Installation and User's Guide

IBM Tivoli Storage Manager for Windows Backup-ArchiveClientsVersion 6.4Installation and User's GuideSC23-9792-06

IBM Tivoli Storage Manager for Windows Backup-ArchiveClientsVersion 6.4Installation and User's GuideSC23-9792-06

Note:Before using this information and the product it supports, read the information in “Notices” on page 681.This edition applies to Version 6.4 of IBM Tivoli Storage Manager (product numbers 5608-E01, 5608-E02, and5608-E03), and to all subsequent releases and modifications until otherwise indicated in new editions or technicalnewsletters. This edition replaces SC23-9792-05.Changes since the previous edition are marked with a vertical bar (|) in the left margin. Ensure that you are usingthe correct edition for the level of the product.© Copyright IBM Corporation 1993, 2012.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents||||||||Tables . . . . . . . . . . . . . . . xiAbout this publication . . . . . . . . xiiiWho should read this publication. . . . . . . xiiiPublications . . . . . . . . . . . . . . xiiiTivoli Storage Manager publications . . . . . xivConventions used in this publication . . . . . xviReading syntax diagrams . . . . . . . . . xviNew for IBM Tivoli Storage ManagerVersion 6.4. . . . . . . . . . . . . xixChapter 1. Installing the Tivoli StorageManager backup-archive clients . . . . 1Upgrading the backup-archive client . . . . . . 1Upgrade path for clients and servers . . . . . 1Considerations for migrating between processorarchitectures x32 and x64 . . . . . . . . . 2Additional upgrade information . . . . . . . 3Automatic backup-archive client deployment . . 3Client environment requirements . . . . . . . 5Windows client environment requirements . . . 6NDMP support requirements (Extended Edition only) 8Installation requirements for backing up andarchiving Tivoli Storage Manager FastBack client data 9Client configuration wizard for Tivoli StorageManager FastBack . . . . . . . . . . . . 9Installing the Tivoli Storage Manager Windowsclient . . . . . . . . . . . . . . . . 10Windows client installation might require areboot . . . . . . . . . . . . . . . 10Installation types . . . . . . . . . . . 10Troubleshooting problems during installation . . 25Chapter 2. Configure the Tivoli StorageManager client . . . . . . . . . . . 27Creating and modifying the client options file . . . 27Create a shared directory options file . . . . . . 29Creating multiple options files . . . . . . . . 29Environment variables. . . . . . . . . . . 30Configuring the Web client . . . . . . . . . 31Configuring the client scheduler . . . . . . . 33Starting the client scheduler . . . . . . . . . 34Scheduling events using the GUI . . . . . . 35Configuring Tivoli Storage Manager client/servercommunication across a firewall . . . . . . . 35Configuring Tivoli Storage Manager client/servercommunication with Secure Sockets Layer . . . . 38Certificate Authorities root certificates . . . . 41Configure your system for journal-based backup . . 41Configuring the journal engine service . . . . 41Client-side data deduplication . . . . . . . . 49Configuring the client for data deduplication . . 52Excluding files from data deduplication . . . . 54|||Configuring the client to back up and archive TivoliStorage Manager FastBack data. . . . . . . . 55Configuring Tivoli Storage Manager to protectFastBack client data . . . . . . . . . . . 56Configuring the backup-archive client in a clusterserver environment . . . . . . . . . . . . 58Protecting data in MSCS clusters (WindowsServer 2008) . . . . . . . . . . . . . 59Configure the Web client in a clusterenvironment . . . . . . . . . . . . . 60Frequently asked questions . . . . . . . . 67Configuring online-image backup support . . . . 69Configuring Open File Support . . . . . . . . 70Configuring NetApp and Tivoli Storage Managerfor snapshot difference incremental backups . . . 70SnapMirror support for NetAppsnapshot-assisted progressive incremental backup(snapdiff) . . . . . . . . . . . . . . 72Register your workstation with a server . . . . . 75Closed registration . . . . . . . . . . . 75Open registration . . . . . . . . . . . 75Creating an include-exclude list . . . . . . . 76Include-exclude options . . . . . . . . . 77Determine compression and encryptionprocessing . . . . . . . . . . . . . . 84Preview include-exclude list files . . . . . . 85Include and exclude option processing . . . . 86Processing rules when using UNC names . . . 88Chapter 3. Getting started . . . . . . 89Backup-archive client operations and security rights 89Backup Operators group operations . . . . . 90Considerations before you start using a BackupOperators group account . . . . . . . . . 91Permissions required to restore files that useadaptive subfile backup . . . . . . . . . . 91Permissions required to back up, archive, restore orretrieve files on cluster resources . . . . . . . 91Tivoli Storage Manager client authentication . . . 92User account control . . . . . . . . . . . 93Starting a Java GUI session . . . . . . . . . 93Tivoli Storage Manager password . . . . . . 93Setup wizard . . . . . . . . . . . . . 94Starting a command-line session . . . . . . . 94Using batch mode . . . . . . . . . . . 94Issuing a series of commands by usinginteractive mode. . . . . . . . . . . . 95Displaying Euro characters in a command-lineprompt . . . . . . . . . . . . . . . 95Use options on the DSMC command . . . . . 96Specifying input strings that contain blank spaces orquotation marks . . . . . . . . . . . . . 96Starting a web client session . . . . . . . . . 97User privileges . . . . . . . . . . . . 98Start the client scheduler automatically . . . . . 98© Copyright IBM Corp. 1993, 2012 iii

Changing your password . . . . . . . . . . 99Sorting file lists using the Tivoli Storage ManagerGUI . . . . . . . . . . . . . . . . 100Displaying online help . . . . . . . . . . 101Ending a session . . . . . . . . . . . . 101Online forums . . . . . . . . . . . . . 102Other sources of online help . . . . . . . . 103Chapter 4. Backing up your data . . . 105Planning your backups (Windows) . . . . . . 105Understanding which files are backed up . . . . 106Open file support for backup operations . . . . 107Backing up data using the GUI . . . . . . . 109Specifying drives in your domain. . . . . . 110Backing up data using the command line . . . . 110Deleting backup data . . . . . . . . . . . 112When to back up and when to archive files . . . 113Pre-backup considerations (Windows) . . . . . 114LAN-free data movement . . . . . . . . 114Unicode file spaces (Windows) . . . . . . 115Incremental backups on memory-constrainedsystems . . . . . . . . . . . . . . 115Incremental backups on systems with a largenumber of files . . . . . . . . . . . . 115Performing a backup with limited bandwidth 117Control processing with an include-exclude list 117Data encryption during backup or archiveoperations . . . . . . . . . . . . . 118Maximum file size for operations . . . . . . 119How Tivoli Storage Manager handles long userand group names . . . . . . . . . . . 119Incremental, selective, or incremental-by-datebackups (Windows) . . . . . . . . . . . 119Full and partial incremental backup . . . . . 120Incremental-by-date backup . . . . . . . 123Comparing incremental-by-date, journal-based,and NetApp snapshot difference to fullincremental and partial incremental backups . . 124Selective backup . . . . . . . . . . . 126Backing up files from one or more file spaces for agroup backup (Windows) . . . . . . . . . 126Backing up data with client-node proxy support(Windows) . . . . . . . . . . . . . . 127Enabling multiple node operations from theGUI . . . . . . . . . . . . . . . 128Setting up encryption . . . . . . . . . 128Scheduling backups with client-node proxysupport . . . . . . . . . . . . . . 128Associate a local snapshot with a server file space(Windows) . . . . . . . . . . . . . . 130Backing up Windows system state . . . . . . 130Backing up Automated System Recovery files . . 132Backing up in preparation for Automated SystemRecovery (Windows Vista, Windows 7, andWindows Server 2008) . . . . . . . . . . 132Creating a Tivoli Storage Manager options filefor Automated System Recovery (WindowsVista, Windows 7, or Windows Server 2008) . . 133Backing up the boot drive and system drive forAutomated System Recovery (Windows Vista,Windows 7, or Windows Server 2008) . . . . 134|||||Image backup . . . . . . . . . . . . . 134Performing prerequisite tasks before creating animage backup . . . . . . . . . . . . 135Utilizing image backups to perform file systemincremental backups . . . . . . . . . . 136Performing an image backup using the GUI . . 139Performing an image backup using thecommand line . . . . . . . . . . . . 139Back up NAS file systems using Network DataManagement Protocol . . . . . . . . . . 140Backing up NAS file systems with the Webclient GUI using NDMP protocol . . . . . . 141Back up NAS file systems using the commandline. . . . . . . . . . . . . . . . 142Methods for backing up and recovering data onNAS file servers when using CIFS . . . . . 144Support for CDP Persistent Storage Manager . . . 145Backing up VMware virtual machines . . . . . 146Preparing the environment for full backups ofVMware virtual machines . . . . . . . . 148Creating full backups for VMware virtualmachines . . . . . . . . . . . . . . 150Preparing the environment for file-level backupsof VMware virtual machines . . . . . . . 152Creating file-level backups for VMware virtualmachines . . . . . . . . . . . . . . 154Parallel backups of VMware virtual machines 155Backing up virtual machines on a WindowsHyper-V system . . . . . . . . . . . . 159Hyper-V backup support limitations. . . . . 161Back up and archive Tivoli Storage ManagerFastBack data . . . . . . . . . . . . . 162Net Appliance CIFS share definition backups. . . 162Display backup processing status. . . . . . . 163Backup (Windows): Additional considerations . . 165Open files . . . . . . . . . . . . . 165Ambiguous file space names in filespecifications . . . . . . . . . . . . 166Management classes . . . . . . . . . . 167Deleted file systems . . . . . . . . . . 167Removable media backup . . . . . . . . 167Fixed drives . . . . . . . . . . . . . 168NTFS file spaces . . . . . . . . . . . 168Universal Naming Convention names . . . . 168Microsoft Dfs file protection methods . . . . 170Chapter 5. Restoring your data . . . . 173Duplicate file names . . . . . . . . . . . 173Universal Naming Convention names restore. . . 174Active or inactive backup restore . . . . . . . 174Restoring files and directories . . . . . . . . 175Restoring data using the GUI . . . . . . . 175Examples for restoring data using the commandline. . . . . . . . . . . . . . . . 175Plan for temporary space to restore migratedfiles . . . . . . . . . . . . . . . 179Restoring Windows system state . . . . . . . 180Restoring Automated System Recovery files . . . 181Restoring the operating system when the computeris working . . . . . . . . . . . . . . 181ivIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Recovering a computer when the OS is notworking (Windows Vista, Windows 7, WindowsServer 2008 and Windows Server 2008 R2) . . . 182Creating a bootable WinPE CD (Windows Vista,Windows 7, Windows Server 2008, WindowsServer 2008 R2). . . . . . . . . . . . 182Restoring Windows Vista, Windows 7, WindowsServer 2008, and Windows Server 2008 R2 withAutomated System Recovery . . . . . . . 182Microsoft Dfs tree and file restore . . . . . . 183Restoring an image . . . . . . . . . . . 183Restoring an image using the GUI . . . . . 184Restoring an image using the command line . . 185Restore data from a backup set . . . . . . . 185Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 188Backup set restore . . . . . . . . . . . 189Restoring backup sets using the GUI . . . . 190Backup set restores using the clientcommand-line interface . . . . . . . . . 191Restore Net Appliance CIFS shares . . . . . . 191Restoring data from a VMware backup . . . . . 192Restoring full VM backups . . . . . . . . 193Scenario: Restoring file-level VM backups . . . 194Restoring full VM backups that were createdwith VMware Consolidated Backup . . . . . 196Restore Windows individual Active Directoryobjects. . . . . . . . . . . . . . . . 198Reanimate tombstone objects or restoring from asystem state backup . . . . . . . . . . 198Restoring Active Directory objects using theGUI and command line . . . . . . . . . 199Restrictions and limitations when restoringActive Directory objects . . . . . . . . . 200Preserve attributes in tombstone objects . . . 201Modifying the client acceptor and agent servicesto use the Web client . . . . . . . . . . 202Authorizing another user to restore or retrieveyour files . . . . . . . . . . . . . . . 202Restoring or retrieving files from another clientnode . . . . . . . . . . . . . . . . 203Restoring or retrieving your files to anotherworkstation . . . . . . . . . . . . . . 204Deleting file spaces . . . . . . . . . . . 205Restoring data to a point in time . . . . . . . 206Restore NAS file systems . . . . . . . . . 207Restoring NAS file systems using the Web client 207Restoring NAS files and directories using theWeb client . . . . . . . . . . . . . 208Options and commands to restore NAS filesystems from the command line . . . . . . 210Chapter 6. Archive and retrieve yourdata (Windows) . . . . . . . . . . 213Archive files. . . . . . . . . . . . . . 213Snapshot backup or archive with open filesupport . . . . . . . . . . . . . . 214Archiving data using the GUI . . . . . . . 214Archive data examples using the command line 215Archiving data with client node proxy . . . . 216Deleting archive data . . . . . . . . . . 218Retrieve archives . . . . . . . . . . . . 218Retrieving archives using the GUI . . . . . 219Retrieve archives using the command line . . . 219Chapter 7. Tivoli Storage Managerscheduler overview . . . . . . . . . 221Examples: Blank spaces in file names in scheduledefinitions . . . . . . . . . . . . . . 222Preferential start times for certain nodes . . . . 222Scheduler processing options . . . . . . . . 223Return codes from preschedulecmd andpostschedulecmd scripts. . . . . . . . . 224Client-acceptor scheduler services versus thetraditional scheduler services . . . . . . . . 225Set the client scheduler process to run as abackground task and start automatically at startup . 226Examples: Display information about scheduledwork . . . . . . . . . . . . . . . . 227Display information about completed work . . . 229Examples: Event logs . . . . . . . . . . 230Specify scheduling options . . . . . . . . . 233Enable or disable scheduled commands . . . . 233Change processing options used by the schedulerservice. . . . . . . . . . . . . . . . 234Manage multiple schedule requirements on onesystem . . . . . . . . . . . . . . . 235Chapter 8. Client return codes . . . . 237Chapter 9. Storage managementpolicies . . . . . . . . . . . . . . 239Policy domains and policy sets . . . . . . . 239Management classes and copy groups . . . . . 240Display information about management classesand copy groups . . . . . . . . . . . . 241Copy group name attribute. . . . . . . . 241Copy type attribute . . . . . . . . . . 241Copy frequency attribute . . . . . . . . 242Versions data exists attribute . . . . . . . 242Versions data deleted attribute . . . . . . 242Retain extra versions attribute . . . . . . . 242Retain only version attribute . . . . . . . 243Copy serialization attribute . . . . . . . . 243Copy mode attribute . . . . . . . . . . 244Copy destination attribute . . . . . . . . 244Retain versions attribute. . . . . . . . . 244Deduplicate data attribute . . . . . . . . 244Select a management class for files . . . . . . 245Assign a management class to files . . . . . . 245Override the management class for archived files 246Select a management class for directories . . . . 247Bind management classes to files . . . . . . . 247Rebind backup versions of files . . . . . . . 248Retention grace period . . . . . . . . . . 248Event-based policy retention protection. . . . . 249Archive files on a data retention server . . . . 249Chapter 10. Using the Client ServiceConfiguration Utility . . . . . . . . 251Contentsv

|File specification syntax . . . . . . . . . 541Wildcard characters . . . . . . . . . . . 542Client commands reference . . . . . . . . . 543Archive . . . . . . . . . . . . . . . 543Open file support . . . . . . . . . . . 545Archive FastBack . . . . . . . . . . . . 546Backup FastBack . . . . . . . . . . . . 549Backup Group . . . . . . . . . . . . . 551Backup Image . . . . . . . . . . . . . 554Offline and online image backup . . . . . . 556Utilizing image backup to perform file systemincremental backup . . . . . . . . . . 557Backup NAS . . . . . . . . . . . . . 558Backup Systemstate . . . . . . . . . . . 560Backup VM . . . . . . . . . . . . . . 562Cancel Process . . . . . . . . . . . . . 568Cancel Restore . . . . . . . . . . . . . 568Delete Access . . . . . . . . . . . . . 569Delete Archive . . . . . . . . . . . . . 570Delete Backup . . . . . . . . . . . . . 571Delete Filespace . . . . . . . . . . . . 574Delete Group . . . . . . . . . . . . . 575Expire . . . . . . . . . . . . . . . . 577Help . . . . . . . . . . . . . . . . 578Incremental . . . . . . . . . . . . . . 579Open file support . . . . . . . . . . . 583Journal-based backup. . . . . . . . . . 583Backing up NTFS volume mount points . . . 585Back up Microsoft Dfs root . . . . . . . . 586Incremental-by-Date . . . . . . . . . . 586Adaptive subfile backups . . . . . . . . 587Associate a local snapshot with a server filespace . . . . . . . . . . . . . . . 587Loop . . . . . . . . . . . . . . . . 587Macro . . . . . . . . . . . . . . . . 588Monitor Process . . . . . . . . . . . . 589Preview Archive . . . . . . . . . . . . 589Preview Backup . . . . . . . . . . . . 590Query Access . . . . . . . . . . . . . 591Query Adobjects . . . . . . . . . . . . 592Query Archive . . . . . . . . . . . . . 594Query Backup . . . . . . . . . . . . . 596Query NAS file system images . . . . . . 599Query Backupset . . . . . . . . . . . . 599Query Backupset without the backupsetnameparameter . . . . . . . . . . . . . 601Query Filespace . . . . . . . . . . . . 603Query NAS file spaces . . . . . . . . . 604Query Group . . . . . . . . . . . . . 605Query Image . . . . . . . . . . . . . 606Query Inclexcl . . . . . . . . . . . . . 608Query Mgmtclass . . . . . . . . . . . . 609Query Node. . . . . . . . . . . . . . 610Query Options . . . . . . . . . . . . . 611Query Restore . . . . . . . . . . . . . 612Query Schedule . . . . . . . . . . . . 613Query Session . . . . . . . . . . . . . 613Query Systeminfo . . . . . . . . . . . 614Query Systemstate . . . . . . . . . . . 616Query VM . . . . . . . . . . . . . . 617Restart Restore. . . . . . . . . . . . . 621|Restore . . . . . . . . . . . . . . . 622Restoring NTFS volume mount points . . . . 627Restore Microsoft Dfs junctions . . . . . . 628Restore active files. . . . . . . . . . . 628Universal Naming Convention restores . . . . 628Restore from file spaces that are notUnicode-enabled . . . . . . . . . . . 628Restore named streams . . . . . . . . . 629Restore sparse files . . . . . . . . . . 629Restore Adobjects. . . . . . . . . . . . 629Restore Backupset . . . . . . . . . . . 631Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 634Restore backup sets in a SAN environment . . 635Restore Backupset without the backupsetnameparameter . . . . . . . . . . . . . 635Restore Group . . . . . . . . . . . . . 638Restore Image . . . . . . . . . . . . . 640Restore NAS . . . . . . . . . . . . . 643Restore Systemstate . . . . . . . . . . . 645Restore VM . . . . . . . . . . . . . . 647Retrieve . . . . . . . . . . . . . . . 652Retrieve archives from file spaces that are notUnicode-enabled . . . . . . . . . . . 656Retrieve named streams . . . . . . . . . 656Retrieve sparse files . . . . . . . . . . 656Schedule . . . . . . . . . . . . . . . 656Selective . . . . . . . . . . . . . . . 658Open file support . . . . . . . . . . . 661Adaptive subfile backups . . . . . . . . 661Associate a local snapshot with a server filespace . . . . . . . . . . . . . . . 661Set Access . . . . . . . . . . . . . . 661Set Event. . . . . . . . . . . . . . . 664Set Password . . . . . . . . . . . . . 666Appendix A. Support information . . . 673Getting technical training . . . . . . . . . 673Searching knowledge bases. . . . . . . . . 673Searching the Internet . . . . . . . . . 673Using IBM Support Assistant . . . . . . . 674Finding product fixes. . . . . . . . . . 675Receiving notification of product fixes . . . . 675Contacting IBM Software Support . . . . . . 675Setting up a subscription and support contract 675Determining the business impact . . . . . . 676Describing the problem and gatheringbackground information . . . . . . . . . 676Submitting the problem to IBM SoftwareSupport . . . . . . . . . . . . . . 676Appendix B. Accessibility features forthe Tivoli Storage Manager productfamily. . . . . . . . . . . . . . . 679Notices . . . . . . . . . . . . . . 681Trademarks . . . . . . . . . . . . . . 683Glossary . . . . . . . . . . . . . 685viiiIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Index . . . . . . . . . . . . . . . 707Contentsix

xIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Tables||||||||1. Server publications . . . . . . . . . . xiv2. Storage agent publications . . . . . . . xiv3. Backup-archive client publications . . . . . xv4. Data protection publications . . . . . . . xv5. Troubleshooting and performance tuningpublications . . . . . . . . . . . . xv6. Windows client communication methods . . . 77. Supported features on Windows platforms 88. Stoppable services . . . . . . . . . . 169. Data deduplication settings: Client and server 5210. Options for excluding file spaces anddirectories . . . . . . . . . . . . . 7811. Options for controlling processing usinginclude and exclude statements . . . . . . 7912. Wildcard and other special characters . . . . 8213. Specifying a drive specification usingwildcards . . . . . . . . . . . . . 8314. Using wildcard characters with include andexclude patterns . . . . . . . . . . . 8415. Options for controlling compression andencryption processing . . . . . . . . . 8416. UNC name patterns and DOS patterns 8817. Required user security rights for Tivoli StorageManager backup and restore services . . . . 8918. Working with your files using the TivoliStorage Manager GUI . . . . . . . . . 10019. Planning your backups . . . . . . . . 10620. Command line backup examples . . . . . 11021. Maximum file size . . . . . . . . . . 11922. Comparing incremental image backupmethods . . . . . . . . . . . . . 13823. NAS options and commands . . . . . . 14224. Backup and restore capabilities for VMwarevirtual machines on Windows platforms . . 14625. Comparison of full backups and file-levelbackups for VMware virtual machines onWindows systems . . . . . . . . . . 14826. Client command line informational messages 16327. UNC examples . . . . . . . . . . . 17028. Command-line restore examples . . . . . 17629. Backup set GUI restore restrictions . . . . 18730. Backup set command-line restore restrictions 18731. Components for the restore command whenyou restore files to the same computer . . . 19532. Components for the restore command whenyou restore files to a different computer. . . 19633. NAS options and commands . . . . . . 21034. Command-line archive examples . . . . . 21535. Command line examples of retrievingarchives . . . . . . . . . . . . . 21936. Sample classic query schedule output 22837. Sample enhanced query schedule output 22938. Client return codes and their meanings 23739. Default attribute values in the standardmanagement class . . . . . . . . . . 24140. TCP/IP options . . . . . . . . . . . 268||41. Named Pipes communication option 26942. Shared memory communication options 26943. Server and node options . . . . . . . . 26944. Node options . . . . . . . . . . . 27045. Backup and archive processing options 27046. Restore and retrieve processing options 27947. Scheduling options. . . . . . . . . . 28248. Format and language options . . . . . . 28349. Command processing options . . . . . . 28450. Authorization options. . . . . . . . . 28451. Error processing options . . . . . . . . 28452. Transaction processing options . . . . . . 28553. Web client options . . . . . . . . . . 28654. Diagnostics options . . . . . . . . . 28655. Client command options . . . . . . . . 28856. Options that are valid on the initial commandline only . . . . . . . . . . . . . 29357. Options that can be set by the Tivoli StorageManager server . . . . . . . . . . . 29458. Clusternode and clusterdisksonlycombinations. . . . . . . . . . . . 31459. Interaction of domain definitions from severalsources. . . . . . . . . . . . . . 34360. Options for controlling compression andencryption processing. . . . . . . . . 36561. System services components andcorresponding keywords . . . . . . . . 36762. Other optional parameters . . . . . . . 39963. Incremental command: Related options 47564. Effects of server and client SSL settings onsuccess or failure of login attempts . . . . 48765. Commands . . . . . . . . . . . . 53566. Wildcard characters . . . . . . . . . 54267. Archive command: Related options . . . . 54468. Archive FastBack command: Related options 54769. Backup FastBack command: Related options 55070. Backup Group command: Related options 55371. Backup Image command: Related options 55572. Backup NAS command: Related options 56073. Delete Archive command: Related options 57174. Delete Backup command: Related options 57375. Delete Filespace command: Related options 57576. Delete Group command: Related options 57677. Expire command: Related options. . . . . 57778. Incremental command: Related options 58179. Query Adobjects command: Related options 59380. Query Archive command: Related options 59581. Query Backup command: Related options 59782. Query Backupset command: Related options 60083. Query Backupset command: Related options 60284. Query Filespace command: Related options 60385. Query Group command: Related options 60586. Query Image command: Related options 60787. Query Mgmtclass command: Related options 61088. Query Node command: Related options 61189. Query Options command: Related options 612© Copyright IBM Corp. 1993, 2012 xi

90. Query Systeminfo command: Related options 61691. Query Systemstate command: Related options 61692. Query VM command: Related options forVMware virtual machine queries. . . . . . 61893. Query VM command: Related options forHyper-V virtual machine queries. . . . . . 62094. Restore command: Related options . . . . 62495. Restore Adobjects command: Related options 63096. Restore Backupset command: Related options 63397. Restore Group command: Related options 63998. Restore Image command: Related options 641||||99. Restore NAS command: Related options 644100. Restore Systemstate command: Relatedoptions . . . . . . . . . . . . . 646101. Restore VM command: Related options whenrestoring VMware virtual machines . . . . 650102. Restore VM command: Related options whenrestoring Hyper-V virtual machines . . . . 652103. Retrieve command: Related options . . . . 654104. Schedule command: Related options . . . . 657105. Selective command: Related options . . . . 659xiiIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

About this publicationIBM ® Tivoli ® Storage Manager is a client-server licensed product that providesstorage management services in a multiplatform computer environment. Thebackup-archive client program permits users to back up and archive files fromtheir workstations or file servers to storage, and restore and retrieve backupversions and archived copies of files to their local workstations.In addition to the backup-archive client, Tivoli Storage Manager includes thefollowing components available on a variety of platforms:vvvvA server program that permits systems to perform as a backup and archive serverfor distributed workstations and file servers.An administrative client program that you can access from a Web browser or thecommand line. The program permits a Tivoli Storage Manager administrator tocontrol and monitor server activities, define storage management policies forbackup, archive and space management services, and set up schedules toperform those services at regular intervals.An application program interface (API) that permits you to enhance an existingapplication with storage management services. When an application is registeredwith a server as a client node, the application can back up, restore, archive, andretrieve objects from storage.A Web backup-archive client that permits an authorized administrator, help deskperson, or end user to perform backup, restore, archive, and retrieve servicesusing a Web browser on a remote system.Who should read this publicationPublicationsThis publication provides instructions for a user to install, configure, and use theTivoli Storage Manager client.Unless otherwise specified, references to Windows refer to all supported MicrosoftWindows operating systems.Publications for the IBM Tivoli Storage Manager family of products are availableonline. The Tivoli Storage Manager product family includes IBM Tivoli StorageFlashCopy ® Manager, IBM Tivoli Storage Manager for Space Management, IBMTivoli Storage Manager for Databases, and several other storage managementproducts from IBM Tivoli.To search all publications, go to the Tivoli Storage Manager information center athttp://pic.dhe.ibm.com/infocenter/tsminfo/v6r4.You can download PDF versions of publications from the Tivoli Storage Managerinformation center or from the IBM Publications Center at http://www.ibm.com/shop/publications/order/.Go to Tivoli Documentation Central to find information centers that contain officialproduct documentation for current and previous versions of Tivoli products,© Copyright IBM Corp. 1993, 2012 xiii

including the Tivoli Storage Manager product family. You can find TivoliDocumentation Central at https://www.ibm.com/developerworks/wikis/display/tivolidoccentral/Home.You can also order some related publications from the IBM Publications Centerwebsite at http://www.ibm.com/shop/publications/order/. The website providesinformation about ordering publications from countries other than the UnitedStates. In the United States, you can order publications by calling 1-800-879-2755.Tivoli Storage Manager publicationsThe following tables list the publications that are included in the Tivoli StorageManager library.Table 1. Server publicationsPublication titleIBM Tivoli Storage Manager for AIX Installation GuideIBM Tivoli Storage Manager for AIX Administrator's GuideIBM Tivoli Storage Manager for AIX Administrator's ReferenceIBM Tivoli Storage Manager for HP-UX Installation GuideIBM Tivoli Storage Manager for HP-UX Administrator's GuideIBM Tivoli Storage Manager for HP-UX Administrator's ReferenceIBM Tivoli Storage Manager for Linux Installation GuideIBM Tivoli Storage Manager for Linux Administrator's GuideIBM Tivoli Storage Manager for Linux Administrator's ReferenceIBM Tivoli Storage Manager for Oracle Solaris Installation GuideIBM Tivoli Storage Manager for Oracle Solaris Administrator's GuideIBM Tivoli Storage Manager for Oracle Solaris Administrator's ReferenceIBM Tivoli Storage Manager for Windows Installation GuideIBM Tivoli Storage Manager for Windows Administrator's GuideIBM Tivoli Storage Manager for Windows Administrator's ReferenceIBM Tivoli Storage Manager for z/OS Media Installation and User'sGuideIBM Tivoli Storage Manager Upgrade and Migration Guide for V5ServersIBM Tivoli Storage Manager Integration Guide for Tivoli StorageManager FastBackOrder numberGC23-9781SC23-9769SC23-9775GC23-9782SC23-9770SC23-9776GC23-9783SC23-9771SC23-9777GC23-9784SC23-9772SC23-9778GC23-9785SC23-9773SC23-9779SC27-4018GC27-4017SC27-2828Table 2. Storage agent publicationsPublication titleIBM Tivoli Storage Manager for SAN for AIX Storage Agent User'sGuideIBM Tivoli Storage Manager for SAN for HP-UX Storage Agent User'sGuideIBM Tivoli Storage Manager for SAN for Linux Storage Agent User'sGuideIBM Tivoli Storage Manager for SAN for Oracle Solaris Storage AgentUser's GuideOrder numberSC23-9797SC23-9798SC23-9799SC23-9800xivIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 2. Storage agent publications (continued)Publication titleIBM Tivoli Storage Manager for SAN for Windows Storage Agent User'sGuideOrder numberSC23-9553Table 3. Backup-archive client publicationsPublication titleIBM Tivoli Storage Manager for UNIX and Linux: Backup-ArchiveClients Installation and User's GuideIBM Tivoli Storage Manager for Windows: Backup-Archive ClientsInstallation and User's GuideIBM Tivoli Storage Manager Using the Application ProgrammingInterfaceIBM Tivoli Storage Manager for Space Management for UNIX and Linux:User’s GuideIBM Tivoli Storage Manager HSM for Windows Administration GuideOrder numberSC23-9791SC23-9792SC23-9793SC23-9794SC23-9795Table 4. Data protection publicationsPublication titleIBM Tivoli Storage Manager for Databases: Data Protection for MicrosoftSQL Server Installation and User’s GuideIBM Tivoli Storage Manager for Databases: Data Protection for Oracle forUNIX and Linux Installation and User’s GuideIBM Tivoli Storage Manager for Databases: Data Protection for Oracle forWindows Installation and User’s GuideIBM Tivoli Storage Manager for Mail: Data Protection for MicrosoftExchange Server Installation and User’s GuideIBM Tivoli Storage Manager for Mail: Data Protection for Lotus Domino ®UNIX and Linux Installation and User’s GuideIBM Tivoli Storage Manager for Mail: Data Protection for Lotus Dominofor Windows Installation and User’s GuideIBM Tivoli Storage Manager for Enterprise Resource Planning: DataProtection for SAP Installation and User’s Guide for DB2IBM Tivoli Storage Manager for Enterprise Resource Planning: DataProtection for SAP Installation and User’s Guide for OracleIBM Tivoli Storage Manager for Virtual Environments Installation andUser’s GuideOrder numberGC27-4010SC27-4019SC27-4020GC27-4009SC27-4021SC27-4022SC33-6341SC33-6340SC27-2898Table 5. Troubleshooting and performance tuning publicationsPublication titleIBM Tivoli Storage Manager Problem Determination GuideIBM Tivoli Storage Manager Performance Tuning GuideIBM Tivoli Storage Manager Client Messages and ApplicationProgramming Interface Return CodesIBM Tivoli Storage Manager Server Messages and Error CodesIBM Tivoli Storage Manager for Mail: Data Protection for MicrosoftExchange Server MessagesOrder numberGC23-9789GC23-9788SC27-2878SC27-2877GC27-4011About this publicationxv

Table 5. Troubleshooting and performance tuning publications (continued)Publication titleIBM Tivoli Storage Manager for Databases: Data Protection for MicrosoftSQL Server MessagesIBM Tivoli Storage Manager for Databases: Data Protection for OracleMessagesIBM Tivoli Storage Manager for Mail: Data Protection for Lotus DominoMessagesIBM Tivoli Storage Manager for Enterprise Resource Planning: DataProtection for SAP MessagesOrder numberGC27-4012SC27-4014SC27-4015SC27-4016Note: IBM System Storage ® Archive Manager is not releasing a new product. Youcan find information about IBM System Storage Archive Manager at the TivoliStorage Manager V6.3 information center (http://pic.dhe.ibm.com/infocenter/tsminfo/v6r3/topic/com.ibm.itsm.nav.doc/c_complydataretention_ovr.html).Conventions used in this publicationThis publication uses the following typographical conventions:Exampleautoexec.ncfhsmgui.exeDSMI_DIRdsmQuerySessInfotimeformatdateformatmaxcmdretriesplus sign (+)DescriptionA series of lowercase letters with an extension indicates program filenames.A series of uppercase letters indicates return codes and other values.Boldface type indicates a command that you type on a command line,the name of a function call, the name of a structure, a field within astructure, or a parameter.Boldface italic type indicates a Tivoli Storage Manager option. Thebold type is used to introduce the option, or used in an example.Italic type indicates an option, the value of an option, a new term, aplaceholder for information you provide, or for special emphasis in thetext.Monospace type indicates fragments of a program or information as itmight appear on a display screen, such a command example.A plus sign between two keys indicates that you press both keys at thesame time.Reading syntax diagramsTo read a syntax diagram for entering a command, follow the path of the line.Read from left to right and from top to bottom.v The ►►─── symbol indicates the beginning of a syntax diagram.vvvThe ───► symbol at the end of a line indicates that the syntax diagram continueson the next line.The ►─── symbol at the beginning of a line indicates that a syntax diagramcontinues from the previous line.The ───►◄ symbol indicates the end of a syntax diagram.Syntax items, such as a keyword or a variable, can be:v On the line (required element)xviIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvAbove the line (default element)Below the line (optional element)SymbolsEnter these symbols exactly as they appear in the syntax diagram.v * Asteriskv {}Bracesv : Colonv , Commav = Equal Signv - Hyphenv () Parenthesesv . Periodv Spacev " quotation markv 'single quotation markVariablesItalicized lowercase items such as indicate variables. In this example,you can specify a when you enter the cmd_name command.►► cmd_name ►◄RepetitionAn arrow returning to the left means that the item can be repeated. A characterwithin the arrow means that you must separate repeated items with that character.►► ▼ ,repeat►◄A footnote (1) by the arrow refers to a limit that tells how many times the item canbe repeated.►► ▼ ,(1)repeat►◄Notes:1 Specify repeat up to 5 times.Required choicesWhen two or more items are in a stack and one of them is on the line, you mustspecify one item.In this example, you must choose A, B, or C.About this publicationxvii

►► cmd_name ABC►◄Optional choicesWhen an item is below the line, that item is optional. In the first example, you canselect A or nothing at all.►►cmd_nameA►◄When two or more items are in a stack below the line, all of them are optional. Inthe second example, you can choose A, B, C, or nothing at all.►►cmd_nameABC►◄Repeatable choicesA stack of items followed by an arrow returning to the left indicates that you canselect more than one item, or in some cases, repeat a single item.In this example, you can select any combination of A, B, or C.,►►cmd_name▼ABC►◄DefaultsDefaults are above the line. The default is selected unless you override it, or youcan select the default explicitly. To override the default, include an option from thestack below the line.In this example, A is the default. Select either B or C to override A.►►cmd_nameABC►◄xviiiIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

New for IBM Tivoli Storage Manager Version 6.4This section summarizes changes that were made to Tivoli Storage ManagerVersion 6.4.||||||||||||||||||||||The following features are new for IBM Tivoli Storage Manager in Version 6.4:LDAP authenticationIf your clients log on to a Tivoli Storage Manager server that is at version6.3.3, or newer, you can now configure the server to use an external LDAPserver to provide login authentication for administrators and nodes. IBMTivoli Directory Server version 6.2 and later, and Windows ActiveDirectory version 2003 and later, are the supported LDAP servers. Using anLDAP server for authentication can provide additional security becauseyou can configure password policies that require passwords to use acombination of uppercase and lowercase letters, numbers, and specialcharacters. You can also configure password policies that mandate thecontent of passwords, and when they expire. See the server documentationfor details.Security enhancementsTwo new client options are provided to promote secure communications.“Sslrequired” on page 486The sslrequired option specifies the conditions when SSL is or isnot required when logging on to the Tivoli ® Storage Managerserver or storage agents. To actually enable SSL so client-to-serverand client-to-storage-agent communications are secure, you mustset the client ssl option to yes.“Lanfreessl” on page 410This option specifies whether the Tivoli Storage Manager clientenables SSL when communicating with a Storage Agent.Snapshot differential backups of NetApp filer volumes in a SnapMirrorenvironmentYou can use NetApp's SnapDiff backup processing in conjunction withNetApp's SnapMirror replication to back up NetApp or N-Seriesproduction or remote filer volumes. For more information, see “SnapMirrorsupport for NetApp snapshot-assisted progressive incremental backup(snapdiff)” on page 72.Snapshot differential backups of NetApp vFiler volumesSnapshot differential backups can now be done on NetApp vFiler volumes,if the targeted NetApp vFiler is running ONTAP 8.1.1, or a newer version.The software changes that allow the client to protect vFiler volumes are allin ONTAP. There are no changes to the backup-archive client to use thisnew capability. You use same the client commands and options to protectvFilers that you use for physical filers. Like a physical filer, a vFiler hasunique credentials, including an IP address or hostname, and a user nameand password. The backup-archive client Set Password command must beused to initially store these credentials before a snapshot differentialbackup can be run.Incremental forever virtual machine backup strategyCustomers who use VMware virtual machines can extend existing periodic© Copyright IBM Corp. 1993, 2012 xix

|||||||||||||full backup functions by creating new incremental-forever backups.Incremental-forever backups offer the following advantages:v Improve support for large VMsv Reduce the backup window and storage pool requirementsv Simplify scheduling operationsv Improve scalability of vStorage Backup Serversv Allow full backups to be requestedv Are managed like incremental back upsYou must be licensed to use IBM Tivoli Storage Manager for VirtualEnvironments to use the incremental forever backup strategy. The TivoliStorage Manager for Virtual Environments documentation explains theincremental forever backup strategy in detail. Client options are providedto support incremental forever back ups. See the “Mode” on page 420,“Mbobjrefreshthresh” on page 417, and “Mbpctrefreshthresh” on page 418options for information. Also see the Backup VM command.Selectively include or exclude VMware virtual machine disks from VM backupsCustomers who have large virtual disks inside their VMware virtualmachines might want to exclude disks during routine backups of thevirtual machine to narrow the backup window or, if the disk is protectedby another backup application. For more information, see the“INCLUDE.VMDISK” on page 401, “EXCLUDE.VMDISK” on page 370, and“Domain.vmfull” on page 348 options and the Backup VM and RestoreVM commands. Wildcards are supported so you can include or excludevirtual machines by name (by using wildcard characters) with the existingvmname and -vmname domain keyword.More granular control of VMware virtual machine backupsTwo new domain parameters on the “Domain.vmfull” on page 348 optionenable full VM backups of VMware virtual machines in a cluster(VMHOSTCLUSTER=) or in a data store (VMDATASTORE=).For Windows clients, these new parameters can be used on the“Domain.vmfile” on page 345 option to enable similar virtual machineselections when running file-level backups.Self-contained application protectionSelf-contained application protection for Microsoft Exchange and MicrosoftSQL applications that run inside of VMware virtual machine guests is newin this release. Self-contained application protection enables theBackup-Archive client to truncate application logs after the client backs upa supported application. For more information, see the “INCLUDE.VMTSMVSS”on page 403, and “Vmtimeout” on page 533 options and the set passwordcommand. You must be licensed to use IBM Tivoli Storage Manager forVirtual Environments to use this option.VMware template virtual machines can be included in full VM backupsA new option, “Vmenabletemplatebackups” on page 523, can be set to sothe client backs up VMware template virtual machines when it protectsvirtual machines in a vCenter server.Virtual machines deployed in vApps are included in Backup VM and RestoreVM operationsVirtual machines deployed in vApps are included in Backup VM andRestore VM operations. There are no new client options needed to protectthe vApp VMs.xxIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||Parallel backups of VMware virtual machinesTivoli Storage Manager Backup-Archive client customers can now protectVMware environments by using parallel processing sessions with only asingle (instead of multiple) client instance. Three new options determinewhich virtual machines to include in the backups. If you do not need touse parallel backup sessions, do not change the defaults for the three newoptions. The options are: “Vmmaxparallel” on page 527, “Vmlimitperhost”on page 525, and “Vmlimitperdatastore” on page 524.The Tivoli Storage Manager Logical Volume Snapshot Agent (LVSA) is nolonger supported as a snapshot provider.In this release, you must use the Microsoft Volume Shadow Copy Service(VSS) as the snapshot provider for creating a snapshot of a logical volumeduring an online image backup.What's newxxi

xxiiIBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 1. Installing the Tivoli Storage Managerbackup-archive clientsThe IBM Tivoli Storage Manager backup-archive client helps you protectinformation on your workstations.You can maintain backup versions of your files that you can restore if the originalfiles are damaged or lost. You can also archive files that you do not currently need,preserve them in their current state, and retrieve them when necessary.The Tivoli Storage Manager clients work in conjunction with the Tivoli StorageManager server. Contact your Tivoli Storage Manager server administrator toobtain backup or archive access to the server, or refer to the server publications toinstall and configure a Tivoli Storage Manager server.Upgrading the backup-archive clientThe following sections explain what you need to do if you are upgrading to IBMTivoli Storage Manager backup-archive client version 6.4 from a previous version.|||||||||||||||||||||||||||Upgrade path for clients and serversAs part of a migration plan from Tivoli Storage Manager Version 6.2 or 6.3 toTivoli Storage Manager Version 6.4, Tivoli Storage Manager clients and servers canbe upgraded at different times. This configuration is supported as long as the olderversion is supported.To help prevent disruption to your backup and archive activities during themigration, follow these guidelines:vvvA Tivoli Storage Manager Version 6.4 client can perform backup, restore, archive,retrieve, and query functions to a Tivoli Storage Manager Version 6.1, 6.2, or6.3.x server.A Tivoli Storage Manager Version 6.1, 6.2 or 6.3 client can perform backup,restore, archive, retrieve, and query functions to a Tivoli Storage ManagerVersion 6.3.x server.If you back up or archive data from a Tivoli Storage Manager 6.2 or 6.3 client toany Tivoli Storage Manager server, you can restore or retrieve that data using aTivoli Storage Manager Version 6.4 client.v If you back up or archive data from a Tivoli Storage Manager Version 6.4 client,you cannot restore or retrieve that data by using a Tivoli Storage ManagerVersion 6.3 or earlier client.v All administrative clients can administer Tivoli Storage Manager Version 6.1, 6.2,and 6.3.x servers.vNAS backups performed on a Tivoli Storage Manager Version 6.3.x server usingthe BACKUP NODE server command can only be restored using the RESTORENODE server command, or from a Tivoli Storage Manager Version 6.3 or 6.4client.See http://www.ibm.com/support/docview.wss?uid=swg21053218 for the latestinformation about client and server compatibility.© Copyright IBM Corp. 1993, 2012 1

Considerations for migrating between processor architecturesx32 and x64When migrating between the Tivoli Storage Manager processor architectures (x32and x64), there are some items that you need to consider for a successful migrationfrom one architecture to another.Consider the following items when migrating from one processor architecture toanother:vvvvvvvvvThe restore of DFS links backed up from 32-bit Windows environments to 64-bitWindows environments, is not supported.The restore of DFS links backed up from 64-bit Windows environments to 32-bitWindows environments, is not supported.System state data is incompatible between different processor architectures.Therefore, when migrating client data between different processor architectures,avoid backing up the system state data from one architecture into the same filespaces containing the system state data from another architecture. To avoidcommingling the data, you can do either of the following before the migration:– Ask your Tivoli Storage Manager administrator to rename the existing systemstate file spaces. Once the migration is complete and you have new backupsof the system state data, your Tivoli Storage Manager administrator can deletethe renamed file spaces. The file spaces to rename include one or more of thefollowing:- SYSTEM STATE- SYSTEM SERVICES- ASRAsk your Tivoli Storage Manager administrator to delete the existing filespaces for your node.Renamed file spaces remain on the server and managed as stabilized file spaces.These file spaces contain all the original data, which can still be restored untilthe file spaces are deleted. You can find additional information in the IBM TivoliStorage Manager for Windows Administrator's Guide.When an existing file space is renamed during Unicode conversion, any accessrules defined for the file space remain applicable to the original file space. Newaccess rules must be defined to apply to the new Unicode file space, if necessary.When backing up files to a file space that is not Unicode-enabled, theUnicode-enabled client skips the files and directories with names containingcharacters from a code page other than the current locale.If files and directories with names containing characters from a code page otherthan the current locale were previously backed up with a client that was notUnicode-enabled, Tivoli Storage Manager expires them in the file space that isnot Unicode-enabled. However, the Unicode-enabled client can back up orarchive these files to a Unicode-enabled file space.When migrating from a client that is not Unicode-enabled to a Unicode client,file names with double-byte characters mixed with single-byte characters mightbe restored in mixed single-byte character set (SBCS) format. This is only adisplay issue.When a client performs a selective backup of an object and the original filespace is renamed, the new Unicode-enabled file space contains only that object.Tivoli Storage Manager backs up all other directories and file spaces during thenext full incremental backup.2 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

v The Unicode-enabled client has a file and directory name size limitation of 504bytes. Depending on the Unicode characters (2-byte, 3-byte, or 4-byte) used, thistranslates to a maximum of 126 to 252 characters.Important:If you do not follow the migration instructions properly, you might have two filespaces, one Unicode and one non-Unicode, with different file space identifiers(fsID) for the same client volume. In this case, the Tivoli Storage Manager clientuses the non-Unicode file space as the default file space for backup and restoreoperations.Additional upgrade informationThis section explains some additional information that you need to know whenupgrading your Tivoli Storage Manager client.The size of the buffer to record change notifications for a particular journal filesystem (DirNotifyBufferSize) has changed. The default value is 16 KB.When you install the Web client, you must install the Web-client language files thatcorrespond to those languages you want to use.To view the non-English online help from the web client applet, you must installthe language versions of the help files on the agent, the system where the TivoliStorage Manager Backup-Archive Client was installed. If the language versions arenot installed or are not available, the online help is displayed in English.See the client_message.chg file in the client package for a list of new and changedmessages since the previous Tivoli Storage Manager release.Automatic backup-archive client deploymentThe Tivoli Storage Manager server administrator can automatically deploy aBackup-Archive Client to workstations that already have the Backup-ArchiveClient installed.When you schedule automatic Backup-Archive client deployments, the updatedclient packages (which include the client components and the API library) areinstalled on the workstations that receive them. A dependency check is performedby the client installation program to ensure that the API library does not conflictwith the client package that is currently installed.Tivoli Data Protection for Enterprise Resource Planning applications do not use thesame installation technology that is used by the client installation program.Because of that, the client installation dependency check is not able to detectwhether the API library that is being used by the Tivoli Data Protection forEnterprise Resource Planning applications are compatible with the API library thatwill be installed by automatic client deployments. If a client package isautomatically deployed to and installed on a workstation, the API library that isinstalled might not be compatible with the API library that was installed by theTivoli Data Protection for Enterprise Resource Planning application. The newlydeployed API library can cause the Tivoli Data Protection for Enterprise ResourcePlanning applications to fail.Do not schedule automatic client deployments to workstations that have a TivoliData Protection for Enterprise Resource Planning application installed on them.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 3

The Tivoli Storage Manager server can be configured to automatically upgradebackup-archive clients on Windows computers. The existing clients must be atversion 5.4, or later.You can use the autodeploy option to conditionally enable automatic clientdeployment, if the deployment does not require a restart of the client workstation.Start the client deployment process as a post-schedule command of the scheduler.By default, the autodeploy option is enabled, and the client workstation is restartedif required. The autodeploy option can be set in several places. It can be set by theserver in the Administration Center, or it can be set in the options file that isassociated with the client scheduler or client acceptor daemon. The user at theclient computer can override any other autodeploy option setting by setting theautodeploy option in the dsm.opt file on the client computer. The deploymentmanager detects options files associated with the scheduler or client acceptordaemon, with the following limitation: If there are multiple scheduler or clientacceptor daemon processes running on the same machine, at the same time, andthe processes use different options files, the deployment manager uses theautodeploy setting in one of the options files.To use automatic deployment but not restart the system, specify the autodeploynoreboot option.Important: For automatic client deployment to be operational, the followingconditions apply:v The client computer must have a minimum of 2 GB free disk space.v The passwordaccess option must be set to generate.To store the password in the local Windows registry, a user must log on from thelocal workstation once, to provide the password. If the client automaticdeployment process cannot find the node password in the registry, the followingevents occur:– The deployment process does not start.– A warning message is logged in the setup.log file.The following messages are examples of the messages that can be loggedduring a deployment.Sun 10/11/2009 10:16:04.35 The deployclient.bat script is started.Sun 10/11/2009 10:16:04.37 deployclient.bat is removing the deploymentmanager and temporary files possibly left from the previous installation.Sun 10/11/2009 10:17:10.53 WARNING: Still waiting for the result of querysystem information.Ensure that "PASSWORDACCESS GENERATE" is set in the client options fileand that a connection to the server can be made without being promptedfor a password.If you see these errors and PASSWORDACCESS is set to GENERATE, the cause islikely due to a network problem (the client cannot be reached) or there mightbe a problem with the digital rights management subkey. The digital rightsmanagement key is in the registry in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\BackupRestore\FilesNotToBackup\DRM.– The dsmc query systeminfo command is left running.– The deployment process cannot start, so no messages are sent to the server.vThe client is deployed from the server as a scheduled task; the client schedulermust be running.The scheduler must be started as a Windows service and not from the commandline. To minimize the chance of a restart, the deployment manager shuts down4 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvvthe scheduler service before the new client is installed, and restarts the schedulerservice after the installation. If the scheduler is not run as a Windows service, arestart is required when the client is deployed.The automatic client deployment feature stops and restarts scheduler and CADprocesses on the client, but it does not stop or restart any client operations suchas backup or restore. It is possible that in-process client operations could beaffected during an automatic deployment. To prevent an automatic deploymentfrom interfering with client operations, schedule automatic client deployments tooccur when it is not likely that the client is performing a backup or restore, orarchive or retrieve operation.The client is deployed as a postschedule operating system command; scheduledoperating system commands must be enabled on the client.You must configure your server to perform Backup-Archive Client automaticdeployments. See the Tivoli Storage Manager Administrators Guide for instructions.The command-line Windows registry utility (reg.exe) is required. This tool isgenerally installed as part of the operating system installation on supportedWindows platforms.The Windows cluster services environment is not supported.To turn off automatic client deployment, add autodeploy no to the client optionsfile.The autodeploy option is only available for Tivoli Storage Manager clientsversion 6.2 and later.When you perform automatic client deployments from the Tivoli Storage ManagerServer, the scheduler installs the updated client by running a command that isspecified on a postschedulecmd option that is associated with the schedule. Bydefault, the log and trace files for a deployment operation are written to the client'sdisk in C:\Program Files\Tivoli\TSM\IBM_ANR_WIN\Vxxxx\log; where xxxxrepresents the version for the newly deployed client.If you did not use the default installation directory when you installed the client,when an automatic client deployment is performed, the log and trace data for thedeployment operation are still copied to the IBM_ANR_WIN\Vxxxx\log folder, andthis folder is created one directory level up (../) from where the client executablefiles (dsm.exe, dsmc,exe, dsmcad.exe, and so on) were installed. For example, if youoriginally installed the client into E:\IBM\Tivoli\baclient, the log and trace filesresulting from the automatic deployment are created in E:\IBM\Tivoli\IBM_ANR_WIN\Vxxxx\log folder.A lock file is also created on each client to prevent a client from being updated bydifferent deployment managers at the same time. Before a deployment begins, thedeployment manager looks on the client for the lock file. If the file exists and isless than 24 hours old, the deployment is canceled. If the lock file is more than 24hours old or does not exist, the deployment is started. The lock file is deletedwhen the deployment completes. If the deployment manager fails to delete thelock file, you can manually delete it from the client’s disk. The lock file location isinstall_dir\..\IBM_ANR_WIN\mutext.txt.Related reference:“Autodeploy” on page 302Client environment requirementsThis section contains Tivoli Storage Manager client environment information,components, and hardware and software requirements.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 5

The following list shows the location of the environment prerequisites for eachsupported platform.v “NDMP support requirements (Extended Edition only)” on page 8For current information concerning the client environment prerequisites for allTivoli Storage Manager supported client platforms, go to the Web site at:http://www.ibm.com/software/tivoli/products/storage-mgr/product-links.htmlWindows client environment requirementsThis section contains client environment information, Tivoli Storage Manager clientcomponents, and hardware and software requirements for the supported Windowsplatforms.For current information concerning the client environment prerequisites for allTivoli Storage Manager supported client platforms, go to the Web site at:http://www.ibm.com/software/tivoli/products/storage-mgr/product-links.htmlWindows client installable componentsThe Tivoli Storage Manager backup-archive client is comprised of severalinstallable components.||The installable components for the Windows client are as follows:v Tivoli Storage Manager backup-archive command line clientv Tivoli Storage Manager administrative clientv Tivoli Storage Manager backup-archive client Graphical User Interface, whichuses Oracle Java technologyv Tivoli Storage Manager backup-archive web clientv Tivoli Storage Manager API (32-bit and 64-bit)v VMware vStorage API runtime files, which are required only if you want to usethe client to back up VMware virtual machinesSystem requirements for Windows clientsThe Tivoli Storage Manager Windows client requires a minimum amount of diskspace for installation and a supported operating system.Disk space requirementsThe following disk space is required to install the Windows client:v 2.3 GB of free disk space is required to install the 32-bit Windows client, and alllanguage packs.v 2.9 GB of free disk space is required to install the 64-bit Windows client, and alllanguage packs.If you select a custom installation, the online installation instructions display howmuch space is required for the selected installation options, however, that numbermight not be accurate. The online installation instructions also displays (correctly)how much space is available on the hard disk.The Java client GUI (graphical user interface) and web GUI require a minimumscreen resolution of 600 by 800 pixels.6 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||Operating System requirementsThe Tivoli Storage Manager Version 6.4 32-bit Windows client requires one of thefollowing operating systems:v Windows Vistav Windows 7v Windows 8v Windows Server 2008v Windows Server 2008 Server CoreThe Tivoli Storage Manager Version 6.4 64-bit Windows client requires one of thefollowing operating systems:v Windows Vistav Windows 7v Windows 8v Windows Server 2008v Windows Server 2008 Server Corev Windows Server 2008 R2v Windows Server 2012v Windows Server 2012 Server CoreRestriction: For GPFS support on 64-bit Windows Server 2008 and 64-bitWindows Server 2008 R2 systems, you must also install GPFS version 3.The supported operating systems are listed in a technote at the followingURL: http://www.ibm.com/support/docview.wss?rs=663&context=SSGSG7&uid=swg21243309.Windows client communication methodsThe TCP/IP and shared memory communication methods are available for theWindows backup-archive client.You can use the following communication methods with the Tivoli StorageManager Windows client:Table 6. Windows client communication methodsTo use this communicationmethod:TCP/IPNamed PipesShared MemoryInstall this software:TCP/IP (Standard with allsupported WindowsNamed Pipes (Standard withall supported Windowsplatforms)TCP/IP (Standard with allsupported Windowsplatforms)To connect to these TivoliStorage Manager servers:AIX ® , HP-UX IA, Linux,Solaris, WindowsWindowsWindowsBackup-archive client features that are available on WindowsplatformsThis topic lists which features are supported or not supported on the variousWindows platforms.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 7

Table 7 shows the supported and unsupported features on the various Windowsplatforms.||Note: ASR from WinPE environment is not supported on 64-bit architectures withExtensible Firmware Interface (EFI).Table 7. Supported features on Windows platforms||||||||||||64-bitWindows832-bit WindowsFeatures32-bit 64-bitWindows Server32-bit 64-bit82008Windows WindowsVista Vista77Windows WindowsServer Server2008 2008 R2WindowsServer2012Journal-based backup yes yes yes yes yes yesOnline image backup yes yes yes yes yes yesOffline image backup yes yes yes yes yes yesSystem state support withVolume ShadowcopyServices (VSS)yes yes yes yes yes yesLAN-free operations no no no no yes yesAutomated SystemRecovery (ASR)yes BIOS: yes yes BIOS: yes yes BIOS: yesEFI: noEFI: noEFI: noOpen File Support (OFS) yes yes yes yes yes yesWindows supported file systemsThis topic lists the types of file systems that are supported on the Tivoli StorageManager Windows Backup-Archive Client.|The Tivoli Storage Manager Windows Backup-Archive Client supports thefollowing types of file systems:v GPFSv File Allocation Table (FAT and FAT32)v NT File System (NTFS)NDMP support requirements (Extended Edition only)You can use the Network Data Management Protocol (NDMP) to back up andrestore network attached storage (NAS) file systems to tape drives or libraries thatare locally attached to Network Appliance and EMC Celerra NAS file servers.NDMP support is available only on IBM Tivoli Storage Manager Extended Edition.NDMP support requires the following hardware and software:v Tivoli Storage Manager Extended Edition8 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vTape drive and tape library. For supported combinations, go to:http://www.ibm.com/software/tivoli/products/storage-mgr/product-links.htmlInstallation requirements for backing up and archiving Tivoli StorageManager FastBack client dataBefore you can back up or archive your FastBack client data, you must install therequired software.You must install the following software:v Tivoli Storage Manager FastBack Version 6.1v Tivoli Storage Manager client Version 6.1.3.x (where x is 1 or higher) or Version6.2 or laterv Tivoli Storage Manager server Version 6.1.3 or higherv Tivoli Storage Manager Administration Center Version 6.1.3– Required only if you want to use integrated Tivoli Storage Manager FastBack- administration.The Tivoli Storage Manager FastBack environment must be running. Forinformation about installing and setting up Tivoli Storage Manager FastBack, seeTivoli Storage Manager FastBack Installation and User's Guide, at:http://pic.dhe.ibm.com/infocenter/tsmfbinf/v6For information about integrating Tivoli Storage Manager and Tivoli StorageManager FastBack, see IBM Tivoli Storage Manager Integration Guide for Tivoli StorageManager FastBack ® .You can install Tivoli Storage Manager client in one of the following ways:v Install Tivoli Storage Manager client on a workstation where the FastBack serveris installed. In this case, the prerequisites are: the FastBack server, the FastBackshell, and the FastBack mount.v Install Tivoli Storage Manager client on a workstation where the FastBack DRHub is installed. In this case, the prerequisites are: the FastBack DisasterRecovery Hub setup, the FastBack shell, and the FastBack mount.v Install Tivoli Storage Manager client on a workstation where neither theFastBack server or the FastBack Disaster Recovery Hub is installed. In this case,ensure that the FastBack shell and the FastBack mount are installed.Related concepts:“Configuring the client to back up and archive Tivoli Storage Manager FastBackdata” on page 55Client configuration wizard for Tivoli Storage Manager FastBackThe IBM Tivoli Storage Manager Backup-Archive client provides a wizard toconfigure the backup-archive client for Tivoli Storage Manager FastBack.The wizard is available in a remote application (the Web client) and in a localapplication (the Java GUI). The wizard helps you set the options to send FastBackclient data to the Tivoli Storage Manager server on a scheduled basis.You can use the Tivoli Storage Manager Client Configuration wizard for TivoliStorage Manager FastBack on 32-bit Windows systems that are supported by bothTivoli Storage Manager and FastBack. The configuration wizard must be installedChapter 1. Installing the Tivoli Storage Manager backup-archive clients 9

on the same workstation where the FastBack server resides, or where a FastBackDisaster Recovery Hub is deployed. You can use the client configuration wizard forTivoli Storage Manager FastBack with Tivoli Storage Manager FastBack V5.5.1 orlater versions.Related concepts:“Configuring Tivoli Storage Manager to protect FastBack client data” on page 56||||||||||||||||||||||||||||||||||||Installing the Tivoli Storage Manager Windows clientYou can install the Tivoli Storage Manager Windows client from the product DVD,or other installation media.Before you begin a Tivoli Storage Manager Windows client installation, ensure thatthe system that you want to install the client on meets the client requirements.Then, determine the type of installation that you need to perform, and follow thesteps in the appropriate procedure.Hardware and software requirements for the Tivoli Storage Manager for WindowsBackup-Archive Client are maintained on the web at http://www.ibm.com/support/docview.wss?uid=swg21197133Windows client installation might require a rebootAs part of the Windows client installation process, one or more Microsoft C++redistributable packages are installed, if they are not already installed on theWindows workstation. These packages can also be automatically updated by theWindows Update service. If the packages are updated, the update can cause thesystem to reboot when you start the Windows client installation program.The reboot that is triggered if the C++ redistributable packages are updated canoccur, even under any of the following conditions:vvvAn automatic client deployment pushes a client upgrade to a node, and theclient or the scheduler sets the AUTODEPLOY=NOREBOOT option.A manual installation or upgrade of the client is started.A client silent installation is started, even if the options to suppress rebootprompts, and the client reboot itself, are set.Additionally, because the Microsoft Visual Studio C++ redistributable package is ashared Windows component, other applications that have dependencies on thepackage might be stopped or restarted by Windows as part of the installation orupgrade of the C++ redistributable package. Schedule client installations andupgrades during a maintenance window when other applications will not beadversely affected if they are stopped or restarted when the C++ redistributablepackage is installed. Monitor other applications after the client is installed to seewhether there are any applications that were stopped and not restarted.Installation typesThe procedure that you follow to install the Tivoli Storage Manager version 6.4Windows Backup-Archive Client depends on the type of installation that you wantto perform.Procedures are provided for each of the following installation types:10 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||Installation typeInstalling the Windows client for the firsttimeUpgrading the Windows clientInstallation descriptionDescribes how to install the Tivoli StorageManager Windows Backup-Archive Clientfor the first time. This procedure presumesthat the Windows computer that you areinstalling the client on has never had aprevious version of the client installed on itbefore.Describes how to upgrade an earlier versionof the Tivoli Storage Manager WindowsBackup-Archive Client to version 6.4.Reinstalling the Windows client Describes how to reinstall the version 6.4Windows client if you uninstalled it.Silent installation Describes how to install the version 6.4client silently, without user interactionduring the installation procedure.Repairing, modifying, or uninstalling theWindows clientDescribes how to add or remove featuresfrom an installed client (modify), replacedamaged files or missing registry keys(repair) or uninstall the Windows client.Installing the Windows client for the first timeComplete this procedure to install the Tivoli Storage Manager WindowsBackup-Archive client for the first time.If you have an earlier version of the Tivoli Storage Manager WindowsBackup-Archive client already installed on a node and you want to upgrade it toversion 6.4, see “Upgrading the Windows client” on page 15.Important: You must know the host name or IP address of the Tivoli StorageManager server, the port number that the server listens on for clientcommunications, and the communications method to use when the clientcommunicates with the server. Obtain this information from your Tivoli StorageManager server administrator before you start this procedure.1. Install the product by using the installation DVD or by using the compressedinstallation file that you download from IBM.||||||OptionInstall from a DVDDescription1. Insert the DVD into the DVD drive.2. If the installation program does notautomatically start, browse the DVD tolocate the setup.exe file. Double-click thesetup.exe file.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 11

|OptionDescription||||||||||||||||||||||||||||||||||||||Install using a compressed installation file 1. The Tivoli Storage Manager version 6.4Quick Start Guide provides a link to adocument that describe how todownload the Windows Backup-ArchiveClient distribution package from the IBMPassport Advantage ® web site. Followthe directions in the download documentto obtain the required file.2. Copy the compressed installation file thatyou downloaded from PassportAdvantage a local disk or to anetwork-accessible share.3. Double-click the compressed installationfile.4. Specify a directory location for theuncompressed files and click Next. Bydefault, this directory is the current diskdrive, in drive:\tsm_images\TSM_BA_Client directory. If theinstallation program detects files fromanother client installation attempt in thisdirectory, you are prompted to determinewhether you want to overwrite the oldfiles. If you receive this prompt, selectYestoAllto overwrite the existing files;this selection ensures that only the filesfrom the current installation are used.2. Select a language to use for this installation and click OK.3. If the installation wizard indicates that one or more Microsoft C++redistributable files must be installed, click Install. These files are required torun the Windows client.4. On the Tivoli Storage Manager client welcome screen, click Next to begininstalling the client software.5. Accept the default installation directory by clicking Next, or specify a differentinstallation directory. The default installation directory is C:\ProgramFiles\Tivoli\TSM.6. Select the installation type: Typical or Custom.|||||||||OptionTypicalDescriptionA typical installation installs the followingcomponents:vvvThe Backup-Archive Client GUI files(required to use the Java GUI)The Backup-Archive Client web files(required to use the web client)The Client API files (as needed by yourclient and operating system)12 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||||||||||||OptionCustomDescriptionA custom installation installs the same filesas a typical installation. However, you canchoose to install the following optionalcomponents:vvvThe API SDK files (only needed if you aredeveloping applications that work withthe Tivoli Storage ManagerBackup-Archive ClientThe Administrative Client Command LineFiles (required to remotely runadministrator functions on the TivoliStorage Manager serverVMware vStorage API runtime files(needed if you are using this client toback up VMware virtual machines)7. Click Next, then click Install.8. When the installer completes the installation, click Finish.9. Verify the installation. Click Start > All Programs > Tivoli Storage Manager.The client components that you installed are shown in the list of TivoliStorage Manager startable programs. The administrative command-line client,backup-archive command-line client, and the backup-archive GUI are the onlycomponents that are displayed in this list. The administrative command-lineclient is only shown if you perform a custom installation and you include theadministrative command-line client. If you installed other components, suchas the API, SDK, or VMware vStorage API runtime files, they are not shownin this list.10. Click Backup-Archive GUI to start the client GUI. The TSM Client OptionsFile Configuration Wizard starts. Click Next to start the wizard.11. On the Options File Task screen, select Create a new options file and clickNext.12. On the TSM Node Name screen, specify a node name. A node name uniquelyidentifies your node to the Tivoli Storage Manager server. The default nodename is the short host name of the Windows computer that you are installingthe client on. Accept the default node name or specify a new node name.Click Next.13. On the TSM Client/Server Communications screen, specify thecommunications method to use when the client communicates with the serverand click Next. This information must be provided to you by your TivoliStorage Manager administrator. If you are not sure what to select, accept thedefault setting (TCP/IP). If the default setting does not work when the clientattempts to connect to the server, contact the Tivoli Storage Manager serveradministrator to determine which communications method to specify.14. On the TCP/IP Options screen, specify the server address and portinformation that your Tivoli Storage Manager administrator provided to you.In the Server Address field, specify the IP address or host name of the TivoliStorage Manager server. In the Port Number field, specify the port numberthat the server listens on for client communications. Click Next.15. The Recommended Include/Exclude List screen contains a list of system filesand directories that are typically included, or excluded from client operations.The excluded files are typically not required to restore your system. You canselect or clear all default selections. Alternatively, you can use the Shift andChapter 1. Installing the Tivoli Storage Manager backup-archive clients 13

|||||||||||||||||||||||||||||||||Ctrl keys to selectively include objects. To facilitate the installation process,click Select All; you can add or remove files from this list later, if you needto. Click Next.16. The Common File Exclusion Selection screen provides a default list of fileextensions that you can exclude from client operations. The file extensions thatare provided in this list are typically large files, like graphics or multimediaextension. These files consume server disk space but they might not berequired to restore critical data. Click Select All to exclude all of the defaultfile extensions. Alternatively, you can use the Shift and Ctrl keys to selectivelychoose which extensions to exclude from client operations. Click Clear All toclear any extensions that you have selected. You can modify these extensionslater, if you need to. Click Next.17. The Domains for Backup screen specifies the default file systems and objectsto include in client operations for incremental and image backups.a. In the Backup Type field, select Incremental. By default, Back up all localfile systems is selected. If you do not want to back up all local file systemsas the default action during incremental backups, clear this option andindividually select the file systems to include. You can override the defaultselection when you initiate an incremental backup operation.b. In the Backup Type field, select Image. By default, Back up all local filesystems is selected. If you do not want to back up all local file systems asthe default action during image backups, clear this option and individuallyselect the file systems to include. You can override the default selectionwhen you initiate an image backup operation.c. Click Next.18. On the Confirm and apply your configuration screen, click Apply. The Logininto a TSM server screen displays and prompts you to enter a user ID andpassword to log on to the Tivoli Storage Manager server. The user ID defaultsto the node name that you specified in step 12 on page 13.19. You can accept the default user ID or specify a different user ID. Specify thepassword that you will use when you log on to the server. Click Login. Whathappens next depends on whether the Tivoli Storage Manager server isconfigured for open or closed registration.14 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||OptionServer is configured for open registrationServer uses closed registrationDescriptionThe Register New Node screen prompts youfor contact information and it prompts youagain for the password.Adding text to the Contact Information fieldis optional, but suggested; specify yourname.Re-enter your password, twice, in the twoPassword fields. If the password that youenter and confirm in these Password fieldsdoes not match what you previouslyspecified in the Login into a TSM serverscreen, the password that you specify andconfirm here becomes the password that isrequired to log on to the server.Click Register to register this node on theserver.Click Finish. The graphical user interfaceopens and is ready for use. You can alsostart any of the other installed clientcomponents from the Start menu.Click Finish. Provide the information thatyou specified in the client configurationwizard to your Tivoli Storage Managerserver administrator. Provide theadministrator with the followinginformation:v The node name that you specified.vvThe user ID and password that youentered.Your contact information, such as yourname, email address, and phone number,so the administrator can contact you afteryour node and user information isregistered on the server.After the administrator registers your node,you can start any of the installed clientcomponents from the Start menu.||||||||||||Upgrading the Windows clientYou can upgrade a earlier version of the Tivoli Storage Manager WindowsBackup-Archive Client to version 6.4. Your previous configuration settings arepreserved, where it is possible to do so. However, enhancements that are in thelatest version of the client can deprecate or prohibit the use of options that wereavailable in earlier versions of the client.Wait for any in-progress backup-archive client tasks (backup, restore, archive,retrieve) to complete before you upgrade a client node.To upgrade to the version 6.4 Windows client, install the version 6.4 Windowsclient; you do not need to uninstall previously installed client software first. Theversion 6.4 client installation program preserves your current client options andsettings (in dsm.opt), and it does not overwrite or delete the dsmerror.log,Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 15

|||||||||||||||||||dsmsched.log, and dsmwebcl.log files, if you install the new client into the samedirectory that was used by the previous installation.The Logical Volume Snapshot Agent (LVSA) component has been deprecated inversion 6.4. If you previously had LVSA configured as your snapshot provider,install the version 6.4 client, and then configure it to use the Microsoft VolumeShadow Copy Service (VSS) as the snapshot provider in the new installation. IfLVSA was installed, your client reboots after the upgrade installation completes, toallow for the removal of LVSA entries from the registry.The installation program stops any client services that are running before itupgrades the client software. If you prefer, you can manually stop the services byusing the control panel or command line. Table 8 shows the stoppable services, andthe names to look for in the Control Panel > Administrative Tools > Services list,so you can stop them with the Control Panel. The table also provides thecommands to stop them from a command prompt or a script.Note: The service names that are shown in the table are the default names that areset by the installation program. You can change some of these service names whenyou configure the services by using one of the configuration wizards on theUtilities > Setup Wizard menus. If you change the service name, record the namethat you specify and use that name to stop the services.|||||||Table 8. Stoppable servicesControl panel display nameTSM Journal ServiceTSM Client AcceptorTSM Client SchedulerRemote Client AgentCommand-line procedurenet stop "tsm journal service"net stop "tsm client acceptor"net stop "tsm client scheduler"net stop "tsm remote client agent"||||Perform the following steps to upgrade an earlier version of the Tivoli StorageManager Windows Backup-Archive Client to version 6.4:1. Install the product by using the installation DVD or the compressedinstallation file that you downloaded from Passport Advantage.||||||OptionDVDDescription1. Insert the DVD into the DVD drive.2. If the installation program does notautomatically start, browse the DVD tolocate the setup.exe file. Double-click thesetup.exe file.16 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||OptionCompressed installation fileDescription1. Copy the compressed installation file thatyou downloaded from PassportAdvantage a local disk or to anetwork-accessible share.2. Double-click the compressed installationfile name.3. The program prompts you for a directoryto unpack the files to. By default, thisdirectory is the current disk drive, indrive:\tsm_images\TSM_BA_Clientdirectory.4. Accept or change the location for theuncompressed installation files. If theinstallation program detects files fromanother client installation attempt in thisdirectory, you are prompted to determinewhether you want to overwrite the oldfiles. If you receive this prompt, selectYestoAllto overwrite the existing files;this selection ensures that only the filesfrom the current installation are used.2. Select a language to use for this installation and click OK.3. If you are prompted to install one, or more, Microsoft C++ redistributablefiles, the prompt indicates that your node does not have the C++ files that arerequired by the Windows Backup-Archive Client. Click Install to install thefiles and continue with the client installation; or, click Cancel to end theinstallation process.4. The Tivoli Storage Manager Windows Backup-Archive Client installationprogram starts. On the Welcome screen, click Next to begin installing the newclient software.5. Accept or change the default installation directory.6. Select the installation type: Typical or Custom.|||||||||OptionTypicalDescriptionA typical installation installs the followingcomponents:vvvThe Backup-Archive Client GUI files(required to use the Java GUI)The Backup-Archive Client web files(required to use the web client)The Client API files (as needed by yourclient and operating system)Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 17

||||||||||||||||||||||||||||||||||||||||||||||||||OptionCustomDescriptionA custom installation installs the same filesas a typical installation. However, you canchoose to install the following optionalcomponents:vvvThe API SDK files (these files are onlyneeded if you are developing applicationsthat work with the Tivoli Storage ManagerBackup-Archive Client).The Administrative Client Command LineFiles (required to run administratorfunctions on the Tivoli Storage Managerserver).VMware vStorage API runtime files(required if you are using this client toback up VMware virtual machines).7. Click Next, then click Install.8. When the installer completes the installation, click Finish.9. Verify the installation. Click Start > All Programs > Tivoli Storage Manager.The client components that you installed are shown in the list of TivoliStorage Manager startable programs. This list includes only the administrativecommand-line client, backup-archive command-line client, or thebackup-archive GUI. The other installable components (the API, SDK, andVMware vStorage API runtime files) do not display in this list.10. Click the Backup-Archive GUI entry in the startable programs list.a. When prompted, type your user ID and password and click Login.b. After the GUI starts, click Help > About TSM. Verify that the versionshown is version 6.4.Your previous configuration settings are preserved in the dsm.opt file. If youpreviously used LVSA as the snapshot provider, warning messages are displayedwhen the command-line client is started. The messages provide instructions to editthe dsm.opt file and remove the LVSA options. Removing the unused options isnot required, but removing options that have no affect or are not used, canfacilitate troubleshooting. If you are using the GUI, the messages are not displayed,but they are logged in the dsmerror.log file, which is in the client installationdirectory, in the baclient directory. Messages are issued when any of the followingoptions are included in dsm.opt. Some of these options are valid for VSS, and ifthey are, the messages are displayed and logged only if they contain parametersthat are specific to LVSA.v snapshotcachelocationv snapshotfsidleretriesv snapshotproviderimagev snapshotproviderfsv snapshotcachesizeYou can set VSS options on the Snapshot tab in the Preferences Editor. They canalso be set by running the online image support and open file supportconfiguration wizards. To use the wizards, start the GUI and click Utilities > SetupWizard. Select the wizards that you want to run, click Next, and follow theprompts to make your selections.18 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||||||||Reinstalling the Windows clientIf you uninstall the version 6.4 Windows client, you can reinstall it if you need to.If you reinstall the Windows client into the same directory that it was installed inbefore, the previous configuration information is detected by the installationprogram. Because the previous configuration information is detected, theinstallation process is the same as an upgrade installation; follow the steps in“Upgrading the Windows client” on page 15 to reinstall the Windows client.If you do not want to preserve the old configuration information, you can removeit. For information about thoroughly removing client settings and files, see thearticle at http://www.ibm.com/developerworks/mydeveloperworks/wikis/home/wiki/Tivoli Storage Manager/page/How to completely remove theBackup-Archive client from Microsoft Windows.If you do completely remove all configuration settings and later decide to reinstallthe Windows client, follow the steps in “Installing the Windows client for the firsttime” on page 11. That procedure is the appropriate installation procedure tofollow if you reinstall the software into a different directory, or if you reinstall thesoftware on a system that contains no previous configuration information.Silent installationThe Tivoli Storage Backup-Archive Client installation program supports silent,unattended installations.Note: The backup-archive client requires the Microsoft Visual C++ 2010redistributable package as a setup prerequisite. The graphical installation programinstalls this package for you. If you are silently installing the client usingMSIEXEC, you must separately install the Microsoft Visual C++ 2010redistributable package. The package can be installed before or after the silentinstallation of the client is performed, but it must be installed before you use thebackup-archive client.The C++ restributable package performs a self-check operation to determine if anyupdates are available on the web. If an update is available, the package downloadsand installs the update. After the update is installed, the C++ redistributablepackage reboots the workstation to register and use the updated libraries. Thisreboot is forced by the C++ redistributable update; you cannot prevent this rebootby using the RebootYesNo="No" REBOOT="Suppress" options.Use the following executable files to install the C++ 2010 redistributable package.In these paths, dir represents the drive and directory where you saved the files towhen you extracted them from the installation package.Windows 32-bit clientsdir\ISSetupPrerequisites\{D4408760-7D16-4F02-B7C1-E68612F5FBFD}\(contains vcredist_x86.exe)Windows 64-bit clientsdir\ISSetupPrerequisites\{270b0954-35ca-4324-bbc6-ba5db9072dad}(contains vcredist_x86.exe)dir\ISSetupPrerequisites\{7f66a156-bc3b-479d-9703-65db354235cc}(contains vcredist_x64.exe)To install a predefined (custom) dsm.opt file, use the following instructions beforeyou begin the silent installation.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 19

|||vPlace the customized copy of the dsm.opt file in the ...\CONFIG directorylocated within the install image, for example:tsm_images\TSM_BA_Client\baclient\Program Files\Tivoli\TSM\config|||||||vThe file must be named “dsm.opt”.The install program copies the predefined dsm.opt file to the ..\BACLIENTdirectory when BOTH of the following conditions are met:– dsm.opt does NOT exist in the ..\BACLIENT directory. The install programdoes not copy over an existing dsm.opt file.– dsm.opt exists in the ..\CONFIG directory of the install image, as describedearlier.||||||||||||||||||||||||||||||||||To perform a silent installation of the C++ redistributables or the backup-archiveclient, you must turn off User Account Control (UAC).To turn UAC off, use either the Windows Control Panel or the MSCONFIG utility.To turn UAC off in the Control Panel, select Control Panel > User Accounts >Change User Account Control settings, then select Never Notify.To turn UAC off using MSCONFIG, open a command prompt window and startMSCONFIG. Then select the Tools tab and Change User Account Control settings;then click Launch and turn UAC by selecting Never Notify.After you install the C++ redistributables and the Windows client, remember toturn UAC on.The C++ redistributables require elevated privileges to install them. Open acommand prompt window as follows:1. Click Start Menu > All Programs > Accessories > Command Prompt.2. Right click the Command Prompt icon to view the properties.3. Click Run as administrator.4. Click Continue in the permission window.5. Start the product installation using the command prompt window. On a 32-bitWindows system, install the 32-bit C++ redistributable package. On a 64-bitWindows system, install the 64-bit C++ redistributable package.Silently installing C++ redistributables for the 32-bit clientvcredist_x86.exe /q /c:"msiexec /i vcredist.msi /qn /l*v%temp%\vcredist_x86.log"Silently installing C++ redistributables for the 64-bit clientvcredist_x86.exe /q /c:"msiexec /i vcredist.msi /qn /l*v%temp%\vcredist_x86.log"vcredist_x64.exe /q /c:"msiexec /i vcredist.msi /qn /l*v%temp%\vcredist_x64.log"Install the Windows backup-archive client. User Account Control (UAC) shouldstill be turned off. If it is not turned off, turn off UAC now. Open a commandprompt that has elevated privileges.1. Click Start Menu > All Programs > Accessories > Command Prompt.2. Right click the Command Prompt icon to view the properties.3. Click Run as administrator.4. Click Continue in the permission window.20 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||||||||||||5. Start the Windows backup-archive client silent installation using the commandprompt window. On a 32-bit Windows system, install the 32-bit clients and API.On a 64-bit Windows system, install the 64-bit clients and API. Install one ormore language packs if languages other than English are needed.Silent client installation on Windows 32-bit systemsWhen you place a customized version of the msiexec command (whichinvokes the Microsoft Software Installer) in a script or batch file, you canperform installations on multiple Windows systems. The following is asample command to install the backup-archive command-line client, clientGUI, web client, API, and Administrative command-line client. You mightneed to customize this example to run correctly on your system. While thecommand is physically spread across multiple lines on this page, enter iton a single command line.msiexec /i"Z:\tsm_images\TSM_BA_Client\IBM Tivoli Storage Manager Client.msi"RebootYesNo="No" REBOOT="Suppress" ALLUSERS=1INSTALLDIR="d:\program files\tivoli\tsm"ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,ApiRuntime,AdministrativeCmd"TRANSFORMS=1033.mst /qn /l*v "c:\log.txt"Silent client installation on Windows 64 bit systemsThis example is essentially the same as the 32-bit example. However, itnames the 64 bit API feature on the ADDLOCAL= parameter. The languagepack installation is the same for either platform.msiexec /i"Z:\tsm_images\TSM_BA_Client\IBM Tivoli Storage Manager Client.msi"RebootYesNo="No" REBOOT="Suppress" ALLUSERS=1INSTALLDIR="d:\program files\tivoli\tsm"ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,Api64Runtime,AdministrativeCmd"TRANSFORMS=1033.mst /qn /l*v "c:\log.txt"Silent language pack installation (32 and 64-bit clients)You must install client features before you install a language pack. Install alanguage pack with a command like the following. Although the commandis physically split across multiple lines on this page, enter it on one singlecommand line.msiexec /i"Z:\tsm_images\TSM_BA_Client\IBM Tivoli Storage Manager Client - French.msi"RebootYesNo="No" REBOOT="Suppress" ALLUSERS=1INSTALLDIR="d:\program files\tivoli\tsm"ADDLOCAL="LanguageFiles" TRANSFORMS=1036.mst /qn /l*v "c:\log.txt"The descriptions of the silent installation parameters are as follows:msiexecInvokes the Microsoft Software Installer (MSI) program./i Installs the specified source package (replace with /x to uninstall thepackage)."Z:\tsm_images\TSM_BA_Client\IBM Tivoli Storage Manager Client.msi"The complete path to the source package. Z: is the CD or network drivecontaining the installation image. You must substitute the appropriatedrive letter for your system.RebootYesNo="No" REBOOT="Suppress"Under certain conditions, a system reboot might be necessary for theinstallation to complete successfully. This option causes the installationChapter 1. Installing the Tivoli Storage Manager backup-archive clients 21

|||||||||||||||||||||||||||||||||||||||||||program to not reboot the system if circumstances would otherwise causethe reboot to occur. While this option is convenient, use it with cautionbecause suppressing the reboot might cause the program to behave in anunpredictable manner. The most common reason that a reboot would berequired is if the installation was an upgrade to an existing Tivoli StorageManager client, and the installation was performed while the clientprograms were running. Therefore, shut down all Tivoli Storage Managerclient programs and services before performing the installation.ALLUSERS=1Specifies that the package is for all users. This option is required.INSTALLDIR="d:\program files\tivoli\tsm"Specifies the destination path. If you have already installed this product ora previous version of this product on your workstation, use the currentinstallation directory as the destination path for this package.For 32-bit client installations:ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,ApiRuntime"For 64-bit client installations:ADDLOCAL="BackupArchiveGUI,BackupArchiveWeb,Api64Runtime"Specifies the features to install. Specify all the components on a single linewithin quotation marks, separated by commas, with no spaces before orafter the commas. The backup-archive features are available as shown inthe following table:Windows 32 bit clientfeaturesWindows 64 bit clientfeaturesFeature descriptionBackupArchiveGUI BackupArchiveGUI Graphical user interfaceBackupArchive web BackupArchive web Backup-archive web clientApiRuntimeApi32RuntimeApi64RuntimeAPI RuntimesApiSdk ApiSdk API SDKAdministrativeCmd AdministrativeCmd Administrative Command LineVMwareBackupTools VMwareBackupTools VMware vStorage API runtime filesADDLOCAL="LanguageFiles"After you install client features, you can install a language pack. You mustinstall client features before you install a language pack.Windows 32 bit clientfeaturesWindows 64 bit clientfeaturesFeature descriptionLanguageFiles LanguageFiles Language-specific filesTRANSFORMS=1033.mstSpecifies which language transform to use. The following languagetransforms are available:|||||Transform1028.mst1029.mst1031.mst1033.mstLanguageCHT Traditional ChineseCSY CzechDEU GermanENG English22 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||Transform1034.mst1036.mst1038.mst1040.mst1041.mst1042.mst1045.mst1046.mst1049.mst2052.mstLanguageESP SpanishFRA FrenchHUN HungarianITA ItalianJPN JapaneseKOR KoreanPLK PolishPTB PortugueseRUS RussianCHS Simplified Chinese/qn Specifies to perform the installation silently./l*v "c:\log.txt"Specifies verbose logging and the name and location of the log file.The installation process creates a Tivoli Storage Manager folder in the programsfolder of the Windows Start menu. You can start Tivoli Storage Manager byclicking one of the icons in this folder.Modifying, repairing, or uninstalling the Windows clientYou can modify, repair, or uninstall an existing Windows client.Use the Windows control panel to modify, repair, or uninstall the Windows client.1. Click Start > Control Panel > Uninstall a program.2. Select IBM Tivoli Storage Manager Client in the list of installed programs.3. Select the function that you want to perform: Repair, Change, orUninstall.|||||||||OptionRepairDescriptionWait for any in-progress backup-archive client tasks to completed before yourepair the Windows client.This option repairs an existing Windows client installation. If you selectRepair, the files installed by the installation program are examined todetermine whether they have somehow become corrupted. If a file isdetermined to be corrupted, the repair option attempts to replace it from theDVD or saved installation image. The repair option also repairs missingprogram short cuts and icons, missing files, and registry keys.Chapter 1. Installing the Tivoli Storage Manager backup-archive clients 23

||||||||||||||||||||OptionChangeDescriptionWait for any in-progress backup-archive client tasks to completed before youmodify the Windows client.This option modifies an existing installation. If you select Change, the nextscreen that is displayed shows Modify as the option for changing installedprograms. If you already installed the client and you need to add or removecomponents, click Change, and select Modify. Choose the icon next to thefeature that you want to install or remove and select the appropriate actionfrom the drop-down list. For example, if you selected a typical installationwhen you installed the client, the administrative client command lineinterface files are not installed. If you decide that a node needs thisinterface, select the icon next to Administrative Client Command Line Filesand click the This feature will be installed on local hard drive option.Note: This option achieves the same effect as upgrading the client. Thedifference is that you bypass the initial steps and the installation processbegins with the last installation type that you selected. If you want tochange the installation type, you can click Back, and select the newinstallation type; then complete the information as you are prompted for it.Use the information that is provided in “Upgrading the Windows client” onpage 15 (start at step 6 on page 17) if you have questions about a prompt.24 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||OptionUninstallDescriptionWait for any in-progress backup-archive client tasks to completed before youuninstall the Windows client.This option uninstalls the Windows client program. It does not remove anyclient services. It also does not remove log files, or other items that werecreated when you configured or used the client. Most of these artifactsremain in the installation directory (Program Files > Tivoli >TSMdirectory), but they can exist anywhere on the disk, depending on whatyou chose for the installation directory and other options. This option alsodoes not remove files that were copied to the local disk if you extracted theinstallation files from a compressed distribution file.Leaving these artifacts on disk is not a problem if you want to reinstall theclient in the future. However, if you want to more thoroughly remove theclient and related files and settings, see the article at http://www.ibm.com/developerworks/mydeveloperworks/wikis/home/wiki/Tivoli StorageManager/page/How to completely remove the Backup-Archive client fromMicrosoft Windows.The installation program stops any client services that are running before ituninstalls the software. If you want to stop the services yourself, type thefollowing commands at a command prompt window:net stop "tsm journal service"net stop "tsm client acceptor"net stop "tsm client scheduler"net stop "tsm remote client agent"You can also use the Control Panel to stop these services. Their displaynames match the name used on the command line.Note: The service names shown here are the default names that are set bythe installation program. You can change some of these service names whenyou configure the services using one of the configuration wizards on theUtilities > Setup Wizard menus. If you change the service name, record thename that you specify and use that name to stop the services.If you want to remove any of these services without uninstalling the client,perform the following steps:1. Click Start > All Programs > Tivoli Storage Manager > Backup-ArchiveGUI.2. Click Utilities > Setup Wizard.3. Select and run the wizard for each service that you want to remove. Thesetup wizard options can also remove the configuration information foronline image support and open file support.||||||||||Troubleshooting problems during installationIf you are upgrading from a previous version of Tivoli Storage Manager and thereare Tivoli Storage Manager services running (for example, Client Acceptor orScheduler), you might see an error during the installation.You might see the following error during installation:Error 1303. The installer has insufficient privileges to access this directory:(Install Drive):\Program Files\Tivoli\TSM\baclient\plugins. The installationcannot continue. Log on as an administrator or contact your system administrator.When this error occurs, you must stop the installation. After stopping theinstallation process, the previous version is no longer installed. Stop the TivoliChapter 1. Installing the Tivoli Storage Manager backup-archive clients 25

|Storage Manager services and retry the installation process.26 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 2. Configure the Tivoli Storage Manager clientAfter successfully installing the Tivoli Storage Manager client, you must configurethe client before performing any operations.If you are upgrading your Tivoli Storage Manager client, it is unnecessary toreconfigure the scheduler, Web client, or other configuration settings. If thedsm.opt file used by the previous client installation is available in the defaultinstallation directory or the directory or file pointed to by the DSM_CONFIG andDSM_DIR environment variables, Tivoli Storage Manager accesses this file forconfiguration information.There are some required and optional configuration tasks. The required configurationtasks include the following:v “Creating and modifying the client options file”v “Register your workstation with a server” on page 75||||||||||||||||||Optional configuration tasks include the following:v “Create a shared directory options file” on page 29v “Creating multiple options files” on page 29v “Environment variables” on page 30v “Configuring the Web client” on page 31v “Configuring the client scheduler” on page 33v “Configuring the journal engine service” on page 41v “Configuring online-image backup support” on page 69v “Configuring Open File Support” on page 70v “Creating an include-exclude list” on page 76v Configuring parallel backups of VMware virtual machines. See “Parallel backupsof VMware virtual machines” on page 155Creating and modifying the client options fileThe client options file is an editable text file that contains configurationinformation for the backup-archive client.The first time that you start the Windows Backup-Archive Client GUI, theinstallation program searches for an existing client options file, called dsm.opt. Ifthis file is not detected, a client options file configuration wizard starts andprompts you to specify initial client configuration settings. When the wizardcompletes, it saves the information that you specified in the dsm.opt file. Bydefault, the dsm.opt file is saved to C:\Program Files\Tivoli\TSM\baclient.The options file must contain the following information to communicate with theserver:v The host name or IP address of the Tivoli Storage Manager server.vThe port number that the server listens on for client communications. A defaultport number is configured by the client options file configuration wizard. Youdo not need to override this default port number unless your server isconfigured to listen on a different port.© Copyright IBM Corp. 1993, 2012 27

|||||||||||||||||||||||v Your client node name. The node name is a name that uniquely identifies yourclient node. The node name defaults to the short host name of the computer thatthe client is installed on.Additional client options can be specified, as needed.Note: Client options can also be set on the server in a client option set. Clientoptions that are defined on the server in a client option set override client optionsthat are set in the client options file.A sample options file is copied to your disk when you install the backup-archiveclient. The file is called dsm.smp. By default, the dsm.smp file is copied toC:\Program Files\Tivoli\TSM\config\. You can view the contents of this file to seeexamples of different options and how they are specified. The file also containscomments that explain syntax conventions for include lists, exclude lists, andwildcard use. You can also use this file as a template for your client options file byediting it and saving it as dsm.opt in the C:\Program Files\Tivoli\TSM\baclientdirectory.After the initial client options file is created, you can modify the client options byadding or changing the options as needed. You can modify the dsm.opt file in anyof the following ways:v By running the client options file configuration setup wizardv By using the client preferences editorv By editing the dsm.opt file with a text editor program, such as NotepadPerform the following steps to modify the client options:1. Select a method to modify the file.|||||||||||||||||||||||||OptionSetup wizardPreferences editorDescription1. Click Start > All Programs > TivoliStorage Manager > Backup-ArchiveGUI.2. Select Utilities > Setup Wizard > Helpme configure the TSM Client OptionsFile. On-screen text and online help isavailable to provide guidance as younavigate through the wizard panels. Thisclient options file configuration wizardoffers limited choices and configuresonly the most basic options.1. Click Start > All Programs > TivoliStorage Manager > Backup-ArchiveGUI.2. Select Edit > Client Preferences. Selectthe tabs in the preferences editor to setclient options. Specify the options in thedialog boxes, drop down lists, and othercontrols. Online help is provided. Clickthe question mark (?) icon to display thehelp topics for the online help for the tabthat you are editing. You can set moreoptions in the preferences editor thanyou can set in the setup wizard.28 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||OptionEdit the dsm.opt fileDescription1. Edit the dsm.opt file by using a plain texteditor. Each of the options is described indetail in the documentation in “Clientoptions reference” on page 294. Thismethod is the most versatile way to setclient options because not all options canbe set in the client options fileconfiguration wizard or in thepreferences editor.2. To comment out a setting, insert anasterisk (*) as the first character on theline that you want to comment out.Remove the asterisk to make thecommented option active.2. Save the changes.a. Changes made in the client options file configuration wizard and in thepreferences editor are saved and recognized by the client when the wizardcompletes, or when you exit the preferences editor.b. If you edit the client options file with a text editor while the client isrunning, you must save the file and restart the client so the changes aredetected.Related concepts:“Client options reference” on page 294“Communication options” on page 268Chapter 11, “Processing options,” on page 267“Register your workstation with a server” on page 75Related reference:“Passwordaccess” on page 433Create a shared directory options fileA server administrator can generate client options files in a shared directory.Windows clients can access the shared directory, and use the files there to createtheir own client options file.Creating a shared directory options file is an optional root user or authorized usertask.For more information, see IBM Tivoli Storage Manager for Windows Installation Guide,SC32-0138.Creating multiple options filesYou can create multiple options files if you have to work with multiple servers, orfind that you need multiple sets of parameters to perform backup or archive tasks.Suppose you want to back up your files to one server (server a), and archive filesto another (server b). Instead of editing the dsm.opt file each time you want toconnect to a different server, create two options files. For example, create theoptions files a.opt for server a, and b.opt for server b.Chapter 2. Configure the Tivoli Storage Manager client 29

Environment variablesThen do one of the following:1. From a command prompt, use the copy command to replace the dsm.opt filewith the appropriate options file before you begin a backup or archive session.For example: copy a.opt dsm.opt, then dsm.2. Use the optfile option on the command line to specify the options file youwant to use. For example: dsm -optfile=b.opt.3. Define the DSM_CONFIG environment variable to specify the options file touse: SET DSM_CONFIG=C:\Program Files\Tivoli\TSM\baclient\b.opt.If you are running from the command line, the DSM_DIR and DSM_LOGenvironment variables might also need to be configured as follows:1. Define the DSM_DIR environment variable to point to the directory where allother executable files reside:SET DSM_DIR=C:\Program Files\Tivoli\TSM\baclient2. Define the DSM_LOG environment variable to point to the directory wheredsmerror.log resides:SET DSM_LOG=C:\Program Files\Tivoli\TSM\baclientNote: The directory path where the client executable files are located must beincluded in the PATH environment variable or you must enter a fully qualifiedpath.Generally, setting the environment variables is an optional task. Setting themmakes it more convenient for you to use the command line.You must set the environment variables if you need to run in either of thefollowing environments:vvYou want to invoke Tivoli Storage Manager from a directory other than thedirectory where Tivoli Storage Manager is installed.You want to specify a different options file for the backup-archive client, theadministrative client, or both.Note: You can also specify an alternate client options file for the command-lineclient (not the administrative client) using the optfile option.You need to set four environment variables:PATH This is the default search path the operating system uses to locateexecutable files. Set this to include the fully qualified paths of the clientinstallation directories.DSM_CONFIGSet this environment variable to the fully qualified path and file name ofthe client options file.DSM_DIRSet this environment variable to the directory where the client message filedsc*.txt is located.DSM_LOGSet this environment variable to the directory where the log files shouldreside.Ensure that the environment variables meet the following guidelines:30 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Configuring the Web clientvvInclude the directory where the executable files (for example, dsm.exe) reside inthe current PATH environment variable. If you accepted the default installationdirectory using the C: drive, you can set this from a command prompt bytyping:SET PATH=C:\Program Files\Tivoli\TSM\baclientSpecify the fully-qualified path name of your client options file (dsm.opt) usingthe DSM_CONFIG environment variable:SET DSM_CONFIG=C:\Program Files\Tivoli\TSM\baclient\dsm.optv Define the DSM_DIR environment variable to point to the directory where theTivoli Storage Manager client message file dsc*.txt is located:SET DSM_DIR=C:\Program Files\Tivoli\TSM\baclientRelated reference:“Optfile” on page 430This task guides you through the steps to configure the Web client.You can use the GUI Setup wizard or command line to install and configure theWeb client.To install and configure the Web client using the GUI Setup wizard, perform thefollowing steps:1. From the backup-archive client GUI main window, open the Utilities menu andselect Setup Wizard.2. Select the Help me configure the TSM Web Client check box.3. Click the Next button and then follow the instructions on the screen.To install and configure the Web client from the command line, perform thefollowing steps:1. If MANAGEDServices schedule is set, specify MANAGEDServices webclientschedule in the dsm.opt file.2. Ensure that you specify passwordaccess generate in the client options file(dsm.opt).3. Install the Client Acceptor Service by entering the following command, wherenodename and password are your Tivoli Storage Manager node name andpassword.dsmcutil install cad /name:"TSM CAD" /node:nodename /password:password/autostart:yesTSM CAD is an example name, you can use any name you want. The defaultname is TSM Client Acceptor.4. Install the Remote Client Agent Service by entering the following command,where nodename and password are your Tivoli Storage Manager node name andpassword.dsmcutil install remoteagent /name:"TSM AGENT" /node:nodename/password:password /partnername:"TSM CAD"TSM AGENT is an example name, you can use any name as long as it is differentfrom the CAD name. The default name is TSM Remote Client Agent. The/partnername option value must match the name of the CAD service. Thedefault is name is TSM Client Acceptor.5. Start the client acceptor service (CAD) by entering: net start "TSM CAD" on thecommand line, or do the following:Chapter 2. Configure the Tivoli Storage Manager client 31

a. Open the Windows Start menu and select Settings→ Control Panel.b. Double-click Administrative Tools and then double-click Services.c. In the Services window, right-click TSM CAD and select Start from thepop-up menu.The Tivoli Storage Manager Remote Client Agent service must not be startedmanually. It is automatically started by the Tivoli Storage Manager ClientAcceptor service when needed.The options applicable only to the dsmcad program are httpport,managedservices, and webports. You can also use options such as optfile orerrorlogname. You can use the managedservices option to specify whether theTivoli Storage Manager client acceptor daemon also manages the Tivoli StorageManager scheduler.The Administration Center, which is a component available through the TivoliIntegrated Portal, allows you to securely hyperlink to the client workstation.The web client GUI is launched without the administrator needing to sign onagain. In order for this to be fully secured, SSL needs to be enabled for theTivoli Integrated Portal server.All Web client messages are written to the Web client log file, dsmwebcl.log.Error messages are written to the error log file dsmerror.log, or the file youspecify with the errorlogname option. The dsmwebcl.log and dsmerror.log filesreside in the directory you specify with the DSM_LOG environment variable orin the current working directory. Set this environment variable to the directorywhere the log files should reside. The root directory is not a valid value forDSM_LOG. Specify a directory other than the root directory.6. To access the Web client, enter the following URL from any supported browser,where your_machine_name is the host name of the workstation running the Webclient.:http://your_machine_name:1581Port 1581 is the default port number. You can set a different port number using thehttpport option.The Tivoli Storage Manager Remote Client Agent daemon must not be startedmanually. It is automatically started by the Tivoli Storage Manager Client Acceptordaemon when needed.The options applicable only to the dsmcad program are httpport,managedservices, and webports. You can also use options such as optfile orerrorlogname. You can use the managedservices option to specify whether theTivoli Storage Manager client acceptor daemon also manages the Tivoli StorageManager scheduler.All Web client messages are written to the Web client log file, dsmwebcl.log. Errormessages are written to the error log file dsmerror.log, or the file you specify withthe errorlogname option. The dsmwebcl.log and dsmerror.log files reside in thedirectory you specify with the DSM_LOG environment variable or in the currentworking directory. Set this environment variable to the directory where the log filesshould reside. The root directory is not a valid value for DSM_LOG. Specify adirectory other than the root directory.After installing and configuring the Web client on your workstation you can usethe Web client to perform backup, archive, restore, and retrieve operations.32 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Scheduling options” on page 282Related tasks:“Starting a web client session” on page 97Related reference:“Httpport” on page 388“Passwordaccess” on page 433Configuring the client schedulerThis task guides you through the steps to configure the client scheduler.Your Tivoli Storage Manager administrator can schedule Tivoli Storage Manager toperform tasks automatically.For example, you can automatically back up files at the end of each day or archivesome of your files every Friday. This procedure, known as central scheduling, isacooperative effort between the server and your client node. Your administratorassociates clients with one or more schedules that are part of the policy domainmaintained in the server database. The Tivoli Storage Manager administratordefines central scheduling on the server and you start the client scheduler on yourworkstation. Once you start the client scheduler, further intervention is notnecessary.With client scheduling, you can perform the following tasks:v Display information about available schedules.v Display information about work that the schedule has completed.v Modify scheduling options in the client options file (dsm.opt).The Tivoli Storage Manager Client Acceptor service (CAD) can manage thescheduler. In this case, the CAD serves as an external timer for the scheduler.When the scheduler is started, it queries the server for the next scheduled event.The event is either run immediately or the scheduler exits. The CAD restarts thescheduler when it is time to run the scheduled event. This reduces the number ofbackground processes on your workstation and resolves memory retentionproblems that can occur when running the scheduler service without CADmanagement.You cannot use the dsmcad for scheduling when you set the sessioninitiationoption to serveronly.Use the managedservices option in your client options file (dsm.opt) to specifywhether the CAD manages the scheduler.Important: If you run the client scheduler on the command line, the schedulerdoes not run as a background service.Perform the following steps to configure the CAD to manage the client scheduler:1. Select Utilities → Setup Wizard → Help me configure the TSM ClientScheduler from the Tivoli Storage Manager main window. The TSM SchedulerWizard window appears.2. Select the Install a new or additional scheduler task and press the Nextbutton. The TSM Scheduler name and location window displaysChapter 2. Configure the Tivoli Storage Manager client 33

Starting the client scheduler3. Specify the name of the Scheduler. Select the Local Machine and Use theClient Acceptor daemon (CAD) to manage the schedule options. Click theNext button. The Select the names of the Web services window displays.4. Specify the name of the client acceptor service that you want to manage thescheduler. If the CAD is already installed for use by the Web client, select thatCAD from the drop down list. Otherwise, type the name you want to give theCAD, for example, TSM Client Acceptor. Click the Next button.5. Follow the instructions on the screen to complete the configuration of theoptions file name, the HTTP port the CAD uses, authentication information,service login options, log file names, and immediate start option.Note:v If the sessioninitiation option is set to serveronly in your client options file(dsm.opt), the client setup wizard and scheduler service might be unable toinitiate authentication with the Tivoli Storage Manager server. To avoid thisproblem, ensure that the Contact the TSM Server to validate passwordcheckbox on the TSM Authentication page is unchecked.v In the Service login options window, select the Automatically when Windowsboots option to have the service started automatically when Windows starts sothat your schedules are run.v You can also use the Scheduler Service Configuration utility. The SchedulerService Configuration utility must be run from an account that belongs to theAdministrator/Domain Administrator group. You can start multiple clientscheduler services on your system.v If you are having the CAD manage your schedule, start the CAD service, but donot start the scheduler service. The scheduler service is started and stoppedautomatically by the CAD service as needed. If you are not managing theschedule with the CAD, then you can use the Services Control Panel or the netstart command to start the Scheduler service.v If you include files for encryption, ensure that the encryptkey save option is setin the options file. This option is set by selecting Save Encryption Key PasswordLocally on the Authorization panel in the preference editor. Setting this optionenables unattended scheduled services. If the encryption key has not beenpreviously saved, you must perform an attended backup of at least one file sothat you get the encryption prompt and you can save the key.Related concepts:“Enable or disable scheduled commands” on page 233“Scheduling options” on page 282Related tasks:“Configuring the Web client” on page 31“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Related reference:“Managedservices” on page 414“Sessioninitiation” on page 468To start the Tivoli Storage Manager client scheduler, use the Services Control Panelor the net start command.34 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

To avoid problems, do not run the client scheduler on the command line. Thecommand line does not run the scheduler as a background service.When you start the client scheduler, it runs continuously until you close thewindow, shut down your system, or log out of your system. If you are running theScheduler Service, the scheduler runs until the system is shutdown or youexplicitly stop it using the services control panel.Related concepts:Chapter 11, “Processing options,” on page 267Scheduling events using the GUIThis task guides you through the steps to schedule events using the GUI.1. From the Tivoli Storage Manager main GUI window, select Utilities → SetupWizard. The Client Configuration Assistant appears.2. Select the Help me configure the TSM Client Acceptor Daemon and TSMClient Scheduler and click the OK button. The Scheduler Wizard panelappears.3. Select the task that you want to perform. You can install a new client scheduler,update the settings for a scheduler, or remove a scheduler.4. Complete each panel and click the right arrow to continue. To go back to aprevious panel, click the left arrow.You can run scheduling services by using the command-line client.Configuring Tivoli Storage Manager client/server communicationacross a firewallIn most cases, the Tivoli Storage Manager server and clients can work across afirewall.Every firewall is different, so the firewall administrator might need to consult theinstructions for the firewall software or hardware in use.There are two methods for enabling client and server operations through a firewall:Method 1:To allow clients to communicate with a server across a firewall, thefollowing ports must be opened in the firewall by the firewalladministrator:TCP/IP portTo enable the backup-archive client, command-line admin client,and the scheduler to run outside a firewall, the port specified bythe server option tcpport (default 1500) must be opened by thefirewall administrator. This port is set on the client and the serverusing the tcpport option. The setting must be the same on theclient and server. This allows Tivoli Storage Manager schedulercommunications in both polling and prompted mode, CAD-managedschedulers, and regular backup-archive client operations.Note: The client cannot use the port specified by the tcpadminportoption (on the server) for a client session. That port can be used foradministrative sessions only.Chapter 2. Configure the Tivoli Storage Manager client 35

HTTP portTo allow the Web client to communicate with remote workstationsacross a firewall, the HTTP port for the remote workstation mustbe opened. Use the httpport option in the remote workstationclient options file to specify this port. The default HTTP port is1581.TCP/IP ports for the remote workstationThe two TCP/IP ports for the remote workstation client must beopened. Use the webports option in the remote workstation clientoptions file to specify these ports. If you do not specify the valuesfor the webports option, the default zero (0) causes TCP/IP torandomly assign two free port numbers.TCP/IP port for administrative sessionsSpecifies a separate TCP/IP port number on which the server iswaiting for requests for administrative client sessions, allowingsecure administrative sessions within a private network.Method 2:For the client scheduler in prompted mode, it is unnecessary to open anyports on the firewall. If you set the sessioninitiation option to serveronly,the client will not attempt to contact the server. All sessions are initiated byserver prompted scheduling on the port defined on the client with thetcpclientport option. The sessioninitiation option only affects the behaviorof the client scheduler running in the prompted mode.The Tivoli Storage Manager server must set the SESSIONINITiationparameter on the register node and update node commands for eachnode. If the server specifies SESSIONINITiation=clientorserver, the default,the client can decide which method to use. If the server specifiesSESSIONINITiation=serveronly, all sessions are initiated by the server.Note:1. If sessioninitiation is set to serveronly, the value for the tcpclientaddressclient option must be the same as the value for the HLAddress optionof the update node or register node server command. The value for thetcpclientport client option must be the same as the value for theLLAddress option of the update node or register node servercommand.2. If you set the sessioninitiation option to serveronly, with the exceptionof CAD-managed schedulers, the command-line client, backup-archiveclient GUI, and Web client GUI still attempts to initiate sessions, but areblocked by the Tivoli Storage Manager server for nodes that have thesessioninitiation option set to serveronly.3. When installing Tivoli Storage Manager scheduler using the setupwizard, and the Tivoli Storage Manager server is behind a firewall, thenode password will not get stored on the client workstation. As aresult, the scheduler service might be unable to authenticate to theserver when the server contacts the client to run a schedule. In thiscase, you can run the scheduler from the command line (dsmcschedule), wait until a scheduled operation starts, and enter thepassword for your node when prompted.4. When installing Tivoli Storage Manager scheduler using the setupwizard or dsmcutil, and the Tivoli Storage Manager server is behind afirewall, the node password will not get stored on the clientworkstation. As a result, the scheduler service might be unable to36 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

authenticate to the server when the server contacts the client to run aschedule. In this case, you can run the scheduler from the commandline (dsmc schedule), wait until a scheduled operation starts, and enterthe password for your node when prompted. After you enter thepassword for your node, restart the scheduler service. You can also usethe following dsmcutil command to write the password into theregistry:dsmcutil updatepw /node:nnn /password:ppp /validate:noIf sessioninitiation option is set to serveronly in your client options file(dsm.opt), the client setup wizard and scheduler service is unable toinitiate authentication with the Tivoli Storage Manager server. To avoidthis problem, when configuring the client scheduler using the setupwizard, ensure that the Contact the TSM Server to validate passwordcheckbox on the TSM Authentication page is unchecked.A similar problem can occur if an encryption key is required for backupoperations. In this case, you can run the scheduler from the commandline (dsmc schedule), wait until a scheduled backup starts, and enterthe encryption key when prompted. After the password and encryptionkey are updated, you must restart the scheduler.5. When configuring the Tivoli Storage Manager scheduler on a clientworkstation for the first time, the scheduler service might be unable toauthenticate to the server when the server contacts the client schedulerto run a schedule. This can happen when the passwordaccess is set togenerate and the Tivoli Storage Manager server is behind a firewall andthe encrypted password cannot be locally stored before the scheduler isstarted. To correct this problem, you need to run the scheduler from thecommand line (dsmc schedule), wait until a scheduled operation starts,and enter the password for your node when prompted.6. The Tivoli Storage Manager client cannot prompt for the encryption keypassword in scheduler mode. If you are using Tivoli Storage Managerdata encryption, you must run an initial interactive backup once to setup the encryption key by opening the TCP/IP connection from theclient workstation to the server workstation. See Method 1 for moreinformation about setting up this communication. After the encryptionkey is set, you can use server-initiated sessions to back up the filesusing Tivoli Storage Manager encryption.If you set the sessioninitiation option to client, the client initiates sessionswith the server (Method 1) by communicating on the TCP/IP port definedwith the server option tcpport. This is the default. Server promptedscheduling can be used to prompt the client to connect to the server.When using Tivoli Storage Manager across a firewall, consider the following:v In prompted mode the Tivoli Storage Manager server needs to contact the client.In order to do this, some software might need to be installed on the TivoliStorage Manager server to route the request through the firewall. This softwareroutes the server request through a socks port on the firewall. This is typicallycalled socksifying a system. Proxies are not supported, because they only route afew types of communication protocols (HTTP, FTP, GOPHER). Tivoli StorageManager communications are not routed by proxies. It is important to note thatthe client creates a new connection to the Tivoli Storage Manager server whenprompted. This means that the firewall configuration discussed above must be inplace.Chapter 2. Configure the Tivoli Storage Manager client 37

Related tasks:“Configuring the client scheduler” on page 33Related reference:“Sessioninitiation” on page 468“Tcpadminport” on page 496“Tcpport” on page 501“Webports” on page 534Configuring Tivoli Storage Manager client/server communication withSecure Sockets LayerSecure Sockets Layer (SSL) allows industry standard SSL-based securecommunications between the Tivoli Storage Manager client and server.The following client components support SSL:v Command-line clientv Administrative command-line clientv Backup-archive client GUIv Client APIOnly outgoing client-server connections support SSL. Incoming connections (forexample, CAD, server-initiated schedule connections) do not support SSL.Client-to-client communications and web GUI do not support SSL.Each Tivoli Storage Manager server that is enabled for SSL must have a uniquecertificate. The certificate can be one of the following types:v A certificate that is self-signed by Tivoli Storage Manager.vA certificate that is issued by a certificate authority (CA). The CA can be from acompany such as VeriSign or Thawte, or an internal CA, maintained within yourcompany.Follow these steps to enable SSL communication with a self-signed certificate:1. Obtain the Tivoli Storage Manager server self-signed certificate (cert256.arm)Use the cert.arm certificate file when the server is not setup to use TransportLayer Security (TLS) 1.2; otherwise, use the cert256.arm file. The clientcertificate file must be the same as the certificate file that the server uses.2. Configure the clientsv To use SSL, each client must import the self-signed server certificate.Use the GSKit command-line utility (gsk8capicmd for 32-bit clients orgsk8capicmd_64 for 64-bit clients) to import the certificate.3. For a disaster recovery of the Tivoli Storage Manager server, if the certificatehas been lost, a new one is automatically generated by the server. Each clientmust obtain and import the new certificate.Follow these steps to enable SSL communication with a CA-signed certificate:1. Obtain the CA root certificate.2. Configure the clients.v To use SSL, each client must import the self-signed server certificate.Use the GSKit command-line utility (gsk8capicmd for 32-bit clients orgsk8capicmd_64 for 64-bit clients) to import the certificate.38 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Tip: After you have completed this step, if the server gets a new certificatesigned by the same CA, the client does not need to import the root certificateagain.3. If you are recovering the Tivoli Storage Manager as part of disaster recovery,you must install the SSL certificate on the server again. If the certificate waslost, you must get a new one. You do not need to reconfigure the client if thenew certificate has been signed by a CA.The gsk8capicmd and gsk8capicmd_64 commands are provided by Global SecurityKit (GSKit). Tivoli Storage Manager automatically installs GSKit in \ProgramFiles\IBM\gsk8. However, if GSKit is installed before Tivoli Storage Manager isinstalled, it is possible that it is in some other location. You can obtain the GSKitlocation from the following registry key:HKey_Local_Machine\SOFTWARE\IBM\gsk8\CurrentVersion\InstallPathBefore you set up the server certificate on the client, follow these steps:1. Open a command window and change the directory to your Tivoli StorageManager client directory, for example: cd "c:\Program Files\Tivoli\TSM\baclient"2. Add the GSKit binary path and library path to the PATH environment variable,for example:set PATH=C:\Program Files\IBM\gsk8\bin;C:\Program Files\IBM\gsk8\lib;%PATH%If you are configuring SSL on the Tivoli Storage Manager client for the first time,you must create the client local key database, dsmcert.kdb. To create the client localkey database, run the following command from the Tivoli Storage Manager clientdirectory:gsk8capicmd_64 -keydb -create -populate-db dsmcert.kdb -pw password -stashAfter you create the local key database, you must import the server certificate, orthe CA root certificate.If you use a self-signed certificateEach Tivoli Storage Manager server generates its own certificate. Thecertificate has a fixed file name of either cert.arm or cert256.arm. Thecertificate file is stored on the server workstation in the server instancedirectory, for example, c:\Program Files\tivoli\tsm\server1\cert256.arm.If the certificate file does not exist when you specify the SSLTCPPORT orSSLTCPADMINPORT server option in the dsmserv.sys file, the certificate file iscreated when you restart the server with these options set. Tivoli StorageManager version 6.3 servers (and newer version) generate files namedcert256.arm and cert.arm. Tivoli Storage Manager servers older thanversion 6.3 only generate certificate files named cert.arm. You must choosethe certificate that is set as the default on the server.Follow these steps to set up the SSL connection to a server:1. Obtain the certificate from the server administrator.2. Import the certificate into the client key database by using thefollowing command:gsk8capicmd_64 -cert -add -db dsmcert.kdb -stashed-label "TSM server self-signed key"-file -format asciiChapter 2. Configure the Tivoli Storage Manager client 39

If you use a certificate from a certificate authorityIf the certificate was issued by a certificate authority (CA) such as VeriSignor Thawte, the client is ready for SSL and you can skip the following steps.See “Certificate Authorities root certificates” on page 41 for the preinstalledlist of the root certificates of the external certificate authorities.If the certificate was not issued by one of the well-known certificateauthorities, follow these steps:1. Obtain the root certificate of the signing CA.2. Import the certificate into the client key database by using thefollowing command:gsk8capicmd_64 -cert -add -db dsmcert.kdb -stashed-label "XYZ Certificate Authority" -file -format asciiImportant:1. An arbitrary password, provided by you, is used to encrypt the key database.The password is automatically stored encrypted in the stash file (dsmcert.sth).The stash file is used by the Tivoli Storage Manager client to retrieve the keydatabase password.2. More than one server certificate can be added to the client key database file sothat the client can connect to different servers. Different certificates must havedifferent labels. The label names are not important, but use meaningful names.Also, more than one CA root certificate can be added to the client key database.3. If you do not run the preceding commands from the Tivoli Storage Managerclient directory, you must copy dsmcert.kdb and dsmcert.sth into thatdirectory.4. Due to system performance concerns, use SSL only for sessions where it isneeded. Consider adding additional processor resources on the Tivoli StorageManager server system to manage the increased requirements.5. In order for a client to connect to a server using Transport Layer Security (TLS)version 1.2, the certificate's signature algorithm needs to be SHA-1 or stronger.If you are using a self-signed certificate, you must use the cert256.armcertificate. Your Tivoli Storage Manager administrator might need to change thedefault certificate on the Tivoli Storage Manager server. See the SSLTLS12server option topic for details.After the server certificate has been added to the client key database, add the sslyes option to the client options file, and update the value of the tcpport option. Itis important to understand that the server is normally set up for SSL connectionson a different port. In other words, two ports are opened on the server:1. One port accepts regular non-SSL client connections2. Another port accepts SSL connections onlyYou cannot connect to a non-SSL port with an SSL-enabled client, and vice versa.If the value of tcpport is incorrect, the client cannot connect to the server. This isnormal behavior that you can correct by specifying the correct port number.40 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Ssl” on page 485“Sslfipsmode” on page 486Certificate Authorities root certificatesWhen the Tivoli Storage Manager Backup-Archive client is delivered, it includes alist of root certificates for a number of common Certificate Authorities.Here is the list of root certificates for a number of common Certificate Authoritiesthat are delivered with the client:v Entrust.net Global Secure Server Certification Authorityv Entrust.net Global Client Certification Authorityv Entrust.net Client Certification Authorityv Entrust.net Certification Authority (2048)v Entrust.net Secure Server Certification Authorityv VeriSign Class 3 Public Primary Certification Authorityv VeriSign Class 2 Public Primary Certification Authorityv VeriSign Class 1 Public Primary Certification Authorityv VeriSign Class 4 Public Primary Certification Authority - G2v VeriSign Class 3 Public Primary Certification Authority - G2v VeriSign Class 2 Public Primary Certification Authority - G2v VeriSign Class 1 Public Primary Certification Authority - G2v VeriSign Class 4 Public Primary Certification Authority - G3v VeriSign Class 3 Public Primary Certification Authority - G3v VeriSign Class 2 Public Primary Certification Authority - G3v VeriSign Class 1 Public Primary Certification Authority - G3v Thawte Personal Premium CAv Thawte Personal Freemail CAv Thawte Personal Basic CAv Thawte Premium Server CAv Thawte Server CAv RSA Secure Server Certification AuthorityTo use certificates issued by any other Certificate Authority you must install theroot certificate of the Certificate Authority on all clients as part of the clientconfiguration.Configure your system for journal-based backupYou must install and configure the journal daemon (Linux) or journal engineservice (Windows) before you can perform journal-based backups.Related tasks:“Configuring the journal engine service”Configuring the journal engine serviceJournal-based backup can be used for all Windows clients. If you install the journalengine service and it is running, then by default the incremental commandChapter 2. Configure the Tivoli Storage Manager client 41

automatically performs a journal-based backup on selected file systems that arebeing monitored by the journal engine service.Journal-based backup is enabled by installing and configuring the Tivoli StorageManager journal service. The Tivoli Storage Manager journal service can beinstalled with the GUI Setup wizard or with the dsmcutil command. Basic journalservice configuration can be done with the GUI Setup wizard, more advancedconfiguration can be done by editing the journal service configuration file,tsmjbbd.ini.To install and configure this service using the client Java GUI setup wizard,perform the following steps:1. From the main window, open the Utilities menu and select Setup Wizard.2. Select the Help me configure the TSM Journal Engine check box.3. Select the task you want to perform. You can install a new journal engine,update a previously installed journal engine, or remove a previously installedjournal engine from your system.4. Complete each panel in the wizard and click the Next button to continue. Toreturn to a previous panel, click the Back button. To display help informationfor a panel, click the Help button.Journal service configuration settings are stored in the journal configuration filetsmjbbd.ini. This file can be installed and configured with the GUI setup wizardor be manually edited.Follow these steps to set up multiple journal services:1. Create and set up a separate journal configuration file (tsmjbbd.ini) for eachjournal service to be installed. Each configuration file must specify a differentJournalPipe value, and must also specify different drives to journal, so that thetwo services do not interfere with each other. Multiple journal servicesjournaling the same drive causes problems. The different services attempts towrite to the same journal database unless this is specifically overridden byspecifying different journal directories in the different configuration files.2. Install the multiple journal services using the dsmcutil.exe tool. Use distinctnames for each service, and specify the /JBBCONFIGFILE option to identify thetsmjbbd.ini to be used for that particular journal instance. For example:dsmcutil install journal /name:"TSM Journal Service 1"/JBBCONFIGFILE:c:\journalconfig\tsmjbbd1.inidsmcutil install journal /name:"TSM Journal Service 2"/JBBCONFIGFILE:d:\journalconfig\tsmjbbd2.ini.3. Different backup clients (based on the distinct dsm.opt file used) can nowconnect to the desired journal service by specifying the appropriateJournalPipe option in the appropriate dsm.opt, which corresponds to theJournalPipe journal service setting.Note:1. Each journal service instance is associated to only one Tivoli Storage Managerclient node name. Changing the association requires a restart of the journalservice to recognize the new association.2. You cannot use network and removable file systems.42 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Configuration settings that you apply when the journal service is started and anychanges you make while the journal service is running are applied without havingto restart the service. This also applies to the journal exclude list. However, somesettings for journaled file systems do not take effect until the file system is broughtoffline and then back online.File systems can be taken online (added) or offline (removed) without stoppingand restarting the journal service. You can bring a file system offline by removingit from the list of journaled file systems in the journal configuration filetsmjbbd.ini, or by shutting down the journal service. You can bring a file systemback online by adding it to the list of journaled file systems in the journalconfiguration file tsmjbbd.ini or by starting (restarting) the journal service.Attention: If you take a file system offline without setting the PreserveDbOnExitvalue of 1, the journaled file system journal database is deleted.PreserveDbOnExit=1 specifies that the journaled file system journal database is notdeleted when the journal file system goes offline. The database is also valid whenthe journal file system comes back online.The following is the syntax for stanza and stanza settings:Syntax for stanzas:[StanzaName]Syntax for stanza settings:stanzaSetting=valueNote:1. You can specify comments in the file by beginning the line with a semicolon.2. Stanza and value names are not case sensitive.3. Numeric values can be specified in hexadecimal by preceding the value with 0xotherwise they are interpreted as decimal.4. There is no correlation between these settings and any settings in thebackup-archive client options file. The journal service is a completelyindependent process and does not process backup-archive client options.Related concepts:“Journal-based backup” on page 121JournalSettings stanza (Windows)Settings under this stanza are global and apply to the entire journal service.The following is the syntax for the JournalSettings stanza:Syntax for JournalSettings stanza:[JournalSettings]Syntax for stanza settings:JournalSettings=valueYou can specify the following JournalSettings values:JournalPipe=pipenameSpecifies the pipe name of the journal service session manager to whichbackup clients initially connect, when establishing a journal-based backupsession. This setting is used in conjunction with the backup client option ofthe same name. The default pipe name is \\.\pipe\jnlSessionMgr1. Forexample, in dsm.opt:Chapter 2. Configure the Tivoli Storage Manager client 43

JournalPipe \\.\pipe\jnlSessionMgr1Under tsmjbbd.ini [JournalSettings] stanza:JournalPipe=\\.\pipe\jnlSessionMgr1Note: The same pipe name must be specified by the client using theJournalPipe option.NlsReposSpecifies the National Language Support repository the journal service usesfor generating messages. Since the journal service is non-interactive, thisonly applies to messages written to the journal error log. The default valueis dscameng.txt. For example:NlsRepos=dscenu.txtErrorLogSpecifies the log file where detailed error messages generated by thejournal service are written. Note that less detailed error and informationalmessages are written to the Windows application event log as well. Thedefault value is jbberror.log. For example:ErrorLog=jbberror.logJournalDirSpecifies the directory where journal database files are stored and written.The default directory is the journal service installation directory. You canspecify different journal locations for each file system being journaled. Thisis useful when running in a clustered environment because the location ofthe journal must be accessible by each workstation in the cluster runningthe journal service. Typically the journal for local resources being journaledresides in the same location and the journal for shared cluster resources(which can move from workstation to workstation) is located on the sharedresource to ensure that it is accessible to both workstations.By default, this setting applies to all journaled file systems but can beoverridden by an override stanza for each journal file system. If the defaultvalue is a fully qualified path (for example c:\tsmjournal), all journaldatabase files are written to the specified directory. If the default valuedoes not specify a drive letter, (for example \tsmjournal) the journaldatabase files for each journal file system are written to the specifieddirectory on each journal file system.The following is an example configuration stanza:[JournalSettings];; Store all resources in one location unless overridden; by an override stanza;JournalDir=c:\tsmjournal;;[JournaledFileSystemSettings.D:\];; Journal for d: only is in location specified below;JournalDir=d:\tsmjournalNote: Changes to this setting do not take effect until the journaled filesystems are brought online.44 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

JournalExcludeList stanzaThis list of exclude statements filters changes from being recorded in the journaldatabase. Changes to objects which match statements in this stanza are ignoredand are not recorded in the journal database.Note:1. Excluding files from the journal has no bearing on those files being excludedby the backup client, other than preventing the files from being sent to thebackup client to be processed during journal-based backup. A file that is notexcluded from the journal should still be excluded by the backup-archive client,if there is a matching exclude statement in the client options file.2. The journal service only provides a subset of the INCLUDE/EXCLUDEfunction provided by the backup-archive client. The journal service does notsupport INCLUDE statements and it does not support the exclude.dir option.There is no correlation between the journal exclude list and the backup-archiveclient exclude list.The following are examples of equivalent journal exclude statements:dsm.opt: tsmjbbd.iniEXCLUDE c:\testdir\...\* c:\testdir\*EXCLUDE.DIR c:\testdir\test* c:\testdir\test*\*The following pattern matching meta characters are supported:% Matches exactly one character.* Matches zero or more characters.%EnvVar%Expands environment variable.The following is an exclude statement syntax example:[JournalExcludeList]%SystemRoot%\System32\Config\*%SystemDrive%\Adsm.Sys\*%TEMP%\*%TMP%\*c:\excludedir\*c:\dir1\excludefile*.:\*.tmpNote: The c:\excludedir\* statement matches the entire tree includingsubdirectories and files.JournaledFileSystemSettings stanzaSettings under this stanza apply to each specified journaled file system unless theyare overridden for individual file systems in an override stanza.The following is the syntax for the JournaledFileSystemSettings stanza:Syntax for JournaledFileSystemSettings stanza:[JournaledFileSystemSettings]Syntax for stanza settings:JournaledFileSystemSetting=valueYou can specify the following JournaledFileSystemSettings values:Chapter 2. Configure the Tivoli Storage Manager client 45

DirNotifyBufferSizeSpecifies the size of the buffer to record change notifications for aparticular journal file system. You might need to increase this value forjournaled file systems that generate a very large volume of change activity.The buffer size is limited by memory. The default value is 16 KB.JournaledFileSystemsSpecifies a space delimited list of file systems to journal. Full file systemspecifications and Windows junctions are supported. There is no defaultvalue. You must specify at least one journaled file system for the journalservice to run. Journaled file systems can be added or removed onlinewithout having to restart the service. For example:JournaledFileSystems=c: d:JournalDbSizeSpecifies the maximum size the journal database can grow. The journaldatabase size is expressed in bytes. A value of zero (0) indicates that thedatabase size is limited only by the capacity of the file system containingthe journal database. The default is 0 (unlimited). For example:JournalDBSize=0x10000000NotifyBufferSizeSpecifies the size of the memory buffer receiving file system changenotifications for a particular journal file system. You might need to increasethis value for journaled file systems that generate a very large volume ofchange activity. The buffer size is limited by memory. The default value is32 KB. For example:NotifyBufferSize=0x00008000NotifyFilterSpecifies what file system change actions generate notifications to thejournal service. NotifyFilter applies to file changes and directorymodifications. Directory name changes, such as deletions and creations, arealways tracked regardless of the filter value. Multiple actions can bemonitored by combining (adding) values together. The default value is0x11F (File and Dir Name, Attrib, Size, Last Write, and security Changes).You can also use the Tivoli Storage Manager Journal Engine Wizard tospecify that any or all of these actions are monitored. Supported values are:Value type Decimal HexFile Name 1 0x001Dir Name 2 0x002Attribute 4 0x004File size* 8 0x008Last Write Time* 16 0x010Last Access Time 32 0x020Create Time 64 0x040Security (ACL) 256 0x100The asterisk (*) indicates that notification might be deferred until disk write cacheis flushed. Name changes are object creations, deletions, or renames.Example:NotifyFilter=0x10746 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

PreserveDbOnExit settingThis setting allows a journal to remain valid when a journaled file systemgoes offline and comes back online. This is useful for preserving thejournal during system reboots, cluster failovers, and resource movement.File systems go offline when the journal service stops or when the filesystem is removed from the configuration file. File systems come backonline when the journal service is started or when the file system is addedto the configuration file.This setting allows a journal-based backup to continue processing whenthe service is restarted (or the file system comes back online) withoutperforming a full incremental backup.Note: Any change activity which occurs while the journal service is notrunning (or the file system is offline) is not recorded in the journal.In a clustered environment, shared resources can move to differentworkstations in the cluster. The journal service running on eachworkstation in the cluster must include these shared resources in the list ofjournaled file systems. The journal service running on the workstationwhich currently owns the resource actively journals the shared resourcewhile other journal services on workstations in the cluster which do notown the resource must defer journaling until the resource becomesavailable (or is moved to that workstation). The configuration settingsdeferFSMonStart, deferRetryInterval, and logFSErrors allows deferment for afile system until the file system is available and accessible.A value of 1 specifies that the journaled file system journal database is notdeleted when the journal file system goes offline. The database is also validwhen the journal file system comes back online. This value should be usedwith caution because any file system change activity which occurs whilethe journaled file system is offline is not reflected in the journal database.The default setting of 0 deletes the journaled file system journal database.Note: The journal is only preserved when a journaled file system comesoffline normally or is brought offline when the resource is no longeravailable and you specify the deferFsMonStart setting. If a file systemcomes offline due to an error such as a notification buffer overrun, thejournal is not preserved.An example for not deleting the journal database upon exit is:[JournaledFileSystemSettings.D:\];; Do not delete the journal when D:\ goes offline;PreserveDbOnExit=1deferFSMonStart settingThis setting defers an attempt to begin monitoring a file system in thefollowing cases:v When the specified journaled file system is not valid or availablev The journal directory for the specified journaled file system cannot beaccessed or createdResources are checked at the interval you specify using thedeferRetryInterval setting.Chapter 2. Configure the Tivoli Storage Manager client 47

The deferFSMonStart setting is most commonly used in a clusterenvironment where shared resources might move to different workstationsin the cluster.A value of 1 indicates that the setting is on. A value of 0 indicates that thesetting is off. The default value is off (set to 0) .deferRetryInterval settingThis setting specifies the value in seconds that a deferred file systems withthe deferRetryInterval setting enabled are checked for availability andbrought online. The default value is 1 second.logFSErrors settingThis setting specifies whether errors encountered while accessing ajournaled file system or journal directory are logged in thejbberror.logand the event log.Use the logFSErrors setting with the deferFSMonStart setting to preventexcessive File System unavailable messages from being logged whenbringing a journaled file system online is deferred. The first error whichcauses the file system to be deferred is logged. Subsequent errors are notlogged. A value of 1 indicates that the setting is on. A value of 0 indicatesthat the setting is off.An example to defer journaling until the file system journal directories arevalid is:[JournalSettings];; Place journal files in directory on each journaled file system;journalDir=\tsmjournal[JournaledFileSystemSettings];;journal c:, d:, and f:;JournaledFileSystems=c: d: d:\mountpoint f:;; Override stanza to defer starting journaling for f:\; until it is a valid file system[JournalFileSystemSettings.f:\];; Keep database valid if file system goes offline;PreserveDBOnExit=1;; Defer journaling until file system and journal directory; are valid;deferFSMonStart=1;; Attempt to start journaling every 120 seconds when deferred;deferRetryInterval=120;;Do not log excessive resource unavailable messages;logFsErrors=048 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Overriding stanzas”Overriding stanzasAny setting in the JournaledFileSystemSettings stanza, except for the buffer sizes,can be overridden for a particular journaled file system by creating an overridestanza.The following is the syntax for the JournaledFileSystemSettings stanza:Syntax for JournaledFileSystemSettings stanza:[JournaledFileSystemSettings.fs]Syntax for stanza settings:JournaledFileSystemSetting=override valueExample:[JournalFileSystemSettings.C:\]NotifyBuffer=0x0020000NotifyFilter=0x107Client-side data deduplicationData deduplication is a method of reducing storage needs by eliminating redundantdata.OverviewTwo types of data deduplication are available on Tivoli Storage Manager: client-sidedata deduplication and server-side data deduplication.Client-side data deduplication is a data deduplication technique that is used on thebackup-archive client to remove redundant data during backup and archiveprocessing before the data is transferred to the Tivoli Storage Manager server.Using client-side data deduplication can reduce the amount of data that is sentover a local area network.Server-side data deduplication is a data deduplication technique that is done by theserver. The Tivoli Storage Manager administrator can specify the datadeduplication location (client or server) to use with the DEDUP parameter on theREGISTER NODE or UPDATE NODE server command.EnhancementsWith client-side data deduplication, you can:v Exclude specific files on a client from data deduplication.v Enable a data deduplication cache that reduces network traffic between theclient and the server. The cache contains extents that were sent to the server inprevious incremental backup operations. Instead of querying the server for theexistence of an extent, the client queries its cache.Specify a size and location for a client cache. If an inconsistency between theserver and the local cache is detected, the local cache is removed andrepopulated.v Enable both client-side data deduplication and compression to reduce theamount of data that is stored by the server. Each extent is compressed beforebeing sent to the server. The trade-off is between storage savings and theChapter 2. Configure the Tivoli Storage Manager client 49

processing power that is required to compress client data. In general, if youcompress and deduplicate data on the client system, you are usingapproximately twice as much processing power as data deduplication alone.The server can work with deduplicated, compressed data. In addition,backup-archive clients earlier than V6.2 can restore deduplicated, compresseddata.Client-side data deduplication uses the following process:v The client creates extents. Extents are parts of files that are compared with otherfile extents to identify duplicates.v The client and server work together to identify duplicate extents. The clientsends non-duplicate extents to the server.v Subsequent client data-deduplication operations create new extents. Some or allof those extents might match the extents that were created in previousdata-deduplication operations and sent to the server. Matching extents are notsent to the server again.BenefitsClient-side data deduplication provides several advantages:v It can reduce the amount of data that is sent over the local area network (LAN).v The processing power that is required to identify duplicate data is offloadedfrom the server to client nodes. Server-side data deduplication is always enabledfor deduplication-enabled storage pools. However, files that are in thededuplication-enabled storage pools and that were deduplicated by the client,do not require additional processing.v The processing power that is required to remove duplicate data on the server iseliminated, allowing space savings on the server to occur immediately.Client-side data deduplication has a possible disadvantage. The server does nothave whole copies of client files until you back up the primary storage pools thatcontain client extents to a non-deduplicated copy storage pool. (Extents are parts ofa file that are created during the data-deduplication process.) During storage poolbackup to non-deduplicated storage pool, client extents are reassembled intocontiguous files.Server-side data deduplication offers more protection against data loss. By default,primary sequential-access storage pools that are set up for data deduplication mustbe backed up to non-deduplicated copy storage pools before they can be reclaimedand before duplicate data can be removed. The default ensures that the server hascopies of whole files at all times, in either a primary storage pool or a copy storagepool.Important: For further data reduction, you can enable client-side datadeduplication and compression together. Each extent is compressed before it is sentto the server. Compression saves space, but it increases the processing time on theclient workstation.In a data deduplication-enabled storage pool (file pool) only one instance of a dataextent is retained. Other instances of the same data extent are replaced with apointer to the retained instance.When client-side data deduplication is enabled, and the server has run out ofstorage in the destination pool, but there is a next pool defined, the server will50 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

stop the transaction. The Tivoli Storage Manager client retries the transactionwithout client-side data deduplication. To recover, the Tivoli Storage Manageradministrator must add more scratch volumes to the original file pool, or retry theoperation with deduplication disabled.For client-side data deduplication, the Tivoli Storage Manager server must beVersion 6.2 or higher.PrerequisitesThe following prerequisites apply to client-side data deduplication:v When a client backs up or archives a file, the data is written to the primarystorage pool that is specified by the copy group of the management class that isbound to the data. To deduplicate the client data, the primary storage pool mustbe a sequential-access disk (FILE) storage pool that is enabled for datadeduplication.v The value of the DEDUPLICATION option on the client must be set to YES. Youcan set the DEDUPLICATION option in the client options file, in the preferenceeditor of the IBM Tivoli Storage Manager client GUI, or in the client option seton the Tivoli Storage Manager server. Use the DEFINE CLIENTOPT commandto set the DEDUPLICATION option in a client option set. To prevent the clientfrom overriding the value in the client option set, specify FORCE=YES.v Client-side data deduplication must be enabled on the server. To enableclient-side data deduplication, use the DEDUPLICATION parameter on theREGISTER NODE or UPDATE NODE server command. Set the value of theparameter to CLIENTORSERVER.v Files on the client must not be excluded from client-side data deduplication. Bydefault, all files are included. You can optionally exclude specific files from datadeduplication.v Files on the client must not be encrypted. Encrypted files and files fromencrypted file systems cannot be deduplicated.v Files must be more than 2 KB. Files that are 2 KB or less are not deduplicated.The server can limit the maximum transaction size for data deduplication bysetting the CLIENTDEDUPTXNLIMIT option on the server. See the Administrator's Guidefor details.The following operations take precedence over client-side data deduplication:v LAN-free data movementv Subfile backup operationsv Simultaneous-write operationsv Data encryptionImportant: Do not schedule or enable any of those operations during client-sidedata deduplication. If any of those operations occur during client-side datadeduplication, client-side data deduplication is turned off, and a message is writtento the error log.The setting on the server ultimately determines whether client-side datadeduplication is enabled. See Table 9 on page 52.Chapter 2. Configure the Tivoli Storage Manager client 51

Table 9. Data deduplication settings: Client and serverValue of the clientDEDUPLICATIONoptionSetting on the serverData deduplicationlocationYes On either the server or the client ClientYes On the server only ServerNo On either the server or the client ServerNo On the server only ServerEncrypted filesThe Tivoli Storage Manager server and the backup-archive client cannotdeduplicate encrypted files. If an encrypted file is encountered during datadeduplication processing, the file is not deduplicated, and a message is logged.Tip: You do not have to process encrypted files separately from files that areeligible for client-side data deduplication. Both types of files can be processed inthe same operation. However, they are sent to the server in different transactions.As a security precaution, you can take one or more of the following steps:v Enable storage-device encryption together with client-side data deduplication.v Use client-side data deduplication only for nodes that are secure.v If you are uncertain about network security, enable Secure Sockets Layer (SSL).v If you do not want certain objects (for example, image objects) to be processedby client-side data deduplication, you can exclude them on the client. If anobject is excluded from client-side data deduplication and it is sent to a storagepool that is set up for data deduplication, the object is deduplicated on server.v Use the SET DEDUPVERIFICATIONLEVEL command to detect possiblesecurity attacks on the server during client-side data deduplication. Using thiscommand, you can specify a percentage of client extents for the server to verify.If the server detects a possible security attack, a message is displayed.Related tasks:“Configuring the client for data deduplication”Related reference:“Deduplication” on page 329“Exclude options” on page 365“Dedupcachepath” on page 328“Dedupcachesize” on page 329“Enablededupcache” on page 355“Ieobjtype” on page 390Configuring the client for data deduplicationConfigure the client so that you can use data deduplication to back up or archiveyour files.Before you configure your client to use data deduplication, ensure that therequirements listed in “Client-side data deduplication” on page 49 are met:52 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvThe server must enable the client for client-side data deduplication with theDEDUP=CLIENTORSERVER parameter on either the REGISTER NODE or UPDATENODE command.The storage pool destination for the data must be a data deduplication-enabledstorage pool.Ensure that your files are bound to the correct management class.Files must be larger than 2 KB.A file can be excluded from client-side data deduplication processing. By default,all files are included. Refer to the exclude.dedup option for details.The server can limit the maximum transaction size for data deduplication bysetting the CLIENTDEDUPTXNLIMIT option on the server. See Tivoli Storage ManagerAdministrator's Guide for details.Follow these steps to enable data deduplication on the client:1. Add the deduplication yes option to the dsm.opt file.2. You can also set this option in the GUI:a. Select Edit > Client Preferencesb. Click the Deduplication tabc. Select the Enable Deduplication check boxd. Click OK to save your selections and close the Preferences EditorAfter you have configured the client for data deduplication, start a backup orarchive operation. When the operation completes, the backup or archive reportshows the amount of data that was deduplicated in this operation, and how manyfiles were processed by client-side data deduplication.If you do not have enough disk space for the backup or archive operation, you canenable client-side data deduplication without local data deduplication cache on theclient using these steps:1. Add the deduplication yes option to the dsm.opt file. You can also set thisoption in the GUI.2. Turn off the local data deduplication cache by adding the ENABLEDEDUPCACHE NOoption to the dsm.opt file.You can also set this option in the Tivoli Storage Manager backup-archive clientpreference editor by clearing the Enable Deduplication check box.The following example uses the query session command to show the type of datathat was processed for data deduplication:tsm> q sessTSM Server Connection InformationServer Name.............: SERVER1Server Type.............: WindowsArchive Retain Protect..: "No"Server Version..........: Ver. 6, Rel. 2, Lev. 0.0Last Access Date........: 08/25/2009 13:38:18Delete Backup Files.....: "No"Delete Archive Files....: "Yes"Deduplication...........: "Client Or Server"Node Name...............: AVIUser Name...............:Chapter 2. Configure the Tivoli Storage Manager client 53

1. Click Edit > Client Preferences.2. Click the Include-Exclude tab.3. Click Add to open the Define Include-Exclude Options window.4. Select a category for processing.v To exclude a file from data deduplication during archive processing, selectArchive in the Category list.v To exclude a file from data deduplication during backup processing, selectBackup in the Category list.5. Select Exclude.Dedup in the Type list.6. Select an item from the Object Type list.v For archive processing, only the File object type is available.v For backup processing, select one of the following object types:– File– Image– System state– ASR7. Specify a file or pattern in the File or Pattern field. You can use wildcardcharacters. If you do not want to type a file or pattern, click Browse to open aselection window and select a file. For mounted file spaces, you can choose thedirectory mount point from the selection window.For ASR and system state, this field is filled out automatically. When youspecify the image object type, the drive letter must be followed by :\*\* . Forexample, to exclude drive E:, enter the following pattern:E:\*\*8. Click OK to close the Define Include-Exclude Options window. The excludeoptions that you defined are in an exclude statement at the bottom of theStatements list box in the Include-Exclude Preferences tab.9. Click OK to save your selections and close the Preferences Editor.You can also exclude files from data deduplication processing in the dsm.opt file:1. Add the deduplication yes option2. Exclude client-side data deduplication for image backup of drive E: by addingEXCLUDE.DEDUP E:\*\* IEOBJTYPE=Image to dsm.opt.Important: If an object is sent to a data deduplication pool, data deduplicationoccurs on the server, even if the object is excluded from client-side datadeduplication.Related concepts:“Client-side data deduplication” on page 49Related reference:“Deduplication” on page 329“Enablededupcache” on page 355“Exclude options” on page 365Configuring the client to back up and archive Tivoli Storage ManagerFastBack dataBefore you can back up or archive Tivoli Storage Manager FastBack client data,there are some configuration tasks that you must complete.Chapter 2. Configure the Tivoli Storage Manager client 55

First ensure that you have configured the backup-archive client and that youinstalled the Tivoli Storage Manager FastBack client.Install the Tivoli Storage Manager FastBack client using the information in TivoliStorage Manager FastBack Installation and User's Guide, here: http://pic.dhe.ibm.com/infocenter/tsmfbinf/v6.After you install the Tivoli Storage Manager FastBack client, complete thefollowing tasks. You can also use the Client Configuration wizard for TivoliStorage Manager FastBack.1. Register a Tivoli Storage Manager node for each Tivoli Storage ManagerFastBack client where Tivoli Storage Manager backs up or archives data. Thenode name must be the short host name of the FastBack client.This is a one-time configuration performed once for each Tivoli StorageManager FastBack client whose volumes need to be backed up or archived.This registration step must be performed manually only when the TivoliStorage Manager client is used as a stand-alone application.The Administration Center does this node registration automatically when theuser creates schedules for archiving or backing up FastBack data using theAdministration Center.2. Use the server GRANT PROXY command to grant proxy authority to yourcurrent Tivoli Storage Manager client node on each node representing aFastBack client created in step 1. The FastBack node should be the target, andthe current Tivoli Storage Manager client node should be the proxy.This is a one-time configuration, and is performed by the AdministrationCenter if the backup or archive is initiated by the Administration Center.3. Run the set password command to store the credentials of the FastBackrepositories where the Tivoli Storage Manager client connects. Run the setpassword -type=fastback command once for each repository where the TivoliStorage Manager client is expected to connect.The credentials that are stored depends on these configurations:v Tivoli Storage Manager client on a FastBack serverv Tivoli Storage Manager client on a FastBack DR Hubv Tivoli Storage Manager client on a dedicated proxy workstationSee IBM Tivoli Storage Manager Integration Guide for Tivoli Storage Manager FastBackfor information about integrating Tivoli Storage Manager and Tivoli StorageManager FastBack.Related concepts:“Installation requirements for backing up and archiving Tivoli Storage ManagerFastBack client data” on page 9“Client configuration wizard for Tivoli Storage Manager FastBack” on page 9“Configuring Tivoli Storage Manager to protect FastBack client data”Related reference:“Set Password” on page 666Configuring Tivoli Storage Manager to protect FastBack client dataYou can configure the backup-archive client to protect FastBack client data byusing the client configuration wizard.56 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Before you can use the Tivoli Storage Manager Client Configuration wizard forFastBack, you must complete the following tasks:vvvvvEnsure that either the Tivoli Storage Manager FastBack server, or the TivoliStorage Manager FastBack Disaster Recovery Hub, is installed and configuredfor short-term data retention.Also ensure that at least one snapshot has been taken.Ensure that the Tivoli Storage Manager backup-archive client is properlyconfigured with a Tivoli Storage Manager server. Also make sure that the TivoliStorage Manager client acceptor service (dsmcad.exe) is running. You can use theTivoli Storage Manager Client Configuration wizard in the Tivoli StorageManager Java GUI, after you install the backup-archive client.Complete a one-time post-installation setup for these purposes:– To specify a Tivoli Storage Manager FastBack user name and password to beused by the wizard, to query and mount volumes from the Tivoli StorageManager FastBack repository– To run Tivoli Storage Manager scheduler scriptsSet up the Tivoli Storage Manager FastBack credentials file. The user ID that youspecify must have Tivoli Storage Manager FastBack administrative authority.1. Configure the user ID and password. Run the following command on theworkstation where the Tivoli Storage Manager backup-archive client andFastBack server or DR Hub are installed:cd \FastBack\shellwhere is the directory location where theTivoli Storage Manager FastBack client is installed.2. If it does not exist, create a folder called FastbackTSMScripts under thesystem drive of the workstation, using the following command:mkdir :\FastbackTSMScripts3. Run the fastbackshell command:FastBackShell -c encrypt -u userName -d domain -p password -f:\FastbackTSMScripts\credential.txtThe following options are used in the preceding command example:– -u specifies the Tivoli Storage Manager FastBack administrator user name.– -p specifies the Tivoli Storage Manager FastBack administrator password.– -d specifies the Tivoli Storage Manager FastBack domain for the username.– -f specifies the output file where the encrypted credentials are to bewritten.Important: The credentials file must be generated with the name"credential.txt". The credentials file must also be located in theFastbackTSMScripts directory of the system drive of the workstation, for thewizard to function properly.You can use the client configuration wizard in the backup-archive client Java GUIor the backup-archive Web client.Follow these steps to use the client configuration wizard in the Java graphical userinterface:1. Ensure that the Tivoli Storage Manager backup-archive client is properlyconfigured with a Tivoli Storage Manager server.2. The configuration wizard starts automatically to create the configuration file.Chapter 2. Configure the Tivoli Storage Manager client 57

3. Follow the instructions on the panel to complete the wizard.4. From the Tivoli Storage Manager Backup-Archive Client GUI main window,select Utilities > Setup Wizard.5. From the welcome page, select Help me configure the client to protectFastBack client data and click Next.6. Use the wizard to complete the configuration process.Follow these steps to start the client configuration wizard in the Web client:1. Ensure that the Web client is properly configured with a Tivoli StorageManager server, and that the Tivoli Storage Manager client acceptor service isrunning.To configure the Web client, follow these steps:a. From the Tivoli Storage Manager Backup-Archive Client GUI main windowin the Java GUI, click Utilities > Setup Wizard.b. From the welcome page, select Help me configure the TSM Web Clientand click Next. Follow the instructions on the panel to complete the wizard.2. Start the Web client. In your Web browser, specify the client node name andport number where the Tivoli Storage Manager Client Acceptor service isrunning.For example: http://:15853. From the Tivoli Storage Manager Backup-Archive Client GUI main window,click Utilities > Setup Wizard.4. From the welcome page, select Help me configure the client to protectFastBack client data, and click Next.5. Use the wizard to complete the configuration process.Related concepts:“Client configuration wizard for Tivoli Storage Manager FastBack” on page 9Configuring the backup-archive client in a cluster server environmentYou can install the backup-archive client software locally on each node of aMicrosoft Cluster Server (MSCS) or Veritas Cluster Server (VCS) environmentcluster.||Tivoli Storage Manager in a VCS environment is supported on the supportedWindows Server platforms.You can also install and configure the Scheduler Service for each cluster node tomanage all local disks and each cluster group containing physical disk resources.For example, MSCS cluster mscs-cluster contains two nodes: node-1 and node-2,and two cluster groups containing physical disk resources: group-a and group-b. Inthis case, an instance of the Tivoli Storage Manager Backup-Archive SchedulerService should be installed for node-1, node-2, group-a, and group-b. This ensuresthat proper resources are available to the Backup-Archive client when disks move(or fail) between cluster nodes.The clusternode option ensures that Tivoli Storage Manager manages backup datalogically, regardless of which cluster node backs up a cluster disk resource. Usethis option for Tivoli Storage Manager nodes that process cluster disk resources,and not local resources.58 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

4. Select the name of the cluster group that you want to protect.5. Select the disks in the cluster group that you want to protect. Note that youcannot use the wizard to backup the quorum drive.6. Specify the disk location where you want the wizard to store the clientoptions file (dsm.opt) that the wizard creates. The client options file must beon one of the drives in the cluster group that you selected in step 4. If a clientoptions file exists at this location, you are prompted to overwrite it, or choosea new directory.7. Specify a name for the Tivoli Storage Manager Scheduler that will be used toperform the backups. Select Use the Client Acceptor Daemon to manage thescheduler, if you want the client acceptor daemon to manage the scheduler.8. Specify the node name for the cluster node and the password that is used tolog on to the Tivoli Storage Manager Server. By default, the option to have thepassword validated by the server is selected. Clear this option if you do notwant the password validated.9. Specify the account that the scheduler and client acceptor daemon services logon as when the services are started. Specify whether you want to start theservice manually, or when the node is booted.10. Specify the names and location of the client schedule log file and error log file.By default, event logging is enabled. Clear this option if you do not want tolog events.To ensure that any node can perform backups if any other node fails, the wizardcopies the registry data to all nodes in the cluster.Configure the Web client in a cluster environmentTo use the Web client in a cluster environment, you must configure thebackup-archive client GUI to run in a cluster environment.See “Configuring cluster protection (Windows 2008)” on page 59 for detailedinformation about installing and configuring the backup-archive client in a MSCSor VCS environment.Configure the Web client to process cluster disk resourcesAfter installing and configuring the backup-archive client in a MSCS or VCSenvironment, there are some steps you must perform to process cluster diskresources.Step 1: Identify the cluster groups to manage:Use the Microsoft Cluster Administrator utility or VCS Configuration editor todetermine which groups contain physical disk resources for the backup-archiveclient to process.Register a unique node name on the backup server for each group.For example, an MSCS cluster named mscs-cluster contains the following groupsand resources:v group-a - Contains physical disk q: (quorum), and physical disk r:Note: VCS does not have quorum disk.v group-b - Contains physical disk s:, and physical disk t:60 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

2. Note that because the /clusternode and /clustername options are not allowedin this command at this level, it is possible that the password in the WindowsRegistry might need to be reset. After installing the above three services foreach cluster group, generate a Tivoli Storage Manager password for eachcluster group node name. You need to identify the proper dsm.opt file for eachcluster group node name you authenticate. For example: dsmc query session-optfile="q:\tsm\dsm.opt"3. See “Frequently asked questions” on page 67 for information on what to do if ageneric service resource for the cluster group fails because the CAD service hasbeen removed.Using the Microsoft Cluster Administrator utility or VCS Configuration Editor,move group-a to node-2. Fromnode-2, issue the same commands above to installthe services on node-2 and generate a password file. Repeat this procedure for eachcluster group.Step 4: Create a network name and IP address resource:Add a network name and IP address resource for each group that is managed bythe client, using the Microsoft Cluster Administrator or VCS Configuration Editor.MSCS:You must use the Microsoft Cluster Administrator utility to add an IP addressresource to each cluster group managed by Tivoli Storage Manager.Follow these steps to add an IP address resource:1. Select the group-a folder under the MSCS-Cluster\Groups folder and select File> New > Resource from the dropdown menu.2. In the New Resource dialog, enter a unique name in the Name field. Forexample: IP address for GROUP-A. Enter a description in the Description field.Change resource type to IP address in the Resource Type field. Enter thegroup name in the Group field. Press Enter.3. In the Possible Owner dialog, ensure that all cluster nodes appear as possibleowners. Press Enter.4. In the Dependencies dialog add all physical disk resources as ResourceDependencies. Press Enter.5. In the TCP/IP Address dialog, enter appropriate values for address,subnetmask, and network. Press Enter.6. Select the new resource from the Microsoft Cluster Administrator utility, andfrom the dropdown menu click File and then Bring Online.You must use the Microsoft Cluster Administrator utility to add a network name toeach cluster group managed by Tivoli Storage Manager.Follow these steps to add a network name:1. Select the group-a folder under the MSCS-Cluster\Groups folder and select File> New > Resource from the dropdown menu.2. In the New Resource dialog, enter a unique name in the Name field. Forexample: Network Name for GROUP-A. Enter a description in the Descriptionfield. Change resource type to Network Name in the Resource Type field. Enterthe group name in the Group field. Press Enter.3. In the Possible Owner dialog, ensure that all cluster nodes appear as possibleowners. Press Enter.Chapter 2. Configure the Tivoli Storage Manager client 63

4. In the Dependencies dialog add the IP address resource and all physical diskresources as Resource Dependencies. Press Enter.5. In the Network Name Parameters dialog, enter a network name for GROUP-A.Press Enter.6. Select the new resource from the Microsoft Cluster Administrator utility, andfrom the dropdown menu click File and then Bring Online.The IP address and network name to backup the disks in the cluster group arenow resources in the same group.Repeat this procedure for each cluster group managed by Tivoli Storage Manager.VCS:You must use the VCS Configuration Editor to add a network name and IPaddress resource for each group that is managed by the client.Follow these steps to add a network name and IP address resource:1. Open the VCS Configuration Editor. You are prompted with the Build a newconfiguration or modify existing configuration window which provides thefollowing options: New Config - If you select this option you are prompted forthe path for the types.cf file, and Open Existing Config - If you select thisoption, the configuration window opens. Click on RESOURCE GROUP youwant to modify.2. Click on the Edit button and select Add resource. The Add Resource windowopens.3. Enter the name you want to give the resource in Resource Name field.4. Select the Resource Type as IP. The attributes of the IP resource type aredisplayed.5. Click the Edit button to modify the resource attributes.a. Select the MACAddress attribute and enter the MAC address of adapter youwant the IP to be assigned to.b. Select the SubNetMask attribute and enter the subnetmask.c. Select the Address attribute and enter the IP address you want to makeHigh-Availability.6. When you are finished, close the window. The Configuration window promptsyou whether to save the configuration; click Yes.Step 5: Create a generic service resource for failover:This topic guides you through the steps to create a generic service resource forfailover.MSCS:To add a Generic Service resource to each cluster group managed by Tivoli StorageManager, you must use the Microsoft Cluster Administrator utility.1. Select the group-a folder under the MSCS-Cluster\Groups folder and select File> New > Resource from the dropdown menu.2. In the New Resource dialog, enter a unique name in the Name field. Forexample: TSM CLIENT ACCEPTOR SERVICE for GROUP-A. Enter a description in theDescription field. Change resource type to Generic Service in the ResourceType field. Enter the group name in the Group field. Press Enter.64 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

3. In the Possible Owner dialog, ensure that all cluster nodes appear as possibleowners. Press Enter.4. In the Dependencies dialog add all physical disk resources as ResourceDependencies. Press Enter.5. In the Generic Service Parameters dialog, enter the service name you specifiedwith the dsmcutil command, in the Service Name field. Leave the StartupParameters field blank. Press Enter.6. In the Registry Replication dialog, add the registry key corresponding to theTivoli Storage Manager node name and server name. The format for this key is:HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ADSM\CurrentVersion\Nodes\nodename\TSM_server_instance_name, where nodename is the name of your Tivoli StorageManager node, and TSM_ server_ instance_name is the name of the TivoliStorage Manager server that the node connects to. For example, if the nodename is mscs-cluster-group-a and the Tivoli Storage Manager server name istsmsv1, then you should enter the following registry key in the RegistryReplication dialog: HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ADSM\CurrentVersion\Nodes\mscs-cluster-group-a\tsmsv1. This entry should match an existing keyin the Windows registry.The client acceptor service is now a resource in the same group. If the group ismoved (failed) to the other nodes in the cluster, the service should correctly failover between the cluster nodes and notify both cluster nodes of automaticpassword changes.Note:1. If you manually change the password, you must stop the remote agent and theclient acceptor services, regenerate the password, and restart the client acceptorservice (do not restart the remote agent). You can generate the password byrunning this command:dsmc query session -optfile="q:\tsm\dsm.opt"2. See “Frequently asked questions” on page 67 for information on what to do if ageneric service resource for the cluster group fails because the CAD service hasbeen removed.VCS:To add a Generic Service resource to each cluster group managed by thebackup-archive client, you must use the VCS Configuration Editor.1. Open the VCS Configuration Editor. You are prompted with the Build a newconfiguration or modify existing configuration window which provides thefollowing options: New Config - If you select this option you are prompted forthe path for the types.cf file, and Open Existing Config- If you select thisoption, the configuration window opens. Click on RESOURCE GROUP youwant to modify.2. Click on the Edit button and select Add resource. The Add Resource windowopens.3. Enter the name you want to give the resource in Resource Name field.4. Select the Resource Type as GenericService. The attributes of theGenericService resource type are displayed.5. Click the Edit button to modify the resource attributes.6. Select the ServiceName attribute and enter the name of scheduler service thatyou want to make High-Availability.Chapter 2. Configure the Tivoli Storage Manager client 65

7. When you are finished, close the window. The Configuration window promptsyou whether to save the configuration; click Yes.Use the VCS Configuration Editor to configure the registry replication resource, asfollows:1. Open the VCS Configuration Editor. You are prompted with the Build a newconfiguration or modify existing configuration window which provides thefollowing options: New Config - If you select this option you are prompted forthe path for the types.cf file, and Open Existing Config - If you select thisoption, the configuration window opens. Click on RESOURCE GROUP youwant to modify.2. Click on the Edit button and select Add resource. The Add Resource windowopens.3. Enter the name you want to give the resource in Resource Name field.4. Select the Resource Type as RegRep. The attributes of the RegRep resource typeare displayed.5. Click the Edit button to modify the resource attributes.6. Select the MountResName attribute and enter the shared disk on which you wantto store the registry keys.7. When you are finished, close the window. The Configuration window promptsyou whether to save the configuration; click Yes.The client acceptor service is now a resource in the same group. If the group ismoved (failed) to the other nodes in the cluster, the service should correctly failover between the cluster nodes and notify both cluster nodes of automaticpassword changes.Note:1. If you manually change the password, you must stop the remote agent and theclient acceptor services, regenerate the password, and restart the client acceptorservice (do not restart the remote agent). You can generate the password byrunning this command: dsmc query session -optfile="q:\tsm\dsm.opt"2. See “Frequently asked questions” on page 67 for information on what to do if ageneric service resource for the cluster group fails because the CAD service hasbeen removed.Step 6: Start the Web client:This topic guides you through the steps to start the Web client to use clusterservices.1. Start the Tivoli Storage Manager Client Acceptor Service for each resourcegroup on each node.2. To start the Web client, point your browser at the IP address and httpportspecified for the Resource Group. For example, if you used an IP address of9.110.158.205 and specified an httpport value of 1583, open the web address:http://9.110.158.205:1583.Alternatively, you can point your browser at the network name and httpport. Forexample, if you used a network name of cluster1groupa and specified an http portvalue of 1583, open the web address: http://cluster1groupa:1583.Note that the Web client connects to whichever workstation currently owns theresource group. The Web client displays all of the local file spaces on that66 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

workstation, but to ensure that the files are backed up with the correct node nameyou should only back up the files for the resource group.When failing back to the original node after a failover scenario, ensure that theremote agent service on the original workstation is stopped. The remote agent canbe stopped manually, or it stops automatically after 20 to 25 minutes of inactivity.Because the remote agent is configured for manual startup, it will not startautomatically if the workstation on which it was running is rebooted.Frequently asked questionsThis section contains some frequently asked questions and answers about usingcluster services.Q: How do you configure a shortcut for the Tivoli Storage Managerbackup-archive client GUI in a cluster environment?A: To configure a Tivoli Storage Manager backup-archive client GUI icon(for example on the Windows desktop) that you can use to manageoperations for a cluster resource group on a Windows cluster, perform thefollowing steps:1. Right-click on the desktop and select New > Shortcut.2. In the window that appears, find the path to the dsm.exe executable (located bydefault in directory C:\program files\tivoli\tsm\baclient\). If you type thepath in, instead of using the Browse button, the path should be enclosed indouble quotation marks. For example: "C:\Program Files\tivoli\tsm\baclient\dsm.exe"3. After you enter the path and executable in the text field, add the followinginformation after the closing double quotation marks (add a space between thedouble quotation marks and the following): -optfile="x:\path\to\cluster\dsm.opt". This identifies the proper Tivoli Storage Manager cluster options fileyou want to use. This example assumes that the cluster options file is located inthe folder "x:\path\to\cluster\" and has the file name dsm.opt.4. The complete line in the text field now should look similar to the following:"C:\Program Files\tivoli\tsm\baclient\dsm.exe" -optfile="x:\path\to\cluster\ dsm.opt".5. Click Next and give this shortcut a meaningful name, such as Backup-ArchiveGUI: Cluster Group X.6. Click Finish. A desktop icon should now be available. The properties of thisicon shows the following correct Target, as noted in step 4: "C:\ProgramFiles\tivoli\tsm\baclient\dsm.exe" -optfile="x:\path\to\cluster\dsm.opt".Q: How do you verify that a scheduler service setup in a cluster environmentworks?A: Setting up a Tivoli Storage Manager scheduler service for a Microsoftclustered resource group can be time consuming, and can be lengthened bymistakes and errors in the syntax of the commands used to set them up.Carefully entering the commands and recording important informationabout the cluster setup can minimize setup time. To successfully set up ascheduler service for Microsoft cluster environments:1. Carefully read the information in this appendix for correct syntax on setting upa scheduler service for a cluster group.2. Ensure that the proper dsm.opt file(s) are used for the cluster. In a typicalnormal workstation, only one dsm.opt file is used. In a clustered environment,additional dsm.opt files are required. Each cluster group that is backed up mustChapter 2. Configure the Tivoli Storage Manager client 67

have its own dsm.opt file. A cluster group is any group listed under theGROUPS folder of the cluster tree within the Microsoft Cluster Administratorutility or VCS Configuration Editor.3. Understand what the following dsmcutil.exe options mean, and when to usethem. (1) /clustername:clustername - Specifies the name of the Microsoft cluster,where clustername is the name at the top level of the tree within the MicrosoftCluster Administrator utility or VCS Configuration Editor. Use this option withdsmcutil.exe, only when installing a scheduler service for a cluster group. Donot specify a clustername of more than 64 characters. If you specify more than256 characters and you are using Veritas Storage Foundation with HighAvailability or a Microsoft Cluster Server configuration, you might not be ableto install or start the Tivoli Storage Manager scheduler service, and (2)/clusternode:yes - Specifies that you want to enable support for clusterresources. Use this option in the dsm.opt file for each cluster group, and withdsmcutil.exe when installing a scheduler service for a cluster group.4. Common mistakes are made in typing the syntax of the dsmcutil.execommand. An easy way to prevent such syntax problems is to create atemporary text file which is accessible to the cluster group (for instance, place iton a cluster drive belonging to that cluster group), and type the syntax into thisfile. When needed, cut and paste this syntax from the file to the DOS promptand press the Enter key. It guarantees the consistency of the command syntaxregardless of which computer you enter it on.5. If the scheduler service is failing to restart after a failover of the cluster groupoccurs (using the MOVE GROUP option in Cluster Administrator, for example),there might be potential password synchronization problems between the twocluster workstations. To verify that the passwords are the same, browse to thisregistry key on each workstation and compare the encrypted password value:HKEY_LOCAL_MACHINE\SOFTWARE\IBM\ADSM\CurrentVersion\Nodes\nodename\servername.If the encrypted keys for this node do not match between the two clusterworkstations, there is a password mismatch on one or both of the twoworkstations. To correct this problem, use the dsmc.exe program to update thepassword manually on both workstations.For example, assume that the Y: drive is part of the cluster group that isexperiencing problems being backed up with a scheduler service. The Y:\tsmdirectory contains the dsm.opt file for this cluster group in the Y:\tsm directory.To update the password manually, enter the following command on bothworkstations: dsmc -optfile=Y:\tsm\dsm.opt -clusternode=yes, and enter thefollowing command to receive the prompt for the node name and password:dsmc q se -optfile=Y:\tsm\dsm.opt -clusternode=yes.Verify that the passwords are synchronized, and restart the scheduler service toverify if the password remains consistent. If password mismatching continues,it might be due to a syntax error in the original dsmcutil.exe command thatwas used to install the scheduler service. In this case, uninstall the schedulerservice (using the dsmcutil remove /name:schedule_name command) andreinstall the scheduler service again (using the shared text file syntax as shownpreviously).Q: How do you add a cluster drive to an existing Tivoli Storage Manager clusterscheduler service resource for backup?A: To add an additional cluster drive resource to an existing Tivoli StorageManager client cluster scheduler service, the following components mustbe modified or updated to properly reflect this change:1. The cluster drive resource, and any related resource shares, must existand reside within the designated cluster group as defined in the68 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Microsoft Cluster Administrator utility or VCS Configuration Editor.The designated cluster group must already contain the clusterscheduler service resource for which this new drive is added.2. The dsm.opt file used by the designated cluster scheduler serviceresource must be modified to include the additional cluster driveresource on the domain option statement. For example, if you want toadd the R:\ drive, and the domain statement currently identifies clusterdrives Q: and S:, update the domain statement in your dsm.opt file asfollows: domain Q: S: R:.3. You must modify the cluster scheduler service resource properties toinclude this file in the list of dependent resources needed to bring thisresource online. This ensures that the cluster drive resource beingadded is included in the new backups, and for backups which run aftera failover occurs.After the changes above are made, bring the cluster scheduler serviceresource offline, and back online. The schedule should now process thisadditional resource for backups.Q: The CAD service has been removed and now the generic service resource forthe cluster group is failing. How can this be corrected?A: The CAD can be used to control the scheduler, the Web client, or bothfor Tivoli Storage Manager in a cluster environment. If the CAD isremoved without updating the generic cluster resource, the resource fails.To correct this:1. Verify which scheduler service was controlled by the CAD.2. Using the Microsoft Cluster Administrator utility or VCS ConfigurationEditor, go to the properties window of the service resource, select theParameters tab, and enter the name of the correct scheduler service touse.3. Repeat steps one and two for each cluster group that was managed bythe specific CAD.4. To test the updated service resource, initiate a failure of the resource. Ifthe resource comes back online with no failures, the update has workedproperly.Note: To fully disable the CAD, remove the managedservices option fromthe cluster group dsm.opt file or comment it out.Configuring online-image backup supportIf the Tivoli Storage Manager online image feature is configured, Tivoli StorageManager performs a snapshot-based image backup, during which the real volumeis available to other system applications.A consistent image of the volume is maintained during the online image backup.||||||To configure online image backup, perform the following steps:1. Select Utilities > Setup Wizard from the Tivoli Storage Manager GUI mainwindow. The Client Configuration Wizard panel appears.2. Select Help me configure Online Image Support and click Next. The TSMOnline Image Support Wizard panel appears.3. Select the VSS Snapshot Provider and then click Next. To disable online imagesupport, select None.Chapter 2. Configure the Tivoli Storage Manager client 69

||||4. Click Finish button to complete the setup.5. Complete each panel in the wizard and click the Next to continue. To return toa previous panel, click the Back. To display help information for a panel, clickthe help icon.To set preferences for open file support, use the Include-Exclude tab on the TivoliStorage Manager Preferences editor. You can set these options for all volumes orfor individual volumes using the include.fs option: snapshotproviderfs,presnapshotcmd, postsnapshotcmd.Related concepts:“Client options reference” on page 294“Image backup” on page 134Configuring Open File Support|You configure Open File Support (OFS) after you install the Window client.If the Tivoli Storage Manager Open File Support feature is configured, TivoliStorage Manager performs a snapshot-based, file-level operation, during which thereal volume is available to other system applications. A consistent image of thevolume is maintained during the operation.||||||||To configure OFS, perform the following steps:1. Start the Windows client Java GUI (run dsm.exe).2. Select Utilities > Setup Wizard.3. Select Help me configure Online Image Support and click Next.4. Click Next again.5. Select the VSS snapshot provider to enable Open File Support or select Noneto perform normal (non-snapshot) backups of the files on your volume; thenclick Next.6. Click Apply and then click Finish.To set preferences for open file support, use the Include-Exclude tab on the TivoliStorage Manager Preferences editor. You can set these options for all volumes orfor individual volumes using the include.fs option: snapshotproviderfs,presnapshotcmd, postsnapshotcmdRelated concepts:“Client options reference” on page 294Configuring NetApp and Tivoli Storage Manager for snapshotdifference incremental backupsYou must configure the NetApp file server connection information to run thesnapshot difference incremental backup command on the Tivoli Storage Managerclient. You must also use the set password command to specify the file serverhostname, and the password and user name used to access the file server.1. Establish a console session on the NetApp filer and define a new user on thefile server using the following steps:a. Add the user ID to a group that permits users to log in to the file serverwith http and running API commands.70 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

. From the file server, enter the following command to list the user ID toverify the settings and verify that the output is similar:useradmin user list snapdiff_userName: snapdiff_userInfo:Rid: 131077Groups: snapdiff_groupFull Name:Allowed Capabilities: login-http-admin,api-*c. If the security.passwd.firstlogin.enable option for the user ID on theNetApp server is set to “on”, ensure that all groups have the login-telnetand cli–passwd* capabilities.Tip: When security.passwd.firstlogin.enable option is enabled, the userID is set to “expired” when created. The user cannot run any commands,including snapshot difference incremental, until their password is changed.Users in groups that do not have these capabilities cannot log in to thestorage system. Refer to the NetApp documentation for details on defininga user ID and a password on the NetApp file server.2. Configure the NetApp Data ONTAP built-in HTTP server:a. The HTTP server must be running. Verify that the NetApp httpd.enableoption is set to “on”.b. You need administrative access to the filer, using HTTP. Verify that theNetApp httpd.admin.enable option is set to “on”.c. From the Tivoli Storage Manager client node, test the connection betweenthe Tivoli Storage Manager client computer and the NetApp ONTAP serverto ensure that firewalls or other NetApp configuration options do notprevent you from connecting to the NetApp server.Tip: See the NetApp ONTAP documentation for instructions on how to testthe connection.3. Export the NetApp volumes and consider the following recommended settings:Tip: See the NetApp documentation for details on exporting the NetAppvolumes for use with Windows.v Map the NetApp volumes using CIFS.v Ensure the NetApp volumes have the NTFS security setting.4. Set the user ID, and password on Tivoli Storage Manager client for the user IDthat you created in step 1 on page 70 using the following steps:a. Log on as the user with read/write access to the CIFS share.b. From the Tivoli Storage Manager client command line, enter the followingcommand:dsmc set password –type=filer my_file_server snapdiff_user newPasswordSubstitute the following values:my_file_serverThis value is the fully qualified hostname of your NetApp fileserver.snapdiff_userThis value is the user ID that you created in step 1 on page 70.Chapter 2. Configure the Tivoli Storage Manager client 71

newPasswordThis value is the password for the user ID that you created in step 1on page 70.Related reference:“Snapdiff” on page 473“Createnewbase” on page 323|||||||||||||||||||||||||||||||||||||||SnapMirror support for NetApp snapshot-assisted progressiveincremental backup (snapdiff)You can use NetApp's SnapDiff backup processing in conjunction with NetApp'sSnapMirror replication to back up NetApp source or destination filer volumes.In a NetApp SnapMirror environment, data that is on volumes attached to theprimary data center are mirrored to volumes attached to a remote server at adisaster recovery site. The NetApp filer in the primary data center is called thesource filer; the NetApp filer at the disaster recovery site is called the destinationfiler. You can use the Tivoli Storage Manager backup-archive client to createsnapshot differential backups of the source or destination filer volumes.Scenario: Back up data on a source filer volumeYou can configure the backup archive client to back up data from the source filervolumes. This scenario requires you to configure a Tivoli Storage Managerbackup-archive client node such that it has access to the NetApp source filervolumes by using CIFS shares or NFS-exported shares to mount the filer volumes.For example, assume a configuration where the source filer is named ProdFiler.Assume that a volume named UserDataVol exists on ProdFiler filer and that thevolume is accessible by using CIFS or NFS from a backup-archive client node.Assume that the share is mounted as UserDataVol_Share.When you initiate a snapshot differential backup, the NetApp filer creates a newdifferential snapshot on the volume that is being backed up. That differentialsnapshot is compared with the base (previous) snapshot. The base snapshot namewas registered on the Tivoli Storage Manager server when the previous backupwas completed. The contents of that base snapshot are compared to the differentialsnapshot that is created on the source filer volume. Differences between the twosnapshots are backed up to the Tivoli Storage Manager server.The following command is used to initiate the snapshot differential backup. Thecommand is entered on the console of a Tivoli Storage Manager node that isconfigured to access and protect the source filer volumes. Because this command isissued to back up volumes on a source filer, a new snapshot (the differentialsnapshot) is created and the snapshot registered on the Tivoli Storage Managerserver is used as the base snapshot. Creating both the differential and basesnapshots is the default behavior; the -diffsnapshot=create option is a defaultvalue, and it does not need to be explicitly specified on this command.dsmc incr \\ProdFiler\UserDataVol_Share -snapdiff -diffsnapshot=createBack up data on a destination filerA more typical configuration is to offload the backups from the source filer bycreating backups of the source volumes by using the replicated volume snapshotsstored on the destination filer. Ordinarily, backing up a destination filer presents a72 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||problem because creating a snapshot differential backup requires that a newsnapshot must be created on the volume that you are backing up. The destinationfiler volumes that mirror the contents of the source volumes are read onlyvolumes, so snapshots cannot be created on them.To overcome this read-only restriction, Tivoli Storage Manager provides clientconfiguration options that allow you to use the existing base and differentialsnapshots on the read-only destination volume to back up changes to the TivoliStorage Manager server.Like in the source filer scenario, the destination filer volumes are accessed by usingCIFS shares or NFS-exported shares.Snapshot differential options summaryThe useexistingbase option causes the most recent snapshot on the volume to beused as the base snapshot, when a base snapshot must be established. A new basesnapshot is established when any of the following conditions are true:v When this backup is the initial backup.v When createnewbase=yes is specified.vWhen the base snapshot that was registered by a previous differential snapshotno longer exists, and an existing snapshot that is older than the missing basesnapshot does not exist.If this option is not specified, a new snapshot is created on the volume that isbeing backed up. Because destination filer volumes are read-only volumes,useexistingbase must be specified when creating snapshot differential backups ofdestination filer volumes. If useexistingbase is not specified, snapshot differentialbackups of a destination filer volume fail because the new snapshot cannot becreated on the read-only volume.When backing up destination filer volumes, use both the useexistingbase optionand the diffsnapshot=latest option to ensure that the most recent base and mostrecent differential snapshots are used during the volume backup.You use the basesnapshotname option to specify which snapshot, on the destinationfiler volume, to use as the base snapshot. If you do not specify this option, themost recent snapshot on the destination filer volume is used as the base snapshot.You can use wildcards to specify the name of the base snapshot.You use the diffsnapshotname option to specify which differential snapshot, on thedestination filer volume, to use during a snapshot differential backup. This optionis only specified if you also specify diffsnapshot=latest. You can use wildcards tospecify the name of the differential snapshot.The diffsnapshot=latest option specifies that you want to use the latest snapshotthat is found on the file server as the source snapshot.Additional information about each of these options is provided in the Client optionsreference topics.Snapshot differential backup command examplesIn the examples that follow, assume that volumes on a source filer are replicated,by using NetApp’s SnapMirror technology, to a disaster recovery filer (host nameChapter 2. Configure the Tivoli Storage Manager client 73

|||||||||||||||||||||||||||||||||||||||||||||||||is DRFiler). Because the DRFiler volumes are read only, you use the options tospecify which of the replicated snapshots that you want to use as the basesnapshot, and which of the snapshots you want to use as the differential snapshot.By specifying the snapshots to use when creating a snapshot differential backup ofa destination filer, no attempt is made to create a snapshot on the read-onlyvolumes.The following commands are used to initiate snapshot differential backups. Mostof these commands create snapshot differential backups by using snapshots storedon the destination filer volumes. When backing up from a destination filer volume,be sure to include the -useexistingbase option, because that option preventsattempts to create a new snapshot on the read-only destination filer volumes.Example 1: Back up a destination filer by using default nightly backups thatwere created by the NetApp snapshot schedulerdsmc incr \\DRFiler\UserDataVol_Share -snapdiff -useexistingbase-diffsnappshot=latest -basesnapshotname=”nightly.?”You can use a question mark (?) to match a single character. In thisexample, -basesnapshotname=nightly.? uses the latest base snapshot thatis named “nightly.”, followed by a single character (for example: nightly.0,nightly.1, and so on).Example 2. Back up a destination filer volume by using snapshots createdmanually (not created by the NetApp snapshot scheduler)dsmc incr \\DRFiler\UserDataVol_Share –snapdiff –useexistingbase–diffsnapshot=latest –basesnapshotname=”share_vol_base?”–diffsnapshotname=”share_vol_diff?”This example also uses the question mark (?) wildcard to illustrate thesyntax if the base and differential snapshot names have different numbersas part of the name.Example 3. Back up a destination filer volume, and specify which snapshots touse for the base and differential snapshotsdsmc incr \\DRFiler\UserDataVol_Share -snapdiff -useexistingbase-diffsnapshot=latest -basesnapshotname=”share_vol_base”–diffsnapshotname=”share_vol_diff_snap”Example 4: Back up script-generated snapshots that use a naming conventionIn this example, a script that is running on the NetApp filer adds a dateand time stamp to the snapshot names. For example, a snapshot created onNovember 3, 2012 at 11:36:33 PM is namedUserDataVol_20121103233633_snapshot. You can use wildcards with theoptions to select the most recent base and differential snapshots. Forexample:dsmc incr \\DRFiler\UserDataVol_Share -snapdiff -useexistingbase-basesnapshotname=”UserDataVol_Share_*_snapshot” –diffsnapshot=latest-diffnsnapshotname=”UserDataVol_Share_*snapshot-useexistingbase selects the most recent base snapshot. Adding an asterisk(*) wildcard to -basesnapshotname selects the most recent base snapshotthat follows the script-naming convention. The -diffsnapshot=latestoption suppresses the creating of a new differential snapshot and-diffsnapshotname= selects the most recent existing differential snapshotthat follows the script-naming convention. (The asterisks wildcards matchany string).74 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||Example 5: Perform a snapshot differential backup by using an existingdifferential snapshot that exists on the source filerTo use an existing differential snapshot that exists on the source filer, usethe -diffsnapshot=latest to prevent the creation of a new differentialsnapshot. Also use the -diffsnapshotname option to specify which existingdifferential snapshot to use. The snapshot you specify is compared to thebase snapshot, which was registered in the Tivoli Storage Manager serverdatabase when the last backup was created. For example:dsmc incr \\ProdFiler\UserDataVol_Share -snapdiff -diffsnapshot=latest-diffsnapshotname=”share_vol_diff_snap”Register your workstation with a serverBefore you can use Tivoli Storage Manager, you must set up a node name andpassword and your node must be registered with the server.The process of setting up a node name and password is called registration. Thereare two types of registration: open and closed.Your Tivoli Storage Manager administrator chooses the type of registration foryour site.If you plan to use a Web client, you must have an administrative user ID withsystem privilege, policy privilege, client access authority, or client owner authority.When a new node is registered, an administrative user ID is automatically createdfor the node. By default, this node has client owner authority.Closed registrationWith closed registration, a Tivoli Storage Manager administrator must register yourworkstation as a client node with the server. If your enterprise uses closedregistration, you must provide some information to your Tivoli Storage Manageradministrator.You must provide the following items to your Tivoli Storage Manageradministrator:v Your node name (the value returned by the hostname command, the name ofyour workstation, or the node name you specified with the nodename option). Ifyou do not specify a node name with the nodename option, the default login IDis the name that the hostname command returns.v The initial password you want to use, if required.v Contact information, such as your name, user ID, and phone number.Your Tivoli Storage Manager administrator defines the following for you:v The policy domain to which your client node belongs. A policy domain containspolicy sets and management classes that control how Tivoli Storage Managermanages the files you back up and archive.v Whether you can compress files before sending them to the server.v Whether you can delete backup and archive data from server storage.Open registrationWith open registration, a system administrator can register your workstation as aclient node with the server.Chapter 2. Configure the Tivoli Storage Manager client 75

The first time you start a session, Tivoli Storage Manager prompts you forinformation necessary to register your workstation with the server identified inyour client options file. You need to supply your node name, a password, andcontact information.When you use open registration:v Your client node is assigned to a policy domain named standard.v You can delete archived copies of files from server storage, but not backupversions of files.If necessary, your Tivoli Storage Manager administrator can change these defaultslater.Creating an include-exclude listIf you do not create an include-exclude list, Tivoli Storage Manager considers allfiles for backup services and uses the default management class for backup andarchive services.|This is an optional task, but an important one.You can create an include-exclude list to exclude a specific file or groups of filesfrom backup services, and to assign specific management classes to files. TivoliStorage Manager backs up any file that is not explicitly excluded. You shouldexclude Tivoli Storage Manager client directories from backup services. You canuse the query inclexcl command to display a list of include and excludestatements in the order they are examined when determining whether an object isto be included.Specify your include-exclude list in your client options file (dsm.opt). Theinclude-exclude list can also go into a separate file, which is referred to by theinclexcl option. The include-exclude statements are not case-sensitive.The client options file, dsm.opt, must be in a non-Unicode format. However, if youare using a separate include-exclude file, it can be in Unicode or non-Unicodeformat.When the client processes include-exclude statements, the include-excludestatements within the include-exclude file are placed at the position occupied bythe inclexcl option in dsm.opt, in the same order, and processed accordingly.You can use the following methods to create an include-exclude list or specify aninclude-exclude file:1. You can add include-exclude statements in the Tivoli Storage Manager or Webclient directory tree. The online help provides detailed instructions.2. Open the Edit menu and select Client Preferences. In the Preferences dialog,click the Include/Exclude section. You can specify an INCLEXCL file using thePreferences editor. However, you cannot create the INCLEXCL file using thePreferences editor.3. Create the include-exclude list manually, following the steps listed.You can create an include-exclude list manually by performing the following steps:1. Determine your include and exclude requirements.2. Locate the client options file.76 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

3. Important: Group your include-exclude options together in your client optionsfile.4. Enter your include and exclude statements. Tivoli Storage Manager evaluatesall exclude.dir statements first (regardless of their position within theinclude-exclude list), and removes the excluded directories and files from thelist of objects available for processing. All other include-exclude statements areprocessed from the bottom of the list up. Therefore, it is important to enter allyour include-exclude statements in the proper order. For example, in thefollowing include-exclude list the includefile.txt file is not backed up:include c:\test\includefile.txtexclude c:\test\...\*However, in the following include-exclude list the includefile.txt file isbacked up:exclude c:\test\...\*include c:\test\includefile.txt5. Save the file and close it. For Mac OS X, ensure that you save the file as plaintext encoded as Unicode (UTF-8 or UTF-16). Do not add the .txt extension.6. Restart your Tivoli Storage Manager client and the scheduler and clientacceptor services to enable your include-exclude list.Related concepts:“System files to exclude” on page 80Chapter 9, “Storage management policies,” on page 239Related reference:“Inclexcl” on page 394Include-exclude optionsThis topic provides brief descriptions of the include and exclude options that youcan specify in your client options file, a minimum include-exclude list thatexcludes system files, a list of supported wildcard characters, and examples of howyou might use wildcard characters with include and exclude patterns.Exclude file spaces and directoriesUse exclude.dir statements to exclude all files and subdirectories in the specifieddirectory from processing.Tivoli Storage Manager evaluates all exclude.dir statements first (regardless oftheir position within the include-exclude list), and removes the excluded directoriesand files from the list of objects available for processing. The exclude.dirstatements override all include statements that match the pattern.Table 10 on page 78 lists the options you can use to exclude file spaces anddirectories from processing.Chapter 2. Configure the Tivoli Storage Manager client 77

Table 10. Options for excluding file spaces and directoriesOptionDescriptionexclude.dir“Exclude options”on page 365Excludes a directory, its files, and all its subdirectories and their filesfrom backup processing. For example, the statement exclude.dirc:\test\dan\data1 excludes the c:\test\dan\data1 directory, its files,and all its subdirectories and their files. Using the exclude.dir option ispreferable over the standard exclude option to exclude large directoriescontaining many files that you do not want to back up. You cannot useinclude options to override an exclude.dir statement. Only useexclude.dir when excluding an entire directory branch.If you define an exclude statement without using a drive letter, such asexclude.dir dirname, this excludes from processing any directorynamed dirname on any drive.v The following examples illustrate valid exclude.dir statements:Exclude directory C:\MyPrograms\Traverse and its files andsubdirectories:exclude.dir c:\MyPrograms\TraverseExclude all directories below c:\MyPrograms\Traverse. Note thatdirectory C:\MyPrograms\Traverse and the files immediately belowC:\MyPrograms\Traverse is eligible for backup.exclude.dir c:\MyPrograms\Traverse\*Exclude all directories whose names begin with temp, and are locatedwithin directory x:\documents and settings and its subdirectories,where x: is any drive.exclude.dir "*:\documents and settings\...\temp*"Exclude all directories whose names begin with temp, regardless ofthe drive or directory in which they reside:exclude.dir temp*The following example is invalid because it ends with a directorydelimiter:exclude.dir c:\MyPrograms\Traverse\vvUse the following statements to exclude drive x: altogether frombackup processing. Note that the drive root (x:\) is backed up, butall other files and directories on x: is excluded.exclude x:\*exclude.dir x:\*An alternative method for excluding an entire drive from domainincremental backup is to use a domain statement to exclude thedrive. For example:domain -x:This alternative still permits selective and explicit incremental backupprocessing of files on x:. For example:dsmc s x:\ -subdir=yesdsmc i x:dsmc i x:\MyPrograms\ -subdir=yesInclude-exclude statements for networked file systemsInclude-exclude statements that involve networked file systems (remote drives)must be written in the UNC format.78 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

In the following example Z: is a mapped drive to a remote file system onvista.sanjose.ibm.com.The old format would be to exclude \dir\dir2 on the remote file system, as in thisexample:EXCLUDE.DIR "Z:\dir1\dir2"Here is an example of the new format using UNC:EXCLUDE.DIR "\\vista.sanjose.ibm.com\d$\dir1\dir2"The include-exclude statements written in the old format will not be recognized byTivoli Storage Manager.Exclude files and directories from a journal-based backupThere are two methods of excluding files and directories from a journal-basedbackup.vvOne method is to add exclude statements to the client options file to prevent thefiles or directories from being backed up during backup processing.The other method is to add exclude statements to the journal configuration filetsmjbbd.ini, to prevent journal entries from being added for the files ordirectories, which prevents them from being processed during a journal-basedbackup.Note: There is no correlation between the two exclude statements. The preferredplace for exclude statements in tsmjbbd.ini to prevent them from entering thejournal database and being processed during a journal-based backup.Control processing with exclude statementsAfter Tivoli Storage Manager evaluates all exclude statements, the followingoptions are evaluated against the remaining list of objects available for processing.Table 11 lists the options that you can use to control processing with include andexclude statements.Table 11. Options for controlling processing using include and exclude statementsOption Description PageBack up processingexcludeexclude.backupexclude.fileexclude.file.backupincludeinclude.backupinclude.fileinclude.fsThese options are equivalent. Use these options to excludea file or group of files from backup services and spacemanagement services (if the HSM client is installed).The exclude.backup option only excludes files fromnormal backup, but not from HSM.Use these options to include files or assignmanagement classes for backup processing.Use this option to set options on a file space-by-filespace basis.Archive processing“Excludeoptions”on page365“Includeoptions”on page395“Includeoptions”on page395Chapter 2. Configure the Tivoli Storage Manager client 79

Table 11. Options for controlling processing using include and excludestatements (continued)Option Description Pageexclude.archive Excludes a file or group of files from archive services. “Excludeoptions”on page365includeinclude.archiveexclude.fs.nasexclude.imageinclude.fs.nasinclude.imageexclude.systemserviceinclude.systemstateThese options are equivalent. Use these options to includefiles or assign management classes for archiveprocessing.Image processingExcludes file systems on the NAS file server from animage backup when used with the backup nascommand. If you do not specify a NAS node name, thefile system identified applies to all NAS file servers.The backup nas command ignores all other excludestatements including exclude.dir statements. Thisoption is for all Windows clients.Excludes mounted file systems and raw logicalvolumes that match the specified pattern from fullimage backup operations. Incremental image backupoperations are unaffected by exclude.image. Thisoption is valid for all Windows clients.Use the include.fs.nas option to bind a managementclass to Network Attached Storage (NAS) file systems.To specify whether Tivoli Storage Manager saves Tableof Contents (TOC) information during a NAS filesystem image backup, use the toc option with theinclude.fs.nas option in your client options file(dsm.opt). See “Toc” on page 505 for more information.This option is valid for all Windows clients.Includes a file space or logical volume, assigns amanagement class, or allows you to assign one ofseveral image backup processing options to a specificlogical volume when used with the backup imagecommand. The backup image command ignores allother include options. This option is valid for allWindows clients.System state processingExcludes individual system components from systemstate backup. Input can be the keyword or componentname to be excluded from backup. This option is validfor Windows Server 2008, Windows Vista, andWindows 7 only.Assigns management classes for backup of theWindows Server 2008, Windows Vista, and Windows 7system state. The default is to bind the system stateobject to the default management class.“Includeoptions”on page395“Excludeoptions”on page365“Excludeoptions”on page365“Includeoptions”on page395“Includeoptions”on page395“Excludeoptions”on page365“Includeoptions”on page395System files to excludeThere are some system files that should be placed in the client options file so thatthey are excluded.80 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Attention: These system files are either locked by the operating system or theycan cause problems during restore. These are system files that cannot be recoveredwithout the possibility of corrupting the operating system, or temporary files withdata that you can easily recreate.The implicitly generated statements can be seen in the lines of output of the queryinclexcl command with the source "operating system".Use the sample include-exclude list in the dsm.smp file as a starting point for yourinclude-exclude list. This is the minimum include-exclude list that you shouldhave. The dsm.smp file is located in the config folder in the installation directory. Ifyou accepted the defaults, the path to this file is C:\Program Files\Tivoli\TSM\config\dsm.smpNote: If subfile backup is being used, the directory containing cache files shouldbe excluded with the exclude.dir option.There are exclude statements generated from a list defined by the Windowsoperating system in the Windows Registry. Those implicitly generated statementscan be seen in the lines of output of the query inclexcl command with the source"operating system".Exclude files with UNC namesYou can exclude remotely accessed files by specifying their universal namingconvention (UNC) names in your exclude statement.The following example assumes that local drive letter g is mapped to the remoteshare point:\\remote\booksYou would like to exclude from backups all files at the root of this share point thathave an extension of .txt. You could use either of the following commands:exclude g:*.txtexclude \\remote\books\*.txtYou cannot specify UNC names for removable drives such as DVD, ZIP, ordiskette. For example, the following command is not valid:exclude \\ocean\a$\winnt\system32\...\*Include and exclude files that contain wildcard charactersYou must use special escape characters when including or excluding files anddirectories that contain wildcard characters.Tivoli Storage Manager treats wildcard characters in different ways on differentplatforms.The names of directories and files can contain different symbols. The types ofsymbols that are allowed depend on the operating system.For example, on Windows, the names of directories and files should not containthe following symbols:?*"/\:|However, they can contain the following symbols:[]Chapter 2. Configure the Tivoli Storage Manager client 81

To specify files and directories in include and exclude statements, you must usethe escape character "\" to specify the wildcards. However, the escape charactercan only be used inside the character classes "[]".The following examples illustrate how to specify files and directories that containwildcard characters using the escape character and character classes ininclude-exclude statements.To exclude the single directory C:\[dir2] from backup processing, enter thefollowing in the dsm.opt file:exclude.dir "C:\[\[]dir2[\]]"To exclude the single file C:\file[.txt from backup processing, enter thefollowing in the dsm.opt file:exclude.dir "C:\file[\[].txt"Tip: If you use the Preferences Editor to include or exclude a single file ordirectory that contains wildcard characters, you must manually edit the include orexclude statement to escape the wildcard characters. The Preferences Editor doesnot automatically escape the wildcard characters. Follow the previous examples toedit the include or exclude statements in the dsm.opt file or the include-excludefile.Related concepts:“Wildcard characters” on page 542Include and exclude groups of files with wildcard charactersYou can use wildcard characters to include or exclude groups of files.To specify groups of files that you want to include or exclude, use the wildcardcharacters listed in the following table. This table applies to include and excludestatements only.A very large include-exclude list can decrease backup performance. Use wildcardsand eliminate unnecessary include statements to keep the list as short as possible.Table 12. Wildcard and other special charactersCharacter Function? The match one character matches any single character except the directoryseparator; it does not match the end of the string. For example:v The pattern ab?, matches abc, but does not match ab, abab, or abzzz.v The pattern ab?rs, matches abfrs, but does not match abrs, or abllrs.v The pattern ab?ef?rs, matches abdefjrs, but does not match abefrs, abdefrs,or abefjrs.v The pattern ab??rs, matches abcdrs, abzzrs, but does not match abrs, abjrs,or abkkkrs.* The match-all character. For example:v The pattern ab*, matches ab, abb, abxxx, but does not match a, b, aa, bb.v The pattern ab*rs, matches abrs, abtrs, abrsrs, but does not match ars, oraabrs, abrss.v The pattern ab*ef*rs, matches abefrs, abefghrs, but does not match abefr,abers.v The pattern abcd.*, matches abcd.c, abcd.txt, but does not match abcd,abcdc, or abcdtxt.82 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 12. Wildcard and other special characters (continued)Character Function\... The match-n character matches zero or more directories.[ The open character-class character begins the enumeration of a characterclass. For example:xxx[abc] matches xxxa, xxxb, or xxxc.– The character-class range includes characters from the first character to thelast character specified. For example:xxx[a-z] matches xxxa, xxxb, xxxc, ... xxxz.This format should not be used to specify remote drives in an excludestatement.\ The literal escape character. When used within a character class, it treats thenext character literally. When used outside of a character class, it is nottreated in this way. For example, if you want to include the ']' in a characterclass, enter [...\]...]. The escape character removes the usual meaning of ']' asthe close character-class character.] The close character-class character ends the enumeration of a character class.: The drive separator character separates a file specification. The characterbefore the colon identifies a drive letter. The characters after the colon identifyfile specification or pattern. For example:d:\direct\file.namNote: Because a drive specification can consist of only one letter, you should notuse more than one wildcard or a combination of a wildcards with a letter todesignate a drive specification. The following patterns are not allowed, and ifspecified in the client options file (dsm.opt), stops the client program immediatelyafter it starts:?*:\test.txt*?:\...\pagefile.sysH*:\test.**H:\test.txtmyvolume*:\myvolume?*:\If you are using UNC names, Table 13 shows how to correctly specify shareddrives.Table 13. Specifying a drive specification using wildcardsIncorrect\\remote\*:\...\*.*\\remote\?:\...\*.*\\remote\*:\...\pagefile.sysCorrect\\remote\*$\...\*.*\\remote\?$\...\*.*\\remote\*$\...\pagefile.sysRelated concepts:“Wildcard characters” on page 542Examples using wildcards with include and exclude patternsTivoli Storage Manager accepts the exclude.dir option which can be used toexclude directory entries. However, the include and exclude.dir options cannot beused together.Chapter 2. Configure the Tivoli Storage Manager client 83

Table 14 shows how to use wildcard characters to include or exclude files.Table 14. Using wildcard characters with include and exclude patternsTaskPatternExclude all files during backup with an extensionof bak, except those found on the d: drive in thedev directory.Exclude all files in any directory named "tmp"and its subdirectories, except for the filed:\tmp\save.fil.Exclude any .obj file for backup in any directoryon the c: e: f: and g: drives.Exclude the .obj files found in the root directoryin the d: drive only.Exclude any file that resides under the tmpdirectory found on any drive.Exclude the c:\mydir\test1 directory and anyfiles and subdirectories under it.Exclude all directories under the \mydir directorywith names beginning with test.Exclude all directories directly under the \mydirdirectory with names beginning with test, onany drive.Exclude the raw logical volume from imagebackup.Exclude all directories and files on the localdrives, except the c: drive.exclude ?:*.bakinclude d:\dev\*.bakexclude ?:\...\tmp\...\*include d:\tmp\save.filexclude [ce-g]:\...\*.objThe c: e: f: and g: drives are local orremovable.exclude d:\*.objexclude ?:tmp\...\*exclude.dir c:\mydir\test1exclude.dir c:\mydir\test*exclude.dir ?:\mydir\test*exclude.image c:\*exclude [abd-z]:\...\*exclude.dir [abd-z]:\...\*Related concepts:“Examples using wildcards with include and exclude patterns” on page 83Related reference:“Exclude options” on page 365Determine compression and encryption processingTivoli Storage Manager evaluates exclude.dir and any other include-excludeoptions controlling backup and archive processing, and then the decision is madeabout which files undergo compression and encryption processing.The following options determine which files undergo compression and encryptionprocessing.Table 15. Options for controlling compression and encryption processingOption Description PageCompression processingexclude.compression Excludes files from compression processing ifcompression=yes is specified. This option applies tobackups and archives.“Excludeoptions”on page36584 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 15. Options for controlling compression and encryption processing (continued)Option Description Pageinclude.compression Includes files for compression processing ifcompression=yes is specified. This option applies tobackups and archives.“Includeoptions”on page395Encryption processingexclude.encrypt Excludes files from encryption processing. “Excludeoptions”on page365include.encryptIncludes files for encryption processing.The data that you include is stored in encryptedform, and encryption does not affect the amount ofdata sent or received.Important: The include.encrypt option is the onlyway to enable encryption on the Backup-Archiveclient. If no include.encrypt statements are usedencryption will not occur.Adaptive subfile backup processing“Includeoptions”on page395exclude.subfileinclude.subfileExcludes files from adaptive subfile backupprocessing. This option does not apply to archiveprocessing. This option is valid for all Windowsclients.Includes files for adaptive subfile backup processing.This option does not apply to archive processing.This option is valid for all Windows clients.“Excludeoptions”on page365“Includeoptions”on page395Preview include-exclude list filesYou can preview the list of objects to be backed up or archived according to theinclude-exclude list, prior to sending any data to the server.The Tivoli Storage Manager client Java GUI directory tree shows detailedinformation of included and excluded objects. The directory tree windows in theTivoli Storage Manager Client Java GUI allow you to select files and directories toinclude or exclude. You should use this preview command to make sure that youinclude and exclude the correct files. The following is a sample scenario for usingthe include-exclude preview function.For example, follow these steps to back up the files on your /Users/home file space:1. Bring up the Tivoli Storage Manager Client Java GUI and open the Backup tree.You can see all of the directories and files that have been excluded by youroptions file and other sources.2. Scroll down the tree and notice that all of the *.o files in your/Volumes/home/mary/myobjdir are backed up.3. You do not want to back up all of the *.o files, so you right click a .o file, andchoose "View File Details" from the popup menu.4. The dialog shows that these files are included, so click the "Advanced" buttonand create a rule to exclude all .o files from the DATA:\home file space.Chapter 2. Configure the Tivoli Storage Manager client 85

5. A rule is created at the bottom of your options file. The current directory isrefreshed in the Backup tree, and the .o files have the red ’X’, meaning theyare excluded.6. When you look at other directories, they show the new excludes that you haveadded. Press "Backup" and back up the files on your /home file space.Related reference:“Preview Archive” on page 589“Preview Backup” on page 590Include and exclude option processingThe Tivoli Storage Manager server can define include-exclude options using theinclexcl parameter in a client option set.The include-exclude statements specified by the server are evaluated along withthose in the client options file. The server include-exclude statements are alwaysenforced and placed at the bottom of the include-exclude list and evaluated beforethe client include-exclude statements.If the client options file include-exclude list contains one or more inclexcl optionsthat specify include-exclude files, the include-exclude statements in these files areplaced in the list position occupied by the inclexcl option and processedaccordingly.A very large include-exclude list can decrease backup performance. Use wildcardsand eliminate unnecessary include statements to keep the list as short as possible.When performing an incremental backup, Tivoli Storage Manager evaluates allexclude.dir statements first, and removes the excluded directories and files fromthe list of objects available for processing.After evaluating all exclude.dir statements, Tivoli Storage Manager evaluates theinclude-exclude list from the bottom up and stops when it finds an include orexclude statement that matches the file it is processing. The order in which theinclude and exclude options are entered therefore affects which files are includedand excluded.To display a list of all include-exclude statements in effect on your clientworkstation in the actual order they are processed, use the query inclexclcommand.The client program processes the list of include-exclude statements according tothe following rules:1. Files are checked; directories are only checked if the exclude.dir option isspecified.2. File names are compared to the patterns in the include-exclude list from thebottom up. When a match is found, the processing stops and checks whetherthe option is include or exclude. If the option is include, the file is backed up.If the option is exclude, the file is not backed up.Note: If a match is not found, files are implicitly included and backed up.3. When a file is backed up, it is bound to the default management class unless itmatched an include statement that specified a different management classname, in which case the file is bound to that management class.86 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The following examples demonstrate bottom up processing.Example 1Assume that you defined the following statements for the include andexclude options:exclude ?:\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.objThe file being processed is: c:\foo\dev\test.obj. Processing follows thesesteps:1. Rule 3 (the last statement defined) is checked first because ofbottom-up processing. The pattern c:\foo\junk\*.obj does not matchthe file name that is being processed.2. Processing moves to Rule 2 and checks. This time, patternc:\foo\...\*.obj matches the file name that is being processed.Processing stops, the option is checked, and it is included.3. File c:\foo\dev\test.obj is backed up.Example 2Assume that you defined the following statements for the include andexclude options:exclude ?:\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.objThe file being processed is: c:\widg\copyit.bat. Processing follows thesesteps: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, file c:\widg\copyit.bat is implicitlyincluded and backed up.Example 3Assume that you defined the following statements for the include andexclude options:exclude ?:\...\*.objinclude c:\foo\...\*.objexclude c:\foo\junk\*.objThe current file being processed is: c:\lib\objs\printf.obj. Processingfollows 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 is excluded.5. File c:\lib\objs\printf.obj is not backed up.Chapter 2. Configure the Tivoli Storage Manager client 87

Related concepts:“Exclude file spaces and directories” on page 77Chapter 11, “Processing options,” on page 267Related reference:“Exclude options” on page 365“Query Inclexcl” on page 608Processing rules when using UNC namesWhen processing files with UNC names, there are rules that must be followed.Tivoli Storage Manager uses the rules described in “Include and exclude optionprocessing” on page 86. Also the rules in “Explicit use of UNC names for remotedrives” apply.Explicit use of UNC names for remote drivesTivoli Storage Manager recognizes explicit use of UNC names for remote drives.For example, as shown in Table 16, the UNC name pattern can be substituted forthe DOS pattern.Assume local drive letter r: is mapped to remote share point \\remote\c$, s: ismapped to \\remote\share4, and t: is mapped to \\remote\share2.Table 16. UNC name patterns and DOS patternsUNC name patternDOS pattern\\remote\c$\include\file.out\\remote\c$\...\file.out\\remote\share4\exclude\*\\remote\share2\...\?.outr:\include\file.outr:\...\file.outs:\exclude\*t:\...\?.outConversion of DOS pathnames for fixed and remote drivesTivoli Storage Manager converts DOS path names that are mapped to remote sharepoints.For example, a remote share point that is mapped from r:\test\...\exclude.outto \\remote\share\test\...\exclude.out is converted. Remote share points thatare not mapped are not converted. Files on removable media are not converted.Character-class matching examplesThis topic shows examples of valid matches using character class.\\remote[a-z]\share\file.txtmatches \\remotea\share\file.txt\\remote\share[a-z]\file.txtmatches \\remote\sharex\file.txt\\remote\share\file[a-z].txtmatches \\remote\share\fileg.txt88 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 3. Getting startedThis topic describes some tasks that you need to do before you use the TivoliStorage Manager Backup-Archive Client.Perform these tasks before using Tivoli Storage Manager:v “Starting a Java GUI session” on page 93v “Starting a command-line session” on page 94v “Starting a web client session” on page 97v “Start the client scheduler automatically” on page 98v “Changing your password” on page 99v “Sorting file lists using the Tivoli Storage Manager GUI” on page 100v “Displaying online help” on page 101v “Ending a session” on page 101Backup-archive client operations and security rightsThis section explains the types of Tivoli Storage Manager Backup-Archive Clientoperations that can be performed and the security rights that are needed.You must have local or domain administrator privileges to install and configureTivoli Storage Manager client services.||||||||||||||||||Table 17 summarizes the user security rights that are needed for backup andrestore.Table 17. Required user security rights for Tivoli Storage Manager backup and restoreservicesOperating systemWindowsAccountMember of Administratorsgroup or member of BackupOperators groupWhat can I back up andrestore?vvAll file and directoryobjectsSystem state data (BackupOperators group cannotback up ASR writer dataand cannot restore systemstate data)Windows All other accounts v All file and directoryobjects to which theaccount has accessvSystem Access ControlLists (SACL) used forauditing entries is notbacked up or restored© Copyright IBM Corp. 1993, 2012 89

||||||||||||Table 17. Required user security rights for Tivoli Storage Manager backup and restoreservices (continued)What can I back up andOperating systemAccountrestore?The account must have the "Backup files and directories" and "Restore files and directories"security settings to back up these objects:v File objectsv Directory objectsv System state dataBy default, the Administrators and Backup Operators groups are granted these securitysettings.By default, Tivoli Storage Manager client services run under the local systemaccount. However, the local system account does not have access to networkmapped drives and does not have the same permissions and logon properties as auser that is logged in to the system. If you experience discrepancies between a userinitiated backup and a scheduled backup using the local system account, considerchanging the services to run under the user account.Tip: In addition to the appropriate user security rights, the Tivoli StorageManager Backup-Archive client requires that the user has read permission to theroot of any drive that needs to be backed up or restored. If you are using thesystem account to logon for the Tivoli Storage Manager scheduler service, ensurethat you grant the system account (SYSTEM) read access to the root of the drive. Itis not sufficient to grant Everyone read access to the root of the drive.Domain resources, such as network drives, can only be accessed by servicesconfigured to run under a domain authorized account using dsmcutil or theService Control Panel Application.Backup Operators group operationsThe Backup Operators group allows users to back up and restore files regardless ofwhether they have read or write access to the files.This group has a limited set of user rights, so some functions are not available tomembers of the Backup Operators group.||||Here is a list of the Tivoli Storage Manager Backup-Archive client operations that amember of the Backup Operators can do:v Back up and restore files (see Table 17 on page 89)v Back up system stateYou must be a member of the Administrators group to back up ASR writer data.v Restore system stateYou must be a member of the Administrators group to restore system state.v Start the TSM scheduler serviceHere is a list of the Tivoli Storage Manager Backup-Archive client operations that amember of the Backup Operators cannot do:vvStart any other services (TSM client acceptor, TSM remote client agent, and TSMjournal service)Install and configure client services90 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvUse open file support (OFS)Back up and restore imagesBack up and restore Windows file sharesConsiderations before you start using a Backup Operatorsgroup accountThere are some items that you need to consider before you use a Backup Operatorsgroup account to back up, archive, restore, or retrieve your data.|||||Consider these items before using a Backup Operators group account to back up,archive, restore, or retrieve your data:vvvvvIf you have already been using the Tivoli Storage Manager Backup-Archiveclient with an Administrators group account you might not be able to launch theclient because you cannot open the log files (for example dsmerror.log). Toalleviate this problem, you can grant the Backup Operators group Read andWrite permissions to the log files or the directories containing these log files.If you have been creating system state backups with an account that is amember of the Administrators group, and if you want to start backing up orrestoring data with an account that is a member of the Backup Operators group,you must delete the staging directory, c:\adsm.sys, before backing up orrestoring the system state as a member of the Backup Operators group.If you have existing backups from a Tivoli Storage Manager Version 5.2 orearlier client and you attempt an incremental backup of an existing file spacewith a member of the Backup Operators group, all of the data appears aschanged and it is resent to the Tivoli Storage Manager Server.Members of the Backup Operators group might not be able to back up or restorefile data that was encrypted by an Administrator account using the Windowsencrypting file system (EFS).Members of the Backup Operators group do not have the proper authority toupdate the last access time for files that is encrypted with the Windowsencrypting file system (EFS). If EFS files are restored by a member of the BackupOperators group, the last access time will not be preserved.Permissions required to restore files that use adaptive subfile backupTo restore files that were processed using adaptive subfile backup, you must eitherbe the owner of the file or have read access.These permissions are in addition to those required to perform a normal restore.Related tasks:“Performing a backup with limited bandwidth” on page 117Permissions required to back up, archive, restore or retrieve files oncluster resourcesTo back up, restore, archive, or retrieve data residing on Microsoft Cluster Server(MSCS) or Veritas Cluster Server cluster resources, your Windows account mustbelong to the Administrators or Domain Administrators group or BackupOperators group.By default, Backup Operators do not have the user rights necessary to performthese tasks on a cluster node. However, Backup Operators can perform thisChapter 3. Getting started 91

procedure if that group is added to the security descriptor for the Cluster service.You can do that using Cluster Administrator or cluster.exe.Tivoli Storage Manager client authenticationWhen using the graphical user interface or command line interface of a TivoliStorage Manager client, you can log on using a node name and password oradministrative user ID and password.The client prompts for your user ID and compares it to the configured node name.If they match, the client attempts to authenticate the user ID as a node name. If theauthentication fails or if the user ID does not match the configured node name, theclient attempts to authenticate the user ID as an administrative user ID.To use an administrative user ID with any of the backup-archive clients, the userID must have one of the following authorities:System privilegeAuthority over the entire system. An administrator with system privilegecan perform any administrative task.Policy privilegeAuthority over the node policy domain. Allows an administrator tomanage policy objects, register client nodes, and schedule client operationsfor client nodes.Client ownerAuthority over the registered Tivoli Storage Manager client node. You canaccess the client through the Web client or backup-archive client. You ownthe data and have a right to physically gain access to the data remotely.You can back up and restore files on the same or different system, and youcan delete file spaces or archive data.Client accessTo use the Web Client to back up and restore files on a remote clientsystem, you must have an administrative user ID with client accessauthority over the node name for the remote client system. If you do notwant Tivoli Storage Manager administrators with client access authorityover your node name to be able to back up and restore files on yoursystem, specify the revokeremoteaccess option in your client options file.Client access authority only allows Tivoli Storage Manager administratorsto back up and restore files on remote systems. They do not have physicalaccess to the data. That is, they cannot restore the data belonging to theremote system to their own systems. To restore data belonging to a remotesystem to your own system, you must possess at least client ownerauthority.To determine what authority you have, you can use either of the followingmethods:vvFrom the main Tivoli Storage Manager GUI window, select File → ConnectionInformation.Use the Tivoli Storage Manager server QUERY ADMIN command from theadministrative command-line client. See the appropriate Tivoli Storage ManagerAdministrator's Reference for more information about the QUERY ADMINcommand.92 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

User account controlRelated reference:“Revokeremoteaccess” on page 456Starting a Java GUI sessionStarting with Microsoft Windows Vista and Windows 2008, the securityarchitecture was updated with a new User Account Control (UAC) component.The UAC component changes how user accounts are configured and used, andhow applications use system-level privileges.As a result, when you start a Tivoli Storage Manager client on those operatingsystems, the Windows Security dialog box is displayed. Depending on how youlogged on, the form of the dialog might differ:vvMembers of the Administrators group are prompted for confirmation to start theTivoli Storage Manager client.Members of the Backup Operators group are prompted to provide the passwordfor a Backup Operators group account or for an administrator account.In addition, members of the Backup Operators group must have the followingaccess privileges to the Tivoli Storage Manager client root directory:v Modifyv Read and Executev List Folder Contentsv Readv WriteThis section explains the different methods to start a GUI session.Start a GUI session using one of the following methods:v Click the Windows Start button and select Programs > Tivoli Storage Manager> Backup Archive GUI.v Click the Windows Start button and select Run, then enter the full path to thebackup client executable file (dsm.exe).v On the command line, change directory to the Tivoli Storage Managerinstallation directory and enter dsm.v On Windows Vista or Windows 7, when you log on as an administrator, you arerunning as a standard user. If you open a command prompt without running asan administrator, you are asked for consent to run dsm.Tivoli Storage Manager locates the client user-options file (dsm.opt) and starts withthe options specified in that file.Related concepts:Chapter 2, “Configure the Tivoli Storage Manager client,” on page 27Tivoli Storage Manager passwordYour Tivoli Storage Manager administrator can require you to use a password toconnect to the server.Chapter 3. Getting started 93

The Tivoli Storage Manager client prompts you for the password if one is required.Contact your Tivoli Storage Manager administrator if you do not know yourpassword.Related tasks:“Changing your password” on page 99Setup wizardWhen the client GUI starts, it checks to see whether a client options file exists.If the client options file does not exist (which usually happens after you haveinstalled the client for the first time on your system), the setup wizardautomatically starts and guides you through the configuration process.You can launch the setup wizard at any time to modify your client options file.The client options file is dsm.opt.Starting a command-line sessionYou can start a command-line session by invoking the dsmc command.Note: If all DSM environment variables are set, you can enter the dsmc commandfrom any directory; otherwise, enter the fully qualified path.You can open the Windows Start menu and select Programs→ Tivoli StorageManager → Backup Client Command LineYour Tivoli Storage Manager administrator can require you to use a password toconnect to the server. The Tivoli Storage Manager client prompts you for apassword, if it is required. Contact your Tivoli Storage Manager administrator ifyou do not know your password.Related concepts:“Backup-archive client operations and security rights” on page 89“Options in interactive mode” on page 540“Start and end a client command session” on page 538Chapter 12, “Using commands,” on page 535Using batch modeUse batch mode to enter a single client command. When you use batch mode, youmust precede the command with dsmc.For example, to issue the incremental command, enter the following at thecommand prompt:dsmc incrementalSome commands require one or more arguments. For example, to archive a file:dsmc archive c:\myfiles\file1.datDepending upon the current setting of your passwordaccess option, Tivoli StorageManager might prompt you for your password before the command is processedin a batch mode session.When you enter your password, the password is not displayed on your screen.94 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Passwordaccess” on page 433Issuing a series of commands by using interactive modeUse interactive mode when you want to issue a series of commands.Tivoli Storage Manager establishes the connection to the server only once forinteractive mode, so you can process a series of commands more quickly ininteractive mode than in batch mode.To start a client command session in interactive mode, enter either of the followingcommands:v dsmcv dsmc loopThe following prompt is displayed on your screen:tsm>On Windows Vista or Windows 7, when you log on with an administrator ID, youcan complete standard user tasks.. If you are not logged on before you begin a taskfrom a command-prompt window, you are prompted to do so..When you are in interactive mode, do not precede commands with dsmc. Forexample, instead of typing dsmc archive to archive a file, type only archive.For example, to archive a file, enter the command with the file specification:archive c:\myfiles\file1.datDepending upon the current setting of the passwordaccess option, Tivoli StorageManager might prompt you for your password before you are allowed to enter acommand in an interactive session.When you enter your password, the password is not displayed on your screen.Displaying Euro characters in a command-line promptThis topic explains how to display the Euro character in the Windowscommand-line prompt (console window).1. Contact your Microsoft Representative for the 858 code page (the file name isc_858.nls). Copy the file into your Windows system32 directory (for example,C:\WINNT\system32).2. Edit the Windows Registry key, using this command: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage\850, and set it to valuec_858.nls. Any changes that you make to the Windows Registry editorcannot be undone. Errors made in editing the Windows Registry can causeyour system to malfunction, and you might not even be able to restart yoursystem. Be very careful when editing the Windows Registry. If you areunfamiliar with using the Windows Registry editor, then ask someone else whois familiar with the Windows Registry editor to help you.3. In your Regional Settings, select a Western European country (Germany, France,Italy, etc.) as your locale setting.4. Exit and reboot the system.Chapter 3. Getting started 95

Ensure that the console window font that you use supports the Euro symbol (suchas Lucida Console).Use options on the DSMC commandThis topic shows some examples of how to use options on the dsmc command.For example, suppose you have one workstation with node name galaxy1, andanother workstation with node name galaxy2, and you want to restore the datafrom galaxy1 to the galaxy2 system. To recover a file from one workstation(galaxy1) while at the other workstation (galaxy2), you must access galaxy1. Usethe set access command to gain access.For example, assume the file to be recovered on galaxy1 is c:\universe\saturn.planet. The owner of galaxy1 enters the following command:dsmc set access archive c:\universe\saturn.planet galaxy2When access is granted, you would retrieve the file by entering the followingcommand:dsmc retrieve -fromnode=galaxy1 \\galaxy1\universe\saturn.planet c:\Note: Access to the files of another user can also be granted and gained using theGUI.If you have more than one backup server in your organization, you can easilyswitch between them using a command-line option. To override the serverspecified in dsm.opt, you could use a command such as this:dsmc -tcpserveraddress=myserver -node=mynode -tcpport=1599Related reference:“Fromnode” on page 385“Set Access” on page 661Specifying input strings that contain blank spaces or quotation marksYou must follow certain rules when you specify an input string that has blanks orquotation marks.Follow these rules when you specify an input string that has blank spaces orquotation marks:vvvvIf the input string has one or more spaces, enclose the string with either singleor double quotation marks. You can use single or double quotation marks, aslong as they match.If the input string has a single quotation mark, enclose the string within doublequotation marks, as in this example:-description="Annual backup of the accounting department’s monthly reports"If the input string has a double quotation mark, enclose the string within singlequotation marks, as in this example:-description=’New translations of "The Odyssey" and "The Iliad"’If the input string has spaces and quotation marks, enclose the string inquotation marks. The outer quotation marks must not be the same as thequotation marks within the string.Restriction: An input string that has single and double quotation marks is not avalid input string.96 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Starting a web client sessionThe following rules apply to these types of data:v Fully qualified namesv The description that you specify in the archive commandv Any value for an option value where the character string can include spaces orquotation marksImportant: You cannot use escape characters in input strings. Escape characters aretreated the same as any other characters. Here are some examples where escapecharacters are not recognized:v If the character string is in an option filev If the character string is in a list filev If the character string is entered in interactive modeAfter installing the web client on your workstation you can use the web client toperform backup, archive, restore, and retrieve operations from any browser that isrunning Java Runtime Environment (JRE) 5 or 6.The web client facilitates the use of assistive devices for users with disabilities andcontains improved keyboard navigation. The native look and feel of the platformrunning the browser is preserved.The web client uses most desktop font and color settings when it is run inbrowsers on Windows platforms.Refer to the software requirements topic for your platform to find the browserswhere the web client runs.For Microsoft Internet Explorer browsers, you must enable the Scripting of Javaapplets. This setting is also enabled by default. You can verify this by followingthese steps:1. Open the Tools menu and select Internet Options2. From the Internet Options dialog, select the Security tab.3. Click the web content zone in which you use the IBM Tivoli Storage Managerweb client and then click the Custom Level button.4. In the Security Settings dialog, ensure that Enable is selected under theScripting of Java applets setting.If your browser does not have the correct JRE level, the web client notifies you andif possible, tries to automatically install the correct JRE for you.For Microsoft Internet Explorer on Windows platforms, the web clientautomatically downloads and installs JRE 5 or 6.You can download and install JRE 5 or 6 (unless otherwise noted), manually fromthe appropriate URL:v For Windows:http://java.sun.com/javase/index.jspTo use the web client, specify the URL of the client workstation running the webclient in your web browser. You must also specify the HTTP port number definedon the client workstation; the default is 1581. For example:Chapter 3. Getting started 97

http://myhost.mycompany.com:1581Note: Entering a different URL or pressing the browser Back button during anoperation disconnects the web client and causes the current operation to end.Note: Back up and restore activities running in conjunction with a NAS boxcontinues after the web client disconnects.Related tasks:“Configuring the Web client” on page 31User privilegesIf you plan to use the Web client, ensure that you were assigned an administrativeuser ID with system privilege, policy privilege, client access authority, or clientowner authority.When a new node is registered with the server, by default it is given an admin IDof the same node name with client owner authority.Note: You can use the revokeremoteaccess option to prevent a Tivoli StorageManager administrator with client access privilege from performing clientoperations on your workstation through the Web client. However, Tivoli StorageManager administrators with client owner privilege, system privilege, or policyprivilege can still perform client operations on your workstation through the Webclient.Related concepts:“Tivoli Storage Manager client authentication” on page 92Related reference:“Revokeremoteaccess” on page 456Start the client scheduler automaticallyYou can start the client scheduler automatically when you start your workstation.If the Tivoli Storage Manager administrator has defined schedules for your node,starting the client scheduler permits you to automatically back up yourworkstation (or perform other scheduled actions).You can also use the Tivoli Storage Manager Client Acceptor service to manage thescheduler.Tivoli Storage Manager supports remote network connections to the server. With aremote network connection, mobile users no longer need to dial-in to theircompany network when a backup is scheduled to run. Tivoli Storage Managerautomatically establishes a connection before the scheduled backup occurs. If theconnection fails, Tivoli Storage Manager reestablishes the connection beforeattempting the backup.98 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Changing your passwordRelated tasks:“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Your Tivoli Storage Manager administrator can require you to use a password toconnect to the server.Tivoli Storage Manager prompts you for the password if one is required. Contactyour Tivoli Storage Manager administrator if you do not know your password.Important: The password discussed in this topic is different than the passwordused for encrypting files.To change your password from the GUI:1. From the main window, open the Utilities menu and select Change password.2. Enter your current and new passwords, and enter your new password again inthe Verify password field.3. Click Change.To change your password from the command-line client, enter this command:For UNIX, Linux, and Windows clients:dsmc set passwordThen, enter your old and new passwords when prompted.Passwords can be up to 63 character in length. Password constraints vary,depending on where the passwords are stored and managed, and depending onthe version of the Tivoli Storage Manager server that your client connects to.If your Tivoli Storage Manager server is at version 6.3.3 or later, and if you usean LDAP directory server to authenticate passwordsUse any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are case-sensitive and are subject to more restrictions that canbe imposed by LDAP policies.If your Tivoli Storage Manager server is at version 6.3.3 or later, and if you donot use an LDAP directory server to authenticate passwordsUse any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are stored in the Tivoli Storage Manager server database andare not case-sensitive.If your Tivoli Storage Manager server is earlier than version 6.3.3Use any of the following characters to create a password:Chapter 3. Getting started 99

Remember:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-&+.Passwords are stored in the Tivoli Storage Manager server database andare not case-sensitive.||||||On the command line, enclose a password in quotation marks if the passwordcontains one or more special characters. The quotation marks ensure that thespecial characters are correctly interpreted as password characters. Withoutquotation marks, the special characters can be interpreted as shell escapecharacters, file redirection characters, or other characters that have significance tothe operating system.On Windows systems:Enclose the password in quotation marks (").Command line example:-password="secret>shhh"Quotation marks are not required when you type a password with specialcharacters in an options file.Related concepts:“Start the client scheduler automatically” on page 98Related reference:“Password” on page 431“Set Password” on page 666Sorting file lists using the Tivoli Storage Manager GUIThis topic explains how to work with your files using the Tivoli Storage ManagerGUI.Table 18. Working with your files using the Tivoli Storage Manager GUITaskProcedureDisplaying filesTo display files in a directory, click the folder icon next to thedirectory name. The files appear in the File List box on theright.Sorting the file list v Click the appropriate column heading in the File List box.Display active and inactivebackup versionsDisplay only active backupversionsSelecting files to restore orretrieve.v Click the Display Active/Inactive Files option from theView menu.v Click the Display both active and inactive files tool on thetool bar.Click the Display active files only option from the Viewmenu.v Click the selection box next to the directory or file namethat you want to restore or retrieve.v Highlight the files that you want to restore or retrieve andclick the Select Items tool on the tool bar.v Highlight the files that you want to restore or retrieve andclick the Select Items option from the Edit menu.100 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 18. Working with your files using the Tivoli Storage Manager GUI (continued)TaskProcedureDeselecting files v Click the checked selection box next to the directory or filename.v Highlight the files that you want to deselect and click theDeselect Items tool on the tool bar.v Highlight the files that you want to deselect and click theDeselect Items option from the Edit menu.Displaying file information v Highlight the file name, and click the View File Detailsbutton on the tool bar.v Highlight the file name, and select File Details from theView menu.Displaying online helpEnding a sessionNote:1. Unless otherwise noted, the tasks and procedures in the above table apply toall Tivoli Storage Manager GUIs.2. Using the Tivoli Storage Manager GUIs, you can sort a list of files by variousattributes, such as name, directory, size, or modification date. Sorting files bythe last backup date can be useful in determining what date and time to use forthe point-in-time function.3. An active file is the most recent backup version of a file that existed on yourworkstation when you ran your last backup. All other backup versions of thatfile are inactive. Only active backup versions of files are displayed, unless youselect the Display active/inactive files menu option. If you delete the file fromyour workstation, the active version becomes inactive the next time you run anincremental backup.On the command-line client, you can use query commands with the inactiveoption to display both active and inactive objects. You can use restorecommands with the pick and inactive options to produce the list of active andinactive backups to choose from.Related reference:“Inactive” on page 393“Pick” on page 434You can display online help in any of the following ways: On the Tivoli StorageManager client GUIs, from the Web client, or from the dsmc command line.vOn Tivoli Storage Manager client GUIs:– Open the Help menu.– Click the Help button in the current window.v From the dsmc command line: Enter the help command. The complete table ofcontents for the available help text is displayed.Related reference:“Help” on page 578You can end a Tivoli Storage Manager client session from the Tivoli StorageManager client GUI or from the dsmc command line.v From the Tivoli Storage Manager client GUI main hub window:– Click File > Exit.Chapter 3. Getting started 101

– Press Alt-X.– For the Web client: Open a different URL or close the browser.v From the DSMC command line:– In batch mode, each dsmc command you enter is a complete session. TivoliStorage Manager ends the session when it finishes processing the command.– To end an interactive session, enter quit at the tsm> prompt.– To interrupt a dsmc command before Tivoli Storage Manager has finishedprocessing, enter QQ on the Tivoli Storage Manager console. In many casesbut not all, this interrupts the command. If the command cannot beinterrupted, use the Windows Task Manager to end the dsmc process. Do notpress Ctrl-C because, while it ends the session, it can lead to unexpectedresults.Related reference:“Loop” on page 587Online forumsTo participate in user discussions of Tivoli Storage Manager you can subscribe tothe ADSM-L list server.This is a user forum maintained by Marist College. While not officially supportedby IBM, Tivoli Storage Manager developers and other IBM support staff alsoparticipate on an informal, best-effort basis. Because this is not an official IBMsupport channel, you should contact IBM Technical Support if you require aresponse specifically from IBM. Otherwise there is no guarantee that IBM willrespond to your question on the list server.You can subscribe by sending a note to the following e-mail address:listserv@vm.marist.eduThe body of the message must contain the following:SUBSCRIBE ADSM-L yourfirstname yourlastnameThe list server will send you a response asking you to confirm the subscriptionrequest. Once you confirm your subscription request, the list server will send youfurther instructions. You will then be able to post messages to the list server bysending e-mail to:ADSM-L@vm.marist.eduIf at a later time you want to unsubscribe from ADSM-L, you can send a note tothe following e-mail address:listserv@vm.marist.eduThe body of the message must contain the following:SIGNOFF ADSM-LYou can also read and search the ADSM-L archives, join discussion forums, andaccess other resources at the following URL:http://www.adsm.org102 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Other sources of online helpAn anonymous FTP server (ftp://public.dhe.ibm.com/storage) is available whereyou can find maintenance and other Tivoli Storage Manager-related materials.Three other anonymous servers are unofficially maintained by non-IBM volunteers.The following are the anonymous servers:ftp.rz.uni-karlsruhe.de (mirror - Germany)ftp.wu-wien.ac.at (mirror - Austria)ftp.cac.psu.edu (mirror - Pennsylvania)You can get maintenance information from the Tivoli Storage Manager supportpage at: http://www.ibm.com/support/entry/portal/Overview/Software/Tivoli/Tivoli_Storage_ManagerChapter 3. Getting started 103

104 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 4. Backing up your dataUse the backup-archive client to store backup versions of your files on the TivoliStorage Manager server. You can restore these backup versions if the original filesare lost or damaged. This section discusses various ways you can back up yourdata.All client backup and restore procedures in this topic also apply to the Web client,except the following:v Estimatev Preferences editorv Setup wizardUnless otherwise specified, references to Windows refer to all supported Windowsoperating systems.Tivoli Storage Manager provides backup and archive services for all files residingin the following types of file systems: File Allocation Table (FAT), NT File System(NTFS), and FAT 32.The following is a list of primary backup tasks.v “Planning your backups (Windows)”v “Pre-backup considerations (Windows)” on page 114v “Incremental, selective, or incremental-by-date backups (Windows)” on page 119v “Deleting backup data” on page 112v “Backing up files from one or more file spaces for a group backup (Windows)”on page 126v “Backing up Windows system state” on page 130v “Backing up Automated System Recovery files” on page 132v “Image backup” on page 134v “Back up NAS file systems using Network Data Management Protocol” on page140v “Preparing the environment for full backups of VMware virtual machines” onpage 148v “Backing up virtual machines on a Windows Hyper-V system” on page 159v “Net Appliance CIFS share definition backups” on page 162Planning your backups (Windows)If you are a first-time user, or if you only back up files occasionally, you can usethe table in this topic as a checklist of preliminary steps to consider beforeperforming a backup.Read the tasks listed in this table to determine whether you are ready to back upyour data.© Copyright IBM Corp. 1993, 2012 105

Table 19. Planning your backupshhhhhDecide whether you want to back up or archive files. See “When to back up andwhen to archive files” on page 113 for more information.See “Pre-backup considerations (Windows)” on page 114 for important migrationinformation, and how you might increase performance before backing up filesand directories.Create an include-exclude list to specify files and directories you want to excludefrom backup services. See “Control processing with an include-exclude list” onpage 117 for more information.Decide what type of backup you want according to your needs. See the followingsections for more information:v “Incremental, selective, or incremental-by-date backups (Windows)” on page119v “Backing up files from one or more file spaces for a group backup (Windows)”on page 126v “Backing up Windows system state” on page 130v “Backing up Automated System Recovery files” on page 132v “Image backup” on page 134v “Back up NAS file systems using Network Data Management Protocol” onpage 140v “Parallel backups of VMware virtual machines” on page 155For additional backup considerations, see “Backup (Windows): Additionalconsiderations” on page 165.Understanding which files are backed upWhen you request a backup, Tivoli Storage Manager backs up a file if somerequirements are met.The following are the requirements that must be met for Tivoli Storage Manager toback up a file.v The selected management class contains a backup copy group.vvvvvThe file meets the serialization requirements defined in the backup copy group.If serialization is static or shared static, and the file changes during backup, thefile will not be backed up.The file meets the mode requirements defined in the backup copy group. If themode is modified, the file must have changed since the last backup. If the modeis absolute, the file can be backed up even if it does not change.The file meets the frequency requirements defined in the backup copy group.The specified minimum number of days since the last backup must elapse beforea file is backed up.The file is not excluded from backup by an exclude statement.The file is not excluded from backup by the operating system. These excludedfiles can be found in registry subkey HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\BackupRestore\FilesNotToBackup.Files that are part of the Windows system state are eligible for backup only whenperforming a system state backup. You can back up the system state only as asingle entity because of dependencies among the system state components. You cannot back up or restore the files individually. For example, becauseC:\windows\system32\ntoskrnl.exe is part of the Windows system state, it is notbacked up during an incremental or selective backup of the C: drive.106 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:Chapter 9, “Storage management policies,” on page 239“Management classes and copy groups” on page 240Related tasks:“Backing up Windows system state” on page 130Open file support for backup operationsThe VSS snapshot provider is used for open file support.VSS is the snapshot provider for Windows.Some applications can create files and open these files in a way that denies accessto all other processes on a Microsoft Windows operating system. Although this isnot a common practice, it is sometimes used by database vendors or otherapplications that might want to limit access to certain files. By restricting access tothese files, backup products are prevented from backing up this data. These lockedfiles are not the same as files which are open, or in use. Tivoli Storage Manager,running without the open file support (OFS) feature, can back up open, or in usefiles, including files that are open for reading or writing, files that are changingduring the backup, executable and dll files that are running, log files that are beingappended to, etc.You can create OFS or online image backups on workstations with a singleNTFS-based C: drive.The following is the error message that is seen in the dsmerror.log when a TivoliStorage Manager backup encounters one of these locked files without OFS supportenabled:ANS4987E Error processing ’\\machine1\d$\dir1\lockedfile.xyz’: the object is in useby another processANS1228E Sending of object ’\\machine1\d$\dir1\lockedfile.xyz’ failed||||||OFS should not be used for backing up locked Windows system files, such as theWindows system state . The Tivoli Storage Manager client has advanced featuresfor backing up data contained within these files. The backup of the system datathat is contained in these files requires additional processing and must be backedup in a group to allow for a successful restore. These files are excluded from theTivoli Storage Manager file level backup.For database applications that use certain files for transactional consistency (forexample, a recovery log file), it might not be possible to back up and restore thesefiles without database coordination. In these situations, do not back up thesedatabase files with the normal Tivoli Storage Manager file level backup. You canexclude these files from backup processing using an exclude or exclude.dirstatement. Tivoli Storage Manager provides a number of Data Protection clients(IBM Tivoli Storage Manager for Databases, IBM Tivoli Storage Manager for Mail,IBM Tivoli Storage Manager for Application Servers, etc.) which provide thisdatabase coordination and backup along with other advanced database backupfeatures. For a current list of Data Protection clients go to this Web site:http://www.ibm.com/software/tivoli/products/storage-mgr/product-links.htmlChapter 4. Backing up your data 107

For private applications or other database products where a Data Protection clientis not available, you can use the preschedulecmd option to signal the database orapplication to do one of the following:v Take the steps necessary to move these files to a consistent and unopen state.v Bring down the database before the file level backup is started.vProgram or script another method to back up this data and exclude these filesfrom the file level backup. In these cases the OFS feature is not necessary sincethese files are no longer unavailable or locked by the application. Once the filelevel backup has completed, use the postschedulecmd option to bring thedatabase back online or restart the application.If the time it takes to complete the file level backup is too long to have the openfiles offline (for example, having the database offline or holding up transactions),use the OFS feature to create a point-in-time snapshot of the volume. In this case,use the presnapshotcmd and postsnapshotcmd options to signal the database orapplication to coordinate with the backup of these open files. The snapshot, whichoccurs between the pre-snapshot command and post-snapshot command, shouldonly take a few seconds to create. This allows the database or application toresume operations quickly while still allowing Tivoli Storage Manager to perform afull incremental backup of the volume, including the locked files. There are othersituations where these application locked files can be safely backed up and restoredon a file by file basis. In these situations, you can enable the OFS feature for thatvolume where the open files exist. Tivoli Storage Manager file level backup thenhas access to these files and back them up using the Tivoli Storage Manager filelevel backup and archive operations.For information about Tivoli Storage Manager Open File Support restrictions andissues, search for the TSM Client Open File Support document, which is Technotenumber 1248971, at: http://www.ibm.com/support/entry/portal/Overview/Software/Tivoli/Tivoli_Storage_ManagerIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications. The snapshot allows the backup to be taken from a point-in-timecopy that matches the file system at the time the snapshot is taken. Subsequentchanges to the file system are not included in the backup. You can set thesnapshotproviderfs parameter of the include.fs option to none to specify whichdrives do not use open file support.To control an open file support operation you can specify these additional optionsin your dsm.opt file or as values of the include.fs option: snapshotproviderfs,presnapshotcmd and postsnapshotcmd.Note:1. You can use the include.fs option to set snapshot options on a per file systembasis.2. Open file support is provided for both backup and archive. For backup, thisincludes incremental, incremental by date, selective, incremental image,adaptive subfile backup, and journal-based backup.3. Open file support is only available for local fixed volumes (mounted to eitherdrive letters or volume mount points) formatted with FAT, FAT32 or NTFS filesystems. This support includes SAN-attached volumes that meet theserequirements.108 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

4. To enable OFS support in a cluster environment, all workstations in the clustermust have OFS configured. Set VSS as the snapshot provider on thesnapshotproviderfs option.Related concepts:Chapter 11, “Processing options,” on page 267Related tasks:“Backing up Windows system state” on page 130“Configuring Open File Support” on page 70Backing up data using the GUIYou can use Tivoli Storage Manager to back up specific files, a group of files withsimilar names, or entire directories.You can locate the files you want to back up by searching or filtering. Filteringdisplays only the files that match the filter criteria for your backup. Files that donot 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 window appears.2. Expand the directory tree by clicking the plus sign +. To display files in afolder, click the folder icon. To search or filter files, click the Search icon fromthe tool bar.3. Click the selection box for the objects that you want to back up.4. Select the type of backup from the pull down menu:a. To run an incremental backup, select Incremental (complete).b. To run an incremental backup by date, select Incremental (date only).c. To run a selective backup, select Always backup.d. To run an incremental backup without using the journal database, selectIncremental (without journal). If you installed the journal engine serviceand it is running, then by default the incremental command automaticallyperforms a journal-based backup on selected file systems which are beingmonitored by the journal engine service. This option lets you perform atraditional full incremental backup, instead of the default journal-basedbackup.5. Click Backup. The Backup Task List window displays the backup processingstatus. When processing completes, the Backup Report window displaysprocessing details.The following are some items to consider when using the GUI to back up yourdata.vTivoli Storage Manager uses management classes to determine how to manageyour backups on the server. Every time you back up a file, the file is assigned amanagement class. The management class used is either a default selected foryou, or one that you assign to the file using an include option in theinclude-exclude options list. Select Utilities → View Policy Information from thebackup-archive client or Web client GUI to view the backup policies defined bythe Tivoli Storage Manager server for your client node. Select Edit → ClientPreferences from the backup-archive client or Web client GUI and select theInclude-Exclude tab in the Preferences editor to display your include-excludelist.Chapter 4. Backing up your data 109

|vTo modify specific backup options, click the Options button. Any options youchange are effective during the current session only.v To perform subsequent incremental backups, from the Tivoli Storage Managermain window, open the Actions menu and select Backup Domain.Related concepts:Chapter 9, “Storage management policies,” on page 239Related tasks:“Restoring data using the GUI” on page 175“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Specifying drives in your domainWhen you start Tivoli Storage Manager, it sets your default domain to the drivesyou specify with the domain option in the dsm.opt file.If you do not set the domain option, the default domain is all local fixed drives (thedrives on your workstation).You can exclude any domain (including the systemobject domain) in your defaultdomain from backup processing using the Backup tab in the Preferences editor.You can also exclude drives or the systemobject domain by specifying the dash (-)operator before the drive or the systemobject domain. For example, in thefollowing option Tivoli Storage Manager processes all local drives except for the c:drive and systemobject domain:domain ALL-LOCAL -c: -systemobjectUsing the backup-archive client command line interface, you can specify drives toinclude in addition to your default domain. For example, if your default domaincontains drives c: and d:, and you want to back up those drives as well as thediskette in drive a:, enter:dsmc incremental -domain="a:"You can also select Actions → Backup Domain from the Tivoli Storage ManagerGUI to perform these backup functions.Related reference:“Domain” on page 340Backing up data using the command lineYou can use the incremental or selective commands to perform backups. Thefollowing table shows examples of using commands to perform different tasks.Table 20. Command line backup examplesTask Command ConsiderationsIncremental backupsPerform an incrementalbackup of your client domain.dsmc incrementalSee “Incremental” on page 579 formore information about theincremental command. See “Full andpartial incremental backup” on page120 for detailed information aboutincremental backups.110 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 20. Command line backup examples (continued)Task Command ConsiderationsBack up the g: and h: drivesin addition to the c:, d:, ande: drives defined in yourclient domain.Back up all local volumesdefined in your client domainexcept for the c: drive andsystemobject domain.Back up all local volumesdefined in your client domainexcept for the c: drive andsystemstate domain.Back up only the g: and h:drives.Back up all files in thec:\Accounting directory andall its subdirectories.Assuming that you initiated asnapshot of the C: drive andmounted the snapshot as thelogical volume \\florence\c$\snapshots\snapshot.0, runan incremental backup of allfiles and directories under thelocal snapshot and managethem on the Tivoli StorageManager server under the filespace name C:.Perform anincremental-by-date backupof your default client domain.Back up all files in thed:\proj directory.dsmc incremental -domain="g: h:"dsmc incremental -domain="all-local -c:-systemobject"dsmc incremental -domain="all-local -c:-systemstate"dsmc incremental g: h:dsmc incremental c:\Accounting\* -sub=yesdsmc incremental c: -snapshot=\\florence\c$\snapshots\snapshot.0Incremental-by-date backupdsmc incremental -incrbydatedsmc selective d:\proj\Selective backupsSee “Domain” on page 340 for moreinformation about the domain option.You cannot use the (-) operator infront of the domain keyword all-local.See “Domain” on page 340 for moreinformation. For Windows clients youcan also exclude the systemstatedomain from backup processing inthis way.You cannot use the (-) operator infront of the domain keyword all-local.See “Domain” on page 340 for moreinformation.NoneSee “Subdir” on page 489 for moreinformation about the subdir option.See “Snapshotroot” on page 479 formore information.Use the incrbydate option with theincremental command to back upnew and changed files with amodification date later than the lastincremental backup stored at theserver. See “Incrbydate” on page 404for more information about theincrbydate option.Use the selective command to backup specific files, a group of files withsimilar names, or empty directoriesand their attributes regardless ofwhether those files or directories werebacked up during your lastincremental backup and withoutaffecting the last incremental backupcount from the backup server. You canuse wildcards to back up multiplefiles at once. See “Selective” on page658 for more information about theselective command.Chapter 4. Backing up your data 111

Table 20. Command line backup examples (continued)Task Command ConsiderationsBack up the d:\proj directoryand all its subdirectories.Back up the d:\h1.doc andd:\test.doc files.Back up a list of files in thec: drive.Assuming that you initiated asnapshot of the C: drive andmounted the snapshot as thelogical volume \\florence\c$\snapshots\snapshot.0, runa selective backup of thec:\dir1\sub1 directory treefrom the local snapshot andmanage it on the TivoliStorage Manager serverunder the file space name C:.dsmc selective d:\proj\ -subdir=yesdsmc selective d:\h1.doc d:\test.docdsmc selective -filelist=c:\filelist.txtdsmc selective c:\dir1\sub1\* -subdir=yessnapshot=\\florence\c$\snapshots\snapshot.0See “Subdir” on page 489 for moreinformation about the subdir option.You can specify as many filespecifications as available resources orother operating system limits permit.Separate file specifications with aspace. You can also use the filelistoption to process a list of files. TheTivoli Storage Manager client opensthe file you specify with this optionand processes the list of files withinaccording to the specific command.See “Filelist” on page 380 for moreinformation.Use the filelist option to process alist of files. See “Filelist” on page380 for more information.See “Snapshotroot” on page 479 formore information.Deleting backup dataRelated concepts:“Backup (Windows): Additional considerations” on page 165Chapter 12, “Using commands,” on page 535If your administrator has given you authority, you can delete individual backupcopies from the Tivoli Storage Manager server without deleting the entire filespace.For example, you might need to delete sensitive data that was backed up(intentionally or unintentionally), and now needs to be removed from the server.Or you might need to delete files that were backed up, but were later found tocontain viruses. To determine if you have the authority to delete individual backupcopies from the Tivoli Storage Manager server without deleting the entire filespace, select File → Connection Information from the Tivoli Storage Manager GUIor Web client main menu. Your authority status is provided in the Delete BackupFiles field.Important: When you delete backup files, you cannot restore them. Verify that thebackup files are no longer needed before you delete them. Tivoli Storage Managerprompts whether you want to continue with the delete. If you specify yes, thespecified backup files are immediately deleted and removed from Tivoli StorageManager server storage.112 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

To delete backup copies using the Tivoli Storage Manager GUI or Web client:1. Select Delete Backup Data from the Utilities menu. The Backup Deletewindow appears.2. Expand the Directory tree by clicking the plus sign (+) or folder icon next tothe object you want to expand.3. Select an item from the drop-down list near the top of the Backup Deletewindow to specify the type of backup delete to perform. You can delete activebackup versions, inactive backup versions, or all objects that you have selectedin the tree. A directory is deleted only if you select Delete All Objects.To delete backup copies using the Tivoli Storage Manager command line client, usethe delete backup command.Related reference:“Delete Backup” on page 571When to back up and when to archive filesWhen the backup-archive client backs up or archives a file, it sends a copy of thefile and its associated attributes to the server; however, backups and archives havedifferent goals.Use backups to protect against unforeseen damage to your files, and use archivesfor maintaining more permanent versions of your files.Backup data is managed by version, using predetermined policy based rules. Usingthese rules, the Tivoli Storage Manager administrator can control the following:v The number of versionsv The number of days each additional backup copy is keptvWhat happens to backup data versions when the file is deleted on the clientsystemEach copy of the file stored on the server is considered to be a separate and uniqueversion of the file.Archive is a powerful and extremely flexible mechanism for storing long termdata. Archive data is kept for a specified number of days. Archive has no conceptor support for versions. The user or Tivoli Storage Manager administrator isresponsible for determining what files get added to an archive.Tip: If archive is run multiple times against a file using the same archivedescription, a new copy of the file is added to the archive each time that archive isrun. To simplify retrieve, store only one copy of a file in each archive.Backups protect against file damage or loss that could occur through accidentaldeletion, corruption, disk crashes, and so forth. The server maintains one or morebackup versions for each file that you back up. Older versions are deleted asnewer versions are made. The number of backup versions the server maintains isset by your administrator.Archive copies are saved for long-term storage. Your administrator can limit howlong archive copies are kept. The server can store an unlimited number of archiveversions of a file. Archives are useful if you need to go back to a particular versionof your files, or you want to delete a file from your workstation and retrieve it at aChapter 4. Backing up your data 113

later time, if necessary. For example, you might need to save spreadsheets for taxpurposes, but because you are not using them, you do not want to leave them onyour workstation.Related concepts:“Restore data from a backup set” on page 185Pre-backup considerations (Windows)This section discusses some items to consider before you back up your data.LAN-free data movementLAN-free data movement shifts the movement of client data from thecommunications network to a storage area network (SAN). This decreases the loadon the Tivoli Storage Manager server.The SAN provides a path that allows you to back up, restore, archive, and retrievedata to and from a SAN-attached storage device. Client data moves over the SANto the storage device using the Tivoli Storage Manager Storage Agent. The TivoliStorage Manager Storage Agent must be installed on the same system as the client.All Windows clients support LAN-free data movement.LAN-free prerequisitesTo enable LAN-free support, you must install and configure the Tivoli StorageManager Managed System for SAN Storage Agent on the client workstation.The Tivoli Storage Manager Managed System for SAN Storage Agent is a separateproduct and it is included on its own DVD, with the Tivoli Storage Manager forSAN product.For more information about installing and configuring the Tivoli Storage ManagerManaged System for SAN Storage Agent, refer to the IBM Tivoli Storage ManagerStorage Agent User's Guides.LAN-free data movement optionsThis topic describes the options that you can use to enable LAN-free datamovement, after you have installed and configured the Tivoli Storage ManagerManaged System for SAN feature on the client workstation.The following are the options that you can use to enable LAN-free data movement:enablelanfreeSpecifies whether to enable an available LAN-free path to a SAN-attachedstorage device.lanfreecommmethodSpecifies a communication protocol between the client and the Storage Agent.lanfreeshmportSpecifies the unique number that is used by the client and the storage agent toidentify shared memory area used for communications.lanfreetcpportSpecifies the TCP/IP port number where the Storage Agent is listening.lanfreetcpserveraddressSpecifies the TCP/IP address for the Tivoli Storage Manager storage agent.114 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Enablelanfree” on page 357“Lanfreecommmethod” on page 407“Lanfreeshmport” on page 409“Lanfreessl” on page 410“Lanfreetcpport” on page 409“Lanfreetcpserveraddress” on page 411Unicode file spaces (Windows)The Windows client is Unicode-enabled. However, client versions before Version4.2 were not enabled for Unicode.If you are backing up a system that had at one time used a client version olderthan Version 4.2, and the file spaces have not yet been migrated to Unicode, thenyou need to plan for the migration of file spaces to Unicode. This involvesrenaming your file spaces on the server and creating new Unicode-enabled filespaces on the server using the autofsrename option.Related concepts:“Considerations for Unicode-enabled clients” on page 395Related reference:“Autofsrename” on page 304“Detail” on page 332“Query Filespace” on page 603“Restore” on page 622“Retrieve” on page 652Incremental backups on memory-constrained systemsIncremental backup performance suffers if the system has a low amount ofmemory available before starting the backup.If your system is memory constrained, specify the memoryefficientbackup yesoption in your client options file. This option causes Tivoli Storage Manager toprocess only one directory at a time, which reduces memory consumption butincreases backup time. When you specify yes, Tivoli Storage Manager analyzes onlyone directory at a time for backup consideration. If performance remains poor,check your communication buffer settings and the communication link betweenyour system and the Tivoli Storage Manager server. If your system is not memoryconstrained, setting the memoryefficientbackup option to yes degrades your backupperformance.Related reference:“Memoryefficientbackup” on page 419Incremental backups on systems with a large number of filesThe client can use very large amounts of memory to perform incremental backupoperations, especially on file systems that contain large numbers of files.The term memory as used here is the addressable memory available to the clientprocess. Addressable memory is a combination of physical RAM and virtualmemory.Chapter 4. Backing up your data 115

On average, the client uses approximately 300 bytes of memory per object (file ordirectory). Thus for a file system with one million files and directories, the TivoliStorage Manager client requires, on average, approximately 300 MB of memory.The exact amount of memory used per object varies, depending on the length ofthe object path and name length, or the nesting depth of directories. The numberof bytes of data is not an important factor in determining the Tivoli StorageManager backup client memory requirement.The maximum number of files can be determined by dividing the maximumamount of memory available to a process by the average amount of memoryneeded per object.The total memory requirement can be reduced by any of the following methods:v Use the client option memoryefficientbackup diskcachemethod. This choice reducesthe use of memory to a minimum at the expense of performance and asignificant increase in disk space required for the backup. The file descriptiondata from the server is stored in a disk-resident temporary database, not inmemory. As directories on the workstation are scanned, the database isconsulted to determine whether to back up, update, or expire each object. At thecompletion of the backup, the database file is deleted.v Use the client option memoryefficientbackup yes. The average memory used bythe client then becomes 300 bytes times the number of directories plus 300 bytesper file in the directory being processed. Note that for file systems with largenumbers (millions) of directories, the client still might not be able to allocateenough memory to perform incremental backup with memoryefficientbackupyes.v If the client option resourceutilization is set to a value greater than 4, andthere are multiple file systems being backed up, then reducingresourceutilization to 4 or lower limits the process to incremental backup of asingle file system at a time. This reduces the memory requirement. If backup ofmultiple file systems in parallel is required for performance reasons, and thecombined memory requirements exceed the process limits, then multipleinstances of the backup client can be used to back up multiple file systems inparallel. For example, if you want to back up two file systems at the same timebut their memory requirements exceed the limits of a single process, then startone instance of the client to back up one of the file systems, and start a secondinstance of the client to back up the other file system.v Use the - incrbydate client option to perform an "incremental-by-date" backup.v Use the Tivoli Storage Manager client exclude.dir option to prevent the clientfrom traversing and backing up directories that do not need to be backed up.v Reduce the number of files per file system by spreading the data across multiplefile systems.116 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Snapdiff” on page 473“Exclude options” on page 365“Incrbydate” on page 404“Memoryefficientbackup” on page 419“Resourceutilization” on page 453Performing a backup with limited bandwidthIf you plan to perform a backup over a network device that has limitedbandwidth, such as a modem, you can help reduce network traffic by usingadaptive subfile backup.An adaptive subfile backup sends only changed portions of a file to the serverduring successive backup operations.Perform the following steps to use adaptive subfile backup:1. Ensure that the server allows this type of backup. Check with your systemadministrator.2. Set the subfilebackup, subfilecachepath and subfilecachesize options in yourclient options file dsm.opt. If you set the subfilebackup option to yes and noexclude.subfile statements exist, Tivoli Storage Manager considers all files foradaptive subfile backup processing.3. Add an exclude.dir option to your client options file, which excludes thedirectory containing the subfile cache information.When you are ready to back up changes, adaptive subfile backup occurs as part ofincremental and selective backups.You can restore an adaptive subfile backup using the restore command. The serverrestores the base file along with the updates from the changed (delta) subfile sothat what you receive is the latest backed-up version of your file.Related concepts:“Adaptive subfile backup processing” on page 369“Determine compression and encryption processing” on page 84Related reference:“Exclude options” on page 365“Subfilebackup” on page 491“Subfilecachepath” on page 492“Subfilecachesize” on page 493Control processing with an include-exclude listThere might be files on your system that you do not want to back up. These filesmight be operating system or application files that you can easily recover byreinstalling the program, or any other file that you can easily rebuild.Use the include and exclude options in the client options file (dsm.opt) to definewhich files to include or exclude from incremental or selective backup processing.A file is eligible for backup unless excluded by an exclude option. It is notnecessary to use an include option to include specific files for backup unless thosefiles are in a directory containing other files you want to exclude.Chapter 4. Backing up your data 117

The include-exclude list might contain items specified by the server. To view thecontents of your include-exclude list, use the query inclexcl command.Tivoli Storage Manager uses management classes to determine how to manage yourbackups on the server. Every time you back up a file, the file is assigned amanagement class. The management class is either a default chosen for you, or oneyou assign to the file using the include option in the include-exclude list. If youassign a management class, it must contain a backup copy group for the file to bebacked up.You can also add include-exclude statements in the Tivoli Storage Manager ClientGUI directory tree. The preview command allows you to see the resultant effects ofthe currently defined include-exclude list without need of performing an actualbackup of data.Related tasks:“Creating an include-exclude list” on page 76“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Related reference:“Preview Backup” on page 590Data encryption during backup or archive operationsFor the strongest possible encryption, use 128-bit Advanced Encryption Standard(AES) data encryption, with the encryptiontype option.The data that you include is stored in encrypted form, and encryption does notaffect the amount of data sent or received.Attention: If the encryption key password is not saved in the Windows Registry,and you have forgotten the password, your data cannot be recovered.The include.encrypt option is the only way to enable encryption on theBackup-Archive client. If no include.encrypt statements are used, encryption willnot occur.To encrypt file data, you must select an encryption key password, which TivoliStorage Manager uses to generate the encryption key for encrypting anddecrypting the file data. You can specify whether to save the encryption keypassword in the Windows Registry by using the encryptkey option.Tivoli Storage Manager client encryption allows you to enter a value of up to 63characters in length. This encryption password needs to be confirmed whenencrypting the file for backup, and also needs to be entered when performingrestores of encrypted files.While restoring an encrypted file, Tivoli Storage Manager prompts you for the keypassword to decrypt the file in the following cases:v If the encryptkey option is set to Prompt.v If the key supplied by the user in the above case does not match.v If the encryptkey option is set to Save and the locally saved key password doesnot match the encrypted file.118 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Backup (Windows): Additional considerations” on page 165Related reference:“Encryptiontype” on page 358“Encryptkey” on page 359“Exclude options” on page 365“Include options” on page 395Maximum file size for operationsThe table in this topic specifies the maximum file sizes for backup, restore, archive,and retrieve operations.The following table shows the maximum file size, in bytes, for backing up,restoring, and retrieving data.Table 21. Maximum file sizeFile systemMax file size (in bytes)FAT162 147 483 647 (2 GB)FAT324 294 967 295 (4 GB)NTFS 17 592 185 978 880 (16 TB-64 K)How Tivoli Storage Manager handles long user and groupnamesTivoli Storage Manager can handle user and group names that are up to 64characters without any issues. However, names longer than 64 characters requirespecial handling.Restriction: Do not exceed the 64-character limit for user and group names. TivoliStorage Manager shortens the name to fall within this limit by using the followingalgorithm: Use the first 53 characters, append a forward slash (/), and then use thenumeric ID as a character string.An error message is logged that contains both the long name and the resultingshortened string. For most functions, you do not need to be aware of the shortenedname. The exceptions are:v The set access commandv The fromowner optionv The users and groups (authorization) optionsIn each of these cases, when you need to enter a name, you either have to find theerror message containing the transformation, or construct the name using theabove outlined rule.Incremental, selective, or incremental-by-date backups (Windows)Your administrator might set up schedules to automatically back up files. Thissection contains information about how to back up files without a schedule.There are three types of incremental backup: full, partial, and incremental-by-date.Chapter 4. Backing up your data 119

||||If you migrate files with Tivoli Storage Manager HSM for Windows, there can beconsequences for backup operations. To see the effect of different types of backupson migrated files, see "Backing up and restoring migrated files" in the IBM TivoliStorage Manager for HSM for Windows Administration Guide.Related tasks:“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Full and partial incremental backupAn incremental backup backs up only new and changed files. Whether youperform a full or partial incremental backup depends on what you select forbackup.If you select entire drives, you are performing a full incremental backup. If youselect a directory tree or individual files, you are performing a partial incrementalbackup.The first time you run a full incremental backup, Tivoli Storage Manager backs upall the files and directories that you specify. This process can take a long time if thenumber of files is large, or if one or more very large files must be backed up.Subsequent full incremental backups only back up new and changed files. Thisallows the backup server to maintain current versions of your files, without havingto waste time or space by backing up files that already exist in server storage.Depending on your storage management policies, the server might keep more thanone version of your files in storage. The most recently backed up files are activebackup versions. Older copies of your backed up files are inactive versions.However, if you delete a file from your workstation, the next full incrementalbackup causes the active backup version of the file to become inactive. If you needto restore a file you have deleted, and if a full incremental backup has been runsince you deleted the file, then you need to restore an inactive version of the file(assuming that a version still exists on the server). The number of inactive versionsmaintained by the server and how long they are retained is governed by themanagement policies defined by your server administrator. The purpose of theactive versions is to represent which files existed on your file system at the time ofthe backup.To perform a full or partial incremental backup using the client Java GUI, selectthe incremental (complete) option from the pull-down menu at the top of thescreen on the backup window, or use the incremental command in thecommand-line interface. Specify file systems, directory trees, or individual files toinclude in the backup.During an incremental backup, the client queries the server or the journal databaseto determine the exact state of your files since the last incremental backup. Theclient uses this information to perform the following tasks:v Back up new files.vvUpdate the attributes on the server. Changes to read-only, hidden andcompressed file attributes causes Tivoli Storage Manager to send only attributechanges to the server. Changes to sparse file, reparse point, and encrypted fileattributes cause Tivoli Storage Manager to send the entire file to the server. Thearchive attribute is not examined by Tivoli Storage Manager in determiningchanged files.Back up files whose contents changed since the last backup.120 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvChanges include any of the following:– File size– Date or time of last modification– Extended Attributes– Access Control List– Sparse, reparse point or encrypted file attributes.– NTFS file security descriptors. These are the Owner Security Identifier (SID),Group SID, Discretionary Access Control List (ACL), and System ACL.Expire backup versions of files on the server that do not have correspondingfiles on the workstation. The result is that files which no longer exist on yourworkstation will not have active backup versions on the server. However,inactive versions are retained according to rules defined by the Tivoli StorageManager administrator.Rebind backup versions if management class assignments change. Only objectsthat have active backup versions are rebound. Objects for which only inactivebackup versions exist are not rebound.Important: Each directory is also backed up under the following circumstances:v It has not been backed up previouslyv Its permissions have changed since the last backupv Its Access Control List has changed since the last backupv Its Extended Attributes have changed since the last backupv Its time stamp has changed since the last backupYou might be able to use the preservelastaccessdate option during a backup orarchive operation to specify whether to reset the last access date to its originalvalue following a backup or archive operation. By default, the Tivoli StorageManager client will not reset the last access date of any backed up or archived filesto their original value prior to the backup or archive operation.Directories are counted in the number of objects backed up. To exclude directoriesand their contents from backup, use the exclude.dir option.Related concepts:Chapter 9, “Storage management policies,” on page 239Related reference:“Exclude options” on page 365“Preservelastaccessdate” on page 441Journal-based backupJournal-based backup is an alternate method of backup that uses a change journalmaintained by the Tivoli Storage Manager journal service process.Journal-based backup is supported for all Windows clients.To support journal-based backup, you must configure the journal engine serviceusing the dsmcutil command or the client GUI setup wizard.A backup for a particular file system will be journal-based when the Tivoli StorageManager journal service has been installed and configured to journal the particularfile system, and a valid journal has been established for the file system.The primary difference between traditional incremental backup and journal-basedbackup is the method used for backup and expiration candidates.Chapter 4. Backing up your data 121

Traditional incremental backup obtains the list of backup and expiration candidatesby building comprehensive lists of local objects, and lists of active server objectsfor the file system being backed up. The local lists are obtained by scanning theentire local file system. The server list is obtained by querying the entire serverinventory for all active objects.The two lists are compared, and candidates are selected according to the followingcriteria:vvAn object is selected as a backup candidate if it exists in the local list. butdoesn't exist in the server list. The object is also a backup candidate if it exists inboth lists, but differs according to Tivoli Storage Manager incremental criteria(for example, attribute changes, date and size changes).An object is selected as an expiration candidate if it exists in the server list, butdoesn't exist in the local list.Journal-based backup obtains the candidates list of objects to backup and expire byquerying the Tivoli Storage Manager journal service for the contents of the changejournal of the file system being backed up.Change journal entries are cleared (marked as free) after they have been processedby the backup client and committed on the Tivoli Storage Manager server.Journal-based backup is activated by configuring the journal service to monitorspecified file systems for change activity.Journal-based backup is enabled by successfully completing a full incrementalbackup.The journal engine service does not record changes in specific system files, such asthe registry, in the journal. Therefore, a journal-based backup will not back up thisfile. See the journal service configuration file, tsmjbbd.ini, in the client installationdirectory for excluded system files.You can use journal-based backup when backing up file systems with small ormoderate amounts of change activity between backup cycles. If you have many filechanges between backup cycles, you will have very large change journals. Manychanges to the journal-based backup file might pose memory and performanceproblems that can negate the benefits of journal-based backup. For example,creating, deleting, renaming, or moving very large directory trees can also negatethe benefit of using journal-based backup instead of normal incremental backup.Journal-based backup is not intended to be a complete replacement for traditionalincremental backup. You should supplement journal-based backup with a fullprogressive incremental backup on a regular basis. For example, performjournal-based backups on a daily basis, and full incremental backups on a weeklybasis.Journal-based backup has the following limitations:v Individual server attributes are not available during a journal-based backup.Certain policy settings such as copy frequency and copy mode might not beenforced.v Other operating-system specific behaviors might prevent objects from beingprocessed properly. Other software that changes the default behavior of the filesystem might prevent file system changes from being detected.122 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvIf the file system is very active when a journal-based backup is in progress, it ispossible that a small number of deleted files will not be expired.If you restore files to a file system that has an active journal, some of therestored files might get backed up again when the next journal-based backupoccurs, even if the files have not changed since they were restored.Note:1. Journal-based backup is supported on a Version 4.2 or higher Tivoli StorageManager server.2. Multiple journal-based backup sessions are possible.3. When using antivirus software, there are limitations to journal-based backup.4. A journal-based backup might not fall back to the traditional incrementalbackup if the policy domain of your node is changed on the server. Thisdepends on when the policy set within the domain was last updated and thedate of the last incremental backup. In this case, you must force a fulltraditional incremental backup to rebind the files to the new domain. Use thenojournal option with the incremental command to specify that you want toperform a traditional full incremental backup, instead of the defaultjournal-based backup.Related tasks:“Configuring the journal engine service” on page 41||||||||||||||||||||||||Restore processing with journal-based backups (Windows):The journal service attempts to identify changes that are made to a file as theresult of a restore operation. If a file is unchanged since it was restored, it is notbacked up again during the next journaled backup. The presumption is that youare restoring a file because it contains the data you need, so there is no point tobacking up the file again when the next journal backup occurs. Changes torestored files that occur after the files are restored must be recognized as newchanges and the file is processed in the next journal backup.When an active journal exists for a particular file system, the backup-archive clientnotifies the journal daemon when a file is about to be restored. Any changes to thefile that occur within a short window in time after the journal daemon is notifiedare assumed to be a result of the file being restored. These changes are notrecorded and the file is not included in the next journal backup.In most cases, journal processing correctly identifies file changes that are generatedas the result of the file being restored and prevents the file from being backed upby the next journal backup.Systemic system delays, whether caused by intensive I/O or file system latency,might prevent a restore operation from starting in the time frame allotted by thejournal daemon once it is notified that a restore is about to take place. If such adelay occurs, changes made to the file are assumed to be new changes thatoccurred after the file was restored. These changes are recorded, and the file isincluded in the next journal backup. Things like systemic processing delays andfile system latency are beyond the control of Tivoli Storage Manager and aresimply recognized limitations of journal-based backups.Incremental-by-date backupFor a file system to be eligible for incremental-by-date backups, you must haveperformed at least one full incremental backup of that file system. Running anChapter 4. Backing up your data 123

incremental backup of only a directory branch or individual file will not make thefile system eligible for incremental-by-date backups.To perform an incremental-by-date backup using the GUI, select the incremental(date only) option from the type of backup pull-down menu or use the incrbydateoption with the incremental command.The client backs up only those files whose modification date and time is later thanthe date and time of the last incremental backup of the file system on which thefile resides. Files added by the client after the last incremental backup, but with amodification date earlier than the last incremental backup, are not backed up.Files that were renamed after the last incremental backup, but otherwise remainunchanged, will not be backed up. Renaming a file does not change themodification date and time of the file. However, renaming a file does change themodification date of the directory in which it is located. In this case, the directoryis backed up, but not the files it contains.If you run an incremental-by-date backup of the whole file system, the serverupdates the date and time of the last incremental backup. If you perform anincremental-by-date backup on only part of a file system, the server does notupdate the date of the last full incremental backup. In this case, the nextincremental-by-date backup backs up these files again.Note: Unlike incremental backups, incremental-by-date backups do not expiredeleted files or rebind backup versions to a new management class if you changethe management class.Comparing incremental-by-date, journal-based, and NetAppsnapshot difference to full incremental and partial incrementalbackupsIncremental-by-date, journal-based, and NetApp snapshot difference arealternatives to full incremental and partial incremental back methods.Incremental-by-date backupAn incremental-by-date backup takes less time to process than a fullincremental backup and requires less memory.An incremental-by-date backup might not place exactly the same backupfiles into server storage because the incremental-by-date backup:vvvDoes not expire backup versions of files that you delete from theworkstation.Does not rebind backup versions to a new management class if youchange the management class.Does not back up files with attributes that change, unless themodification dates and times also change.v Ignores the copy group frequency attribute of management classes(Journal-based backups also ignore this attribute).Journal-based backupThe memory requirements for an initial journaling environment are thesame as the memory requirements for a full file space incremental, becausejournal-based backups must complete the full file space incremental inorder to set the journal database as valid, and to establish the baseline forjournaling.124 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The memory requirements for subsequent journal-based backups are muchless. Journal backup sessions run in parallel and are governed by theresourceutilization client option in the same manner as normal backupsessions. The size of the journal database file reverts to a minimal size (lessthan 1 KB) when the last entry has been deleted from the journal. Sinceentries are deleted from the journal as they are processed by the client, thedisk size occupied by the journal should be minimal after a completejournal backup. A full incremental backup with journaling active takes lesstime to process than an incremental-by-date backup.NetApp snapshot differenceFor NAS and N-Series file servers that are running ONTAP 7.3.0, or later,you can use the snapdiff option to invoke the snapshot difference backupfrom NetApp when running a full-volume incremental backup. Using thisoption reduces memory usage and is faster.Consider the following restrictions when running a full-volumeincremental backup using the snapdiff option, to ensure that data isbacked up when it should be.vvvvA file is excluded due to an exclude rule in the include-exclude file.Tivoli Storage Manager runs a backup of the current snapshot with thatexclude rule in effect. This happens when you have not made changes tothe file, but you have removed the rule that excluded the file. NetAppwill not detect this include-exclude change because it only detects filechanges between two snapshots.If you added an include statement to the option file, that include optiondoes not take effect unless NetApp detects that the file has changed.Tivoli Storage Manager does not inspect every file on the volume duringbackup.If you used the dsmc delete backup command to explicitly delete a filefrom the Tivoli Storage Manager inventory, NetApp cannot detect that afile was manually deleted from Tivoli Storage Manager. Therefore, thefile remains unprotected in Tivoli Storage Manager storage until it ischanged on the volume and the change is detected by NetApp, signalingTivoli Storage Manager to back it up again.Policy changes such as changing the policy from mode=modified tomode=absolute are not detected.v The entire file space is deleted from the Tivoli Storage Managerinventory. This action causes the snapdiff option to create a newsnapshot to use as the source, and a full incremental backup to be run.The NetApp software determines what is a changed object, not TivoliStorage Manager.If you run a full volume backup of an NFS-mounted or a CIFS-mappedNetApp or N-Series volume, all the snapshots under the snapshot directorymight also be backed up. To avoid this situation, you can do one of thefollowing actions:v Run NDMP backupsv Run backups using the snapshotroot optionv Run incremental backups using the snapdiff optionTip: If you run an incremental backup using the snapdiff option andyou schedule periodic incremental backups, use the createnewbase=yesoption with the snapdiff option to create a base snapshot and use it as asource to run an incremental backup.Chapter 4. Backing up your data 125

vExclude the snapshot directory from backups.On Windows systems, the snapshot directory is in ~snapshot.Selective backupUse a selective backup when you want to back up specific files or directoriesregardless of whether a current copy of those files exists on the server.Incremental backups are generally part of an automated system to back up entirefile systems. In contrast, selective backups allow you to manually select a set offiles to back up regardless of whether they have changed since your lastincremental backup.Unlike incremental backups, a selective backup provides the following:v Does not cause the server to update the date and time of the last incremental.v Backs up directory and file entries even if their size, modification timestamp, orpermissions have not changed.v Does not expire deleted files.v Does not rebind backup versions to a new management class if you change themanagement class.Related tasks:“Backing up data using the GUI” on page 109Related reference:“Selective” on page 658Backing up files from one or more file spaces for a group backup(Windows)You can use the backup group command to create and back up a group containinga list of files from one or more file space origins to a virtual file space on the TivoliStorage Manager server.A group backup allows you to create a consistent point-in-time backup of a group offiles that is managed as a single logical entity:vvvvAll objects in the group are assigned to the same management class. Use theinclude option to bind a group to a management class.Existing exclude statements for any files in the group are ignored.All objects in the group are exported together.All objects in the group are expired together as specified in the managementclass. No objects in a group are expired until all other objects in the group areexpired, even when another group they belong to gets expired.A group backup can be added to a backup set.You can perform a full or differential backup using the mode option.For example, to perform a full backup of all the files in the c:\dir1\filelist1 fileto the virtual file space \virtfs, containing the group leader c:\group1 file, enterthe following command:dsmc backup group -filelist=c:\dir1\filelist1 -groupname=group1 -virtualfsname=\virtfs -mode=full126 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Restore data from a backup set” on page 185Related reference:“Backup Group” on page 551“Include options” on page 395“Mode” on page 420Backing up data with client-node proxy support (Windows)Backups of multiple nodes that share storage can be consolidated to a commontarget node name on the Tivoli Storage Manager server.This is useful when the workstation responsible for performing the backup canchange over time, such as with a cluster.The asnodename option also allows data to be restored from a different system thanthe one which performed the backup.An agent node is a client node which has been granted authority to perform clientoperations on behalf of a target node.A target node is a client node which grants authority to one (or more) agent nodesto perform client operations on its behalf.Use the asnodename option with the appropriate command to back up, archive,restore, and retrieve data under the target node name on the Tivoli StorageManager server. This support is only available with Tivoli Storage Manager Version5.3 and higher server and client.To enable this option, follow these steps:1. Install the backup-archive client on all nodes in a shared data environment.2. Register each node with the Tivoli Storage Manager server, if it does not exist.Register the common target node name to be shared by each of the agent nodesused in your shared data environment.3. Register each of the nodes in the shared data environment with the TivoliStorage Manager server. This is the agent node name that is used forauthentication purposes. Data will not be stored using the node name when theasnodename option is used.4. Grant proxy authority to all nodes in the shared environment to access thetarget node name on the Tivoli Storage Manager server, using the GRANTPROXYNODE command (Tivoli Storage Manager administrator).5. Use the QUERY PROXYNODE administrative client command to display theclient nodes of the authorized user, granted by the GRANT PROXYNODEcommand.Suggestions:v All agent nodes in the multiple node environment should be of the sameplatform type.v Do not use target nodes as traditional nodes, especially if you encrypt your filesbefore backing them up to the server.Restrictions enforced within a proxied session:v You cannot perform a system state object backup or restore.Chapter 4. Backing up your data 127

v If a backup set contains system state object, it will not be restored within aproxied session.v You cannot access another node (either from GUI drop down or use of thefromnode option).v You cannot use the clusternode option.v You cannot perform NAS backup or restore.Related reference:“Asnodename” on page 296Enabling multiple node operations from the GUIThis topic lists the steps that you must follow to enable multiple node operationfrom the GUI.1. Verify that the client node has proxy authority to a target node (or authorizedto act as the target node) using the QUERY PROXYNODE administrative clientcommand.2. Select Edit → Preferences to open the preferences window.3. Select the General tab and fill in the As Node Name field with the name of thetarget node.4. Click Apply and then OK to close the preferences window.Perform one of the following steps to verify that your client node is now accessingthe server as the target node:vvOpen the tree window and check that the target node name specified by the AsNode Name field appears.Verify the target node name in the Accessing As Node field in the ConnectionInformation window.To return to single node operation, delete the As Node Name from the AccessingAs Node field in the General → Preferences tab.Setting up encryptionThis topic lists the steps that you must follow to set up encryption with theencryptkey option.1. Specify encryptkey=save in the options file.2. Back up at least one file with asnode=ProxyNodeName to create a localencryption key on each agent node in the multiple node environment.Follow these steps to set up encryption with the encryptkey=prompt option:1. Specify encryptkey=prompt in the options file.2. Ensure that users of the agent nodes in the multiple node environment areusing the same encryption key.Important:v If you change the encryption key, you must repeat the previous steps.v Use the same encryption key for all files backed up in the shared nodeenvironment.Scheduling backups with client-node proxy supportMultiple nodes can be used to perform backup operations using the scheduler.128 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

When you grant proxy authority to the agent nodes, they perform scheduledbackup operation on behalf of the target node. Each agent node must use theasnodename option within their schedule to perform multiple node backup for theagent node.Perform the following steps to enable scheduling of multiple nodes:1. Ensure that all agent nodes must have proxy authority over the common targetnode2. Ensure that all agent nodes must have a schedule defined on the server:def sched domain_name sched_name options=’-asnode=target’3. Ensure that each agent node must have its schedule associated with a node:def association domain_name schedule_name The following examples show the administrative client-server commands using thescheduler on multiple nodes.v The administrator registers all the nodes to be used, by issuing the followingcommands:– register node NODE-A– register node NODE-B– register node NODE-Cv The administrator grants proxy authority to each agent node, by issuing thefollowing commands:– grant proxynode target=NODE-Z agent=NODE-A– grant proxynode target=NODE-Z agent=NODE-B– grant proxynode target=NODE-Z agent=NODE-Cv The administrator defines the schedules, by issuing the following commands:– define schedule standard proxy1 description="NODE-A proxy schedule"action=incremental options="-asnode=NODE-Z" objects=C:startdate=05/21/2005 starttime=01:00– define schedule standard proxy2 description="NODE-B proxy schedule"action=incremental options="-asnode=NODE-Z" objects=D:startdate=05/21/2005 starttime=01:00– define schedule standard proxy3 description="NODE-C proxy schedule"action=incremental options="-asnode=NODE-Z" objects=E:startdate=05/21/2005 starttime=01:00Note: Place the asnodename option in the schedule definition only. Do not place itin the client options file, on the command line, or in any other location.For more information about the server scheduler commands, see IBM Tivoli StorageManager Administrator Command Reference.Start the schedules by either configuring a Tivoli Storage Manager scheduleservice, or by using the following client command: dsmc schedYou can also use the client acceptor daemon, with managedservices set to schedulein the systems options file.Important:v Each schedule can be started from a different workstation or LPAR.Chapter 4. Backing up your data 129

vAfter running the schedules, any proxied client can query and restore all thebacked up data.Associate a local snapshot with a server file space (Windows)Use the snapshotroot option with the incremental and selective commands inconjunction with a vendor-supplied application that provides a snapshot of alogical volume, to associate the data on the local snapshot with the real file spacedata that is stored on the Tivoli Storage Manager server.The snapshotroot option does not provide any facilities to take a volume snapshot,only to manage data created by a volume snapshot.Related reference:“Snapshotroot” on page 479Backing up Windows system stateTivoli Storage Manager uses VSS to back up all system state components as asingle object, to provide a consistent point-in-time snapshot of the system state.System state consists of all startable system state and system services components.Tivoli Storage Manager supports the Microsoft Volume Shadowcopy Service (VSS)on the supported Windows clients.The system state backup consists of data from several VSS writers. When the filesthat belong to the System Writer change, an incremental backup is used for thesefiles. Using incremental backup on the System Writer files reduces the amount oftime it takes to back up the system state. A full backup is used for all other systemstate data.By default, a progressive incremental backup is used for the System Writer files inthe system state. If you want to run a full backup of all system state data, you canspecify include.systemstate mc_name in the client options file (dsm.opt), wheremc_name is the name of the management class with copy group mode absolute.Startable system state components include the following:v ASR writerv Active Directory (domain controller only)v System Volume (domain controller only)v Certificate Server Database (domain controller only)v COM+ databasev Windows Registryv System and boot filesSystem services components include the following:v Background Intelligent Transfer Service (BITS)v Removable Storage Management Database (RSM)v Cluster Database (cluster node only)v Remote Storage Servicev Terminal Server Licensingv Windows Management Instrumentation (WMI)v Internet Information Services (IIS) metabasev Dynamic Host Configuration Protocol (DHCP)v Windows Internet Name Service (WINS)130 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The list of startable system state and system services components are dynamic andcan change depending on service pack and operating system features installed.Tivoli Storage Manager allows for the dynamic discovery and back up of thesecomponents.You must be a member of the Administrators or Backup Operators group to backup system state information.Important:1. Your Windows client must be connected to a Tivoli Storage Manager Version5.2.0 or higher server.To back up a system state object using the command line:1. On the command line, use the backup systemstate command to back up allsystem state or system services components as a single object.2. Use the query systemstate command to display information about a backup ofthe system state on the Tivoli Storage Manager server.To back up a system state object using the GUI:1. Click Backup from the GUI main window. The Backup window appears.2. Expand the directory tree by clicking the plus sign (+). To display files in afolder, click the folder icon.3. Locate the system state node in the directory tree. You can expand the systemstate node to display the components.4. Click the selection box next to the system state node to back up the entiresystem state object. You can back up the system state node only as a singleentity because of dependencies among the system state components. By default,all components are selected; you cannot back up individual system statecomponents.5. Click Backup. The Backup Task List window displays the backup processingstatus. When processing completes, the Backup Report window displaysprocessing details.System and boot files are backed up as a group only if one of the members of thegroup (one of the files) changes. If the files have not changed since the last backup,the system and boot files are not redundantly backed up.You can use the include.systemstate option to assign management classes forback up of the system state. The default is to bind the system state object to thedefault management class.You can use the exclude.systemservice option in your client options file (dsm.opt)to exclude individual system services components from backup. Input can be thekeyword or component name to be excluded from backup.You can use the domain option to exclude the entire system state from domainincremental backup processing.|||||The system dllcache directory is now included in the boot partition backup ofWindows Vista systems. When the dllcache files are not available when yourestore a Windows Vista computer, system recovery might require availability ofthe operating system installation media. By backing up the dllcache directory, youcan avoid the need for installation media during system restores.Chapter 4. Backing up your data 131

If you do not want the dllcache directory included in the backup of your bootpartition, and you understand the limitations of not backing up the dllcachedirectory, then you can use an exclude.dir statement to suppress backup of thosefiles. For example:exclude.dir c:\windows\system32\dllcache|On Windows clients, backup systemstate also backs up ASR data.Related tasks:“Restoring Windows system state” on page 180Related reference:“Backup Systemstate” on page 560“Domain” on page 340“Exclude options” on page 365“Include options” on page 395“Query Systemstate” on page 616“Restore Systemstate” on page 645Backing up Automated System Recovery filesBack up Automated System Recovery (ASR) files in preparation for recovering theWindows disk configuration information and system state in case a catastrophicsystem or hardware failure occurs.|||||||On Windows Vista, Windows 7, and Windows Server 2008, the Tivoli StorageManager backup-archive client backs up ASR data when the backup-archive clientbacks up the Windows system state. Use the backup systemstate command to backup ASR files on these operating systems.Tivoli Storage Manager generates the ASR files in the \adsm.sys\ASR stagingdirectory on the system drive of your local workstation and stores these files in theASR file space on the Tivoli Storage Manager server.Related concepts:“Backing up in preparation for Automated System Recovery (Windows Vista,Windows 7, and Windows Server 2008)”Related tasks:“Restoring Automated System Recovery files” on page 181Related reference:“Backup Systemstate” on page 560Backing up in preparation for Automated System Recovery (WindowsVista, Windows 7, and Windows Server 2008)Specific backups and media are required for Windows Vista, Windows 7, andWindows Server 2008 Automated System Recovery (ASR).Note that ASR data is not backed up, and hence cannot be restored, on 64-bitarchitectures with Extensible Firmware Interface (EFI).132 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Creating a Tivoli Storage Manager options file for AutomatedSystem Recovery (Windows Vista, Windows 7, or WindowsServer 2008)Before you can recover a Windows Vista, Windows 7, or Windows Server 2008computer using Automated System Recovery (ASR), you must create an optionsfile. The options file is unique for each computer.This task assumes that you created a generic bootable WinPE CD or DVD. Ageneric bootable WinPE CD does not contain the Tivoli Storage Manager optionsfile (dsm.opt), because the options file is unique for each computer. This task helpsyou create a computer-specific options file.The Windows Preinstallation Environment (WinPE) requires particular optionsvalues.1. Find a copy of the Tivoli Storage Manager client options file. You can find thefile in several places:vThere is an options file in the installation directory of an installed TivoliStorage Manager client. The default installation location is C:\ProgramFiles\Tivoli\TSM\baclient\dsm.opt. If you have the options file for thecomputer that you want to restore, this options file requires the fewestmodifications.v There is a sample options file in the client installation package. The path inthe package is TSM_BA_Client\program files\Tivoli\TSM\config\dsm.smp.Rename the file to dsm.opt.2. Edit dsm.opt.a. Enter a writable location for the error log. The backup-archive client createsseveral log files. Use the option errorlogname to specify the log file location.For example, in dsm.opt specify errorlogname x:\dsmerror.log.Note: This example uses x: because in WinPE mode, the default systemdrive is x:.b. Enter the Tivoli Storage Manager node name with the nodename option.c. Optional: If you plan to restore the system state from files stored on a TivoliStorage Manager server, enter the Tivoli Storage Manager server connectioninformation. Enter appropriate values for the commmethod andtcpserveraddress options.d. Optional: If you know the password for the node, enter the password withthe password option.3. Copy the dsm.opt file to media that the target computer can read duringAutomated System Recovery.4. Optional: Copy Tivoli Storage Manager client registry information to media thatthe target computer can read during Automated System Recovery. Use theregedit.exe utility to export Tivoli Storage Manager client registry entries fromthe HKLM\SOFTWARE\IBM key. For example, from a command promptwindow, run this command: regedit /e tsmregistry.out"HKEY_LOCAL_MACHINE\SOFTWARE\IBM". Copy the tsmregistry.out file to mediathat the target computer can read during ASR. During ASR, you can import theregistry entries from the tsmregistry.out file. The Tivoli Storage Managerclient can use the registry entries in the WinPE environment to access backupcopies on the Tivoli Storage Manager server.Chapter 4. Backing up your data 133

Image backupNote: Saving registry entries is optional because there are other ways to getaccess to the password-protected Tivoli Storage Manager server. The other waysto gain access to the server are the following:v If you know the node password, you can type the password when promptedduring recovery.v Request the Tivoli Storage Manager administrator to change the nodepassword and tell you the new password at the time of recovery.v Provide the password information in the dsm.opt file.If the files you want to restore are included in a backup set on tape or on a CDor DVD, then you do not need to access the Tivoli Storage Manager server.You created an options file that contains Tivoli Storage Manager configurationinformation that is unique for each computer. This information complements thegeneric bootable WinPE CD.Related tasks:“Creating a bootable WinPE CD (Windows Vista, Windows 7, Windows Server2008, Windows Server 2008 R2)” on page 182Backing up the boot drive and system drive for AutomatedSystem Recovery (Windows Vista, Windows 7, or WindowsServer 2008)Before you can recover your Windows Vista, Windows 7, or Windows Server 2008computer using ASR (Automated System Recovery), you must have a completebackup of the boot drive and system drive.1. Perform a full incremental backup of your system and boot drives. Assumingthat your system and boot files are on drive c:, enter the following command:dsmc incremental c:2. Back up the system state. To back up the system state, enter the followingcommand: dsmc backup systemstate. To verify that you backed up the systemstate, enter the following command: dsmc query systemstate. You can specify-showmembers=yes to display file level detail.Related concepts:“Full and partial incremental backup” on page 120Related tasks:“Backing up Windows system state” on page 130From your local workstation, you can back up a logical volume as a single object(image backup) on your system.The traditional static image backup prevents write access to the volume by othersystem applications during the operation.These volumes can be formatted NTFS, or unformatted RAW volumes. If a volumeis NTFS-formatted, only those blocks used by the file system or smaller than theimagegapsize parameter is backed up.Normally you cannot restore an image backup of the system drive over itself sincean exclusive lock of the system drive is not possible. However, when using WinPE,134 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

an image restore of the system drive is possible. See Tivoli Storage Manager RecoveryTechniques Using Windows Preinstallation Environment (Windows PE) for moreinformation.You cannot restore an image backup to the volume from which the client iscurrently running. Consider installing the Tivoli Storage Manager client on thesystem drive.Image backup does not guarantee consistency of system objects, such as the ActiveDirectory. System objects can be spread out across multiple volumes, and shouldbe backed up using the corresponding BACKUP commands.An image backup provides the following benefits:v Backs up file systems containing a large number of files faster than a full filesystem incremental backup.v Improves the speed with which Tivoli Storage Manager restores file systemscontaining many small files.v Conserves resources on the server during backups since only one entry isrequired for the image.v Provides a point-in-time picture of your logical volume, which might be useful ifyour enterprise needs to recall that information.v Restores a corrupt file system or raw logical volume. Data is restored to thesame state it was when the last logical volume backup was performed.The traditional offline image backup prevents write access to the volume by othersystem applications during the operation. When backing up an image usingsnapshotproviderimage=none, after a restore always run the fsck utility.To restore an image backup of a volume, the Tivoli Storage Manager client must beable to obtain an exclusive lock on the volume being restored.If the Tivoli Storage Manager online image support is configured, Tivoli StorageManager performs an online image backup, during which the volume is availableto other system applications. The snapshot provider, as specified by thesnapshotproviderimage option, maintains a consistent image of a volume duringonline image backup.You can use the snapshotproviderimage option with the backup image commandor the include.image option to specify whether to perform an offline or onlineimage backup.Related tasks:“Configuring online-image backup support” on page 69Related reference:“Snapshotproviderimage” on page 479Performing prerequisite tasks before creating an imagebackupThis topic lists some items to consider before you perform an image backup.The following items are the image backup considerations.v To perform an offline or online image backup you must have administrative authority onthe system.Chapter 4. Backing up your data 135

v You do not need more than one drive to perform an image backup.v Ensure that no other application is using the volume when you run an offlineimage backup. To ensure a consistent image during backup processing, the clientlocks the volume, so that no other applications can write to it. If the volume isin use when the client attempts to lock the volume, the backup fails. If the clientcannot lock a volume because it is in use, you can perform an online imagebackup.v Use the include.image option to assign a management class to the volumeimage. If you do not assign a management class, the default management classis used for the image.vvvNote: If the snapshotproviderimage option is set to none, then the copyserialization parameters set by the management class is used.You can exclude a volume from image backup using the exclude.image option.You must use the mount point or drive letter for the volume on which you wantto perform an image backup. Tivoli Storage Manager will not back up a volumewithout the use of a drive letter or mount point.Do not include the system drive in an image backup because the client cannothave an exclusive lock of the system drive during the restore and the systemdrive image cannot be restored to the same location. Image backup does notguarantee consistency of system objects, such as the Active Directory. Systemobjects can be spread out across multiple volumes, and should be backed upusing the corresponding backup commands. Because you cannot restore animage backup to the volume from which the client is currently running (or anyvolume for which an exclusive lock cannot be obtained) you should install yourclient program on the system drive.Note: When using WinPE, an image restore of the system drive is possible. SeeTivoli Storage Manager Recovery Techniques Using Windows PreinstallationEnvironment (Windows PE) for more information.v If bad disk sectors are detected on the source drive during a LAN-free orLAN-based image backup, data corruption can occur. In this case, bad sectorsare skipped when sending image data to the Tivoli Storage Manager server. Ifbad disk sectors are detected during the image backup, a warning message isissued after the image backup completes.Related concepts:Chapter 9, “Storage management policies,” on page 239Related reference:“Exclude options” on page 365“Include options” on page 395“Snapshotproviderimage” on page 479Utilizing image backups to perform file system incrementalbackupsThis topic lists the methods and steps to use image backups to perform efficientincremental backups of your file system.These backup methods allow you to perform a point-in-time restore of your filesystems and improve backup and restore performance. You can perform thebackup only on formatted volumes; not on raw logical volumes.136 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

You can use one of the following methods to perform image backups of volumeswith mounted file systems.Method 1: Using image backups with file system incrementalbackupsThis topic lists the steps to perform image backups with file system incrementalbackup.1. Perform a full incremental backup of the file system. This establishes a baselinefor future incremental backups.2. Perform an image backup of the same file system to make image restorespossible.3. Perform incremental backups of the file system periodically to ensure that theserver records additions and deletions accurately.4. Perform an image backup periodically to ensure faster restore.5. Restore your data by performing an incremental restore. Ensure that you selectthe Image plus incremental directories and files and Delete inactive filesfrom local options in the Restore Options window before beginning the restore.During the restore, the client does the following:v Restores the most recent image on the server.vvDeletes all of the files restored in the previous step which are inactive on theserver. These are files which existed at the time of the image backup, but weresubsequently deleted and recorded by a later incremental backup.Restores new and changed files from the incremental backups.Note: If an incremental backup is performed several times after backing up animage, make sure that the backup copy group of the Tivoli Storage Manager serverhas enough versions for existing and deleted files on the server so that thesubsequent restore image with incremental and deletefiles options can deletefiles correctly.Related tasks:“Backing up data using the GUI” on page 109“Performing an image backup using the GUI” on page 139“Restoring an image using the GUI” on page 184Method 2: Using image backups with incremental-by-date imagebackupsThis topic lists the steps to perform image backups with incremental-by-date imagebackup.1. Perform an image backup of the file system.2. Perform an incremental-by-date image backup of the file system. This sendsonly those files that were added or changed since the last image backup to theserver.3. Periodically, perform full image backups.4. Restore your volume by performing an incremental restore. Ensure that youselect the Image plus incremental directories and files option in the RestoreOptions window before beginning the restore. This first restores the most recentimage and then restores all of the incremental backups performed since thatdate.Note: You should perform full image backups periodically in the following cases:v When a file system changes substantially (more than 40%), as indicated in step 4of method 1 and step 3 of method 2. On restore, this would provide a fileChapter 4. Backing up your data 137

system image close to what existed at the time of the last incremental-by-dateimage backup and it also improves restore time.v As appropriate for your environment.This improves restore time because fewer changes are applied from incrementalbackups.The following restrictions apply when using method 2:v The file system can have no previous full incremental backups.v Incremental-by-date image backup does not inactivate files on the server;therefore, when you restore an image with the incremental option, files deletedafter the original image backup is present after the restore.v If this is the first image backup for the file system, a full image backup isperformed.v If file systems are running at or near capacity, an out-of-space condition couldresult during the restore.Related information“Restoring an image using the GUI” on page 184“Performing an image backup using the GUI” on page 139Related tasks:“Performing an image backup using the GUI” on page 139“Restoring an image using the GUI” on page 184Comparing methods 1 and 2This topic shows a comparison of methods 1 and 2: (1) Using image backup withfile system incremental or (2) Using image backup with incremental-by-date imagebackup.To help you decide which method is appropriate for your environment, thefollowing table is a comparison of methods 1 and 2.Table 22. Comparing incremental image backup methodsMethod 1: Using image backup with filesystem incrementalFiles are expired on the server when they aredeleted from the file system. On restore, youhave the option to delete files which areexpired on server from image.Incremental backup time is the same asregular incremental backups.Restore is much faster compared to a fullincremental file system restore.Directories deleted from the file system afterthe last image backup are not expired.Method 2: Using image backup withincremental-by-date image backupFiles are not expired on server. After theimage incremental restore completes, all ofthe files that are deleted on the file systemafter the image backup are present after therestore. If file systems are running at or nearcapacity, an out-of-space condition couldresult.Incremental image backup is faster becausethe client does not query the server for eachfile that is copied.Restore is much faster compared to a fullincremental file system restore.Directories and files deleted from the filesystem after the last full image backup arenot expired.138 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Performing an image backup using the GUIIf the Tivoli Storage Manager image feature is configured, you can create an imagebackup where the real volume is available to other system applications.A consistent image of the volume is maintained during the image backup.When you perform an image backup using the client GUI image backup option,Tivoli Storage Manager honors the snapshotproviderimage setting in your clientoptions file (dsm.opt). If the Tivoli Storage Manager online image support isconfigured, Tivoli Storage Manager performs an online image backup, duringwhich the volume is available to other system applications.To create an image backup of your file system or raw logical volume, perform thefollowing steps:1. Click on the Backup button in the Tivoli Storage Manager main window. TheBackup window appears.2. Expand the directory tree and select the objects you want to back up. To backup a raw logical volume, locate and expand the RAW directory tree object.3. Click Backup. The Backup Task List window displays the backup processingstatus. The Backup Report window displays a detailed status report.vvvTo perform an offline image backup, select Image Backup from the drop-downlist.To perform an online image backup, select Snapshot Image Backup from thedrop-down list.To perform an incremental-by-date image backup, select Incremental image(date only) from the drop-down list.The following are some items to consider when you perform an online imagebackup:vvvTo modify specific backup options, click the Options button. The options youselect are effective during the current session only.Because image backup allows you to back up only used blocks in a file system,the stored image size on the Tivoli Storage Manager server could be smallerthan the volume size. For online image backups, the stored image can be largerthan the file system based on the size of the cache files. To determine the actualstored image size, select View → File Details. The actual stored image size isnoted in the Stored Size field.To modify specific backup options, click the Options button. The options youselect are effective during the current session only.v Because image backup allows you to back up only used blocks in a file system,the stored image size on the Tivoli Storage Manager server could be smallerthan the volume size. For online image backups, the stored image can be largerthan the file system based on the size of the cache files. To determine the actualstored image size, select View → File Details. The actual stored image size isnoted in the Stored Size field.Related reference:“Snapshotproviderimage” on page 479Performing an image backup using the command lineUse the backup image and restore image commands to perform image backupand restore operations on a single volume.Chapter 4. Backing up your data 139

You can use the snapshotproviderimage option with the backup image commandor the include.image option in your dsm.opt file or on the command line tospecify whether to perform an offline or online image backup.Use the mode option with the backup image command to perform anincremental-by-date image backup that backs up only new and changed files afterthe last full image backup. However, this only backs up files with a changed date,not files with changed permissions.Related reference:“Backup Image” on page 554“Mode” on page 420“Restore Image” on page 640“Snapshotproviderimage” on page 479Back up NAS file systems using Network Data Management ProtocolThrough support of Network Data Management Protocol (NDMP), Tivoli StorageManager Windows, AIX, and Solaris backup-archive clients can efficiently back upand restore network attached storage (NAS) file system images to automated tapedrives or libraries that are locally attached to Network Appliance and EMC CelerraNAS file servers.NDMP support is available only on IBM Tivoli Storage Manager Extended Edition.Incremental backup can also be used to back up NAS file system snapshots. Seethe incremental command and snapshotroot, snapdiff, createnewbase, anddiffsnapshot options for more information.After configuring NDMP support, the server connects to the NAS device and usesNDMP to initiate, control, and monitor each backup and restore operation. TheNAS device performs outboard data transfer to and from the NAS file system to alocally attached library.Filer to server data transfer is available for NAS devices that support NDMPVersion 4.The benefits of performing backups using NDMP include the following:v LAN-free data transfer.v High performance and scalable backups and restores.v Backup to local tape devices without network traffic.The following support is provided:v Full file system image backup of all files within a NAS file system.v Differential file system image backup of all files that have changed since the lastfull image backup.v Parallel backup and restore operations when processing multiple NAS filesystems.v Choice of interfaces to initiate, monitor, or cancel backup and restore operations:– Web client– Backup-archive client command interface– Administrative client command line interface (backup and restore operationscan be scheduled using the administrative command scheduler)140 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

– Administrative Web clientThe following functions are not supported:v Archive and retrievev Client scheduling. Use server commands to schedule a NAS backup.v Detection of damaged files.v Data-transfer operations for NAS data stored by Tivoli Storage Manager:– Migration– Reclamation– Export– Backup set generationRelated concepts:“NDMP support requirements (Extended Edition only)” on page 8Related reference:“Diffsnapshot” on page 334“Incremental” on page 579“Snapdiff” on page 473“Snapshotroot” on page 479Backing up NAS file systems with the Web client GUI usingNDMP protocolFor both the Web client GUI and the client command line interface, you mustspecify passwordaccess=generate (which is a current Web client restriction for theclient node) and the authentication=on must be specified at the server.You are always prompted for a user ID and password. To display NAS nodes andperform NAS functions, you must enter an authorized administrative user ID andpassword. The authorized administrative user ID should have at least client ownerauthority over both the NAS node and the client workstation node they are usingeither from command line or from the web.You can use the toc option with the include.fs.nas option in the client optionsfile to specify whether Tivoli Storage Manager saves Table of Contents (TOC)information for each file system backup. If you save TOC information, you can useTivoli Storage Manager for Windows Web client to examine the entire file systemtree and select files and directories to restore. Creation of a TOC requires that youdefine the TOCDESTINATION attribute in the backup copy group for themanagement class to which this backup image is bound. Note that TOC creationrequires additional processing, network resources, storage pool space, and possiblya mount point during the backup operation.To back up NAS file systems using the Web client GUI:1. Click Backup from the main window. The Backup window is displayed.2. Expand the directory tree if necessary.Note:a. The root node called Nodes is not selectable. This node only appears if aNAS plug-in is present on the client workstation.b. NAS nodes display on the same level as the client workstation node. Onlynodes for which the administrator has authority appear.c. You can expand NAS nodes to reveal file spaces, but no further expansion isavailable (no file names).Chapter 4. Backing up your data 141

3. Click the selection boxes next to the nodes or file systems you want to back up.4. Click the type of backup you want to perform in the backup type pull-downmenu. The NAS backup type list is active only when you first select NASbackup objects. Full backup backs up the entire file system. Differential backsup the changes since the most recent full backup.5. Click Backup. The NAS Backup Task List window displays the backupprocessing status and progress bar. The number next to the progress barindicates the number of bytes backed up so far. After the backup completes, theNAS Backup Report window displays processing details, including the actualsize of the backup including the total bytes backed up.Note: If it is necessary to close the Web browser session, current NASoperations continue after disconnect. You can use the Dismiss button on theNAS Backup Task List window to quit monitoring processing without endingthe current operation.6. (Optional) To monitor processing of an operation from the GUI main window,open the Actions menu and select TSM Activities. During a backup, the statusbar indicates processing status. A percentage estimate is not displayed fordifferential backups.Here are some items to consider when you back up NAS file systems using theWeb client GUI:vvvvWorkstation and remote (NAS) backups are mutually exclusive in a Backupwindow. After selecting an item for backup, the next item you select must be ofthe same type (either NAS or non NAS).Details will not appear in the right-frame of the Backup window for NAS nodesor file systems. To view information about objects in a NAS node, highlight theobject and select View → File Details from the menu.To delete NAS file spaces, select Utilities → Delete Filespaces.Backup options do not apply to NAS file spaces and are ignored during a NASbackup operation.Related concepts:“Restore NAS file systems” on page 207Related tasks:“Configuring the Web client” on page 31Related reference:“Toc” on page 505Back up NAS file systems using the command lineYou can use the command line to back up NAS file system images.Table 23 lists the commands and options that you can use to back up NAS filesystem images from the command line.Table 23. NAS options and commandsOption or command Definition Pagedomain.nasUse the domain.nas option to specify thevolumes to include in your default domainfor NAS backups.“Domain.nas” on page344142 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 23. NAS options and commands (continued)Option or command Definition Pageexclude.fs.nas Use the exclude.fs.nas option to excludefile systems on the NAS file server from animage backup when used with the backupnas command.“Exclude options” onpage 365|||||||include.fs.nasquery nodebackup nastocmonitor processcancel processquery backupquery filespaceThis option is valid for all Windows clients.Use the include.fs.nas option to bind amanagement class to Network AttachedStorage (NAS) file systems. You can alsospecify whether Tivoli Storage Managersaves Table of Contents (TOC) informationduring a NAS file system image backup,using the toc option with theinclude.fs.nas option in your client optionsfile..This option is valid for all Windows clients.Use the query node command to display allthe nodes for which a particularadministrative user ID has authority toperform operations. The administrative userID should have at least client ownerauthority over both the NAS node and theclient workstation node they are using.Use the backup nas command to create animage backup of one or more file systemsthat belong to a Network Attached Storage(NAS) file server.Use the toc option with the backup nascommand or the include.fs.nas option tospecify whether Tivoli Storage Managersaves Table of Contents (TOC) informationfor each file system backup.Use the monitor process command todisplay current backup and restore processesfor all NAS nodes for which anadministrative user has authority. Theadministrative user can then select oneprocess to monitor.Use the cancel process command to displaycurrent backup and restore processes for allNAS nodes for which an administrative userhas authority. From the display, theadministrative user can select one process tocancel.Use the query backup command with theclass option to display information aboutfile system images backed up for a NAS fileserver.Use the query filespace command with theclass option to display a list of file spacesbelonging to a NAS node.“Include options” onpage 395“Query Node” onpage 610“Backup NAS” onpage 558“Toc” on page 505“Monitor Process” onpage 589“Cancel Process” onpage 568“Query Backup” onpage 596“Query Filespace” onpage 603Chapter 4. Backing up your data 143

Table 23. NAS options and commands (continued)Option or command Definition Pagedelete filespace Use the delete filespace command with theclass option to display a list of file spacesbelonging to a NAS node so that you canchoose one to delete.“Delete Filespace” onpage 574A NAS file system specification uses the following conventions:v NAS nodes represent a new node type. The NAS node name uniquely identifiesa NAS file server and its data to Tivoli Storage Manager. You can prefix the NASnode name to the file specification to specify the file server to which the includestatement applies. If you do not specify a NAS node name, the file system youspecify applies to all NAS file servers.v Regardless of client platform, NAS file system specifications use the forwardslash (/) separator, as in this example: /vol/vol0.v NAS file system designations on the command line require brace delimiters {}around the file system names, such as: {/vol/vol0}. Do not use brace delimitersin the option file.Note: When you initiate a NAS backup operation using the client command lineinterface, client GUI, or Web client the server starts a process to initiate, control,and monitor the operation. It might take several moments before you noticeprogress at the client command line interface because the server must perform amount and other necessary tasks before data movement occurs.Related reference:“Toc” on page 505Methods for backing up and recovering data on NAS fileservers when using CIFSTivoli Storage Manager can process network attached storage (NAS) file-serverdata that is accessed using the Common Internet File System (CIFS).You can use the following methods to back up and recover data on NAS devices:v Use a Tivoli Storage Manager backup-archive client to back up and restore data,by using CIFS or NFS to access files from the backup-archive client. Data can bestored on the Tivoli Storage Manager server with file-level granularity, by usingthe progressive-incremental backup method. The data is stored in the TivoliStorage Manager storage hierarchy and can be migrated, reclaimed, and backedup to a copy storage pool.This method increases processor usage when the Tivoli Storage Manager clientaccesses individual files. The method requires that data flow through the TivoliStorage Manager client. This method also requires that the data flows throughthe Tivoli Storage Manager server unless a LAN-free configuration is used.v Use the snapdiff option to mitigate the performance problems of CIFS backup.This option stores data with file-level granularity using progressive incrementalbackup for NFS or CIFS.v Use a Tivoli Storage Manager backup-archive client running on the NAS device,provided that you can use external programs with the NAS operating system.This method decreases processor usage of CIFS or NFS. Data can be stored onthe Tivoli Storage Manager server with file-level granularity usingprogressive-incremental backup. The data is stored in the Tivoli Storage Managerstorage hierarchy and can be migrated, reclaimed, and backed up to a copy144 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vstorage pool. This method requires that data flow through the Tivoli StorageManager client. This method also requires that the data flows over a networkand through the Tivoli Storage Manager server unless a LAN-free configurationis used.Use NDMP with Tivoli Storage Manager. File systems are backed up as fullimages (all files) or differential images (all files that have changed since the lastfull backup). Backed up images are stored on a tape device that is accessed bythe NAS file server. This method provides high performance because there is nodata flow through a Tivoli Storage Manager client or server. Data that is backedup to Tivoli Storage Manager using NDMP cannot be migrated, reclaimed, orbacked up to a copy storage pool.These are some limitations of NAS file server data when using CIFS:v File and directory security information might be inaccessible when the Windowsaccount performing the backup is not a member of the Domain Administratorsgroup of the domain the NAS file server is a trusted member of. It is alsopossible that these security access failures might prevent the entire file ordirectory from being backed up.v Performance degradation occurs because data is being accessed remotely.v The mapped drives appear to Tivoli Storage Manager as NTFS file systems, butthey might not have the full functionality of NTFS functionality. For example,the encryption attribute of a file is set, but when the client backs up the file, thebackup fails because the volume-level encryption setting indicates thatencryption cannot be used for the volume.Tip: Use NDMP with Tivoli Storage Manager on a NAS file server to back upand restore volumes instead of backing up and restoring the volumes usingremote mapped drives.Related reference:“Snapdiff” on page 473Support for CDP Persistent Storage ManagerPersistent Storage Manager (PSM) is the snapshot technology that is included witha number of Microsoft Server Appliance Kit based NAS boxes including the IBMTotalStorage NAS 200, 300, and 300G.You can use the Tivoli Storage Manager backup-archive client to back up thepersistent images (PI) of a volume produced by PSM. You must first ensure thatthe volume has a label. You can then use PSM to schedule or create a persistentimage with a specific image name, such as snapshot.daily, and set the number ofimages to save to 1. PSM overwrites the PI as needed and you can use TivoliStorage Manager to incrementally back up the PI. In this case, Tivoli StorageManager only backs up the files that changed between snapshots. One advantageof backing up a PSM PI rather than the actual volume, is that there are no openfiles in the PI.Consider the following items before using Persistent Storage Manager:v By default, a PSM schedule uses a variable name (snapshot.%i) and keeps anumber of images.Important: Do not use Tivoli Storage Manager with PSM in this way. TivoliStorage Manager sees each image as unique and makes a complete copy of each.Chapter 4. Backing up your data 145

vvvTivoli Storage Manager requires that the volume used to make the PI has a label.If the volume does not have a label, Tivoli Storage Manager will not back up itsPI.You use the Tivoli Storage Manager image backup function to back up theoriginal volume used to create the PI, but you cannot use the backup imagefunction to back up the PI.To avoid backing up unnecessary files when backing up PSM, include thefollowing entries in your client option file (dsm.opt):exclude.dir "Persistent Storage Manager State"exclude.file "*.psm"exclude.file "*.otm"Backing up VMware virtual machinesYou can use the backup-archive client to back up and restore a VMware virtualmachine (VM). Full backups of the virtual machine operate at a disk image level.Incremental backups copy only the data that is changed since the previous fullbackup.|||||||||Table 24 lists the backup and restore operations for VMware virtual machines thatthe backup-archive client can perform on Windows platforms.Table 24. Backup and restore capabilities for VMware virtual machines on Windows platformsCapabilityCommentFull VM backup:Backs up a full virtual machine. The following types of full VM backup are possible:v Create an image backup of the full virtual machine.v Create a backup of files or directories on the virtual machine.v Create an image backup of a Microsoft Hyper-V virtual machine.Incremental VM backup: Requires a license for IBM Tivoli Storage Manager for Virtual Environments.|||||||||||||||||||||||Full VM incremental-foreverbackup:Backs up all changes that occurred since the previous backup of the virtual machine,whether the backup was a full backup, or another incremental backup. For thisbackup mode, you must schedule full backups of the virtual machine to occurperiodically so the historical data can be expired. Historical data is expired from a fullbackup and all incremental backups that depend on the full backup. Restoring datafrom incremental backups is not convenient or efficient because the process mustautomatically complete the following tasks:v Restore the most recent full backup.vRestore each incremental backup as required to restore your content to a specificpoint in time.For more efficient backups, use the incremental-forever backup modes.Requires a license for IBM Tivoli Storage Manager for Virtual Environments.A full VM backup is required before you can create incremental backups. If youschedule incremental-forever backups, this backup type is selected automatically forthe first backup if a full backup was not already created. Data from incrementalbackups is combined with data from the full backup to create a synthetic full backupimage. Subsequent full VM incremental-forever backups read all used blocks and copythose blocks to the Tivoli Storage Manager server. Each full VM incremental-foreverbackup reads and copies all of the used blocks, whether the blocks are changed or notsince the previous backup. You can still schedule a full VM backup, although a fullbackup is no longer necessary. For example, you might run a full VM backup to createa backup to a different node name with different retention settings.146 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||Table 24. Backup and restore capabilities for VMware virtual machines on Windows platforms (continued)CapabilityCommentIncremental-foreverincrementalVM backup:Requires a license for IBM Tivoli Storage Manager for Virtual Environments.Requires you to create a full VM backup one time only. The full VM backup copies allof the used disk blocks owned by a virtual machine to the Tivoli Storage Managerserver. After the initial full backup is complete, all subsequent backups of the virtualmachine are incremental-forever-incremental backups. Each incremental-foreverincrementalbackup copies only the blocks that are changed since the previous backup,irrespective of the type of the previous backup. The server uses a grouping technologythat associates the changed blocks from the most recent backup with data alreadystored on the server from previous backups. A new full backup is then effectivelycreated each time changed blocks are copied to the server by an incremental-foreverincrementalbackup.|||||||||||||||||||||||||Item recovery for files andfolders from a full backup ofthe virtual machine:Full restore of the virtualmachine:File-level backup:File-level restore of thevirtual machine:The incremental-forever-incremental backup mode provides the following benefits:v Improves the efficiency of backing up virtual machines.v Simplifies data restore operations.v Optimizes data restore operations.During a restore operation, you can specify options for point-in-time and point-in-dateto recover data. The data is restored from the original full backup and all of thechanged blocks that are associated with the data.Requires a license for IBM Tivoli Storage Manager for Virtual Environments.Provides the capability to recover files and folders from a full backup of a virtualmachine. Item recovery is available only with Tivoli Storage Manager for VirtualEnvironments Data Protection for VMware Recovery Agent.Restores all of the file systems, virtual disks, and the virtual machine configuration.Uses the VMware vStorage API for Data Protection and VMware vStorage backupserver to create backups of individual files in the virtual machine. You create includeand exclude rules to identify the files to back up. For file-level backups, files arebacked up as individual files rather than as an image backup.The restore approach depends on the type of backup of the virtual machine:v If you have a license for Tivoli Storage Manager for Virtual Environments, you canrestore files and directories from a full VM image backup.v Backup-archive client users can restore files and directories created by file-levelbackups of a virtual machine. You use the restore command to restore individualfiles from a file-level backup of a virtual machine, not the restore vm command.||||||||||||For releases before Tivoli Storage Manager version 6.3, the backup-archive clientwas able to use VMware Consolidated Backup (VCB) to back up data on virtualmachines. From Tivoli Storage Manager version 6.3, the use of VCB for backups isno longer available. The backup-archive client now backs up data by using theVMware vStorage API for Data Protection. You can use the restore VM commandto restore backups that were created by using VCB. Using the vStorage API, thebackup-archive client can create either full backups or file-level backups ofVMware virtual machines. The vStorage API provides the following benefits:vvLess storage is needed on the vStorage backup server because a temporarydirectory is not needed to contain the backup.Backups that are created by using the vStorage API do not require the VMwareconverter tool to restore the virtual machine.Chapter 4. Backing up your data 147

|||||||||||||||||||||||||||||The file-level backup method uses the progressive incremental technique. Yourestore the files by using the normal file-level restore function that is provided bythe backup-archive client. This backup approach is an alternative to backing up thefull VMware virtual machine. Typically, backing up the full virtual machine is thepreferred approach. Before you create file-level backups for a VMware virtualmachine on Windows systems, first evaluate the benefits of backing up the fullVMware virtual machine. Table 25 compares the different approaches for backingup VMware virtual machines on Windows systems.Table 25. Comparison of full backups and file-level backups for VMware virtual machines on Windows systemsCapability Full backups File-level backupsVMware vStorage API for Data YesYesProtection functions:Create backups for virtual machinesthat are running on an operatingsystem other than MicrosoftWindows:YesNoCreate incremental backups of the YesYesvirtual machine:Restore a complete virtual machine: Yes NoRestore individual files from the YesYesbackup:Use the same backup format asprogressive incremental backup, andallow for file and folder restore byusing the backup-archive client:NoYesDefine file-level include and excluderules:NoRelated concepts:“Parallel backups of VMware virtual machines” on page 155Related tasks:“Preparing the environment for full backups of VMware virtual machines”“Creating full backups for VMware virtual machines” on page 150“Preparing the environment for file-level backups of VMware virtual machines” onpage 152“Creating file-level backups for VMware virtual machines” on page 154YesPreparing the environment for full backups of VMware virtualmachinesComplete the following steps to prepare the VMware environment for backing upfull VMware virtual machines. The vStorage backup server can run either aWindows or Linux client.1. To configure the storage environment for backing up, complete the followingsteps:a. Configure your storage environment so that the vStorage backup server canaccess the storage volumes that are in your ESX server farm.b. If you are using network-attached storage (NAS) or direct-attach storage,ensure that the vStorage backup server is accessing the volumes with anetwork-based transport.c. Optional: For data access, make the following settings:148 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vCreate storage area network (SAN) zones that your vStorage backupserver can use to access the storage logical units (LUNs) that host yourVMware data stores.v Configure your disk subsystem host mappings so that all ESX serversand the backup proxy can access the same disk volumes.2. To configure the vStorage backup server, complete the following steps:a. When the backup-archive client runs on a vStorage backup server, thisclient configuration is called the Tivoli Storage Manager data mover node. Adata mover node typically uses the SAN to back up and restore data. If youconfigure the data mover node to directly access the storage volumes, turnoff automatic drive letter assignment. If you do not turn off letterassignments, the client on the data mover node might corrupt the Raw DataMapping (RDM) of the virtual disks. If the RDM of the virtual disks iscorrupted, backups fail. Consider the following conditions for restoreconfigurations:The data mover node is on a Windows Server 2008 or Windows Server2008 R2 system:If you plan to use the SAN to restore data, you must set theWindows SAN policy to OnlineAll. Run diskpart.exe and type thefollowing commands to turn off automatic drive letter assignmentand set the SAN policy to OnlineAll:diskpartautomount disableautomount scrubsan policy OnlineAllexitThe backup-archive client is installed in a virtual machine on a WindowsServer 2008 or Windows Server 2008 R2 system:If you plan to use the hotadd transport to restore data fromdynamically added disks, the SAN policy on that system must alsobe set to OnlineAll.|||||Whether the client uses the SAN or hotadd transport, the WindowsSAN policy must be set to OnlineAll. If the SAN policy is not set toOnlineAll, restore operations fail, and the following message isreturned:ANS9365E VMware vStoragee API error.TSM function name: vddksdk WriteTSM file : vmvddkdsk.cpp (2271)API return code : 1API error message : Unknown errorANS0361I DIAG: ANS1111I VmRestoreExtent(): VixDiskLib_WriteFAILURE startSector=512 sectorSize=512 byteOffset=262144,rc=-1For a description of the vStorage transport settings and how you canoverride the defaults, see the following topic:“Vmvstortransport” on page 531b. Install the Tivoli Storage Manager client on the vStorage backup server. Atthe custom setup page of the installation wizard, select VMware vStorageAPI runtime files.Important: If you are moving the backup data by using backups that arenot in a LAN, the SAN must have separate connections for tape and disk.3. To modify Tivoli Storage Manager, complete the following steps:a. Access the administrative command line of Tivoli Storage Manager client.Chapter 4. Backing up your data 149

. From the Tivoli Storage Manager client of the vStorage backup server, runthe following command to register the node:register node my_server_name my_passwordWhere my_server_name is the full computer name of the vStorage backupserver and my_password is the password to access the server.Tip: On Windows systems, you can get the server full computer name byright-clicking on My Computer. Click the Computer Name tab and look atthe name listed next to Full computer name.c. From the Tivoli Storage Manager client of the vStorage backup server, runthe following command to register the node:register node my_vm_name my_passwordWhere my_vm_name is the full name of the virtual machine that you arebacking up.4. If you back up a virtual machine where volumes are mounted to directoriesrather than drive letters, files might not be stored in the correct location. Anerror might be caused because the mount point does not correspond to theactual mount points of backed up files. An error is caused because the mountpoints for a virtual machine that is running Windows do not have a drive letterassignment. When you use the VMware vStorage APIs for Data Protection, afilespace name is created that includes a number assignment. The filespacenames that are created for the mount point do not correspond to the actualmount points of the backed up file.To back up or restore files to their original location, use the following steps:a. To restore files to their original location, map the drive or assign a driveletter to the mount point from the virtual machine.b. If you restore a file that the vStorage API renamed, select a different restorelocation.c. When using mount points without drive letter assignments, use an includeor exclude statement for that volume. See the following example of anexclude statement:exclude \\machine\3$\dir1\...\*.docRelated tasks:“Creating full backups for VMware virtual machines”Related reference:“Backup VM” on page 562“Query VM” on page 617“Restore VM” on page 647“Vmchost” on page 520“Vmcpw” on page 521“Vmcuser” on page 522“Vmlist” on page 526“Vmvstortransport” on page 531Creating full backups for VMware virtual machinesA full backup of a VMware virtual machine is a backup of an entire virtualmachine, including the virtual disks and the virtual machine configuration file.This type of backup is similar to a Tivoli Storage Manager image backup. To create150 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|the full backup, you configure the backup-archive client on the vStorage backupserver. The vStorage backup server must run a Windows client or a Linux client.1. To prepare the environment, complete the steps in the following topic:“Preparing the environment for full backups of VMware virtual machines” onpage 1482. To configure the backup-archive client on the vStorage backup server, completethe following steps:a. From the welcome page of the Tivoli Storage Manager client, click Edit >Client Preferences.b. Select the VM Backup tab.c. Select VMWare Full VM.d. In the Domain Backup Types list, select Domain Full VM.e. In the Host field, enter either the host name of each ESX server or the hostname of the Virtual Center. If you specify the Virtual Center, you can backup virtual machines from any of the VMware servers that are managed bythe Virtual Center.f. Enter the user ID and password information for the host that you specify inthe Host field.g. Optional: If you want to override the default management class for fullvirtual machine backups, specify the management class that you want touse.h. In the Datastore Location field, enter the path to the directory where thefiles are stored.i. Click OK to save your changes.3. To create a backup of one of the virtual machines, complete the following steps:a. At the command line of the vStorage backup server, run the followingcommand:dsmc backup vm my_vm_name -mode=full -vmbackuptype=fullvmWhere my_vm_name is the name of the virtual machine.b. Verify that the command is completed without errors. The followingmessage indicates successful completion:Backup VM command completeTotal number of virtual machines backed up successfully: 1virtual machine vmname backed up to nodename NODETotal number of virtual machines failed: 0Total number of virtual machines processed: 14. To verify that you can restore the files for the virtual machine, complete thefollowing steps:a. At the command-line interface of the vStorage backup server, run thefollowing command:dsmc restore vm my_vm_nameThe default location of the restore is in the following directory:c:\mnt\tsmvmbackup\my_vm_name\fullvm\RESTORE_DATE_yyyy_mm_dd[hh_mm_ss].b. If errors occur in the restore processing, view the Tivoli Storage Managererror log for more information.Tip: The error log is saved to the following file:c:\Program Files\Tivoli\TSM\baclient\dsmerror.logChapter 4. Backing up your data 151

|||||||||||||||||||||||||||||||Related concepts:“Parallel backups of VMware virtual machines” on page 155Related tasks:“Preparing the environment for full backups of VMware virtual machines” on page148Related reference:“Backup VM” on page 562“Domain.vmfull” on page 348“Query VM” on page 617“Restore VM” on page 647“Mode” on page 420“Vmchost” on page 520“Vmcpw” on page 521“Vmcuser” on page 522“Vmlist” on page 526“Vmmc” on page 518“Vmvstortransport” on page 531Preparing the environment for file-level backups of VMwarevirtual machinesYou can create file-level backups for VMware virtual machines that are runningMicrosoft Windows. Complete these steps to prepare the environment for file-levelbackups of virtual machines.1. Configure the vStorage backup server, by completing the following steps:a. Install the backup-archive client with the custom installation option,including the VMware vStorage API runtime files component.b. Open the "Preferences Editor VM Backup" page and configure the followingoptions in the dsm.opt file:OptionVMBACKUPTYPE FILEVMCHOSTVMCPWVMCUSERDOMAIN.VMFILEDescriptionSpecifies that a file-level backup is createdSpecifies either the host name of each ESX server or the hostname of the VMware Virtual Center. If you specify the VMwareVirtual Center, you can create backups from any of the VMwareservers that are managed by the VMware Virtual Center.Specifies the password for the VMware Virtual Center or theESX user ID that is specified with the vmcuser option.Specifies the user ID for the VMware Virtual Center or ESXuser.Specifies the virtual machines to process for file-level backups.c. Optional: Define include and exclude options to control the files that areincluded in the backup.d. Optional: For data access, make the following settings:vvCreate storage area network (SAN) zones that your vStorage backupserver can use to access the storage logical units (LUNs) that host yourVMware data stores.Configure your disk subsystem host mappings so that all ESX serversand the data mover node can access the same disk volumes.152 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||||||||2. Prepare your VMware environment, by completing the following steps:a. Ensure that the VMware Virtual Center and your vStorage backup serverresolve host names to the same internet protocol (IP) addresses.b. Optional: Install a Tivoli Storage Manager client within each virtual machinethat you plan to use for file level restores. You do not need any specialsetup or options for the virtual machine that is installed by Tivoli StorageManager.3. Configure the Tivoli Storage Manager server for file-level VMware backups, bycompleting the following steps:a. Register a single node for the vStorage backup server. For example:register node DATAMOVER1 password.b. Register a node on the Tivoli Storage Manager server for each virtualmachine that is backed up. For best results, use the default Tivoli StorageManager node name for the virtual machine. To find the node name, runthe hostname command from the virtual machine. For example:DSMADMC>register node DATAMOVER1 passwordDSMADMC>register node VM1 passwordDSMADMC>register node VM2 password...DSMADMC>register node VMn passwordc. Grant proxy access for each of the virtual machines you are backing up, byentering the following command:grant proxy agent=my_server_name target=my_guest_nameFor example:grant proxy agent=DATAMOVER1 target=VM1grant proxy agent=DATAMOVER1 target=VM2...grant proxy agent=DATAMOVER1 target=VMn4. Configure include and exclude rules in the options file on the vStorage backupserver to control the files that are included in the backup. The exclude list onthe backup proxy can be set for all virtual machines or for a specific virtualmachine. If incremental backups are created from within the virtual machine,the exclude list on the virtual machine must match the exclude list on thebackup proxy. In most cases, the incremental backups run from the backupproxy.The following examples demonstrate how to create exclude statements.vvvTo exclude files in the temp directory from the backup proxy for the singlevirtual machine vm1:exclude "\\vm1\c$\temp\...\*"To exclude a file from backup proxy for all virtual machines:exclude "\\*\X$\Directory\File"When you use mount points without drive letter assignments, specify aninclude or exclude statement for that volume, for example:exclude \\machine\3$\dir1\...\*.docChapter 4. Backing up your data 153

||||||||||||||||||||||||||||||||||||||||||||||Related tasks:“Creating file-level backups for VMware virtual machines”Related reference:“Domain.vmfile” on page 345“Query VM” on page 617“Vmbackuptype” on page 517“Vmchost” on page 520“Vmcpw” on page 521“Vmcuser” on page 522“Vmlist” on page 526“Vmvstortransport” on page 531Creating file-level backups for VMware virtual machinesFor VMware virtual machines that are running Microsoft Windows, you can usethe backup-archive client to create file-level backups. You use include and excluderules to determine the files that are included in the file-level backup.The file-level backup of a virtual machine is implemented in the followingsequence:v A VMware snapshot is taken of the virtual machine to be backed up.vvvThe file systems of the virtual machine are remotely mapped to the vStoragebackup server.A file-level progressive incremental backup is run for all of the file systems.The data is stored under the node name that matches the host name of thevirtual machine. The data for each virtual machine is stored in the node that isassociated with the virtual machine.v The file system mappings are removed and the snapshot is removed.Complete the following steps to create a file-level backup for a virtual machinethat is running Windows.1. To configure the backup environment, complete the steps in the following topic:“Preparing the environment for file-level backups of VMware virtual machines”on page 1522. To start the file-level backup, open the command line of the vStorage backupserver and run the backup vm command with the vmbackuptype option set tofile. You can identify the virtual machine for backing up in several ways, forexample:v To back up a list of virtual machines, run the backup command with thevmlist option:vdsmc backup vm -vmlist=vm1,vm2 -vmbackuptype=fileTo create file-level backups for all of the virtual machines defined in theDOMAIN.vmfile option, run the following command:dsmc backup vm -vmbackuptype=filev To identify virtual machines by their internet protocol (IP) address, you mustprovide the Tivoli Storage Manager node name for each virtual machine. Usethe following syntax in the command:dsmc backup vm 9.100.45.101[vm1], 9.100.45.102[vm2] -vmbackuptype=file3. Verify that you can restore the file-level backup for one of the virtual machines,by completing the following steps:154 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||||||a. From the command line of the vStorage backup server, run the followingcommand:dsmc restore \\my_vm_name\c$\my_docs\ c:\restore_temp\ -sub=yes-virtualnode=my_vm_nameb. Verify that the files are restored for the virtual machine. By default, the filesare restored in the following location:c:\mnt\tsmvmbackup\my_vm_name\fullvm\RESTORE_DATE_yyyy_mm_dd[hh_mm_ss]c. If the restore fails, view the Tivoli Storage Manager error log for moreinformation. The log file is saved to the following location:c:\Program Files\Tivoli\TSM\baclient\dsmerror.logd. For more information about restoring files from file-level backups, see thefollowing topic:“Scenario: Restoring file-level VM backups” on page 194Related concepts:“Parallel backups of VMware virtual machines”Related tasks:“Preparing the environment for file-level backups of VMware virtual machines” onpage 152Related reference:“Domain.vmfile” on page 345“Query VM” on page 617“Vmbackuptype” on page 517“Vmchost” on page 520“Vmcpw” on page 521“Vmcuser” on page 522“Vmlist” on page 526“Vmvstortransport” on page 531Parallel backups of VMware virtual machinesA single Tivoli Storage Manager data mover node can be used to concurrently backup multiple virtual machines.When the back ups are initiated, the client establishes parallel sessions to copy thedata to the Tivoli Storage Manager server.Client options are provided so you can optimize the backups so they do notadversely affect the ESX servers that are hosting the virtual machines. The optionsare described in detail in Client options reference. A short summary is provided hereto illustrate their use.vvThe vmmaxparallel option limits how many virtual machines can be backed upat any one time.The vmlimitperhost option limits how many virtual machines can be backed up,at any one time, per ESX server.v The vmlimitperdatastore option limits how many virtual machines can bebacked up, at any one time, per datastore.vmmaxparallelThe vmmaxparallel option specifies how many virtual machines can bebacked up at any one time. The optimal value for vmmaxparallel is notobvious; it depends on the processing power of the vStorage server thatthe Tivoli Storage Manager data mover node runs on, and the performanceChapter 4. Backing up your data 155

|||||||||||||||||||||||||||||||||||||||of I/O between the client and the Tivoli Storage Manager server. Forexample, if you are moving data to the server over a busy LAN, you mightneed to limit the number of virtual machines in each parallel backupsession. Similarly, if the vStorage server processing capabilities are limited,for any reason, this is also a reason to restrict the value for vmmaxparallel.The default for this option is 1. Using the default value mimics the samebehavior of older clients, where only one virtual machine is backed upduring a session.vmlimitperhostThe vmlimitperhost option specifies how many virtual machines can bebacked up from a single ESX/ESXi host, at the same time. Like the valuefor vmmaxparallel, you might have to experiment with this setting to findthe optimum value. On ESX/ESXi servers that are heavily used, you mightneed to restrict the value for vmmlimitperhost so you do not adverselyaffect the vSphere server performance. On servers that are not as heavilyused, you can include more virtual machines.vmlimitperdatastoreThe vmlimitperdatastore option limits the maximum number of virtualmachines that can be backed up, at any one time, from a datastore. In amultiple datastore VMware environment, you can use this option to reducethe burden that is placed on any one datastore during a parallel backupoperation.These options work in concert with each other. Examples are provided to illustratehow these options determine how many virtual machines are backed up from anyhost or datastore.Parallel backup examplesIn the following figures, the circled virtual machines are the virtual machines thatare selected for backup processing, which is based on the option settings indomain.vmfull.Example 1: Each VM is stored in a single datastoreFigure 1 shows that each of the circled virtual machines has its data saved in aunique datastore. Assume that the parallel backup options are set to the followingvalues:v vmmaxparallel 3v vmlimitperhost 1v vmlimitperdatastore 1Figure 1. Virtual machines using unique datastores.156 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|VMware vSphereinfrastructureESX Host-AVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManagerbackup-archiveclientdatastore1datastore2datastore3Each linerepresents aVM beingbacked upESX Host-BVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManager server|||||||||||||||||In Host A, only virtual machines 1 and 5 match the selection criteria on adomain.vmfull statement. In Host B, only virtual machine 2 matches the selectioncriteria. In this configuration, each virtual machine has a separate datastore, so thevmlimitperdatastore setting is valid. But, since vmlimitperhost is set to one, onlyone virtual machine (vm1 or vm5) from Host A and one virtual machine (vm2)from Host B are included when the Backup VM operation is run; only two virtualmachines are included in this backup session.Example 2: Same as example 1, but with a different setting forvmlimitperhostFigure 2 on page 158 shows that each of the circled virtual machines has its datasaved in a unique datastore. In this configuration, the vmlimitperhost is increasedto two to illustrate how the option increase changes the Backup VM operation.Assume that the parallel backup options are now set to the following values:v vmmaxparallel 3v vmlimitperhost 2 (an increase of 1)v vmlimitperdatastore 1Chapter 4. Backing up your data 157

|||||Figure 2. Virtual machines using unique datastores, with different option value forvmlimitperhost.VMware vSphereinfrastructureESX Host-AVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManagerbackup-archiveclientdata store 1 data store 2data store 3Each linerepresents aVM beingbacked upESX Host-BVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManager server||||||||||||The same virtual machines match the domain.vmfull criteria as they did in theprevious example. However, with the increase in the vmlimitperhost setting, now atotal of three virtual machines are included in a Backup VM operation (vm1 andvm5 from Host A, and vm2 from Host B).Example 3: Some VMs share datastoresFigure 3 on page 159 shows that the VMDK and configuration files for virtualmachine 5 in Host A is stored in two datastores. To include both vm1 and vm5 inHost A in the parallel backup operation, the value of vmlimitperdatastore must beincreased to at least two. If vmlimitperdatastore is not increased to two, or higher,the backup of the second virtual machine (vm5), in Host A, cannot be started untilthe first virtual machine (vm1) backup is completed because the two VMs share158 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||data in datastore1.Figure 3. Virtual machines sharing a datastore.VMware vSphereinfrastructureESX Host-AVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManagerbackup-archiveclientdata store 1 data store 2data store 3Each linerepresents aVM beingbacked upESX Host-BVM1 VM2 VM3VM4 VM5 VM6Tivoli StorageManager server|Backing up virtual machines on a Windows Hyper-V systemOn Windows systems, you can use a Microsoft Hyper-V server to host virtualmachines.You can use the Tivoli Storage Manager backup-archive client for these tasks onHyper-V systems:vvBack up and restore snapshots of Hyper-V virtual machines using the MicrosoftVolume Shadow Copy Services (VSS) interface. You can restore a virtual machineusing the files created by VSS.Restore either individual virtual machines or a group of virtual machinesrunning on a Hyper-V server for disaster recovery purposes.Chapter 4. Backing up your data 159

vBack up data without stopping the virtual machine or stopping any runningapplications within the virtual machine.vRestriction: You can only back up data this way if the operating system of thevirtual machine supports VSS. For further details about this restriction, refer to:http://technet.microsoft.com/en-us/library/dd252619(WS.10).aspxAdd backup and restore support for guest operating systems without installing aTivoli Storage Manager client on the guest VM.For both disaster recovery and long-term data backup support, perform thesesteps:1. Install the Tivoli Storage Manager client on the Hyper-V host Windows 2008operating system (for example, the parent partition).2. On the Tivoli Storage Manager Server, define a single node for the backup ofthe Hyper-V machine.3. Back up a running virtual machine:vvFrom the Tivoli Storage Manager GUI Backup panel, expand the “Hyper-VVMs” container, and select the virtual machine to back up.You can also enter dsmc backup vm -vmlist=vm1 -vmbackuptype=HyperVFullon the Tivoli Storage Manager command prompt, where vm1 is the name ofthe virtual machine.Important:a. If the virtual machine is not fully VSS-compliant (the operating systemsupports VSS, and all virtual hard drives (VHD) are configured to supportVSS):v The virtual machine that is running pausesv A snapshot is takenv The virtual machine resumesb. If Microsoft clustering is enabled, you might need to set theclusterdisksonly option to NO to back up Hyper-V VMs. This action isnecessary if any VM files or supporting VM files reside on disks that arenot clustered.4. Restore a virtual machine:v From the Tivoli Storage Manager GUI Restore panel, expand the Hyper-VVMs container, and select the virtual machine to restore.v You can also enter: dsmc restore vm1 -vmlist=vm1 -vmbackuptype=HyperVFull on the Tivoli Storage Manager command line,where vm1 is the name of the virtual machine.Important: When a restore operation is complete, the existing virtual machineis stopped (if it is running) and all existing files (for example, VHD) aredeleted. When the backup snapshot is restored, all the virtual machines thatexisted when the files were backed up are recreated. This includes any Hyper-Vsnapshots that existed when the files were backed up.You can set up Tivoli Storage Manager scheduled backups on a regular basis (forexample, once a week). Create the schedules as MACRO type schedules with themacro file located in the Tivoli Storage Manager Backup-Archive Client directoryof the Hyper-V machine. The contents have the dsmc command, for example: dsmcbackup vm -vmbackuptype=HyperVFull.160 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Backup VM” on page 562“Query VM” on page 617“Restore VM” on page 647“Clusterdisksonly” on page 312Hyper-V backup support limitationsDue to the tight integration of Microsoft Failover Clustering with Cluster SharedVolumes and Hyper-V, the following limitations apply when using Tivoli StorageManager.Microsoft Hyper-V support is provided for the following configurations:v A dedicated Hyper-V systemv A Hyper-V configuration that is part of Microsoft Failover Clusteringv A Hyper-V configuration that is part of Microsoft Failover Clustering withCluster Shared VolumesVM backups can only be performed by a backup-archive client installed on thecluster node that is the current owner of the VM. To see which VMs are owned bythe node, navigate the Windows menu items: ServerManager->Roles->Hyper-VManager.A VM should be restored only by a backup-archive client installed on the clusternode that is the current owner of the VM. To determine the VM configurations ofthe cluster, navigate the Windows menu items: ServerManager > Features >Failover Cluster Manager > cluster name > Services and Applications.. Use theServices and Applications window to change which node is the owner of the VMbefore you restore the VM.VMs currently owned by different nodes which have files on a common ClusterShared Volume cannot be backed up simultaneously when using the defaultsystem VSS provider. The second backup will fail as the shared volume will beowned by the first node. You can significantly reduce the amount of time that thefirst node owns the shared volume by using hardware snapshots through the VSSprovider supplied by your storage hardware vendor. Once the hardware snapshotis completed, the backup process can be initiated from the second node, thereforethe backups can be running concurrently from both nodes. To determine whichnode owns the volume, navigate the Windows menu items: ServerManager >Features > Failover Cluster Manager > cluster name > Cluster Shared Volumes.The Cluster Shared Volume windows displays the status of the volume, includingownership, and if a backup is in progress (with redirected I/O enabled).If your cluster environment typically has all VMs owned by a single node, andother nodes only provide failover support, the following applies:vvConsider using CLUSTERNODE YES for backup from the active node and restore tofailover nodes (if needed).Consider running the Tivoli Storage Manager scheduler as a failover service toperiodically backup all VMs. For example: dsmc backup vm *-vmbackuptype=hypervfull. A failover will start the scheduler on the failovernode.If your cluster environment typically has some VMs owned by one node, and otherVMs owned by other nodes, the following applies:Chapter 4. Backing up your data 161

vvConsider using the “Asnodename” on page 296 option to allow for backup frommultiple nodes and restore to failover nodes (if needed).Consider running the Tivoli Storage Manager scheduler as active on each nodeto periodically backup the VMs owned by each node. The schedules need to bedefined with non-overlapping start times to avoid contention for commonshared volumes. If the scheduler on each node backs up with -vmlist=*, there isno need for the scheduler service to failover since the scheduler service on theother node will automatically pick up nodes which move over on the nextbackup.Back up and archive Tivoli Storage Manager FastBack dataUse IBM Tivoli Storage Manager FastBack to back up and archive the latestsnapshots for short-term retention.Use the archive fastback and backup fastback commands to archive and back upvolumes that are specified by the fbpolicyname, fbclientname and fbvolumenameoptions for short-term retention.Related concepts:“Installation requirements for backing up and archiving Tivoli Storage ManagerFastBack client data” on page 9“Configuring the client to back up and archive Tivoli Storage Manager FastBackdata” on page 55Related reference:“Fbclientname” on page 373“Fbpolicyname” on page 374“Fbvolumename” on page 378Net Appliance CIFS share definition backupsNetwork Appliance (NetApp) CIFS share definitions include share permissions seton the file server.The Windows client backs up the CIFS share definition under the root directory,the mapped CIFS share, or the UNC name. This support requires that the NetAppliance file server is running DATA ONTAP software which presents CIFSshares to remote clients as ordinary remote NTFS shares.The root directory of a CIFS share is backed up with a full progressive incrementalbackup of the mapped drive/UNC name. See the following two examples:net use x: \\NetAppFiler\CifsShareNamedsmc incr x:dsmc incr \\NetAppFiler\CifsShareNameThe following output is displayed when the root directory (and share definition) isbacked up:Directory-->0 \\NetAppFiler\CifsShare\ [Sent]162 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Restore Net Appliance CIFS shares” on page 191Related reference:“Snapdiff” on page 473Display backup processing statusDuring a backup, by default Tivoli Storage Manager displays the status of each fileit attempts to back up.Tivoli Storage Manager reports the size, path, file name, total number of bytestransferred, and whether the backup attempt was successful for the file. These arealso recorded in the dsmsched.log file for scheduled commands.The Web client and backup-archive client GUI provide a Task List window thatdisplays information about files during processing. When a task completes, aBackup Report window displays processing details. Click the Help button in theBackup Report window for context help.On the backup-archive command line the name of each file is displayed after it issent to the server. The progress indicator shows overall progress.Table 26 lists some informational messages and meanings.Table 26. Client command line informational messagesInformational messageDirectory-->Updating-->Expiring-->Subfile-->Total number of objects inspected:MeaningIndicates the directory that you back up.Indicates that only the file meta data is sent, not the data itself.Indicates an object (file or directory) on the server that no longer existson the client is expired and made inactive on the server.Indicates that a file is processed using adaptive subfile backup. The filesize indicated in this message is the size of the entire file, not the amountof data actually sent.As indicated. When using journal-based backup (AIX and Windowsonly), the number of objects inspected might be less than the number ofobjects backed up.When using snapshot difference incremental backup, the number ofobjects inspected is zero. The number is zero because the client performsan incremental backup of the files that NetApp reported as changed. Theclient does not scan the volume looking for files that have changed.Total number of objects backed up:Total number of objects updated:Total number of objects rebound:Total number of objects deleted:Total number of objects expired:Total number of objects failed:As indicated.These are files whose attributes, such as file owner or file permissions,have changed.See “Bind management classes to files” on page 247 for moreinformation.This is a count of the objects deleted from the client workstation afterbeing successfully archived on the server. The count is zero for allbackup commands.See the section about full and partial incremental backup for moreinformation.Objects can fail for several reasons. Check the dsmerror.log for details.Chapter 4. Backing up your data 163

||||Table 26. Client command line informational messages (continued)Informational messageMeaningTotal snapshot difference objects: For snapshot difference incremental backups, this represents the totalnumber of objects backed up and the total number of objects expired.Total objects deduplicated:Specifies the number of files that are deduplicated.Total bytes before deduplication: Specifies the number of bytes to send to the Tivoli Storage Managerserver if the client does not eliminate redundant data. Compare thisamount with Total bytes after deduplication. Includes metadata sizeand might be greater than bytes inspected.Total bytes after deduplication: Specifies the number of bytes that are sent to the Tivoli Storage Managerserver, after deduplication of the files on the client computer. Includesmetadata size and might be greater than bytes processed.Total number of bytes inspected: Specifies the sum of the sizes of the files that are selected for theoperation. For example, the total number of bytes inspected for thiscommand is the number of bytes used in the directory C:\Usersdsmc.exe INCREMENTAL C:\Users\* -su=yesTotal number of bytes processed: Specifies the sum of the sizes of the files that are processed for theoperation.Total number of subfile objects: The number of files processed using adaptive subfile backup.Data transfer time:The total time to transfer data across the network. Transfer statisticsmight not match the file statistics if the operation was retried due to acommunications failure or session loss. The transfer statistics display thebytes attempted to be transferred across all command attempts.Network data transfer rate:The average rate at which the network transfers data between the clientand the server. This is calculated by dividing the total number of bytestransferred by the time to transfer the data over the network. The time ittakes to process objects is not included in the network transfer rate.Therefore, the network transfer rate is higher than the aggregate transferrate.Aggregate data transfer rate:The average rate at which Tivoli Storage Manager and the networktransfer data between the client and the server. This is calculated bydividing the total number of bytes transferred by the time that elapsesfrom the beginning to the end of the process. Both Tivoli StorageManager processing and network time are included in the aggregatetransfer rate. Therefore, the aggregate transfer rate is lower than thenetwork transfer rate.Objects compressed by:Note: On occasion, the aggregate data transfer rate might be higher thanthe network data transfer rate. This is because the backup-archive clientcan have multiple simultaneous sessions with the backup server. If youset the resourceutilization option, Tivoli Storage Manager attempts toimprove performance and load balancing by using multiple sessionswhen it backs up a volume or other set of files. When multiple sessionsare open during backup, the data transfer time represents the sum of thetimes reported by all sessions. In this case, aggregate data transfer time isincorrectly reported as higher. However, when running with a singlesession, the aggregate data transfer rate should always be reported aslower than the network data transfer rate.Specifies the percentage of data sent over the network divided by theoriginal size of the file on disk. For example, if the net data-bytes are 10Kand the file is 100K, then Objects compressed by: == (1 - (10240/102400))x 100 == 90%.164 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 26. Client command line informational messages (continued)Informational messageDeduplication reduction:Total data reduction ratio:Subfile objects reduced by:Elapsed processing time:Total number of bytes transferred:LanFree bytes transferred:Total number of bytes inspected:Total objects deduplicated:MeaningSpecifies the size of the duplicate extents that were found, divided by theinitial file or data size. For example, if the initial object size is 100 MB,after deduplication it is 25 MB. The reduction would be: (1 - 25/100) *100 = 75%.Adds incremental and compression effects. For example, if the bytesinspected are 100 MB and the bytes sent are 10 MB, the reduction wouldbe: (1 - 10/100) * 100 = 90%Expresses the savings achieved by adaptive subfile backup as apercentage of actual bytes sent versus actual file sizes. For example, ifthe actual sizes of the files backed us is 100 MB, but with adaptivesubfile backup, only 25 MB were sent, then the reduction would be: (1 -(25 MB/100 MB)) x 100 == 75%.Note: The calculation considers all files that were processed, not onlythose files that were processed by adaptive subfile backup. Thecalculation does not include the effect of compression.The active processing time to complete a command. This is calculated bysubtracting the starting time of a command process from the ending timeof the completed command process.As indicated.The total number of data bytes transferred during a lan-free operation. Ifthe enablelanfree option is set to no, this line will not appear.A sum of sizes of files selected for the operation.The number of files that have been deduplicated.Backup (Windows): Additional considerationsThis section discusses additional information to consider when backing up data.Open filesSome files on your system might be in use when you try to back them up. Theseare called open files because they are locked by an application for its exclusive use.It is not very common for files to be opened in locked mode. An application canopen a file in this way to avoid other applications or users from reading oraccessing the file, but it can prevent backup programs from reading the file forbackup.You might not always want to use the open file feature to back up open or lockedfiles. Sometimes an application opens a file or group of files in this locked mode toprevent the access of these files in an inconsistent state.To avoid the increase of processor usage when you create a volume snapshot foreach backup, and on platforms where the open file feature is not available or is notin use, consider the following points:vvIf the file is unimportant or can be easily rebuilt (a temporary file for example),you might not care if the file is backed up, and might choose to exclude it.If the file is important:– Ensure the file is closed before backing it up. If backups are run according toa schedule, use the preschedulecmd option to enter a command that closes thefile. For example, if the open file is a database, issue a command to close theChapter 4. Backing up your data 165

database. You can use the postschedulecmd option to restart the applicationthat uses the file after the backup completes. If you are not using a schedulefor the backup, close the application that uses the file before you start thebackup.– Tivoli Storage Manager can back up the file even if it is open and changesduring the backup. This is only useful if the file is usable even if it changesduring backup. To back up these files, assign a management class withdynamic or shared dynamic serialization.Note: If open file support is not configured: While Tivoli Storage Managerattempts to back up open files, this is not always possible. Some files are openexclusively for the application that opened them. If Tivoli Storage Managerencounters such a file, it cannot read it for backup purposes. If you are aware ofsuch file types in your environment, you should exclude them from backup toavoid seeing error messages in the log file.Related concepts:“Display information about management classes and copy groups” on page 241“Select a management class for files” on page 245Ambiguous file space names in file specificationsIf you have two or more file spaces such that one file space name is the same asthe beginning of another file space name, then an ambiguity exists when you try torestore, retrieve, query, or do another operation that requires the file space name aspart of the file specification.For example, consider the following file spaces and the backup copies they contain:File space name\\storman\home\\storman\home\amrFile nameamr\project1.docproject2.docNotice that the name of the first file space, \\storman\home, matches the beginningof the name of the second file space, \\storman\home\amr. When you use the TivoliStorage Manager command-line client interface to restore or query a file fromeither of these file spaces, by default the client matches the longest file space namein the file specification, \\storman\home\amr. To work with files in the file spacewith the shorter name, \\storman\home, use braces around the file space nameportion of the file specification.This means that the following query command finds project2.doc but does notfind project1.doc:dsmc query backup "\\storman\home\amr\*"This is because the longer of the two file space names is \\storman\home\amr andthat file space contains the backup for project2.doc.To find project1.doc, enclose the file space name in braces. The followingcommand finds project1.doc but does not find project2.doc:dsmc query backup "{\\storman\home}\amr\*"166 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Similarly, the following command restores project1.doc but does not restoreproject2.doc:dsmc restore {\\storman\home}\amr\project1.docManagement classesTivoli Storage Manager uses management classes to determine how to manageyour backups on the server.Every time you back up a file, the file is assigned a management class. Themanagement class used is either a default selected for you, or one that you assignto the file using an include option in the include-exclude options list. The selectedmanagement class must contain a backup copy group for the file to be backed up.Select Utilities → View Policy Information from the backup-archive client or Webclient GUI to view the backup policies defined by the Tivoli Storage Managerserver for your client node.Related concepts:Chapter 9, “Storage management policies,” on page 239Related tasks:“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Deleted file systemsWhen a file system or drive has been deleted, or it is no longer backed up byTivoli Storage Manager, the existing backup versions for each file are managedaccording to the following policy attributes: Number of days to keep inactivebackup versions, and number of days to keep the last backup version (if there isno active version).If you do nothing else, active backup versions remain indefinitely. If you do notneed to keep the active versions indefinitely, use the expire command to inactivethe active versions.You can also use the delete backup command to delete individual backupversions, or the delete filespace command to delete the entire file space. YourTivoli Storage Manager server administrator must give you "delete backup"authority to use these commands. If the file space also contains archive versions,you must also have delete archive authority to use delete filespace.Use the query session command to determine whether you have delete backupand delete archive authority. Alternatively, you can ask your Tivoli StorageManager server administrator to delete the file space for you.When you delete a file system, it has no effect on existing archive versions.However, if you no longer require the archive versions, you can use the deletearchive or delete filespace commands to delete archives.Related concepts:Chapter 9, “Storage management policies,” on page 239Removable media backupTivoli Storage Manager backs up your removable media (such as tapes, cartridgesor diskettes) based on the drive label, not the drive letter.Chapter 4. Backing up your data 167

If a drive has no label, the backup does not occur. This use of drive labels permitsyou to perform such tasks as backing up different diskettes from the a: drive.For a restore or retrieve, Tivoli Storage Manager maintains a separate file space foreach drive label. These labels become the file space names on the server. If youchange the label of a drive you already backed up, Tivoli Storage Manager views itas a new drive and does not relate it to your previous drive.Because Tivoli Storage Manager uses the labels to manage backups and archives ofyour removable media, you occasionally need to use those labels to locate datawhen using commands. For example, if you try to restore a file on diskette orDVD–ROM using d:\projx\file.exe as a file name, Tivoli Storage Managersubstitutes the current label of your d: drive for the d:. Ifthed: drive label isd-disk, d:\projx\file.exe becomes {d–disk}\projx\file.exe, and the label isenclosed in braces.If the label of the d: drive does not match a file space name on the server, TivoliStorage Manager cannot locate your files using the current d: drive label.However, Tivoli Storage Manager can locate your files if you use the file spacename based on the original drive label. A mismatch between a label and a filespace name might occur if you label your drives again, or if you access TivoliStorage Manager from a different workstation than the one from which you backedup the files. If you have not relabeled the drive, and you are at the sameworkstation where the file was backed up, then you can use the drive letter as ashorthand version of the file space name (drive label).Fixed drivesTivoli Storage Manager can back up your fixed drives even if they do not have alabel, including drive aliases created with the DOS subst command. This applies toboth the drive alias and the underlying physical drive, because the alias name andthe physical drive label are the same.NTFS file spacesWhen you back up files on New Technology File System (NTFS) partitions, TivoliStorage Manager also backs up file security information and file descriptors.The following file descriptors are backed up:v Owner security information (SID)v Primary group SIDv Discretionary access-control listv System access-control listYou must specify an NTF file-space name that is mixed or lowercase, and enclosedin quotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks or double quotation marks are valid in loop mode. For example:{"NTFSDrive"} and {’NTFSDrive’} are both valid. In batch mode, only singlequotation marks are valid. The single quotation mark requirement is a restrictionof the operating system.Universal Naming Convention namesA Universal Naming Convention (UNC) name is a network resource name for ashare point on a workstation.168 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The resource name includes the workstation name assigned to the workstation anda name you assign to a drive or directory so that it can be shared. The name youassign is also called a share point name.Examples: UNC names in domain listsThis topic shows some examples of using UNC names to specify a domain list.You must specify the following information:v A drive letter for removable mediav Drive letters or UNC name for local fixed drivesv Drive letters or UNC names for remote mapped drivesv UNC names for remote unmapped drivesExample 1: To specify drive a: containing removable media, enterdomain a: \\local\c$Example 2: To specify fixed drive c:, enterdomain c: \\remote\share1 \\remote\c$Examples: Universal Naming Convention backupYou can back up shared files in a network through the use of a UNC name. Thistopic shows some examples of backing up UNC name files.A UNC name is a network resource name for a share point on a workstation. Theresource name includes the workstation name assigned to the workstation and aname you assign to a drive or directory so that it can be shared. The name youassign is also called a share point name.Using a UNC name permits you to back up specific shared directories to a separatefile space. This is useful if, for example, you or an administrator want to back up asmall portion of data that you would otherwise be unable to access. Drives are notbacked up to a separate file space.Every local drive is accessible using a UNC name except for drives containingremovable media (such as tapes, cartridges or diskettes). Access these drives byusing a predefined administrative share name consisting of the workstation nameand the local drive letter, followed by $. For example, to specify a UNC name onthe c: drive for workstation ocean, enter:\\ocean\c$The $ sign must be included with the drive letter.To enter a UNC name for workstation ocean and share point wave, enter:\\ocean\waveWhen accessing files, you do not need to enter the letter of the drive except fordrives containing removable media.See the following table for examples showing selective backup of files using UNCnames. In these examples, assume that:v The workstation running dsmc is major.vShare names betarc and testdir from workstation alpha1 are mapped to drivesr and t, respectively.Chapter 4. Backing up your data 169

Table 27. UNC examplesExampledsmc sel \\alpha1\c$\dsmc sel \\major\c$\dsmc sel a:\dsmc sel \\alpha1\betarc\dsmc sel \\alpha1\testdir\dsmc sel d:\dsmc sel c:\dsmc sel r:\Commentname of remote file space is \\alpha1\c$name of local, fixed file space is \\major\c$name of local, removable file space is volumelabel of a:name of remote file space is \\alpha1\betarcname of remote file space is\\alpha1\testdirname of local, fixed file space is \\major\d$file space name is \\major\c$file space name is \\alpha1\betarcYou can also specify UNC names for files in your include-exclude and domainlists.Related tasks:“Creating an include-exclude list” on page 76Related reference:“Domain” on page 340Microsoft Dfs file protection methodsThere are some methods that you can use to protect the data in your Microsoft Dfsenvironment.Here are the methods you should use to protect your Microsoft Dfs data:1. Back up the Dfs link metadata and the actual data at the share target of eachlink from the workstation hosting the Dfs root. This method simplifies back upand restore by consolidating all of the Tivoli Storage Manager activities on asingle workstation. This method has the disadvantage of requiring anadditional network transfer during backup to access the data stored at linktargets.2. Back up only the Dfs link metadata that is local to the workstation hosting theDfs root. Back up the data at the target of each link from the workstation(s)which the data is local too. This method increases back up and restoreperformance by eliminating the extra network transfer, but requires TivoliStorage Manager back up and restores to be coordinated among severalworkstations.Note:1. This feature applies to Windows Server 2003.2. See the product README file for current limitations of this feature.Files contained on a Dfs server component are accessed using a standard UNCname, for example:\\servername\dfsroot\where servername is the name of the host computer and dfsroot is the name of theDfs root.170 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If you set the dfsbackupmntpnt option to yes (the default), an incremental backup ofa Dfs root does not traverse the Dfs junctions. Only the junction metadata isbacked up. This is the setting you should use so that Tivoli Storage Manager canbe used to restore Dfs links.You can use the dfsbackupmntpnt option to specify whether Tivoli Storage Managersees a Dfs mount point as a Microsoft Dfs junction or as a directory.Important: Restore the Dfs junction metadata first. This recreates the links. Thenrestore each junction and the data at each junction separately. If you do not restorethe junction metadata first, Tivoli Storage Manager creates a directory under theDfs root using the same name as the junction point and restores the data in thatdirectory.The following example relates to method 1 above and illustrates how to use TivoliStorage Manager to back up and restore a Microsoft Dfs environment. Assume theexistence of a domain Dfs environment hosted by the workstation almaden:Dfs root\\almaden\snj64testDfs link1\\almaden\snj64test\toolsDfs link2\\almaden\snj64test\treesBackup procedure:1. Set the dfsbackupmntpnt option to yes in your client options file (dsm.opt).2. Enter the following command to back up link junction information:dsmc inc \\almaden\snj64test3. Enter the following command to back up data at the tools link:dsmc inc \\almaden\snj64test\tools4. Enter the following command to back up data at the trees link:dsmc inc \\almaden\snj64test\treesNote: DFS Replication uses staging folders to act as caches for new and changedfiles to be replicated from sending members to receiving members. If you do notwant to backup these files, you can exclude them from your backup using theexclude.dir option.exclude.dir x:\...\DfsrprivateRestore procedure:1. Manually recreate shares at target workstations only if they no longer exist.2. Manually recreate the Dfs root using the exact name as it existed at the time ofback up.3. Enter the following command to recover data from the tools link. This step isnot necessary if the data still exists at the link target:dsmc restore \\almaden\snj64test\tools\* -sub=yes4. Enter the following command to recover data from the trees link. This step isnot necessary if the data still exists at the link target:dsmc restore \\almaden\snj64test\trees\* -sub=yesChapter 4. Backing up your data 171

5. Use the Distributed File System management console snap-in to reestablishreplication for each link, if necessary.Tivoli Storage Manager limitations:v Tivoli Storage Manager does not restore root of Dfs. To recreate the Dfs tree,manually create the Dfs root first, then start restore to recreate the links.v Tivoli Storage Manager can back up the Dfs tree (both domain based Dfs andstand alone Dfs) hosted on local workstation only. You cannot back up Dfs if theDfs host server is not your local workstation.v Tivoli Storage Manager cannot recreate shared folders on restore. For example, ifyou delete the junction and the shared folder the junction points to, restoring theDfs root recreates the Dfs junction, but restoring a junction creates a local folderinstead of creating the original backed up shared network folder.v If a Dfs link is created with replica and the replica share is on a different server,then Tivoli Storage Manager does not display the replica data.v If a Dfs root is added or modified, Tivoli Storage Manager will not back it up.You must specify the Dfs root in the domain option in the client options file(dsm.opt) regardless of whether DOMAIN ALL-LOCAL is specified.172 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 5. Restoring your dataDuplicate file namesUse Tivoli Storage Manager to restore backup versions of specific files, a group offiles with similar names, or entire directories.You can restore these backup versions if the original files are lost or damaged.Select the files you want to restore using file specification (file path, name, andextension), a directory list, or a subdirectory path to a directory and itssubdirectories.All client backup and restore procedures in this topic also apply to the Web client,except the following:v Estimatev Preferences editorNote: When restoring a directory, its modification date and time is set to the dateand time of the restore, not to the date and time the directory had when it wasbacked up. This is because Tivoli Storage Manager restores the directories first,then adds the files to the directories.The following are the primary restore tasks:v “Restoring files and directories” on page 175v “Restoring Windows system state” on page 180v “Restoring Automated System Recovery files” on page 181v “Microsoft Dfs tree and file restore” on page 183v “Restoring an image” on page 183v “Restore data from a backup set” on page 185v “Restoring data to a point in time” on page 206v “Restore NAS file systems” on page 207v “Authorizing another user to restore or retrieve your files” on page 202v “Restoring or retrieving files from another client node” on page 203v “Restoring or retrieving your files to another workstation” on page 204v “Deleting file spaces” on page 205v “Restoring data from a VMware backup” on page 192Related tasks:“Starting a web client session” on page 97If you attempt to restore or retrieve a file whose name is the same as the shortname of an existing file, a file name collision occurs (existence of duplicate filenames).An example is when the file abcdefghijk.doc has a short name of abcdef~1.doc, andyou attempt to restore or retrieve a file explicitly named abcdef~1.doc into the samedirectory. In this case, a collision occurs because the name of the file you arerestoring conflicts with the short name for abcdefghijk.doc.© Copyright IBM Corp. 1993, 2012 173

A collision can occur even if the files are restored or retrieved to an emptydirectory. For example, files abcdef~1.doc and abcdefghijk.doc might originally haveexisted in the directory as abcdefghijk.doc and abcdef~2.doc. During the restore, ifabcdefghijk.doc is restored first, it is assigned a short name of abcdef~1.doc by theWindows operating system. When you restore abcdef~1.doc, the duplicate file namesituation occurs.Tivoli Storage Manager handles these situations based on the value of the replaceoption. Use the replace option to specify whether to overwrite an existing file, orto prompt you for your selection when you restore or retrieve files.If a file name collision occurs, you can do any of the following:v Restore or retrieve the file with the short file name to a different location.v Stop the restore or retrieve and change the name of the existing file.v Disable short file name support on Windows.v Do not use file names, such as abcdef~1.doc, that would conflict with the shortfile naming convention.Related reference:“Replace” on page 450Universal Naming Convention names restoreUsing a Universal Naming Convention (UNC) name permits you to restore specificshared files to a separate file space. This is useful if, for example, you or anadministrator want to restore a portion of data that you would otherwise beunable to access.Except for drives with removable media, every local drive letter is accessible usinga local UNC name that includes the workstation name and a designation for thedrive letter. For example, to enter a UNC name on drive c: for workstation ocean,enter:\\ocean\c$The $ sign must be included with the drive letter.To enter a UNC name for workstation ocean and share point wave, enter:\\ocean\waveWhen accessing files, you do not need to enter the letter of the drive except fordrives with removable media.Active or inactive backup restoreYour administrator determines how many backup versions Tivoli Storage Managermaintains for each file on your workstation. Having multiple versions of a filepermits you to restore older versions if the most recent backup is damaged.The most recent backup version is the active version. Any other backup version isan inactive version. Every time Tivoli Storage Manager backs up your files, it marksthe new backup version as the active backup, and the last active backup becomesan inactive backup. When the maximum number of inactive versions is reached,Tivoli Storage Manager deletes the oldest inactive version.To restore a backup version that is inactive, you must display both active andinactive versions by clicking on the View menu → Display active/inactive files174 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

item. To display only the active versions (the default), click on the View menu →Display active files only item. If you try to restore both an active and inactiveversion of a file at the same time, only the active version is restored.On the Tivoli Storage Manager command line, use the inactive option to displayboth active and inactive objects.Related reference:“Inactive” on page 393Restoring files and directoriesYou can locate the files you want to restore by searching and filtering.Filtering displays only the files that match the filter criteria for your restoreoperation. Files that do not match the filter criteria do not display. The filterprocess searches files in the specified directory but does not include subdirectories.||Restoring data using the GUIThis section lists the steps to follow to restore files and directories using the clientGUI.1. Click Restore on the main window. The Restore window appears.2. Expand the directory tree by clicking the plus (+) sign or the folder icon next toan object in the tree. Select the object that you want to restore. To search orfilter files, click the Search icon from the tool bar.3. Click the selection box for the objects that you want to restore.4. To modify specific restore options, click the Options button. Any options youchange are effective during the current session only.5. Click Restore. The Restore Destination window appears. Enter the appropriateinformation.6. Click Restore. The Restore Task List window displays the processing status.Related tasks:“Backing up data using the GUI” on page 109Examples for restoring data using the command lineYou can use the examples in this topic when you need to restore objects fromTivoli Storage Managerserver storage.The following table shows how to use some restore commands to restore yourobjects from Tivoli Storage Manager server storage.Chapter 5. Restoring your data 175

Table 28. Command-line restore examplesTask Command ConsiderationsRestore the most recent backupversion of the c:\doc\h1.doc file,even if the backup is inactive.Display a list of active and inactivebackup versions of files from whichyou can select versions to restore.Restore all files with a file extensionof .c from the c:\devel \projectadirectory.Restore the c:\project\doc\h1.docfile to its original directory.Restore the c:\project\doc\h1.docfile under a new name and directory.Restore the files in the e: drive andall of its subdirectories.Restore all files in the c:\mydirdirectory to their state as of 1:00 PMon August 17, 2002.Restore the c:\doc\h2.doc file to itsoriginal directory on the workstation,named star.dsmc restore c:\doc\h1.doc -latestdsmc restore c:\project\* -pick-inactivedsmc restore c:\devel\projecta\*.cdsmc restore c:\project\doc\h1.docdsmc restore c:\project\doc\h1.docc:\project\newdoc\h2.docdsmc restore e:\ -subdir=yesdsmc restore -pitd=8/17/2002-pitt=13:00:00 c:\mydir\dsmc restore c:\doc\h2.doc\\star\c$\To restore the file to “star” which hasbeen renamed “meteor”, enter:dsmc restore \\star\c$\doc\h2.doc \\meteor\c$\You could also enter:dsmc restore \\star\c$\doc\h2.doc c:\This example is valid because if theworkstation name is not included inthe specification, the local workstationis assumed (“meteor”, in this case).If the file you are restoring no longerresides on your workstation, and youhave run an incremental backup sincedeleting the file, there is no activebackup of the file on the server. Inthis case, use the latest option torestore the most recent backupversion. Tivoli Storage Managerrestores the latest backup version,whether it is active or inactive. See“Latest” on page 413 for moreinformation.If you try to restore both an activeand inactive version of a file at thesame time, only the active version isrestored. See “Pick” on page 434 and“Inactive” on page 393 for moreinformation.If you do not specify a destination,the files are restored to their originallocation.If you do not specify a destination,the files are restored to their originallocation.NoneYou must use the subdir option torestore directory attributes/permissions. See “Subdir” on page489 for more information about thesubdir option.See “Pitdate” on page 435 and“Pittime” on page 436 for moreinformation about the pitdate andpittime options.For the purposes of this manual, theworkstation name is part of the filename. Therefore, if you back up fileson one workstation and you want torestore them to another workstation,you must specify a destination. Thisis true even if you are restoring to thesame physical workstation, but theworkstation has a new name.176 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 28. Command-line restore examples (continued)Task Command ConsiderationsRestore a file that was originallybacked up from the diskette labeled“workathome” in the a: drive, andrestore it to a diskette in the a: drivelabeled “extra”.Restore files specified in thec:\filelist.txt file to the d:\dirdirectory.Restore all members of thevirtfs\group1 group backup storedon the Tivoli Storage Manager server.dsmc restore {workathome}\doc\h2.doc a:\doc\h2.docdsmc restore -filelist=c:\filelist.txt d:\dir\dsmc restore group{virtfs}\group1Related concepts:Chapter 12, “Using commands,” on page 535Related reference:“Restore” on page 622If you are restoring a file to a diskwith a different label than the diskfrom which the file was backed up,you must use the file space name(label) of the backup disk instead ofthe drive letter.See “Filelist” on page 380 for moreinformation about restoring a list offiles.See “Restore Group” on page 638 formore information.Examples: Restoring large amounts of dataIf you need to restore a large number of files, you get faster performance using thecommand line interface rather than the GUI interface. In addition, you improveperformance if you enter multiple restore commands at one time.For example, to restore all the files in your c: file space, enter:dsmc restore c:\* -subdir=yes -replace=all -tapeprompt=noHowever, if you enter multiple commands for the root directories in your c: filespace, you can restore the files faster. For example, enter these 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=noOr, if you need to restore files for multiple drives, enter these commands:dsmc restore c:\* -subdir=yes -replace=all -tapeprompt=nodsmc restore d:\* -subdir=yes -replace=all -tapeprompt=nodsmc restore e:\* -subdir=yes -replace=all -tapeprompt=noYou can also use the quiet option with the restore command to save processingtime. However, you will not receive informational messages for individual files.Note: If you already have the appropriate values set for the subdir, replace,tapeprompt, and quiet options in your client options file, it is not necessary toinclude these options in the commands.When you enter multiple commands to restore your files, you must specify aunique part of the file space in each restore command. Do not use any overlappingfile specifications in the commands.To display a list of the root directories in a file space, use the query backupcommand. For example:dsmc query backup -dirsonly -subdir=no c:\Chapter 5. Restoring your data 177

As a general rule, you can enter two to four restore commands at one time. Themaximum number you can run at one time without degrading performancedepends on factors such as network utilization and how much memory you have.For example, if \users and \data1 are on the same tape, the restore for \data1must wait until the restore for \users is complete. However, if \data2 is on adifferent tape, and there are at least two tape drives available, the restore 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 how many tapedrives are available and whether your administrator is using collocation to keepfile spaces assigned to as few volumes as possible. If your administrator is usingcollocation, the number of sequential access media mounts required for restoreoperations is also reduced.Standard query restore, no query restore, and restartable restoreThis topic describes the standard (or classic) restore method, the no query restoremethod, and the restartable restore method.Standard query restore process:The standard query restore process is also known as classic restore. This topicexplains how standard query restore works.Here is how standard query restore works:v The client queries the server for a list of files backed up for the client file spaceyou want to restore.v The server sends a list of backed up files that match the restore criteria. If youwant to restore both active and inactive files, the server sends information aboutall backed up files to the client.v The list of files returned from the server is sorted in client memory to determinethe file restore order and to minimize tape mounts required to perform therestore.v The client tells the server to restore file data and directory objects.v The directories and files you want to restore are sent from the server to theclient.No query restore process:In the no query restore process a single restore request is sent to the server insteadof querying the server for each object to be restored.1. The client tells the server that a no query restore is going to be performed andprovides the server with details about file spaces, directories, and files.2. The server sorts the data using an internal sort table which minimizes tapemounts.3. The data to be restored is sent to the client. File and directory objects stored ondisk are sent immediately since sorting for such data is not required beforerestoring it.4. You can use multiple sessions to restore the data. If the data resides on multipletapes, there are multiple mount points available at the server. The combinationof using the resourceutilization option and MAXNUMMP allows multiplesessions.When you enter an unrestricted wildcard source file specification on the restorecommand and do not specify any of the options: inactive, latest, pick, fromdate,178 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

todate, orvolinformation, the client uses a no query restore method for restoringfiles and directories from the server. This method is called no query restore becauseinstead of querying the server for each object to be restored, a single restorerequest is sent to the server. In this case, the server returns the files and directoriesto the client without further action by the client. The client merely accepts the datacoming from the server and restores it to the destination named on the restorecommand.Using the command-line client, an example of an unrestricted wildcard commandwould be:c:\mydocs\2004\*An example of a restricted wildcard file specification would be:c:\mydocs\2004\sales.*Restartable restore process:If the restore process stops because of a power outage or network failure, theserver records the point at which this occurred.This record is known to the client as a restartable restore. It is possible to have morethan one restartable restore session. Use the query restore command or chooserestartable restores from the Actions menu to find out if your client has anyrestartable restore sessions in the server database.You must complete a restartable restore before attempting further backups of thefile system. If you attempt to repeat the restore that was interrupted or try to backup the destination file space, the attempt fails because you did not complete theoriginal restore. You can restart the restore at the point of interruption by enteringthe restart restore command, or you can delete the restartable restore using thecancel restore command. If you restart the interrupted restore, it restarts with thefirst transaction, which might consist of one or more files, not completely restoredwhen the interruption occurred. Because of this, you might receive some replaceprompts for files from the interrupted transaction which were already restored.From the Tivoli Storage Manager GUI Restartable restores dialog box you canselect the interrupted restore and delete it, or you can choose to restart the restore.If you restart the interrupted restore, it restarts with the first transaction, whichmight consist of one or more files, not completely restored when the interruptionoccurred. Because of this, you might receive some replace prompts for files fromthe interrupted transaction which were already restored.To perform restartable restores using the GUI, follow these steps:1. Select Actions –> Restartable restores from the main panel.2. Select the restartable restore session you want to complete.3. Click the Restart button at the bottom of the panel.Related reference:“Resourceutilization” on page 453“Restore” on page 622Plan for temporary space to restore migrated filesWhen you restore migrated files, you also need temporary space for the residentversion of these files.Chapter 5. Restoring your data 179

If you do not specify enough space for the migrated files and the resident versionsof the files combined, the operation might fail. Refer to IBM Tivoli Storage Managerfor HSM for Windows Administration Guide for details about the restoremigstateoption.|Restoring Windows system stateTivoli Storage Manager supports the Microsoft Volume Shadowcopy Service (VSS)on Windows clients. Tivoli Storage Manager uses VSS to restore the system state.By default, all system state components are restored together.Extra disk space is required to restore SFP files because they are restored to atemporary location on your disk.Startable system state components can include the following:v Active Directory (domain controller only)v System volume (domain controller only)v Certificate Server Databasev COM+ databasev Windows Registryv System and boot filesv ASR writerSystem services components can include the following:v Background Intelligent Transfer Service (BITS)v Event logsv Removable Storage Management Database (RSM)v Cluster Database (cluster node only)v Remote Storage Servicev Terminal Server Licensingv Windows Management Instrumentation (WMI)v Internet Information Services (IIS) metabasev DHCP databasev Wins databaseImportant: Only restore system state during system recovery.||||You must be a member of the Administrators group to restore Windows systemstate information.On Windows clients, restore systemstate also restores ASR files when running inWinPE (Windows Preinstallation Environment).To restore Windows system state information using the GUI, follow these steps:1. Click Restore from the GUI main window. The Restore window appears.2. Expand the directory tree by clicking the plus sign +. To display files in afolder, click the folder icon.3. Locate the system state node in the directory tree. You can expand the systemstate node to display the components.4. Click the selection box next to the system state node to restore the entiresystem state. You can restore the startable system state node only as a singleentity because of dependencies among the startable system state components.By default, all components are selected; you can restore individual systemservices components.180 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

5. Click Restore. The Task List window displays the restore processing status.On the command line, use the restore systemstate command to restore a backup ofsystem state.|||||||||||Considerations:v If you are upgrading from a Windows XP workstation to a Windows Vistaworkstation, you cannot restore the Windows XP system objects that werebacked up to the server.v Your Windows client must be connected to a Tivoli Storage Manager Version5.2.0 or higher server.v If Active Directory is installed, you must be in Active Directory restore mode.v See the related information for performing a system recovery to perform thefollowing tasks:– Your operating system is still functioning, but a complete system restore isrequired.– A complete recovery is required, including an operating system re-installation.Related concepts:“Recovering a computer when the OS is not working (Windows Vista, Windows 7,Windows Server 2008 and Windows Server 2008 R2)” on page 182Related tasks:“Restoring the operating system when the computer is working”Related reference:“Restore Systemstate” on page 645Restoring Automated System Recovery filesRestore Automated System Recovery (ASR) files to recover the Windows operatingsystem volume configuration information and system state if a catastrophic systemor hardware failure occurs.You must be a member of the Administrators or Backup Operators group to backup ASR files.On Windows Vista, Windows 7, and Windows Server 2008, the Tivoli StorageManager backup-archive client restores ASR data when the backup-archive clientrestores the Windows system state. Use the restore systemstate command torestore ASR files on these operating systems.Related concepts:“Recovering a computer when the OS is not working (Windows Vista, Windows 7,Windows Server 2008 and Windows Server 2008 R2)” on page 182Restoring the operating system when the computer is workingIf your computer is working, you can restore the operating system from backed upfiles.If Active Directory is installed, you must be in Active Directory restore mode.When performing an operating system recovery including the system state, use thefollowing restore order. Do not restart the computer between each step, eventhough you are prompted to do so.1. Restore the system drive. For example: dsmc restore c:\* -sub=yes -rep=all.Chapter 5. Restoring your data 181

2. Restore system state. For example: dsmc restore systemstate.Recovering a computer when the OS is not working (Windows Vista,Windows 7, Windows Server 2008 and Windows Server 2008 R2)If the computer has a catastrophic hardware or software failure, you can recover aWindows Vista, Windows 7, or Windows Server 2008 operating system withAutomated System Recovery (ASR).Note that ASR data is not backed up, and hence cannot be restored, on 64-bitarchitectures with Extensible Firmware Interface (EFI).Related tasks:“Restoring the operating system when the computer is working” on page 181Creating a bootable WinPE CD (Windows Vista, Windows 7,Windows Server 2008, Windows Server 2008 R2)Before you can recover a Windows Vista, Windows 7, Windows Server 2008, orWindows Server 2008 R2 computer using ASR (Automated System Recovery), youmust create a bootable Windows Preinstallation Environment (WinPE) CD or DVD.For instructions that describe how to create a bootable WinPE CD or DVD, see theTivoli Storage Manager Wiki article, entitled Best Practices for Recovering WindowsServer 2008, Windows Server 2008 R2, Windows 7, and Windows Vista. The article isposted at the following URL: http://www.ibm.com/developerworks/mydeveloperworks/wikis/home/wiki/Tivoli Storage Manager/page/BestPractices for Recovering Windows Server 2008, Windows Server 2008 R2, Windows7, and Windows VistaRestoring Windows Vista, Windows 7, Windows Server 2008,and Windows Server 2008 R2 with Automated SystemRecoveryYou can restore the operating system of a Windows Vista, Windows 7, WindowsServer 2008 or Windows Server 2008 R2 computer with Automated SystemRecovery (ASR).For instructions that describe how to restore a Windows system using AutomatedSystem Recovery, see the Tivoli Storage Manager Wiki article, entitled Best Practicesfor Recovering Windows Server 2008, Windows Server 2008 R2, Windows 7, andWindows Vista. The article is posted at the following URL: http://www.ibm.com/developerworks/mydeveloperworks/wikis/home/wiki/Tivoli StorageManager/page/Best Practices for Recovering Windows Server 2008, WindowsServer 2008 R2, Windows 7, and Windows VistaYou can now restore other volumes.182 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related tasks:“Creating a bootable WinPE CD (Windows Vista, Windows 7, Windows Server2008, Windows Server 2008 R2)” on page 182“Creating a Tivoli Storage Manager options file for Automated System Recovery(Windows Vista, Windows 7, or Windows Server 2008)” on page 133Related reference:“Restore” on page 622“Restore Systemstate” on page 645Microsoft Dfs tree and file restoreRestoring an imageTo restore Dfs junctions and the data for each junction, restore the Dfs junctionmetadata first and then restore each junction separately.If the junction metadata is not restored, Tivoli Storage Manager creates a directoryunder the Dfs root using the same name as that of the junction point and restoresthe data in that directory.Related tasks:“Microsoft Dfs file protection methods” on page 170There are some items to consider before you begin restoring images on yoursystem.Before you restore an image (offline or online), you must have administrativeauthority on the system.Here is a list of items to consider before you restore an image:v Restoring the image of a volume restores the data to the same state that it wasin when you performed your last image backup. Be absolutely sure that youneed to restore an image, because it replaces your entire current file system orraw volume with the image on the server.v The image restore operation overwrites the volume label on the destinationvolume with the one that existed on the source volume.v Ensure that the volume to which you are restoring the image is at least as largeas the image that is being restored.v The file system or volume you are restoring to does not have to be the sametype as the original. The volume does not even have to be formatted. The imagerestore process creates the appropriately formatted file system for you.v Ensure that the target volume of the restore is not in use. The client locks thevolume before starting the restore. The client unlocks the volume after therestore completes. If the volume is in use when the client attempts to lock thefile system, the restore fails.v You cannot restore an image to where the Tivoli Storage Manager client programis installed.v If you created an image of the system drive, you cannot restore the image to thesame location because the client cannot have an exclusive lock of the systemdrive. Also, because of different system component configurations, the systemimage might not be consistent across components (such as Active Directory).Some of these components can be configured to use different volumes whereparts are installed on the system drive and others to non-system volumes.Chapter 5. Restoring your data 183

vIf you have run progressive incremental backups and image backups of your filesystem, you can perform an incremental image restore of the file system. Theprocess restores individual files after the complete image is restored. Theindividual files restored are those backed up after the original image. Optionally,if files were deleted after the original backup, the incremental restore can deletethose files from the base image.Deletion of files is performed correctly if the backup copy group of the TivoliStorage Manager server has enough versions for existing and deleted files.Incremental backups and restores can be performed only on mounted filesystems, not on raw logical volumes.v If for some reason a restored image is corrupted, you should run chkdsk to checkfor and repair any bad sectors (unless the restored volume is RAW).You can use the verifyimage option with the restore image command to specifythat you want to enable detection of bad sectors on the destination targetvolume. If bad sectors are detected on the target volume, Tivoli Storage Managerissues a warning message on the console and in the error log.If bad sectors present on the target volume, you can use the imagetofile optionwith the restore image command to specify that you want to restore the sourceimage to a file. Later, you can use a data copy utility of your choice to transferthe image from the file to a disk volume.Related reference:“Imagetofile” on page 392“Verifyimage” on page 513Restoring an image using the GUIYou can use the GUI to restore an image of your file system or raw logical volume.Follow these steps to restore an image of your file system or raw logical volume:1. Click Restore from the main window. The Restore window appears.2. Expand the directory tree.3. Locate the object in the tree named Image and expand it. Click the selectionbox next to the image you want to restore. You can obtain detailed informationabout the object by highlighting the object and selecting View → File Details...from the main window or click the View File details button.4. (Optional) To perform an incremental image restore, click the Options buttonto open the Restore Options window and select the Image plus incrementaldirectories and files option. If you want to delete inactive files from your localfile system, select the Delete inactive files from local check box. Click the OKbutton.5. Click Restore. The Restore Destination window appears. The image can berestored to the volume with the drive letter or mount point from which it wasoriginally backed up. Alternatively, a different volume can be chosen for therestore location.6. Click the Restore button to begin the restore. The Task List window appearsshowing the progress of the restore. The Restore Report window displays adetailed status report.The following are some items to consider when you perform an image restoreusing the GUI:vYou can select View → File Details from the main window or click the View Filedetails button to display the following statistics about file system images backedup by the client:184 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vv– Image Size - This is the volume size which was backed up.– Stored Size - This is the actual image size stored on the server. Because imagebackup allows you to back up only used blocks in a file system, the storedimage size on the Tivoli Storage Manager server could be smaller than thevolume size. For online image backups, the stored image can be larger thanthe file system based on the size of the cache files.– File system type– Backup date and time– Management class assigned to image backup– Whether the image backup is an active or inactive copyTo modify specific restore options, click the Options button. Any options youchange are effective during the current session only.In the Restore Options window, you can choose to restore the image only or theimage and incremental directories files. If you choose Image Only, you restorethe image from your last image backup only. This is the default.If you ran incremental-by-date image backup on a volume or image backups ona volume with incrementals, you can choose the Image plus incrementaldirectories and files option. If you choose Image plus incremental directoriesand files, you can also select Delete inactive files from local to delete theinactive files that are restored to your local file system. If incremental-by-dateimage backup was the only type of incremental backup you performed on thefile system, deletion of files will not occur.Important: Be absolutely sure that you need to perform an incremental restorebecause it replaces your entire file system with the image from the server andthen restore the files that you backed up using the incremental image backupoperation.Restoring an image using the command lineUse the restore image command to restore an image using the Tivoli StorageManager command line client.You can use the verifyimage option with the restore image command to specifythat you want to enable detection of bad sectors on the destination target volume.If bad sectors are detected on the target volume, Tivoli Storage Manager issues awarning message on the console and in the error log.If bad sectors are present on the target volume, you can use the imagetofileoption with the restore image command to specify that you want to restore thesource image to a file. Later, you can use a data copy utility of your choice totransfer the image from the file to a disk volume.Related reference:“Imagetofile” on page 392“Verifyimage” on page 513Restore data from a backup setYour Tivoli Storage Manager administrator can generate a backup set, which is acollection of your files that reside on the server, onto portable media created on adevice using a format that is compatible with the client device.You can restore data from a backup set from the Tivoli Storage Manager server, orwhen the backup set is locally available as a file or on a tape device.Chapter 5. Restoring your data 185

You can restore backup sets from the following locations:v From the Tivoli Storage Manager serverv From portable media on a device attached to your client workstationv From a backup set file on your client workstationBackup sets can provide you with instant archive and rapid recovery capability asdescribed in the following list.Instant archiveThis capability allows an administrator to create an archive collection frombackup versions already stored on the server.Rapid recovery with local backup setsTypically, restores are performed from normal file backups that are storedon the Tivoli Storage Manager server outside of backup sets. This restoreapproach gives you the ability to restore the most recent backup version ofevery file. It is possible that a backup set does not contain the most recentbackup version of your files.In some cases restoring data from a backup set can be a better option thanrestoring data from normal backup files on the Tivoli Storage Managerserver. Restoring from a backup set can be a better option for the followingreasons:v A backup set restore can provide for a faster recovery because all of therequired files for restore are contained together within a smaller numberof storage volumes.v A backup set provides a point-in-time collection of files. You can restoreto a point in time rather than restoring what is currently available froma normal file-level restore from the server.v You can perform an ASR restore using a backup set volume.Restoring a backup set from the Tivoli Storage Manager server provides alarger set of restore options than restoring from a local backup set.However, restoring from a local backup set can be preferable in somecases:v It is possible that you need to restore your data when a networkconnection to the Tivoli Storage Manager server is not available. This ispossible in a disaster recovery situation.v The local restore may be faster than restoring over a network connectionto your Tivoli Storage Manager server.A backup set can be restored from the Tivoli Storage Manager server while thebackup set volumes are available to the server, or they can be moved to the clientsystem for a local backup set restore. A backup set can be generated with orwithout a table of contents (TOC), and can contain file data or image data.The backup set can contain system state data.Your ability to restore data from backup sets is restricted by the location of thebackup set and the type of data in the backup set. The command-line client canrestore some data that the GUI cannot restore, but the GUI can allow you tobrowse and choose which objects to restore. Generally, backup sets from the serverwith a TOC allow more options when restoring. However, local backup setsprovide options that are sometimes preferable to restoring from theTivoli StorageManager server.186 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The restrictions for restoring data from backup sets using the GUI are summarizedin the following table. Each interior cell represents one combination of data typeand backup set location. For each situation, the cell indicates if you can use theGUI to restore only the entire backup set, to select objects within the backup set, orif you cannot use the GUI to restore the backup set.Table 29. Backup set GUI restore restrictionsData type in thebackup setfileimagesystem stateLocal(location=fileorlocation=tape)Restore entirebackup set only.Cannot berestored.Restore entirebackup set only.Backup set locationTivoli Storage Manager Server(TOC available)Restore entire backup set, orselected objects in the backup set.Restore entire backup set, orselected objects in the backup set.Restore entire backup set, orselected objects in the backup set.Tivoli StorageManager Server(TOC notavailable)Restore entirebackup set only.Cannot berestored.Restore entirebackup set only.The restrictions for restoring data from backup sets using the command-line clientare summarized in the following table. Each interior cell represents onecombination of data type and backup set location. For each situation, the cell liststhe restore commands you can use. Except as noted, you can restore specificobjects within a backup set, as well as the entire backup set.Table 30. Backup set command-line restore restrictionsData typein thebackup setfileLocal (location=file orlocation=tape)Commands:restorerestore backupsetBackup set locationTivoli Storage ManagerServer (TOC available)Commands:restorerestore backupsetimage Cannot be restored Command:restore imagesystem stateCommand:restore backupsetCommands:restore backupsetrestore systemstateTivoli Storage ManagerServer (TOC notavailable)Commands:restore backupsetCannot be restoredCommand:restore backupsetRestriction: When restoring system state data using the restore backupsetcommand, you cannot specify individual objects. You can only restore the entiresystem state.Chapter 5. Restoring your data 187

Related reference:“Localbackupset” on page 413“Query Backupset” on page 599“Query Image” on page 606“Restore” on page 622“Restore Backupset” on page 631“Restore Image” on page 640“Restore Systemstate” on page 645Restore backup sets: considerations and restrictionsThis topic lists some considerations and restrictions that you must be aware ofwhen restoring backup sets.Backup set restore considerationsConsider the following when restoring backup sets:v If the object you want to restore was generated from a Tivoli Storage Managernode whose name is different from your current node, specify the original nodename with the filespacename parameter on any of the restore commands.v If you are unable to restore a backup set from portable media, check with yourTivoli Storage Manager administrator to ensure that the portable media wascreated on a device using a compatible format.v If you use the restore backupset command on the initial command line with theparameter -location=tape or -location=file, the client does not attempt tocontact the Tivoli Storage Manager server.v When restoring a group from a backup set:– The entire group, or all groups, in the virtual file space are restored. Youcannot restore a single group by specifying the group name, if there areseveral groups in the same virtual file space. You cannot restore a part of agroup by specifying a file path.– Specify a group by using the following values:- Specify the virtual file space name with the filespacename parameter.- Use the subdir option to include subdirectories.v Limited support is provided for restoring backup sets from tape devices attachedto the client system. A native device driver provided by the device manufacturermust always be used. The device driver provided by Tivoli to be used with theTivoli Storage Manager server cannot be used on the client system for restoringlocal backup sets.v To enable the client GUI to restore a backup set from a local device, withoutrequiring a server connection, use the localbackupset option.Backup set restore restrictionsBe aware of the following restrictions when restoring backup sets:v A backup set data that was backed up with the API cannot be restored or used.v You cannot restore image data from a backup set using the restore backupsetcommand. You can restore image data from a backup set only with the restoreimage command.188 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vYou cannot restore image data from a local backup set (location=tape orlocation=file). You can restore image data from a backup set only from theTivoli Storage Manager server.Related information“Localbackupset” on page 413“Restore” on page 622“Restore Image” on page 640“Restore Backupset” on page 631Backup set restoreTivoli Storage Manager considers a backup set as one object containing the wholefile structure. You can restore the entire backup set or, in some cases, you can selectportions. The backup set media is self-describing and contains all the informationrequired to perform a successful restore.If you are connected to a Tivoli Storage Manager Version 5.4 or later server, yourTivoli Storage Manager administrator can create backup sets that are stacked.Stacked backup sets can contain data from multiple client nodes, and they cancontain different types of data for a particular client node. The types of data can befile data or image data.If you have upgraded from Tivoli Storage Manager Express ® , some applicationdata is also supported.Restriction: Image data and application data restore processing is only availablewhen restoring from the Tivoli Storage Manager server. You cannot restore imagedata and application data from a client local backup set restore.When a backup set is stacked, you can only restore data for your own node. Datafor all other nodes is skipped. When restoring data from a stacked backup set on alocal device, you can only restore file level data for your own client node. It isimportant that the nodename option is set to match the node name used to generatethe backup set for one of the nodes in the stack.Important: Due to the portability of local backup sets, you must take additionalsteps to secure your local backup sets on portable media. The backup set mediashould be physically secured because the backup set can be restored locallywithout authenticating with the server. Each user has access to all of the data onthe stacked backup set, which means that the user has access to data that they donot own, by changing the node name or viewing the backup set in its raw format.Encryption or physical protection of the media are the only methods to ensure thatthe data is protected.If you restore backup set data from the server, individual files, directories or entirebackup set data can be restored in a single operation from the GUI or thecommand line. When you restore backup set data locally, the GUI can only displayand restore an entire backup set. The command line can be used to restoreindividual files or directories stored in a backup set locally.Chapter 5. Restoring your data 189

Restoring backup sets using the GUIThe client GUI can restore data from a backup set from the server, from a local file,or from a local tape device. You can use the GUI to restore individual files from abackup set from the Tivoli Storage Manager server with a TOC, but not from alocal backup set nor from a backup set from the server without a TOC.Important: Before you begin a restore operation, be aware that backup sets cancontain data for multiple file spaces. If you specify a destination other than theoriginal location, data from all file spaces are restored to the location you specify.To restore a backup set from the GUI, perform the following steps:1. Click Restore from the GUI main window. The Restore window appears.2. Locate the Backup Sets directory tree object and expand it by clicking the plussign (+) beside it.v To restore the backup set from a local device, expand the Local object andthe Specify backup set location window is displayed. On the window, selectFile name: or Tape name: from the list and enter the tape or file namelocation. You can also click the Browse button to open a file selectionwindow and select a backup set.v To restore data from backup set from the server, first expand the Serverobject and then either Filelevel or Image, depending on the type of restorerequested.3. Click the selection box next to the backup set or directory or file within thebackup set that you want to restore.You can select files from within a backup set if that backup set is from theserver and has a table of contents.4. Click Restore. The Restore Destination window appears. Enter the appropriateinformation.5. Click Restore. The Task List window displays the restore processing status.Note:v If the object you want to restore is part of a backup set generated on a node, andthe node name is changed on the server, any backup set objects that weregenerated prior to the name change will not match the new node name. Ensurethat the node name is the same as the node for which the backup set wasgenerated.v The client can be used to restore a backup set on an attached device with orwithout a server connection. If the server connection fails, a prompt appears tocontinue for purposes of local backup set restore. Also, thelocalbackupsetoption can be used to tell the client not to attempt the connection to the server.v Certain local devices such as tape devices (tape devices do not apply to Mac OSX) require device drivers to be set up prior to performing a restore. See thedevice manual for assistance with this task. You also need to know the deviceaddress in order to perform the restore.v The following features of a backup set restore from the server are not availablewhen restoring locally:1. Image restore.2. Restoring individual system state components.3. The GUI display and restore of individual files and directories. Thecommand line can be used to restore an individual directory or file from alocal backup set.190 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

4. Application data restore if the server was migrated from the Tivoli StorageManager Express product.Backup set restores using the client command-line interfaceThe client command line interface can restore data from a backup set from theserver, from a local file, or from a local tape device. You can use the clientcommand line interface to restore individual files from local backup sets and frombackup sets without a TOC.To restore a backup set from the client command line interface, use the querybackupset command to display what backup set data is available, then use restorecommands to restore the data.You can use the commands below to restore data from backup sets. Use theappropriate command for the location of the backup set and the data in the backupset. (See the table in the parent topic)restorerestore backupsetrestore imagerestore systemstateRelated reference:“Query Backupset” on page 599“Query Image” on page 606“Restore” on page 622“Restore Backupset” on page 631“Restore Image” on page 640“Restore Systemstate” on page 645Restore Net Appliance CIFS sharesRestoring the share definition requires restoring the root directory of the share filespace, which under most circumstances can be done as follows: dsmc rest\\NetAppFiler\CifsShareName\ -dirsonly.The following output indicates that the root directory (and share definition hasbeen restored):Restoring0 \\NetAppFiler\CifsShareName\ [Done]If the CIFS share definition is deleted on the Net Appliance file server, the client isunable to directly restore the share definition because the share is no longeraccessible.The share definition can be restored indirectly by creating a temporary local shareand restoring the share definition to the temporary share as follows:md c:\tempdir net share tempshare=c:\tempdir/remark:"Temporary Share for Restoring Deleted CIFS Share"net use z: \\LocalMachineName\tempsharedsmc res \\NetAppFiler\CifsShareName\ z:\ -dirsonlyThis restores the original share definition (including permissions) on the file server.Chapter 5. Restoring your data 191

Older versions of the Tivoli Storage Manager server might have a problem whichprevents restoring the root directory and the CIFS share definition. If this problemoccurs, it can be circumvented by using by one of the following methods:1. Use the DISABLENQR testflag to restore the root directory as follows:dsmc res \\NetAppFiler\CifsShareName\ -test=disablenqr-dirsonly2. Use the command line client -pick option with a restore command and selectthe root directory:dsmc res \\NetAppFiler\CifsShareName\ -dirsonly -pickRelated tasks:“Net Appliance CIFS share definition backups” on page 162Restoring data from a VMware backupYou can use several methods for restoring data from backups to a VMware virtualmachine. The restore method depends on the type of backup and on the version ofTivoli Storage Manager client software that you use to run the restore.Full VM restoreUse the restore vm command to restore an entire virtual machine from afull VM backup. When you restore a full VM backup, the restored imagereplaces the virtual machine or a new virtual machine is created. In a fullVM restore, you restore all of the VMware files and the system state onWindows systems. If you have access to Tivoli Storage Manager for VirtualEnvironments Data Protection for VMware Recovery Agent, you canrestore individual files.Depending on the version of Tivoli Storage Manager that is running on theVMware client, use the appropriate method to restore a full VM backup:Versions of Tivoli Storage Manager earlier than 6.2.2:Restore the full VM backup by using VMware ConsolidatedBackup. For more information, see the following topic:“Restoring full VM backups that were created with VMwareConsolidated Backup” on page 196Tivoli Storage Manager version 6.2.2 or later:Restore the full VM backup by using the vStorage API. TivoliStorage Manager version 6.2.2 or later can restore full VMwarebackups that were created with versions of Tivoli Storage Managerearlier than 6.2.2. For more information, see the following topic:“Restoring full VM backups” on page 193File-level restoreUse the restore command to restore individual files from a file-level VMbackup. Use this method when you cannot practically restore an entireVMware image. The following restrictions apply to file-level restores:vvYou can use the file-level restore method only if a file-level backup ofthe virtual machine exists.You cannot restore an entire virtual machine from file-level backupsbecause the restore command does not re-create Windows system states.v You cannot use this method to restore individual files from a full VMbackup of a virtual machine.Depending on the configuration of the virtual machine where you restorethe files, use the appropriate method to restore files from a file-levelbackup:192 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

A Tivoli Storage Manager client is not installed on the VM:Restore the files from the vStorage backup server that backed upthe virtual machine.A Tivoli Storage Manager client is installed on the VM:Restore the file from the Tivoli Storage Manager client that isinstalled on the virtual machine.For more information, see the following topic:“Scenario: Restoring file-level VM backups” on page 194Restoring full VM backupsYou can restore a full VMware backup to re-create all of the files for a VMwarevirtual machine (VM) directly to the VMware server. This method replaces thedeprecated method of restoring backups that were created by using the VMwareConsolidated Backup (VCB) tools. This restore method does not require you to usethe VMware converter tool before you restore the backup to the VMware server.You cannot use this restore method to restore individual files from a full VMbackup.To restore a full VMware backup that was created by using VCB tools in TivoliStorage Manager version 6.2.0 or earlier, see the following topic:“Restoring full VM backups that were created with VMware Consolidated Backup”on page 1961. Depending on the target location for the restore, complete the appropriate step:vIf the restore of the full VM backup is going to overwrite the existingVMware virtual machine, delete the existing virtual machine.v If you restore the full VM backup to a new virtual machine, you do not needto delete the existing virtual machine. You can delete the existing virtualmachine if you prefer, otherwise proceed to the next step.2. Query the virtual machine for VMware backups, by completing the followingsteps:a. From the off-host backup server, run the following command:dsmcqvm*The command lists the available backups, for example:# Backup Date Mgmt Class Type A/I Virtual Machine--- ----------- ---------- ---- --- ---------------1 12/03/2009 03:05:03 DEFAULT VSTORFULL A vm_guest12 09/02/2010 10:45:09 DEFAULT VSTORFULL A vm_guest113 09/02/2010 09:34:40 DEFAULT VSTORFULL A vm_guest124 09/02/2010 10:10:10 DEFAULT VSTORFULL A vm_guest135 12/04/2009 20:39:35 DEFAULT VSTORFULL A vm_guest146 09/02/2010 11:15:18 DEFAULT VSTORFULL A vm_guest157 09/02/2010 02:52:44 DEFAULT VSTORFULL A vm_guest168 08/05/2010 04:28:03 DEFAULT VSTORFULL A vm_guest179 08/05/2010 05:20:27 DEFAULT VSTORFULL A vm_guest1810 08/12/2010 04:06:13 DEFAULT VSTORFULL A vm_guest1911 09/02/2010 00:47:01 DEFAULT VSTORFULL A vm_guest712 09/02/2010 01:59:02 DEFAULT VSTORFULL A vm_guest813 09/02/2010 05:20:42 DEFAULT VSTORFULL A vm_guest9ANS1900I Return code is 0.ANS1901I Highest return code was 0.b. From the results that are returned by the query command, identify a virtualmachine to restore.Chapter 5. Restoring your data 193

3. Restore the full VMware backup, by using the restore vm command. To restorethe backup to a virtual machine with a new name, use the -vmname option. Forexample, in the following command the virtual machine is restored and a newname is specified for the restored virtual machine:dsmc restore vm my_old_vmname -vmname=new_vm_name -datastore=myPath4. When the restore is complete, the virtual machine is powered off. Start thevirtual machine from the VMware vCenter.Related reference:“Query VM” on page 617“Restore VM” on page 647Scenario: Restoring file-level VM backupsOn Microsoft Windows systems, you can restore specific files from a file-levelbackup of a VMware virtual machine. A file-level restore is useful for restoringindividual files that might be lost or damaged. You cannot use this method torestore files that were part of a full VM backup. Before you can restore files fromthe off-host backup server onto the VMware virtual machine, the off-host backupserver must be configured as a proxy server.For prerequisite information, see the following topics:v For information about how to configure the off-host backup server as a proxyserver, see the following topic:“Preparing the environment for file-level backups of VMware virtual machines”on page 152.v For information about how to create a file-level VM backup, see the followingtopic:“Creating file-level backups for VMware virtual machines” on page 154Important: Use the restore command to run a file-level restore. Do not use therestore vm command.The following assumptions are made for this scenario of a file-level restore:v The goal is to restore files that were previously backed up to the Tivoli StorageManager server.v The files were previously backed up on a VMware virtual machine called Orion,with the host name orion. For this scenario, the Orion VM fails and some of thefiles must be restored.v Files on Orion were backed up to file spaces that match the lowercase form ofthe computer host name. The file space names are expressed in UniversalNaming Convention (UNC) format, for example:– Files that are backed up from the C: drive on Orion, are stored in the\\orion\c$ file space.– If Orion has a D: drive, files that are backed up from that drive are stored inthe \\orion\d$ file space.v In this scenario, the files are restored from the C:\mydocs directory that was onOrion to the C:\restore_temp directory on a different computer. The computerthat you restore file to can be another VMware virtual machine or a physicalcomputer.v The computer that runs the restore has a different host name and node namethan the virtual machine Orion. During the restore, you must specify the sourcefile specification in the complete UNC format and use one of the followingparameters to access Orion:194 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

-virtualnodenameSpecifies the Tivoli Storage Manager node for which you are restoring abackup. Use this parameter if you are restoring files to the computerwhere you are currently logged on.-asnodenameSpecifies the Tivoli Storage Manager node for which you are restoring abackup. Use this parameter if you are restoring files to a computer forwhich you have proxy authority.Complete the following steps to run a file-level restore for the computer Orion:1. Query the Tivoli Storage Manager server to determine the file spaces that areregistered for Orion:dsmc query filespace -virtualnode=orion2. Restore files for the Orion file space, by running one of the followingcommands:Restore files to the computer where you are currently logged on:Assume that you are currently logged on to the computer called Orion.Run one of the following commands:a. If you know the password for the node that you are restoring, usethe -virtualnodename option in the restore command. For example,run the following command to restore the files to Orion:dsmc restore \\orion\c$\mydocs\ c:\restore_temp\ -sub=yes-virtualnodename=orionb. If you have proxy authority, you can restore files on behalf of thetarget node. Proxy authority must be granted from the agent node,in other words the node of the computer that the restore is runfrom. You must know the password for the agent node so that youcan access the target node. For example, run the followingcommand to restore the files to Orion:dsmc restore \\orion\c$\mydocs\ c:\restore_temp\ -sub=yes-asnodename=orionTable 31. Components for the restore command when you restore files to the same computerCommand component\\orion\c$mydocs\c:\restore_temp\-sub=yes-virtualnodename=orion-asnodename=orionDescriptionSource file specification on the Tivoli StorageManager server. This location contains thebacked up files that you are restoring. Thefiles are backed up for the orion VM, so thefile specification must be in UNC format.Destination file specification on the computerwhere you are currently logged on. The filesare restored to this location.Specifies that all subdirectories in the sourcefile specification are included when you runthe restore operation.Notifies the Tivoli Storage Manager serverthat the backup is running from the nodeorion.Notifies the Tivoli Storage Manager serverthat the backup is running from the nodeorion.Chapter 5. Restoring your data 195

Restore files to a different computer:To restore the files from the Tivoli Storage Manager server to acomputer other than the one you are logged on to, run the followingcommand. You can use this command only if you are logged in withauthority to write to the remote computer as controlled by theoperating system.dsmc restore \\orion\c$\mydocs\ \\orion\c$\restore_temp\ -sub=yes-virtualnode=orionTable 32. Components for the restore command when you restore files to a differentcomputerCommand component\\orion\c$mydocs\\\orion\c$\restore_temp\-sub=yes-virtualnodename=orionDescriptionIdentifies the source file specification on theTivoli Storage Manager server. This locationcontains the backed up files that you arerestoring. The files are backed up for theorion VM, so the file specification must be inUNC format.Identifies the destination file specification ona computer other than the computer whereyou are logged on. The You are restoring thefiles to the orion VM over the network, byusing a Microsoft feature that identifiesnetwork locations in UNC notation.Specifies that all subdirectories in the sourcefile specification are included when you runthe restore operation.Notifies the Tivoli Storage Manager serverthat the backup is running from the nodeorion.Related concepts:“Restoring data from a VMware backup” on page 192Related tasks:“Restoring full VM backups that were created with VMware Consolidated Backup”“Restoring full VM backups” on page 193Related reference:“Query Filespace” on page 603“Restore” on page 622Restoring full VM backups that were created with VMwareConsolidated BackupYou can restore a full VMware backup to re-create all of the files for a VMwarevirtual machine (VM). Complete these steps to restore full VM backups that werecreated by using VMware Consolidated Backup (VCB) running on Tivoli StorageManager version 6.2.0 or earlier.To restore a full VMware backup that was created by using Tivoli Storage Managerversion 6.2.2 or later, see the following topic:“Restoring full VM backups” on page 1931. Depending on the target location for the restore, complete the appropriate step:196 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vIf the restore of the full VM backup is going to overwrite the existingVMware virtual machine, delete the existing virtual machine.v If you restore the full VM backup to a new virtual machine, you do not needto delete the existing virtual machine. You can delete the existing virtualmachine, otherwise proceed to the next step.2. Query the virtual machine for full VMware backups, by completing thefollowing steps:a. From the off-host backup server, run the following command:dsmcqvm*The command lists the available backups, for example:# Backup Date Mgmt Class Type A/I Virtual Machine--- ----------- ---------- ---- --- ---------------1 12/03/2009 03:05:03 DEFAULT VMFULL A vm_guest12 09/02/2010 10:45:09 DEFAULT VMFULL A vm_guest113 09/02/2010 09:34:40 DEFAULT VMFULL A vm_guest124 09/02/2010 10:10:10 DEFAULT VMFULL A vm_guest135 12/04/2009 20:39:35 DEFAULT VMFULL A vm_guest146 09/02/2010 11:15:18 DEFAULT VMFULL A vm_guest157 09/02/2010 02:52:44 DEFAULT VMFULL A vm_guest168 08/05/2010 04:28:03 DEFAULT VMFULL A vm_guest179 08/05/2010 05:20:27 DEFAULT VMFULL A vm_guest1810 08/12/2010 04:06:13 DEFAULT VMFULL A vm_guest1911 09/02/2010 00:47:01 DEFAULT VMFULL A vm_guest712 09/02/2010 01:59:02 DEFAULT VMFULL A vm_guest813 09/02/2010 05:20:42 DEFAULT VMFULL A vm_guest9ANS1900I Return code is 0.ANS1901I Highest return code was 0.b. From the results that are returned by the query command, identify a virtualmachine to restore.3. Restore the full VMware backup, by using the restore vm command. To restorea virtual machine from a specific point in time, include the -pitdate and-pittime options, for example:dsmc restore vm my_vm_name destination -pitdate=date -pittime=hh:mm:ssWhere:my_vm_nameName of the virtual machine that you are restoring.destinationDirectory location for the restored vmdk file.-pitdateDate that the backup was created.-pittimeTime that the backup was created.4. When the restore is completed, the following message is returned. Enter Y.Virtual Infrastructure Client or VMware Converter toolcan be used to redefine virtual machine to the VMware Virtual Center Inventory.Would you like to launch VMware Converter now? (Yes (Y)/No (N))Tip: If you enter N, the command-line returns without opening the VMwareConverter. However, you must convert the image before the image can berestored.5. To convert the restored VCB image into a virtual machine on a VMware serverby using the VMware vCenter Converter tool, complete following steps:Chapter 5. Restoring your data 197

a. From the Windows Start menu, open the Converter tool.b. From the Converter tool, click Convert Machine.c. In the Virtual machine file field, enter the location of the restored .vmx file.Tip: The .vmx file is restored to the directory specified by the vmbackdiroption of the restore vm command.d. Follow the remaining steps in the wizard to convert the full VM backup.6. When the restore is complete, the virtual machine is powered off. Start thevirtual machine from the VMware vCenter.Related reference:“Query VM” on page 617“Restore VM” on page 647Restore Windows individual Active Directory objectsYou can restore individual Active Directory objects to recover from accidentalcorruption or deletion of Active Directory objects without requiring a shutdown orrestart of the Active Directory server.On the Windows Server 2008 client, use the restore adobjects command to restorelocal, deleted Active Directory objects (tombstone objects). You can also restoreindividual Active Directory objects from system state backups on the Tivoli StorageManager server.Related tasks:“Restoring Windows system state” on page 180Related reference:“Restore Adobjects” on page 629Reanimate tombstone objects or restoring from a systemstate backupTombstone reanimation is a process to restore an object that had been deleted fromthe Active Directory. When an object is deleted from Active Directory, it is notphysically erased, but only marked as deleted. It is then possible to reanimate(restore) the object.When an object is reanimated, not all object attributes are preserved. When anobject becomes a tombstone object, many attributes are automatically stripped fromit, and the stripped attributes are lost. It is possible, however, to change the ActiveDirectory schema so that more attributes are preserved when the object is deleted.User-group links are not preserved in tombstones. For example, when a user objectis reanimated, the user account is not a member of any group. All of thisinformation must be recreated manually by the Active Directory administrator.Important: Tombstone object reanimation is the only method available on theWindows Server 2003 domain controller.||||When an Active Directory object is restored from a system state backup on theTivoli Storage Manager server, virtually all of its attributes and its groupmembership are restored. This is the best restore option using a Windows Server2008 domain controller. When an object is restored from the server:198 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||vvvvvThe Active Directory database is extracted from a system state backup andrestored into a temporary location.The restored database is opened.Select which objects you want to restore. For each object:– A search for the matching tombstone is performed. The Globally UniqueIdentifier (GUID) of the restored object is used to search for the tombstone.– If the matching tombstone is found, it is reanimated. In this case, the restoredobject retains the original Globally Unique Identifier (GUID) and the SecurityIdentifier (SID).– If the matching tombstone is not found, a new object is created in thedatabase. In this case, the new object has a new GUID and a new SID that aredifferent than the original object.Missing attributes are copied from the backup into the reanimated or recreatedobject. Existing attributes that have been changed since the backup was takenare updated to match the value in the backup. New attributes that have beenadded since the backup was taken are removed.Group membership is restored.Although all attributes that can be set and the group links are recreated, therestored objects might not be immediately available after the restore operation. AnActive Directory administrator might have to manually update the restored objectsin order to make them available. Make sure to read “Restrictions and limitationswhen restoring Active Directory objects” on page 200 before performing therestore.Related concepts:“Preserve attributes in tombstone objects” on page 201Chapter 5, “Restoring your data,” on page 173“Restrictions and limitations when restoring Active Directory objects” on page 200Related tasks:“Restoring Windows system state” on page 180Related reference:“Restore Adobjects” on page 629Restoring Active Directory objects using the GUI andcommand lineTo restore individual Active Directory objects, you must run the Tivoli StorageManager client on a domain controller and your user account must be a memberof the Administrators group. The Active Directory objects are not displayed in thedirectory tree if your user account is not a member of the Administrators group.You can restore active directory objects or tombstone objects using either the GUIor the command line.To restore individual objects from the GUI:1. Click Restore in the IBM Tivoli Storage Manager window. The Restore windowopens.2. Expand the directory tree if necessary. To expand an object in the tree, click theplus sign (+) next to the object.3. Locate the Active Directory node in the directory tree. Expand it to reveal LocalDeleted Objects. For Windows Server 2008, the Server object is also available.Chapter 5. Restoring your data 199

vvTo restore tombstone objects, expand Local Deleted Objects, navigate to thetombstone objects that you want to restore, and select the tombstone objects.To restore Active Directory objects that are backed up to the Tivoli StorageManager server (only on Windows Server 2008):a. Expand the Server object. A window opens displaying a list of systemstate backups (with different time stamps) on the server.b. Select a system state backup from the list. The Active Directory databasefrom that system state is restored in the background, and the tree ispopulated with Active Directory objects.c. Navigate to the Active Directory objects that you want to restore andselect the Active Directory objects.Tip: To see the attributes for an Active Directory object, keep expanding eachActive Directory object in the tree until you reach the one you want. Theattributes for an object are displayed in the display area that is adjacent tothe tree. You can search or filter the tree for an Active Directory object basedon its name.4. Click Restore to begin the restore operation. The Task List window appearsshowing the progress of the restore operation.On the command line, use the query adobjects command to query and the restoreadobjects command to restore individual Active Directory objects.Related reference:“Query Adobjects” on page 592“Restore Adobjects” on page 629Restrictions and limitations when restoring Active DirectoryobjectsThere are some restrictions and limitations to be aware of when restoring ActiveDirectory objects.Understand the following restrictions before restoring objects:v Do not restore the Active Directory as part of a system-state restore operation,unless it is intended to be used for a disaster recovery-level restore operation ofthe full Active Directory. This type of restore operation requires the ActiveDirectory Server to be stopped and restarted.v You cannot perform a point-in-time restore of tombstone objects. You canperform a point-in-time restore of Active Directory objects that are backed up tothe server.v You cannot restore Active Directory objects from backup sets.Understand the following limitations before restoring objects:v Restoring Active Directory objects from the Tivoli Storage Manager serverrequires temporary space on your local hard disk drive. You can use thestagingdirectory option to specify a directory on your local hard disk forstoring temporary data from the server. Depending on the size of the temporarydata, network bandwidth, and both client and server performance, this operationcan take anywhere from 20 seconds to over an hour. There might be a delay inrefreshing the Restore window when displaying the Active Directory tree.v User passwords cannot be restored by default. A restored user object is disableduntil the administrator resets the password and re-enables the account. Also, ifan account was deleted from the domain and is then restored by Tivoli Storage200 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvvvManager, it must be manually joined to the domain after the restore operation.Otherwise, users on the target computer cannot log on to the domain.In order to have a user or a computer object fully operational after restore, youmust modify schema attribute Unicode-Pwd as described in Preserve attributes intombstone objects.The Active Directory schema is not recreated when the Active Directory object isrestored. If the schema was modified after the backup, the restored object mightno longer be compatible with the new schema, and some Active Directory objectattributes might no longer be valid. Tivoli Storage Manager issues a warningmessage if some attributes cannot be restored.Group Policy Objects and their links to organizational units (OU) cannot berestored.Local policies for restored Active Directory objects are not restored.When you restore an object from the Tivoli Storage Manager server, if the targetobject already exists in the Active Directory and you replace it with its backupversion, the object is not deleted and recreated. The existing object is used as abase, and its attributes are overwritten by the backup version. Some attributes,such as the GUID and the SID, stay with the existing object and are notoverwritten by the backup version.If there are multiple tombstone objects for the same container, reanimate themfrom the Tivoli Storage Manager command line using the object GUID, in whichcase the command-line client only reanimates the container object and not itschildren. In the Tivoli Storage Manager client GUI, the entire container can beselected to reanimate.When you restore an object from the Tivoli Storage Manager server, if the liveActive Directory object exists and has the prevent deletion bit on, Tivoli StorageManager can modify the attributes of the object. However, if there is atombstone object of the same name but a different object GUID, the DirectoryServices returns the access denied error.v When you restore an object from the Tivoli Storage Manager server and thecontainer of the object has been renamed, Tivoli Storage Manager recreates thecontainer using the original name at the time of the backup. When restoring atombstone object, Tivoli Storage Manager restores it to the renamed containerbecause the lastKnownParent attribute of the tombstone object has been updatedto reflect the new container name.Related concepts:“Preserve attributes in tombstone objects”Chapter 5, “Restoring your data,” on page 173Related reference:“Restore Adobjects” on page 629“Stagingdirectory” on page 488Preserve attributes in tombstone objectsTo specify an attribute to be preserved in the tombstone object, first locate thisattribute in the Active Directory schema, then update the searchFlags attribute ofthe schema object.There is vendor-acquired software (for example, ADSI Edit) that allows you toupdate the searchFlags attribute of the schema object.Chapter 5. Restoring your data 201

Usually none of the bits in the searchFlags bit mask are set (the value is 0). SetsearchFlags to 8 (0x00000008) if you want Active Directory to save the particularattribute in the tombstone object when the original object is deleted.Related concepts:Chapter 5, “Restoring your data,” on page 173Related reference:“Restore Adobjects” on page 629Modifying the client acceptor and agent services to use theWeb clientYou cannot restore individual Active Directory objects using the Web client bydefault. The Web client services (CAD and agent) run under the Local Systemaccount by default. The Local System account does not have enough privileges torestore Active Directory objects.To enable this restore operation in the Web client, follow these steps:1. Modify the client acceptor (CAD) and agent services to use an administrativeaccount such as Administrator when logging on to Windows.2. You can edit the properties for the CAD and agent services (typically calledTSM Client Acceptor and TSM Remote Client Agent) in the Control Panel.3. Modify the CAD and the agent services in the Login Options page of the TivoliStorage Manager configuration wizard when you set up the Web clientIf the Web client is already set up, follow these steps:1. Click Start.2. Click Control Panel → Administrative Tools → Services.3. Select the scheduler service from the list of Windows services.4. Click the Log On tab.5. Click This Account in the Login As section.6. Enter an administrative account, or click Browse to locate the domain account.7. Enter the password for the domain account.8. Click OK and then click Start.Related reference:“Restore Adobjects” on page 629Authorizing another user to restore or retrieve your filesYou can authorize a user on another node to restore your backup versions orretrieve your archive copies. In this way, you can share files with other people orwith other workstations that you use with a different node name.You can also authorize other nodes to access the automated system recovery (ASR)file space.Another node can be used to create the ASR diskette so that the workstation canbe recovered using ASR and Tivoli Storage Manager. Use the other node if aproblem occurs with the workstation and the ASR diskette of the workstation isnot available.To authorize another node to restore or retrieve your files:1. Click Utilities → Node Access List from the main window.202 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

2. In the Node Access List window, click the Add button.3. In the Add Access Rule window, select an item in the Permit Access field tospecify the type of data that the other user can access. You can select eitherBacked up Objects or Archived Objects.4. Type the node name of the user in the Grant Access to Node field. Type thenode name of the host workstation of the user in the Grant Access to Nodefield.5. Type the user ID on the host workstation in the User field.6. In the Filespace and Directory field, select the file space and the directorythat the user can access. You can select one file space and one directory at atime. If you want to give the user access to another file space or directory, youmust create another access rule.7. If you want to limit the user to specific files in the directory, type the name orpattern of the files on the server that the other user can access in the Filenamefield. You can make only one entry in the Filename field. It can either be asingle file name or a pattern that matches one or more files. You can use awildcard character as part of the pattern. Your entry must match files thathave been stored on the server.8. If you want to give access to all files that match the file name specificationwithin the selected directory including its subdirectories, click Includesubdirectories.9. Click OK to save the access rule and close the Add Access Rule window.10. The access rule that you created is displayed in the list box in the NodeAccess List window. When you have finished working with the Node AccessList window, click OK. If you do not want to save your changes, click Cancelor close the window.For example, to give the node user2 access to all backup files and subdirectoriesunder the d:\user1 directory, create a rule with the following values:Permit Access to: Backed up ObjectsGrant Access to Node: user2Filespace and Directory: d:\user1Filename: *Include subdirectories: SelectedThe node you are authorizing must be registered with your Tivoli Storage Managerserver.On the command line of the client, use the set access command to authorizeanother node to restore or retrieve your files. You can also use the query accesscommand to see your current list, and delete access to delete nodes from the list.Related reference:“Delete Access” on page 569“Query Access” on page 591“Set Access” on page 661Restoring or retrieving files from another client nodeAfter users grant you access to their files on the server, you can restore or retrievethose files to your local system.Chapter 5. Restoring your data 203

You can display file spaces for another user on the server, restore the backupversions of files for another user, or retrieve the archive copies for another user toyour local file system, by following these steps:1. Click Utilities from the main window.2. Click Access Another Node.3. Type the node name of the host workstation of the user in the Node name fieldand click Set.If you are using commands, use the fromnode option to indicate the node. Youmust also use the file space name, rather than the drive letter, to select therestore-retrieve drive that you want to access. Include the file space name in bracesand specify it as you would specify a drive letter. For example, to restore the filesfrom the cougar node \projx directory on the d–disk file space to your own \projxdirectory, enter:dsmc restore -fromnode=cougar \\cougar\d$\projx\* d:\projx\Use the query filespace command to display a list of file spaces. For example, todisplay a list of the file spaces of cougar, enter:dsmc query filespace -fromnode=cougarImportant: The Tivoli Storage Manager client can use file space information whenrestoring files. The file space information can contain the name of the computerfrom which the files were backed up. If you restore files from another TivoliStorage Manager client node and do not specify a destination for the restored files,the client uses the file space information to restore the files. In this case, the clientattempts to restore the files to the drive on the original computer. If the restoringcomputer has access to the drive of the original computer, you can restore files tothe original drive. If the restoring computer cannot access the drive of the originalcomputer, the client returns a network error message. If you want to restore theoriginal directory structure but on a different computer, specify only the targetdrive when you restore the files. This is true when restoring files from anothernode and when retrieving files from another node.Related reference:“Fromnode” on page 385“Restore” on page 622“Retrieve” on page 652Restoring or retrieving your files to another workstationWhen you are using a different workstation, you can restore or retrieve files youbacked up from your own workstation.Your backup versions and archive copies are stored according to your node, notyour specific workstation. Your Tivoli Storage Manager password protects yourdata.To restore or retrieve files to another workstation, use the virtualnodename optionto specify the node name of the workstation from which you backed up the files.You can use the virtualnodename option when starting Tivoli Storage Manager orplace the option in your client options file, dsm.opt, on the workstation. If you areusing a workstation other than your own, use the virtualnodename option with thedsm command. For example, if your node name is cougar, enter:start dsm -virtualnodename=cougar204 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Deleting file spacesYou can then restore or retrieve files as if you were working from your originalworkstation.You can also use virtualnodename option on commands. For example, to restoreyour \projx files to your local c:\myfiles directory, enter:dsmc restore -virtualnodename=cougar \\cougar\d$\projx\*.* c:\myfiles\If you do not want to restore or retrieve the files to the same directory name onthe alternate workstation, enter a different destination.Restoring or retrieving files to another type of workstationYou can restore or retrieve files from one system type to another. This is calledcross-client restore.Restriction: You must have the appropriate permissions to access the file space ofthe other workstation.NTFS drives permit file and directory names that are longer than those permittedon FAT drives. If you are recovering files to a FAT drive with long file names,specify a destination file specification for each file.When you use the Windows client to recover files with long names to an NTFSdisk, the long names are preserved, even if you are recovering the file to adifferent type of drive than the source drive.Related tasks:“Authorizing another user to restore or retrieve your files” on page 202“Restoring or retrieving files from another client node” on page 203If your Tivoli Storage Manager administrator grants you authority, you can deleteentire file spaces from the server.You cannot delete individual backup copies that are kept on the server. When youdelete a file space, you delete all the files, both backup copies and archive copies,that are contained within the file space. For example, if you delete the file spacefor your C drive, you are deleting every backup copy for every file on that diskand every file that you archived from that disk.Attention:Carefully consider what you are doing before you delete a file space.You can delete file spaces using the GUI or the command-line client. To deletenetwork-attached storage (NAS) file spaces, use the Web client or command-lineclient.To delete a file space using the GUI client, perform the following steps:1. From the main window, click Utilities → Delete Filespaces.2. Select the file spaces you want to delete.3. Click Delete. Tivoli Storage Manager prompts you for confirmation beforedeleting the file space.You can also delete a file space using the delete filespace command. Use the classoption with the delete filespace command to delete NAS file spaces.Chapter 5. Restoring your data 205

Related reference:“Class” on page 310“Delete Filespace” on page 574Restoring data to a point in timeUse a point-in-time restore to restore files to the state that existed at a specific dateand time.A point-in-time restore can eliminate the effect of data corruption by restoring datafrom a time prior to known corruption, or recover a basic configuration to a priorcondition.You can perform a point-in-time restore of system state data, a file space, adirectory, or a file. You can also perform a point-in-time restore of image backups.Perform incremental backups to support a point-in-time restore. During anincremental backup, the client notifies the server when files are deleted from aclient file space or directory. Selective and incremental-by-date backups do notnotify the server about deleted files. Run incremental backups at a frequencyconsistent with possible restore requirements.If you request a point-in-time restore with a date and time that is prior to theoldest version maintained by the Tivoli Storage Manager server, the object is notrestored to your system. Files which were deleted from your workstation prior tothe point-in-time specified will not be restored.Note:1. Your administrator must define copy group settings that maintain enoughinactive versions of a file to guarantee that you can restore that file to a specificdate and time. If enough versions are not maintained, Tivoli Storage Managermight not be able to restore all objects to the point-in-time you specify.2. If you delete a file or directory, the next time you run an incremental backup,the active backup version becomes inactive and the oldest versions that exceedthe number specified by the versions data deleted attribute of the managementclass are deleted.When performing a point-in-time restore, consider the following:v Tivoli Storage Manager restores file versions from the most recent backup beforethe specified point-in-time date. Ensure the point-in-time that you specify is notthe same as the date and time this backup was performed.v If the date and time you specify for the object you are trying to restore is earlierthan the oldest version that exists on the server, Tivoli Storage Manager cannotrestore that object.v Point-in-time restore restores files deleted from the client workstation after thepoint-in-time date but not files deleted before this date.v Tivoli Storage Manager cannot restore a file created after the point-in-time dateand time. When a point-in-time restore runs, files that were created on the clientafter the point-in-time date are not deleted.To perform a point-in-time restore using the client GUI, use the following steps:1. Click the Restore button in the main window. The Restore window appears.206 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Restore NAS file systems2. Click the Point-in-Time button from the Restore window. The Point in TimeRestore window appears.3. Select the Use a Point-in-Time Date selection box. Select the date and time andclick OK. The point in time that you specified appears in the Point in Timedisplay field in the Restore window.4. Display the objects you want to restore. You can search for an object by name,filter the directory tree, or work with the directories in the directory tree.5. Click the selection boxes next to the objects you want to restore.6. Click the Restore button. The Restore Destination window is displayed. Enterthe appropriate information.7. Click the Restore button to start the restore. The Restore Task List windowdisplays the restore processing status.Note: If there are no backup versions of a directory for the point-in-time youspecify, files within that directory are not restorable from the GUI. However, youcan restore these files from the command line.You can start point-in-time restore from the command-line client using the pitdateand pittime options with the query backup and restore commands. For example,when you use the pitdate and pittime options with the query backup command,you establish the point-in-time for which file information is returned. When youuse pitdate and pittime with the restore command, the date and time values youspecify establish the point-in-time for which files are returned. If you specifypitdate without a pittime value, pittime defaults to 23:59:59. If you specifypittime without a pitdate value, it is ignored.Related concepts:Chapter 9, “Storage management policies,” on page 239Related reference:“Backup Image” on page 554You restore NAS file system images using the Web client or command lineinterface.You can restore full or differential NAS file system images that were backed uppreviously. If you restore a differential image, Tivoli Storage Manager automaticallyrestores the full backup image first, followed by the differential image. It is notnecessary for a client node to mount a NAS file system to perform backup orrestore operations on that file system.Related tasks:“Configuring the Web client” on page 31Restoring NAS file systems using the Web clientThis section lists the steps to follow to restore NAS file systems using the Webclient GUI.1. Click the Restore button from the main window. The Restore window appears.2. Expand the directory tree if necessary. To expand a node in the tree, click theplus sign (+) next to an object in the tree. Nodes shown are those that havebeen backed up and to which your administrator has authority. The root nodecalled Nodes is not selectable. This node only appears if a NAS plug-in isChapter 5. Restoring your data 207

present on the client workstation. NAS nodes display on the same level as thenode of the client workstation. Only nodes to which the administrator hasauthority appear.3. Expand the NAS node to reveal the Image object.4. Expand the Image object to display volumes that you can restore. You cannotexpand Volume objects.5. Click the selection boxes next to the volumes under the Image object that youwant to restore. If you want to restore a NAS image that was backed up on aparticular date, click the Point In Time button. After you select a date, the lastobject that was backed up on or prior to that date appears, including anyinactive objects. If you want to display all images (including active images andinactive images), before you select them, select View → Display active/inactivefiles from the menu bar.6. Click Restore. The Restore Destination window appears. Enter the informationin the Restore Destination window. If you choose to restore to a differentdestination, you can only restore one volume at a time to a differentdestination. You can restore NAS file system images to any volume on the NASfile server from which they were backed up. You cannot restore images toanother NAS file server.7. Click Restore. The NAS Restore Task List window displays the restoreprocessing status and progress bar. If there is a number next to the progressbar, it indicates the size of the restore, if known. After the restore completes, theNAS Restore Report window displays processing details. If you must close theWeb browser session, current NAS operations continue after you disconnect.You can use the Dismiss button on the NAS Restore Task List window to quitmonitoring processes without ending the current operation.8. (Optional) To monitor processing of an operation, select the Actions → TSMActivities from the main window.Considerations:v Workstation and remote (NAS) backups are mutually exclusive in a Restorewindow. After selecting an item for restore, the next item you select must be ofthe same type (either NAS or non NAS).v Details will not appear in the right-frame of the Restore window for NAS nodesor images. To view information about a NAS image, highlight the NAS imageand select View → File Details from the menu.v To delete NAS file spaces, select Utilities → Delete Filespaces. You can deleteboth workstation and remote objects.Restoring NAS files and directories using the Web clientYou can use the toc option with the include.fs.nas option in your client optionsfile to specify whether Tivoli Storage Manager saves Table of Contents (TOC)information for each file system backup.If you save TOC information, you can use Tivoli Storage Manager Web client toexamine the entire file system tree and select files and directories to restore.Creation of a TOC requires that you define the TOCDESTINATION attribute in thebackup copy group for the management class to which this backup image isbound. Note that TOC creation requires additional processing, network resources,storage pool space, and possibly a mount point during the backup operation. Ifyou do not save TOC information, you can still restore individual files or directory208 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

trees using the RESTORE NODE server command, provided that you know thefully qualified name of each file or directory and the image in which that objectwas backed up.To restore NAS files and directories:1. Click the Restore from the main window. The Restore window appears.2. Expand the directory tree if necessary. To expand a node in the tree, click theplus sign (+) next to an object in the tree. Nodes shown are those that havebeen backed up and to which your administrator has authority. The root nodecalled Nodes is not selectable. This node only appears if a NAS plug-in ispresent on the client workstation. NAS nodes appear on the same level as thenode of the client workstation. Only nodes to which the administrator hasauthority appear.3. Expand the NAS node to display the File Level object.4. Expand the File Level object to display the volumes, directories, and files thatwere last backed up. When you expand the volume object, and complete TOCinformation is available on the server for the latest backup, the Load Table ofContents dialog appears. If complete TOC information is not available for thelatest backup, no objects appear below the volume object. The next stepexplains how to display objects from backups other than the latest backup.Complete TOC information is provided if you performed either of thefollowing operations: (1) A differential image backup with TOC informationand its corresponding full image backup with TOC information, or (2) A fullimage backup with TOC information.5. Click the selection boxes next to the directories or files that you want to restore.a. If you want to restore files from a NAS image that was backed up on aparticular date or display files from several older versions, highlight thevolume you want to restore and click the Point In Time button.b. If you select Use a Point in Time Date in the Point in Time Restorewindows, files from the image backed up on that date, and if it is adifferential image, files from its corresponding full image appear under theFile Level object.c. If you click Use Selected Images in the Point in Time Restore window, theSelected Images window appears for you to select images. The contents ofthe selected images appear in the File Level object.6. Click Restore. The Restore Destination window appears. Enter the informationin the Restore Destination window. If you choose to restore to a differentdestination, you can only restore one volume at a time to a differentdestination.7. Click Restore. The NAS Restore Task List window displays the restoreprocessing status and progress bar. If there is a number next to the progressbar, it indicates the size of the restore, if known. After the restore completes, theNAS Restore Report window displays processing details. If you must close theWeb browser session, current NAS operations continue after you disconnect.You can use the Dismiss button on the NAS Restore Task List window to quitmonitoring processes without ending the current operation.8. (Optional) To monitor processing of an operation, select the Actions → TSMActivities from the main window.Considerations:v Workstation and remote (NAS) backups are mutually exclusive in a Restorewindow. After selecting an item for restore, the next item you select must be ofthe same type either (either workstation or NAS).Chapter 5. Restoring your data 209

vTo view information about objects in a NAS node, highlight the object and selectView → File Details from the menu.v To delete NAS file spaces, select Utilities → Delete Filespaces. You can deleteboth workstation and remote objects.Related reference:“Toc” on page 505Options and commands to restore NAS file systems from thecommand lineThis topic lists some examples of options and commands you can use to restoreNAS file system images from the command line.Table 33. NAS options and commands|||||||Option or command Definition Pagequery nodeDisplays all the nodes for which a particularadministrative user ID has authority toperform operations. The administrative userID should have at least client ownerauthority over both the NAS node and theclient workstation node they are using eitherfrom command line or from the Web client.“Query Node” onpage 610query backupquery filespacerestore nasmonitor processcancel processdelete filespaceUse the query backup command with theclass option to display information aboutfile system images backed up for a NAS fileserver.Use the query filespace command with theclass option to display a list of file spacesbelonging to a NAS node.Restores the image of a file systembelonging to a Network Attached Storage(NAS) file server.Displays current backup and restoreprocesses for all NAS nodes for which anadministrative user has authority. Theadministrative user can then select oneprocess to monitor.Displays current backup and restoreprocesses for all NAS nodes for which anadministrative user has authority. From thedisplay, the administrative user can selectone process to cancel.Use the delete filespace with the classoption to display a list of file spacesbelonging to a NAS node so that you canchoose one to delete.“Query Backup” onpage 596“Query Filespace” onpage 603“Restore NAS” onpage 643“Monitor Process” onpage 589“Cancel Process” onpage 568“Delete Filespace” onpage 574A NAS file system specification uses the following conventions:v Regardless of client platform, NAS file system specifications use the forwardslash (/) separator, as in this example: /vol/vol0.v NAS file system designations on the command line require brace delimiters {}around the file system names, such as: {/vol/vol0}.210 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Note: When you initiate a NAS restore operation using the command line client orthe Web client, the server starts a process to initiate, control, and monitor theoperation. It might take several moments before you notice progress at the clientcommand line interface because the server must perform a mount and othernecessary tasks before data movement occurs. The Tivoli Storage Managercommand line client might display an Interrupted ... message when the mountoccurs. You can ignore this message.Chapter 5. Restoring your data 211

212 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 6. Archive and retrieve your data (Windows)Archiving and retrieving files is similar to backing up and restoring files. Thissection discusses the primary archive and retrieve tasks.Unless otherwise specified, references to Windows refer to all supported Windowsoperating systems.All client archive and retrieve procedures in this topic also apply to the Web client,except the following:v Preferences editorv Setup wizardThe following are the primary archive and retrieve tasks:v “Archiving data using the GUI” on page 214v “Archive data examples using the command line” on page 215v “Deleting archive data” on page 218v “Retrieving archives using the GUI” on page 219v “Retrieve archives using the command line” on page 219Related concepts:“When to back up and when to archive files” on page 113Related tasks:“Starting a web client session” on page 97Archive filesTo archive files, select the files you want to archive. You can select the files byname or description, or select them from a directory tree.Your administrator might have set up schedules to automatically archive certainfiles on your workstation. The following sections discuss how to archive fileswithout using a schedule.You must assign an archive description for all archived files. An archivedescription identifies data through a meaningful description that you can use laterto identify files and directories. You can enter as many as 254 characters todescribe your archived data. If you do not enter a description, Tivoli StorageManager assigns the following default archive description:Archive Date: mm/dd/yyyywhere mm/dd/yyyy is the current date.When you select the archive function from the backup-archive GUI, Tivoli StorageManager displays a list of all previously used archive descriptions. You can assignthese archive descriptions to future archives.Incremental backup might recall migrated files, while selective backup and archivealways recall migrated files, if you do not use the skipmigrated option. Refer toIBM Tivoli Storage Manager for HSM for Windows Administration Guide for detailsabout using the skipmigrated option.© Copyright IBM Corp. 1993, 2012 213

Related tasks:“Set the client scheduler process to run as a background task and startautomatically at startup” on page 226Snapshot backup or archive with open file supportIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications.The snapshot allows the archive to be taken from a point-in-time copy thatmatches the file system at the time the snapshot is taken. Subsequent changes tothe file system are not included in the archive. You can set the snapshotproviderfsparameter of the include.fs option to none to specify which drives do not useopen file support.Note:1. You can use the include.fs option to set snapshot options on a per file systembasis.2. Open file support is only available for local fixed volumes (mounted to eitherdrive letters or volume mount points) formatted with FAT, FAT32 or NTFS filesystems. This support includes SAN-attached volumes that meet theserequirements.3. If the client is unable to create a snapshot, failover to non-OFS backup occurs;the same backup support that would be done if the OFS feature was notinstalled.4. To enable open file support in a cluster environment all workstations in thecluster should have the OFS feature configured.5. When using the open file support feature with VSS, the client adds thesnapshot volume name to the path of the objects being processed. The snapshotvolume name can be up to 1024 bytes. The complete path (snapshot volumename plus object path) can be 8192 bytes or less.For information about Tivoli Storage Manager Open File Support restrictions andissues, search for TSM Client Open File Support (OFS) at the IBM support website:http://www.ibm.com/support/Related concepts:Chapter 11, “Processing options,” on page 267Related tasks:“Configuring Open File Support” on page 70Archiving data using the GUIYou can archive specific files or entire directories from a directory tree. You canalso assign a unique description for each group of files you archive (archivepackage).To archive your files:1. Click the Archive button in the GUI main window. The Archive windowappears.2. Expand the directory tree by clicking the plus sign (+) or the folder icon next toan object in the tree. To search or filter files, click the Search icon from the toolbar.214 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

3. Enter a description, accept the default description, or select an existingdescription for your archive package in the Description pull down box.4. To modify specific archive options, click the Options button. Any options youchange are effective during the current session only. To estimate the transfertime for your archive selections click the Estimate button.5. Click the Archive button. The Archive Status window displays the progress ofthe archive.Archive data examples using the command lineYou can archive data when you want to preserve copies of files in their currentstate, either for later use or for historical or legal purposes.You can archive a single file, a group of files, or all the files in a directory orsubdirectory. After you archive a file, you can delete the original file from yourworkstation. Use the archive command to archive files.The following table shows examples of how to use the archive command toarchive objects.Table 34. Command-line archive examplesTask Command ConsiderationsArchive all files in thec:\plan\proj1 directory with afile extension of .txt.dsmc archive c:\plan\proj1\*.txtUse wildcards to archive more than onefile at a time.Archive all files in thec:\small\testdir directory anddelete the files on yourworkstation.Archive the c:\proj1\h1.doc fileand the c:\proj2\h2.doc fileArchive a list of files in thec:\filelist.txt file.Archive the a:\ch1.doc file andassign a description to the archive.Archive all the files in the d:\projdirectory and its subdirectories.Use the v2archive option with thearchive command to archive onlyfiles in the c:\relx\dir1 directory.dsmc archive c:\small\testdir\*-deletefilesdsmc archive c:\proj1\h1.docc:\proj2\h2.docdsmc archive -filelist=c:\filelist.txtdsmc archive a:\ch1.doc-description="Chapter 1, firstversion"dsmc archive d:\proj\ -subdir=yesdsmc archive c:\relx\dir1\-v2archiveRetrieve the archived files to yourworkstation whenever you need themagain. For more information about thedeletefiles option, see “Deletefiles”on page 331.You can specify as many files to bearchived as the resources and operatingsystem limits permit. Separate the filesto be archived with a space. For moreinformation about the filelist option,see “Filelist” on page 380.Use the filelist option to process alist of files. For more information aboutthe filelist option, see “Filelist” onpage 380.If you do not specify a description withthe archive command, the default isArchive Date:x, where x is the currentsystem date. For more informationabout the description option, see“Description” on page 331.For more information about the subdiroption, see “Subdir” on page 489.Tivoli Storage Manager archives onlyfiles in the c:\relx\dir1 directory.Directories that exist in the path are notprocessed. For more information aboutthe v2archive option, see “V2archive”on page 511.Chapter 6. Archive and retrieve your data (Windows) 215

Table 34. Command-line archive examples (continued)Task Command ConsiderationsUse the archmc option with thearchive command to specify theavailable management class forthe policy domain to which youwant to bind your archived files.Assuming that you initiated asnapshot of the C: drive andmounted the snapshot as thelogical volume \\florence\c$\snapshots\ snapshot.0, archivethe c:\dir1\sub1 directory treefrom the local snapshot andmanage it on the Tivoli StorageManager server under the filespace name C:dsmc archive –archmc=RET2YRS c:\plan\proj1\ budget.jan\*dsmc archive c:\dir1\sub1\*-subdir=yes -snapshotroot=\\florence\c$\snapshots\snapshot.0For more information about the archmcoption, see “Archmc” on page 295. Formore information about managementclasses, see Chapter 9, “Storagemanagement policies,” on page 239.See “Snapshotroot” on page 479 formore information.Related reference:“Archive” on page 543Associating a local snapshot with a server file spaceYou can associate the data on the local snapshot with the real file space data that isstored on the Tivoli Storage Manager server.To associate the data on the local snapshot with the real file space data on theTivoli Storage Manager server, use the snapshotroot option with the archivecommand, in conjunction with a vendor-acquired application that provides asnapshot of a logical volume.The snapshotroot option cannot provide any facilities to take a volume snapshot, itcan only manage data created by a volume snapshot.Related reference:“Snapshotroot” on page 479Archiving data with client node proxyArchives of multiple nodes that share storage can be consolidated to a commontarget node name on the Tivoli Storage Manager server.This is useful when the workstation responsible for performing the archive canchange over time, such as with a cluster. The asnodename option also allows data tobe restored from a different system than the one that performed the backup. Usethe asnodename option with the appropriate command to back up, archive, restore,and retrieve data under the target node name on the Tivoli Storage Managerserver. This support is only available with Tivoli Storage Manager Version 5.3 andhigher.Tivoli Storage Manager FastBack clients are also backed up using client nodeproxy.To enable this option, follow these steps:1. Install the backup-archive client on all nodes in a shared data environment.216 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

2. Register each node with the Tivoli Storage Manager server, if it does not exist.Register the common target node name to be shared by each of the agent nodesused in your shared data environment.3. Register each of the nodes in the shared data environment with the TivoliStorage Manager server. This is the agent node name that is used forauthentication purposes. Data is not stored using the node name when theasnodename option is used.4. The Tivoli Storage Manager administrator must grant proxy authority to allnodes in the shared environment to access the target node name on the TivoliStorage Manager server, using the GRANT PROXYNODE server command.5. Use the QUERY PROXYNODE administrative client command to display theclient nodes of the authorized user, granted by the GRANT PROXYNODEcommand.Follow these steps to set up encryption with the encryptkey=save option:1. Specify encryptkey=save in the options file.2. Back up at least one file with asnode=ProxyNodeName to create a localencryption key on each agent node in the multiple node environment.Follow these steps to set up encryption with the encryptkey=prompt option:1. Specify encryptkey=prompt in the options file.2. Ensure that users of the agent nodes in the multiple node environment areusing the same encryption key.v If you change the encryption key, you must repeat the previous steps.v Use the same encryption key for all files backed up in the shared nodeenvironment.Follow these steps to enable multinode operation from the GUI:1. Verify that the client node has proxy authority to a target node (or authorizedto act as the target node) using the QUERY PROXYNODE administrative clientcommand.2. Select Edit → Preferences to open the preferences window.3. Select the General tab and fill in the As Node Name field with the name of theproxy authorized target node.4. Click Apply and then OK to close the preferences window.Follow these steps to verify that your client node is now accessing the server asthe target node:1. Open the tree window and check that the target node name specified by the AsNode Name field appears, or2. Verify the target node name in the Accessing As Node field in the ConnectionInformation window.To return to single node operation, delete the As Node Name from the AccessingAs Node field in the General → Preferences tab.Tip:v All agent nodes in the multiple node environment should be of the sameplatform type.v Do not use target nodes as traditional nodes. Use them only for multiple nodeprocessing.Chapter 6. Archive and retrieve your data (Windows) 217

Restrictions enforced within a proxied session:v You cannot perform a system object or system state backup or restore.v You cannot access another node (either from GUI drop down or use of thefromnode option).v You cannot use the clusternode option.v You cannot perform NAS backup or restore.Related reference:“Asnodename” on page 296Deleting archive dataIf your administrator has given you authority, you can delete individual archivecopies from the Tivoli Storage Manager server without deleting the entire filespace.Retrieve archivesTo determine if you have this authority, select File → Connection Information fromthe Tivoli Storage Manager GUI or Web client main menu. Your authority status isprovided in the Delete Archive Files field.To delete archive copies from the Tivoli Storage Manager GUI or Web client:1. Select Delete Archive Data from the Utilities menu. The Archive Deletewindow appears.2. Expand the Directory tree by clicking the plus sign (+) or folder icon next tothe object you want to expand. Objects on the tree are grouped by archivepackage description.3. Click the Delete button. Tivoli Storage Manager prompts you for confirmationbefore deleting archive selections. The Archive Delete Task List windowdisplays the progress of the delete.To delete archive copies using the Tivoli Storage Manager command line client, usethe delete archive command.Related reference:“Delete Archive” on page 570Select the retrieve function to recover an archive copy of a file or a directory.Note: When retrieving a directory, its modification date and time is set to the dateand time of the retrieve, not to the date and time the directory had when it wasarchived. This is because retrieves the directories first, then adds the files to thedirectories.You can also retrieve archive copies from the directory tree, filter the directory tree,and retrieve archive copies of files owned by someone else. To do any of these,click the Retrieve button on the Tivoli Storage Manager main window and followthe directions provided in the task help of the GUI.Important: When you retrieve a file without any specifications, and more than oneversion of the archive copy exists on the server, Tivoli Storage Manager retrievesall of the copies. After the first copy is retrieved, the second copy is retrieved. Ifthere is an existing copy on your client workstation, you are prompted to replace,skip, or cancel.218 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Duplicate file names” on page 173Retrieving archives using the GUIThis topic guides you through the steps to retrieve your archived files using theTivoli Storage Manager GUI.1. Click the Retrieve button on the GUI main window. The Retrieve windowappears.2. Expand the directory tree by clicking the plus sign (+) or the folder icon nextto an object you want to expand. To search or filter files, click the Search iconfrom the tool bar.3. Enter your search criteria in the Find Files (Retrieve) window.4. Click the Search button. The Matching Files (Retrieve) window appears.5. Click the selection boxes next to the files you want to retrieve and close theMatching Files (Retrieve) window.6. Enter your filter criteria in the Find Files (Retrieve) window.7. Click the Filter button. The Retrieve window displays the filtered files.8. Click the selection boxes next to the filtered files or directories you want toretrieve.9. To modify specific retrieve options, click the Options button located to theright of the Estimate button. Any options you change are effective during thecurrent session only.10. Click Retrieve. The Retrieve Destination window appears. You can retrievefiles to a directory or drive other than the one from where they wereoriginally archived. You can also select how much of the parent directorystructure is recreated at the retrieve location.11. Click Retrieve. The Retrieve Status window displays the processing status.Retrieve archives using the command lineYou retrieve a file when you want to return an archive copy from the server toyour workstation. This topic shows some examples of how to retrieve archivedfiles using the command line.You can retrieve a single file, a group of files, or all the files in a directory orsubdirectory. When you retrieve a file, Tivoli Storage Manager sends you a copy ofthat file. The archived file remains in storage.Use the retrieve command to retrieve files. The following table shows examples ofusing the retrieve command.Table 35. Command line examples of retrieving archivesTask Command ConsiderationsRetrieve the c:\doc\h2.doc file to itsoriginal directory.Retrieve the c:\doc\h2.doc file undera new name and directory.Retrieve all files archived with aspecific description to a directorynamed retr1 at a new locationdsmc retrieve c:\doc\h2.docdsmc retrieve c:\doc\h2.docc:\proj2\h3.docdsmc retrieve c:\* d:\retr1\-sub=yes -desc="My first archive"If you do not specify a destination,the files are retrieved to their originallocation.NoneNoneChapter 6. Archive and retrieve your data (Windows) 219

Table 35. Command line examples of retrieving archives (continued)Task Command ConsiderationsRetrieve all files from the c:\projectadirectory that end with the characters.bak to the c:\projectn directory.Use the pick option display a list ofarchives from which you can selectfiles to retrieve.Retrieve a file originally archivedfrom the diskette labelled“workathome” on the a: drive, to adiskette in the a: drive labeled“extra”.Retrieve the c:\doc\h2.doc file to itsoriginal directory on the workstation,named star.dsmc retrieve c:\projecta\*.bakc:\projectndsmc retrieve c:\project\* -pickdsmc retrieve {workathome}\doc\h2.doc a:\doc\h2.docdsmc retrieve c:\doc\h2.doc\\star\c$\To retrieve the file to “star” which hasbeen renamed “meteor”, enter:dsmc retrieve \\star\c$\doc\h2.doc \\meteor\c$\You could also enter:dsmc retrieve \\star\c$\doc\h2.doc c:\This example is valid because if theworkstation name is not included inthe specification, the local workstationis assumed (“meteor”, in this case).NoneSee “Pick” on page 434 for moreinformation about the pick option.If you are retrieving a file to a diskthat has a different label other thanthe disk from which the file wasarchived, use the file space name(label) of the archive disk rather thanthe drive letter.For the purposes of this manual, theworkstation name is part of the filename. Therefore, if you archive fileson one workstation and you want toretrieve them to another workstation,you must specify a destination. Thisis true even if you are retrieving tothe same physical workstation, butthe workstation has a new name.Related reference:“Retrieve” on page 652220 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 7. Tivoli Storage Manager scheduler overviewThe Tivoli Storage Manager central scheduler allows client operations to occurautomatically at specified times.In order to understand scheduling with Tivoli Storage Manager, several terms needto be defined:schedule definitionA definition on the Tivoli Storage Manager server which specifies criticalproperties of the automated activity including the type of action, the timethe action should take place, and how frequently the action takes place.There are numerous other properties which can be set (see the appropriateTivoli Storage Manager Administrator's Reference Guide for a detaileddescription of the define schedule.)schedule associationAn assignment to a specific schedule definition for a client node. Multipleschedule associations allow single schedule definitions to be used by manyclient nodes. Because schedule definitions are included with specific policydomains, it is only possible for nodes defined to a certain policy domain tobe associated with schedules defined in that domain.scheduled eventA specific occurrence of when a schedule is executed for a node. Thefollowing conditions must be met before automatic scheduled events takeplace for a client:v A schedule definition must exist for a specific policy domain.v A schedule association must exist for the required node which belongsto that policy domain.v The client scheduler process must be running on the client system.When creating a schedule definition on the Tivoli Storage Manager server, scheduleactions that you can take include incremental, selective, archive, restore, retrieve,imagebackup, imagerestore, command, and macro. The scheduled action that ismost frequently used is incremental with the objects parameter left undefined. Withthis setting, the Tivoli Storage Manager client performs a domain incrementalbackup of all drives defined by the client domain option. A schedule definitionusing the command action allows an operating system command or shell script tobe executed. When automating tasks for Tivoli Storage Manager for Data Protectionclients, you must use command action schedule definitions which invoke thecommand-line utilities for the "Tivoli Storage Manager for" application.The schedule startup window indicates the acceptable time period for a scheduledevent to start. The startup window is defined by these schedule definitionparameters: startdate, starttime, durunits, and duration. The startdate and starttimeoptions define the beginning of the startup window for the very first scheduledevent. The beginning of the startup windows for subsequent scheduled events varydepending on the period and perunit values of the schedule definition. The durationof the schedule window defines the length of the startup window. The scheduleaction is required to start within the startup window. To illustrate, consider theresults of the following schedule definition:define schedule standard test1 action=incremental starttime=12:00:00 period=1perunits=hour dur=30 duru=minutes© Copyright IBM Corp. 1993, 2012 221

Event Window start Window endActual start (just anexample, times vary)1 12:00:00 12:30:00 12:05:332 13:00:00 13:30:00 13:15:023 14:00:00 14:30:00 14:02:00and so onThe variation in actual start times is a result of the randomization feature providedby the Tivoli Storage Manager central scheduler which helps to balance the load ofscheduled sessions on the Tivoli Storage Manager server.Examples: Blank spaces in file names in schedule definitionsWhen you define or update a schedule objects parameter or the schedule optionsparameter with file specifications that contain blank spaces, put quotation marks(") around each file specification that contains blanks, then add single quotes (')around the entire specification.The following examples show how to delimit schedule object parameters whenfile specifications contain space characters:objects='"c:\home\proj1\Some file.doc"'objects='"c:\home\proj1\Some file.doc" "c:\home\Another file.txt"c:\home\noblanks.txt'objects='"c:\home\My Directory With Blank Spaces\"'objects='"c:\Users\user1\Documents\Some file.doc"'objects='"c:\Users\user1\Documents\Some file.doc""c:\Users\user5\Documents\ Another file.txt" c:\Users\user3\Documents\noblanks.txt'objects='"c:\Users\user1\My Directory With Blank Spaces\"'This syntax ensures that a file specification containing a space, such asc:\home\proj1\Some file.doc, is treated as a single file name, and not as twoseparate files (c:\home\proj1\Some, and file.doc)The following examples show how to delimit schedule options parameters whenfile specifications contain space characters:options=’-preschedulecmd="c:\home\me\my files\bin\myscript"-postschedulecmd="c:\home\me\my files\bin\mypostscript" -quiet’options=’-presched="c:\home\me\my files\bin\precmd" -postsched=finish’You can also refer to the objects and options parameter information for theDEFINE SCHEDULE and UPDATE SCHEDULE commands in the appropriateIBM Tivoli Storage Manager Administrator's Reference.Related concepts:“Specifying input strings that contain blank spaces or quotation marks” on page 96Preferential start times for certain nodesOccasionally, you might want to ensure that a particular node begins its scheduledactivity as close as possible to the defined start time of the schedule. The need forthis typically arises when prompted mode scheduling is in use.Depending on the number of client nodes associated with the schedule and wherethe node is in the prompting sequence, the node might be prompted significantlylater than the start time for the schedule.222 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

In this case, you can perform the following steps:1. Copy the schedule to a new schedule with a different name (or define a newschedule with the preferred attributes).2. Set the new schedule priority attribute so that it has a higher priority than theoriginal schedule.3. Delete the association for the node from the original schedule, then associatethe node to the new schedule.Scheduler processing optionsNow the Tivoli Storage Manager server processes the new schedule first.This topic lists the processing options that impact the behavior of the clientscheduler.On the Tivoli Storage Manager client, you can define most of these options in theclient options file. However, some of these options can be set globally on the TivoliStorage Manager server for all Tivoli Storage Manager clients. The Tivoli StorageManager Administrator's Guide provides detailed information on all topics describedin the section.This table shows which options are defined by the client and server, and whichoptions are overridden by the server. An X in a column indicates where the optioncan be specified.Option Client defined Server defined Server global overridemanagedservicesXmaxcmdretries X SET MAXCMDRETRIEScommandmaxschedsessionsXpostschedulecmd,Xpostnschedulecmdpreschedulecmd,Xprenschedulecmdqueryschedperiod X SETQUERYSCHEDPERIODcommandrandomizeXretryperiod X SET RETRYPERIODcommandschedcmddisabledXschedlognameXschedlogretentionXschedmode X SET SCHEDMODEScommandsessioninitiation X X UPDATE NODE commandChapter 7. Tivoli Storage Manager scheduler overview 223

Option Client defined Server defined Server global overridetcpclientaddress X X(also defined on serverwhensessioninit=serveronly aspart of the nodedefinition)tcpclientport X X(also defined on serverwhensessioninit=serveronly aspart of the nodedefinition)Client defined options are defined in the dsm.opt file. The Tivoli Storage Managerserver can also define some options in a client options set, or as part of the optionsparameter of the schedule definition. The Tivoli Storage Manager server can alsoset some options globally for all clients. By default, the client setting for theseoptions is honored. If the global override on the Tivoli Storage Manager server isset, the client setting for the option is ignored. Defining client options as part ofthe schedule definition is useful if you want to use specific options for a scheduledaction that differ from the option settings normally used by the client node, or aredifferent for each schedule the node executes.The schedmode option controls the communication interaction between the TivoliStorage Manager client and server. There are two variations on the schedule mode:client polling and server prompted.Return codes from preschedulecmd and postschedulecmdscriptsThis topic lists the return codes that you might see when you use thepreschedulecmd and postschedulecmd options.vvIf the command specified by the preschedulecmd option ends with a nonzeroreturn code, Tivoli Storage Manager considers the command to have failed. Inthis case, neither the scheduled event nor any postschedulecmd orpostnschedulecmd command runs. The administrative query event commandwith format=detailed option shows that the event failed with return code 12.If the command specified by the postschedulecmd option ends with a nonzeroreturn code, Tivoli Storage Manager considers the command to have failed. Theadministrative query event command with format=detailed option shows that theevent completed with return code 8, unless the scheduled operation completedwith a higher return code, in which case the higher return code takesprecedence. Therefore, if the scheduled operation completes with return code 0or 4 and the postschedulecmd command fails, the administrative query eventcommand shows that the event completed with return code 8. If the scheduledoperation completes with return code 12, that return code takes precedence, andquery event shows that the event failed with return code 12.When interpreting the return code from a command, Tivoli Storage Managerconsiders 0 to mean success, and anything else to mean failure. While this behavioris widely accepted in the industry, it is not 100% guaranteed. For example, thedeveloper of the widget.exe command might exit with return code 3, if widget.exeran successfully. Therefore, it is possible that the preschedulecmd orpostschedulecmd command might end with a nonzero return code and be224 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

successful. To prevent Tivoli Storage Manager from treating such commands asfailed, you should wrap these commands in a script, and code the script so that itinterprets the command return codes correctly. The script should exit with returncode 0 if the command was successful; otherwise it should exit with a nonzeroreturn code. The logic for a script running widget.exe might look like this:run ’widget.exe’if lastcc == 3exit 0elseexit 1Related reference:“Postschedulecmd/Postnschedulecmd” on page 437“Preschedulecmd/Prenschedulecmd” on page 440Client-acceptor scheduler services versus the traditional schedulerservicesYou can configure the Tivoli Storage Manager client to manage the schedulerprocess using the Tivoli Storage Manager client acceptor daemon.The client acceptor daemon provides a light-weight timer which automaticallystarts and stops the scheduler process as needed. Alternatively, the traditionalmethod keeps the Tivoli Storage Manager scheduler process running continuously.Generally, using the client acceptor daemon to manage the scheduler is thepreferred method.The following information is a comparison of the client acceptor daemon-managedservices and the traditional scheduler services methods.Client acceptor daemon-managed servicesvvvvvDefined using the managedservices schedule option and started withclient acceptor daemon services (dsmcad).The client acceptor daemon starts and stops the scheduler process asneeded for each scheduled action.Requires fewer system resources when idle.Tivoli Storage Manager client options and Tivoli Storage Manager serveroverride options are refreshed each time the client acceptor daemonservices start a scheduled backup.Cannot be used with SESSIONINITiation=SERVEROnly backups.||||Tivoli Storage Manager traditional scheduler servicesv Started with command dsmc sched command.v Remains active, even after scheduled backup is complete.v Requires higher use of system resources when idle.v Tivoli Storage Manager client options and Tivoli Storage Manager serveroverride options are only processed once when dsmc sched is started; ifyou delete an option from a client options set, you must restart thescheduler so the scheduler is made aware of the deletion. .Tip: Restart the traditional scheduler periodically to free system resourcespreviously used by system calls.Chapter 7. Tivoli Storage Manager scheduler overview 225

Set the client scheduler process to run as a background task and startautomatically at startupYou can configure the Tivoli Storage Manager client scheduler to run as abackground system task which starts automatically when your system is started.This is true whether you use the client acceptor daemon (CAD) to manage thescheduler or whether you use the traditional method to start the scheduler clientscheduler.For the scheduler to start unattended, you must enable the client to store itspassword by setting the passwordaccess option to generate, and store thepassword by running a simple Tivoli Storage Manager client command such asdsmc query session. Note that for testing purposes, you can always start thescheduler in the foreground by running dsmc sched from a command prompt(without a managedservices stanza set).On Windows platforms, the scheduler and the client acceptor daemon run asservices. You can create and manage these services by using either the setupwizard or the Tivoli Storage Manager Client Service Configuration Utility,dsmcutil.exe.vvTo start the setup wizard, select Utilities > Setup Wizard in the Tivoli StorageManager backup-archive GUI and select a Help me configure option for theappropriate service. Follow the prompts to install, configure, and start theservice.To start the Tivoli Storage Manager Client Service Configuration Utility, open acommand prompt window and issue the following command to change to thedirectory that contains dsmcutil.exe:cd /d "c:\program files\tivoli\tsm\baclient"Use dsmcutil to manage the client acceptor service or the scheduler service. Fulldocumentation on how to use dsmcutil is available by entering dsmcutil help.The Tivoli Storage Manager client scheduler can be managed by the client acceptordaemon. When setting up Tivoli Storage Manager scheduler services to run withclient acceptor daemon management, two services must be created: the schedulerservice and the client acceptor daemon service. When you install the clientacceptor daemon service with dsmcutil.exe, use the /cadschedname: parameter toidentify which Tivoli Storage Manager scheduler service the client acceptordaemon manages. If you use the setup wizard to install the scheduler, you canselect the Use the CAD to manage the scheduler check box, which automaticallycreates both services and associates them.Using the Client Service Configuration Utility, you can use either of the followingmethods:Client acceptor daemon-managed method1. In your client options file (dsm.opt), either set the managedservicesoption to schedule or schedule webclient.2. In your client options file (dsm.opt), set the passwordaccess option togenerate.3. Create the scheduler service:dsmcutil inst /name:"TSM Client Scheduler" /node:tsmclient1/password:secret /autostart:no /startnow:no226 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

4. Create the client acceptor daemon and associate scheduler service withthe client acceptor daemon:dsmcutil inst CAD /name:"TSM Client Acceptor" /cadschedname:"TSM Client Scheduler" /node:tsmclient1 /password:secret /autostart:yes5. Manually start the client acceptor daemon service:net start "TSM Client Acceptor"Traditional method1. In your client options file (dsm.opt), either remove the managedservicesentirely (it defaults to webclient) or set it to webclient.2. In your client options file (dsm.opt), set the passwordaccess option togenerate.3. Create the scheduler service:dsmcutil inst /name:"TSM Client Scheduler" /node:tsmclient1/password:secret /autostart:yesTo increase the reliability of the Tivoli Storage Manager client scheduler service onWindows, you should set the services to automatically recover from a failure, asfollows:vvvvStart the Windows services management console (Start > Settings > ControlPanel > Administrative Tools > Services)Right-click the TSM Client Scheduler service and select Properties.Click the Recovery tab.Define the recovery action as Restart the service for first, second, andsubsequent failures.If you are using the client acceptor daemon to manage the scheduler, you must setthe recovery properties for the TSM Client Acceptor service, but leave the recoverysettings for the TSM Client Scheduler as Take No Action for the first, second, andsubsequent failures. The same recovery settings can also be defined to increase thereliability of the TSM Journal Service.Examples: Display information about scheduled workSchedules can be classic or enhanced, depending on how the interval to the nextexecution is defined.Classic schedules allow the period to be as small as an hour. Enhanced schedulesallow actions to be executed on specific days.To view schedules that are defined for your client node, enter:dsmc query scheduleTivoli Storage Manager displays detailed information about all scheduled work foryour client node. Table 36 on page 228 displays sample classic query scheduleoutput.Chapter 7. Tivoli Storage Manager scheduler overview 227

Table 36. Sample classic query schedule outputSchedule Name: DAILY_INCDescription: Daily System-wide backupSchedule Style: ClassicAction: IncrementalOptions: QUIETObjects:Priority: 1Next Execution: 30 minutesDuration: 4 HoursPeriod: 1 DayDay of Week: AnyMonth:Day of Month:Week of Month:Expire: NeverSchedule Name: WEEKLY_INCDescription: Weekly backup for project filesSchedule Style: ClassicAction: IncrementalOptions: QUIETObjects: e: f:Priority: 1Next Execution: 60 minutesDuration: 8 HoursPeriod: 7 DaysDay of Week: FridayMonth:Day of Month:Week of Month:Expire: NeverThe schedule name, WEEKLY_INC, starts a weekly incremental backup on the e:and f: drives.The schedule name, DAILY_INC, starts a daily incremental backup. The nextincremental backup starts in 30 minutes. Because no objects are listed, TivoliStorage Manager runs the incremental backup on your default domain. Theschedule has no expiration date.To more accurately determine the status of scheduled events, the query scheduleoutput for an enhanced schedule, on Tivoli Storage Manager Version 5.3 client andabove, includes new fields. These fields are always displayed, even if it is a classicschedule or a Tivoli Storage Manager Version 5.3 client session with a pre-Version5.3 server, but the new fields are blank. Note that for a down-level (prior to TivoliStorage Manager Version 5.3) client, the server reports the period as indefinite andthe day of week as an illegal day. Table 37 on page 229 displays sample enhancedquery schedule output.228 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 37. Sample enhanced query schedule outputSchedule Name: QUARTERLY_FULLDescription: Quarterly full backupSchedule Style: EnhancedAction: SelectiveOptions: subdir=yesObjects: \* \volumes\fs2\*Priority: 5Next Execution: 1744 Hours and 26 MinutesDuration: 1 DayPeriod:Day of Week: FridayMonth: March, June, September, DecemberDay of Month: AnyWeek of Month: LastExpire: NeverDisplay information about completed workWhen you run the schedule command in the foreground, your screen displaysoutput from the scheduled commands.Output is also directed to the dsmsched.log file in the installation directory unlessyou change the directory and file name using the schedlogname option.Note: On Mac OS X, by default the log can be found in one of these locations:~/Library/Logs/tivoli/tsm/Library/Logs/tivoli/tsmWhen you run the schedule command as a service, output from scheduledcommands displays in the application event log. Output is also directed to thedsmsched.log file in the current directory unless you change the path and filename using the schedlogname option. The amount of detail is determined bywhether verbose or quiet is set in the dsm.opt file. The scheduler service also postsmessages to the Windows event log.After scheduled work is performed, check the schedule log to verify that all workcompleted successfully.When a scheduled command is processed the schedule log contains the followingentry:Scheduled event eventname completed successfullyIf the scheduled event does not complete successfully, you receive a messagesimilar to the following:ANS1512E Scheduled event eventname failed. Return code = code.The client indicates whether Tivoli Storage Manager successfully issued thescheduled command associated with the eventname (action=command). No attemptis made to determine the success or failure of the command. You can assess thestatus of the command by evaluating the return code from the scheduledcommand in the schedule log. The schedule log entry for the return code of thecommand is prefaced with the following text:Finished command. Return code is:Chapter 7. Tivoli Storage Manager scheduler overview 229

The schedule log continues to grow unless you prune it using theschedlogretention option or specify a maximum size using the schedlogmaxoption.Related concepts:“Specify scheduling options” on page 233Examples: Event logsThe scheduler service logs information into the application event log and providesan event identification (event ID) number for each event in the log. This topicshows examples of events that are logged to the application event log.Scheduler Service4097: Informational messageExample 1:Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4097Date: 10/31/2002Time: 8:29:57 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:TSM 515 Scheduler halted.Example 2:Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4097Date: 10/31/2002Time: 8:29:57 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:Scheduler Terminated, service ending.Example 3:Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4097Date: 10/31/2002Time: 8:29:56 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:TSM Client Scheduler ’TSM 515 Scheduler’Started.Example 4:Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4097Date: 10/31/2002Time: 8:29:56 AM230 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

User: DILE\AdministratorComputer: MIKEDILEDescription:Starting Scheduler.Example 5:Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4097Date: 10/30/2002Time: 8:06:09 PMUser: DILE\AdministratorComputer: MIKEDILEDescription:Incremental backup of volume ’\\MIKEDILE\C$’4098: Warning messageExample 1:Event Type: WarningEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4098Date: 10/31/2002Time: 8:29:56 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:Error Initializing TSM Api, unable to verifyRegistry Password, see dsierror.log.Example 2:Event Type: WarningEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4098Date: 9/20/2002Time: 6:20:10 PMUser: DILE\AdministratorComputer: MIKEDILEDescription:ANS1802E Incremental backup of ’\\mikedile\c$’ finished with 3 failure4099: Error messageExample 1:Event Type: ErrorEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4099Date: 9/17/2002Time: 6:53:13 PMUser: DILE\AdministratorComputer: MIKEDILEDescription:Scheduler exited with a result code of 4.Example 2:Chapter 7. Tivoli Storage Manager scheduler overview 231

Event Type: ErrorEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4099Date: 9/17/2002Time: 6:27:19 PMUser: DILE\AdministratorComputer: MIKEDILEDescription:ANS4987E Error processing ’\\mikedile\e$\tsm520c\client\winnt\mak \dsmwin32.ncb’:the object is in use by another process4100: Scheduler command messageEvent Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4100Date: 10/31/2002Time: 8:29:56 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:Next Scheduled Event Obtained from ServerSNJEDS1 (MVS):-----------------------------------------Schedule Name: NIGHTLY_BACKUPAction: IncrementalObjects: (none)Options: (none)Server Window Start: 19:00:00 on 10/31/20024101: Backup/Archive statistics for scheduler Displays backup and archivestatistics, which might be useful in determining the success or failure of acommand.Event Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4101Date: 10/30/2002Time: 8:29:21 PMUser: DILE\AdministratorComputer: MIKEDILEDescription:Backup/Archive Statistics for Schedule BackupNIGHTLY_BACKUP :---------------------------------------------Total number of objects inspected: 158,688Total number of objects backed up: 2,486Total number of objects updated: 0Total number of objects rebound: 0Total number of objects deleted: 0Total number of objects expired: 12Total number of objects failed: 0Total number of bytes transferred: 1.15 GBData transfer time: 104.35 secNetwork data transfer rate: 11,564.84 KB/secAggregate data transfer rate: 866.99 KB/secObjects compressed by: 100%Elapsed processing time: 00:23:114102: Restore/Retrieve statistics for scheduler Similar to 4101, except that it is forscheduled restore and retrieve commands.232 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

4103: Backup-Archive Client Service Startup ParametersEvent Type: InformationEvent Source: AdsmClientServiceEvent Category: NoneEvent ID: 4103Date: 10/31/2002Time: 8:29:56 AMUser: DILE\AdministratorComputer: MIKEDILEDescription:Backup/Archive Client Service StartupParameters:--------------------------------------Service Name : TSM 515 SchedulerLast Update : Oct 14 2002Client PTF Level : 5.1.5.2Service Directory : D:\Program Files\Tivoli\TSM515\baclientClient Options File : E:\users\mikedile\logfiles\dsm.optClient Node : MIKEDILEComm Method : (default or obtained fromclient options file)Server : (default or obtained from clientoptions file)Port : (default or obtained from clientoptions file)Schedule Log : E:\users\mikedile\logfiles\dsmsched.logError Log : E:\users\mikedile\logfiles\dsmerror.logMS Cluster Mode : (default or obtainedfrom client options file)Journal Based Backup Service:Specify scheduling options4097: Informational message4098: Warning message4099: Error message4100: Journal Based Backup service filemonitor parameters4101: Journal Based Backup service databaseparameters4102: Journal Based Backup Serviceconfiguration parametersYou can modify scheduling options in the client options file or the graphical userinterface (GUI).However, if your administrator specifies a value for these options, that valueoverrides the value in your client.Related concepts:“Scheduling options” on page 282Enable or disable scheduled commandsYou can use the schedcmddisabled option to disable the scheduling of commandsby the server.Chapter 7. Tivoli Storage Manager scheduler overview 233

Commands are scheduled by using the action=command option on the DEFINESCHEDULE server command.The schedcmddisabled option does not disable the preschedulecmd andpostschedulecmd commands. However, you can specify preschedulecmd orpostschedulecmd with a blank or a null string to disable the scheduling of thesecommands.You can use the schedrestretrdisabled option to prevent the Tivoli StorageManager Server administrator from executing restore or retrieve scheduleoperations.You can use the srvprepostscheddisabled option to prevent the Tivoli StorageManager Server administrator from executing pre-schedule and post-schedulecommands when performing scheduled operations.You can use the srvprepostsnapdisabled option to prevent the Tivoli StorageManager Server administrator from executing pre-snapshot and post-snapshotcommands when performing scheduled image snapshot backup operations.Related reference:“Schedcmddisabled” on page 457“Schedrestretrdisabled” on page 465“Srvprepostscheddisabled” on page 483“Srvprepostsnapdisabled” on page 484Change processing options used by the scheduler serviceWhen you configure the Tivoli Storage Manager central-scheduling services (thescheduler, the client acceptor, or the remote client agent), some of the processingoptions that you specify are defined in the Windows registry.The following options can also be specified in the client options file (dsm.opt).v nodenamev httpportv tcpserveraddressv tcpportv webportsWhen the client scheduler runs as a foreground process using the dsmc schedcommand, the options in the client options file are used. However, when thescheduler runs as a Windows service, the options in the registry are used instead.If you are using the scheduler service and change an option in the dsm.opt file,you must update the corresponding value in the registry as well.To update the Windows registry value:Use the Setup wizard in the client GUI. For more information, see“Configuring the client scheduler” on page 33.Alternatively, you can use the dsmcutil utility to change the registry value.For example: dsmcutil update scheduler /name: /node: /password: .Note: After updating the registry, you must restart the scheduler servicefor the changes to take effect. If you are using client acceptor234 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

daemon-managed scheduling this is not necessary because the scheduler isrestarted by the client acceptor daemon for each backup.Manage multiple schedule requirements on one systemIn certain situations it is preferable to have more than one scheduled activity foreach client system.Normally, you can do this by associating a node with more than one scheduledefinition. This is the standard method of running multiple schedules on onesystem.You must ensure that the schedule windows for each schedule do not overlap. Asingle client scheduler process is not capable of executing multiple scheduledactions simultaneously, so if there is overlap, the second schedule to start is missedif the first schedule does not complete before the end of the startup window of thesecond schedule.Suppose that most of the drives on your client system must be backed up daily,and that one drive containing critical data must be backed up hourly. In this case,you would need to define two schedules to handle this requirement. To avoidconflict between the hourly and daily backup schedule, the starttime of eachschedule needs to be varied.In certain cases, it is necessary to run more than one scheduler process on asystem. Multiple processes require a separate options file for each process andmust contain the following information:v Define a unique node name for each processv Specify unique schedule and error logs for each processvWhen running in prompted mode, you must use the tcpclientport option tospecify a unique port for each process.Note: When the scheduler runs as a service, processing options specified in theWindows registry override the same options specified in the client options file.The advantages of using multiple schedule processes:v You can run more than one scheduled backup at the same time.v You can specify different backup criteria for each schedule started, with theTivoli Storage Manager client option file or Tivoli Storage Manager serveroverride options.The disadvantages of using multiple schedule processes:v A unique file space for each node name on the Tivoli Storage Manager server iscreated.v When restoring the data, you must use the same node name associated with thebackup.You must create a separate service for each schedule process. If you are using theclient acceptor daemon to manage the scheduler, a client acceptor daemon serviceand schedule service are required for each schedule. The following is an exampleof setting up two schedule processes to be managed by the client acceptor daemon:dsmcutil inst /name:"TSM Client Scheduler1" /optfile:"c:\tsm\dsm.opt1"/node:tsmcli_sched1 /password:secret /autostart:no /startnow:nodsmcutil inst CAD /name:"TSM Client Acceptor1" /optfile:"c:\tsm\dsm.opt1"Chapter 7. Tivoli Storage Manager scheduler overview 235

cadschedname:"TSM Client Scheduler1" /node:tsmcli_sched1 /password:secret/autostart:yesdsmcutil inst /name:"TSM Client Scheduler2" /optfile:"c:\tsm\dsm.opt2"/node:tsmcli_sched2 /password:secret /autostart:no /startnow:nodsmcutil inst CAD /name:"TSM Client Acceptor2" /optfile:"c:\tsm\dsm.opt2"/cadschedname:"TSM Client Scheduler2" /node:tsmcli_sched2 /password:secret/autostart:yesUnique option files are required for each schedule instance, and must be identifiedat the time of service creation:Option file #1 (c:\tsm\dsm.opt1)tcpstsmserv1.storage.sanjose.ibm.comnodename tsmcli_sched1passwordaccess generateschedlogname c:\tsm\dsmsched1.logerrorlogname c:\tsm\dsmerror1.logschedmode promptedtcpclientport 1507domain h:managedservices scheduleOption file #2 (c:\tsm\dsm.opt2)tcpstsmserv1.storage.sanjose.ibm.comnodename tsmcli_sched2passwordaccess generateschedlogname c:\tsm\dsmsched2.logerrorlogname c:\tsm\dsmerror2.logschedmode promptedtcpclientport 1508domain i:managedservices scheduleRelated concepts:“Change processing options used by the scheduler service” on page 234236 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 8. Client return codesThe backup-archive command-line interface and the scheduler exit with returncodes that accurately reflect the success or failure of the client operation.Scripts, batch files, and other automation facilities can use the return code from thecommand-line interface. For operations that use the Tivoli Storage Managerscheduler, the return codes are shown in the output of the QUERY EVENTadministrative command.In general, the return code is related to the highest severity message during theclient operation.vvvIf the highest severity message is informational (ANSnnnnI), then the returncode is 0.If the highest severity message is a warning (ANSnnnnW), then the return codeis 8.If the highest severity message is an error (ANSnnnnE or ANSnnnnS), then thereturn code is 12.An exception to these rules is made when warning or error messages indicate thatindividual files could not be processed. For files that cannot be processed, thereturn code is 4. Examine the dsmerror.log file to determine the cause of errorsthat occur during client operations. Errors that occur during scheduled events arerecorded in the dsmsched.log file.Table 38 describes the return codes and their meanings.Table 38. Client return codes and their meaningsCode Explanation0 All operations completed successfully.4 The operation completed successfully, but some files were not processed.There were no other errors or warnings. This return code is very common.Files are not processed for various reasons. The most common reasons are:v The file satisfies an entry in an exclude list.v The file was in use by another application and could not be accessed bythe client.v The file changed during the operation to an extent prohibited by the copyserialization attribute. See “Copy serialization attribute” on page 243.8 The operation completed with at least one warning message. For scheduledevents, the status is Completed. Review dsmerror.log (and dsmsched.log forscheduled events) to determine what warning messages were issued and toassess their impact on the operation.12 The operation completed with at least one error message (except for errormessages for skipped files). For scheduled events, the status is Failed.Review the dsmerror.log file (and dsmsched.log file for scheduled events) todetermine what error messages were issued and to assess their impact on theoperation. As a general rule, this return code means that the error was severeenough to prevent the successful completion of the operation. For example,an error that prevents an entire drive from being processed yields return code12.© Copyright IBM Corp. 1993, 2012 237

Table 38. Client return codes and their meanings (continued)Code Explanationother For scheduled operations where the scheduled action is COMMAND, thereturn code is the return code from the command that was executed. If thereturn code is 0, the status of the scheduled operation is Completed. Ifthereturn code is nonzero, then the status is Failed.Some commands might issue a nonzero return code to indicate success. Forthese commands, you can avoid a Failed status by wrapping the command ina script that invokes the command, interprets the results, and exits withreturn code 0 if the command was successful (the script should exit with anonzero return code if the command failed). Then ask your Tivoli Storagemanager server administrator to modify the schedule definition to invokeyour script instead of the command.The return code for a client macro is the highest return code issued among theindividual commands that comprise the macro. For example, suppose a macroconsists of these commands:selective c:\MyTools\* -subdir=yesincremental c:\MyPrograms\TestDriver\* -subdir=yesarchive e:\TSM510C\* -subdir=yesIf the first command completes with return code 0; the second commandcompleted with return code 8; and the third command completed with return code4, the return code for the macro is 8.See the IBM Tivoli Storage Manager Administrator's Reference for your operatingsystem for more information about QUERY EVENT.238 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 9. Storage management policiesStorage management policies are rules your administrator defines in order tomanage your backups and archives on the server.Your data is associated (or bound) to these policies; then when the data is backedup or archived, it is managed according to policy criteria. Policy criteria include apolicy domain, a policy set, a management class, and a copy group.Policies determine:v Whether a file is eligible for backup or archive services.v How many backup versions to keep.v How long to keep inactive backup versions and archive copies.v Where to place the copies in storage.v For incremental backup, policies also determine:– How frequently a file can be backed up.– Whether a file must change before it is backed up again.This topic explains:v Policy criteria (policy domains, policy sets, copy groups, and managementclasses).v How to display policies.v How Tivoli Storage Manager associates your data with policies.Policy domains and policy setsA policy domain is a group of clients with similar requirements for backing up andarchiving data.Policy domains contain one or more policy sets. An administrator uses policydomains to manage a group of client nodes in a logical way.For example, a policy domain might include:v A department, such as Accounting.v A physical location, such as a particular building or floor.v A local area network, such as all clients associated with a particular file server.Tivoli Storage Manager includes a default policy domain named Standard. At first,your client node might be associated with the default policy domain. However,your administrator can define additional policy domains if there are groups ofusers with unique backup and archive requirements.A policy set is a group of one or more management classes. Each policy domain canhold many policy sets. The administrator uses a policy set to implement differentmanagement classes based on business and user needs. Only one of these policysets can be active at a time. This is called the active policy set. Each policy setcontains a default management class and any number of additional managementclasses.© Copyright IBM Corp. 1993, 2012 239

Management classes and copy groupsA management class is a collection of backup and archive copy groups thatestablishes and contains specific storage management requirements for backing upand archiving data.An administrator can establish separate management classes to meet the backupand archive requirements for different kinds of data, such as:v System data that is critical for the business.v Application data that changes frequently.v Report data that Management reviews monthly.v Legal information that must be retained indefinitely, requiring a large amount ofdisk space.Most of the work you do with storage management policies is with managementclasses. Each file and directory that you back up, and each file that you archive, isassociated with (or bound to) a management class, as follows:vvvIf your data is not associated with a management class, Tivoli Storage Manageruses the default management class in the active policy set.When backing up directories, you can specify a management class with aninclude statement or the dirmc option. If you do not specify a management class,Tivoli Storage Manager uses the management class in the active policy setspecifying the longest "Retain Only" retention period. If there are multiplemanagement classes that meet this criteria, Tivoli Storage Manager uses the lastone found, in alphabetical order.For archiving directories, you can specify a management class with aninclude.archive statement or the archmc option. If you do not specify amanagement class, the server assigns the default management class to thearchived directory. If the default management class has no archive copy group,the server assigns the management class that currently has the archive copygroup with the shortest retention time.You can use include statements in your include-exclude list to associate files withmanagement classes. In your client options file, you can associate directories with amanagement class, using the dirmc option.Within a management class, the specific backup and archive requirements are incopy groups. Copy groups define the specific storage management attributes thatdescribe how the server manages backed up or archived data. Copy groupsinclude both backup copy groups and archive copy groups. A management class canhave one backup copy group, one archive copy group, both, or neither.A backup copy group contains attributes that are used during the backup process todetermine:v How many days must elapse before a file is backed up again.v How a file is processed during a backup if it is in use.It also contains attributes to manage the backup versions of your files on theserver. These attributes control:v On which media type the server stores backup versions of your files anddirectories.v How many backup versions the server keeps of your files and directories.v How long the server keeps backup versions of your files and directories.v How long the server keeps inactive backup versions.v How long the last remaining inactive version of a file is kept.240 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

An archive copy group contains attributes that control:v Whether a file is archived if it is in usev On which media type the server stores archived copies of your filesv How long the server keeps archived copies of your filesRelated concepts:“Select a management class for files” on page 245“Retention grace period” on page 248Display information about management classes and copy groupsYou can display policy information with the command-line interface or with agraphical user interface.On a graphical user interface, click View policy information from the Utilitiesmenu. The Policy information window displays the available management classes.On a command line, use the query mgmtclass command to view the availablemanagement classes. The detail option provides more information.Table 39 shows the default values for the backup and archive copy groups in thestandard management class.Table 39. Default attribute values in the standard management classAttribute Backup default Archive defaultCopy group name Standard StandardCopy type Backup ArchiveCopy frequency 0 days CMD (Command)Versions data exists Two versions Does not applyVersions data deleted One version Does not applyRetain extra versions 30 days Does not applyRetain only version 60 days Does not applyCopy serialization Shared static Shared staticCopy mode Modified AbsoluteCopy destination Backuppool ArchivepoolRetain versions Does not apply 365 daysLan free Destination NoDeduplication enabled No NoCopy group name attributeThe copy group name attribute is the name of the copy group. The default value forboth backup and archive is standard.Copy type attributeThe copy type attribute is the type of the copy group. The value for backup isalways backup, and the value for archive is always archive.Chapter 9. Storage management policies 241

Copy frequency attributeThe copy frequency attribute is the minimum number of days that must elapsebetween successive incremental backups. Use this attribute during a fullincremental backup.Copy frequency works with the mode parameter. For example, if frequency is zero (0)and mode is modified, a file or directory is backed up only if it changed since thelast incremental backup. If frequency is zero (0) and mode is absolute, a file isbacked up every time you run an incremental backup against it. This attribute isnot checked for selective backups.For archive copy groups, copy frequency is always CMD (command). There is norestriction on how often you archive a file.Copy frequency is ignored during a journal-based backup.Journal-based incremental backup differs from the traditional full incrementalbackup because Tivoli Storage Manager does not enforce non-default copyfrequencies (other than 0).Versions data exists attributeThe versions data exists attribute specifies the maximum number of different backupversions retained for files and directories.If you select a management class that permits more than one backup version, themost recent version is called the active version. All other versions are called inactiveversions. If the maximum number of versions permitted is five, and you run abackup that creates a sixth version, the oldest version is deleted from serverstorage.Versions data deleted attributeThe versions data deleted attribute specifies the maximum number of differentbackup versions retained for files and directories that you deleted.This parameter is ignored until you delete the file or directory.If you delete the file or directory, the next time you run an incremental backup, theactive backup version is changed to inactive. Tivoli Storage Manager deletes theoldest versions in excess of the number specified by this parameter.The expiration date for the remaining versions is based on the retain extra versionsand retain only version parameters.Retain extra versions attributeThe retain extra versions attribute specifies how many days all but the most recentbackup version is retained.The most recent version is the active version, and active versions are never erased.If Nolimit is specified, then extra versions are kept until the number of backupversions exceeds the versions data exists or versions data deleted parameter settings. Inthis case, the oldest extra version is deleted immediately.242 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Retain only version attributeThe retain only version attribute specifies the number of days the last remaininginactive version of a file or directory is retained.If Nolimit is specified, the last version is retained indefinitely.This parameter goes into effect during the next incremental backup after a file isdeleted from the client system. Any subsequent updates to this parameter will notaffect files that are already inactive. For example: If this parameter is set to 10 dayswhen a file is inactivated during an incremental backup, the file is deleted fromthe server in 10 days.Copy serialization attributeThe copy serialization attribute determines whether a file can be in use during abackup or archive, and what to do if it is.The value for this attribute can be one of the following:v Static. A file or directory must not be modified during a backup or archive. Ifthe object is changed during a backup or archive attempt, it is not backed up orarchived.vvvNote: For all supported Windows 32-bit versions: During an image backup, thestatic copy serialization value is no longer controlled by the server managementclass, but is instead controlled directly from the client, using thesnapshotproviderimage option.Shared static. A file or directory must not be modified during backup orarchive. Tivoli Storage Manager attempts to perform a backup or archive asmany as four additional times, depending on the value specified on thechangingretries option in your options file. If the object is changed duringevery backup or archive attempt, it is not backed up or archived.Dynamic. A file or directory is backed up or archived on the first attemptregardless of whether it changes during a backup or archive.Important: For all supported Windows 32-bit versions: During an image backup,the dynamic copy serialization value is no longer controlled by the servermanagement class, but is instead controlled directly from the client, using thesnapshotproviderimage option.Shared dynamic. A file or directory is backed up or archived regardless ofwhether it changes during a backup or archive. Tivoli Storage Manager attemptsto back up or archive as many as four additional times. The number of attemptsdepend on the value that was specified on the changingretries option in youroptions file, without the file changing during the attempt. The file is backed upor archived on the last try even if it has changed.If you select a management class that permits a file to be backed up or archivedwhile it is in use, the backup version or archived copy that is stored on theserver might be a fuzzy copy. A fuzzy copy is a backup version or archived copythat does not accurately reflect what is currently in the file. It might containsome, but not all, of the changes. If that is not acceptable, select a managementclass that creates a backup version or archive copy only if the file does notchange during a backup or archive. When you use static serialization,applications cannot open a file for write access while the file is being backed up.Chapter 9. Storage management policies 243

If you restore or retrieve a file that contains a fuzzy copy, the file might not beusable. Do not use dynamic or shared dynamic serialization to back up filesunless you are certain that a fuzzy copy that is restored is usable.Important: Be careful when you select a management class containing a copygroup that specifies shared dynamic or serialization dynamic backup.Related concepts:“Open file support for backup operations” on page 107Related tasks:“Configuring Open File Support” on page 70Related reference:“Snapshotproviderimage” on page 479Copy mode attributeThe copy mode attribute determines whether a file or directory is considered forincremental backup regardless of whether it changed or not since the last backup.Tivoli Storage Manager does not check the mode for selective backups.The value for this parameter can be one of the following:v Modified. The file is considered for incremental backup only if it has changedsince the last backup. A file is considered changed if any of the following aretrue:– The date or time of the last modification is different.– The file size is different.– The file attributes, with the exception of archive, are different.– If only the file metadata changes (such as access permissions), but the filedata does not change, Tivoli Storage Manager might back up only themetadata.v Absolute. The file is considered for incremental backup regardless of whether itchanged since the last backup. For archive copy groups, the mode is alwaysabsolute, indicating that a file is archived regardless of whether it changed sincethe last archive request.Copy destination attributeThe copy destination attribute names the destination where backups or archives arestored.The destination can be either a storage pool of disk devices or a storage pool ofdevices that support removable media, such as tape.Retain versions attributeThe retain versions attribute specifies the number of days an archived file remainsin storage.When the specified number of days elapse for an archived copy of a file, it isdeleted from server storage.Deduplicate data attributeThe deduplicate data attribute specifies whether redundant data is transferred to theTivoli Storage Manager server during backup and archive processing.244 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related concepts:“Client-side data deduplication” on page 49Related reference:“Deduplication” on page 329“Enablededupcache” on page 355“Exclude options” on page 365Select a management class for filesIf the default management class meets the backup and archive requirements for allthe files on your workstation, it is not necessary to take any action to associateyour files with that management class. This is done automatically when you backup or archive your files.When selecting a different management class for your files, consider thesequestions:v Does the management class contain a backup copy group?If you attempt to back up a file associated with a management class that doesnot contain a backup copy group, the file is not backed up.v Does the management class contain an archive copy group?You cannot archive a file associated with a management class that does notcontain an archive copy group.v Does the backup copy group contain attributes that back up your files oftenenough?Mode and frequency work together to control how often a file is backed upwhen you use incremental backup. Tivoli Storage Manager does not check thoseattributes for selective backup.v What serialization method does the copy group use?The serialization method determines how Tivoli Storage Manager functionswhen a file changes while it is being backed up.v Does the backup copy group specify an adequate number of backup versions tokeep, along with an adequate length of time to keep them?v Does the archive copy group specify an adequate length of time to keeparchived copies of files?Related concepts:“Copy serialization attribute” on page 243Assign a management class to filesA management class defines when your files are included in a backup, how longthey are kept on the server, and how many versions of the file the server shouldkeep.The server administrator selects a default management class. You can specify yourown management class to override the default management class.To assign a management class other than the default to directories, use the dirmcoption in your options file.You can assign a management class for a file or file group by using an includestatement in your options file. You can also assign a management class by using anChapter 9. Storage management policies 245

include statement in include-exclude file specified by the inclexcl option.Management class names are not case-sensitive.Using the command-line client, to associate all files in the costs directory with themanagement class named budget, you would enter:include c:\adsm\proj2\costs\* budgetTo specify a management class named managall to use for all files to which you donot explicitly assign a management class, enter the following:include ?:\...\* managallThe following examples show how to assign a management class to files:exclude ?:\...\*.snoinclude c:\winter\...\*.ice mcweeklyinclude c:\winter\december\*.ice mcdailyinclude c:\winter\january\*.ice mcmonthlyinclude c:\winter\february\white.snoProcessing follows these steps:1. The file white.sno in the february directory in the winter directory is backedup following bottom-up processing rules. Because you did not specify amanagement class on this statement, the file is assigned to the defaultmanagement class.2. Any file with an extension of ice in the january directory is assigned to themanagement class named mcmonthly.3. Any file with an extension of ice in the december directory is assigned to themanagement class named mcdaily.4. Any other files with an extension of ice in any directory under the winterdirectory are assigned to the management class named mcweekly.5. Any file with an extension of sno in any directory is excluded from backup.The exception to this rule is white.sno in the february directory, which is in thewinter directory.To specify your own default management class mgmt_class_name for files that arenot explicitly included, put the following statement at the top of your include list:include ?:\...\* mgmt_class_nameRelated reference:“Dirmc” on page 336“Include options” on page 395Override the management class for archived filesWhen you archive a file, you can override the assigned management class usingthe a graphical user interface (GUI), or by using the archmc option on the archivecommand.Overriding the management class using the GUI is equivalent to using the archmcoption on the archive command. To use the GUI, press the Options button on thearchive tree to override the management class and select a different managementclass.On the command line, to associate the file budget.jan with the management classret2yrs, enter this command:dsmc archive –archmc=ret2yrs c:\plan\proj1\budget.jan246 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Select a management class for directoriesIf the management class in your active policy set containing the longest "Retainonly version" (RETONLY) setting meets your backup requirements for directories,it might not be necessary to take any action to associate directories with thatmanagement class. Tivoli Storage Manager does it automatically when it backs upyour directories.If there is more than one management class with the longest RETONLY setting, theTivoli Storage Manager client selects the management class whose name is last inalphabetical order.If the default management class does not meet your requirements, select amanagement class with an adequate retention period specified by the retain onlyversion parameter. For example, if the management class happens to back up datadirectly to tape, but you want your directory backups to go to disk, you mustchoose a different management class. You should keep directories at least as longas you keep the files associated with those directories.For backup directories, use the dirmc option to specify the management class towhich directories are bound.For archive directories, use the archmc option with the archive command.You can use these methods to view the available management classes and theirattributes:v GUI or Web Client: Select View Policy Information from the Utilities menu.v command-line client: Run dsmc query mgmtclass -detail.Note: During expiration processing on a Tivoli Storage Manager server, if anarchived directory is eligible for expiration, the server checks if any existingarchived files require the archived directory to remain. If so, the archived directoryis not expired and the Tivoli Storage Manager client updates the insert date on thearchived directory to ensure that the directory is not expired before the files underit.Bind management classes to filesBinding associates a file with a management class.When you back up a file for the first time, Tivoli Storage Manager binds it toeither the default management class or the management class specified in yourinclude-exclude list.If the backup copy group for the management class specifies keeping multiplebackup versions of the file, and you request multiple backups, the server alwayshas one active backup version (the current version) and one or more inactivebackup versions of the file. All backup versions of a file are bound to the samemanagement class and are managed based on the attributes in the backup copygroup.When you archive a file for the first time, Tivoli Storage Manager binds it to thedefault management class, to the management class specified in yourinclude-exclude list, or to a management class you specify when modifying yourarchive options during an archive.Chapter 9. Storage management policies 247

Archived files are never rebound to a different management class. If you changethe management class for a file using an include.archive statement, the archmcoption, or through a Tivoli Storage Manager GUI, any previous copies of the filethat you archived remain bound to the management class specified when youarchived them.If a file is deleted on the client system then that inactive objects of the file are notrebound.Refer to the IBM Tivoli Storage Manager Administrator's Guide for your operatingsystem, for more information on how files and directories are associated withmanagement classes.Rebind backup versions of filesRetention grace periodRebinding associates a file or a logical volume image with a new management class.Backups of files are bound again to a different management class in the followingconditions. In each condition, the files (active and inactive) are not bound againuntil the next backup.vvvYou specify a different management class in an Include statement to change themanagement class for the file. The backups are managed based on the oldmanagement class until you run another backup.Your administrator deletes the management class from your active policy set.The default management class is used to manage the backup versions when youback up the file again.Your administrator assigns your client node to a different policy domain and theactive policy set in that domain does not have a management class with thesame name. The default management class for the new policy domain is used tomanage the backup versions.Refer to the IBM Tivoli Storage Manager Administrator's Guide for your operatingsystem, for more information on how files and directories are associated withmanagement classes.Tivoli Storage Manager also provides a backup retention grace period and an archiveretention grace period to help protect your backup and archive data when it isunable to rebind a file to an appropriate management class.The backup retention grace period is in the following cases:v You change the management class for a file, but neither the default managementclass nor the new management class contain a backup copy group.v The management class to which a file is bound no longer exists, and the defaultmanagement class does not contain a backup copy group.The backup retention grace period, defined in your policy domain, starts when yourun an incremental backup. The default is 30 days. However, your administratorcan lengthen or shorten this period.When Tivoli Storage Manager manages a file using the backup retention graceperiod, it does not create any new backup versions of the file. All existing backupversions of the file expire 30 days (or the number of days specified in your policydomain) from the day they are marked inactive.248 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Archive copies are never rebound because each archive operation creates adifferent archive copy. Archive copies remain bound to the management classname specified when the user archived them. If the management class to which anarchive copy is bound no longer exists or no longer contains an archive copygroup, the server uses the default management class. If you later change or replacethe default management class, the server uses the updated default managementclass to manage the archive copy. If the default management class does not containan archive copy group, the server uses the archive retention grace period specifiedfor the policy domain.Event-based policy retention protectionAll management classes with an archive copy group must specify a retentionperiod, for example, the number of days that an archived object is stored on theserver before being deleted.Event-based policy provides the option of beginning the retention period either atthe time the object is archived or at a later date when an activation event is sent tothe server for that object.Using the Tivoli Storage Manager copy group value RETINIT=CREATE starts thedata retention period when the file is archived. Using the copy group valueRETINIT=EVENT starts the data retention period when the server is notified thatthe event has occurred.The following example demonstrates this concept:The user has two files, create.file and event.file. The user has available twomanagement classes; CREATE, with RETINIT= CREATE, and EVENT, withRETINIT=EVENT. Both management classes have a 60-day retention period. Theuser, on the same day, archives both files:dsmc archive create.file -archmc=CREATEdsmc archive event.file -archmc=EVENTTen days later, the user issues the set event -type=hold command for thecreate.file file, so the file cannot be deleted. On the same day the user issues theset event -type=activate for the event.file file. At this time, create.file has 50days left on its retention period, and event.file has 60 days. If no other action istaken, create.file remains on the server forever, and event.file is expired 70days after it was created (60 days after its event occurred). However, if 20 daysafter the initial archive, the user issues set event -type=release for the create.filefile. Thirty days of its retention period have passed, so the file is expired in 30days (the hold does not extend the retention period).See the IBM Tivoli Storage Manager Administrator's Guide for your operating system,for more information about RETINIT.Related reference:“Set Event” on page 664Archive files on a data retention serverUp to this point, there is no difference between archiving files on a normal serveror a data retention server.The following example demonstrates the differences between the two servers, andwhat can be done at day 5:Chapter 9. Storage management policies 249

If the files were archived on a non-data retention server, the user can issue thedelete archive create.file event.file command and both files are deleted. If the fileswere archived on a data retention server, the same command fails both files. Thedata retention server forces the user to keep archives until the stated retentioncriteria are met.Now here is the difference at day 15 (after the hold):The delete archive create.file event.file command on the non-data retention servernow deletes event.file, but returns a cannot delete error for create.file because itis in hold status. That same command to a data retention server still rejects thedeletion of both files.250 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 10. Using the Client Service Configuration UtilityThe following Tivoli Storage Manager services can be installed during installationor by using the Tivoli Storage Manager Client Service Configuration Utility: (1)Backup-Archive Scheduler Service, (2) Client Acceptor Service (CAD), (3) RemoteClient Agent Service, and (4) Tivoli Storage Manager Journal Engine Service.For more information about using the Tivoli Storage Manager Client ServiceConfiguration Utility to install the Client Acceptor Service and Remote ClientAgent Service, see related information about using the Dsmcutil command.Related concepts:“Use the Dsmcutil command” on page 254Install the backup-archive scheduler serviceYou can use either the Tivoli Storage Manager GUI or the TSM Client ServiceConfiguration Utility to install the Tivoli Storage Manager scheduler.vvFrom the Tivoli Storage Manager GUI click Utilities and then click SetupWizard. Select the Help me configure the TSM Client Scheduler option.If you have an account that belongs to the Administrator/Domain Administratorgroup, you can use the TSM Client Service Configuration Utility to configureclient services on both local and remote Windows workstations.Using the Client Service Configuration Utility (Windows)This section provides the steps for using the Client Service Configuration Utility toautomate backups, manage existing scheduler services, create a new scheduler, andassociate a CAD to manage the scheduler.This example illustrates the use of the Tivoli Storage Manager scheduler.When the Tivoli Storage Manager backup-archive client is registered with a TivoliStorage Manager server, the procedure involves the following steps:1. On the server:a. Define a schedule for the policy domain to which the backup-archive clientis registered.b. Associate the backup-archive client node to the defined schedule.2. On the backup-archive client:a. Install the Tivoli Storage Manager scheduler client as a Windows service forthe backup-archive client.b. Start the scheduler service installed for the backup-archive client.Examples: Automating backupsThis section provides examples of how to automate your backups.The example below uses the following assumptions:v The Tivoli Storage Manager backup-archive client is registered to a TivoliStorage Manager server with a node name of mars and a password ofmarspswd in policy domain bacliwnt.v The event to be scheduled is a daily incremental backup of file systems on clientworkstations. The backup begins between 9:00 and 9:15 pm.© Copyright IBM Corp. 1993, 2012 251

vvThe backup-archive client is installed to the c:\program files\tivoli\tsm\baclient directory.The communication parameters in the backup-archive client options file(dsm.opt) are appropriate for the Tivoli Storage Manager server.On the server:1. Enter the following command on the server console or from an administrativeclient to define the schedule: def sched bacliwnt wnt_daily_incr desc="DailyIncremental Backup" priority=2 starttime=21:00 duration=15durunits=minutes period=1 perunits=days dayofweek=any. The administrativeclient does not have to be running on the same system as the Tivoli StorageManager server. Tivoli Storage Manager displays this message: ANR2500ISchedule WNT_DAILY_INCR defined in policy domain BACLIWNT.2. To associate the backup-archive client to this schedule, issue the followingcommand: define association bacliwnt wnt_daily_incr mars. Tivoli StorageManager displays this message: ANR2510I Node MARS associated with scheduleWNT_DAILY_INCR in policy domain BACLIWNT. At this point, a schedule thatperforms an incremental backup is defined on the Tivoli Storage Managerserver. The schedule starts around 9:00 pm. The schedule is re-executed once aday and can start on any day of the week. If you want to confirm that theschedule and association are set correctly, you can use the Query Schedulecommand.On the backup-archive client:This example assumes that you installed the Tivoli Storage Managerbackup-archive client in the c:\program files\tivoli\tsm\baclient directory. Italso assumes that the options files in each of these directories are updated so thatthe communication parameters point to the Tivoli Storage Manager server.1. Login using an account with administrative privileges.2. Open a command prompt window and issue the following command: cd /d"c:\program files\tivoli\tsm\baclient". If the path contains a space, forexample c:\program files\tivoli\tsm\baclient, enclose the name in doublequotation marks.3. In the window, issue the following command: dsmcutil inst scheduler/name:"TSM Client Scheduler" /node:mars /password:marspswd/clientdir:"c:\program files\ tivoli\tsm\baclient" /optfile:"c:\programfiles\tivoli\tsm\ baclient\dsm.opt" /autostart:yes. Your system is nowready to run automatic daily incremental backups. The /autostart:yes optionspecifies that the scheduler service starts automatically each time the system isrebooted. You can use the /startnow:[Yes|No] option to specify whether to startthe scheduler service after executing the command; the default is Yes.Ifyouspecify /startnow:No you must start the service manually using the servicescontrol panel applet on NT, or issue the following command: net start "TSMClient Scheduler".4. The scheduler uses the backup-archive client options file to validate the nodeand password, and to contact the server for schedule information. This exampleassumes that the dsm.opt file is updated so that the communication parameterspoint to the Tivoli Storage Manager server. If you see the following message: Acommunications error occurred connecting to the TSM server. You shouldensure that the options file contains entries that point to the correct TivoliStorage Manager server. You should also ensure that the server is running. Usethe dsmcutil update command to correct one of the parameters which wasincorrectly specified during the dsmcutil install. For example, to update the252 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

client directory and options file for the specified scheduler service, enter:dsmcutil update scheduler /name:"TSM Central Scheduler Service"/clientdir:c:\tsmptf3\baclient /optfile:c:\tsmptf3\baclient\dsm.opt.Then reissue the net start "TSM Client Scheduler" command.Note:1. If any changes that affect the scheduler service are made to the backup-archiveclient options file, the scheduler service has to be restarted. If you are usingCAD managed scheduling this is not necessary since the scheduler is restartedby the CAD for each backup and the changes are picked up. An example ofthis is the Tivoli Storage Manager server address or the schedule mode. Thiscan be done by issuing the following commands: net stop "TSM ClientScheduler" and then net start "TSM Client Scheduler".2. The dsmsched.log file contains status information for the Tivoli StorageManager scheduler service. In this example, the file is located in this path:c:\program files\tivoli\tsm\baclient\dsmsched.log. You can override thisfile name by specifying the schedlogname option in the options file, dsm.opt.3. Output from scheduled commands is sent to the log file. After scheduled workis performed, check the log to ensure the work completed successfully. When ascheduled command is processed the schedule log might contain the followingentry: Scheduled event eventname completed successfully. This is merely anindication that Tivoli Storage Manager successfully issued the scheduledcommand associated with the eventname. No attempt is made to determine thesuccess or failure of the command. You should assess the success or failure ofthe command by evaluating the return code from the scheduled command inthe schedule log. The schedule log entry for the return code of the command isprefaced with the following text: Finished command. Return code is:.Related tasks:“Dsmcutil valid options” on page 262Related reference:“Query Schedule” on page 613Examples: Configuring the CAD to manage an existing schedulerserviceThis section provides examples of how to configure the client service configurationutility to use scheduler services.The example below assumes that the scheduler service name is TSM CentralScheduler Service and the CAD service name is TSM Client Acceptor, which arethe default names. You can use the dsmcutil /name option to specify differentnames.To configure the CAD to manage an existing scheduler service:1. Stop the scheduler service and the CAD, as follows: dsmcutil stop /name:"tsmcentral scheduler service" and then dsmcutil stop /name:"tsm clientacceptor".2. Set the managedservices option to schedule in the client options file (dsm.opt).3. Update the scheduler service so that it does not start automatically after areboot: dsmcutil update /name:"tsm central scheduler service"/autostart:no.4. Associate the scheduler service with the CAD: dsmcutil update cad/name:"tsm client acceptor" /cadschedname:"tsm central schedulerservice" /autostart:yes. If this command is successful, the dsmwebcl.log fileChapter 10. Client Service Configuration Utility 253

Use the Dsmcutil commandincludes this message: Command will be executed in 1 minute. After oneminute, the CAD starts the scheduler and you see information regarding thenext scheduled event in the dsmwebcl.log file.Related concepts:“Dsmcutil commands: Required options and examples” on page 255Related tasks:“Dsmcutil valid options” on page 262Creating a new scheduler and associating a CAD to manage theschedulerThis section provides step-by-step instructions to create a new scheduler andassociate a CAD to manage the scheduler.Follow these steps to create a new scheduler and associate a CAD:1. Set the managedservices option to schedule in the client options file (dsm.opt).2. Create the scheduler service: dsmcutil install scheduler/name:"NEW_SCHEDULE_NAME" /node:yournode /password:xxxxx /startnow:no.Do not use the /autostart:yes option when installing a scheduler that ismanaged by the CAD.3. Create the CAD service: dsmcutil install cad /node:yournode/password:xxxxx /autostart:yes /startnow:no.4. Associate the scheduler with the CAD: dsmcutil update cad /name:"tsmclient acceptor" /cadschedname:"NEW_SCHEDULE_NAME".5. Start the CAD: dsmcutil start cad /name:"tsm client acceptor".Note: The CAD and scheduler starts, as described above. Since the CAD iscontrolling the scheduler, you do not see the scheduler running as a service, eitherthrough the Services applet or the NET START command. To stop the scheduler,you must stop the CAD.The Tivoli Storage Manager Client Service Configuration Utility, dsmcutil, allowsTivoli Storage Manager Client Services installation and configuration on local andremote Windows workstations.You can install the following Tivoli Storage Manager services under a double-bytecharacter set (DBCS) path:v Backup-Archive Scheduler Servicev Client Acceptor Service (CAD)v Remote Client Agent Servicev Journal Engine Servicev VMware Tools ServiceThe Client Service Configuration Utility must be run from an account that belongsto the Administrator/Domain Administrator group. The syntax of the utility is:►►SCHEDulerdsmcutil command serviceCADJOURnalREMOTEagentVMWAREtools►◄254 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Note:1. For Windows Vista, you must right click on the command prompt and select"Run as administrator".2. Options that you specify with dsmcutil commands override those in youroptions file (dsm.opt).The account running the utility must have the appropriate user rights for installingservices and updating the Windows Registry on the target workstation.If a remote workstation is specified, the account must be authorized to connect tothe Windows Registry of the specified workstation.Note: For the commands and options documented here, the minimumabbreviation is in upper case. Upper case letters denote the shortest acceptabletruncation. If an item appears entirely in upper case letters, it cannot be truncated.You can type the item in any combination of upper case or lower case letters.Related concepts:Chapter 2, “Configure the Tivoli Storage Manager client,” on page 27Dsmcutil commands: Required options and examplesThe INSTall command installs and configures a Tivoli Storage Manager Service.INSTall SchedulerInstalls and configures the Tivoli Storage Manager Scheduler Service.These are the required INSTall command options:v /name:servicenamev /password:passwordv /clusternode:Yes|No (required if running the Microsoft Cluster Server (MSCS) orVeritas Cluster Server (VCS)).v /clustername:clustername (required if running the MSCS or VCS).Restriction: Do not specify a clustername of more than 64 characters. If youspecify more than 64 characters and you are using Veritas Storage Foundation withHigh Availability or a Microsoft Cluster Server configuration, you might not beable to install or start the Tivoli Storage Manager scheduler service.The /clientdir:clientdir option can also be used, the default is the current directory.The following files must exist in the directory specified for /clientdir:clientdir:v dsmcsvc.exev dscenu.txtv dsm.optv dsmntapi.dllv tsmutil1.dllNote: If the service is being installed on a remote workstation, the fully qualifiedclient directory path should be relative to the target workstation. UNC names arenot allowed for the local system account. Multiple services can be installed on thesame workstation.TaskInstall a scheduler service named TSM Central Scheduler Service on theChapter 10. Client Service Configuration Utility 255

local workstation. Start the service automatically at system boot time. Allrequired files must reside in the current directory and the client options filemust point to the Tivoli Storage Manager server where node ALPHA1 isdefined with password nodepw. The Tivoli Storage Manager server iscontacted to verify that the specified node and password are valid. Whenthe password is validated it is generated (encrypted) into the WindowsRegistry:TaskTaskTaskCommand:dsmcutil install scheduler /name:"TSM Central Scheduler Service"/node:ALPHA1 /password:nodepw /autostart:yesInstall a scheduler service named TSM Central Scheduler Service onremote workstation PDC. Start the service automatically at system boottime. The required scheduler service files and the specified options filemust reside on the remote workstation in the c:\tsm\baclient directory.The password is encrypted into the Windows Registry. The Tivoli StorageManager server is not contacted to validate the password.Command:dsmcutil install scheduler /name:"TSM Central Scheduler Service"/machine:PDC /clientdir:c:\tsm\baclient /optfile:c:\tsm\baclient\dsm.opt/node:PDC /validate:no /autostart:yes/password:nodepasswordInstall a scheduler service named TSM Central Scheduler Service onremote workstation PDC. Start the service automatically at system boottime. The required scheduler service files and the specified options filemust reside on the remote workstation in the c:\tsm\baclient directory.The password is encrypted into the Windows Registry. The Tivoli StorageManager server residing at the specified TCP/IP host and port is contactedto validate the password.Command:dsmcutil install scheduler /name:"TSM Central Scheduler Service"/machine:PDC /clientdir:c:\tsm\baclient /optfile:c:\tsm\baclient\dsm.opt/node:PDC /autostart:yes /password:nodepassword/commmethod:tcpip /commserver:alpha1.sanjose.com/commport:1521Install the TSM Central Scheduler Service on one node of a MSCS (orVCS) cluster. For group-a from workstation node-1, ensure that node-1currently owns group-a and then issue the command.Command:dsmcutil install scheduler /name:"TSM Central Scheduler Service:group-a" /clientdir:c:\tsm\baclient /optfile:q:\tsm\baclient\dsm.opt /node:mscs-cluster-group-a /password:n/validate:no /autostart:yes /startnow:yes/clusternode:yes /clustername:mscs-clusterINSTall CADInstalls and configures the Client Acceptor Service (CAD). Required options are:v /name:servicenamev /node:nodenamev /password:passwordOther valid options are:v /optfile:optionsfile256 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

v /httpport:httpportv /webports:webportsTask Install a Client Acceptor Service called TSM CAD. TSM CAD uses a nodecalled test to connect to the Tivoli Storage Manager server. Use the optionsfile c:\tsm\baclient\dsm.opt to connect to Tivoli Storage Manager.Command:dsmcutil install cad /name:"TSM CAD" /node:test/password:test /optfile:c:\tsm\baclient\dsm.optINSTall JournalInstalls a journaling engine service on all Windows clients. A journal database iscreated that stores information the client uses to determine which files are eligiblefor backup before an operation starts.If necessary, you can use the nojournal option with the incremental command tospecify that you want to perform a traditional full incremental backup.The journaling engine service is named TSM Journal Service and uses theconfiguration file tsmjbbd.ini from the Tivoli Storage Manager installationdirectory.Note: The Journal Service is supported in a Microsoft Cluster Server environment.Multiple journal services can be installed by specifying unique pipe names usingthe JournalPipe journal config setting and client options.There are no valid options for this command.Task Install the journaling engine service TSM Journal Service.Command:dsmcutil install journalINSTall REMOTEAgentInstalls and configures a Remote Client Agent Service. Required options are:v /name:servicenamev /node:nodenamev /password:passwordv /partnername:partner service nameOther valid options are:v /optfile:optionsfileTaskInstall a Remote Client Agent Service called TSM AGENT. TSM AGENTuses a node called test to connect to the Tivoli Storage Manager server. Theoptions file c:\tsm\baclient\dsm.opt is used to connect to Tivoli StorageManager. The partner CAD service is TSM CAD.Command:dsmcutil install remoteagent /name:"TSM AGENT" /node:test/password:test /optfile:c:\tsm\baclient\dsm.opt /partnername:"TSM CAD"Note: Both the Remote Client Agent Service and the Client Acceptor Service mustbe installed to run the Web client. The Client Acceptor Service must be installedChapter 10. Client Service Configuration Utility 257

efore the Remote Client Agent Service. Use the /partnername: option to specify thename of the partner Client Acceptor Service.INSTall vmwaretoolsInstalls and configures the VMware tools service. There are no required options.Command:dsmcutil install vmwaretoolsREMoveRemove an installed Client Service. The required option is /name:servicename.TaskTaskRemove the specified scheduler service from the local workstation.Command:dsmcutil remove /name:"TSM Central Scheduler Service"Remove the journaling engine service TSM Journal Service from the localworkstation.Command:dsmcutil remove /name:"TSM Journal Service"REMove vmwaretoolsRemove the VMware tools service. There are no required options.Command:dsmcutil remove vmwaretoolsUPDateUpdates Scheduler Service registry values. The required option for this commandis /name:servicename, and the registry values to update. Other valid options are:v /clientdir:clientdirv /optfile:optionsfilev /eventlogging:[Yes|No]v /node:nodenamev /autostart:[Yes|No]v /clusternode:Yes|No (required if running the MSCS or VCS).v /clustername:clustername (required if running the MSCS or VCS).TaskUpdate the client directory and options file for the specified schedulerservice. All required client service files must reside in the specifieddirectory.Note: The communication options specified with the dsmcutil commandhere take precedence over those specified in the client options file.Command:dsmcutil update /name:"TSM Central Scheduler Service"/clientdir:c:\tsmptf3\baclient /optfile:c:\tsmptf3\baclient\dsm.opt258 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

TaskUpdate the specified scheduler service to use the TCP/IP protocol toconnect to a Tivoli Storage Manager server at the specified host name onthe specified port.Command:dsmcutil update /name:"TSM Central Scheduler Service"/commserver:nt1.sanjose.com /commport:1521 /commmethod:tcpipUPDate CADUpdates Client Acceptor Service registry values. The required option for thiscommand is /name:servicename, and the registry values to update. Other validoptions are:v /node:nodenamev /password:passwordv /optfile:optionsfilev /httpport:httpportv /webports:webportsv /cadschedname:schedulernameTaskUpdate the Client Acceptor Service to use the specified client passwordand options file. All required client service files must reside in the specifieddirectory.Command:dsmcutil update cad /name:"TSM CAD" /password:test/optfile:c:\tsm\baclient\dsm.optUPDate REMOTEAgentUpdates Remote Client Agent Service registry values. The required option for thiscommand is /name:servicename, and the registry values to update. Other validoptions are:v /node:nodenamev /password:passwordv /optfile:optionsfilev /partnername:partner service nameTaskUpdate a Remote Client Agent Service called TSM AGENT. TSM AGENTuses a node called test to connect to the Tivoli Storage Manager server. Theoptions file c:\tsm\baclient\dsm.opt is used to connect to Tivoli StorageManager. The partner CAD service is TSM CAD.Command:dsmcutil update remoteagent /name:"TSM AGENT" /node:test/password:test /optfile:c:\tsm\baclient\dsm.opt /partnername:"TSM CAD"Query SchedulerQuery Scheduler Service registry values. Required options are: /name:servicename.Other valid options are:v /machine:machinenamev /clientdirv /optfileChapter 10. Client Service Configuration Utility 259

vvvvvvv/eventlogging/node/commmethod/commport/commserver/errorlog/schedlogNote: Do not specify a value for the non-required options. Tivoli Storage Managerreturns option registry values for the scheduler service you specify.TaskTaskQuery registry settings for the scheduler service you specify.Command:dsmcutil query /name:"TSM Central Scheduler Service"Query the client directory registry setting for the scheduler service youspecify.Command:dsmcutil query /name:"TSM Central Scheduler Service"Query CADQueries Client Acceptor Service registry values. The required option for thiscommand is /name:servicename. Other valid options are:v /machine:machinenamev /nodev /optfilev /httpportv /webportsv /clientdirv /partnernameNote: Do not specify a value for these options.TaskQuery registry settings for the Client Acceptor Service you specify.Command:dsmcutil query cad /name:"TSM CAD"Query JournalQuery the journaling engine service, TSM Journal Service on a Windows (32-bit).There are no valid options for this command.TaskQuery the journaling engine service, TSM Journal Service.Command:dsmcutil query journalQuery REMOTEAgentQueries Remote Client Agent Service registry values. The required option for thiscommand is /name:servicename. Other valid options are:v /machine:machinename260 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvv/node/optfile/partnername/clientdirNote: Do not specify a value for these options.TaskQuery registry settings for the specified Remote Client Agent Service.Command:dsmcutil query remoteagent /name:"TSM AGENT"ListLists installed Client Services. There are no required options.TaskTaskLocate and list the installed Tivoli Storage Manager client services on thelocal workstation.Command:dsmcutil listList the installed Tivoli Storage Manager client services on remoteworkstation PDC.Command:dsmcutil list /MACHINE:PDCSTARTUse the Start command to start a client service. The Start command requires the/name:servicename option.TaskStart the journaling engine service, TSM Journal Service.Command:dsmcutil start /name:"TSM Journal Service"STOPUse the Stop command to stop a client service. The Stop command requires the/name:servicename option.TaskStop the journaling engine service, TSM Journal Service.Command:dsmcutil stop /name:"TSM Journal Service"UPDATEPWGenerate encrypted Tivoli Storage Manager registry password. The UPDATEPWcommand requires the /node:nodename and /password:password options. Optionally,you can use the following options:v /validate:[Yes|No]v /clusternode:Yes|No (required if running the MSCS or VCS).v /clustername:clustername (required if running the MSCS or VCS).v /force:[Yes|No]Chapter 10. Client Service Configuration Utility 261

The password is validated with the Tivoli Storage Manager server if the/validate:Yes option is specified. The password is updated on the server if youspecify the /updateonserver:Yes option. If you specify this option, you must specifythe current password with the /oldpassword option.TaskUpdate the encrypted registry password for the specified node. Validateand update the password on the specified Tivoli Storage Manager serverwhich resides on the specified TCP/IP hostname and port:Command:dsmcutil updatepw /node:alpha1 /commMethod:tcpip/commServer:alpha1.sanjose.ibm.com /commPort:1500/password:newpw /oldpassword:oldpw /updateonserver:yesRelated concepts:“Journal-based backup” on page 121Related tasks:“Dsmcutil valid options”Related reference:“Incremental” on page 579Dsmcutil valid optionsThis section lists the valid dsmcutil options that you can specify to use thescheduler service./autostart:[Yes|No]Specifies whether the Scheduler Service starts automatically at system boottime. The default is No./cadschedname:schedulernameSpecifies the name of the scheduler service to manage with the CAD. Usethis option when the managedservices option is set to schedule in the clientoptions file dsm.opt. You can specify this option only with the CADservice./clientdir:clientdirThe fully qualified directory path where the Client Service files reside. Thisdirectory should be relative to the target workstation where the service isinstalled. UNC names are not allowed if the local system account is set tologon. The default is the current directory./clustername:clusternameThis option replaces the /group option.The /clustername option specifies the cluster name to which the systembelongs. You can determine the cluster name in any of the following ways:vvvOn MSCS, run the MSCS command, CLUSTER /LIST, from thecommand line or use the Cluster Administrator utility. When the ClusterAdministrator utility starts, it displays a tree-like structure with thecluster name at the top.On VCS, use the VCS Cluster Manager - Java Console or open themain.cf file in the %VCS_HOME%\config directory.On VCS, use the following command:haclus -displayRestriction: Do not specify a clustername of more than 64 characters. Ifyou specify more than 64 characters and you are using Veritas Storage262 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Foundation with High Availability or a Microsoft Cluster Serverconfiguration, you might not be able to install or start the Tivoli StorageManager scheduler service.This option must be used with the /clusternode:Yes option. This optionmust be specified when using the INSTALL command in a clusterenvironment. It must also be specified when using the UPDATE commandto modify the cluster settings (/clusternode and /clustername).This option can also be specified when using the UPDATEPW command ina cluster environment. Normally this is not required. However, if morethan one scheduler service with different cluster settings are defined for aparticular node, the utility cannot determine which settings are correct. Inthis case, correct the discrepancies between the services.Alternatively, you can specify this option with /clusternode:Yes and/force:Yes, to force the utility to show or update the password with thespecified cluster settings.This option is not required if /clusternode:No is specified./clusternode:Yes|NoSpecifies whether to enable support for cluster resources. The default valueis No. You must be running the MSCS or VCS to specify /clusternode:Yes.This option must be specified when using the INSTALL command in acluster environment. This option must also be specified when using theUPDATE command to modify the cluster settings (/clusternode,/clustername).This option can also be specified when using the UPDATEPW command ina cluster environment. Normally this is not required. However, if morethan one scheduler service with different cluster settings are defined for aparticular node, the utility cannot determine which settings are correct. Inthis case, correct the discrepancies between the services.Alternatively, you can specify this option with /clustername and /force:Yes,to force the utility to show or update the password with the specifiedcluster settings. If /clusternode:No is specified, /clustername is not required./commmethod:protocolSpecifies client communications protocol to communicate with a TivoliStorage Manager server. Valid protocols are: TCP/IP and Named Pipes. Ifyou do not specify a value, the value is obtained from the client optionsfile or set to the default client value. You can also use this option with theUPDATEPW command to specify a communication protocol to connect toa server when updating passwords./commport:serverportSpecifies the protocol specific Tivoli Storage Manager server port. ForTCP/IP, this is the port on the specified hostname. If this option is notspecified, the value is obtained from the client options file or set to thedefault client value. You can also use this option with the UPDATEPWcommand to specify a protocol specific server port to connect to forupdating passwords./commserver:servernameSpecifies the protocol specific Tivoli Storage Manager server name.Depending on the protocol used, this can be a TCP/IP hostname or aNamed Pipes name. If not specified, the value is obtained from the clientoptions file or set to the default client value.Chapter 10. Client Service Configuration Utility 263

This option can also be used with the UPDATEPW command to specify aprotocol specific server name to connect to for updating passwords./copyfilesSpecifies that the service installation is copied to another location prior toinstalling the service. Use the /srcdir option to specify the fully qualifiedsource path./errorlog:errorlogSpecifies the fully qualified name of the client error log./eventlogging:[Yes|No]Turns detailed event logging on or off for the specified scheduler service.The default is Yes./force:[Yes|No]This option can also be specified when using the UPDATEPW command ina cluster environment. Normally this is not required. However, if morethan one scheduler service with different cluster settings is defined for aparticular node, the utility cannot determine which settings are correct. Inthis case, correct the discrepancies between the services.Alternatively, you can specify this option with /clusternode and/clustername (if /clusternode:Yes is specified), to force the utility to show orupdate the password with the specified cluster settings./httpport:httpportSpecifies a TCP/IP port address for the Web client./machine:machinenameSpecifies the name of a remote workstation to connect to./name:servicenameSpecifies the name of the Client service. The name must be quote delimitedif it contains embedded spaces./node:nodenameSpecifies the Tivoli Storage Manager node name the Client Service useswhen connecting to the Tivoli Storage Manager server. Also used whendisplaying or updating the Tivoli Storage Manager registry password. Thedefault is the workstation name./ntaccount:ntaccountSpecifies the Windows account which the service logs in as./ntdomain:ntdomainSpecifies the Windows domain which the service logs in as./ntpassword:ntpasswordSpecifies the Windows password for the account under which the servicelogs in./oldpassword:oldpwCurrent ® Tivoli Storage Manager server password. Used in conjunctionwith the /updateonserver option when updating a password on the server./optfile:optionsfileThe fully qualified path of the Tivoli Storage Manager options file. This isthe options file the specified Client Service uses to connect to TivoliStorage Manager. The utility also uses the file to connect to Tivoli StorageManager to validate and update passwords. Note that although this optionoverrides the default option file in the current directory (dsm.opt), theTivoli Storage Manager API requires that a default option file exists in the264 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

current directory. UNC names are not allowed if the local system accountis set to logon. The default is the dsm.opt file in the /clientdir directory./partnername:partner service nameThis option is used when installing a Remote Client Agent Service tospecify the partner Client Acceptor Service./password:passwordThe Tivoli Storage Manager password which is generated (encrypted) intothe Windows Registry./schedlog:schedlogSpecifies the fully qualified name of the client schedule log./srcdir:pathnameUse this option in conjunction with the /copyfiles option to specify thefully qualified source path to copy the service installation to anotherlocation prior to installing the service./startnow:[Yes|No]Specifies whether dsmcutil starts the specified service after executing thecommand; the default is Yes. If you specify No, you must start the servicemanually using the services control panel applet, or the NET START nameof the Tivoli Storage Manager service./updateonserver:[Yes|No]Specifies whether the specified password is updated on the Tivoli StorageManager server. Requires using the /oldpassword option./validate:[Yes|No]Specifies whether to perform validation when displaying or updating theencrypted registry password. The default is Yes./webports: webportsSpecifies the TCP/IP port number used by the Tivoli Storage ManagerClient Acceptor service and the Tivoli Storage Manager Web client agentservice for communications with the Web GUI.Chapter 10. Client Service Configuration Utility 265

266 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 11. Processing optionsProcessing options overviewYou can use defaults for processing options or you can tailor the processingoptions to meet your specific needs. This topic provides an overview of processingoptions and an options reference section that provides detailed information abouteach option.Related concepts:“Using options with commands” on page 286Related information:Reading syntax diagramsThis section provides an overview of the types of options that you can use.Tivoli Storage Manager uses processing options that you specify in your clientsystem-options file (dsm.opt) or on the command line to control communications,backup-archive processing, and other types of processing.v Communication optionsv Node optionsv Backup and archive processing optionsv Restore and retrieve processing optionsv Scheduling optionsv Format and language optionsv Command processing optionsv Authorization optionsv Error processing optionsv Transaction processing optionv Web client optionsv Diagnostics optionsTivoli Storage Manager also includes a group of client command options that youcan enter only on the command line with specific commands. You can overridesome of the options in your options file by entering them with appropriatebackup-archive commands.Note: Some of the processing options used by the Tivoli Storage Manager centralscheduler are defined in the Windows registry when the schedule services areconfigured. These options can also be specified in the client options file. When thescheduler runs as a service, processing options specified in the registry overridethe same options specified in the client options file.© Copyright IBM Corp. 1993, 2012 267

Communication optionsRelated concepts:“Entering options with a command” on page 287Related tasks:“Creating and modifying the client options file” on page 27You use communication options to specify how your client node communicateswith a Tivoli Storage Manager server. This topic provides information about thetypes of communication options you can use.For all Windows clients, use one of the following protocols:v TCP/IPv Named pipesv Shared memoryUse the commmethod option to specify the communication protocol.Ask your Tivoli Storage Manager administrator for assistance in setting yourcommunication options.Related reference:“Commmethod” on page 317TCP/IP optionsTo use the TCP/IP communication protocol, you must include thetcpserveraddress option in your client options file.The other TCP/IP options have default values that you can modify if you want tochange the default value. This topic provides information about the types ofcommunication options you can use.Table 40. TCP/IP optionsOptionhttpport “Httpport” on page388lanfreetcpport“Lanfreetcpport” on page 409lanfreetcpserveraddress“Lanfreetcpserveraddress”on page 411tcpbuffsize “Tcpbuffsize”on page 497tcpnodelay “Tcpnodelay” onpage 500tcpadminport “Tcpadminport”on page 496tcpcadaddress“Tcpcadaddress” on page 498tcpport “Tcpport” on page501DescriptionSpecifies a TCP/IP port address for the Tivoli StorageManager Web client.Specifies the TCP/IP port number where the Tivoli StorageManager storage agent is listening.Specifies the TCP/IP address for the Tivoli Storage Managerstorage agent.Specifies the size, in kilobytes, of the Tivoli Storage Managerinternal TCP/IP communication buffer.Specifies whether the server or client disables the delay ofsending successive small packets on the network.Specifies a separate TCP/IP port number on which theserver is waiting for requests for administrative clientsessions, allowing secure administrative sessions within aprivate network.Specifies a TCP/IP address for dsmcad.Specifies the TCP/IP port address for a Tivoli StorageManager server.268 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 40. TCP/IP options (continued)OptionDescriptiontcpserveraddress“Tcpserveraddress” on page501tcpwindowsize“Tcpwindowsize” on page 502webports “Webports” on page534Specifies the TCP/IP address for a Tivoli Storage Managerserver.Specifies the size, in kilobytes, of the TCP/IP slidingwindow for your client node.Enables the use of the Web client outside a firewall byspecifying the TCP/IP port number used by the ClientAcceptor service and the Web Client Agent service forcommunications with the Web GUI.Named Pipes optionThis topic provides information about the namedpipename communication option.Table 41. Named Pipes communication optionOptionDescriptionnamedpipename“Namedpipename” on page 424Specifies the name of a named pipe to use forcommunications between a Tivoli Storage Manager clientand server on the same Windows server domain.Shared memory optionsThis topic provides information on the shared memory options that you can use.Table 42. Shared memory communication optionsOptionDescriptionlanfreeshmport“Lanfreeshmport” on page 409lanfreeshmport “Shmport” onpage 470Specifies the unique number that is used by the client andthe storage agent to identify shared memory area used forcommunications.Specifies the unique number that is used by the client andthe server to identify shared memory area used forcommunications.Server and node optionsThis topic provides information about the server to contact for backup-archiveservices, and the client node to request backup-archive services.Table 43. Server and node optionsOptionDescriptionasnodename “Asnodename” onpage 296nasnodename “Nasnodename”on page 425nodename “Nodename” on page426Use the asnodename option to allow agent nodes to back upor restore data on behalf of another node (the target node).This enables concurrent operations from multiple nodes tostore data to the same target node and file space in parallel.Specifies the node name for the NAS file server whenprocessing NAS file systems.Use the nodename option in your dsm.sys file to identifyyour workstation to the server to establish communications.Chapter 11. Processing options 269

Table 43. Server and node options (continued)OptionDescriptionvirtualnodename“Virtualnodename” on page514The virtualnodename option specifies the node name of yourworkstation when you want to restore or retrieve files to adifferent workstation.Node optionsThis topic explains the node options that you can use to request backup-archiveservices.Table 44. Node optionsOptionasnodename “Asnodename” onpage 296clusterdisksonly“Clusterdisksonly” on page312clusternode “Clusternode”on page 315nasnodename “Nasnodename”on page 425nodename “Nodename” on page426virtualnodename“Virtualnodename” on page514DescriptionUse the asnodename option to allow agent nodes to back upor restore data on behalf of another node (the target node).This enables concurrent operations from multiple nodes tostore data to the same target node and file space in parallel.Specifies whether the Tivoli Storage ManagerBackup-Archive client allows the backup of only clustereddisks, when running in a Microsoft Cluster Server (MSCS)or VERITAS Cluster Server (VCS) environment and usingthe clusternode=yes processing option.Specifies whether Tivoli Storage Manager manages clusterdrives in a Microsoft Cluster Server (MSCS) or VeritasCluster Server (VCS) environment.Specifies the node name for the NAS file server whenprocessing NAS file systems.Use the nodename option in your client options file dsm.optto identify your workstation to the server to establishcommunications.The virtualnodename option specifies the node name of yourworkstation when you want to restore or retrieve files to adifferent workstation.Backup and archive processing optionsThis topic describes the options that you can use to control some aspects of backupand archive processing.Table 45. Backup and archive processing optionsOptionarchmc“Archmc” on page 295asnodename“Asnodename” on page 296DescriptionUse the archmc option with the archivecommand to specify the availablemanagement class for your policydomain to which you want to bind yourarchived files.Use the asnodename option to allowagent nodes to back up or restore dataon behalf of another node (the targetnode). This enables concurrentoperations from multiple nodes to storedata to the same target node and filespace in parallel.270 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 45. Backup and archive processing options (continued)OptionDescriptionautofsrename“Autofsrename” on page 304backmc“Backmc” on page 306changingretries“Changingretries” on page 310class“Class” on page 310compressalways“Compressalways” on page 320compression“Compression” on page 320createnewbase“Createnewbase” on page 323deduplication“Deduplication” on page 329dedupcachepath“Dedupcachepath” on page 328dedupcachesize“Dedupcachesize” on page 329domain.vmfile“Domain.vmfile” on page 345domain.vmfull“Domain.vmfull” on page 348Specifies whether to rename an existingfile space on a Unicode-enabled serverso a Unicode-enabled file space can becreated for the current operation.Specifies the Tivoli Storage Managermanagement class to apply to thebackup fastback subcommand forretention purposes.Specifies the number of times a back upor archive action is retried on a file thatis in use.Specifies whether to list the NAS orclient Application Server objects duringa query backup, query filespace, ordelete filespace operation.The compressalways option specifieswhether to continue compressing anobject if it grows during compression.Use this option with the compressionoption.The compression option compresses filesbefore you send them to the server.Compressing your files reduces datastorage for backup versions and archivecopies of your files.The createnewbase option creates a basesnapshot and uses it as a source to runa full incremental. This ensures that thebackup of any files that might havebeen skipped during the snapshotdifference incremental.Specifies whether to eliminateredundant data on the client side whentransferring data to theTivoli StorageManager server, during backup orarchive processing.Specifies the location where theclient-side data deduplication cachedatabase is created, if theenablededupcache=yes option is setduring backup or archive processing.Determines the maximum size of thedata deduplication cache file.Specifies the virtual machines to includein your backup vm file-level VMwareConsolidated Backup operations.Specifies the virtual machines to includein your backup vm full VM imageVMware Consolidated Backupoperations.Chapter 11. Processing options 271

Table 45. Backup and archive processing options (continued)OptionDescriptionenablededupcache“Enablededupcache” on page 355deletefiles“Deletefiles” on page 331description“Description” on page 331detail“Detail” on page 332diffsnapshot“Diffsnapshot” on page 334dirmc“Dirmc” on page 336dirsonly“Dirsonly” on page 337diskcachelocation“Diskcachelocation” on page 339domain“Domain” on page 340domain.image“Domain.image” on page 343domain.nas“Domain.nas” on page 344enablearchiveretentionprotection“Enablearchiveretentionprotection” on page 354Specifies whether you want to enableclient-side data deduplication cache, sothat Tivoli Storage Manager gets thechanged data from the cache.Use the deletefiles option with thearchive command to delete files fromyour workstation after you archivethem.You can also use this option with therestore image command and theincremental option to delete files fromthe restored image if they were deletedafter the image was created.The description option assigns orspecifies a description for files whenperforming archive, delete, retrieve,query archive, or query backupsetoperations.Use the detail option to listmanagement class, file space, backup,and archive information depending onthe command with which it is used.Use the diffsnapshot option todetermine whether Tivoli StorageManager creates a differential snapshot.Specifies the management class to usefor directories. If you do not specify thisoption, the client uses the managementclass in the active policy set of yourpolicy domain with the longestretention period.Backs up, restores, archives, retrieves, orqueries directories only.Specifies the location where the diskcache database is created if the optionmemoryefficient=diskcachemethodoption is set during an incrementalbackup.Specifies the drives to include in yourdefault client domain for an incrementalbackup.Specifies the file systems and rawlogical volumes that you want toinclude in your client domain for animage backup. This option is only validfor Windows 32-bit clients.Specifies the volumes to include in yourdefault domain for NAS image backups.Allows the client to connect to a dataretention server.272 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 45. Backup and archive processing options (continued)OptionDescriptionenablelanfree“Enablelanfree” on page 357excludeexclude.backupexclude.fileexclude.file.backupencryptiontype“Encryptiontype” on page 358encryptkey“Encryptkey” on page 359exclude.archive“Exclude options” on page 365exclude.compression“Exclude options” on page 365exclude.dir“Exclude options” on page 365exclude.encrypt“Exclude options” on page 365exclude.fs.nas“Exclude options” on page 365exclude.image“Exclude options” on page 365exclude.subfile“Exclude options” on page 365exclude.systemservice“Exclude options” on page 365fbbranch“Fbbranch” on page 372fbclientname“Fbclientname” on page 373Specifies whether to enable an availableLAN-free path to a storage areanetwork (SAN) attached storage device.Use these options to exclude a file orgroup of files from backup services.Allows you to select AES 128 bit dataencryption, providing a stronger form ofdata encryption than DES 56 bit dataencryption.Specifies whether to save the encryptionkey password locally when performinga backup-archive operation or whetherto prompt for the encryption keypassword.Excludes a file or a group of files thatmatch the pattern from archive servicesonly.Excludes files from compressionprocessing if you set the compressionoption to yes. This option applies tobackups and archives.Excludes a directory, its files, and all itssubdirectories and their files frombackup processing.Excludes specified files from encryptionprocessing.Excludes file systems on the NAS fileserver from an image backup whenused with the backup nas command.Excludes mounted file systems and rawlogical volumes that match the specifiedpattern from full image backupoperations. Incremental image backupoperations are unaffected byexclude.image.Excludes files from adaptive subfilebackup processing. This option does notapply to archive processing.Excludes individual system servicescomponents from backup services. Inputcan be the keyword or component nameto be excluded from back up.Specifies the branch ID of the remoteFastBack server to back up or archive.Specifies the name of one or moreFastBack clients to back up from thebackup proxy.Chapter 11. Processing options 273

Table 45. Backup and archive processing options (continued)OptionDescriptionfbpolicyname“Fbpolicyname” on page 374fbreposlocation“Fbreposlocation” on page 376fbserver“Fbserver” on page 377fbvolumename“Fbvolumename” on page 378filelist“Filelist” on page 380filesonly“Filesonly” on page 383groupname“Groupname” on page 387guitreeviewafterbackup“Guitreeviewafterbackup” on page 387ieobjtype“Ieobjtype” on page 390imagegapsize“Imagegapsize” on page 391inclexcl“Inclexcl” on page 394“Include options” on page 395includeinclude.backupinclude.fileinclude.archive“Include options” on page 395Specifies the name of one or more TivoliStorage Manager FastBack policies thatyou want to back up from the backupproxy.Specifies the location of the TivoliStorage Manager FastBack repository forthe Tivoli Storage Manager client proxyto connect to issue MOUNT DUMP,MOUNT ADD and MOUNT DELcommands.Specifies host name of the FastBackserver workstation or the FastBack DRHub workstation that owns therepository specified by thefbreposlocation option.Specifies the name of one or more TivoliStorage Manager FastBack volumes toback up from the backup proxy.Specifies a list of files to be processedfor the command. Tivoli StorageManager opens the designated filelistand processes the files listed withinaccording to the command.Backs up, restores, retrieves, or queriesfiles only.Use this option with the backup groupcommand to specify the fully qualifiedname of the group leader for a group.Specifies whether the client GUI isreturned to the Backup, Restore,Archive, or Retrieve window after anoperation finishes.Specifies an object type for a client-sidedata deduplication operation. Thisoption is used with the include.dedupand exclude.dedup options.Specifies the minimum size of emptyregions on a volume that you want toskip during backup. This option is validfor Windows 32-bit clients.Specifies the path and file name of aninclude-exclude options file.Use these options to include files orassign management classes for backupprocessing.Includes files or assigns managementclasses for archive processing.274 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 45. Backup and archive processing options (continued)OptionDescriptioninclude.compression“Include options” on page 395include.encrypt“Include options” on page 395include.fs“Include options” on page 395include.fs.nas“Include options” on page 395include.image“Include options” on page 395include.subfile“Include options” on page 395include.systemstate“Include options” on page 395incrbydate“Incrbydate” on page 404incremental“Incremental” on page 405Includes files for compressionprocessing if you set the compressionoption to yes. This option applies tobackups and archives.Includes the specified files forencryption processing. By default, TivoliStorage Manager does not performencryption processing.Use the include.fs option to specifyprocessing options for a given filesystem. Use the include.fs option tospecify which drives use open filesupport and to control how full filespace incremental backups areprocessed.Use the include.fs.nas option to bind amanagement class to Network AttachedStorage (NAS) file systems. You can alsospecify whether Tivoli Storage Managersaves Table of Contents (TOC)information during a NAS file systemimage backup, using the toc optionwith the include.fs.nas option in yourclient options file (dsm.opt). See “Toc”on page 505 for more information.Specifies a file system or logical volumeto be included for image backupprocessing. This option also provides away to specify an explicit managementclass assignment for a specified filesystem or logical volume. The backupimage command ignores all otherinclude options. Use the include.fsoption to specify which drives use openfile support and to control how full filespace incremental backups areprocessed.Includes files for adaptive subfilebackup processing. This option does notapply to archive processing.Assigns management classes for backup of the Windows system state. Thedefault is to bind the system object tothe default management class.Use with the incremental command torequest an incremental backup by date.Use with the restore image command toensure that any changes that were madeto the base image are also applied to therestored image.Chapter 11. Processing options 275

Table 45. Backup and archive processing options (continued)OptionDescriptionincrthreshold“Incrthreshold” on page 406memoryefficientbackup“Memoryefficientbackup” on page 419mode“Mode” on page 420monitor“Monitor” on page 424noprompt“Noprompt” on page 428nojournal“Nojournal” on page 427optfile“Optfile” on page 430The 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.Specifies a memory-saving backupalgorithm for incremental backups whenused with the incremental command.Use the mode option with thesecommands, as follows:backup imageTo specify whether to performa selective or incrementalimage backup of client filesystems.backup nasTo specify whether to performa full or differential imagebackup of NAS file systems.backup groupTo specify whether to performa full or differential groupbackup containing a list of filesfrom one or more file spaceorigins.backup vmTo specify whether to performa full or incremental backup ofa VMware virtual machinewhen vmbackuptype=fullvm andwhen you have installed IBMTivoli Storage Manager forVirtual Environments.Specifies whether you want to monitoran image backup of file systemsbelonging to a Network AttachedStorage (NAS) file server.suppresses the confirmation prompt thatis presented by the delete group, deletearchive, expire, restore image, and setevent commands.Use this option with the incrementalcommand to specify that you want toperform the traditional full incrementalbackup, instead of the defaultjournal-based backup.Specifies the client options file you wantto use when you start a Tivoli StorageManager session.276 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 45. Backup and archive processing options (continued)OptionDescriptionpostsnapshotcmd“Postsnapshotcmd” on page 438preservelastaccessdate“Preservelastaccessdate” on page 441presnapshotcmd“Presnapshotcmd” on page 445resetarchiveattribute“Resetarchiveattribute” on page 451skipntpermissions“Skipntpermissions” on page 472skipntsecuritycrc“Skipntsecuritycrc” on page 472snapdiff“Snapdiff” on page 473snapshotproviderfs“Snapshotproviderfs” on page 478snapshotproviderimage“Snapshotproviderimage” on page 479During an online image backup or openfile support operation, this optionallows you to manually open anapplication after the snapshot providerstarts a snapshot. This option is onlyvalid if the OFS or online imagesupport is enabled.Use this option during a backup orarchive operation to specify whether toreset the last access date of anyspecified files to their original valuefollowing a backup or archiveoperation. By default, the Tivoli StorageManager client does not reset the lastaccess date of any backed up orarchived files to their original valuebefore the backup or archive operation.During an online image backup or openfile support operation, this optionallows you to manually quiesce anapplication before the snapshot providerstarts a snapshot. This option is onlyvalid if the OFS or online imagesupport is enabled.Specifies whether Tivoli StorageManager resets the Windows archiveattribute on files that are successfullybacked up to a Tivoli Storage Managerserver. This option is valid for allWindows clients.Specifies whether to back up, archive,retrieve, or restore Windows securityinformation.Specifies whether to compute thesecurity CRC for permission comparisonduring subsequent backups. Use thisoption on all Windows clients.Specifies an incremental backup of thefiles reported as changed by NetApp,instead of scanning the volume lookingfor files that have changed. Use thisoption with a NAS full volumeincremental backup.Use the snapshotproviderfs option toenable snapshot-based file backup andarchive operations, and to specify asnapshot provider.Use the snapshotproviderimage optionto enable snapshot-based online imagebackup, and to specify a snapshotprovider.Chapter 11. Processing options 277

Table 45. Backup and archive processing options (continued)OptionDescriptionsnapshotroot“Snapshotroot” on page 479subdir“Subdir” on page 489subfilebackup“Subfilebackup” on page 491subfilecachepath“Subfilecachepath” on page 492subfilecachesize“Subfilecachesize” on page 493tapeprompt“Tapeprompt” on page 495toc“Toc” on page 505type“Type” on page 509v2archive“V2archive” on page 511virtualfsname“Virtualfsname” on page 513(does not apply to Mac OS X)Use the snapshotroot option with theincremental, selective, orarchivecommands in conjunction with aindependent software vendorapplication that provides a snapshot ofa logical volume, to associate the dataon the local snapshot with the real filespace data that is stored on the TivoliStorage Manager server.Specifies whether to includesubdirectories of a named directory.Specifies whether Tivoli StorageManager uses adaptive subfile backup.Specifies the path where the client cacheresides for adaptive subfile backupprocessing.Specifies the client cache size foradaptive subfile backup.Specifies whether you want TivoliStorage Manager to wait for a tapemount if it is required for a backup,archive, restore, or retrieve process, orto be prompted for a choice.Use the toc option with the backup nascommand or the include.fs.nas optionto specify whether Tivoli StorageManager saves Table of Contents (TOC)information for each file system backup.If you save TOC information, you canuse the query toc server command todetermine the contents of a file systembackup in conjunction with the restorenode server command to restoreindividual files or directory trees. Youcan also use the Tivoli Storage ManagerWeb client to examine the entire filesystem tree and select files anddirectories to restore.Use the type option with the querynode command to specify the type ofnode to query.Use the v2archive option with thearchive command to archive only filesto the server. Tivoli Storage Managerwill not process directories that exist inthe path of the source file specification.Use this option with the backup groupcommand to specify the name of thecontainer for the group on which youwant to perform the operation.278 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 45. Backup and archive processing options (continued)Optionvmchost“Vmchost” on page 520vmcpw“Vmcpw” on page 521vmcuser“Vmcuser” on page 522vmlist“Vmlist” on page 526DescriptionUsed with the backup VM, restore VM,or query VM commands to specify thehost name of the VMware VirtualCenteror ESX server where the VMwareConsolidated Backup commands aredirected.Used with the backup VM, restore VM,or query VM commands to specify thepassword of the VirtualCenter or ESXuser specified with the vmcuser option.Used with the backup VM, restore VM,or query VM commands to specify theuser name of the VMware VirtualCenteror ESX server where the VMwareConsolidated Backup commands aredirected.Used with the backup VM, restore VM,or query VM commands to specify thehost name or list of host names of thevirtual machine to back up.The following options are Backup-Archive Client options that apply only to HSMfor Windows migrated files. Refer to IBM Tivoli Storage Manager for HSM forWindows Administration Guide for details about these options:v Restorecheckstubaccessv Restoremigstatev SkipmigratedRestore and retrieve processing optionsThis topic describes the options that you can use for restoring and retrieving.Table 46 lists the restore and retrieve processing options that are available.Table 46. Restore and retrieve processing optionsOptionasrmode “Asrmode” on page 297backupsetname “Backupsetname”on page 306dirsonly “Dirsonly” on page 337DescriptionUse this option with the restore, and restore systemstatecommands to specify whether to perform a restoreoperation in system ASR recovery mode. This option isused in the context of restore commands generated inthe asr.sif file by the backup asr command only. Thisoption should not be used outside the context of ASRrecovery mode.The backupsetname option specifies either the name ofthe backup set, or the name of the file or tape devicecontaining the backup set. This option is used inconjunction with the location option.Qualifies the operation (backup, archive, restore,retrieve) to process directories alone.Chapter 11. Processing options 279

Table 46. Restore and retrieve processing options (continued)OptionDescriptiondisablenqr “Disablenqr” on page338filelist “Filelist” on page 380filesonly “Filesonly” on page383fromdate “Fromdate” on page 384fromnode “Fromnode” on page 385fromtime “Fromtime” on page 386guitreeviewafterbackup“Guitreeviewafterbackup” onpage 387ifnewer “Ifnewer” on page 391imagetofile “Imagetofile” onpage 392inactive “Inactive” on page 393latest “Latest” on page 413localbackupset “Localbackupset”on page 413monitor “Monitor” on page 424noprompt “Noprompt” on page 428optfile “Optfile” on page 430pick “Pick” on page 434Specifies whether the Tivoli Storage ManagerBackup-Archive Client can use the no-query restoremethod for restoring files and directories from theserver.Specifies a file containing a list of files to be processedby the specified command.Qualifies the operation (backup, archive, restore,retrieve) to process files alone.Use the fromdate option with the fromtime option tospecify a date and time from which you want to searchfor backups or archives during a restore, retrieve, orquery operation.Permits one node to perform commands for anothernode. A user on another node must use the set accesscommand to permit you to query, restore, or retrievefiles or images for the other node.Use the fromtime option with the fromdate option tospecify a beginning time from which you want to searchfor backups or archives during a restore, retrieve orquery operation.Specifies whether the client GUI is returned to theBackup, Restore, Archive, or Retrieve window after asuccessful operation completes.Replaces an existing file with the latest backup versiononly if the backup version is newer than the existing file.Use the imagetofile option with the restore imagecommand to specify that you want to restore the sourceimage to a file. You might need to restore the image to afile in the event of bad sectors present on the targetvolume, or if you want to do some manipulations withthe image data.Displays a list of active and inactive files when usedwith the pick option.Restores the most recent backup version of a filewhether it is active or inactive.Specifies whether the Tivoli Storage Manager GUIbypasses initial logon with the server to restore a localbackup set on a stand-alone workstation.Specifies whether you want to monitor an image restoreof one or more file systems belonging to anetwork-attached storage (NAS) file server.suppresses the confirmation prompt that is presented bythe delete group, delete archive, expire, restore image,and set event commands.Specifies the client options file you want to use whenyou start a Tivoli Storage Manager session.Creates a list of backup versions, images, or archivecopies that match the file specification you enter. Fromthe list, you can select the versions to process. Includethe inactive option to view both active and inactiveobjects.280 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 46. Restore and retrieve processing options (continued)Optionpitdate “Pitdate” on page 435pittime “Pittime” on page 436preservepath “Preservepath” onpage 443replace “Replace” on page 450showmembers “Showmembers” onpage 470 (does not apply to MacOS X)subdir “Subdir” on page 489tapeprompt “Tapeprompt” on page495todate “Todate” on page 506totime “Totime” on page 507type “Type” on page 509verifyimage “Verifyimage” onpage 513DescriptionUse the pitdate option with the pittime option toestablish a point in time for which you want to displayor restore the latest version of your backups.Use the pittime option with the pitdate option toestablish a point in time for which you want to displayor restore the latest version of your backups.Specifies how much of the source path to reproduce aspart of the target directory path when you restore orretrieve files to a new location.Specifies whether to overwrite an existing file, or toprompt you for your selection when you restore orretrieve files.Displays all members of a group.Specifies whether you want to include subdirectories ofa named directory.Specifies whether you want Tivoli Storage Manager towait for a tape required for a restore or retrieve to bemounted, or to prompt you for your choice.Use the todate option with the totime option to specifyan ending date and time to which you want to searchfor backups or archives during a restore, retrieve, orquery operation.Use the totime option with the todate option to specifyan ending date and time to which you want to searchfor backups or archives during a restore, retrieve, orquery operation.Use the type option with the query node command tospecify the type of node to query.Use the verifyimage option with the restore imagecommand to specify that you want to enable detectionof bad sectors on the destination target volume. If badsectors are detected on the target volume, Tivoli StorageManager issues a warning message on the console andin the error log.The following options are Backup-Archive Client options that apply only to HSMfor Windows migrated files. Refer to IBM Tivoli Storage Manager for HSM forWindows Administration Guide for details about these options:v Restorecheckstubaccessv Restoremigstatev SkipmigratedChapter 11. Processing options 281

Scheduling optionsThis topic discusses the options that you can use to regulate central scheduling.Tivoli Storage Manager uses scheduling options only when the Scheduler isrunning.Table 47 lists the scheduling options that are available.Table 47. Scheduling optionsOptionmanagedservices “Managedservices” on page414maxcmdretries “Maxcmdretries” on page 416postschedulecmd/postnschedulecmd“Postschedulecmd/Postnschedulecmd” onpage 437preschedulecmd/prenschedulecmd“Preschedulecmd/Prenschedulecmd” on page440queryschedperiod “Queryschedperiod” onpage 446retryperiod “Retryperiod” on page 455runasservice “Runasservice” on page 456schedcmddisabled “Schedcmddisabled” onpage 457schedlogmax “Schedlogmax” on page 459schedlogname “Schedlogname” on page 461schedlogretention “Schedlogretention” onpage 462schedmode “Schedmode” on page 464schedrestretrdisabled“Schedrestretrdisabled” on page 465DescriptionSpecifies whether the Storage Manager clientacceptor service manages the Web client, thescheduler, or both.Specifies the maximum number of times theclient scheduler attempts to process ascheduled command that fails.Specifies a command to process after runninga schedule.Specifies a command to process beforerunning a schedule.Specifies the number of hours the clientscheduler waits between attempts to contactthe server for scheduled work.Specifies the number of minutes the clientscheduler waits between attempts to processa scheduled command that fails or betweenunsuccessful attempts to report results to theserver.Forces the client command process tocontinue running, even if the account thatstarted the client logs off. Use this option onall Windows clients.Specifies whether to disable the schedulingof generic commands specified by yourTivoli Storage Manager administrator.Specifies the maximum size of the schedulerlog and Web client log, in megabytes.Specifies the path and file name where youwant to store schedule log information.Specifies the number of days to keep log fileentries in the schedule log and the Web clientlog, and whether to save pruned entries.Specifies which schedule mode to use, pollingor prompted.Specifies whether to prevent the TivoliStorage Manager Server administrator fromexecuting restore or retrieve scheduleoperations.282 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 47. Scheduling options (continued)Optionsessioninitiation “Sessioninitiation” onpage 468srvprepostscheddisabled“Srvprepostscheddisabled” on page 483srvprepostsnapdisabled“Srvprepostsnapdisabled” on page 484tcpclientaddress “Tcpclientaddress” onpage 498tcpclientport “Tcpclientport” on page 499DescriptionUse the sessioninitiation option to controlwhether the server or client initiates sessionsthrough a firewall. The default is that theclient can initiate sessions.Specifies whether to prevent the TivoliStorage Manager Server administrator fromexecuting pre-schedule and post-schedulecommands when performing scheduledoperations.Specifies whether to prevent the TivoliStorage Manager Server administrator fromexecuting pre-snapshot and post-snapshotcommands when performing scheduledimage snapshot backup operations.Specifies a TCP/IP address if your clientnode has more than one address, and youwant the server to contact an address otherthan the one that was used to make the firstserver contact. The server uses this addresswhen it begins the server promptedscheduled operation. See schedmode prompted(“Schedmode” on page 464) for details.Specifies a TCP/IP port number for theserver to contact the client when the serverbegins the server prompted scheduledoperation. See schedmode prompted(“Schedmode” on page 464) for details.Format and language optionsFormat and language options allow you to select different formats for date, time,numbers, and for different languages if you have the appropriate client languagepack installed for that language.Table 48. Format and language optionsOptionDescriptiondateformat “Dateformat” on Specifies the format for displaying dates.page 326language “Language” on page Specifies the language used for messages.412numberformat “Numberformat” Specifies the format for displaying numbers.on page 429timeformat “Timeformat” on Specifies the format for displaying time.page 503Command processing optionsThis topic explains the options that you can use with the Tivoli Storage Managercommands.Chapter 11. Processing options 283

Command processing options allow you to control some of the formatting of dataon your terminal screen.Table 49. Command processing optionsOptionDescriptionquiet “Quiet” on page 449 Limits the number of messages that are displayed on yourscreen during processing. This option can be overridden bythe server.scrolllines “Scrolllines” onpage 466scrollprompt “Scrollprompt”on page 467verbose “Verbose” on page 512Specifies the number of lines of information that aredisplayed on your screen at one time. Use this option onlywhen scrollprompt is set to yes.Specifies whether you want Tivoli Storage Manager to stopand wait after displaying the number of lines ofinformation you specified with the scrolllines option, orscroll through and stop at the end of the information list.Specifies that processing information should be displayedon your screen. The alternative is quiet. This option can beoverridden by the server.Authorization optionsAuthorization options control access to a Tivoli Storage Manager server.Table 50 lists the authorization options that are available.Table 50. Authorization optionsOptionautodeploy“Autodeploy” on page302password “Password” on page431passwordaccess“Passwordaccess” on page 433revokeremoteaccess“Revokeremoteaccess” on page456DescriptionSpecifies whether you want to enable or disable anautomatic deployment of the client if a restart is required.Specifies a Tivoli Storage Manager password.Specifies whether you want to use a generated passwordor be prompted for a password each time you start theclient.Restricts an administrator with client access privilegesfrom accessing your workstation through the Web client.Error processing optionsError processing options specify the name of the error log file and how TivoliStorage Manager treats the entries in the log file.Table 51 lists the error processing options that are available.Table 51. Error processing optionsOptionDescriptionerrorlogmax “Errorlogmax” Specifies the maximum size of the error log, in megabytes.on page 360errorlogname “Errorlogname”on page 362Specifies the fully qualified path and file name of the filewhere you want to store information about errors that occurduring processing.284 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 51. Error processing options (continued)OptionDescriptionerrorlogretention“Errorlogretention” on page363Specifies how many days to maintain error log entriesbefore pruning, and whether to save the pruned entries.Transaction processing optionsTransaction processing options control how Tivoli Storage Manager processestransactions between the client and server.Table 52 lists the transaction processing options that are available.Table 52. Transaction processing optionsOptionDescriptioncollocatebyfilespec“Collocatebyfilespec” onpage 316commrestartduration“Commrestartduration” onpage 318commrestartinterval“Commrestartinterval” onpage 319diskbuffsize “Diskbuffsize”on page 338largecommbuffers“Diskbuffsize” on page 338resourceutilization“Resourceutilization” onpage 453txnbytelimit “Txnbytelimit”on page 508usedirectory “Usedirectory”on page 509Specifies that you want the Tivoli Storage Manager client touse only one server session to send objects generated fromone file specification. Setting the collocatebyfilespecoption to yes eliminates interspersing of files from differentfile specifications, by limiting the client to one server sessionper file specification. Therefore, if you store the data to tape,files for each file specification are stored together on onetape (unless another tape is required for more capacity).Specifies the maximum number of minutes you want theclient to try to reconnect to a Tivoli Storage Manager serverafter a communication error occurs.Specifies the number of seconds you want the client to waitbetween attempts to reconnect to a Tivoli Storage Managerserver after a communication error occurs.Specifies the maximum disk I/O buffer size (in kilobytes)that the client can use when reading files.This option has been replaced by the diskbuffsize option.At this time, largecommbuffers is still accepted by the TivoliStorage Manager client in order to ease the transition to thenew option. However, the value specified bylargecommbuffers is ignored in favor of the diskbuffsizesetting.Important: Discontinue the use of largecommbuffersbecause future releases of Tivoli Storage Manager might notaccept this option.Use the resourceutilization option in your client optionsfile dsm.opt to regulate the level of resources the TivoliStorage Manager server and client can use duringprocessing.Specifies the number of kilobytes the client program buffersbefore it sends a transaction to the server.Provides a convenient way to simplify client communicationconfiguration by overriding commmethod parameters set inthe client options file and instead querying the ActiveDirectory for the communication method and server withwhich to connect.Chapter 11. Processing options 285

Web client optionsThis topic describes the options for the Tivoli Storage Manager Web Client.Table 53 lists the Web client options that are available.Table 53. Web client optionsOptionhttpport “Httpport” on page 388managedservices“Managedservices” on page 414revokeremoteaccess“Revokeremoteaccess” on page456webports “Webports” on page 534DescriptionSpecifies a TCP/IP port address for the Web client.Specifies whether the Storage Manager client acceptorservice manages the Web client, the scheduler, or both.Restricts administrator access on a client workstationthrough the Web client.Enables the use of the Web client outside a firewall byspecifying the TCP/IP port number used by the clientacceptor service and the Web Client Agent service forcommunications with the Web client.Diagnostics optionsUse the query systeminfo command to gather Tivoli Storage Manager systeminformation and output this information to a file or the console.The query systeminfo command is intended primarily as a diagnostic aid. You cansubmit the resulting information to technical support personnel for problemdiagnosis.Table 54 lists the diagnostics options that are available.Table 54. Diagnostics optionsOptionconsole “Console” on page 322filename “Filename” on page 382DescriptionUse the console option with the query systeminfocommand to output system information to the console.Use the filename option with the query systeminfocommand to specify a file name in which to store thesystem information.Related reference:“Query Systeminfo” on page 614Using options with commandsYou can override some of the options in your client options file (dsm.opt) file byentering them with appropriate Tivoli Storage Manager commands.Tivoli Storage Manager processes options in the following order (precedence):1. Options defined on the server with server-enforced client options. The serveroverrides 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.286 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

5. Options received from the server with client option sets not set as forced by theserver. The server does not override client values if not forced.6. Default option values.Tivoli Storage Manager also includes a group of client command options that youcan enter only on the command line with specific commands. For a complete list ofcommand-line options, a description, and where to go for more information, seeTable 55 on page 288.Entering options with a commandThis topic lists the general rules for entering options with a command.vvvvvvEnter a command, a dash (–), the option name, an equal sign (=), and the optionvalue or parameter. There should be no spaces on either side of the = sign.Here are examples of this syntax on different clients:dsmc archive -description="Project A" c:\devel\proj1\*For options that do not include parameters, enter a command, a dash (–) and theoption name. For example,dsmc incremental -quietNote: Use a leading dash (-) to indicate that the following text is the name of anoption. If an object name begins with a dash, you must surround it in eithersingle quotation marks (') or quotation marks ("). Most operating systemcommand-line processors strip the quotation marks before submitting thecommand-line arguments to the Tivoli Storage Manager client application. Insuch cases, using escape characters or doubling the quotation marks allows theclient to receive the quoted object name. In loop mode, surround such objects ineither single quotation marks (') or quotation marks (").Enter either the option name, or an abbreviation for the option name. Forexample, to enter the latest option, enter either -lat or -latest. The capitalletters in the syntax of each option indicate the minimum abbreviation for thatoption name.Enter options before or after command parameters. For example, you can enterthe option before or after a file specification:dsmc selective -subdir=yes c:\devel\proj1\*dsmc selective c:\devel\proj1\* -subdir=yesWhen entering several options on a command, separate them with a blankspace.Enclose the value in quotation marks (" ") if the option value that you entercontains a blank space. For example:dsmc archive -description="Project A" c:\devel\proj1\*v Most options that you enter on the command line override the value set in thepreferences file. However, when you use the domain option with the incrementalcommand, it adds to the domain specified in your client options file rather thanoverriding the current value.v The maximum number of bytes for a file name and file path combined is 6255.However, the file name itself cannot exceed 255 bytes and the path leading tothe file cannot exceed 6000 bytes. Furthermore, directory names (including thedirectory delimiter) within a path are limited to 255 bytes. The Unicoderepresentation of a character can occupy several bytes, so the maximum numberof characters that a file name might contain can vary.Table 55 on page 288 lists client command options that you can enter only on thecommand line with specific commands.Chapter 11. Processing options 287

Table 55. Client command optionsCommand option Description Commandsarchmc “Archmc” on page295class “Class” on page 310Use the archmc option with the archive command tospecify the available management class for your policydomain to which you want to bind your archived files.Specifies whether to display a list of NAS objects or clientobjects when using the following commands:archivequery backupdelete filespacequery filespacerestore systemstaterestore backupsetconsole “Console” on page322deletefiles “Deletefiles”on page 331description “Description”on page 331detail “Detail” on page332dirsonly “Dirsonly” onpage 337filelist “Filelist” onpage 380filename “Filename” onpage 382Use the console option with the query systeminfocommand to output system information to the console.Deletes the local copy of files from your workstation afterthey are archived on the server. Can also be used withthe restore image command and the incremental optionto delete files from the restored image that are deletedfrom the file space after the image is created.Assigns or specifies a description for files whenperforming archive, delete, retrieve, or query archiveoperations.Displays management class, file space, backup, andarchive information depending on the command withwhich it is used.Backs up, restores, archives, retrieves, or queriesdirectories only.Specifies a list of files to be processed for the command.Tivoli Storage Manager opens the designated filelist andprocesses the files listed within according to thecommand.Use the filename option with the query systeminfocommand to specify a file name in which to store thesystem information.query systeminfoarchiverestore imagearchivedelete archivequery archivequery backupsetretrievedelete filespacequery archivequery backupquery filespacequery mgmtclassarchiveincrementalquery archivequery backuprestorerestore backupsetretrieveselectivearchivebackup groupdelete archivedelete backupexpireincrementalquery archivequery backuprestoreretrieveselectivequery systeminfo288 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 55. Client command options (continued)Command option Description Commandsfilesonly “Filesonly” onpage 383fromdate “Fromdate” onpage 384fromnode “Fromnode” onpage 385fromtime “Fromtime” onpage 386groupname “Groupname” onpage 387ifnewer “Ifnewer” on page391imagetofile “Imagetofile”on page 392Backs up, restores, retrieves, or queries files only.Use the fromdate option with the fromtime option tospecify a date and time from which you want to searchfor backups or archives during a restore, retrieve, orquery operation.Permits one node to perform commands for anothernode. A user on another node must use the set accesscommand to permit you to query, restore, or retrieve filesor images for the other node.Specifies a beginning time on the specified date. Use withthe fromdate option. This option is ignored if thefromdate option is absent.Specifies the fully qualified name for a group.Replaces existing files with the latest backup version onlyif the backup version is newer than the existing version.Use the imagetofile option with the restore imagecommand to specify that you want to restore the sourceimage to a file. You might need to restore the image to afile in the event of bad sectors present on the targetvolume, or if you want to do some manipulations withthe image data.archiveincrementalquery archivequery backuprestorerestore backupsetretrieveselectivedelete backupquery archivequery backuprestorerestore groupretrievequery archivequery backupquery filespacequery groupquery imagequery mgmtclassrestorerestore grouprestore imageretrievequery archivequery backuprestorerestore groupretrievebackup grouprestorerestore backupsetrestore groupretrieverestore imageChapter 11. Processing options 289

Table 55. Client command options (continued)Command option Description Commandsinactive “Inactive” onpage 393incrbydate “Incrbydate”on page 404incremental “Incremental”on page 405latest “Latest” on page413mode “Mode” on page 420monitor “Monitor” on page424nojournal “Nojournal” onpage 427noprompt “Noprompt” onpage 428optfile “Optfile” on page430Displays a list of active and inactive files when used withthe pick option.Requests an incremental backup by date.Applies changes to the base image using informationfrom incremental backups made after the original imagebackup.Restores the most recent backup version of a file whetherit is active or inactive.Use the mode option with these commands, as follows:backup imageTo specify whether to perform a selective orincremental image backup of client file systems.backup nasTo specify whether to perform a full ordifferential image backup of NAS file systems.backup groupTo specify whether to perform a full ordifferential group backup containing a list offiles from one or more file space origins.Specifies whether you want to monitor an image backupor restore of one or more file systems belonging to aNetwork Attached Storage (NAS) file server.Use this option with the with the incremental commandto specify that you want to perform the traditional fullincremental backup, instead of the default journal-basedbackup.suppresses the confirmation prompt that is presented bythe delete group, delete archive, expire, restore image,and set event commands.Specifies the client options file you want to use when youstart a Tivoli Storage Manager session.delete groupquery backupquery groupquery imagequery nasquery systemstaterestorerestore grouprestore imagerestore nasrestore systemstateincrementalrestore imagerestorerestore groupbackup groupbackup nasbackup imagerestore nasbackup nasrestore nasincrementaldelete archivedelete backupdelete groupexpirerestore imagedsmc.exe290 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 55. Client command options (continued)Command option Description Commandspick “Pick” on page 434 Creates a list of backup versions, images, or archivecopies that match the file specification you enter. Fromthe list, you can select the versions to process. Include theinactive option to view both active and inactive objects.delete archivedelete groupexpirequery nasrestorerestore asrrestore grouprestore imagerestore nasretrievepitdate “Pitdate” on page435pittime “Pittime” on page436preservepath“Preservepath” on page443runasservice“Runasservice” on page456showmembers “Showmembers”on page 470Use the pitdate option with the pittime option toestablish a point in time for which you want to displayor restore the latest version of your backups.Use the pittime option with the pitdate option toestablish a point in time for which you want to displayor restore the latest version of your backups.Specifies how much of the source path to reproduce aspart of the target directory path when you restore orretrieve files to a new location.Forces the client command process to continue running,even if the account that started the client logs off. Usethis option on all Windows clients.Displays all members of a group.query backupquery groupquery imagequery nasquery systemstaterestorerestore grouprestore imagerestore nasrestore systemstateAll query and restoresystem objectcommandsquery backupquery imagequery nasquery systemstaterestorerestore imagerestore nasrestore systemstateAll query andrestore systemobject commandsrestorerestore backupsetrestore groupretrieveschedulequery groupquery systemstaterestore groupChapter 11. Processing options 291

Table 55. Client command options (continued)Command option Description Commandstodate “Todate” on page506totime “Totime” on page507type “Type” on page 509v2archive “V2archive” onpage 511verifyimage “Verifyimage”on page 513virtualfsname“Virtualfsname” on page513Use the todate option with the totime option to specifyan ending date and time to which you want to search forbackups or archives during a restore, retrieve, or queryoperation.Use the totime option with the todate option to specifyan ending date and time to which you want to search forbackups or archives during a restore, retrieve, or queryoperation.Use the type option with the query node command tospecify the type of node to query.Use the v2archive option with the archive command toarchive only files to the server. Tivoli Storage Managerwill not process directories that exist in the path of thesource file specification.Use the verifyimage option with the restore imagecommand to specify that you want to enable detection ofbad sectors on the destination target volume. If badsectors are detected on the target volume, Tivoli StorageManager issues a warning message on the console and inthe error log. This option is only valid for Windows32-bit platforms.Specifies the name of the virtual file space for the groupon which you want to perform the operation.query archivequery backuprestorerestore groupretrievequery archivequery backuprestorerestore groupretrievequery nodearchiverestore imagebackup groupInitial command-line-only optionsThere is a subset of client options that are valid on the initial command line only.Many of these options establish the runtime environment, such as the commmethodand optfile options. Options in this category are not valid in interactive, macro, orscheduler modes. They generate an error and cause processing to stop.Table 56 on page 293 lists the options that are valid only on the initial commandline.292 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 56. Options that are valid on the initial command line onlyOptions valid on the initial command lineasrmodepreschedulecmd/prenschedulecmd (can bebackupregistryincluded in the schedule definition)commmethodpresnapshotcmdcomputernamequeryschedperioddeduplicationresourceutilizationdiskbuffsizeretryperiodeditorrunasserviceenablededupcacheschedlogmaxenablelanfreeschedlognameerrorlogmaxschedlogretentionerrorlognameschedmodeerrorlogretentionsessioninitiationincrthresholdsubfilebackuplanfreecommmethodsubfilecachepathlanfreeshmportsubfilecachesizelanfreetcpporttcpbuffsizemaxcmdretriestcpcadaddressnamedpipenametcpclientaddressnodenametcpclientportoptfiletcpportpasswordtcpserveraddresspostschedulecmd/postnschedulecmd (can tcpwindowsizebe included in the schedule definition) txnbytelimitpostsnapshotcmdusedirectoryvirtualnodenameClient options that can be set by the Tivoli Storage ManagerserverSome client options can be set by the Tivoli Storage Manager server.Table 57 on page 294 lists the options that can be set by the server.Chapter 11. Processing options 293

Table 57. Options that can be set by the Tivoli Storage Manager serverOptions that can be set by the TivoliStorage Manager serverv “Casesensitiveaware” on page 308 v “Queryschedperiod” on page 446v “Changingretries” on page 310v “Quiet” on page 449v “Collocatebyfilespec” on page 316 v “Resetarchiveattribute” on page 451v “Compressalways” on page 320v “Resourceutilization” on page 453v “Compression” on page 320v “Retryperiod” on page 455v “Deduplication” on page 329v “Schedmode” on page 464v “Dirmc” on page 336v “Scrolllines” on page 466v “Disablenqr” on page 338v “Scrollprompt” on page 467v “Diskcachelocation” on page 339 v “Snapshotproviderfs” on page 478v “Domain” on page 340v “Snapshotproviderimage” on page 479v “Domain.image” on page 343v “Stagingdirectory” on page 488v “Domain.nas” on page 344v “Subdir” on page 489v “Encryptiontype” on page 358v “Subfilebackup” on page 491v “Encryptkey” on page 359v “Subfilecachepath” on page 492v “Exclude options” on page 365v “Subfilecachesize” on page 493v “Inclexcl” on page 394v “Tapeprompt” on page 495v “Include options” on page 395v “Txnbytelimit” on page 508v MAXCANDPROCSv “Verbose” on page 512v “Maxcmdretries” on page 416v “Vmchost” on page 520v MAXMIGRATORSv “Vmcpw” on page 521v “Memoryefficientbackup” on page 419 v “Vmcuser” on page 522v “Postschedulecmd/Postnschedulecmd” onpage 437v “Postsnapshotcmd” on page 438v “Preschedulecmd/Prenschedulecmd” onpage 440v “Preservelastaccessdate” on page 441v “Presnapshotcmd” on page 445v “Vmlist” on page 526v “Vmprocessvmwithindependent” on page529v “Vmprocessvmwithprdm” on page 530Client options referenceNote:1. See Tivoli Storage Manager for Space Management for UNIX and Linux, clientcommand line interface help or user's guide.2. See Tivoli Storage Manager for Mail, Data Protection for Microsoft Exchange ServerInstallation and User's Guide.Related informationFor information about creating client options sets on the Tivoli StorageManager server, see the Tivoli Storage Manager Administrator's Guide foryour server platform.The following sections contain detailed information about each of the TivoliStorage Manager processing options.Information for each option includes the following information:v a description294 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvva syntax diagramdetailed descriptions of the parametersexamples of using the option in the client options file (if applicable)examples of using the option on the command line (if applicable)Options with a command-line example of Does not apply cannot be used withcommand line or scheduled commands.AdlocationYou can use the adlocation option with the query adobjects or restore adobjectscommands to indicate whether the Active Directory objects are to be queried orrestored from the local Active Directory Deleted Objects container or from a systemstate backup on the Tivoli Storage Manager server.Supported ClientsThis option is valid for Windows Server 2008 clients only. The Tivoli StorageManager client API does not support this option.Syntax►►ADLOCationlocalserver►◄ArchmcParametersserverSpecifies that the Active Directory objects are to be queried or restored from asystem state backup on the Tivoli Storage Manager server. Valid for WindowsServer 2008 only.localSpecifies that the Active Directory objects are to be queried or restored fromthe local Active Directory Deleted Objects container. This is the default.ExampleCommand line:query adobjects "cn=Jim Smith" -adlocation=serverUse the archmc option with the archive command to specify the availablemanagement class for your policy domain to which you want to bind yourarchived files and directories.When you archive a file, you can override the assigned management class usingthe archmc option on the archive command or by using the Web client. Overridingthe management class using the Web client is equivalent to using the archmc optionon the archive command.If you do not use the archmc option, the server binds archived directories to thedefault management class. If the default management class has no archive copygroup, the server binds archived directories to the management class with theshortest retention period.Chapter 11. Processing options 295

Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►► ARCHMc = managementclass ►◄ParametersmanagementclassSpecifies an available management class in the active policy set of your policydomain. This management class overrides the default management class andany include statements for the files and directories you are archiving.ExamplesCommand line:dsmc archive –archmc=ret2yrs c:\plan\proj1\budget.jan\*AsnodenameUse the asnodename option to allow an agent node to back up, archive, restore,retrieve, and query data on behalf of a target node.An agent node is a client node that has been granted authority by a Tivoli StorageManager administrator to perform client operations on behalf of a target node,which is a another client node. The administrator uses the grant proxynodecommand on the Tivoli Storage Manager server to grant this authority.When you back up or archive data without the asnodename option, the backed updata is stored in a file space on the Tivoli Storage Manager server that matches theTivoli Storage Manager nodename of the drive on which the original data exists.For example, if a computer with a nodename of “TAURUS” backs up data on itsF: drive, then the data is stored in a server file space named \\taurus\f$; nodeTaurus owns the file space.When you use the asnodename option to back up data on behalf of a target node,the data is stored in a file space owned by the target node. For example, ifcomputer having a Tivoli Storage Manager nodename of TAURUS backs up dataon its F: drive using -asnodename=scorpio, the data is stored in a file space named\\scorpio\f$, and the files are owned by the SCORPIO node.When you restore or retrieve data, the default behavior is to restore or retrieve thedata to a location that matches the file space name. Continuing with the precedingexample, if node TAURUS uses the option -asnodename=scorpio to restore datafrom \\scorpio\f$, Tivoli Storage Manager attempts to restore the data to the F:drive on a computer named SCORPIO. This might not produce the expected result,especially if the SCORPIO computer does not exist or if you do not have access toit.To restore files, specify a destination for the restored files. In the followingexample, the restore command is entered on the TAURUS node. The commandrestores all files and subdirectories from the Users\taurus\education directory inthe \\scorpio\f$ file space to the local F: drive.296 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

dsmc restore \\scorpio\f$\users\taurus\education\* f:\ -subdir=yes-asnodename=scorpioRestrictions:v You cannot use the asnodename option with -fromnode and you cannotperform NAS backup using asnodename.v asnodename can be used for clustered systems, although no specificcluster software is supported.v You cannot use the asnodename option with system state components.v When backing up an image, you must identify the volume by using theUNC name. You cannot use the drive letter.v Tivoli Storage Manager does not track the originating system for thefiles. Because the asnodename option can cause data to be stored in thesame file space name, regardless of the system from which the backupwas taken, you will need to make sure you know which files should berestored to each system.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the dsm.opt file. You can set this option on the General tab ofthe Preferences editor.Syntax►► ASNODEname targetnode ►◄ParameterstargetnodeSpecifies the node name on the Tivoli Storage Manager server under whichyou want to back up or restore data.ExamplesOptions file:asnodename scorpioCommand line:dsmc incr f:\* -subdir=yes -asnodename=scorpioThis command backs up the entire F disk to the server file space called\\scorpio\f$.This option is not valid in interactive mode, but it can be defined in the optionsportion of a schedule definition.AsrmodeUse the asrmode option with the restore and restore systemstate commands tospecify whether to perform a restore operation in system ASR recovery mode.This option is used in the context of restore commands generated in the asr.sif fileby the backup asr command only.Chapter 11. Processing options 297

Supported ClientsThis option is valid for Windows Vista, Windows7, and Windows Server 2008clients only when these clients are running in Windows PreinstallationEnvironment (WinPE). Note that ASR data is not backed up, and hence cannot berestored, on 64-bit architectures with Extensible Firmware Interface (EFI).Syntax►► ASRMODE =NoYes►◄ParametersNoYesSpecifies that Tivoli Storage Manager does not perform the restore operation insystem ASR recovery mode.Specifies that Tivoli Storage Manager performs the restore operation in ASRrecovery mode. This is the default for Windows Vista, Windows 7, andWindows Server 2008 during ASR recovery. These clients are running inWindows Preinstallation Environment (WinPE) during ASR recovery.ExamplesCommand line:restore systemstate -asrmode=yesrestore systemstate -asrmode=yes -inactive -pickThis option is valid for an interactive session, but cannot be changed byentering the option while running an interactive session.AuditloggingUse the auditlogging option to generate an audit log that contains an entry foreach file that is processed during an incremental, selective, archive, restore, orretrieve operation.The audit log can be configured to capture either a basic level of information or amore inclusive (full) level of information.The basic level of the audit logging feature captures the information that is in theschedule log and it records information that a file has been backed up, archived,updated, restored, retrieved, expired, deleted, skipped or failed during anincremental backup, selective backup, archive, restore or retrieve operation. Inaddition, the basic level of audit logging captures the input command forcommands run through the Backup-Archive command line or scheduler clients.The full level of audit logging records an action for each file that is processed bythe Backup-Archive client. In addition to all of the events recorded by the basiclevel of audit logging, the full level of audit logging records information for a filethat has been excluded or not sent during a progressive incremental backupoperation because the file had not changed.The following is an example of the messages that are issued when the audit log isconfigured to capture the basic level of information:298 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

04/21/07 15:25:05 ANS1650I Command:sel c:\test\file.txt04/21/07 15:25:05 ANS1651I Backed Up:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1652I Archived:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1653I Updated:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1654E Failed:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1655I Restored:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1656I Retrieved:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1657I Expired:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1658I Deleted:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1659I Skipped:\\spike\c$\test\file.txtThe following is an example of the messages that are issued when the audit log isconfigured to capture the full level of information (in addition to all messagesissued for the basic level of audit logging):04/21/07 15:25:05 ANS1660I Excluded:\\spike\c$\test\file.txt04/21/07 15:25:05 ANS1661I Unchanged:\\spike\c$\test\file.txtThe audit log is not a substitute or a replacement for the standard error log(dsmerror.log) or for the schedule log (dsmsched.log). If an error occurs thatprevents a file from being processed, a message indicating that an error hasoccurred is written to the audit log, but the message will not indicate the nature ofthe error. For problem diagnostics the standard error log must still be used.The audit log entries only contain a time stamp and object name. There is noinformation to distinguish between files and directories or any information aboutthe size of an object.When using the Windows Backup-Archive Client, all object names are written inthe UNC format. The Windows Backup-Archive Client creates the audit log as aUnicode file.By default, the name of the audit log is dsmaudit.log and it is contained in thesame directory as the error log, dsmerror.log. The name and location of the auditlog can be configured using the auditlogname option. There are no parameters tocontrol the size of the audit log or to prune the audit log. The auditlogname optioncannot be set as an option in a Tivoli Storage Manager Server client options set.The auditlogging command is not supported with backup commands whichinteract with image-level objects such as backup image or restore image. Theauditlogging command is supported with backup commands that interact withfile-level objects such as backup groups, and backup systemstate.If you have enabled audit logging for an operation and there is a failure trying towrite to the audit log (for example, the disk on which the audit log resides is outof space), the audit logging is disabled for the rest of the operation and the returncode for the operation is set to 12, regardless of the outcome of the operation.Chapter 11. Processing options 299

Supported ClientsThis option is valid for all clients.Options FilePlace this option in the dsm.opt file.Syntax►►AUDITLOGGingoffbasicfull►◄ParametersoffSpecifies that the audit logging facility is not engaged. This is the default.basicSpecifies that the audit log captures a basic level of information.fullSpecifies that the audit log captures a more extensive level of information.ExamplesRun an incremental backup with audit logging enabled.Command line:dsmc i -auditlogging=basicBack up a list of files using the maximum level of auditing, which enablesa separate application, such as a Perl script, to verify the results.dsmc i -filelist=file.lst -auditlogging=full-auditlogname="c:\program files\tivoli\tsm\baclient\temp_audit001.log"AuditlognameThe auditlogname option specifies the path and file name where you want to storeaudit log information. This option applies when audit logging is enabled.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the dsm.opt file.Syntax►► AUDITLOGName filespec ►◄300 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersfilespecSpecifies the path and file name where you want Tivoli Storage Manager tostore audit log information.If you specify a file name only, the file is stored in your current directory. Thedefault is the installation directory with a file name of dsmaudit.log. Thedsmaudit.log file cannot be a symbolic link.ExamplesRun an incremental backup with audit logging enabled.Options file:Store the audit log in a non-default path.auditlogname c:\mypath\myaudit.logCommand line:Back up a list of files using the maximum level of auditing, which wouldenable a separate application, such as a Perl script, to verify the results:dsmc i -filelist=file.lst -auditlogging=full-auditlogname="c:\program files\tivoli\tsm\baclient\temp_audit001.log"Sample outputThe following is a sample execution and output file:C:\Program Files\Tivoli\TSM\baclient>dsmc ic:\test\* -sub=yes -auditlogging=fullIBM Tivoli Storage ManagerCommand Line Backup/Archive Client InterfaceClient Version 5, Release 5, Level 0.0Client date/time: 04/21/2007 15:52:25(c) Copyright by IBM Corporation and other(s)1990, 2007. All Rights Reserved.Node Name: PATMOSSession established with server PATMOS_5331: WindowsServer Version 5, Release 3, Level 3.1Server date/time: 04/21/2007 15:52:26Last access: 04/21/2007 15:52:06Incremental backup of volume ’c:\test\*’Normal File--> 1,048,576 \\patmos\c$\test\dir1\file1 [Sent]Normal File--> 1,048,576 \\patmos\c$\test\dir1\file2 [Sent]Normal File-->1,024 \\patmos\c$\test\dir1\file3 [Sent]Normal File--> 1,048,576 \\patmos\c$\test\dir2\file1 [Sent]Normal File--> 1,048,576 \\patmos\c$\test\dir2\file2 [Sent]Normal File-->1,024 \\patmos\c$\test\dir2\file3 [Sent]Successful incremental backup of ’\\patmos\c$\test\*’Total number of objects inspected: 12Total number of objects backed up: 6Total number of objects updated: 0Total number of objects rebound: 0Total number of objects deleted: 0Total number of objects expired: 0Total number of objects failed: 0Chapter 11. Processing options 301

Total number of subfile objects: 0Total number of bytes transferred: 400.85 KBData transfer time:0.00 secNetwork data transfer rate:0.00 KB/secAggregate data transfer rate: 382.85 KB/secObjects compressed by: 91%Subfile objects reduced by: 0%Elapsed processing time: 00:00:01ANS1900I Return code is 0.ANS1901I Highest return code was 0.The following are the audit log contents:04/21/2007 15:52:25 ANS1650I Command:i c:\test\*04/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test04/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test\dir104/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test\dir204/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test\file104/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test\file204/21/2007 15:52:26 ANS1661I Unchanged:\\patmos\c$\test\file304/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir1\file104/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir1\file204/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir1\file304/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir2\file104/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir2\file204/21/2007 15:52:26 ANS1651I Backed Up:\\patmos\c$\test\dir2\file3Related informationFor more information about the audit logging facility refer to “Auditlogging” onpage 298.AutodeployUse the autodeploy option to enable or disable an automatic deployment of theclient if a restart is required.Supported ClientsThis option is valid for Windows clientsOptions FileYou can set this option by including it in your client options file. You can also setin using the Java GUI by clicking Edit > Client Preferences and selecting theappropriate option on the General tab.302 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►►AUTODEPLOYYesNoNOReboot►◄ParametersYesSpecifies that the client is automatically deployed from the server. Yes is thedefault.Important:v When you set autodeploy to yes, if a restart of the client workstation isrequired to complete the deployment, you cannot disable the restart. Theclient workstation will be restarted. If it is important that the workstation isnot automatically restarted, set autodeploy to noreboot. The deployment willbe canceled if a restart is required. The current client is not affected.v If a restart is required, the deployment manager initiates a restart for theclient computer and exits. However, it is possible that you cancel orinterrupt the restart. Since the deployment manager is already terminated, amessage is not sent to the server to indicate the failure of the restart. Thedeployment result is still successful. You must restart the computer so thatthe new client deployment completes.No Specifies that the client is not automatically deployed from the server.NORebootSpecifies that the deployment manager never automatically restarts the clientcomputer, even if a restart is required. If a restart is required, allowingautomatic deployment to many machines with the NOReboot parameter canresult in only a partial update of, potentially, many clients.To alleviate this problem, the deployment manager tries to detect if a restart isrequired. If a restart is required, the deployment manager cancels thedeployment before the new client installation. This guarantees that the clientcomputer still has a working backup-archive client, and the new clientdeployment can be rescheduled.There are rare cases where the deployment manager cannot detect the restart;for example, if client processes are started from a script. In these cases, the newclient installation will continue, but a manual restart of the client computer isrequired.ExamplesOptions file:autodeploy noCommand line:Does not apply.Options file:autodeploy norebootCommand line:Does not apply.Chapter 11. Processing options 303

Important: Use schedmode prompted with the autodeploy option, to enable thescheduler to process the client deployment schedule immediately.Related concepts:“Automatic backup-archive client deployment” on page 3AutofsrenameThe autofsrename option renames an existing file space that is not Unicode-enabledon the Tivoli Storage Manager server so that a Unicode-enabled file space with theoriginal name can be created for the current operation.When you specify autofsrename yes in your client options file, and the servervalue of autofsrename is set to client, Tivoli Storage Manager generates a uniquename by appending _OLD to the file space name you specify in the currentoperation. For example, Tivoli Storage Manager renames the file space\\your-node-name\h$ to \\your-node-name\h$_OLD. If the new file space name istoo long, the suffix replaces the last characters of the file space name, as follows:\\your-node-name_OLDIf the new file space name already exists on the server, Tivoli Storage Managerrenames the new file space \\your-node-name_OLDx, where x is a unique number.Tivoli Storage Manager creates new Unicode-enabled file spaces that contain onlythe data specified in the current operation. For example, to archive files from yourH: disk named \\your-node\h$, issue the following archive command:arc h:\logs\*.logBefore the archive takes place, the server renames the file space to\\your-node\h$_OLD. The archive places the data specified in the current operationinto the Unicode-enabled file space named \\your-node\h$. The newUnicode-enabled file space now contains only the \logs directory and the *.logfiles specified in the operation. Tivoli Storage Manager stores all subsequent fulland partial incremental, selective backup, and archive data in the newUnicode-enabled file spaces.Renamed file spaces remain on the server as stabilized file spaces. These file spacescontain all the original data, which you can restore as long as they remain on the server.Note: When an existing file space is renamed during Unicode conversion, anyaccess rules defined for the file space remain applicable to the original file space.New access rules must be defined to apply to the new Unicode file space.After installation, perform a full incremental backup and rename all existing filespaces that are not Unicode-enabled and back up the files and directories withinthem under the new Unicode-enabled file spaces. This operation requires increasedprocessing time and storage on the server.File spaces that are not Unicode-enabled can be viewed in the character set of thelocale from which Tivoli Storage Manager backed up the files. A workstationrunning in a different locale might be unable to view or restore from these filespaces. Unicode-enabled file spaces that are backed up in one locale are visible inall other locales, provided that the workstation has the proper fonts installed.To restore or retrieve from a file space that is not Unicode-enabled, specify thesource on the server and the destination on the client. See304 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all Windows clients. The server can define theautofsrename option and override the autofsrename setting on the client. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt) file. You can set this option onthe General tab, Rename non-Unicode filespaces during backup/archivedrop-down list box of the Preferences editor.Syntax►►AUTOFsrenamePromptYesNo►◄ParametersYesSpecifies that Tivoli Storage Manager automatically renames all file spaces thatare not Unicode-enabled in the current backup or archive operation.No Specifies that Tivoli Storage Manager does not rename file spaces that are notUnicode-enabled in the current backup or archive operation.PromptSpecifies that Tivoli Storage Manager prompts you whether to rename the filespaces that are not Unicode-enabled in the current operation. This is thedefault.Considerations:v This option applies only when the server sets the autofsrename option to client.v When the client scheduler is running, the default behavior is to not prompt you.The next interactive session prompts you to rename the file space.v The client prompts you only one time per file space. If you specify no at theprompt, the client cannot rename the file spaces later. However, the TivoliStorage Manager administrator can rename the file spaces on the server.v When backing up files to a file space that is not Unicode-enabled, theUnicode-enabled client skips the files and directories with names containingcharacters from a code page that is different from the current locale.v If files and directories with names containing characters from a code page otherthan the current locale were previously backed up with a client that was notUnicode-enabled, they might be expired. The Unicode-enabled client expiresthese files if you do not migrate the file space to a Unicode-enabled file space.You can back up and archive these files to a Unicode-enabled file space.ExamplesOptions file:autofsrename yesRelated informationChapter 11. Processing options 305

Backmc“Restore from file spaces that are not Unicode-enabled” on page 628The backmc option specifies the Tivoli Storage Manager management class to applyto the backup fastback command for retention purposes.Use the backmc option with the backup fastback command.If you back up an object more than once and specify a different management classfor each backup, all backup versions of the object are rebound to the lastmanagement class specified.Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line or on the scheduler.Syntax►► BACKMc= management_class_name ►◄Parametersmanagement_class_nameSpecifies the management class name.ExamplesCommand line:dsmc backup fastback -fbpolicyname=policy1 -fbserver=server1-backmc=ret2yrsBackupsetnameThe backupsetname option specifies the name of a backup set from the TivoliStorage Manager server.|You can use backupsetname option with the following commands:v query backupv query filespacev query imagev query systemstatev restore imagev restore systemstateNote: The following commands take backupsetname as a positional parameter. Thebackupsetname positional parameter behaves differently from the backupsetnameoption. See the command explanations for a discussion of how the backupsetnamepositional parameter affects each of these commands:query backupsetrestorerestore backupset306 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FileNone. You can specify this option only on the command line.Syntax►► BACKUPSETName backupsetname ►◄ParametersbackupsetnameSpecifies the name of a backup set from the Tivoli Storage Manager server. Youcannot use wildcards.ExamplesCommand line:dsmc query image -backupsetname=WEEKLY_BSET.21435678dsmc query backup c:\* -subdir=yes-backupsetname=weekly_accounting_data.32145678dsmc restore image e:-backupsetname=weekly_backup_data.12345678dsmc restore systemstate-backupsetname=daily_backup_data.43215678Related information“Restore data from a backup set” on page 185||||||||||||BasesnapshotnameThe basesnapshotname option specifies the snapshot to use as the base snapshot,when you perform a snapshot differential (snapdiff) backup of a NetApp filervolume. If you specify this option, you must also use the snapdiff option or anerror occurs. If basesnapshotname is not specified, the useexistingbase optionselects the most recent snapshot on the filer volume as the base snapshot.If the specified snapshot cannot be found, an error is reported and the backupoperation fails.Supported ClientsThis option can be used with supported Windows clients.Options FileThis option can be specified in the client options file or on the command line.Chapter 11. Processing options 307

|||||||||||||||||||||||||||||||||||Syntax►► BASESNAPSHOTName snapshot_name ►◄Parameterssnapshot_nameSpecifies the name of an existing snapshot to use as the base snapshot. Thename specified can be a snapshot name, such as vol1_snap, or it can be thename of a scheduled NetApp backup that has a name like nightly.x, where xis the sequence number (where nightly.0 is the oldest snapshot).You can also use a pattern with wildcard characters to select a snapshot. Thewildcard characters can be either of the following:* An asterisk (*) matches any character.? A question mark (?) matches a single character.The wildcards are useful if your snapshots follow a pattern, such as includingthe date or data and time as part of the snapshot name. For example, asnapshot created on November 12 2012 at 11:10:00 AM could be saved asUserDataVol_121103111000_snapshot. The most recent snapshot that matchesthe pattern is selected as the existing base. For example, if there are two savedsnapshots (UserDataVol_121103111000_snapshot andUserDataVol_121103231000_snapshot, the UserDataVol_121103231100_snapshotis selected because it is 12 hours newer than the other snapshot.-basesnapshotname="UserDataVol_*_snapshot"Question marks work well for scheduled backups that follow a consistentname pattern. This syntax selects the latest “nightly” backup as the snapshot touse as the existing base.-basenameshotname="nightly.?"ExamplesOptions file:basesnapshotname nightly.?basesnapshotname volum_base_snapCommand line:dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff-useexistingbase -basesnapshotname="nightly.?"Related informationUseexistingbaseCasesensitiveawareThe casesensitiveaware option specifies whether the Windows Backup-Archiveclient should filter out file and directory objects which have names conflicting incase only.NTFS volumes are case sensitive and allow case sensitive file names to be stored.Although the Windows operating system is not case sensitive, applications such asWindows Services for UNIX (SFU) exploit POSIX and allow case sensitive filenames. SFU is typically included with Windows operating systems such asWindows Powered OS and Windows Storage Server. These operating systems are308 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

typically deployed on hardware (for example, NAS hardware) which is acting as adedicated file server in a heterogeneous environment.If there are UNIX clients storing files on NTFS volumes in these Windows fileserver environments, use the casesensitiveaware option. If this option is not usedin these environments unpredictable results occur during backup and archiveoperations if case sensitive file name conflicts are encountered. For homogeneousWindows file server environments the casesensitiveaware option is not necessary.For example, if there is a set of objects called ’MyWork.xls’, ’MYWORK.xls’, and’mywork.xls’, because the Windows operating system is not case sensitive,applications cannot distinguish between two objects named ’mywork.xls’ and’MyWork.xls’For this reason, the Tivoli Storage Manager Windows Backup-Archive client cannotguarantee the restore integrity of such objects. When a name casing conflict arises,the Tivoli Storage Manager Backup-Archive client can only guarantee the restoreintegrity of the first file in an alphabetical sort. On an ASCII-based operatingsystem such as Windows, this means that capital letters come first alphabeticallybefore their lowercase counterparts, so ’MySwork.xls’ would alphabetically precede’mywork.xls’.In this example, if the casesensitiveaware option is used, only ’MyWork.xls’ isprocessed. An error message is issued for ’mywork.xls’ and it is skipped. If’mywork.xls’ is a directory, then the directory subtree ’mywork.xls’ would beskipped. In all cases, messages are written to both the local error log and to theTivoli Storage Manager server console to indicate the exact file names of the objectsbeing skipped.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►►CASESENSITIVEAwareNoYes►◄ParametersyesnoSpecifies that the Tivoli Storage Manager should attempt to identify objectnames which differ in casing only and filter out objects which have casingconflicts and cannot be guaranteed to be restored properly.Specifies that the Tivoli Storage Manager should not attempt to identify objectnames which differ in casing only. This is the default.Chapter 11. Processing options 309

ChangingretriesThe changingretries option specifies how many additional times you want theclient to attempt to back up or archive a file that is in use. Use this option with thearchive, incremental, and selective commands.||This option is applied only when copy serialization, an attribute in amanagement class copy group, is shared static or shared dynamic.With shared static serialization, if a file is open during an operation, theoperation repeats the number of times that you specify. If the file is open duringeach attempt, the operation does not complete.With shared dynamic serialization, if a file is open during an operation, theoperation repeats the number of times that you specify. The backup or archiveoccurs during the last attempt whether the file is open or not. Open file supportcan be used to back up files that are locked or in use.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.The Tivoli Storage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab, Number of retries if file is in use field of the Preferences editor.Syntax►► CHAngingretries numberretries ►◄ParametersnumberretriesSpecifies the number of times a backup or archive operation is attempted if thefile is in use. The range of values is zero through 4; the default is 4.ExamplesOptions file:changingretries 3Command line:-cha=3ClassThe class option specifies whether to display a list of NAS or client objects whenusing the delete filespace, query backup, and query filespace commands.For example, to display a list of the file spaces belonging to a NAS node, enter thefollowing command:query filespace -class=nas310 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Options FileNone. You can specify this option only on the command line.Syntax►►CLASS =clientnas►◄ParametersclientSpecifies that you want to display a list of file spaces for a client node. This isthe default.nasSpecifies that you want to display a list of file spaces for a NAS node.ExamplesNone. You can specify this option only on the command line.Command line:q backup -nasnodename=nodename -class=nasClientviewThe clientview option is available to users who have upgraded from the TivoliStorage Manager Express backup client to the Tivoli Storage Manager enterpriseclient.You must be connected to a Tivoli Storage Manager Version 5.4 or higher server touse this option. The clientview option allows you to choose either the expressview or the standard view of the client graphical user interface (GUI).Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the dsm.opt file. To switch to the Express view:1. In the IBM Tivoli Storage Manager window, select Edit > Preference from themenu bar.2. From the General tab of the Preferences editor, in the Client View field, clickExpress.3. Click OK to save your change.To switch to the Standard view:1. In the IBM Tivoli Storage Manager window, click Modify Settings.Chapter 11. Processing options 311

2. From the General tab of the Preferences editor, in the Client View field, clickStandard.3. Click OK to save your change.Syntax►►CLIENTVIEW =standardexpress►◄ParametersstandardSpecifies that the standard, or enterprise, view of the Tivoli Storage Managerclient GUI should be used. The standard view contains the advanced featuresof the Tivoli Storage Manager Backup-Archive Client GUI. This is the default.expressSpecifies that the express view of the Tivoli Storage Manager client GUI shouldbe used. The express view contains the same features as the Express backupclient GUI.ClusterdisksonlyThe clusterdisksonly option specifies whether the Tivoli Storage ManagerBackup-Archive client allows the backup of only clustered disks in specificenvironments.|Tivoli Storage Manager allows the backup of only clustered disks when running inthe following environments:v A Microsoft Cluster Server (MSCS)v Failover Clustering is employed on a supported Windows Server clientvVERITAS Cluster Server (VCS) environment, when the clusternode processingoption is set to yesThe Tivoli Storage Manager Backup-Archive client previously only allowedbackups and restores of data on clustered drives that were mounted as a driveletter.It is common to find clustered drives mounted as volume mount points. WindowsServer operating systems and products such as IBM ® Tivoli SANergy ® allow usersto surpass the 26-drive-letter limitation by allowing volume mount points to bedefined on a clustered server. Tivoli Storage Manager can protect data on clusterdisks mounted as drive letters on Windows Server OS computers. Tivoli StorageManager can also protect data on cluster disks mount as volume mount points andthe Backup-Archive client can automatically determine whether a volume using avolume mount point is a cluster volume.Note that when the clusterdisksonly option is specified as yes, the Tivoli StorageManager Backup-Archive client continues to segregate local drives from clusterdrives when evaluating the ALL-LOCAL domain option. When the clusterdisksonlyoption is specified as no, you must explicitly define the backup domains. When theclusterdisksonly option is specified as no, the Tivoli Storage ManagerBackup-Archive client also bypasses enumeration of cluster resources in order todetermine which resources represent cluster drives.312 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported Clients|This option is valid for all supported Windows Server clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►►CLUSTERDISKSOnlyYesNo►◄ParametersYesSpecifies that the Tivoli Storage Manager only allows the processing of clusterdrives. Yes is the default.No Specifies that the Tivoli Storage Manager allows the processing of any diskwhen the clusternode processing option is set to yes.ExamplesScenario 1: Back up a node which manages the local (non-clustered) drives andthe system state informationThis is the node that is basically dedicated to the restoration of thephysical system should there be a hardware failure. There are no clustereddrives which appear as volume mount points (for example, a product likeIBM Tivoli SANergy ® is not being exploited).Options file:CLUSTERNODE NO (default)CLUSTERDISKSONLY YES (default)DOMAIN ALL-LOCAL (default)EXCLUDE c:\...\file.txtScenario 1b: Back up a node which manages the local (non-clustered) drives andthe system state information and bypass enumeration of cluster resourcesThis is a scenario similar to scenario 1 which can be deployed if the TivoliStorage Manager Backup-Archive client takes an inappropriate amount oftime during startup processing. During initialization of the Backup-Archiveclient, all of the cluster resources are enumerated to determine whichresources represent cluster disk devices. This processing can be skipped bycoding the clusterdisksonly parameter to no.Options file:CLUSTERNODE NO (default)CLUSTERDISKSONLY NODOMAIN C: D: (local drives must be explicitly enumerated)EXCLUDE c:\...\file.txtScenario 2: Back up a node which manages the local (non-clustered) drives andthe system state information in a clustered environment using volume mountpoints as cluster resourcesThis node is dedicated to the restoration of the physical system if there is ahardware failure. There are clustered drives which appear as volumeChapter 11. Processing options 313

mount points in this environment (for example, IBM Tivoli SANergy,Windows Server operating systems). Also, be sure to remove any volumemount points from the incremental processing domain.Options file:CLUSTERNODE NO (default)CLUSTERDISKSONLY YES (default)DOMAIN ALL-LOCALEXCLUDE c:\...\file.txtScenario 3: Back up a node which manages the clustered drives within a clusterresource group and bypass enumeration of cluster resourcesThis is a scenario which can be deployed if the Tivoli Storage ManagerBackup-Archive client takes an inappropriate amount of time duringstartup processing. During initialization of the Backup-Archive client, all ofthe cluster resources are enumerated to determine which resourcesrepresent cluster disk devices. This processing can be skipped by codingthe clusterdisksonly parameter to no.Options file:CLUSTERNODE YESCLUSTERDISKSONLY NODOMAIN f: g:EXCLUDE f:\...\file.txtScenario 4: Back up a node which manages the clustered drives within a clusterresource group, using volume mount points as cluster resourcesIn this scenario, it is assumed that the node is responsible for backing up acluster resource group that has two drives, f: and f:\mnt. There areclustered drives which appear as volume mount points (IBM TivoliSANergy, Windows Server operating systems). Ensure that you define theincremental processing domain as only the volumes within a clusterresource group. If you have multiple cluster resource groups, assign aunique Tivoli Storage Manager node to manage each cluster resourcegroup.Options fileCLUSTERNODE YESCLUSTERDISKSONLY YESDOMAIN f: f:\mntEXCLUDE f:\mnt\...\file.txtTable 58 shows the list of clusternode and clusterdisksonly combinations.Table 58. Clusternode and clusterdisksonly combinationsClusternode Clusterdisksonly When to useno yes This is the default behavior ifnothing is specified; sinceclusterdisksonly is set toyes, the cluster disk map isbuilt. This combination isused for backing up localdrives.314 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 58. Clusternode and clusterdisksonly combinations (continued)Clusternode Clusterdisksonly When to useyes yes This is the default way torun in a cluster node to backup cluster disks, includingdisks that are exposed asmount points; the clusterdisk map is built.yes no For Windows Server 2008and newer Windows Serversystems, you only need tospecify clusterdisksonly=noif you need to bypass clustervolume enumeration forperformance reasons.ClusternodeThe clusternode option specifies how the Tivoli Storage Manager Backup-ArchiveClient manages cluster drives.|Tivoli Storage Manager manages clustered drives in the following environments:v A Microsoft Cluster Server (MSCS)v Failover Clustering on Windows Server systemsv VERITAS Cluster Server (VCS)When the clusternode option is set to yes, only shared cluster drives are availablefor backup and archive processing. When you set the clusternode option to yes,the node name defaults to the cluster name.To back up local drives or Windows Server system state, you must set theclusternode option to no.Note: You must set the clusternode option to yes for all Tivoli StorageManager-managed cluster operations. Inconsistent use of the clusternode optionfor a given Tivoli Storage Manager cluster node name can cause Tivoli StorageManager to invalidate the cluster node name encrypted password, and prompt theuser to reenter the password during the next Tivoli Storage Manager programinvocation.Use the optfile option to properly call the correct (cluster) dsm.opt for all TivoliStorage Manager programs to ensure proper Tivoli Storage Manager functionalityfor cluster related operations. See the optfile option description for moreinformation.Supported ClientsThis option is valid for Windows Server operating system clients.Options FilePlace this option in the client options file (dsm.opt).Chapter 11. Processing options 315

Syntax►►CLUSTERnodeNoYes►◄|ParametersYesSpecifies that you want Tivoli Storage Manager to manage cluster drives in thefollowing environments:v A MSCSv Failover Clustering on Windows Server systemsv VCSNo Specifies that you want to back up local disks. This is the default.ExamplesOptions file:cluster noCommand line:-cluster=yesThis option is valid only on the initial command line. It is not valid in interactivemode.Related information“Optfile” on page 430CollocatebyfilespecUse the collocatebyfilespec option to specify whether the Tivoli Storage Managerclient uses only one server session to send objects generated from one filespecification.Setting the collocatebyfilespec option to yes attempts to eliminate interspersingof files from different file specifications, by limiting the client to one server sessionper file specification. Therefore, if you store the data to tape, files for each filespecification are stored together on one tape (unless another tape is required formore capacity).Considerations:v Use the collocatebyfilespec option only if the storage pool is going directly totape. If you use this option going to a disk storage pool, you could affect someload balancing, and therefore, performance.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt).316 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►►COLlocatebyfilespecNoYes►◄ParametersYesNoCommmethodSpecifies that you want the Tivoli Storage Manager client to use only oneserver session to send objects generated from one file specification. Therefore,if you store the data to tape, files for each file specification are stored togetheron one tape, unless another tape is required for more capacity. Restoreperformance can increase as a result.Specifies that the Tivoli Storage Manager client can (depending on theexecution dynamics and on the setting of the resourceutilization option of 3or higher), use more than one server session to send the files from one filespecification. This is the default.Backup performance might increase as a result. If the files are backed up totape, files are stored on multiple tapes. Generally, the files specified in the filespecification are still contiguous.ExamplesOptions file:collocatebyfilespec yesCommand line:-collocatebyfilespec=yesThis option is valid only on the initial command line. It is not valid in interactivemode.||The commmethod option specifies the communication method you use to provideconnectivity for client-server communication.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab of the Preferences editor.Syntax►►COMMMethodTCPipSHAREdmemV6TCPIPNAMedpipes►◄Chapter 11. Processing options 317

ParametersTCPipThe Transmission Control Protocol/Internet Protocol (TCP/IP) communicationmethod. This is the default.V6TcpipIndicates that either TCP/IP Version 4 or Version 6 should be used, dependingon the system configuration and the results of a domain name service lookup.A valid DNS environment must be available.NAMedpipesThe interprocess communication method that permits message data streams topass between a client and a server. Use this communication method with aTivoli Storage Manager server running on the same workstation as the client.SHAREdmemUse the shared memory communication method when the client and server arerunning on the same system. This provides better performance than theTCP/IP protocol.Note: Use of this communication method requires that both client and serverrun under the same Windows account.ExamplesOptions file:commmethod tcpipUse only TCP/IP Version 4commmethod V6TcpipUse both TCP/IP Version 4 and Version 6, depending on how the system isconfigured, and the results of a domain name service lookup.Note: The dsmc schedule command cannot be used when both SCHEDMODeprompt and commmethod V6Tcpip are specified.Command line:-commm=tcpip-commm=V6TcpipThis option is valid only on the initial command line. It is not valid in interactivemode.CommrestartdurationThe commrestartduration option specifies the maximum number of minutes youwant the client to try to reconnect to a Tivoli Storage Manager server after acommunication error occurs.|||Note: A scheduled event continues if the client reconnects with the server beforethe commrestartduration value elapses, even if the startup window of the eventhas elapsed.You can use the commrestartduration option and the commrestartinterval in busyor unstable network environments to decrease connection failures.318 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, Common Options section of the Preferences editor.Syntax►► COMMRESTARTDuration minutes ►◄ParametersminutesThe maximum number of minutes you want the client to attempt to reconnectwith a server after a communication failure occurs. The range of values is zerothrough 9999; the default is 60.ExamplesOptions file:commrestartduration 90Command line:Does not apply.CommrestartintervalThe commrestartinterval option specifies the number of seconds you want theclient to wait between attempts to reconnect to a Tivoli Storage Manager serverafter a communication error occurs.Note: Use this option only when commrestartduration is a value greater than zero.You can use the commrestartduration option and the commrestartinterval in busyor unstable network environments to decrease connection failures.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, Common Options section of the Preferences editor.Syntax►► COMMRESTARTInterval seconds ►◄ParameterssecondsThe number of seconds you want the client to wait between attempts toChapter 11. Processing options 319

econnect with a server after a communication failure occurs. The range ofvalues is zero through 65535; the default is 15.ExamplesOptions file:commrestartinterval 30Command line:Does not apply.CompressalwaysThe compressalways option specifies whether to continue compressing an object ifit grows during compression.Use this option with the compression option, and with the archive, incremental,and selective commands.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab, Continue Compressing if Object Grows check box of the Preferenceseditor.Syntax►►COMPRESSAlwaysYesNo►◄ParametersYesNoFile compression continues even if the file grows as a result of compression.This is the default.Backup-archive client objects are resent uncompressed if they grow duringcompression. API behavior depends on the application. Application backupsmight fail.ExamplesOptions file:compressalways yesCommand line:-compressa=noThis option is valid only on the initial command line. It is not valid in interactivemode.CompressionThe compression option compresses files before you send them to the server.320 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Compressing your files reduces data storage for backup versions and archivecopies of your files. It can, however, affect Tivoli Storage Manager throughput. Afast processor on a slow network connection benefits from compression, but a slowprocessor on a fast network connection does not.Use the compression option with the archive, incremental, and selectivecommands.The backup image command uses the compression option value specified in thedsm.opt file. This option is valid on the initial command line and in interactivemode. The server can also define this option which overrides the client value.Tivoli Storage Manager backs up a sparse file as a regular file if client compressionis off. Set the compression option to yes to enable file compression when backingup sparse files to minimize network transaction time and maximize server storagespace.If you set the compressalways option to yes, compression continues even if the filesize increases. To stop compression if the file size grows, and resend the fileuncompressed, set the compressalways option to no.If you set the compression option to yes, you can control compression processing inthe following ways:vvUse the exclude.compression option in your client options file (dsm.opt) toexclude specific files or groups of files from compression processing.Use the include.compression option in your client options file (dsm.opt) toinclude files within a broad group of excluded files for compression processing.This option controls compression only if your administrator specifies that yourclient node can compress files before sending them to the server.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab, Compress objects check box of the Preferences editor.Syntax►►COMPRESSIonNoYes►◄ParametersNo Files are not compressed before they are sent to the server. This is the default.YesFiles are compressed before they are sent to the server.Chapter 11. Processing options 321

ExamplesOptions file:compression yesCommand line:-compressi=noThis option is valid only on the initial command line. It is not valid in interactivemode.Related information“Exclude options” on page 365“Include options” on page 395ConsoleUse the console option with the query systeminfo command to outputinformation to the console.v DSMOPTFILE - The contents of the dsm.opt file.v ENV - Environment variables.v ERRORLOG - The Tivoli Storage Manager error log file.v FILE - Attributes for the file name that you specify.v FILESNOTTOBACKUP - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackupvvvvvvvvThis key specifies those files that backup products should not back up. Thequery inclexcl command indicates that these files are excluded per the operatingsystem.INCLEXCL - Compiles a list of include-exclude in the order in which they areprocessed during backup and archive operations.KEYSNOTTORESTORE - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\BackupRestore\KeysNotToRestoreThis key specifies those Windows Registry keys that backup products should notrestore.MSINFO - Windows system information (output from MSINFO32.EXE).OPTIONS - Compiled options.OSINFO - Name and version of the client operating systemPOLICY - Policy set dump.REGISTRY - Windows Tivoli Storage Manager-related Windows Registry entries.SCHEDLOG - The contents of the Tivoli Storage Manager schedule log (usuallydsmsched.log).322 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

v SFP - The list of files protected by Windows System File Protection, and for eachfile, indicates whether that file exists. These files are backed up as part of theSYSFILES system object.v SFP= - Indicates whether the specified file (filename) is protected byWindows System File Protection. For example:SFP=C:\WINNT\SYSTEM32\MSVCRT.DLLv SYSTEMSTATE - Windows system state information.v CLUSTER - Windows cluster information.Note: The query systeminfo command is intended primarily as an aid for IBMsupport to assist in diagnosing problems, although users who are familiar with theconcepts addressed by this information might also find it useful. If you use theconsole option, no special formatting of the output is performed to accommodatescreen height or width. Therefore, the console output might be difficult to read dueto length and line-wrapping. In this case, use the filename option with the querysysteminfo command to allow the output to be written to a file that cansubsequently be submitted to IBM support.Supported ClientsThis option is valid for all clients.Syntax►► CONsole ►◄ParametersThere are no parameters for this option.ExamplesCommand line:query systeminfo dsmoptfile errorlog -consoleRelated information“Filename” on page 382CreatenewbaseThe createnewbase option creates a base snapshot and uses it as a source to run afull incremental backup.Some files might not be backed up when the snapshot difference incrementalbackup command is run. If the files are skipped, you can run a snapshot differenceincremental backup with the createnewbase option to back up these files. See“Snapdiff” on page 473 for a list of reasons why a file might not be backed upwhen the snapshot difference command is run.One reason that a file can be skipped during backup processing is because the filename is not supported by NetApp Data ONTAP. NetApp Data ONTAP versions8.0 and versions lower than 7.3.3 support only file names that are within the 7 bitASCII character set. NetApp Data ONTAP version 7.3.3 and versions greater than8.0.0 support Unicode file names. If you upgraded NetApp Data ONTAP from aChapter 11. Processing options 323

version that does not support Unicode file names to a version that does supportUnicode files names, run a full incremental backup with thecreatenewbase=migrate option.Supported ClientsThis option is valid for the following clients:v All Windows clients except IA 64 bitEnter the createnewbase option on the command line. Specify this option with thesnapdiff option.Syntax►►CreatenewbaseNoYesIGNoreMIGRate►◄ParametersnoSpecifies that a snapshot difference incremental is run. If Tivoli StorageManager detects that the NetApp Data ONTAP file server has been migratedfrom a version that does not support Unicode file names to a file server thatdoes, a warning message is recorded to the error log and the Tivoli StorageManager server activity log. The warning message indicates that you must runa full incremental backup and logs a return code of 8 even if the operationcompleted successfully.This parameter is the default value.yesSpecifies that a full incremental is run by creating a new base snapshot andusing it to run a scan-based incremental backup. Use this option to backup anyfile changes that might not have been detected by the snapshot difference API.If the operation finished successfully, the command ends with a return code of0.It is recommended that you do not set createnewbase=yes for any schedulethat runs a daily snapshot difference backup. Instead, create a separate,monthly schedule that has the createnewbase=yes option.IGNoreSpecifies that a snapshot difference incremental backup is run when TivoliStorage Manager detects that the NetApp Data ONTAP file server wasupgraded to support Unicode file names.The ignore option is different from the no parameter because the ignore optionsuppresses the warning message. Instead, an informational message is recordedin the error log and the Tivoli Storage Manager activity log that tells you torun a full incremental backup.If the command finishes successfully, it returns a code of 0.Use the ignore option if you have upgraded the NetApp Data ONTAP fileserver to support Unicode but you have not yet run a full incremental backup.This option is used only when the Tivoli Storage Manager client has detected324 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

that the file server was migrated and a full incremental has not yet been run.The option is ignored for all other times.MIGRateSpecifies that if the NetApp Data ONTAP file server was upgraded to aversion that supports Unicode file names, a base snapshot is taken and ascan-based incremental backup runs. The migrate option is different from theyes option because the migrate option creates a base snapshot only whenTivoli Storage Manager detects that the NetApp Data ONTAP file serverversion was updated. The yes option creates a base snapshot every time thecommand is run.After the incremental backup finishes, no additional migration-relatedmessages are recorded to the error log or the Tivoli Storage Manager serveractivity log. When the operation finishes, the command ends with a returncode of 0.Use the migrate option if you have upgraded the NetApp Data ONTAP fileserver to support Unicode but you have not yet run a full incremental backup.The migrate option is ignored if the NetApp Data ONTAP file server has notbeen upgraded.ExamplesCommand line:dsmc incremental -snapdiff -createnewbase=yes /net/home1Related information“Snapdiff” on page 473“Configuring NetApp and Tivoli Storage Manager for snapshot differenceincremental backups” on page 70DatacenterSpecifies the target location of the data center that will contain the restoredmachine data.Use this option on vm restore commands.If folders are used within virtual center to organize datacenters, then the foldername needs to be included in the datacenter specification, separated by a slash.If you are restoring through a ESX server rather than a virtual center, the-datacenter=ha-datacenter option should be used.The default target location is the datacenter which the virtual machine was storedat the time of backup.ExamplesRestore a virtual machine to USEast datacenter which is organizaed under a foldernamed Production in the virtual center.dsmc restore vm my_vm -datacenter=Production/USEastRestore a virtual machine backup taken from a virtual center, but using a ESXserver at the time of restore.Chapter 11. Processing options 325

estore vm my_vm -datacenter=ha-datacenterRestore the virtual machine into the USWest datacenter.restore vm my_vm -datacenter=USWEstDatastoreSpecifies the datastore target to be used during VMware restore operation.ExampleRestore the virtual machine to a datacenter named ds8k_prod1restore vm my_vm -datacenter=ds8k_prod1DateformatThe dateformat option specifies the format you want to use to display or enterdates.Use this option if you want to change the default date format for the language ofthe message repository you are using.By default, the backup-archive and administrative clients obtain formatinformation from the locale definition in effect at the time you start the client.Consult the documentation on your local system for details about setting up yourlocale definition.Note:1. The dateformat option does not affect the Web client. The Web client uses thedate format for the locale that the browser is running in. If the browser is notrunning in a locale that Tivoli Storage Manager supports, the Web client usesthe date format for US English.2. When you change the date format and use the schedlogretention option toprune the schedule log, Tivoli Storage Manager removes all entries in theschedule log with a different date format when pruning the log. When youchange the date format and use the errorlogretention option to prune theerror log, Tivoli Storage Manager removes all entries in the error log with adifferent date when pruning the log. When changing the date format, copy theschedule log and error log if you want to preserve log entries that contain adifferent date format.You can use the dateformat option with the following commands.v delete archivev delete backupv expirev query archivev query asrv query backupv query filespacev query imagev query systemstatev restorev restore imagev restore nasv retrievev restore registry326 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvrestore systemstateset eventWhen you include the dateformat option with a command, it must precede thefromdate, pitdate, and todate options.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theRegional Settings tab, Date Format drop-down list of the Preferences editor.Syntax►► DATEformat format_number ►◄Parametersformat_numberDisplays the date using one of the following formats. Select the number thatcorresponds to the date format you want to use:1 MM/DD/YYYYThis is the default for the following available translations:v US Englishv Chinese (Traditional)v Korean2 DD-MM-YYYYThis is the default for the following available translations:v Brazilian Portuguesev Italian3 YYYY-MM-DDThis is the default for the following available translations:v Japanesev Chinese (Simplified)v Polish4 DD.MM.YYYYThis is the default for the following available translations:v Germanv Frenchv Spanishv Czechv Russian5 YYYY.MM.DDThis is the default for the following available translations:v Hungarian6 YYYY/MM/DD7 DD/MM/YYYYChapter 11. Processing options 327

ExamplesOptions file:dateformat 3Command line:-date=3This option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.Additional considerations for specifying time and date formatsThe date or time format you specify with this option must be used when usingoptions that take date and time as input. Examples are: totime, fromtime, todate,fromdate, and pittime.For example, if you specify the timeformat option as TIMEFORMAT 4, the value thatyou provide on the fromtime or totime option must be specified as a time such as12:24:00pm. Specifying 13:24:00 would not be valid because TIMEFORMAT 4 requiresan hour integer that is 12 or less. If you want to specify up to 24 hour values on anoption, and if you want to use commas as separators, you must specify TIMEFORMAT2.DedupcachepathUse the dedupcachepath option to specify the location where the client-side datadeduplication cache database is created.This option is ignored if the enablededupcache=no option is set during backup orarchive processing.Supported ClientsThis option is valid for all clients. This option is also valid for the Tivoli StorageManager client API.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theDeduplication → Deduplication Cache Location text box of the Preferences editor.The option can be set in the client option set on Tivoli Storage Manager server.Syntax►► DEDUPCACHEPath path ►◄ParameterspathSpecifies the location where the client-side data deduplication cache database iscreated if the enablededupcache option is set to yes. The default location is tocreate the data deduplication cache file in the Tivoli Storage Manager client orAPI installation directory.328 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:dedupcachepath c:\logs\dedup\Command line:Does not apply.Related reference:“Enablededupcache” on page 355DedupcachesizeUse the dedupcachesize option to determine the maximum size of the datadeduplication cache file. When the cache file reaches its maximum size, thecontents of the cache are deleted and new entries are added.Supported ClientsThis option is valid for all clients. This option is also valid for the Tivoli StorageManager client API.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theDeduplication → Deduplication Cache → Maximum Size field of the Preferenceseditor. The option can be set in the client option set on Tivoli Storage Managerserver.Syntax►► DEDUPCACHESize dedupcachesize ►◄ParametersdedupcachesizeSpecifies the maximum size, in megabytes, of the data deduplication cache file.The range of values is 1 - 2048; the default is 256.ExamplesOptions file:dedupcachesize 1024Command line:Does not apply.Related reference:“Deduplication”DeduplicationUse the deduplication option to specify whether to enable redundant client-sidedata elimination when data is transferred to the Tivoli Storage Manager serverduring backup and archive processing.Data deduplication is disabled if the enablelanfree or subfilebackup options areset. Tivoli Storage Manager client encrypted files are excluded from client-side datadeduplication. Files from encrypted file systems are also excluded.Chapter 11. Processing options 329

To support client-side data deduplication, the following criteria must be met:v Client-side data deduplication for the node is enabled on the Tivoli StorageManager server.v The storage pool destination for the data must be a storage pool that is enabledfor data deduplication. The storage pool must have a device type of "file".v A file can be excluded from client-side data deduplication processing (by defaultall files are included).v The server can limit the maximum transaction size for data deduplication bysetting the CLIENTDEDUPTXNLIMIT option on the server. Refer to the Administrator'sGuide for details.v The file size must be larger than 2 KB.Supported ClientsThis option is valid for all clients. This option is also valid on the Tivoli StorageManager client API.Options FilePlace this option in the client options file (dsm.opt). You can set this option byselecting the Deduplication → Enable Deduplication check box of the Preferenceseditor. The option can be set in the client option set on Tivoli Storage Managerserver.Syntax►►DEDUPLicationNoYes►◄ParametersNoYesSpecifies that you do not want to enable client-side data deduplication forbackup and archive processing. No is the default.Specifies that you want to enable client-side data deduplication for backup andarchive processing.ExamplesOptions file:deduplication yesCommand line:-deduplication=yesThis option is valid only on the initial command line. It is not valid in interactivemode.330 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Include options” on page 395“Exclude options” on page 365DeletefilesUse the deletefiles option with the archive command to delete files from yourworkstation after you archive them.You can also use this option with the restore image command and the incrementaloption to delete files from the restored image if they were deleted after the imagewas created. Deletion of files is performed correctly if the backup copy group ofthe Tivoli Storage Manager server has enough versions for existing and deletedfiles.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► DELetefiles ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc archive c:\foo\*.c –deletefilesdsmc rest image c: -incre -deletefilesDescriptionThe description option assigns or specifies a description for files when performingarchive, delete archive, retrieve, query archive, or query backupset.For example, if you want to archive a file named budget.jan and assign to it thedescription 2002 Budget for Proj 1, you would enter:dsmc archive –des="2003 Budget for Proj 1" c:\plan\proj1\budget.janNote:1. The maximum length of a description is 254 characters.2. Enclose the value in quotation marks (" ") if the option value that you entercontains a blank space.Use the description option with the following commands:v archivev delete archivev query archivev query backupsetv retrieveChapter 11. Processing options 331

Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► DEScription = description ►◄ParametersdescriptionAssigns a description to the file you are archiving. If you do not specify adescription with the archive command, the default is Archive Date:x, where xis the current system date. Note that the date is always 10 characters long. Ifyour date format uses a two digit year, there are two blank spaces at the endof the date. For example, a default description using a four-digit year might be"Archive Date: 2002/05/03", and the same default with a two-digit year mightbe "Archive Date: 02/05/03 " (note the two spaces at the end). Whenretrieving files using the two-digit year description, you can enter the-description option string in either of the following ways:-description="ArchiveDate: 02/05/03 "or-description="ArchiveDate: 02/05/03*"If you use the archive command to archive more than one file, the descriptionyou enter applies to each file. For example, to archive a group of files andassign the same description, Project X, to each file, you would enter:dsmc archive –description="Project X" c:\allproj\*.xYou can then use the description to retrieve all of the files.ExamplesCommand line:dsmc archive –des="2003 Budget for Proj 1" c:\foo\ *.prjDetail|||Use the detail option to display management class, file space, backup, archiveinformation, and additional information, depending on the command with which itis used.Use the detail option with the query mgmtclass command to display detailedinformation about each management class in your active policy set. If you do notuse the detail option, only the management class name and a brief description aredisplayed on the screen. If you specify the detail option, information aboutattributes in each copy group contained in each management class is displayed onthe screen. A management class can contain a backup copy group, an archive copygroup, both, or neither.A Unicode-enabled file space might not display correctly if the server cannotdisplay the Unicode name. In this case, use the file space identifier (fsID) of the filespace to identify these file spaces on the server. Use the detail option with the332 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

delete filespace and query filespace commands to determine the fsID of a filespace. The fsID also appears in the file information dialog in the backup-archiveclient and Web client GUIs.Use the detail option with the query backup and query archive commands todisplay these attributes of the file that you specify:v Last modification datev Last access datev Compressionv Encryption typev Client-side data deduplicationUse the detail option with the query adobjects command to display detailedinformation about Active Directory objects, including all of their attributes.|||||||||||||||Use the detail with the query vm command to display the following statistics:v The average number of Tivoli Storage Manager objects that are needed todescribe a single megablock, across all megablocks in a backup.v The average number of Tivoli Storage Manager objects that are needed todescribe a single megablock, for all megablocks in a filespace.v The ratio of the amount of data, reported by Change Block Tracking, versus theamount of data that was actually backed up, in a specific backup.v The ratio of the amount of data, reported by Change Block Tracking, versus theamount of data that was actually backed up, for all backups in this filespace.v The number of backups that were created since the last full backup was createdfrom the production disks.The values returned on query vm can help you fine tune the heuristics (see theMbobjrefreshthresh and Mbpctrefreshthresh options) to fine tune the valuestrigger for megablock refreshes.Use the detail option with the following commands:v delete filespacev query adobjectsv query archivev query backupv query filespacev query inclexclv query mgmtclassv query systemstatev query vmSupported Clients|||This option is valid for all clients. This option is not set in the client options file;use it by adding it to the command line when you enter any of the commands thatsupport it. The Tivoli Storage Manager client API does not support this option.Syntax►► DETail ►◄Chapter 11. Processing options 333

ParametersThere are no parameters for this option.ExamplesCommand line:|dsmc query mgmtclass -detaildsmc query filespace -detaildsmc query backup file1 -detaildsmc query systemstate -detaildsmc query vm -detailDiffsnapshotThe diffsnapshot option controls whether Tivoli Storage Manager should createthe differential snapshot when running a snapshot difference incremental backup .If the differential snapshot is not created by Tivoli Storage Manager, the latestsnapshot found on the volume is used as the differential snapshot and as thesource for the backup operation.The default value is to create the differential snapshot. This option is ignored thefirst time the snapdiff option is used. The first time the snapdiff option is used ona volume, a snapshot must be created and used as the source for a full incrementalbackup. Snapshots that are created by Tivoli Storage Manager are deleted by TivoliStorage Manager after the next snapshot difference incremental backup iscomplete.Snapshots can be created with the Network Appliance FilerView tool. Use thelatest parameter if you want Tivoli Storage Manager to use the most recentsnapshot that was created. Whatever method is used to create named snapshots,snapshot names differing only by case will not work properly with the snapdiffoption. Snapshots that are created by Tivoli Storage Manager will not have thecasing problem. Snapshots created by methods outside of Tivoli Storage Managerare never deleted by Tivoli Storage Manager.Supported ClientsThis option is valid for the following clients:v All Windows clients except IA 64 bitSyntax►►DIFFSNAPSHOTcreatelatest►◄ParameterscreateSpecifies that you want to create a new, persistent, snapshot to use as thesource snapshot. This is the default.334 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

latestSpecifies that you want to use the latest snapshot that is found on the fileserver as the source snapshot.ExamplesCommand line:Perform a snapdiff incremental backup from a snapshot that was taken ofa network share //homestore.example.com/vol/vol1 mounted on drive H:,where homestore.example.com is a file server.incremental -snapdiff H:Perform a snapdiff incremental backup from a snapshot that was taken ofan network share //homestore.example.com/vol/vol1 mounted on driveH:, where homestore.example.com is a file server. The -diffsnapshot optionvalue of LATEST means the operation uses the latest snapshot (the activesnapshot) for volume H:.incremental -snapdiffH: -diffsnapshot=latestRelated information“Snapdiff” on page 473“Createnewbase” on page 323“Configuring NetApp and Tivoli Storage Manager for snapshot differenceincremental backups” on page 70||||||||||||||||||DiffsnapshotnameThe diffsnapshotname option allows you to specify which differential snapshot, onthe target filer volume, to use during a snapshot differential backup. This option isonly specified if you also specify diffsnapshot=latest.If this option is not specified, diffsnapshot=latest selects the most recent existingsnapshot on the filer volume and uses it as the differential snapshot.Supported ClientsThis option can be used with supported Windows clients.Options FileThis option can be specified in the client options file or on the command line.Syntax►► DIFFSNAPSHOTName snapshot_name ►◄Parameterssnapshot_nameSpecifies the name of an existing snapshot to use as the differential snapshot.You can also use a pattern with wildcard characters to select a snapshot.Wildcards can be either of the following characters:Chapter 11. Processing options 335

|||||||||||||||* An asterisk (*) matches any character.? A question mark (?) matches a single character.The most recent snapshot that matches the wildcard pattern is selected as thedifferential snapshot.ExamplesOptions file:diffsnapshotname volume_base_snapdiffsnapshotname nightly.?Command line:dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff-useexistingbase -basenameshotname="nightly.?"-diffsnapshot=latest -diffsnapshotname="nightly.?"Related informationBasesnapshotnameUseexistingbaseDirmcThe dirmc option specifies the management class you want to use for directories.If you do not specify this option to associate a management class with directories,the client program uses the management class in the active policy set of yourpolicy domain with the longest retention period. Select a management class forindividual directories that retains directories at least as long as it retains the filesassociated with them.If you specify a management class with this option, all directories specified in abackup operation are bound to that management class.The dirmc option specifies the management class of directories that you back upand it does not affect archived directories. Use the archmc option with the archivecommand to specify the available management class for your policy domain towhich you want to bind your archived directories and files. If you do not use thearchmc option, the server binds archived directories to the default managementclass. If the default management class has no archive copy group, the server bindsarchived directories to the management class with the shortest retention period.Important: Only extended attributes and ACLs are stored in storage pools. Thedirectory information, other than extended attributes and ACLs, remains in thedatabase. On Windows systems, directories occupy storage pool space.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab, Directory Management Class section in the Preferences editor.336 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► DIRMc mgmtclassname ►◄ParametersmgmtclassnameSpecifies the name of the management class that you want to associate withdirectories. The client uses the management class name that you specify for allof the directories that you back up. If you do not specify this option, the clientassociates the management class with the longest retention period withdirectories.ExamplesOptions file:dirm managdirCommand lineDoes not apply.Related informationIf you want to back up specific files to a management class see “Assign amanagement class to files” on page 245 for more information.DirsonlyThe dirsonly option processes directories only. The client does not process files.Use the dirsonly option with the following commands:v archivev incrementalv query archivev query backupv restorev restore backupsetv retrievev selectiveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► DIrsonly ►◄ParametersThere are no parameters for this option.Chapter 11. Processing options 337

ExamplesCommand line:dsmc query backup -dirsonly c:*DisablenqrThe disablenqr option specifies whether the Tivoli Storage ManagerBackup-Archive Client can use the "no query restore" method for restoring filesand directories from the server.If you set the disablenqr option to no (the default), the client can use the "noquery restore" process.If you set the disablenqr option to yes, the client can use only the standard restoreprocess (also known as "classic restore").Note: There is no option or value to specify that the client can use only the "noquery restore" method.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Options FilePlace this option in the dsm.opt file.Syntax►►DISABLENQRNoYes►◄ParametersNoYesSpecifies that Tivoli Storage Manager can use the "no query restore" method.This is the default.Specifies that the client uses only the "standard restore" method. The "no queryrestore" method is not allowed.ExamplesOptions file:disablenqr yesCommand line-disablenqr=yesDiskbuffsizeThe diskbuffsize option specifies the maximum disk I/O buffer size (in kilobytes)that the client can use when reading files. The diskbuffsize option replaces thelargecommbuffers option.338 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Optimal backup, archive migration client performance can usually be achieved ifthe value for this option is equal to or smaller than the amount of file read aheadprovided by the client file system. A larger buffer requires more memory and itmight not improve performance.Important:personnel.Use the default setting, unless otherwise directed by IBM supportSupported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► DISKBuffsize size ►◄ParameterssizeSpecifies the maximum disk I/O buffer size (in kilobytes) that the client useswhen reading files. The range of values is 16 through 1023; the default is 32.ExamplesOptions file:diskbuffsize 64Command line:Does not apply.DiskcachelocationThe diskcachelocation option specifies the location where the disk cache databaseis created if the option memoryefficientbackup=diskcachemethod is set during anincremental backup.You can specify the diskcachelocation option in your option file, or with theinclude.fs option. If the diskcachelocation option appears in the option file, itsvalue is used for all file systems not represented by an include.fs optioncontaining the diskcachelocation option.The disk cache is a temporary file which is deleted after the incremental commandis run. Use this option to select one of the following:1. A location that has more free disk space if, when you are usingmemoryefficientbackup=diskcachemethod, you get the message that the diskcache file cannot be created because you do not have enough disk space.2. A location on a different physical volume to reduce contention for the diskaccess mechanism, and therefore improve performance.Important: For performance reasons, do not use a remote drive fordiskcachelocation.Chapter 11. Processing options 339

The actual amount of disk space required for the disk cache file created by diskcache incremental backups depends on the number of files and directories includedin the backup and on the average length of the files and directories to be backedup. Estimate 2 bytes per character in the path name. For example, if there are 1 000000 files and directories to be backed up and the average path length is 200characters, then the database occupies approximately 400 MB. Another way toestimate for planning purposes is to multiply the number of files and directoriesby the length of the longest path to establish a maximum database size.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►► DISKCACHELocation path ►◄DomainParameterspathSpecifies the location where the disk cache database is created ifmemoryefficientbackup is set to diskcachemethod. The default location is tocreate the disk cache file in the root of the file space being processed.ExamplesOptions file:diskcachelocation c:\tempdiskcachelocation c:\tivoli\dataCommand line:Does not apply.See “Include options” on page 395 for more information about include.fs.The domain option specifies what you want to include for incremental backup.Domain objects are backed up only if you invoke the incremental commandwithout a file specification.Tivoli Storage Manager uses the domain value in the following situations todetermine which drives to process during an incremental backup:vvvWhen you run an incremental backup using the incremental command and youdo not specify which drives to processWhen your Tivoli Storage Manager administrator defines a schedule to run anincremental backup for you, but does not specify which drives to processWhen you select the Backup Domain action from the Tivoli Storage Managerbackup- archive client GUI340 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

There are several places where the domain option can be defined:v In an options filev On the command line, when entered with a Tivoli Storage Manager commandv In a client option set, defined on the Tivoli Storage Manager server with thedefine clientopt commandv As an option on a scheduled command, defined on the Tivoli Storage Managerserver with the define schedule commandIf any of these sources contain a domain definition, the client backs up thatdomain. If more than one source specifies a domain, the client backs up allspecified domains. The same domain object can be defined more than once, but theeffect is the same as defining it only once. If you do not specify a domain, TivoliStorage Manager backs up the default domain, as described in the all-localparameter.You can exclude objects from the domain by specifying the exclusion operator (-)before the object. If any domain definition excludes an object, that object isexcluded from the domain, even if another definition includes the object. Youcannot use the domain exclusion operator (-) in front of any domain keyword thatbegins with all-.If you invoke the incremental command with a file specification, Tivoli StorageManager ignores any domain definitions and backs up only the file specification.Supported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the options file, dsm.opt. You can set this option on the Backuptab, Domain for Backup section of the Preferences editor.Syntax►►DOMain▼all-localobject-objectsystemstate-systemstate►◄Parametersall-localBack up all local volumes on the system, and the Windows system state. Thisis the default setting. Local volumes are defined as volumes which areformatted with a supported file system (NTFS, FAT32, FAT, or GPFS) on adirect-attached storage device, including SAN and iSCSI attached storage.Directories mapped to drive letters using the Windows subst command areincluded in a backup if the mapped directory is on a local disk.The following types of volumes are not included when all-local is specified:Chapter 11. Processing options 341

|||vNetwork attached volumes including CIFS shares which are mapped todrive letters.v Removable volumes including CD/DVD drives, USB thumb drives, andfloppy diskette drives. Some USB-attached hard disks are included in theall-local domain if Windows does not classify them as a removable storagedevice.objectSpecifies the domain objects to include in the domain.An object name must be enclosed in quotation marks if the name includes anyspaces.-objectSpecifies the domain objects to exclude from the domain.An object name must be enclosed in quotation marks if the name includes anyspaces.systemstateBack up the Windows system state. The systemstate domain is included in theall- local domain.-systemstateExclude system state from backup processing.ExamplesOptions file:An options file can contain more than one domain statement. However,each of the domain statements are an example of a single statement in anoptions file.domainc: d: e:domain c: systemstatedomain ALL-LOCAL -systemstatedomain ALL-LOCAL -c:domain ALL-LOCAL -\\florence\e$A single domain statement can list one or more objects for the domain. Youcan use more than one domain statement. The following two examplesfrom two options files yield the same domain result:Example 1...domain fs1domain all-localdomain -fs3...Example 2...domain all-local fs1 -fs3...Command line:-domain=“c: d:”-domain="ALL-LOCAL -c: -systemstate"342 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Domain definition interactionDomain can be defined in several sources, and the result is a summation of alldomain definitions. As an example of the interaction of domain definitions,consider how domain definitions from several sources yield different backupresults. In the table, FS followed by a number (for example, FS1) is a drive. Thistable shows only commands that are entered on the command line. For scheduledcommands, the command line column is not relevant, and options from thescheduled command must be considered.Table 59. Interaction of domain definitions from several sourcesObjects backed up usingOptions file Command line Client option setthe incremental commanddomain FS1 incremental -domain=FS2 domain FS3 FS1 FS2 FS3domain FS1 incremental domain FS3 FS1 FS3incremental -domain=FS2FS2incremental -domain=FS2 domain FS3 FS2 FS3incremental domain FS3 FS3incrementalall-localdomain all-local incremental domain FS3 all-local + FS3domain all-localincrementalall-local, but not FS1domain -FS1domain -FS1 incremental nonedomain FS1 FS3 incremental domain -FS3 FS1domain all-local incremental domain -FS3 all-local, but not FS3incremental FS1FS1-domain=all-localincremental FS1 domain all-local FS1domain -FS1 incremental FS1 FS1Related informationDomain.imageThe domain.image option specifies what you want to include in your client domainfor an image backup.Raw logical volumes must be named explicitly.If you do not specify a file system with the backup image command, the filesystems you specify with the domain.image option are backed up.When you specify a file system with the backup image command, thedomain.image option is ignored.If you do not use the domain.image option to specify file systems in your clientoptions file, and you do not specify a file system with the backup imagecommand, a message is issued and no backup occurs.Chapter 11. Processing options 343

Supported ClientsThe server can also define this option. The Tivoli Storage Manager client API doesnot support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab → Domain for Backup box of the Preferences editor.Syntax►►DOMAIN.Image▼domain►◄ParametersdomainDefines the file systems or raw logical volumes to include in your defaultclient image domain.ExamplesOptions file:domain.image d: e: f: domain.image f:\mnt\raw\rawmnt1f:\mnt\fs\fsmnt1Command line:Does not apply.Domain.nasThe domain.nas option specifies the volumes to include in your NAS imagebackups.You can specify all-nas to include all the mounted file systems on the NAS fileserver, except those you exclude with the exclude.fs.nas option.Tivoli Storage Manager uses your domain for NAS image backups when you run abackup nas command and you do not specify which volumes to process.When you use this option in your client system options file (dsm.opt), thedomain.nas option defines your default domain for NAS image backups.When you perform a NAS file system image backup using the backup nascommand, Tivoli Storage Manager adds volumes that you specify on the commandline to the volumes defined in your dsm.opt file. For example, if you enterdomain.nas nas1/vol/vol0 nas1/vol/vol1 in your dsm.opt file and you enter dsmcbackup nas -nasnodename=nas1 /vol/vol2 on the command line, Tivoli StorageManager backs up the vol/vol0, vol/vol1, and vol/vol2 volumes on node nas1.If you set the domain.nas option to all-nas in the dsm.opt file, Tivoli StorageManager backs up all mounted volumes on the NAS file server. When performinga backup, if you use a file specification and set the domain.nas option to all-nas inthe dsm.opt file, all-nas takes precedence.344 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►►DOMAIN.Nas▼all-nasdomain►◄ParametersdomainDefines the volumes you want to process. You cannot exclude volumes byspecifying the dash (-) operator.all-nasProcesses all mounted volumes on the NAS file server, except those youexclude with the exclude.fs.nas option. This is the default. If there is nodomain.nas statement in the dsm.opt file and no volumes specified on thecommand line, Tivoli Storage Manager backs up all mounted volumes on theNAS server.ExamplesOptions file:domain.nas nas1/vol/vol0 nas1/vol/vol1domain.nas all-nasCommand line:Does not apply.Domain.vmfile||The domain.vmfile option specifies the virtual machines to include when youperform off-host file-level backups of VMware virtual machines.VMware file-level backups are only available for Windows guests backupsperformed from a Windows backup proxy. Template virtual machines are notincluded in file-level backups.|||The virtual machines specified with the domain.vmfile option are only processedwhen the backup vm command is issued without a virtual machine, a list ofvirtual machines, or the -vmlist option specified.You can specify the all-windows domain to include all Windows virtual machinesthat are defined to the Virtual Center or to the ESX Server that is specified on thevmchost option.Chapter 11. Processing options 345

Supported ClientsThis option is valid for Windows clients. The server can also define this option.This option is not valid for Hyper-V backups.Options FilePlace this option in the client options file (dsm.opt), or on the command line. Youcan also set this option on the VM Backup tab of the Preferences editor.|Syntax||►►DOMAIN.VMFIle▼;vmname1,vmname2VM=vmname1,vmname2-VM=vmname1,vmname2ALL-WINdowsVMHost=srv1,srv2VMFolder=foldername1,foldername2VMHOSTCLUSTER=cluster1,cluster2VMDATASTORE=datastore1,datastore2►◄||||||||||||Important: Multiple keywords must be separated by a semicolon. There cannot beany spaces following the semicolons. Multiple machine or domain names must beseparated by commas, with no space characters. See vm=vmname for examples.You can use these keywords to easily add groups of virtual machines:all-windowsvmhostvmfoldervmhostclustervmdatastoreWhen you include virtual machines by using one of the above domain levels,Tivoli Storage Manager detects any new virtual machines added to the domainafter the initial VMware environment was set up.ParametersvmnameDefines the virtual machine host name you want to process or a list of virtualmachine host names separated by commas.vm=vmnameThe VM keyword specifies that the next set of values are virtual machine hostnames. VM is the default and it is not required.-vm=vmnameYou can exclude individual virtual machines from the domain by specifyingthe exclude operator (-) before the vmname. For example, -VM=vm1,vm2excludes the vm1 and vm2 virtual machines from a backup operation. Youcannot use any domain exclusion operator (-) in front of any domainkeywords.346 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||all-windowsProcess all virtual machines that are defined to the Virtual Center or the ESXserver that is specified on the vmchost option, that have a guest operatingsystem type of Windows. All-windows also allows for automatic inclusion ofnewly added virtual machines.vmhost=hostnameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. All newly added to this host areautomatically included in backup and restore processing. To be include, thevirtual machines must also be running on the ESX server that is specified bythe host name. This parameter can include multiple ESX servers separated bycommas. When the Virtual Center contains multiple ESX servers, this optiondoes not determine the ESX server from which a snapshot is taken. The ESXserver from which a snapshot is taken is determined by the VMwareVirtualCenter web service.When you connect directly to an ESXi or ESX host, the vmhost keywordapplies only if the vmhost is the ESXi you connect to. If it is not, a warninglevel message is issued to the console and is recorded in the clientdsmerror.log; it is also recorded as a server event message.vmfolder=foldernameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the VMCHOST that is defined as residing in theVMware folder specified by the folder name. Folder name can include multipleVMware folders separated by commas. Allows for automatic inclusion ofnewly added virtual machines.vmhostcluster=hostclusternameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsobe running on the ESX host cluster that is specified by the host cluster name.To include more than one host cluster name, separate the cluster names withcommas: VMHOSTCLUSTER=cluster1,cluster2.A VMware host cluster is not available if you connect directly to an ESXi orESX host. If you connect directly to an ESXi/ESX host and a domain isprocessed that includes a host cluster, a warning level message is issued to theconsole and is recorded in the client dsmerror.log; it is also recorded as aserver event message.vmdatastore=datastorenameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsohave its configured datastore location match the datastore name that isspecified by datastorename. The datastore name can include multiple datastoresseparated by commas: VMDATASTORE=datastore1,datastore2It is possible for virtual machines to have their disk (vmdk files) on more thanone datastore; but there is only one default datastore location. This defaultdatastore location is defined in the virtual machine configuration and is alwayswhere the virtual machine configuration file (.vmx file) is located. When amachine is selected for backup by using a domain keyword, the virtualmachine configuration file, and all of the virtual machine's disks are includedin the backup, including the disks that are located on a different datastore thanthe one specified on the domain.Chapter 11. Processing options 347

ExamplesOptions file:File-level backup of all virtual machines running on Windows operatingsystems.domain.vmfile all-windowsFile-level VM backup of all virtual machines defined to VM folder TSMSvtand TSMdev.domain.vmfile "vmfolder=TSMSvt,TSMdev"File-level VM backup of all virtual machines defined to VM foldersTSMSvt and TSMdev and virtual machines testvm1 and testvm2.domain.vmfile "vmfolder=TSMSvt;VM=testvm1,testvm2"Process all Windows virtual machines for file-level backup vm command,except for the virtual machines named machine1 and machine 2.domain.vmfile "all-windows;-vm=machine1,machine2"Process the virtual machines vm1 and vm2 during a file-level backup.-domain.vmfile="vm1,vm2"Command line:dsmc backup vm -domain.vmfile="vm1,vm2"Domain.vmfull|||||||||||||||||||||||The domain.vmfull option specifies the virtual machines to include in your full VMimage backupsThe domain.vmfull option works in conjunction with the vmchost option. Thevmchost option identifies the vCenter server or ESX server that contains the virtualmachines that you want to protect. The domain.vmfull parameters are used tonarrow the focus of an operation to a subset of the virtual machines that arerunning on the system identified by vmchost.You can specify which virtual machines are to be processed by using any of thefollowing techniques:v Use the VM= option and specify the name of a virtual machine.v Provide a comma separated list of virtual machine names.v Use wildcard syntax to process virtual machines that match the name pattern.v Use one of the domain-level parameters.The domain-level parameters are the following:all-vmall-windowsvmhostvmfoldervmhostclustervmdatastoreWhen you use domain-level keywords, virtual machines that are created in thedomain are automatically included when the next backup occurs. For example, ifyou use the vmfolder parameter to back up all virtual machines included in a348 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||folder, any new virtual machines that get added to that folder are included in thenext backup. The same is true of pattern-matched names that are included in awildcard match.The virtual machines specified on the domain.vmfull option are processed onlywhen the backup vm command is issued without specifying a virtual machine or alist of virtual machines on the command line.|||This option is not used to back up or restore Hyper-v systems. Hyper-V systembackup and restore operations are performed only on the Hyper-v virtual machinesthat are specified on the command line, or on the -vmlist option.Supported ClientsThis option can be used with supported Windows clients.The server can also define this option.Options file|||||Set this option in the client options, using the command line, or by using the VMBackup tab of the Preferences editor. Note that the vmname:vmdk=vmdk_labelparameters cannot be set in the Preferences Editor; set it in the options file, or onthe command line when running a backup vm command.Syntax||►►DOMAIN.VMFUll▼;vmname1,vmname2VM=vmname1,vmname2-VM=vmname1,vmname2ALL-VMALL-WINdowsVMHost=srv1,srv2VMFolder=foldername1,foldername2VMHOSTCLUSTER=cluster1,cluster2VMDATASTORE=datastore1,datastore2►◄|||||||||Important: Multiple keywords must be separated by a semicolon. There cannot beany spaces afer the semicolons. Multiple machine or domain names must beseparated by commas, with no space characters. See vm=vmname for examples.ParametersvmnameDefines the virtual machine name that you want to process. You can supply alist of virtual machine host names, by separating the names with commas(vm1,vm2,vm5).vm=vmnameThe VM keyword specifies that the next set of values are virtual machinenames. vm= is the default and is not required.In this example, vm= is not specified and commas are used to separate themachine names.domain.vmfull my_vm1,my_vm2Chapter 11. Processing options 349

||||||||||||||||||||||||||||||||||||||||||||||||If you specify multiple keywords, like vm= or vmfolder=, the values that thekeywords refer to must be separated by semicolons, with no intervening spacecharacters:domain.vmfull vm=my_vm1;vm=my_vm2domain.vmfull vm=my_vm1;vmfolder=folder1;vmfolder=folder2Wildcards can be used to select virtual machine names that match a pattern.An asterisk (*) matches any sequence of characters. A question mark (?)matches any single character. Examples are: -vm=*test* (excludes all virtualmachines that have “test” in the hostname), vm=test2? (includes all virtualmachines with names like test20, test25, test29, test2A, and so on.)You can exclude a virtual machine from a backup operation by specifying theexclude operator (-) before the vm= keyword. For example, -vm is used toexclude a particular machine, or machines, from a domain level backup (suchas, ALL-Windows, ALL-VM, VMFolder, and so on). If “vm1” is the name of avirtual machine in a folder called “accountingDept”, you can back up all of thevirtual machines in the folder, but prevent the virtual machine named vm1from being backed up, as follows:domain.vmfull VMFolder=accountingDept;-vm=vm1You cannot use the exclude operator (-) to exclude a domain, such as ALL-VM,ALL-Windows, or VMFolder; it works only at the virtual machine name level.vmname:vmdk=vmdk_labelThis :vmdk= keyword requires a Tivoli Storage Manager for VirtualEnvironments license.This option is typically used to exclude disks (see the :-vmdk syntax) that arebacked up by other means, such as by Tivoli Data Protection products that runin the virtual machine. You can also include virtual machine disks by using the“INCLUDE.VMDISK” on page 401 option or exclude virtual machine disks byusing the “EXCLUDE.VMDISK” on page 370option.Detailed guidance for excluding disks when backing up VMware virtualmachines is provided in the IBM Tivoli Storage Manager for Virtual EnvironmentsVersion 6.4 Data Protection for VMware Installation and User's Guide.The virtual disks within a virtual machine have disk labels that uniquelyidentify each virtual disk. The :vmdk= keyword allows you to specify the labelsof the virtual disks that you want to be included in a Backup VM operation. Ifyou do not specify :vmdk= and a disk label, all virtual disks in the virtualmachine are backed up.Assume that there is a virtual machine named “my_vm_example”. This virtualmachine has four disks (labeled Hard Disk 1, Hard Disk 2, Hard Disk 3,Hard Disk 4). To include only Hard Disk 2 and Hard Disk 3 in a backup, addthe :vmdk= keyword and disk label for those disks. Quotation marks arenecessary around the parameters because the disk labels contain spacecharacters. For example:domain.vmfull "my_vm_example:vmdk=Hard Disk 2:vmdk=Hard Disk 3"This next example backs up Hard Disk 1 and Hard Disk 2 on VM1, and HardDisk 3 and Hard Disk 4 on VM2. A comma is used to separate the virtualmachine information.domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2","vm2:vmdk=Hard Disk 3:vmdk=Hard Disk 4"350 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||||Like the -vm= keyword, you can also use the exclusion operator (-) with :vmdk=to exclude disks from a backup operation.To back up a virtual machine (vm1) and exclude disks 3 and 4, use thefollowing syntax:domain.vmfull "vm1:-vmdk=Hard Disk 3:-vmdk=Hard Disk 4"To back up two virtual machines, vm1 and vm2, and exclude the first twodisks on each machine, use the following syntax:domain.vmfull "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2","vm2:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2"You can include one or more disks on a domain.vmfull statement. You canexclude one or more disks on a domain.vmfull statement. You can mix includeand exclude disks on the same statement. For example, the following statementis valid:domain.vmfull"vm1:Hard Disk 1:-vmdk=Hard Disk 2:vmdk=Hard Disk 3:vmdk:Hard Disk 4"If an include statement is present, it causes all other disks in the virtualmachine to be excluded from a backup operation, unless the other disks arealso specified on an include statement. For example, the following statementexcludes all hard disks on vm1, except for Hard Disk 1:domain.vmfull "vm1:vmdk=Hard Disk 1"Both of the following exclude Hard Disk 4 from a backup of vm1:domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"domain.vmfull "vm1:-vmdk=Hard Disk 4"all-vmProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option.all-windowsProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsohave a guest operating system type of Windows.vmhost=hostnameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. All virtual machines that areadded to this host are automatically included in backup and restore processing.To be included, the virtual machines must also be running on the ESX serverthat is specified by the host name; they cannot be powered off.This parameter can include multiple ESX servers separated by commas. Whenthe Virtual Center contains multiple ESX servers, this option does notdetermine the ESX server from which a snapshot is taken. The ESX server fromwhich a snapshot is taken is determined by the VMware VirtualCenter webservice.When you connect directly to an ESXi or ESX host, the vmchost option appliesonly if the vmhost is the server that you connect to. If it is not, a warning levelmessage is issued to the console and is recorded in the client dsmerror.log; itis also recorded as a server event message.If the vmenabletemplatebackups option is set to yes, and VM templates are partof the domain, they are included in the backup.Note: VMware templates virtual machines cannot be backed up when they arein an ESX or ESXi host because ESX and ESXi hosts do not support templates.Chapter 11. Processing options 351

||||||||||||||||||||||||||||||||||||||||||||||vmfolder=foldernameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsoexist in the VMware folder that is specified by the folder name. Folder namecan include multiple VMware folders separated by commas.vmhostcluster=hostclusternameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsobe running on the ESX host cluster that is specified by the host cluster name.To include more than one host cluster name, separate the cluster names withcommas: VMHOSTCLUSTER=cluster1,cluster2.If the vmenabletemplatebackups option is set to yes, and VM templates are partof the domain, they are included in the backup. A VMware host cluster is notavailable if you connect directly to an ESXi or ESX host. If you connect directlyto an ESXi/ESX host and a domain is processed that includes a hostcluster, awarning level message is issued to the console and is recorded in the clientdsmerror.log; it is also recorded as a server event message.vmdatastore=datastorenameProcess all virtual machines that are defined to the Virtual Center or to the ESXserver that is specified on the vmchost option. The virtual machines must alsohave its configured datastore location match the datastore name that isspecified by datastorename. The datastore name can include multiple datastoresseparated by commas: VMDATASTORE=datastore1,datastore2It is possible for virtual machines to have their disk (vmdk files) on more thanone datastore; but there is only one default datastore location. This defaultdatastore location is defined in the virtual machine configuration and is alwayswhere the virtual machine configuration file (.vmx file) is located. When amachine is selected for backup by using a domain keyword, the virtualmachine configuration file, and all of the virtual machine's disks are includedin the backup, including the disks that are located on a different datastore thanthe one specified on the domain.ExamplesOptions file:Perform a full VM backup of all virtual machines.domain.vmfull all-vmPerform a full VM backup of all virtual machines that have Windows asthe operating system.domain.vmfull all-windowsPerform a full VM backup of all virtual machines in cluster servers 1, 2,and 3.domain.vmfull vmhostcluster=cluster1,cluster2,cluster3Back up all virtual machine data in datastore1.domain.vmfull vmdatastore=datastore1Perform a full VM backup of all virtual machines, but exclude virtualmachines testvm1 and testmvm2.domain.vmfull all-vm;-VM=testvm1,testvm2Perform a full VM backup of the virtual machines that are defined in theVM folders named lab1 and lab2.352 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||domain.vmfull vmfolder=lab1,lab2Perform a full VM backup of all virtual machines on the ESX hosts namedbrovar, doomzoo, and kepler.domain.vmfull vmhost=brovar.example.com,doomzoo.example.com,kepler.example.comCommand line:Back up virtual machines name testvm1 and testvm2. On testvm1, includeonly Hard Disk 2 and Hard Disk 3; include all disks on testvm2 in thebackup.dsmc backup vm "testvm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3",testvm2Back up virtual machine testvm1, and exclude Hard Disk 1 and Hard Disk4.dsmc backup vm "testvm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 4"Back up all virtual machines running on the ESX server named brovar,doomzoo, and kepler.dsmc backup vm -domain.vmfull="VMHOST=brovar.example.com,doomzoo.example.com,kepler.example.com"Related reference:“EXCLUDE.VMDISK” on page 370“INCLUDE.VMDISK” on page 401Enable8dot3namesupportThe enable8dot3namesupport option specifies whether the client backs up andrestores short 8.3 names for files that have long names on NTFS file systems.Supported ClientsThis option is valid for all Windows clients.A file with a long file name might not have a short 8.3 name if short namegeneration is disabled on the Windows system. This option is effective only forNTFS file systems.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab of the Preferences editor.Syntax►►ENABLE8DOT3NAMESupportNoYes►◄ParametersNoShort 8.3 names for files with long file names are not backed up or restored.This is the default.YesShort 8.3 names for files with long file names are backed up and restored.Chapter 11. Processing options 353

Each short name uses up to 14 additional bytes in the server database.Although this is a small number, if there are a large number of files with short8.3 names on a large number of Windows systems, this can impact the size ofthe Tivoli Storage Manager server database.Important: Consult with your Tivoli Storage Manager server administrator beforeusing this option.The first backup that runs with this option causes all files that have short 8.3names to be updated on the Tivoli Storage Manager server, even if the files havenot otherwise changed. This is because the client is adding the short 8.3 names tothe active backup versions.If this option is enabled for restore, the client attempts to set the short 8.3 name forrestored files, even if short name generation is disabled on the Windows system.The client must run under a Windows account that possesses theSE_RESTORE_NAME privilege in order for this option to be effective. See yoursystem administrator if you have questions about account privileges.During restore, the short 8.3 name of a file is not restored if another object in thesame directory already has the same short 8.3 name. In this case, the file is restoredand an informational message is logged indicating that the short name could notbe set. If the file must be restored with its original short name, you need to resolvethe conflict with the existing file, and then try the restore again.Important: This parameter can cause unexpected results in some cases. Forexample, if the short name of a file changes between the last time the file wasbacked up and the time it is restored, and there is a link or registry entry thatrefers to the newer short name, then restoring the file with the older short nameinvalidates the references to the newer short name.ExamplesOptions file:enable8dot3namesupport yesCommand line:-enable8dot3namesupport=yesEnablearchiveretentionprotectionThe enablearchiveretentionprotection option allows the client to connect to aTivoli Storage Manager data retention server. This ensures that archive objects willnot be deleted from the server until policy-based retention requirements for thatobject have been satisfied.This option is ignored if the client connects to a server that is not retentionprotection enabled. If the option is no (the default) and an attempt is made toconnect to a data retention server, the connection is refused.The data retention server is specially configured for this task, so normal backup orrestore processing is rejected by the server. When the client is connected to a dataretention server, the following commands will not be available. If you attempt touse these commands, a message is displayed indicating that they are not validwith this server.v incrementalv backup (all subcommands)354 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

v selectivev restore (all subcommands except restore backupset -location=file or-location=tape)vvvvvNote: restore backupset -location=file or -location=tape do not connect toany server (except the virtual one) and thus will not be blocked under anycircumstances.restart restoredelete backupdelete groupexpireAll queries except:– query access– query archive– query filespace– query inclexcl– query managementclass– query node– query options– query schedule– query session– query systeminfo– query tracestatusSupported ClientsThis option is valid for all clients.Options FileThis option is valid only in client options file (dsm.opt) and is not valid in a clientoption set from the server. It is not valid on any command line.Syntax►►ENABLEARCHIVERETENTIONProtectionNoYes►◄ParametersNo The data retention server connection is refused. This is the default.YesThe client connects to a data retention server.EnablededupcacheUse the enablededupcache option to specify whether you want to use a cacheduring client-side data deduplication. Using a local cache can reduce networktraffic between the Tivoli Storage Manager server and the client.When you perform a backup or archive operation with the data deduplicationcache enabled, the specification of data extents that are backed up or archived aresaved to the cache database. The next time you run a backup or archive, the clientChapter 11. Processing options 355

queries the data deduplication cache and identifies the extents of data that havebeen previously saved to the server. Data extents that are identical to data extentson the server are not resent to the server.If the server and the cache are not synchronized, the cache is removed and a newone is created.Only one process can access the distributed data deduplication cache at a time.Concurrent backup instances on a workstation, that use the same server andstorage pool, must either use unique node names or unique cache specifications. Inthis way, all the instances can use a local cache and optimize the client-side datadeduplication.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API alsosupports this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theDeduplication → Enable Deduplication Cache check box of the Preferences editor.The option can be set in the client option set on Tivoli Storage Manager server.Syntax►►ENABLEDEDUPCacheYes*No►◄ParametersYesNoSpecifies that you want to enable data deduplication cache. If datadeduplication is not enabled, this setting is not valid. Yes is the default for theTivoli Storage Manager client. No is the default for the Tivoli Storage ManagerAPI.Specifies that you do not want to enable data deduplication cache.ExamplesOptions file:enablededupcache noCommand line:-enablededupcache=noThis option is valid only on the initial command line. It is not valid in interactivemode.356 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related reference:“Deduplication” on page 329“Dedupcachepath” on page 328“Dedupcachesize” on page 329EnablelanfreeThe enablelanfree option specifies whether to enable an available LAN-free pathto a storage area network (SAN) attached storage device.A LAN-free path allows backup, restore, archive, and retrieve processing betweenthe Tivoli Storage Manager client and the SAN-attached storage device.To support LAN-free data movement you must install and configure the TivoliStorage Manager Managed System for SAN Storage Agent on the clientworkstation. For more information, refer to IBM Tivoli Storage Manager for WindowsStorage Agent User's Guide.||||Note:1. If you place the enablelanfree option in the client option file (dsm.opt), butzero (0) bytes were transferred through the SAN during an operation, ensurethat you bind the data to a LAN-free enabled management class.2. To restore backup sets in a SAN environment, see “Restore Backupset” onpage 631 for more information.3. When a LAN-free path is enabled, the SAN Storage Agent settings override theclient tcpserveraddress, tcpport, and ssl options. This override action occursto ensure that both the client and the Storage Agent use the same servercommunication options.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt). You can also set this option byselecting the Enable Lanfree check box on the General tab in the Preferenceseditor.Syntax►►ENABLELanfreeNoYes►◄ParametersYesNoSpecifies that you want to enable an available LAN-free path to aSAN-attached storage device.Specifies that you do not want to enable a LAN-free path to a SAN-attachedstorage device. This is the default.Chapter 11. Processing options 357

ExamplesOptions file:enablelanfree yesCommand line:-enablelanfree=yesThis option is valid only on the initial command line. It is not valid in interactivemode.Related informationTo specify a communication protocol between the Tivoli Storage Manager clientand Storage Agent, see “Lanfreecommmethod” on page 407.EncryptiontypeThe encryptiontype option allows you to choose the algorithm for data encryption.The encryptiontype option allows you to use AES 128-bit data encryption,providing a stronger form of data encryption than DES 56-bit data encryption. Theencryption type only affects backup and archive operations. The data that youinclude is stored in encrypted form, and encryption does not affect the amount ofdata sent or received. During restore and retrieve operations, the encrypted data isdecrypted with the proper encryption algorithm, regardless of the setting for thisoption.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can also set this option onthe Authorization tab of the Preferences editor. The server can override this.Syntax►►ENCRYPTIONTypeAES128DES56►◄ParametersAES128AES 128-bit data encryption. AES 128-bit data encryption provides a strongerform of data encryption than DES 56-bit data encryption. This is the default.DES56DES 56-bit data encryption.ExamplesOptions file:encryptiontype des56Command line:Does not apply.358 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

EncryptkeyThe Tivoli Storage Manager client supports the option to encrypt files being backedup or archived to the Tivoli Storage Manager server. This option is enabled withthe include.encrypt option.All files matching the pattern on the include.encrypt specification are encryptedbefore the data is sent to the server. There are three options for managing the keyused to encrypt the files (prompt, save, and generate). All three options can beused with either the backup-archive client or the Tivoli Storage Manager API.The encryption key password is case-sensitive and can be up to 63 characters inlength and include the following characters:A-Z Any letter, A through Z, uppercase or lowercase. You cannot specifynational language characters.0-9 Any number, 0 through 9+ Plus. Period_ Underscore- Hyphen& AmpersandNote:1. The Tivoli Storage Manager API has an alternate way of specifyingencryptkey=generate; the previous enableclientencryptkey=yes option canalso be specified to request generate encryption processing.2. The enableclientencryptkey=yes API option is still supported, so it is possiblewhen using the API to specify two conflicting options. For example,enableclientencryptkey=yes and encryptkey=prompt or encryptkey=save.3. When conflicting values are specified, the Tivoli Storage Manager API returnsan error message.Attention: When using the prompt option, your encryption key is not saved inthe Windows Registry. If you forget the key, your data cannot be recovered.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theAuthorization tab, Encryption Key Password section of the Preferences editor.Syntax►►ENCRYPTKeysavepromptgenerate►◄ParameterssaveThe encryption key password is saved in the Tivoli Storage Manager client'sChapter 11. Processing options 359

password file. A prompt is issued for an initial encryption key password, andafter the initial prompt, the saved encryption key password in the passwordfile is used for the backups and archives of files matching the include.encryptspecification. The password can be up to 63 bytes in length. The key isretrieved from the password file on restore and retrieve operations.When the save option is specified for an API application, the initial keypassword must be provided by the application using the API in the dsmInitExfunction call. The API itself does not issue a prompt to the user but relies onthe application to prompt the user as necessary.This is the default.Note: The following restrictions apply:v This option can only be used when passwordaccess generate is alsospecified.v The root user or a Tivoli Storage Manager authorized user must specify theinitial encryption key password.promptThe management of the encryption key password is provided by the user. Theuser is prompted for the encryption key password when the Tivoli StorageManager client begins a backup or archive. A prompt for the same password isissued when restoring or retrieving the encrypted file. This password can beup to 63 bytes in length.When the prompt option is specified for an API application, the key passwordmust be provided by the application using the API in the dsmInitEx functioncall. The API itself does not issue a prompt to the user but relies on theapplication to prompt the user as necessary.generateAn encryption key password is dynamically generated when the Tivoli StorageManager client begins a backup or archive. This generated key password isused for the backups of files matching the include.encrypt specification. Thegenerated key password, in an encrypted form, is kept on the Tivoli StorageManager server. The key password is returned to the Tivoli Storage Managerclient to enable the file to be decrypted on restore and retrieve operations.ExamplesOptions file:encryptkey promptCommand line:Does not apply.ErrorlogmaxThe errorlogmax option specifies the maximum size of the error log, in megabytes.The default name for the error log is dsmerror.log.Log wrapping is controlled by the errorlogmax option. If errorlogmax is set to zero(0), the size of the log is unlimited; logged entries never “wrap” and beginoverwriting earlier logged entries. If errorlogmax is not set to zero, the newest logentries overwrite the oldest log entries after the log file reaches its maximum size.360 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Log pruning is controlled by the errorlogretention option. Pruned logs do notwrap. Instead, log entries that are older than the number of days specified by theerrorlogretention option are removed from the log file.If you change from log wrapping (errorlogmax option) to log pruning(errorlogretention option), all existing log entries are retained and the log ispruned using the new errorlogretention criteria. Pruned log entries are saved ina file called dsmerlog.pru.If you change from using log pruning (errorlogretention option) to using logwrapping (errlogmax option), all records in the existing log are copied to thedsmerlog.pru log file, the existing log is emptied, and logging begins using thenew log wrapping criteria.If you simply change the value of the errorlogmax option, the existing log isextended or shortened to accommodate the new size. If the value is reduced, theoldest entries are deleted to reduce the file to the new size.If neither errologmax nor errorlogretention is specified, the error log can growwithout any limit on its size. You must manually manage the log contents toprevent the log from depleting disk resources. When the log has been created withneither option specified, if you later issue a command and specify theerrorlogretention option, the log is pruned using the retention value specified.When the log has been created with neither option specified, if you later issue acommand and specify the errorlogmax option, the existing log is treated as if itwas a pruned log. That is, the content of the dsmerror.log file is copied to a filecalled dsmerlog.pru and new log entries are created in dsmerror.log and the log iswrapped when it reaches its maximum size.Note: If you specify a non-zero value for errorlogmax (which enables logwrapping), you cannot use the errorlogretention option to create pruned logs.Logs can be pruned or wrapped, but not both.Logs created with the errorlogmax option contain a log header record that containsinformation similar to this example record:LOGHEADERREC 661 104857600 IBM Tivoli Storage Manager 6.3.0.52 11080B Tue Aug 9 06:46:53 2011Note that the dates and time stamps in the LOGHEADERREC text are nottranslated or formatted using the settings specified on the dateformat ortimeformat options.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).You can also set this option on the Client preferences tab in the GUI, by selectingEnable error log file wrapping and by specifying a non-zero maximum size forthe log file. To prevent log file wrapping, set the maximum size to zero. When themaximum wrapping is set to zero, clearing or setting the Enable error log filewrapping option has no effect; log wrapping does not occur if the maximum sizeis set to zero.Chapter 11. Processing options 361

Syntax►► ERRORLOGMAX size ►◄ParameterssizeSpecifies the maximum size, in megabytes, for the log file. The range of valuesis 0 to 2047; the default is 0, which disables log file wrapping and allows thelog file to grow indefinitely.ExamplesOptions file:errorlogmax 2000Command line:-errorlogmax=2000This option is valid only on the initial command line. It is not valid in interactivemode.ErrorlognameThis option specifies the fully qualified path and file name of the file that containsthe error messages.The value for this option overrides the DSM_LOG environment variable. Thedsmwebcl.log and dsmsched.log files are created in the same directory as the errorlog file you specify with the errorlogname option.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab, Select Error Log button of the Preferences editor.Syntax►► ERRORLOGName filespec ►◄ParametersfilespecThe fully qualified path and file name in which to store error log information.If any part of the path you specify does not exist, Tivoli Storage Managerattempts to create it.ExamplesOptions file:errorlogname c:\temp\dsmerror.log362 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Command line:-errorlogname=c:\temp\dsmerror.logThis option is valid only on the initial command line. It is not valid in interactivemode.The location of the log file specified using the Client Service Configuration Utilityor the client configuration wizard overrides the location specified in the clientoptions file (dsm.opt).ErrorlogretentionThe errorlogretention option specifies how many days to maintain error logentries before pruning, and whether to save the pruned entries in other files.The error log is pruned when the first error is written to the log after a TivoliStorage Manager session is started. If the only session you run is the clientscheduler, and you run it twenty-four hours a day, the error log might not bepruned according to your expectations. Stop the session and start it again to allowthe scheduler to prune the error log.If you change from log pruning (errorlogretention option) to log wrapping(errorlogmax option), all records in the existing log are copied to the dsmerlog.prulog file, the existing log is emptied, and logging begins using the new logwrapping criteria.If you change from log wrapping (errorlogmax option) to log pruning(errorlogretention option), all existing log entries are retained and the log ispruned using the new errorlogretention criteria. Pruned log entries are saved ina file called dsmerlog.pru.If neither errologmax nor errorlogretention is specified, the error log can growwithout any limit on its size. You must manually manage the log contents toprevent the log from depleting disk resources. When the log has been created withneither option specified, if you later issue a command and specify theerrorlogretention option, the log is pruned using the retention value specified.When the log has been created with neither option specified, if you later issue acommand and specify the errorlogmax option, the existing log is treated as if itwas a pruned log. That is, the content of the dsmerror.log file is copied to a filecalled dsmerlog.pru and new log entries are created in dsmerror.log and the log iswrapped when it reaches its maximum size.Note: If you specify errorlogretention option to create pruned logs, you cannotspecify the errorlogmax option. Logs can be pruned or wrapped, but not both.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).You can also set this option on the Client preferences tab in the GUI, by selectingPrune old entries and by specifying a value for Prune entries older than. SelectingChapter 11. Processing options 363

the Save pruned entries option saves the pruned log entries in the dsmerlog.prulog file.Syntax►►ERRORLOGRetentionNdaysDS►◄ParametersN or daysSpecifies how long to wait before pruning the error log.N Do not prune the error log. This permits the error log to grow indefinitely.This is the default.daysThe number of days to keep log file entries before pruning the log. Therange of values is zero through 9999.D or SSpecifies whether to save the pruned entries. Enter a space or comma toseparate this parameter from the previous one.D Discard the error log entries when you prune the log. This is the default.S Save the error log entries when you prune the log.The pruned entries are copied from the error log to the dsmerlog.pru filelocated in the same directory as the dsmerror.log file.ExamplesOptions file:Prune log entries from the dsmerror.log file that are older than 365 daysand save the pruned entries in dsmerlog.pru.errorlogretention 365 SCommand line:-errorlogr=365,SOptions file:Prune log entries from the dsmerror.log file that are older than 365 daysand do not save the pruned entries.errorlogretention 365 DThis option is valid only on the initial command line. It is not valid in interactivemode.Determine compression and encryption processingTivoli Storage Manager evaluates exclude.dir and any other include-excludeoptions controlling backup and archive processing, and then the decision is madeabout which files undergo compression and encryption processing.The following options determine which files undergo compression and encryptionprocessing.364 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 60. Options for controlling compression and encryption processingOption Description PageCompression processingexclude.compression Excludes files from compression processing ifcompression=yes is specified. This option applies tobackups and archives.“Excludeoptions”include.compressionIncludes files for compression processing ifcompression=yes is specified. This option applies tobackups and archives.Important: The include.encrypt option is the onlyway to enable encryption on the Backup-Archiveclient. If no include.encrypt statements are usedencryption will not occur.“Includeoptions”on page395Encryption processingexclude.encrypt Excludes files from encryption processing. “Excludeoptions”include.encryptIncludes files for encryption processing.“Includeoptions”The data that you include is stored in encryptedform, and encryption does not affect the amount ofdata sent or received.on page395Adaptive subfile backup processingexclude.subfileinclude.subfileExcludes files from adaptive subfile backupprocessing. This option does not apply to archiveprocessing. This option is valid for all Windowsclients.Includes files for adaptive subfile backup processing.This option does not apply to archive processing.This option is valid for all Windows clients.“Excludeoptions”“Includeoptions”on page395Exclude optionsUse the exclude options to exclude objects from backup, image, or archive services.For example, you might want to exclude this type of information:v All temporary filesv Any local caches of network filesv All files that contain compiled object code that you can easily reproduce usingother methodsv Your operating system filesYou can exclude specific files from encryption processing during a backup.You can exclude remotely accessed files by specifying Universal NamingConvention (UNC) names in your exclude statement.Note:1. When you exclude a file that was previously included, existing backup versionsbecome inactive during the next incremental backup.2. The exclude statements are not case sensitive.Chapter 11. Processing options 365

3. The server can define exclude options with the inclexcl option.4. As with other include-exclude statements, you can use the inclexcl option tospecify a file that can be in Unicode format, containing exclude statements withfile names in Unicode.Exclude any system files or images that could corrupt the operating system whenrecovered. Also exclude the directory containing the Tivoli Storage Manager clientfiles.Use wildcard characters to exclude a broad range of files.To exclude an entire directory called any\test, enter the following:exclude.dir c:\any\testTo exclude subdirectories that begin with test under the any directory, enter thefollowing:exclude.dir c:\any\test*Note: Defining an exclude statement without using a drive letter, such asexclude.dir code, excludes the code directory on any drive from processing.Supported ClientsThis option is valid for all clients.Options FilePlace these options in the client options file (dsm.opt). You can set these options onthe Include-Exclude tab, Define Include-Exclude Options section of thePreferences editor.Syntax►► options pattern ►◄exclude, exclude.backup, exclude.file, exclude.file.backupUse these options to exclude a file or group of files from backup services.exclude.archiveExcludes a file or a group of files that match the pattern from archive servicesonly.exclude.compressionExcludes files from compression processing if the compression option is set toyes. This option applies to backups and archives.exclude.dedupExcludes files from client-side data deduplication. To control a client-side datadeduplication operation, specify ieobjtype as the value of the exclude.dedupoption.Valid ieobjtype parameters are:FileSYSTEMStateAsrThe default is File.366 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

exclude.dirExcludes a directory, its files, and all its subdirectories and their files frombackup processing. For example, the statement exclude.dir c:\test\dan\data1excludes the c:\test\dan\data1 directory, its files, and all its subdirectoriesand their files.If you exclude a directory that was previously included, Tivoli StorageManager expires existing backup versions of the files and directories beneath itduring the next incremental backup. Use this option to exclude a portion ofyour data that has no underlying files to back up.Note: Avoid performing a selective backup of an individual file within anexcluded directory. The next time that you perform an incremental backup, anyfiles backed up in this manner is expired.Note: Defining an exclude statement without using a drive letter, such asexclude.dir code, excludes the code directory on any drive from processing.exclude.encryptExcludes the specified files from encryption processing. This option does notaffect whether files are excluded from backup or archive processing, onlywhether they are excluded from encryption processing.exclude.fs.nasExcludes file systems on the NAS file server from an image backup when usedwith the backup nas command. The NAS node name must be prefixed to thefile system name, for example: netappsj1/vol/vol1. To apply the exclude to allNAS nodes, replace the NAS node name with a wildcard, for example:*/vol/vol1. The backup nas command ignores all other exclude statementsincluding exclude.dir statements. This option is valid for all Windows clients.exclude.subfileExcludes files from adaptive subfile backup processing. This option does notapply to archive processing.exclude.systemserviceExcludes individual system services components from system state backup.Input can be the keyword or component name to be excluded from processing.If you specify the component name and there are spaces, enclose the name inquotation marks. Table 61 shows valid system services components and theircorresponding keywords.If you are specifying a component that is not listed in Table 61, you can specifythe component name. This option is valid for Windows Server 2003 andWindows Vista only.Table 61. System services components and corresponding keywordsComponentKeywordBackground Intelligent Transfer ServiceBITSEvent logEVENTLOGRemovable Storage ManagementRSMCluster DatabaseCLUSTERDBRemote Storage ServiceRSSTerminal Server LicensingTLSWindows Management InstrumentationWMIInternet Information Services (IIS) metabaseIISChapter 11. Processing options 367

Table 61. System services components and corresponding keywords (continued)ComponentKeywordDHCP databaseDHCPWins databaseWINSDBParameterspatternSpecifies the file or group of files that you want to exclude.Note: For NAS file systems: You must prefix the NAS node name to the filespecification to specify the file server to which the exclude statement applies. Ifyou do not specify a NAS node name, the file system identified refers to theNAS node name specified in the client options file (dsm.opt) or on thecommand line.If the pattern begins with a single or double quote or contains any embeddedblanks or equal signs, you must surround the value in either single (') ordouble (") quotation marks. The opening and closing quotation marks must bethe same type of quotation marks.vFor the exclude.image option, the pattern is the name of a file system or rawlogical volume.ExamplesOptions file: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/vol0exclude.systemservice eventlogexclude.dedup c:\Users\Administrator\Documents\Important\...\*exclude.dedup e:\*\* ieobjtype=imageexclude.dedup ALL ieobjtype=systemstateexclude.dedup ALL ieobjtype=ASRCommand line:Does not apply.Related informationSee “Exclude files with UNC names” on page 81 for examples of statements usingUNC file names.See “System files to exclude” on page 80 for a list of files that you should alwaysexclude.“Inclexcl” on page 394368 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

See “Include and exclude groups of files with wildcard characters” on page 82 fora list of wildcard characters that you can use. Then, if necessary, use the includeoption to make exceptions.Controlling compression processingThis topic lists some items to consider if you want to exclude specific files orgroups of files from compression processing during a backup or archive operation.vvvRemember that Tivoli Storage Manager compares the files it processes againstthe patterns specified in the include-exclude statements, reading from the bottomto the top of the options file.You must set the compression option to yes to enable compression processing. Ifyou do not specify the compression option or you set the compression option tono, Tivoli Storage Manager does not perform compression processing.If you set the compression option to yes and no exclude.compression statementsexist, Tivoli Storage Manager considers all files for compression processing.Tivoli Storage Manager processes exclude.dir and other include-excludestatements first. Tivoli Storage Manager then considers any exclude.compressionstatements. For example, consider the following include-exclude list:exclude c:\test\*.*exclude.compression c:\test\file.txtinclude c:\test\file.txtTivoli Storage Manager examines the statements (reading from bottom to top)and determines that the c:\test\file.txt file is a candidate for backup, but isnot a candidate for compression processing.v Include-exclude compression processing is valid for backup and archiveprocessing only. The exclude.compression option does not affect whether filesare excluded from backup or archive processing, only whether they are excludedfrom compression processing.Related reference:“Compression” on page 320Adaptive subfile backup processingThis topic lists some items to consider if you want to exclude files from adaptivesubfile backup processing using the exclude.subfile option.vvvYou must set the subfilebackup option to yes to enable include-exclude adaptivesubfile backup processing. If you do not specify the subfilebackup option oryou set the subfilebackup option to no, Tivoli Storage Manager does notperform adaptive subfile backup processing.If you set the subfilebackup option to yes and no exclude.subfile statementsexist, Tivoli Storage Manager considers all files for adaptive subfile backupprocessing.Tivoli Storage Manager processes exclude.dir and other include-excludestatements first. Tivoli Storage Manager then considers any exclude.subfilestatements. For example, consider the following include-exclude list:exclude c:\test\*.*exclude.subfile c:\test\file.txtinclude c:\test\file.txtTivoli Storage Manager examines the statements (reading from bottom to top)and determines that the c:\test\file.txt file is a candidate for backup, but isnot a candidate for adaptive subfile backup.Include-exclude adaptive subfile backup processing is valid for backup andrestore processing only. The exclude.subfile option does not affect whether filesChapter 11. Processing options 369

vare excluded from backup or restore processing, only whether they are excludedfrom adaptive subfile backup processing.As with other include-exclude statements, you can specify exclude.subfilestatements in Unicode using the inclexcl option.The subfilebackup option does not work correctly for migrated files. If you use acombination of subfilebackup and non-subfilebackup for migrated files, your datamight be corrupted on the server.Related reference:“Inclexcl” on page 394“Subfilebackup” on page 491Processing NAS file systemsUse the exclude.fs.nas option to exclude file systems from NAS image backupprocessing.Note: The exclude.fs.nas option does not apply to a snapshot differenceincremental backup.A NAS file system specification uses the following conventions:v NAS nodes represent a unique node type. The NAS node name uniquelyidentifies a NAS file server and its data to Tivoli Storage Manager. You canprefix the NAS node name to the file specification to specify the file server towhich the exclude statement applies. If you do not specify a NAS node name,the file system identified applies to all NAS file servers.v Regardless of the client platform, NAS file system specifications use the forwardslash (/) separator, as in this example: /vol/vol0.For example, to exclude /vol/vol1 from backup services on all NAS nodes, specifythe following exclude statement:exclude.fs.nas */vol/vol1||||||||||||||||||VMware virtual machine exclude optionsVMware include and exclude options influence the behavior of backup and restoreoperations for VMware virtual machines. These options are processed before anycommand-line options are processed, so options on the command line can overrideoptions specified on any of the VMware include options or VMware excludeoptions. See the individual option descriptions for information about the options.Related reference:“EXCLUDE.VMDISK”EXCLUDE.VMDISK:The EXCLUDE.VMDISK option excludes a VMware virtual machine disk frombackup operations.The EXCLUDE.VMDISK option specifies the label of a virtual machine's disk to beexcluded from a Backup VM operation. If you exclude a disk on the Backup VMcommand, the command-line parameters override any EXCLUDE.VMDISK statementsin the options file.This option is available only if you are licensed to use IBM ® Tivoli ® StorageManager for Virtual Environments. See the Data Protection for VMware Installationand User's Guide for additional information about this option.370 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||Supported clientsThis option can be used with supported Windows clients.Options fileSet this option in the client options file. Command line parameters overridestatements in the options file.Syntax►► EXCLUDE.VMDISK vmname vmdk_label ►◄ParametersvmnameSpecifies the name of the virtual machine that contains a disk that you want toexclude from a Backup VM operation. You can specify only one virtualmachine name on each EXCLUDE.VMDISK statement. Specify additionalEXCLUDE.VMDISK statements for each virtual machine disk to exclude.The virtual machine name can contain an asterisk (*), to match any characterstring, and question mark (?) to match any one character. Surround the VMname with quotation marks (“ ”) if the VM name contains space characters.Tip: If the virtual machine name contains special characters, such as bracketcharacters ([ or ]), the virtual machine name might not be correctly matched. Ifa virtual machine name uses special characters in the name, you might need touse the question mark character (?) to match the special characters in the VMnameFor example, to exclude "Hard Disk 1" in the backup of a virtual machinenamed "Windows VM3 [2008R2]", use this syntax in the options file:EXCLUDE.VMDISK "Windows VM3 ?2008R2?" "Hard Disk 1"vmdk_labelSpecifies the disk label of the disk that you want to exclude. Wildcardcharacters are not allowed. Use the Backup VM command with the -previewoption to determine the disk labels of disks in a given virtual machine. See“Backup VM” on page 562 for the syntax.Do not exclude disks on virtual machines that you are protecting with theINCLUDE.VMTSMVSS option, if the disks contain application data.ExamplesOptions fileAssume that a virtual machine named vm1 contains four disks, labeledHard Disk 1, Hard Disk 2, Hard Disk 3, and Hard Disk 4. To exclude disk2fromBackup VM operations, specify the following in the options file:EXCLUDE.VMDISK "vm1" "Hard Disk 2"Exclude disks 2 and 3 from Backup VM operations:EXCLUDE.VMDISK "vm1" "Hard Disk 2"EXCLUDE.VMDISK "vm1" "Hard Disk 3"Chapter 11. Processing options 371

|||||||||||||||Command lineThe command line examples show the use of the exclusion operator (-)before the vmdk= keyword, to indicate that the disk is to be excluded.Exclude a single disk:dsmc backup vm "vm1:-vmdk=Hard Disk 1"Exclude disk 2 and disk 3:dsmc backup vm "vm1:-vmdk=Hard Disk 2:-vmdk=Hard Disk 3"Exclude disk 1 and disk 2 on vm1:dsmc backup vm "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2"Related reference:“Backup VM” on page 562“Restore VM” on page 647“Domain.vmfull” on page 348“INCLUDE.VMDISK” on page 401“INCLUDE.VMTSMVSS” on page 403FbbranchUse the fbbranch option with the backup fastback or archive fastback commands.The fbbranch option specifies the branch ID of the remote FastBack server to backup or archive. The fbbranch option is only required when the Backup-ArchiveClient is installed on a FastBack DR Hub or when a dedicated proxy is connectingto a replicated DR Hub repository. Do not specify the fbbranch option when theBackup-Archive Client is installed on the FastBack server.Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Syntax►► FBBranch= branch_ID ►◄Parametersbranch_IDSpecifies the FastBack server branch ID. The value is part of the disasterrecovery configuration of the FastBack server.ExamplesCommand line:-FBBranch=oracleOn a Tivoli Storage Manager backup-archive client that is installed on aFastBack DR Hub:372 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

dsmc backup fastback -fbpolicyname=policy1 -fbserver=myFbServer-fbbranch=oracleCommand line:On a Tivoli Storage Manager backup-archive client that is connecting to arepository on a remote FastBack DR Hub:dsmc backup fastback -fbpolicyname=policy1 -fbserver=server1-Fbreposlocation=\\myDrHub.company.com\REP-fbbranch=oracleIf the fbbranch option is specified on a Tivoli Storage Manager client workstationthat is installed on a FastBack server, the fbbranch option is ignored.FbclientnameUse the fbclientname option with the backup fastback or archive fastbackcommands.The fbclientname option is the name of one or more comma-separated FastBackclients to back up or archive from the backup proxy. The values for thefbclientname option are invalid if more than one policy is specified in thefbpolicyname option.You cannot include spaces in the fbclientname option values.If you do not specify any values for the fbvolumename option, all the volumes fromall the FastBack clients in the policy that is specified are backed up. If you specifymultiple FastBack clients in the fbclientname option, you cannot specify values forthe fbvolumename option.Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Syntax►►,(1)FBClientname ▼ client_name ►◄Notes:1 Specify up to 10 client_name values for FBClientname.Parametersclient_nameSpecifies the name of one or more FastBack clients. You can specify up to 10FastBack client names.Important:Chapter 11. Processing options 373

When specifying the archive fastback or backup fastback command:1. At least one FBpolicyName is always required.2. You can specify up to 10 values for FBPolicyName, if no values are specifiedfor both FBClientName and FBVolumeName.3. When you specify a FBClientName value, there must be only one value forFBPolicyName.4. You can specify up to 10 values for FBClientName if only one PolicyName isspecified, and no values for FBVolumeName are specified.5. When you specify the FBVolumeName option, you can have only one FBPolicy,and only one FBCLientName specified.6. You can specify multiple FBVolumeNames if condition 5 is satisfied.7. You must always specify the FBReposLocation option for Linux.ExamplesCommand line:dsmc backup fastback -fbpolicyname=Policy1-fbclientname=fbclient1,fbclient2-fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPBacks up all volumes for FastBack clients fbclient1 and fbclient2 that arefound in policy Policy1.Command line:dsmc backup fastback -fbpolicyname=Policy1-fbclientname=fbclient1-fbvolume=c:,f: -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPBacks up volumes C: and F: for FastBack client fbclient1 found in policyPolicy1.Command line:dsmc backup fastback -fbpolicyname=Policy1-fbclientname=fbWindowsClient,fbLinuxClient-fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPBacks up all volumes for FastBack client fbWindowsClient found in policyPolicy1.The volumes for Linux FastBack client fbLinuxClient will not be backed upfrom the Windows Tivoli Storage Manager backup-archive client. To backup or archive volumes from a Linux FastBack client, use the Linux TivoliStorage Manager backup-archive client.FbpolicynameUse the fbpolicyname option with the backup fastback or archive fastbackcommands.The fbpolicyname option is the name of one or more comma-separated TivoliStorage Manager FastBack policies that you want to back up or archive from thebackup proxy. You must specify at least one policy name. Specify multiple policynames using a comma-delimited list of policies. There is no default value.374 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If one or more FB policy names contain spaces, you must specify them withinquotation marks. Here is an example: "FB Policy NAME1, FBPolicy Name 2".If you do not specify any values for the fbclientname and fbvolumename options,all the volumes from all the FastBack clients in the policies that are specified arebacked up. If you specify multiple policies in the fbpolicyname option, you cannotspecify values for the fbclientname and fbvolumename options.If a policy specification contains both Windows and Linux FastBack clients, onlythe Windows volumes will be backed up or archived to Tivoli Storage Manager bythe Windows Tivoli Storage Manager backup-archive client.At least one snapshot should exist in the Tivoli Storage Manager FastBackrepository for the FastBack policies being archived or backed up prior to issuingthe dsmc commandSupported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Syntax►►,(1)FBPolicyname ▼ policy_name ►◄Notes:1 Specify up to 10 FastBack policy names.Parameterspolicy_nameSpecifies the name of the FastBack policies. You can specify up to 10 FastBackpolicy names.Important:When specifying the archive fastback or backup fastback command:1. At least one FBpolicyName is always required.2. You can specify up to 10 values for FBPolicyName, if no values are specifiedfor both FBClientName and FBVolumeName.3. When you specify a FBClientName value, there must be only one value forFBPolicyName.4. You can specify up to 10 values for FBClientName if only one PolicyName isspecified, and no values for FBVolumeName are specified.5. When you specify the FBVolumeName option, you can have only one FBPolicy,and only one FBCLientName specified. You must specify exactly oneFBClientName. It cannot be omitted.6. You can specify multiple FBVolumeNames if condition 5 is satisfied.Chapter 11. Processing options 375

7. You must always specify the FBReposLocation option for Linux.ExamplesCommand line:dsmc backup fastback -fbpolicyname=Policy1,Policy2,Policy3-fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPBacks up all volumes for all FastBack clients found in policies Policy1,Policy2 and Policy3.To specify policies with spaces, enclose them in double quotation marks,for example:-fbpolicyname="Policy 1,Policy2,Policy3"FbreposlocationUse the fbreposlocation option with the backup fastback or archive fastbackcommands.The fbreposlocation option specifies the location of the Tivoli Storage ManagerFastBack repository for the Tivoli Storage Manager backup-archive client proxy toconnect to issue Tivoli Storage Manager FastBack shell commands necessary tomount appropriate snapshots.On Windows systems, you do not need to specify the fbreposlocation optionwhen the Tivoli Storage Manager backup-archive client is installed on a DR Hubserver or a FastBack server workstation. When the Tivoli Storage Managerbackup-archive client is installed on a dedicated client proxy, the repositorylocation fbreposlocation option is required.If you specify the fbreposlocation option for a FastBack DR Hub, specify only thebase directory of the DR Hub repository with this option. Then use the fbbranchoption to indicate the Branch ID of the server to back up. If you specify thefbreposlocation option for the FastBack server, use the format \\\REP.In this case, do not use the fbbranch option.Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Syntax►► FBReposlocation repository_location ►◄Parametersrepository_locationSpecifies the Tivoli Storage Manager FastBack repository location.376 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesCommand line:The fbreposlocation option is only required on a dedicated proxymachine. If the fbreposlocation option is specified on a machine where aFastBack server or FastBack DR Hub is installed, it is ignored.Use this command when the Tivoli Storage Manager dedicated proxy clientis connecting to a remote Tivoli Storage Manager FastBack serverrepository:dsmc backup fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPA repository location is required.myFbServer is the short host name of the machine where the FastBackserver is installed.Command line:Use this command when the Tivoli Storage Manager dedicated proxy clientis connecting to a remote repository on a Tivoli Storage Manager FastBackdisaster recovery hub:dsmc backup fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myfbdrhub.company.com\REP-fbbranch=aFbServerBranchA repository location is required.The myFbServer parameter specifies the short host name of the TivoliStorage Manager FastBack Server whose FastBack branch is specified usingthe FBBranch option.The fbbranch option specifies the branch ID of a FastBack server on thedisaster recovery hub.FbserverUse the fbserver option with the backup fastback or archive fastback commands.The fbserver option specifies the short host name of the Tivoli Storage ManagerFastBack server workstation that owns the repository specified by thefbreposlocation option. For a DR Hub, the fbserver option specifies the shortname of the FastBack server workstation whose branch repository the TivoliStorage Manager backup-archive client is connecting to.The fbserver option is a key to retrieving the necessary user credentials requiredto connect to the FastBack server repository or the DR Hub server repository formount processing.Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Chapter 11. Processing options 377

Syntax►► -FBServer server_name ►◄Parametersserver_nameSpecifies the short hostname of the machine on which a FastBack server isinstalled.ExamplesCommand line:The Tivoli Storage Manager backup-archive client is running on a FastBackserver machine whose short name is myFbServer:dsmc archive fastback -fbpolicyname=Policy1 -fbserver=myFbServerCommand line:The Tivoli Storage Manager backup-archive client is running on a TivoliStorage Manager FastBack DR Hub machine and is connecting to aFastBack Server branch repository branch1. The short host name of theFastBack server is myFbServer:dsmc archive fastback -fbpolicyname=Policy1 -fbserver=myFbServer-fbbranch=branch1Command line:The Tivoli Storage Manager Backup-archive client is running on adedicated proxy machine and is connecting to a remote FastBack serverrepository. The FastBack server is installed on a machine whose short nameis myFbServerMachine:dsmc archive fastback -fbpolicyname=Policy1 -fbserver=myFbServerMachine-fbreposlocation=\\myFbServerMachine.company.com\RepCommand line:The Tivoli Storage Manager Backup-Archive Client is running on adedicated proxy machine and is connecting to a remote Tivoli StorageManager FastBack repository on a FastBack DR Hub. The FastBack Serverwith branch ID branch1 is installed on a machine whose short name ismyFbServer.dsmc backup fastback -fbpolicyname=Policy1 -fbserver=myFbServer-fbreposlocation=\\myDrHubMachine.company.com\Rep-fbbranch=branch1FbvolumenameUse the fbvolumename option with the backup fastback or archive fastbackcommands.The fbvolumename option is the name of one or more comma-separated TivoliStorage Manager FastBack volumes to back up or archive from the backup proxy.Values for the fbvolumename option are not valid if more than one FastBack client isspecified in the fbclientname option.If you specify multiple FastBack clients in the fbclientname option, you cannotspecify values for the fbvolumename option.378 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all Windows clients.Options FileNone. You can specify this option only on the command line. The server can alsodefine or override this option.Syntax►►,(1)FBVolumename ▼ volume_name ►◄Notes:1 Specify up to 10 FastBack volume names.Parametersvolume_nameSpecifies the name of the Tivoli Storage Manager FastBack volumes. You canspecify up to 10 FastBack volume names.Important:When specifying the archive fastback or backup fastback command:1. At least one FBpolicyName is always required.2. You can specify up to 10 values for FBPolicyName, if no values are specifiedfor both FBClientName and FBVolumeName.3. When you specify a FBClientName value, there must be only one value forFBPolicyName.4. You can specify up to 10 values for FBClientName if only one PolicyName isspecified, and no values for FBVolumeName are specified.5. When you specify the FBVolumeName option, you can have only one FBPolicy,and only one FBCLientName specified. You must specify exactly oneFBClientName. It cannot be omitted.6. You can specify multiple FBVolumeNames if condition 5 is satisfied.ExamplesCommand line:dsmc backup fastback -fbpolicyname=Policy1 -fbclientname=client1-fbvolumename=c:,f: -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPBacks up volumes c: and f: from FastBack client Client1, found in policyPolicy1.Command line:dsmc archive fastback -fbpolicyname=Policy1 -fbclientname=client1-fbvolumename=c:,f: -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPArchives volumes C: and F: from FastBack client Client1, found in policyPolicy1.Chapter 11. Processing options 379

FilelistUse the filelist option to process a list of files.You can use the filelist option with the following commands:v archivev backup groupv delete archivev delete backupv expirev incrementalv query archivev query backupv restorev retrievev selectiveThe Tivoli Storage Manager client opens the file you specify with this option andprocesses the list of files within according to the specific command. Except for therestore and retrieve commands, when you use the filelist option, Tivoli StorageManager ignores all other file specifications on the command line.The files (entries) listed in the filelist must adhere to the following rules:v Each entry must be a fully-qualified or a relative path to a file or directory. Notethat if you include a directory in a filelist entry, the directory is backed up, butthe contents of the directory are not.v Each path must be specified on a single line. A line can contain only one path.v Paths must not contain control characters, such as 0x18 (CTRL-X), 0x19 (CTRL-Y)and 0x0A (newline).v Paths must not contain wildcard characters. Do not include * or ? in a path.v The filelist can be an MBCS file or a Unicode file with all Unicode entries. ForMac OS X, the filelist can be encoded in the current operating system languageor UTF-16.v If a path or file name contains a space, enclose the entire path in quotationmarks (") or single quotation marks ('). For example "C:\My Documents\spreadsheet.xls" or 'C:\My documents\spreadsheet.xls'.v If a path contains one or more single quotation marks ('), enclose the entire entryin quotation marks ("). If a path contains one or more quotation marks, enclosethe entire path in single quotation marks. File list processing does not supportpaths that include a mix of quotation marks and single quotation marks.The following examples illustrate the correct and incorrect use of quotationmarks and single quotation marks in paths:This path example contains a single quotation mark, so the path must beenclosed in quotation marks:"/home/gatzby/mydir/gatzby’s_report.out"This path example contains quotation marks, so it must be enclosed in singlequotation marks:’/home/gatzby/mydir/"top10".out’This path example contains a space character, so it must be enclosed in eitherquotation marks or single quotation marks:"/home/gatzby/mydir/top 10.out"380 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

or’/home/gatzby/mydir/top 10.out’This path example is not supported for filelist processing because it containsunmatched delimiters (" and ’):/home/gatzby/mydir/andy’s_"top 10" report.outvThese paths are not supported for filelist processing because they containwildcard characters:/home/gatzby*/home/*/20??.txtAny Tivoli Storage Manager filelist entry that does not comply with these rulesis ignored.The following are examples of valid paths in 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"You can use the filelist option during an open file support operation. In thiscase, Tivoli Storage Manager processes the entries in the filelist from the virtualvolume instead of the real volume.If an entry in the filelist indicates a directory, only that directory is processed andnot the files within the directory.If the file name (the filelistspec) you specify with the filelist option does notexist, the command fails. Tivoli Storage Manager skips any entries in the filelistthat are not valid files or directories. Tivoli Storage Manager logs errors andprocessing continues to the next entry.Use file specifications with the restore and retrieve commands to denote thedestination for the restored filelist entries. For example, in the following restorecommand, d:\dir\ represents the restore destination for all entries in the filelist.restore -filelist=c:\filelist.txt d:\dir\However, in the following selective command, the file specification d:\dir\ isignored.selective -filelist=c:\filelist.txt d:\dir\If you specify a directory in a filelist for the delete archive or delete backupcommand, the directory is not deleted. filelists that you use with the delete archiveor delete backup command should not include directories.The entries in the list are processed in the order they appear in the filelist. Foroptimal processing performance, pre-sort the filelist by file space name and path.Note: Tivoli Storage Manager might back up a directory twice if the followingconditions exist:v The filelist contains an entry for the directoryv The filelist contains one or more entries for files within that directoryv No backup of the directory existsChapter 11. Processing options 381

For example, your filelist includes the entries c:\dir0\myfile and c:\dir0. Ifthe\dir0 directory does not exist on the server, the c:\dir0 directory is sent to theserver a second time.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► FILEList = filelistspec ►◄ParametersfilelistspecSpecifies the location and name of the file that contains the list of files toprocess with the command.Note: When you specify the filelist option on the command line, the subdiroption is ignored.ExamplesCommand line:sel -filelist=c:\avi\filelist.txtFilenameUse the filename option with the query systeminfo command to specify a filename in which to store information.You can store information gathered from one or more of the following items:v DSMOPTFILE - The contents of the dsm.opt file.v ENV - Environment variables.v ERRORLOG - The Tivoli Storage Manager error log file.v FILE - Attributes for the file name that you specify.v FILESNOTTOBACKUP - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackupvvThis key specifies those files that back up products should not back up. Thequery inclexcl command indicates that these files are excluded per the operatingsystem.INCLEXCL - Compiles a list of include-exclude in the order in which they areprocessed during backup and archive operations.KEYSNOTTORESTORE - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\BackupRestore\KeysNotToRestore382 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvvvvvvvThis key specifies those Windows Registry keys that back up products shouldnot restore.MSINFO - Windows system information (output from MSINFO32.EXE).OPTIONS - Compiled options.OSINFO - Name and version of the client operating system.POLICY - Policy set dump.REGISTRY - Windows Tivoli Storage Manager-related Windows Registry entries.SCHEDLOG - The contents of the Tivoli Storage Manager schedule log (usuallydsmsched.log.SFP - The list of files protected by Windows System File Protection, and for eachfile, indicates whether that file exists. These files are backed up as part of theSYSFILES system object.SFP= - Indicates whether the specified file (filename) is protected byWindows System File Protection. For example:SFP=C:\WINNT\SYSTEM32\MSVCRT.DLLSYSTEMSTATE - Windows system state information.CLUSTER - Windows cluster information.Note: The query systeminfo command is intended primarily as an aid for IBMsupport to assist in diagnosing problems, although users who are familiar with theconcepts addressed by this information might also find it useful. If you use theconsole option, no special formatting of the output is performed to accommodatescreen height or width. Therefore, the console output might be difficult to read dueto length and line-wrapping. In this case, use the filename option with the querysysteminfo command to allow the output to be written to a file that cansubsequently be submitted to IBM support.Supported ClientsThis option is valid for all clients.Syntax►► FILEName = outputfilename ►◄ParametersoutputfilenameSpecifies a file name in which to store the information. If you do not specify afile name, by default the information is stored in the dsminfo.txt file.ExamplesCommand line:query systeminfo dsmoptfile errorlog -filename=tsminfo.txtRelated information“Console” on page 322FilesonlyThe filesonly option restricts backup, restore, retrieve, or query processing to filesonly.Chapter 11. Processing options 383

You cannot restore or retrieve directories from the Tivoli Storage Manager serverwhen using the filesonly option with the restore or retrieve commands. However,directories with default attributes are created, if required, as placeholders for filesthat you restore or retrieve.You can also use the filesonly option with the following commands:v archivev incrementalv query archivev query backupv restorev restore backupsetv restore groupv retrievev selectiveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► FILESOnly ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc incremental -filesonlyFromdateUse the fromdate option with the fromtime option to specify a date and time fromwhich you want to search for backups or archives during a restore, retrieve, orquery operation.Files that were backed up or archived before this date and time are not included,although older directories might be included, if necessary, to restore or retrieve thefiles.Use the fromdate option with the following commands:v delete backupv query archivev query backupv restorev restore groupv retrieveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.384 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► FROMDate = date ►◄ParametersdateSpecifies the date from which you want to search for backup copies orarchived files. Enter the date in the format you selected with the dateformatoption.When you include dateformat with a command, it must precede the fromdate,pitdate, and todate options.ExamplesCommand line:dsmc query backup -fromdate=12/11/2003 c:\Windows\ProgramFiles\*.exeFromnodeThe fromnode option permits one node to perform commands for another node. Auser on another node must use the set access command to permit you to query,restore, or retrieve files for the other node.Use the fromnode option with the following commands:v query archivev query backupv query filespacev query groupv query mgmtclassv restorev restore groupv restore imagev retrieveSupported ClientsThis option is valid for all clients.Syntax►► FROMNode = node ►◄ParametersnodeSpecifies the node name on a workstation or a file server whose backup copiesor archived files you want to access.ExamplesCommand line:dsmc query archive -fromnode=bob -subdir=yes d:\Chapter 11. Processing options 385

Note: The Tivoli Storage Manager client can use file space information whenrestoring files. The file space information can contain the name of the computerfrom which the files were backed up. If you restore from another Tivoli StorageManager client node and do not specify a destination for the restored files, theclient uses the file space information to restore the files. In such a case, the clientattempts to restore the files to the file system on the original computer. If therestoring computer has access to the file system of the original computer, you canrestore files to the original file system. If the restoring computer can not access thefile system of the original computer, the client can return a network error message.If you want to restore the original directory structure but on a different computer,specify only the target file system when you restore. This is true when restoringfiles from another node and when retrieving files from another node.FromtimeUse the fromtime option with the fromdate option to specify a beginning time fromwhich you want to search for backups or archives during a restore, retrieve, orquery operation.Tivoli Storage Manager ignores this option if you do not specify the fromdateoption.Use the fromtime option with the following commands:v delete backupv query archivev query backupv restorev restore groupv retrieveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► FROMTime = time ►◄ParameterstimeSpecifies a beginning time on a specific date from which you want to searchfor backed up or archived files. If you do not specify a time, the time defaultsto 00:00:00. Specify the time in the format you selected with the timeformatoption.When you include the timeformat option in a command, it must precede thefromtime, pittime, and totime options.ExamplesCommand line:dsmc q b -timeformat=4 -fromt=11:59AM -fromd=06/30/2003 -tot=11:59PM-tod=06/30/2003 c:\*386 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

GroupnameUse the groupname option with the backup group command to specify the namefor a group. You can only perform operations on new groups or the current activeversion of the group.Supported ClientsThis option is valid for all Windows clients.Syntax►► GROUPName = name ►◄ParametersnameSpecifies the name of the group which contains the files backed up using thefilelist option. Directory delimiters are not allowed in the group name sincethe group name is not a file specification, but a name field.ExamplesCommand line:backup group -filelist=c:\dir1\filelist1 -groupname=group1-virtualfsname=\virtfs -mode=fullGuitreeviewafterbackupThe guitreeviewafterbackup option specifies whether the client returns to theBackup, Restore, Archive, or Retrieve window after a successful operationcompletes.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client user options file (dsm.opt). You can set this option onthe General tab, Return to tree window after function completed check box of thePreferences editor.Syntax►►GUITREEViewafterbackupNoYes►◄ParametersNoYesReturns you to the Tivoli Storage Manager main window after a successfuloperation completes. This is the default.Returns you to the Backup, Restore, Archive, or Retrieve window after asuccessful operation completes.Chapter 11. Processing options 387

ExamplesOptions file:guitreeviewafterbackup yesCommand line:Does not apply.HostThe host option specifies the target ESX server location where the new virtualmachine is created during a VMware restore operation.Use this option on restore vm commands to specify the ESX host server to restorethe data to.ExampleRestore the virtual machine to the ESX server named vmesxbld1.restore vm -host=vmesxbld1.us.acme.comHttpportThe httpport option specifies a TCP/IP port address for the Web client.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client system options file (dsm.opt). You can set this optionon the Web Client tab, in the HTTP Port field of the Preferences editor.Syntax►► HTTPport port_address ►◄Parametersport_addressSpecifies the TCP/IP port address that is used to communicate with the Webclient. The range of values is 1000 through 32767; the default is 1581.ExamplesOptions file:httpport 1502Command line:-httpport=1502HsmreparsetagThe hsmreparsetag option specifies a unique reparse tag that is created by an HSMproduct installed on your system.388 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Many HSM products use reparse points to retrieve or recall migrated files. After afile is migrated, a small stub file, with the same name as the original file, is left onthe file system. The stub file is a reparse point that triggers a recall of the originalfile when a user or application accesses the stub file. The reparse point includes aunique identifier called a reparse tag to identify which HSM product migrated thefile.If the Tivoli Storage Manager Backup-Archive Client does not recognize the reparsetag in a stub file, the Backup-Archive Client causes the HSM product to recall theoriginal file. You can prevent files from being recalled if you specify the reparse tagwith the hsmreparsetag option.The Backup-Archive Client recognizes the reparse tag of HSM products from thefollowing companies:v International Business Machines Corp.v Wisdata System Co. Ltd.v BridgeHead Software Ltd.v CommVault Systems, Inc.v Data Storage Group, Inc.v Enigma Data Solutions, Ltd.v Enterprise Data Solutions, Inc.v Global 360v GRAU DATA AGv Hermes Software GmbHv Hewlett Packard Companyv International Communication Products Engineering GmbHv KOM Networksv Memory-Tech Corporationv Moonwalk Universalv Pointsoft Australia Pty. Ltd.v Symantec CorporationIf the HSM product you use is not in the preceding list, use the hsmreparsetagoption to specify the reparse tag. Ask your HSM product vendor for the reparsetag used by the product.Supported clientsThis option is valid for all Windows clients.Option filePlace this option in the client options file (dsm.opt).Syntax►► HSMREPARSETAG reparse_tag_value ►◄Chapter 11. Processing options 389

Parametersreparse_tag_valueA decimal (base 10) or hexadecimal (base 16) value that specifies the reparsetag.ExamplesOptions file:Specify an HSM reparse tag in decimal format:hsmreparsetag 22Specify an HSM reparse tag in hexadecimal format:hsmreparsetag 0x16Command line:Does not apply.IeobjtypeUse the ieobjtype option to specify an object type for a client-side datadeduplication operation within include-exclude statements.The ieobjtype option is an additional parameter to the include.dedup orexclude.dedup options.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API alsosupports this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theInclude/Exclude tab of the Preferences editor. The option can be set in the clientoption set on Tivoli Storage Manager server.Syntax►►IEObjtypeFileImageSYSTEMStateAsr►◄ParametersFileSpecifies that you want to include files for, or exclude files from, client-sidedata deduplication processing. File is the default.ImageSpecifies that you want to include images for, or exclude images from,client-side data deduplication processing.System StateSpecifies that you want to include system state for, or exclude system statefrom, client-side data deduplication processing.390 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

AsrSpecifies that you want to include automatic system recovery objects for, orexclude ASR objects from, client-side data deduplication processing.ExamplesOptions file:exclude.dedup e:\*\* ieobjtype=imageCommand line:Does not apply.Related reference:“Exclude options” on page 365“Include options” on page 395IfnewerThe ifnewer option replaces an existing file with the latest backup version only ifthe backup version is newer than the existing file.Only active backups are considered unless you also use the inactive or latestoptions.Note: Directory entries are replaced with the latest backup version, whether thebackup version is older or newer than the existing version.Use the ifnewer option with the following commands:v restorev restore backupsetv restore groupv retrieveNote: This option is ignored if the replace option is set to No.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► IFNewer ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore -ifnewer d:\logs\*.logImagegapsizeUse the imagegapsize option with the backup image command, in the options file,or with the include.image option to specify the minimum size of empty regions ona volume that you want to skip during image backup.Chapter 11. Processing options 391

Use this option for LAN-based and LAN-free image backup.For example, if you specify a gap size of 10, this means that an empty region onthe disk that is larger than 10 KB in size is not backed up. Gaps that are exactly 10KB is backed up. Empty regions that are exactly 10 KB and that are smaller than 10KB is backed up, even though they do not contain data. However, an empty regionthat is smaller than 10 KB is backed up, even though it does not contain data. Asmaller image gap size means less data needs to be transferred, but withpotentially decreased throughput. A larger image gap size results in more databeing transferred, but with potentially better throughput.Place the include.image statement containing the imagegapsize value in yourdsm.opt file.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►► IMAGEGapsize size ►◄ParameterssizeSpecifies the minimum size of empty regions in a formatted logical volumethat should be skipped during an image backup. You can specify k (kilobytes)m (megabytes) or g (gigabytes) qualifiers with the value. Without a qualifier, thevalue is interpreted in kilobytes. Valid values are 0 through 4294967295 KB. Ifyou specify a value of 0, all blocks, including unused blocks at the end of thevolume, is backed up. If you specify any value other than 0, unused blocks atthe end of the volume will not be backed up. For LAN-based and LAN-freeimage backup the default value is 32 KB.Note: Because of operating system limitations, use this option for NTFS filesystems only. If you specify an imagegapsize that is greater than 0 for a filesystem other than NTFS, you get a warning message.ExamplesOptions file:imagegapsize 1mInclude-exclude list example: include.image h: MYMC imagegapsize=1mCommand line:-imagegapsize=64kImagetofileUse the imagetofile option with the restore image command to specify that youwant to restore the source image to a file.392 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

You might need to restore the image to a file if bad sectors are present on thetarget volume, or if you want to manipulate the image data. Later, you can use adata copy utility of your choice to transfer the image from the file to a diskvolume.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►► IMAGETOfile ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore image d: e:\diskD.img -imagetofileInactiveUse the inactive option to display both active and inactive objects.You can use the inactive option with the following commands:v delete groupv query asrv query backupv query imagev query nasv query systemstatev query vm (vmbackuptype=fullvm and vmbackuptype=hypervfull)v restorev restore groupv restore imagev restore nasv restore systemstatev restore vm (vmbackuptype=fullvm and vmbackuptype=hypervfull)Important: When using the inactive option during a restore operation, also usethe pick or some other filtering option because, unlike the latest option, allversions are restored in an indeterminate order. This option is implicit whenpitdate is used.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.SyntaxChapter 11. Processing options 393

►► INActive ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore -inactive c:\id\projecta\ -pickInclexclThe inclexcl option specifies the path and file name of an include-exclude optionsfile.Multiple inclexcl statements are permitted. However, you must specify this optionfor each include-exclude file.Ensure that you store your include-exclude options file in a directory to which allusers have read access.When processing occurs, the include-exclude statements within the include-excludefile are placed in the list position occupied by the inclexcl option, in the sameorder, and processed accordingly.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theInclude-Exclude tab of the Preferences editor.Syntax►► INCLExcl filespec ►◄ParametersfilespecSpecifies the path and file name of one include-exclude options file.ExamplesOptions file:inclexcl c:\dsm\backup.exclCommand line:Does not apply.Related informationFor more information about creating an include-exclude options file, see “Creatingan include-exclude list” on page 76.394 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Considerations for Unicode-enabled clientsAn include-exclude file can be in Unicode or non-Unicode format.If the codeset used to create an include-exclude list file does not match the codesetused on the client computer, characters in the file that cannot be mapped by theclient’s codeset to a displayable character cannot be processed when backups areperformed.Using Unicode encoding for files containing include-exclude lists eliminates theunmapped character problem, so you no longer need to use wildcard characters assubstitutes for the unrecognized characters.1. Open TextEdit. Click Format > Make PlainText.2. Enter your include and exclude statements.3. Click File and then click Save As.4. From PlainText Encoding, select Unicode (UTF-8) or Unicode (UTF-16), specifythe file and target directory, and then save the file. Do not add the .txtextension.5. Place an inclexcl option specifying the include-exclude file you just created inyour dsm.sys file.6. Restart the Tivoli Storage Manager client.Windows users: Create an include-exclude file in Unicode format by performingthe following steps:1. Open Notepad.2. Enter your include and exclude statements. You might need to copy file nameswith characters from other code pages using Microsoft Windows Explorer.3. Click File and then click Save As.4. Select the Save as Unicode check box, specify the file and target directory, andthen save the file.5. Place an inclexcl option specifying the include-exclude file you just created inyour client options file (dsm.opt).6. Restart the Tivoli Storage Manager client.Include optionsThe include options specify objects that you want to include for backup andarchive services.The include options specify any of the following:v Objects within a broad group of excluded objects that you want to include forbackup, archive, and image services.v Files that are included for backup or archive processing that you want to includefor encryption processing.v Files that are included for backup or archive processing that you also want toinclude for compression processing.v Files that are included for backup processing that you also want to include foradaptive subfile backup processing.v Objects to which you want to assign a specific management class.v A management class to assign to all objects to which you do not explicitly assigna management class.v File spaces to which you want to assign memory-efficient backup processingv File spaces where you want to use the diskcachelocation option to causespecific file systems to use different, specific locations for their disk cache.Chapter 11. Processing options 395

If you do not assign a specific management class to objects, Tivoli Storage Manageruses the default management class in the active policy set of your policy domain.Use the query mgmtclass command to display information about the managementclasses available in your active policy set.You can include remotely accessed files by specifying Universal NamingConvention (UNC) names in your include statement.Remember: Tivoli Storage Manager compares the files it processes against thepatterns specified in the include-exclude statements, reading from the bottom tothe top of the options file.Note:1. The exclude.dir statement overrides all include statements that match thepattern.2. The include statements are not case-sensitive.3. The server can also define these options with the inclexcl option.Supported ClientsThis option is valid for all clients. The server can also define include.fs.nas.Options FilePlace these options in the client options file (dsm.opt). You can set these options onthe Include-Exclude tab in the Preferences editor.Syntax►► options patternoptional_parameter►◄include, include.backup, include.fileUse these options to include files or assign management classes for backupprocessing.The include option affects archive and backup processing. If you want toassign different management classes for archive and backup processing, alwaysspecify include.archive and include.backup with their own managementclasses. In this example, the archmc management class is assigned when anarchive operation is performed. The management class is assigned when anarchive operation is performed because include.backup is used only forbackup processing, and not for archive processing.include.archive c:\test\*\ archmcinclude.backup c:\test\*include.archiveIncludes files or assigns management classes for archive processing.include.compressionIncludes files for compression processing if you set the compression option toyes. This option applies to backups and archives.include.dedupIncludes files for client-side data deduplication. To control a client-side data396 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

deduplication operation, specify ieobjtype as the value of the include.dedupoption. By default, all data deduplication-eligible objects are included forclient-side data deduplication.Valid ieobjtype parameters are:FileImageSYSTEMStateAsrThe default is File.include.encryptIncludes the specified files for encryption processing. By default, Tivoli StorageManager does not perform encryption processing.|||||||||||||||||||Important: The include.encrypt option is the only way to enable encryptionon the Backup-Archive client. If no include.encrypt statements are used,encryption does not occur.include.fsIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or in use) by otherapplications. The snapshot allows the backup to be taken from a point-in-timecopy that matches the file system at the time the snapshot is taken. Subsequentchanges to the file system are not included in the backup. You can set thesnapshotproviderfs parameter of the include.fs option to none to specifywhich drives do not use open file support.To control how Tivoli Storage Manager processes your file space forincremental backup, you can specify these additional options in your dsm.optfile as values of the include.fs option: diskcachelocation andmemoryefficientbackup.include.fs d: memoryefficientbackup=diskcachemdiskcachelocation=e:\tempinclude.fs e: memoryefficientbackup=diskcachemdiskcachelocation=c:\tempIf these options appear both in the options file and an include.fs option, theinclude.fs values are used for the specified file space in place of any values inan option file or on the command line.include.fs.nasUse the include.fs.nas option to bind a management class to NetworkAttached Storage (NAS) file systems. You can also specify whether TivoliStorage Manager saves Table of Contents (TOC) information during a NAS filesystem image backup, using the toc option with the include.fs.nas option inyour client options file (dsm.opt).include.imageIncludes a file space or logical volume, or assigns a management class whenused with the backup image command. The backup image command ignoresall other include options.By default, Tivoli Storage Manager performs an offline image backup. Toenable and control an online image operation, you can specify these options inyour dsm.opt file as values of the include.image option:snapshotproviderimage, presnapshotcmd, postsnapshotcmd.Chapter 11. Processing options 397

include.subfileIncludes files for adaptive subfile backup processing. This option does notapply to archive processing. This option is valid for all Windows clients.include.systemstateAssigns management classes for backup of the system state. The default is tobind the system state object to the default management class.During system state backup, a progressive incremental backup is used for theSystem Writer files in the system state. If you want to run a full backup of allsystem state data, you can specify include.systemstate mc_name in the clientoptions file (dsm.opt), where mc_name is the name of the management classwith copy group mode absolute.ParameterspatternSpecifies the objects to include for backup or archive processing or to assign aspecific management class.Note: For NAS file systems: You must prefix the NAS node name to the filespecification to specify the file server to which the include statement applies. Ifyou do not specify a NAS node name, the file system identified refers to theNAS node name specified in the client options file (dsm.opt) or on thecommand line.If the pattern begins with a single or double quotation mark, or contains anyembedded blanks or equal signs, you must surround the value in either single(') or double (") quotation marks. The opening and closing quotation marksmust be the same type of quotation marks.For the include.image option, the pattern is the name of a file system or rawlogical volume.Note: When using include.systemstate the only valid pattern is ALL (alltypes of system state objects). By default, Tivoli Storage Manager binds allobjects to the default management class.|||||||||||||||||optional_parametermanagement_class_nameSpecifies the name of the management class to assign to the objects. If amanagement class is not specified, the default management class is used. Toassociate a management class with a backup group on an include statement,use the following syntax:include virtual_filespace_name/group_name management_class_namewhere:virtual_filespace_nameSpecifies the name of the Tivoli Storage Manager server virtualfilespace that you associated with the group, on the Backup Groupcommand.group_nameIs the name of the group that you created when you ran the BackupGroup command.management_class_nameIs the name of the management class to associate with the files in thegroup.398 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||For example, to associate the TEST management class with the groupnamed MyGroup. MyGroup files are stored on the server in the virtualfile space named MyVirtualFileSpace, use the following syntax:include MyVirtualFileSpace\MyGroup TESTTable 62. Other optional parametersoptional_parameterieobjtype“Ieobjtype” on page 390memoryefficientbackup“Memoryefficientbackup” on page 419diskcachelocation“Diskcachelocation” on page 339postsnapshotcmd“Postsnapshotcmd” on page 438presnapshotcmd“Presnapshotcmd” on page 445snapshotproviderfs“Snapshotproviderfs” on page 478snapshotproviderimage“Snapshotproviderimage” on page 479Use with optioninclude.dedupinclude.fsinclude.fsinclude.imageinclude.imageinclude.imageinclude.image|||||||||||||||||||||||||||||ExamplesOptions file:Windows only:include c:\proj\text\devel.*include c:\proj\text\* textfilesinclude ?:* managallinclude WAS_ND_NDNODE mgmtclassinclude WAS_APPNODE mgmtclassinclude.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.image h: MGMTCLASSNAMEsnapshotproviderimage=vssinclude.image x:snapshotproviderimage=noneinclude.image y:snapshotproviderimage=vssinclude.image z: MGMTCLASSNAMEsnapshotproviderimage=noneinclude.fs c:snapshotproviderfs=vssinclude.systemstate ALL mgmtc3include.dedup c:\Users\Administrator\Documents\Important\...\*include.dedup e:\*\* ieobjtype=imageinclude.dedup ALL ieobjtype=systemstateinclude.dedup ALL ieobjtype=ASRTo encrypt all files on all drives:include.encrypt ?:\...\*Chapter 11. Processing options 399

Command line:Does not apply.Related information“Exclude files with UNC names” on page 81“Configuring Open File Support” on page 70Compression, encryption, and adaptive subfile backupprocessingThis topic lists some items to consider if you want to include specific files orgroups of files for compression, encryption, and adaptive subfile backupprocessing during a backup or archive operation.vvvvvYou must set the compression option to yes to enable compression processing. Ifyou do not specify the compression option or you set the compression option tono, Tivoli Storage Manager does not perform compression processing.You must set the subfilebackup option to yes to enable include-exclude adaptivesubfile backup processing. If you do not specify the subfilebackup option oryou set the subfilebackup option to no, Tivoli Storage Manager does notperform adaptive subfile backup processing.Tivoli Storage Manager processes exclude.dir and other include-excludestatements first. Tivoli Storage Manager then considers anyinclude.compression, include.encrypt and include.subfile statements. Forexample, consider the following include-exclude list:exclude c:\test\file.txtinclude.compression c:\test\file.txtinclude.encrypt c:\test\file.txtinclude.subfile c:\test\file.txtTivoli Storage Manager examines the exclude c:\test\file.txt statement firstand determines that c:\test\file.txt is excluded from backup processing andis, therefore, not a candidate for compression, encryption, or adaptive subfilebackup processing.Include-exclude compression and encryption processing is valid for backup andarchive processing only.Include-exclude adaptive subfile backup processing is valid for backup andrestore processing only.v As with other include-exclude statements, you can use the inclexcl option tospecify a file that is in Unicode format, which contains include.compression,include.encrypt and include.subfile statements specifying Unicode files. See“Inclexcl” on page 394 for more information.Related reference:“Compression” on page 320“Subfilebackup” on page 491Processing NAS file systemsUse the include.fs.nas option to bind a management class to NAS file systemsand to control if Table of Contents information is saved for the file system backup.Note: The include.fs.nas option does not apply to incremental snapshotdifference incremental backup.A NAS file system specification uses the following conventions:400 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vNAS nodes represent a new node type. The NAS node name uniquely identifiesa NAS file server and its data to Tivoli Storage Manager. You can prefix the NASnode name to the file specification to specify the file server to which the includestatement applies. If you do not specify a NAS node name, the file system youspecify applies to all NAS file servers.v Regardless of the client platform, NAS file system specifications use the forwardslash (/) separator, as in this example: /vol/vol0.v NAS file system designations on the command line require brace delimiters {}around the file system names, such as: {/vol/vol0}. Do not use brace delimitersin the option file.Use the following syntax:►► pattern mgmtclassname toc=value ►◄ParameterspatternSpecifies the objects to include for backup services, to assign a specificmanagement class, or to control TOC creation. You can use wildcards in thepattern.mgmtclassnameSpecifies the name of the management class to assign to the objects. If amanagement class is not specified, the default management class is used.toc=valueSee “Toc” on page 505 for more information.For example, to assign a management class to the /vol/vol1 file system of a NASnode called netappsj, specify the following include statement:include.fs.nas netappsj/vol/vol1 nasMgmtClass toc=yes||||||||||||||||VMware virtual machine include optionsVMware include and exclude options influence the behavior of backup and restoreoperations for VMware virtual machines. These options are processed before anycommand-line options are processed, so options on the command line can overrideoptions specified on any of the VMware include options or VMware excludeoptions. See the individual option descriptions for information about the options.Related reference:“INCLUDE.VMDISK”“INCLUDE.VMTSMVSS” on page 403INCLUDE.VMDISK:The INCLUDE.VMDISK option includes a VMware virtual machine disk in backupoperation. If you do not specify one or more disk labels, all disks in the virtualmachine are backed up.This option is available only if you are licensed to use IBM ® Tivoli ® StorageManager for Virtual Environments. See the Data Protection for VMware Installationand User's Guide for additional information about this option.Chapter 11. Processing options 401

||||||||||||||||||||||||||||||||||||||||||The INCLUDE.VMDISK option specifies the label of a virtual machine's disk to beincluded in a Backup VM operation. If you include a disk on the Backup VMcommand, the command-line parameters override any INCLUDE.VMDISK statementsin the options file.Supported clientsThis option can be used with supported Windows clients.Options fileSet this option in the client options file. Command line parameters overridestatements in the options file.Syntax►► INCLUDE.VMDISK vmname vmdk_label ►◄ParametersvmnameSpecifies the name of the virtual machine that contains a disk that you want toinclude in a Backup VM operation. You can specify only one virtual machinename on each INCLUDE.VMDISK statement. Specify additional INCLUDE.VMDISKstatements for each virtual machine disk to include.The virtual machine name can contain an asterisk (*), to match any characterstring, and question mark (?) to match any one character. Surround the VMname with quotation marks (“ ”) if the VM name contains space characters.Tip: If the virtual machine name contains special characters, such as bracketcharacters ([ or ]), the virtual machine name might not be correctly matched. Ifa virtual machine name uses special characters in the name, you might need touse the question mark character (?) to match the special characters in the VMnameFor example, to include "Hard Disk 1" in the backup of a virtual machinenamed "Windows VM3 [2008R2]", use this syntax in the options file:INCLUDE.VMDISK "Windows VM3 ?2008R2?" "Hard Disk 1"vmdk_labelSpecifies the disk label of the disk that you want to include. Wildcardcharacters are not allowed. Use the Backup VM command with the -previewoption to determine the disk labels of disks in a given virtual machine. See“Backup VM” on page 562 for the syntax.ExamplesOptions fileAssume that a virtual machine named vm1 contains four disks, labeledHard Disk 1, Hard Disk 2, Hard Disk 3, and Hard Disk 4. To include onlydisk2inaBackup VM operations, specify the following in the optionsfile:INCLUDE.VMDISK "vm1" "Hard Disk 2"Include disks 2 and 3 in Backup VM operations:402 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||INCLUDE.VMDISK "vm1" "Hard Disk 2"INCLUDE.VMDISK "vm1" "Hard Disk 3"Command lineInclude a single disk when backing up vm1:dsmc backup vm "vm1:vmdk=Hard Disk 1"Include disk 2 and disk 3 on vm1:dsmc backup vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"Related reference:“Backup VM” on page 562“Restore VM” on page 647“Domain.vmfull” on page 348“EXCLUDE.VMDISK” on page 370INCLUDE.VMTSMVSS:The INCLUDE.VMTSMVSS option notifies virtual machine applications that a backup isabout to occur. This allows the application to truncate transaction logs and committransactions so the application can resume from a consistent state when the backupcompletes. You must have an IBM ® Tivoli ® Storage Manager for VirtualEnvironments license installed to use this option.When a virtual machine is included by this option, Tivoli Storage Manager,provides application protection. That is, Tivoli Storage Manager freezes and thawsthe VSS writers and truncates the application logs. If a virtual machine is notprotected by this option, application protection is provided by VMware, andVMware freezes and thaws the VSS writers, but application logs are not truncated.Supported clientsThis option can be used with supported Windows clients.Options fileSet this option in the client options file. This option cannot be set by thepreferences editor.Syntax►► INCLUDE.VMTSMVSS vmname ►◄ParametersvmnameSpecifies the name of the virtual machine that contains the applications toquiesce. Specify one virtual machine per INCLUDE.VMTSMVSS statement.To protect all virtual machines with this option, use an asterisk as a wildcard(INCLUDE.VMTSMVSS *. You can also use question marks to match any singlecharacter. So INCLUDE.VMTSMVSS vm?? protects all virtual machines that havenames that begin with “vm” and followed by any two characters (vm10, vm15,and so on).Chapter 11. Processing options 403

|||||||||||||||||||||||||||Tip: If the virtual machine name contains special characters, such as bracketcharacters ([ or ]), the virtual machine name might not be correctly matched. Ifa virtual machine name uses special characters in the name, you might need touse the question mark character (?) to match the special characters in the VMname.For example, to include a virtual machine named "Windows VM3 [2008R2]", usethis syntax in the options file: INCLUDE.VMTSMVSS "Windows VM3 ?2008R2?"There is no default value. To enable application protection, you must includevirtual machines to be protected on one or more INCLUDE.VMTSMVSS statements.Make sure that you do not exclude a disk on a virtual machine (by using theEXCLUDE.VMDISK option) if the disk contains application data that you wantprotected.ExamplesOptions fileConfigure application protection for a virtual machine named“vm_example”:INCLUDE.VMTSMVSS vm_exampleConfigure application protection for vm11, vm12, and vm15:INCLUDE.VMTSMVSS vm11INCLUDE.VMTSMVSS vm12INCLUDE.VMTSMVSS vm15Command lineNot applicable; this option cannot be specified on the command line.Related reference:“Vmtimeout” on page 533“EXCLUDE.VMDISK” on page 370“INCLUDE.VMDISK” on page 401IncrbydateUse the incrbydate option with the incremental command to back up new andchanged files with a modification date later than the last incremental backupstored at the server, unless you exclude the file from backup.Important: Files that are modified or created after their respective directory wasprocessed by the Tivoli Storage Manager client, but before the incremental-by-datebackup completes, are not backed up and will not be backed up in futureincremental-by-date backups, unless the files are modified again. For this reason, aregular incremental backup should be run periodically, without specifying theincrbydate option.An incremental-by-date updates the date and time of the last incremental at theserver. If you perform an incremental-by-date on only part of a file system, thedate of the last full incremental is not updated and the next incremental-by-datebacks up these files again.Both full incrementals and incrementals-by-date back up new and changed files.An incremental-by-date takes less time to process than a full incremental andrequires less memory. However, unlike a full incremental, an incremental-by-datedoes not maintain current server storage of all your workstation files because:v It does not expire backup versions of files that are deleted from the workstation.404 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvIt does not rebind backup versions to a new management class if themanagement class has changed.It does not back up files with attributes that have changed, such as NTFSsecurity information, unless the modification dates and times have also changed.It ignores the copy group frequency attribute of management classes.Note: If you have limited time during the week to perform backups, but extra timeon weekends, you can maintain current server storage of your workstation files byperforming an incremental backup with the incrbydate option on weekdays and afull incremental backup on weekends.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► INCRbydate ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc incremental -incrbydateIncrementalUse the incremental option with the restore image command to ensure that anychanges that were made to the base image are also applied to the restored image.If you also use the deletefiles option, changes include the deletion of files anddirectories that were in the original image but later deleted from the workstation.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►► INCREmental ►◄ExamplesCommand line:res i d: -incrementalChapter 11. Processing options 405

IncrthresholdThe incrthreshold option specifies the threshold value for the number ofdirectories in any journaled file space that might have active objects on the server,but no equivalent object on the workstation.When a Windows client deletes a file or directory with a long name, it sometimesreports this using a compressed name. After the object is deleted, the compressedname might be reused and the deletion notice can no longer identify a uniqueobject. During a journaled incremental backup of a file space, this can result in theno active version response from the server resulting in an unsuccessful expire for anobject.The incrthreshold option allows you to specify what to do when this conditionarises:vvvIf you set the incrthreshold option to 0 (the default), Tivoli Storage Managertakes no action. The primary consequence is that, during a restore of such adirectory, these objects might be inadvertently restored. When the nextnon-journaled incremental is run on this directory, Tivoli Storage Managerexpires all objects in the directory that exist on the server but not on theworkstation.If you specify a value greater than zero, Tivoli Storage Manager saves thedirectory name of an object in the journal during journaled backups. During afull file space journaled incremental backup, if the number of directories in thefile space is greater than or equal to this value, a full incremental backup of eachdirectory occurs. This takes place automatically after completion of the journaledbackup and does not require entry of another command.If you set the incrthreshold option to 1, Tivoli Storage Manager performs a fullincremental backup of these directories whenever a no active version response isreceived during a full file space journaled incremental backup.Supported ClientsThis option is for all Windows clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab → Threshold for non-journal incremental backup field of thePreferences editor.Syntax►► INCRTHreshold numberdirectories ►◄ParametersnumberdirectoriesSpecifies the threshold value for the number of directories in any journaled filespace that might contain active files that should be expired. When thisthreshold is reached during a full file space journaled incremental, the clientinitiates an incremental backup on each such directory at the completion of thejournaled backup. The range of values is 0 through 2,000,000,000; the default is0.406 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:incrthreshold 1Command line:-increthreshold=1This option is valid only on the initial command line. It is not valid ininteractive mode.Related informationSee “Incremental” on page 579 for more information about journaled backups.JournalpipeThe journalpipe option specifies the pipe name of a journal daemon sessionmanager to which the backup clients attach.Supported ClientsThis option is for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).JournalPipe \\.\pipe\jnlSessionMgr1Syntax►► JOURNALPipe pipename ►◄ParameterspipenameSpecify the name of the pipe the client attaches to when performing ajournal-based backup. The default pipe name is \\.\pipe\jnlSessionMgr.ExamplesOptions file:JOURNALPipe \\.\pipe\jnlSessionMgrCommand line:This option cannot be set on the command line.LanfreecommmethodThe lanfreecommmethod option specifies the communications protocol between theTivoli Storage Manager client and Storage Agent. This enables processing betweenthe client and the SAN-attached storage device.If you are using LAN failover, you must have lanfreecommmethod TCPip in theclient options file (dsm.opt).For Windows, use the lanfreeshmport option to uniquely identify the storage agentto which the client is trying to connect.Chapter 11. Processing options 407

Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► LANFREECommmethod commmethod ►◄ParameterscommmethodSpecifies the supported protocol for your Tivoli Storage Manager client:TCPipThe Transmission Control Protocol/Internet Protocol (TCP/IP)communication method.Use the lanfreetcpport option to specify the TCP/IP port number wherethe Storage Agent is listening.V6TcpipIndicates that either TCP/IP Version 4 or Version 6 should be used,depending on the system configuration and results of a domain nameservice lookup. The only time this is not true is when dsmc schedule isused and schedmode is prompt. A valid DNS environment must beavailable.NAMedpipesThe interprocess communication method that permits message datastreams to pass between a client and a server. This is the default. Do notspecify the lanfreetcpport option if you want to use the NAMedpipescommunication method for LAN-free communication.SHAREdmemUse the shared memory communication method when the client andStorage Agent are running on the same system. Shared memory providesbetter performance than the TCP/IP protocol.ExamplesOptions file:lanfreecommmethod tcpUse only TCP/IP Version 4lanfreecommmethod V6TcpipUse both TCP/IP Version 4 or Version 6, depending on how the system isconfigured and the results of a domain name service lookup.Command line:-lanfreec=tcp-lanfreec=V6TcpipThis option is valid only on the initial command line. It is not valid in interactivemode.408 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Related information“Lanfreeshmport”“Lanfreetcpport”LanfreeshmportUse the lanfreeshmport option when lanfreecommmethod=SHAREdmem is specified forcommunication between the Tivoli Storage Manager client and the storage agent.This enables processing between the client and the SAN-attached storage device.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► LANFREEShmport port_address ►◄||Parametersport_addressSpecifies the number that is used to connect to the storage agent. The range ofvalues is 1 through 32767.For Windows clients, the default is 1.For all clients except Windows clients, the default is 1501.ExamplesOptions file:lanfrees 1520Command line:-lanfrees=1520This option is valid only on the initial command line. It is not valid in interactivemode.Related information“Lanfreecommmethod” on page 407LanfreetcpportThe lanfreetcpport option specifies the TCP/IP port number where the TivoliStorage Manager Storage Agent is listening.Use this option when you specify lanfreecommmethod=TCPip for communicationbetween the Tivoli Storage Manager client and Storage Agent. Do not specify thelanfreetcpport option if you want to use the NAMedpipes communicationmethod for LAN-free communication.Chapter 11. Processing options 409

Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► LANFREETCPPort port_address ►◄Parametersport_addressSpecifies the TCP/IP port number where the Storage Agent is listening. Therange of values is 1 through 32767; the default is 1500.Note: The client lanfreetcpport value must match Storage Agent tcpportvalue for communications with the Storage Agent (virtual server). The clienttcpport value must match the server tcpport value for communications withthe actual server.ExamplesOptions file:lanfreetcpp 1520Command line:-lanfreetcpp=1520This option is valid only on the initial command line. It is not valid in interactivemode.Related information“Lanfreecommmethod” on page 407||||||||LanfreesslUse the lanfreessl option to enable Secure Sockets Layer (SSL), to provide secureclient and Storage Agent communications.Supported ClientsThis option is supported on all clients, except for Mac OS X clients.Options FilePlace this option in the client options file. You cannot set this option in the GUI oron the command line.410 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|Syntax||►►LANFREESSLNoYes►◄||||||||||||||||ParametersNoYesSpecifies that the Tivoli Storage Manager client does not use SSL whencommunicating with the Storage Agent. No is the default.Specifies that the Tivoli Storage Manager client enables SSL whencommunicating with the Storage Agent. To enable SSL, specify lanfreessl=yesand change the value of the lanfreetcpport option. Changing the value of thelanfreetcpport option is necessary because the Tivoli Storage Manager StorageAgent is typically set up to listen for SSL connections on a separate port.ExamplesOptions file:lanfreessl yeslanfreessl noCommand line:Not applicable. You cannot set this option on the command line.LanfreetcpserveraddressThe lanfreetcpserveraddress option specifies the TCP/IP address for a TivoliStorage Manager Storage Agent.Use this option when you specify lanfreecommmethod=TCPip or V6Tcpip forcommunication between the Tivoli Storage Manager client and Storage Agent.Overriding the default for this option is useful when configuring LAN-free in anenvironment where the client and storage agent are running on different systems.You can obtain this Storage Agent address from your administrator.Supported Clients|This option is valid for all supported Windows clients.Options FilePlace this option in the client system-options file.Syntax►► LANFREETCPServeraddress stagent_address ►◄Parametersstagent_addressSpecifies a1to64character TCP/IP address for a server. Specify a TCP/IPdomain name or a numeric IP address. The numeric IP address can be either aTCP/IP v4 or TCP/IP v6 address. The default value is 127.0.0.1 (localhost).Chapter 11. Processing options 411

ExamplesOptions file:LANFREETCPServeraddress stagent.bayamon.ibm.comLANFREETCPServeraddress 192.168.1.50Command line:Does not apply.LanguageThe language option specifies the national language in which to present clientmessages.You can use US English (ENU) with all clients.The Tivoli Storage Manager client automatically detects the language of the systemlocale and displays Tivoli Storage Manager for that language. For example, asupported operating system on a Windows system running a French localedisplays Tivoli Storage Manager in French by default, without specifying thelanguage option; provided that the French language pack is installed. If TivoliStorage Manager cannot load the French message catalog, it defaults to the USEnglish language pack. If the client is running on an unsupported language/localecombination, such as French/Canada or Spanish/Mexico, Tivoli Storage Managerdefaults to US English. You can override the default language by specifying thelanguage option.Note: The language option does not affect the Web client. The Web client displaysin the language associated with the locale of the browser. If the browser is runningin a locale that Tivoli Storage Manager does not support, the Web client displays inUS English.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theRegional Settings tab, Language drop-down list of the Preferences editor.Syntax►► LANGuage language ►◄ParameterslanguageSpecifies the language you want to use. The available languages include:v ENU (English, United States).v PTB (Brazilian Portuguese)v CHS (Chinese, Simplified)v CHT (Chinese, Traditional)v FRA (Standard French)v DEU (Standard German)412 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvvvvvITA (Standard Italian)JPN (Japanese)KOR (Korean)ESP (Standard Spanish)CSY (Czech)HUN (Hungarian)PLK (Polish)RUS (Russian)LatestExamplesOptions file:language enuCommand line:Does not apply.Use the latest option to restore the most recent backup version of a file, even ifthe backup is inactive.You can use the latest option with the following commands:v restorev restore groupIf you are performing a point-in-time restore (using the pitdate option), it is notnecessary to specify latest since this option is implicit when pitdate is used.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► LATest ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore c:\devel\projecta\ -latestLocalbackupsetThe localbackupset option specifies whether the Tivoli Storage Manager GUIbypasses initial logon with the Tivoli Storage Manager server to restore a localbackup set on a standalone workstation.If you set the localbackupset option to yes, the GUI does not attempt initial logonwith the server. In this case, the GUI only enables the restore functionality.Chapter 11. Processing options 413

If you set the localbackupset option to no (the default), the GUI attempts initiallogon with the server and enables all GUI functions.Note: The restore backupset command supports restore of local backup sets on astandalone workstation without using the localbackupset option.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the dsm.opt file.Syntax►►LOCALbackupsetNoYes►◄ParametersNoYesSpecifies that the GUI attempts initial logon with the server and enables allfunctions. This is the default.Specifies that the GUI does not attempt initial logon with the server andenables only the restore functionality.ExamplesOptions file:localbackupset yesThis option is not valid with the dsmc command-line client. (Does not apply toMac OS X)Related information“Restore Backupset” on page 631ManagedservicesThe managedservices option specifies whether the Tivoli Storage Manager clientacceptor service manages the scheduler, the Web client, or both.Restriction: You cannot use the dsmcad for scheduling when you set thesessioninitiation option to serveronly.The client acceptor daemon serves as an external timer for the scheduler. When thescheduler is started, it queries the server for the next scheduled event. The event iseither executed immediately or the scheduler exits. The client acceptor daemonrestarts the scheduler when it is time to execute the scheduled event.Note:414 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

1. If you set the schedmode option to prompt, the server prompts the clientacceptor daemon when it is time to run the schedule. The scheduler connects toand disconnects from the server when the client acceptor daemon is firststarted.The dsmc schedule command cannot be used when both schedmode prompt andcommmethod V6Tcpip are specified.2. Set the passwordaccess option to generate in your client options file (dsm.opt)and generate a password, so Tivoli Storage Manager can manage yourpassword automatically.Using the client acceptor daemon to manage the scheduler service can provide thefollowing benefits:vvMemory retention problems that can occur when using traditional methods ofrunning the scheduler are resolved. Using the client acceptor daemon to managethe scheduler requires very little memory between scheduled operations.The client acceptor daemon can manage both the scheduler program and theWeb client, reducing the number of background processes on your workstation.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theWeb Client tab of the Preferences editor.Syntax►► MANAGEDServices mode ►◄ParametersmodeSpecifies whether the client acceptor daemon manages the scheduler, the Webclient, or both.webclientSpecifies that the client acceptor daemon manages the Web client.scheduleSpecifies that the client acceptor daemon manages the scheduler. Bothwebclient and schedule are the defaults for Mac OS X.ExamplesOptions file:The following are examples of how you might specify the managedservicesoption in your client options file (dsm.opt).TaskTaskSpecify that the client acceptor daemon manages only the Webclient.managedservices webclientSpecify that the client acceptor daemon manages only thescheduler.Chapter 11. Processing options 415

managedservices scheduleTaskSpecify that the client acceptor daemon manages both the Webclient and the scheduler.managedservices schedule webclientNote: The order in which these values are specified is notimportant.Command line:Does not apply.Related information“Passwordaccess” on page 433See “Configuring the client scheduler” on page 33 for instructions to set up theclient acceptor daemon to manage the scheduler.“Sessioninitiation” on page 468MaxcmdretriesThe maxcmdretries option specifies the maximum number of times the clientscheduler (on your workstation) attempts to process a scheduled command thatfails.The command retry starts only if the client scheduler has not yet backed up a file,never connected to the server, or failed before backing up a file. This option is onlyused when the scheduler is running.Your Tivoli Storage Manager administrator can also set this option. If your TivoliStorage Manager administrator specifies a value for this option, that valueoverrides what you specify in the client options file after your client nodesuccessfully contacts the server.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Maximum command retries field of the Preferences editor.Syntax►► MAXCMDRetries maxcmdretries ►◄ParametersmaxcmdretriesSpecifies the number of times the client scheduler can attempt to process ascheduled command that fails. The range of values is zero through 9999; thedefault is 2.416 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:maxcmdr 4Command line:-maxcmdretries=4This option is valid only on the initial command line. It is not valid in interactivemode.||||||||||||||||||||||||||MbobjrefreshthreshThe mbobjrefreshthresh (megablock object refresh threshold) option is a numberdefining a threshold. When the number of Tivoli Storage Manager objects that areneeded to describe any 128 MB megablock exceeds this value, the entire megablockis refreshed and the objects that were used to represent this area, in previousbackups, are expired.During a backup operation, VMware virtual machine data is stored on the TivoliStorage Manager server in 128 MB units, called megablocks. Ifanareaontheproduction disk changes and a new incremental backup is performed, a newmegablock is created to represent the changes that were made to the previouslybacked up data. Because a new megablock can be created with each incrementalbackup, eventually the megablocks can adversely affect the performance of theTivoli Storage Manager database, and therefore, adversely affect the performanceof most Tivoli Storage Manager operations.Use this option when estimating Tivoli Storage Manager objects that representproduction data for each virtual machine backup. For example, when the numberof Tivoli Storage Manager objects exceed this value, the megablock is refreshed.This action means that the entire 128-MB block is copied to the Tivoli StorageManager server and is represented as a single Tivoli Storage Manager object. Theminimum value is 2 and the maximum value is 8192. The default value is 50.Supported clientsThis option is valid for clients that are data mover nodes that protect VMwarevirtual machines.Options fileSpecify this option in the client options file.Syntax||►►MBOBJREFRESHTHRESH50integer►◄|||ParametersThe minimum value you can specify is 2 megablocks, the largest value is 8192megablocks; the default is 50 megablocks.Chapter 11. Processing options 417

|||||||||||||||||||||||||||||||||ExamplesSet this option to trigger a megablock refresh when the number of objects neededto represent an updated megablock exceeds 20 objects:MBOBJREFRESHTHRESH 20Related informationAdditional information about using the MBOBJREFRESHTHRESH option for optimaldatabase performance is described in the IBM Tivoli Storage Manager for VirtualEnvironments Version 6.4 Data Protection for VMware Installation and User's Guide.MbpctrefreshthreshThe mbpctrefreshthresh (megablock percentage refresh threshold) option is anumber defining a threshold. When the number of Tivoli Storage Managerpercentage of objects that are needed to describe any 128 MB megablock exceedsthis value, the entire megablock is refreshed and the objects that were used torepresent this area, in previous backups, are expired.During a backup operation, VMware virtual machine data is stored on the TivoliStorage Manager server in 128 MB units, called megablocks. Ifanareaontheproduction disk changes and a new incremental backup is performed, a newmegablock is created to represent the changes that were made to the previouslybacked up data. Because a new megablock can be created with each incrementalbackup, eventually the megablocks can adversely affect the performance of theTivoli Storage Manager database, and therefore, adversely affect the performanceof most Tivoli Storage Manager operations.Use this option when estimating the amount of additional data that is backed upfor each virtual machine. For example, when a 128-MB block of a production diskchanges more than the percentage specified, the entire 128-MB block is copied tothe Tivoli Storage Manager server. The block is represented as a single TivoliStorage Manager object.Supported clientsThis option is valid for clients that are data mover nodes that protect VMwarevirtual machines.Options fileSpecify this option in the client options file.Syntax||►►MBPCTREFRESHTHRESH50integer►◄|||ParametersThe minimum value you can specify is 1 percent, the largest value is 99 percent;the default is 50 percent.418 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||ExamplesSet this option to trigger a megablock refresh when 50 percent (or more) of theobjects in a megablock on a production disk have changed:MBPCTREFRESHTHRESHOLD 50Related informationAdditional information about using the MBPCTREFRESHTHRESH option for optimaldatabase performance is described in the IBM Tivoli Storage Manager for VirtualEnvironments Version 6.4 Data Protection for VMware Installation and User's Guide.MemoryefficientbackupThe memoryefficientbackup option specifies the memory-conserving algorithm touse for processing full file space backups.One method backs up one directory at a time, using less memory. The othermethod uses much less memory, but requires more disk space.Use the memoryefficientbackup option with the incremental command when yourworkstation is memory constrained. You can also use this option as a parameter tothe include.fs option in order to select the algorithm Tivoli Storage Manager useson a per-filespace basis.Use memoryefficientbackup=diskcachemethod for any file space that has too manyfiles for Tivoli Storage Manager to complete the incremental backup with either thedefault setting, memoryefficientbackup=no, or with memoryefficientbackup=yes.The disk cache file created by the initial disk cache incremental backup can requireup to 5 GB of disk space for each million files or directories being backed up.The actual amount of disk space required for the disk cache file created by diskcache incremental backups depends on the number of files and directories includedin the backup and on the average path length of the files and directories to bebacked up. Estimate 2 bytes per character in the path name. For example, if thereare 1 000 000 files and directories to be backed up and the average path length is200 characters, then the database occupies approximately 400 MB. Another way toestimate for planning purposes is to multiply the number of files and directoriesby the length of the longest path to establish a maximum database size.Supported ClientsThis option is valid for all clients. The server can also define this option.Options FilePlace this option in the client user-options file (dsm.opt), or on the initial commandline. You can also set this option on the Performance Tuning tab in the Preferenceseditor, and selecting the Use memory-saving algorithm check box.Chapter 11. Processing options 419

|Syntax||►►MEMORYEFficientbackupNoYesDISKCACHEMethod►◄||||||||||||||||||||||||||||||||||ModeParametersNoYour client node uses the faster, more memory-intensive method whenprocessing incremental backups. This is the default.YesYour client node uses the method that requires less memory when processingincremental backups.DiskcachemethodYour client node uses the method that requires much less memory but moredisk space when processing incremental backups for full file systems.ExamplesOptions file:memoryefficientbackup yesmemoryefficientbackup diskcachemCommand line:-memoryef=noRelated information“Include options” on page 395Use the mode option to specify the backup mode to use when performing specificbackup operations.The mode option has no effect on a when backing up a raw logical device.You can use the mode option with the following backup commands:backup imageTo specify whether to perform a selective or incremental image backup ofclient file systems.backup nasTo specify whether to perform a full or differential image backup of NASfile systems.backup groupTo specify whether to perform a full or differential group backupcontaining a list of files from one or more file space origins.backup vmTo specify whether to perform a full, incremental, incremental-forever-full,or incremental-forever-incremental backup of VMware virtual machines.420 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||The incremental mode and the incremental-forever-incremental modes canonly be used if you have a license for IBM Tivoli Storage Manager forVirtual Environments.For Microsoft Hyper-V virtual machines, you must specifyvmbackuptype=hypervfull and use mode=full.Supported ClientsThis option is valid on all supported clients, except Mac OS. The Tivoli StorageManager API does not support this option.SyntaxFor image backups of client file systems|||Selective►► MODE =IncrementalFor image backup of NAS file systems►◄||►►MODE =differentialfull►◄|For group backups||||||||►►MODE =fulldifferentialFor backing up VMware virtual machinesAll of these modes, except for full mode, require a IBM Tivoli StorageManager for Virtual Environments license.►►MODE =fullincrementalIFFullIFIncrementalFor full VM backup of Microsoft Hyper-V virtual machines►◄►◄||►►MODE =full►◄|||||ParametersImage backup parametersselectiveSpecifies that you want to perform a full (selective) image backup. Thisis the default mode for image backups of client file systems.Chapter 11. Processing options 421

|||||||||||||||||||||||||||||||||||||||||||||||||incrementalSpecifies that you want to back up only the data that has changedsince the most recent image backup. If an image backup has notalready been created, then the first backup is a full image backup(mode=selective), regardless of what mode option you specify.NAS backup parametersdifferentialThis is the default for NAS objects. Specifies that you want to performa NAS backup of files that changed since the last full backup. If thereis no copy of a full image stored on the Tivoli Storage Manager server,a full backup occurs. If a full image exists, whether it is restorable, orexpired and being maintained because of dependent differentialimages, specifying MODE =differential sends a differential imagebackup. If a full image is sent during a differential backup, it isreflected as a full image using the QUERY NASBACKUP servercommand.A full image can be eligible for expiration based on versioning orretention (verexists retextra), but still be maintained on the TivoliStorage Manager server to allow for restoring dependent differentialimages. A full image that is eligible for expiration cannot be selectedfor restore, so it is not displayed using the QUERY NASBACKUPserver command. The differential image backups that depend on an"expired" full image can be restored.fullSpecifies that you want to perform a full backup of NAS file systems.Group backup parametersfullSpecifies that you want to perform a full backup of group objects. Thisis the default for group backups.differentialSpecifies that you want to perform a group backup of files thatchanged since the last full backup. If there is no copy of a full imagestored on the Tivoli Storage Manager server, a full backup occurs. If afull image exists, whether it is restorable, or expired and beingmaintained because of dependent differential images, specifyingMODE =differential sends a differential image backup. If a fullimage is sent during a differential backup, it is reflected as a fullimage using the QUERY GROUP server command.A full image can be eligible for expiration based on versioning orretention (verexists retextra), but still be maintained on the TivoliStorage Manager server to allow for restoring dependent differentialimages. A full image that is eligible for expiration cannot be selectedfor restore, so it is not displayed using the QUERY GROUP servercommand. The differential image backups that depend on an "expired"full image can be restored.VMware virtual machine parametersThe incremental forever backup strategy is described in the IBM TivoliStorage Manager for Virtual Environments Version 6.4 Data Protection forVMware Installation and User's Guide.422 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||||||||||||||ExamplesTaskTaskTaskTaskTaskTaskfullSpecifies that you want to perform an image backup of all objects on aVMware virtual machine's disks. This is the default mode for VMwarevirtual machine backup operations.IFFullSpecifies that you want to perform an incremental-forever-full backupof a VMware virtual machine. An IFFull backup backs up all usedblocks on a VMware virtual machine's disks. To use this mode, youmust be licensed to use IBM Tivoli Storage Manager for VirtualEnvironments.incrementalSpecifies that you want to back up only new and changed data afterthe most recent image backup (full or incremental). If an image backuphas not yet been made, then the first backup is a full image backup,regardless of the mode option.IFIncrementalSpecifies that you want to perform an incremental-forever-incrementalbackup of a VMware virtual machine. An IFIncremental backup backsup only the disk blocks that have changed since the last backup. Touse this mode, you must be licensed to use IBM Tivoli StorageManager for Virtual Environments.Microsoft Hyper=V virtual machine parametersfullSpecifies that you want to perform an image backup of allobjects on a Hyper-V virtual machine's disks. This is the onlymode that you can specify for Hyper-V backups.Perform a full VM incremental backup of a VMware virtual machinenamed vm1.dsmc backup vm vm1 -mode=incremental -vmbackuptype=fullPerform a backup of a VMware virtual machine named vm1, using theincremental-forever-incremental mode to back up only the data that haschanged since the last backup.dsmc backup vm vm1 -mode=ifincremental -vmbackuptype=fullPerform a full VM backup of a Windows Hyper-V VM named msvm1dsmcbackup vm msvm1 -mode=full -vmbackuptype=hypervfullPerform the NAS image backup of the entire file system.dsmc backup nas -mode=differential -nasnodename=nas1 {/vol/vol0} {/vol/vol1}Back up the c: drive using an image incremental backup that backs uponly new and changed files after the last full image backup.dsmc backup image c: -mode=fullPerform a full backup of all the files in filelist c:\dir1\filelist1 to thevirtual file space name \virtfs containing the group leader c:\group1 file.backup group -filelist=c:\dir1\filelist1 -groupname=group1-virtualfsname=\virtfs -mode=incremental -vmbackuptype=fullvmChapter 11. Processing options 423

|||||Related reference:“Backup VM” on page 562“Backup Group” on page 551“Backup Image” on page 554“Backup NAS” on page 558MonitorThe monitor option specifies whether to monitor an image backup or restore of filesystems belonging to a Network Attached Storage (NAS) file server.If you specify monitor=yes, Tivoli Storage Manager monitors the current NASimage backup or restore operation and displays processing information on yourscreen. This is the default.If you specify monitor=no, Tivoli Storage Manager does not monitor the currentNAS image backup or restore operation and is available to process the nextcommand.Use this option with the backup nas or restore nas commands.Supported ClientsThis option is valid for all Windows clients.Syntax►►MONitor =YesNo►◄ParametersYesNoSpecifies that you want to monitor the current NAS image backup or restoreoperation and display processing information on your screen. This is thedefault.Specifies that you do not want to monitor the current NAS image backup orrestore operation.ExamplesCommand line:backup nas -mode=full -nasnodename=nas1 -monitor=yes{/vol/vol0} {/vol/vol1}NamedpipenameThe namedpipename option specifies the name of a named pipe to use forcommunications between a client and a server on the same Windows serverdomain.Supported ClientsThis option is valid for all Windows clients.424 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab of the Preferences editor.Syntax►► NAMedpipename name ►◄ParametersnameThe name of a named pipe. The default is \\.\pipe\Server1.ExamplesOptions file:namedpipename \\.\pipe\dsmser1Command line:-namedpipename=\\.\pipe\dsmser1This option is valid only on the initial command line. It is not valid in interactivemode.NasnodenameThe nasnodename option specifies the node name for the NAS file server whenprocessing NAS file systems. Tivoli Storage Manager prompts you for anadministrator ID.The node name identifies the NAS file server to the Tivoli Storage Manager server.The server must register the NAS file server.You can specify this option on the command line or in the client options file(dsm.opt).You can override the default value in the dsm.opt file by entering a different valueon the command line. If you do not specify the nasnodename option in the dsm.optfile, you must specify this option on the command line when processing NAS filesystems.You can use the nasnodename option with the following commands:v backup nasv delete filespacev query backupv query filespacev restore nasYou can use the delete filespace command to interactively delete NAS file spacesfrom server storage.Use the nasnodename option to identify the NAS file server. Place the nasnodenameoption in your client options file (dsm.opt). The value in the client options file isthe default, but this value can be overridden on the command line. If thenasnodename option is not specified in the client options file, you must specify thisoption on the command line when processing NAS file systems.Chapter 11. Processing options 425

Use the class option to specify the class of the file space to delete. To display a listof file spaces belonging to a NAS node so that you can choose one to delete, usethe -class=nas option.To delete NAS file spaces using the Web client, see the topic for backing up yourdata.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab of the Preferences editor.Syntax►► NASNodename nodename ►◄ParametersnodenameSpecifies the node name for the NAS file server.ExamplesOptions file:nasnodename nas2Command line:-nasnodename=nas2NodenameUse the nodename option in your client options file to identify your workstation tothe server. You can use different node names to identify multiple operatingsystems on your workstation.When you use the nodename option, Tivoli Storage Manager prompts for thepassword assigned to the node you specify, if a password is required.If you want to restore or retrieve files from the server while you are working froma different workstation, use the virtualnodename option. You can also use theasnodename option, if it is set up by the administrator.If you are working from a different workstation, you can use the nodename optioneven if the passwordaccess option is set to generate, however, the password isstored in the Windows Registry. To prevent this, use the virtualnodename optioninstead of nodename.The node name is not necessarily the TCP/IP host name.v In the absence of a nodename entry in the dsm.opt file, or a virtualnodenameentry in the client options file (dsm.opt), or a virtual node name specified on acommand line, the default login ID is the name that the hostname commandreturns.426 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvIf a nodename entry exists in the dsm.opt file, the nodename entry overrides thename that the hostname command returns.If a virtualnodename entry exists in the client options file (dsm.opt), or a virtualnode name is specified on a command line, it cannot be the same name as thename returned by the hostname command. When the server accepts the virtualnode name, a password is required (if authentication is on), even if thepasswordaccess option is generate. When a connection to the server isestablished, access is permitted to any file that is backed up using this login ID.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab, in the Node Name field of the Preferences editor.Syntax►► NODename nodename ►◄ParametersnodenameSpecifies a1to64character node name for which you want to request TivoliStorage Manager services. The default is the value returned with the hostnamecommand.Not specifying a node name permits the node name to default to the hostname of the workstationExamplesOptions file:nodename cougarCommand line:-nodename=cougarThis option is valid only on the initial command line. It is not valid in interactivemode.“Virtualnodename” on page 514NojournalUse the nojournal option with the incremental command to specify that you wantto perform a traditional full incremental backup, instead of the defaultjournal-based backup.Journal-based incremental backup differs from the traditional full incrementalbackup in the following ways:vvTivoli Storage Manager does not enforce non-default copy frequencies (otherthan 0).Attribute changes to an object require a backup of the entire object.Chapter 11. Processing options 427

For these reasons, you might want to use the nojournal option periodically toperform a traditional full incremental backup.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►► NOJournal ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc incr c: -nojournalRelated informationSee “Journal-based backup” on page 583 for more information about journal-basedincremental backup.NopromptThe noprompt option suppresses the confirmation prompt that is presented by thedelete group, delete archive, expire, restore image, and set event commands.v delete archivev delete backupv delete groupv expirev restore imageSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► NOPrompt ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc delete archive -noprompt c:\home\project\*428 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

NumberformatThe numberformat option specifies the format you want to use to display numbers.Use this option if you want to change the default number format for the languageof the message repository you are using.By default, the backup-archive and administrative clients obtain formatinformation from the locale definition in effect at the time the client is called.Consult the documentation on your local system for details about setting up yourlocale definition.Note: The numberformat option does not affect the Web client. The Web client usesthe number format for the locale that the browser is running in. If the browser isnot running in a supported locale, the Web client uses the number format for USEnglish.You can use the numberformat option with the following commands:v delete archivev delete backupv expirev query archivev query asrv query backupv query imagev query nasv query systemstatev restorev restore imagev restore nasv restore registryv restore systemstatev retrievev set eventSupported ClientsThis option is valid for all clients.Options FilePlace this option in the client user-options file (dsm.opt). You can set this option onthe Regional Settings tab, Number Format field of the Preferences editor.Syntax►► NUMberformat number ►◄ParametersnumberDisplays numbers using any one of the following formats. Specify the number(0–6) that corresponds to the number format you want to use.0 Use the locale-specified date format. This is the default (does not apply toMac OS X).Chapter 11. Processing options 429

1 1,000.00This is the default for the following available translations:v US Englishv Japanesev Chinese (Traditional)v Chinese (Simplified)v Korean2 1,000,003 1 000,00This is the default for the following available translations:v Frenchv Czechv Hungarianv Polishv Russian4 1 000.005 1.000,00This is the default for the following available translations:v Brazilian Portuguesev Germanv Italianv Spanish6 1'000,00ExamplesOptions file:num 4Command line:-numberformat=4This option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.OptfileThe optfile option specifies the client options file to use when you start a TivoliStorage Manager session.Supported ClientsThis option is valid for all clients.Syntax►► OPTFILE = file_name ►◄430 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Parametersfile_nameSpecifies an alternate client options file, if you use the fully qualified pathname. If you specify only the file name, Tivoli Storage Manager assumes thefile name specified is located in the current working directory. The default isdsm.opt.ExamplesCommand line:dsmc query session -optfile=myopts.optThis option is valid only on the initial command line. It is not valid in interactivemode.PasswordThe password option specifies a Tivoli Storage Manager password.If you do not specify this option and your administrator has set authentication toOn, you are prompted for a password when you start a Tivoli Storage Managersession.Note:1. If the server prompts for a password, the password is not displayed as youenter it. However, if you use the password option on the command line, yourpassword is displayed as you enter it.2. If the Tivoli Storage Manager server name changes or Tivoli Storage Managerclients are directed to a different Tivoli Storage Manager server, all clients mustre-authenticate with the server because the stored encrypted password must beregenerated.The password option is ignored when the passwordaccess option is set to generate.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► PASsword password ►◄|||||||ParametersPASswordSpecifies the password you use to log on to the Tivoli Storage Manager server.Passwords can be up to 63 character in length. Password constraints vary,depending on where the passwords are stored and managed, and dependingon the version of the Tivoli Storage Manager server that your client connectsto.Chapter 11. Processing options 431

||||||||||||||||||||||||||||||||||||||||If your Tivoli Storage Manager server is at version 6.3.3 or later, and if youuse an LDAP directory server to authenticate passwordsUse any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are case-sensitive and are subject to more restrictions thatcan be imposed by LDAP policies.If your Tivoli Storage Manager server is at version 6.3.3 or later, and if youdo not use an LDAP directory server to authenticate passwordsUse any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are stored in the Tivoli Storage Manager server databaseand are not case-sensitive.If your Tivoli Storage Manager server is earlier than version 6.3.3Use any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-&+.Remember:Passwords are stored in the Tivoli Storage Manager server databaseand are not case-sensitive.On the command line, enclose a password in quotation marks if the passwordcontains one or more special characters. The quotation marks ensure that thespecial characters are correctly interpreted as password characters. Withoutquotation marks, the special characters can be interpreted as shell escapecharacters, file redirection characters, or other characters that have significanceto the operating system.On Windows systems:Enclose the password in quotation marks (").Command line example:-password="secret>shhh"Quotation marks are not required when you type a password with specialcharacters in an options file.ExamplesOptions file:password secretwordCommand line:-password=secretword-password="secret>shhh"432 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

This option is valid only on the initial command line. It is not valid in interactivemode.PasswordaccessThe passwordaccess option specifies whether you want to generate your passwordautomatically or set as a user prompt.Your administrator can require a password for your client node by enabling theauthentication feature. Ask your administrator if a password is required for yourclient node.If a password is required, you can choose one of the following methods:v Set the password for your client node yourself and have Tivoli Storage Managerprompt for it each time you request services.v Let Tivoli Storage Manager automatically generate a new password for yourclient node each time it expires, encrypt and store the password in a file, andretrieve the password from that file when you request services. You are notprompted for the password.When the passwordaccess option is set to generate and you specify the passwordoption, the password option is ignored.Setting the passwordaccess option to generate is required in the followingsituations:v When using the Web client.v When performing NAS operations.v When using Tivoli Continuous Data Protection for Files.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theAuthorization tab, in the Password Access section of the Preferences editor.Syntax►►PASSWORDAccesspromptgenerate►◄ParameterspromptYou are prompted for your Tivoli Storage Manager client node password eachtime a client connects to the server. This is the default.To keep your client node password secure, enter commands without thepassword and wait for Tivoli Storage Manager to prompt you for thepassword.API applications must supply the password when a session is initiated. Theapplication is responsible for obtaining the password.Chapter 11. Processing options 433

||||||||||||||generateEncrypts and stores your password locally and generates a new passwordwhen the old password expires. The new password is randomly generated bythe Tivoli Storage Manager client. Password constraints vary, depending onwhere the passwords are stored and managed, and depending on the versionof the server that your client connects to. Generated passwords are 63characters in length and contain at least two of the following characters:v upper case lettersv lower case lettersv numeric charactersv special charactersAdditionally, the first and last character of a generated password is analphabetic character, and they can be either upper or lower case. Generatedpasswords do not contain repeated characters.A password prompt is displayed when registering a workstation with a serverusing open registration or if your administrator changes your password manually.ExamplesOptions file:passwordaccess generateCommand line:Does not apply.Related informationPickThe pick option creates a list of backup versions or archive copies that match thefile specification you enter.From the list, you can select the versions to process. Include the inactive option toview both active and inactive objects.For images, if you do not specify a source file space and destination file space, thepick list contains all backed up images. In this case, the images selected from thepick list are restored to their original location. If you specify the source file spaceand the destination file space, you can select only one entry from the pick list.Use the pick option with the following commands:v delete archivev delete backupv delete groupv expirev restorev restore asrv restore groupv restore imagev restore nasv restore vmv retrieve434 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► PIck ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore c:\project\* -pick -inactivePitdateUse the pitdate option with the pittime option to establish a point in time todisplay or restore the latest version of your backups.Files that were backed up on or before the date and time you specify, and whichwere not deleted before the date and time you specify, are processed. Backupversions that you create after this date and time are ignored.Use the pitdate option with the following commands:v delete backupv query asrv query backupv query groupv query imagev query nasv query systemstatev query vm (vmbackuptype=fullvm and vmbackuptype=hypervfull)v restorev restore groupv restore imagev restore nasv restore systemstatev restore vm (vmbackuptype=fullvm and vmbackuptype=hypervfull)When pitdate is used, the inactive and latest options are implicit.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Chapter 11. Processing options 435

Syntax►► PITDate = date ►◄ParametersdateSpecifies the appropriate date. Enter the date in the format you selected withthe dateformat option.When you include dateformat with a command, it must precede the fromdate,pitdate, and todate options.ExamplesCommand line:dsmc restore -pitdate=08/01/2003 c:\myfiles\PittimeUse the pittime option with the pitdate option to establish a point in time todisplay or restore the latest version of your backups.Files that were backed up on or before the date and time you specify, and whichwere not deleted before the date and time you specify, are processed. Backupversions that you create after this date and time are ignored. This option is ignoredif you do not specify pitdate option.Use the pittime option with the following commands:v delete backupv query asrv query backupv query imagev query nasv query systemstatev query vm(vmbackuptype=fullvm and vmbackuptype=hypervfull)v restorev restore imagev restore nasv restore systemstatev restore vm (vmbackuptype=fullvm and vmbackuptype=hypervfull)Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► PITTime = time ►◄436 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParameterstimeSpecifies a time on a specified date. If you do not specify a time, the timedefaults to 23:59:59. Specify the time in the format you selected with thetimeformat option.When you include the timeformat option in a command, it must precede thefromtime, pittime, and tottime options.ExamplesCommand line:dsmc query backup -pitt=06:00:00 -pitd=08/01/2003 c:\myfiles\Postschedulecmd/PostnschedulecmdThe postschedulecmd/postnschedulecmd option specifies a command that the clientprogram processes after it runs a schedule.If you want the client program to wait for the command to complete before itcontinues with other processing, use the postschedulecmd option. If you do notwant to wait for the command to complete before the client continues with otherprocessing, specify the postnschedulecmd option.Notes:1.For scheduled operations where the scheduled action is something other thanCOMMAND:If the postschedulecmd command does not complete with return code 0(zero), the return code for the scheduled event is either 8, or the returncode of the scheduled operation, whichever is greater. If you do notwant the postschedulecmd command to be governed by this rule, youcan create a script or batch file that starts the command and exits withreturn code 0. Then configure postschedulecmd to start the script orbatch file.2.For scheduled operations where the scheduled action is COMMAND:The return code from the command specified on the postschedulecmdoption does not affect the return code that is reported to the serverwhen the scheduled event completes. If you want the results ofpostschedulecmd operations to affect the return code of the scheduledevent, include the postschedulecmd operations in the scheduled actioncommand script instead of using the postschedulecmd option.3. The return code from an operation specified on the postnschedulecmd option isnot tracked, and does not influence the return code of the scheduled event.4. If the scheduler action cannot be started, and the command specified on thepreschedulecmd option completes with a return code of zero (0), the commandspecified by the postschedulecmd option is run.5. The server can also define the postschedulecmd option (and thepostnschedulecmd option).Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Chapter 11. Processing options 437

Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab in the Schedule Command text box in the Preferences editor.Syntax►►POSTSChedulecmdPOSTNSChedulecmdcmdstring►◄ParameterscmdstringSpecifies the command to process. You can enter a command to be run after aschedule with this option. Use only one postschedulecmd option.Specify the command string just as you would enter it from the operatingsystem command prompt. If the command string contains any blank spaces,enclose the command string in single quotation marks. For example:’net stop someservice’Use a blank, or null, string for cmdstring if you want to prevent any commandsfrom running that the Tivoli Storage Manager server administrator uses forpostschedulecmd or preschedulecmd. If you specify a blank or null string oneither option, it prevents the administrator from using a command on bothoptions.If your administrator uses a blank or null string on the postschedulecmdoption, you cannot run a post-schedule command.ExamplesOptions file:posts startdb.cmdposts ’rename c:\myapp\logfile.log logfile.new’posts ’net start "simple service"’posts ’rename "c:\myapp\log file.log" "log file.new"’posts ’"C:\Program Files\MyTools\runreport.bat"log1.in log2.in’Command line:-postschedulecmd="’restart database’"This option is valid only on the initial command line. It is not valid in interactivemode.Related concepts:Chapter 8, “Client return codes,” on page 237PostsnapshotcmdThe postsnapshotcmd option allows you to run operating system shell commandsor scripts after the Tivoli Storage Manager client starts a snapshot during asnapshot-based backup operation.438 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

This option can be used in conjunction with the presnapshotcmd option to allowyou to quiesce an application while a snapshot is created, and then to restart thatapplication after the snapshot is started. This option is only valid if OFS or onlineimage backup has been configured.For an online image backup, use this option with the backup image command, theinclude.image option, or in the dsm.opt file.For open file support operations, use the postsnapshotcmd option in an include.fsstatement or in your client options file (dsm.opt).If the postsnapshotcmd fails the operation continues, but appropriate warnings arelogged.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can also set this option onthe Image-Snapshot tab of the Preferences editor.Syntax►► POSTSNAPshotcmd "cmdstring" ►◄Parameters"cmdstring"Specifies the quiesce command to process.Use a blank, or null, string for "cmdstring" if you want to prevent anycommands from running that the administrator uses for postsnapshotcmd. Ifyou specify a blank or null string, it prevents the administrator from using acommand on this option. If your administrator uses a blank or null string onthe postsnapshotcmd option, you cannot run a post-snapshot command.Use the srvprepostsnapdisabled option to prevent the Tivoli Storage Managerserver administrator from executing operating system commands on the clientsystem.If the command string contains blanks, enclose the command string inquotation marks:"resume database myDb"If you placed quotation marks within the command string, then enclose theentire command string in single quotation marks:’resume database "myDb"’ExamplesOptions file:postsnapshotcmd "restart application"The command string is a valid command for restarting your application.Chapter 11. Processing options 439

Command line:backup image -postsnapshotcmd="restart application"This option is valid only on the initial command line. It is not valid in interactivemode.Related information“Include options” on page 395“Srvprepostscheddisabled” on page 483Preschedulecmd/PrenschedulecmdThe preschedulecmd option specifies a command that the client program processesbefore it runs a schedule.The client program waits for the command to complete before it starts theschedule. If you do not want it to wait, specify prenschedulecmd.Note:1. Successful completion of the preschedulecmd command is considered to be aprerequisite to running the scheduled operation. If the preschedulecmdcommand does not complete with return code 0, the scheduled operation andany postschedulecmd and postnschedulecmd commands will not run. The clientreports that the scheduled event failed, and the return code is 12. If you do notwant the preschedulecmd command to be governed by this rule, you can createa script or batch file that invokes the command and exits with return code 0.Then configure preschedulecmd to invoke the script or batch file. The returncode for the prenschedulecmd command is not tracked, and does not influencethe return code of the scheduled event.2. The server can also define the preschedulecmd option (and the prenschedulecmdoption).Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Schedule Command dialog box in the Preferences editor.Syntax►►PRESChedulecmdPRENSChedulecmdcmdstring►◄ParameterscmdstringSpecifies the command to process. Use only one preschedulecmd option. Youcan enter a command to be executed before a schedule using this option.440 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Specify the command string just as you would enter it from the operatingsystem command prompt; if the string you specify would require quotationmarks to run it at a Windows prompt, include the quotation marks as needed.If the command string contains any blank spaces, enclose the command stringin single quotation marks.In this example, single quotation marks are needed because the commandstring contains space characters:’net stop someservice’In this next example, double quotation marks are needed because both the filebeing renamed, and the new file name, contain space characters. Because thecommand string does contain space characters, the entire string must beenclosed in single quotation marks.presc ’rename "c:\myapp\log file.log" "log file.old"’Use a blank or null string for cmdstring if you want to prevent any commandsfrom running that the Tivoli Storage Manager server administrator uses forpostschedulecmd and preschedulecmd. If you specify a blank or null string oneither option, it prevents the administrator from using a command on bothoptions.If your administrator uses a blank or null string on the preschedulecmd option,you cannot run a pre-schedule command.ExamplesOptions file:presc stopdb.cmdpresc ’rename c:\myapp\logfile.log logfile.old’presc ’net stop "simple service"’presc ’rename "c:\myapp\log file.log" "log file.old"’presc ’"C:\Program Files\MyTools\runreport.bat"log1.in log2.in’Command line:-preschedulecmd=’"quiesce database"’This option is valid only on the initial command line. It is not valid in interactivemode.PreservelastaccessdateUse the preservelastaccessdate option during a backup or archive operation tospecify whether to reset the last access date of any specified files to their originalvalue following the backup or archive operation.By default, the Tivoli Storage Manager client will not reset the last access date ofany backed up or archived files to their original value following the backup orarchive operation. This option requires extra processing time during backup andarchive for each file that is sent to the Tivoli Storage Manager server, so it shouldonly be enabled when necessary.Any application that touches a file can implicitly cause the last access date of thefile to change to the time that the application touches it. This is a function of thefile system, not the application. Because of this, when the client backs up orarchives a file, it can trigger an update to the last access date of the file. This canChapter 11. Processing options 441

cause problems for other applications such as Storage Resource Management(SRM), whose processing relies on accurate last access dates.If you have enabled open file support, the last access date for files is alwayspreserved regardless of the setting for preservelastaccessdate. When using openfile support, leave this option disabled.Use this option with the incremental, selective, orarchive commands.Note:1. This option only applies to files; it does not apply to directories.2. Resetting the last access date incurs additional overhead that impact backupand archive performance. The last access date should be reset only if you areusing other another application, such as a Storage Resource Management (SRM)that relies on accurate last access dates.3. The last access date cannot be preserved on files which are write protectedeither by the read-only attribute or by a restrictive NTFS security permission.4. You cannot reset the last access date of read-only files. Thepreservelastaccessdate option ignores read-only files and does not changetheir date.Supported ClientsThis option is valid for all Windows clients.The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab of the Preferences editor.Syntax►►PRESERVELAstaccessdateNoYes►◄ParametersNoYesSpecifies that the Tivoli Storage Manager client will not reset the last accessdate of any backed up or archived files to their original value following thebackup or archive operation. This is the default.Specifies that the Tivoli Storage Manager client will reset the last access date ofany backed up or archived files to their original value following the backup orarchive operation.ExamplesOptions file:preservelastaccessdate yesCommand line:dsmc incr c: e: f: -preservelastaccessdate=yes442 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

PreservepathThe preservepath option specifies how much of the source path to reproduce aspart of the target directory path when you restore or retrieve files to a newlocation.Use the -subdir=yes option to include the entire subtree of the source directory(directories and files below the lowest-level source directory) as source to berestored. If a required target directory does not exist, it is created. If a target filehas the same name as a source file, it is overwritten. Use the -replace=promptoption to have Tivoli Storage Manager prompt you before files are overwritten.Use the preservepath option with the following commands:v restorev restore backupsetv restore groupv retrieveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Syntax►►PRESERvepath =SubtreeCompleteNOBaseNONe►◄ParametersSubtreeCreates the lowest-level source directory as a subdirectory of the targetdirectory. Files from the source directory are stored in the new subdirectory.This is the default.CompleteRestores the entire path, starting from the root, into the specified directory. Theentire path includes all the directories except the file space name.NOBaseRestores the contents of the source directory without the lowest level, or basedirectory, into the specified destination directory.NONeRestores all selected source files to the target directory. No part of the sourcepath at or above the source directory is reproduced at the target.If you specify SUBDIR=yes, Tivoli Storage Manager restores all files in the sourcedirectories to the single target directory.ExamplesCommand line:Assume the server file space contains the following backup copies:Chapter 11. Processing options 443

c:\h1\m1\file.ac:\h1\m1\file.bc:\h1\m1\l1\file.xc:\h1\m1\l1\file.yThis command:dsmc res backupset my.backupset.file /fs/h1/m1/ /u/ann/ -su=yescreates a local backupset file named "my.backupset.file".Restores these directories and files:c:\ann\h1\m1\file.ac:\ann\h1\m1\file.bThis command:dsmc res c:\h1\m1\ c:\ann\ -preser=nobase.Restores these directories and files:c:\ann\file.ac:\ann\file.bThis command:dsmc res c:\h1\m1\ c:\ann\ -preser=subtree.Restores these directories and files:c:\ann\m1\file.ac:\ann\m1\file.bThis command:dsmc res c:\h1\m1\ c:\ann\ -preser=none.Restores these directories and files:c:\ann\file.ac:\ann\file.bThis command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=completeRestores these directories and files:c:\ann\h1\m1\file.ac:\ann\h1\m1\file.bc:\ann\h1\m1\l1\file.xc:\ann\h1\m1\l1\file.yThis 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.yThis 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.yThis command:dsmc res c:\h1\m1\ c:\ann\ -su=yes -preser=none.444 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Restores these directories and files:c:\ann\file.ac:\ann\file.bc:\ann\file.xc:\ann\file.yThis command:dsmc res backupset c:\h1\m1\ c:\ann\ -su=yes-preser=nobase -loc=fileRestores these directories and files:c:\ann\file.ac:\ann\file.bc:\ann\file.xc:\ann\file.yPresnapshotcmdThe presnapshotcmd option allows you to run operating system commands beforethe Tivoli Storage Manager client starts a snapshot.This allows you to quiesce an application before the Tivoli Storage Manager clientstarts the snapshot during a snapshot-based backup or archive.This option can be used in conjunction with the postsnapshotcmd option to allowyou to quiesce an application while a snapshot is created, and then to restart thatapplication after the snapshot is started. This option is only valid if OFS or onlineimage backup has been configured.For an online image backup, use this option with the backup image command, theinclude.image option, or in the dsm.opt file.For open file support operations, use the presnapshotcmd option in an include.fsstatement or in your client options file (dsm.opt).If the presnapshotcmd fails it is assumed that the application is not in a consistentstate and the client stops the operation and display the appropriate error message.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set also this option onthe Image-Snapshot tab of the Preferences editor.Syntax►► PRESNAPshotcmd "cmdstring" ►◄Parameters"cmdstring"Specifies the quiesce command to process.Chapter 11. Processing options 445

Use a blank, or null, string for "cmdstring" if you want to prevent anycommands from running that the administrator uses for presnapshotcmd. Ifyouspecify a blank or null string, it prevents the administrator from using acommand on this option. If your administrator uses a blank or null string onthe presnapshotcmd option, you cannot run a pre-snapshot command.Use the srvprepostsnapdisabled option to prevent the Tivoli Storage Managerserver administrator from running operating system commands on the clientsystem.If the command string contains blanks, enclose the command string inquotation marks:"quiesce database myDb"If you placed quotation marks within the command string, then enclose theentire command string in single quotation marks:’resume database "myDb"’ExamplesOptions file:presnapshotcmd "application"The command string is a valid command for quiescing your application.Command line:backup image -presnapshotcmd=" application"This option is valid only on the initial command line. It is not valid in interactivemode.Related information“Include options” on page 395“Srvprepostscheddisabled” on page 483QueryschedperiodThe queryschedperiod option specifies the number of hours you want the clientscheduler to wait between attempts to contact the server for scheduled work.This option applies only when you set the schedmode option to polling. Thisoption is used only when the scheduler is running.This option applies only when you set the schedmode option to polling. Thisoption is used only when the scheduler is running.Your administrator can also set this option. If your administrator specifies a valuefor this option, that value overrides the value set in your client options file afteryour client node successfully contacts the server.446 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Query Schedule Interval field of the Preferences editor.Syntax►► QUERYSCHedperiod hours ►◄ParametershoursSpecifies the number of hours the client scheduler waits between attempts tocontact the server for scheduled work. The range of values is 1 through 9999;the default is 12.ExamplesOptions file:querysch 6Command line:-queryschedperiod=8This option is valid only on the initial command line. It is not valid in interactivemode.QuerysummaryThe querysummary option provides statistics about files, directories and objects thatare returned by the query backup or query archive commands.The following statistics are provided by the querysummary option:v The aggregate number of files and directories that are returned by the querybackup or query archive commandv The aggregate amount of data of the objects that are returned by the querybackup or query archive commandv The classic restore memory-utilization estimate to restore objects that arereturned by the query backup or query archive commandv The total number of unique server volumes where the objects that are returnedby the query command resideSingle objects that span multiple volumes only include one volume in the totalnumber of volumes statistics. For example, if c:\bigfile spans two volumes, onlyone of the volumes is counted in the estimated number of volumes.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Chapter 11. Processing options 447

Syntax►► QUERYSUMMARY ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc query backup k:\.* -subdir=yes -QUERYSUMMARYIBM Tivoli Storage ManagerCommand Line Backup/Archive Client InterfaceClient Version 6, Release 1, Level 0.0 0324FAClient date/time: 04/03/2008 05:46:42(c) Copyright by IBM Corporation and other(s) 1990, 2008. All Rights Reserved.Node Name: BARKENSTEINSession established with server BARKENSTEIN_SERVER1: WindowsServer Version 5, Release 4, Level 1.0Server date/time: 04/03/2008 05:46:43 Last access: 04/03/2008 05:46:09Size Backup Date Mgmt Class A/I File---- ----------- ---------- --- ----0 B 04/02/2008 20:21:51 STANDARD A \\barkenstein\k$\0 B 04/02/2008 20:21:51 STANDARD A \\barkenstein\k$\jack_test0 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\System Volume Information0 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Test10 B 04/02/2008 20:21:51 STANDARD A \\barkenstein\k$\TestTree0 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Tree1500 B 04/02/2008 19:49:20 STANDARD A \\barkenstein\k$\Tree150.10 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Tree150.20 B 04/02/2008 19:50:51 STANDARD A \\barkenstein\k$\Tree150.30 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Tree15000 B 04/02/2008 10:41:40 STANDARD A \\barkenstein\k$\Tree150_20 B 04/02/2008 20:02:31 STANDARD A \\barkenstein\k$\tree180 B 04/02/2008 20:15:04 STANDARD A \\barkenstein\k$\Tree18.test0 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Tree300 B 04/01/2008 12:37:07 STANDARD A \\barkenstein\k$\Tree30.20 B 04/02/2008 19:52:30 STANDARD A \\barkenstein\k$\tree30.test11,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file111,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1011,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1111,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1211,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1311,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1411,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1511,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1611,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1711,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1811,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file1911,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file211,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file2011,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file2111,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file311,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file411,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file511,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file611,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file711,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file811,788 B 04/02/2008 19:55:32 DEFAULT A \\barkenstein\k$\file911,788 B 04/02/2008 13:31:06 DEFAULT A \\barkenstein\k$\file910448 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

10,964 B 04/01/2008 12:37:07 DEFAULT A \\barkenstein\k$\filea10,964 B 04/01/2008 12:37:07 DEFAULT A \\barkenstein\k$\fileb10,964 B 04/01/2008 12:37:07 DEFAULT A \\barkenstein\k$\xSummary StatisticsTotal Files Total Dirs Avg. File Size Total Data Memory Est.----------- ---------- -------------- ---------- -----------25 16 11.41 KB 285.37 KB 10.58 KBEstimated Number of Volumes: 2QuietThe quiet option limits the number of messages that are displayed on your screenduring processing..For example, when you run the incremental, selective, orarchive commands,information might appear about each file that is backed up. Use the quiet option ifyou do not want to display this informationWhen you use the quiet option, error and processing information appears on yourscreen, and messages are written to log files. If you do not specify quiet, thedefault option, verbose is used.Supported ClientsThis option is valid for all clients. The server can also define the quiet option,overriding the client setting. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommand Line tab, Do not display process information on screen checkbox ofthe Preferences editor.Syntax►► QUIET ►◄ParametersThere are no parameters for this option.ExamplesOptions file:quietCommand line:-quietThis option is valid only on the initial command line. It is not valid in interactivemode.Chapter 11. Processing options 449

ReplaceThe replace option specifies whether to overwrite existing files on yourworkstation, or to prompt you for your selection when you restore or retrieve files.Important: The replace option does not affect recovery of directory objects.Directory objects are always recovered, even when specifying replace=no. Toprevent overwriting existing directories, use the filesonly option.You can use this option with the following commands:v restorev restore backupsetv restore groupv retrieveNote: Replace prompting does not occur during a scheduled operation. If you setthe replace option to prompt, Tivoli Storage Manager skips files withoutprompting during a scheduled operation.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theRestore tab, Action for files that already exist section of the Preferences editor.Syntax►►REPlacePromptAllYesNo►◄ParametersPromptFor nonscheduled operations, you specify whether to overwrite existing files.For scheduled operations, existing files are not overwritten and no prompts aredisplayed. This is the default.AllYesNoAll existing files are overwritten, including read-only files. All locked files arereplaced when the system is rebooted. If access to a file is denied, you areprompted to skip or overwrite the file. No action is taken on the file until thereis a response to the prompt.Existing files are overwritten, except read-only files. For nonscheduledoperations, you specify whether to overwrite existing read-only files. Forscheduled operations, existing read-only files are not overwritten and noprompts are displayed. If access to a file is denied, the file is skipped.Existing files are not overwritten. No prompts are displayed.450 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Note: You can choose to replace locked files when the system is rebooted. TivoliStorage Manager cannot perform an in-place restore of active files. However, itstages restored versions of active files for replacement during the next reboot,except for files containing named streams, sparse files, and directories. You canonly restore these files if they are unlocked.ExamplesOptions file:replace allCommand line:-replace=noThis option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.ResetarchiveattributeUse the resetarchiveattribute option to specify whether Tivoli Storage Managerresets the Windows archive attribute on files that are successfully backed up to aTivoli Storage Manager server.Tivoli Storage Manager also resets the archive attribute during incremental backupsif it is determined that there is already an active object on the Tivoli StorageManager server. The resetarchiveattribute option is useful in conjunction withapplications, such as the IBM Tivoli Storage Resource Manager, as a simple way toreport on the backup status of files.The Windows archive attribute is used to indicate that a file has changed since thelast backup. After Tivoli Storage Manager resets the archive attribute, the Windowsoperating system turns the attribute back to ON after the file has been modified.Tivoli Storage Manager does not use the Windows archive attribute to determine ifa file is a candidate for incremental backup, but only manipulates this attribute forreporting purposes. Tivoli Storage Manager uses a much more sophisticatedmethod to determine candidacy for incremental backup.There are several applications which manipulate or examine the Windows archiveattribute. Be aware of the ramifications of using the resetarchiveattribute optionin conjunction with these products.If you set the resetarchiveattribute option to yes, after a file has beensuccessfully backed up to the Tivoli Storage Manager server, the Tivoli StorageManager client resets the Windows archive attribute on the local file system:vvvThe Windows archive attribute is reset during incremental and selective backupsafter the file has been successfully committed to the Tivoli Storage Managerdatabase. This attribute is not reset for archive, or image operations.The Windows archive attribute is not reset when processing system objects orsystem state objects.The Windows archive attribute is not reset for directory entries.In addition, in order for the local file system to reflect the current active objectinventory on the Tivoli Storage Manager server, the resetarchiveattribute optioninstructs the Tivoli Storage Manager client to reset the Windows archive attributeChapter 11. Processing options 451

on the local file system if it is determined during incremental backup that a valid,active backup copy of the file already exists on the Tivoli Storage Manager server.This behavior is not displayed in the following cases:vvIncremental backup operations which do not examine the stored client attributeson the Tivoli Storage Manager server, such as journal-based backup orincremental-by-date processing.Files that are not examined during an incremental backup operation becausethey are excluded from backup processing.The Tivoli Storage Manager client does not guarantee the accuracy of the currentsetting of the Windows archive attribute. For example, if theresetarchiveattribute option is set to yes and a file examined by a reportingproduct indicates that the Windows archive attribute is OFF for a particular file,this does not necessarily mean that a valid, active backup copy of the file exists onthe Tivoli Storage Manager server. Factors that could contribute to this type ofsituation include:v An independent software vendor product is manipulating the Windows archiveattributev A file space was deleted from the Tivoli Storage Manager serverv A backup tape was lost or destroyedThere should be no significant performance degradation when using theresetarchiveattribute option. The resetarchiveattribute option does not affectrestore processing.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FileThis option is valid in the client options file (dsm.opt) or server client options set.You can set this option on the Backup tab of the Preferences editor.Syntax►►RESETARCHIVEATTRibute =NoYes►◄ParametersYesNoSpecifies that you want to reset the Windows archive attribute for files duringa backup operation.Specifies that you do not want to reset the Windows archive attribute for filesduring a backup operation. This is the default.ExamplesOptions file:resetarchiveattribute yesRelated information452 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

“Full and partial incremental backup” on page 120ResourceutilizationUse the resourceutilization option in your option file to regulate the level ofresources the Tivoli Storage Manager server and client can use during processing.Supported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab, in the Resource Utilization field of the Preferences editor.Syntax►► RESOURceutilization number ►◄ParametersnumberSpecifies the level of resources the Tivoli Storage Manager server and client canuse during processing. The range of values that you can specify is 1 through10.ExamplesOptions file:resourceutilization 7Command line:-resourceutilization=7This option is valid only on the initial command line. It is not valid in interactivemode.Regulating backup and archive sessionsWhen you request a backup or archive, the client can use more than one session tothe server.The default is to use a maximum of two sessions; one to query the server and oneto send file data. The client can use only one server session if you specify aresourceutilization setting of 1.A client can use more than the default number of sessions when connecting to aserver that is Version 3.7 or higher. For example, resourceutilization=10 permitsup to eight sessions with the server. Multiple sessions can be used for querying theserver and sending file data.Multiple query sessions are used when you specify multiple file specifications witha backup or archive command. For example, if you enter the following commandsand you specify resourceutilization=5, the client might start a second session toquery files on file space B.inc /Volumes/filespaceA /Volumes/filespaceBChapter 11. Processing options 453

Whether or not the second session starts depends on how long it takes to querythe server about files backed up on file space A. The client might also try to readdata from the file system and send it to the server on multiple sessions.Note: During a backup operation, if you enter multiple file specifications, theresult might be that files from one file specification are stored on multiple tapesand interspersed with files from different file specifications. This can decreaserestore performance. Setting the collocatebyfilespec option to yes eliminatesinterspersing of files from different file specifications, by limiting the client to oneserver session per file specification. Therefore, if you store the data to tape, files foreach file specification are stored together on one tape (unless another tape isrequired for more capacity).Related reference:“Collocatebyfilespec” on page 316Regulating restore sessionsWhen you request a restore, the default is to use a maximum of one session.Additional restore sessions are based on:v resourceutilization valuev how many tapes on which the requested data is storedv how many tape drives are availablev the maximum number of mount points allowed for the nodeNote:1. If all of the files are on disk, only one session is used. There is no multi-sessionfor a pure disk storage pool restore. However, if you are performing a restorein which the files reside on 4 tapes and some on disk, you could use up to 5sessions during the restore.2. The Tivoli Storage Manager server can set the maximum number of mountpoints a node can use on the server using the MAXNUMMP parameter. If theresourceutilization option value exceeds the value of the MAXNUMMP onthe server for a node, the backup can fail with an Unknown System Errormessage.3. You can get a multi-session restore from your single restore command, andfrom a single volume on the server, if that volume is device class FILE.For example, if the data you want to restore is on 5 different tape volumes, themaximum number of mount points is 5 for your node, and resourceutilization isset to 3, then 3 sessions are used for the restore. If you increase theresourceutilization setting to 5, then 5 sessions are used for the restore. There isa 1 to 1 relationship to the number of restore sessions allowed for theresourceutilization setting. Multiple restore sessions are only allowed for noquery restore operations.Multiple client session considerationsThis topic lists some items to consider when working with multiple client sessions.The following factors can affect the throughput of multiple sessions:v The ability of the server to handle multiple client sessions. Is there sufficientmemory, multiple storage volumes, and processor cycles to increase backupthroughput?454 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvThe ability of the client to drive multiple sessions (sufficient processor cycles,memory, etc.).The configuration of the client storage subsystem. File systems that are stripedacross multiple disks, using either software striping or RAID-5 can better handlean increase in random read requests than a single drive file system. Additionally,a single drive file system might not see performance improvement if it attemptsto handle many random concurrent read requests.Sufficient bandwidth in the network to support the increased traffic.Potentially undesirable aspects of running multiple sessions include:v The client could produce multiple accounting records.v The server might not start enough concurrent sessions. To avoid this, the servermaxsessions parameter must be reviewed and possibly changed.v A query node command might not summarize client activity.RetryperiodThe retryperiod option specifies the number of minutes the client scheduler waitsbetween attempts to process a scheduled command that fails, or betweenunsuccessful attempts to report results to the server. Use this option only when thescheduler is running.Your administrator can also set this option. If your administrator specifies a valuefor this option, that value overrides the value in your client options file after yourclient node successfully contacts the server.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Retry period field of the Preferences editor.Syntax►► RETRYPeriod minutes ►◄ParametersminutesSpecifies the number of minutes the client scheduler waits between attempts tocontact the server, or to process a scheduled command that fails. The range ofvalues is 1 through 9999; the default is 20.ExamplesOptions file:retryp 10Command line:-retryperiod=10Chapter 11. Processing options 455

This option is valid only on the initial command line. It is not valid in interactivemode.RevokeremoteaccessThe revokeremoteaccess option restricts an administrator with client accessprivilege from accessing a client workstation that is running the Web client.This option does not restrict administrators with client owner, system, or policyprivilege from accessing your workstation through the Web client.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theWeb Client tab of the Preferences editor.Syntax►►REVOKEremoteaccessNoneAccess►◄ParametersNoneDoes not revoke access to administrators who have client access authority forthe client. This is the default.AccessRevokes access to administrators who have client access authority for theclient.ExamplesOptions file:revokeremoteaccess noneCommand line:Does not apply.RunasserviceThe runasservice option forces the client command process to continue running,even if the account that started the client logs off.Use this option with the AT command and the dsmc sched command when youschedule client command batch jobs. The runasservice option is not valid in anyoptions file (dsm.opt or tsmasr.opt).Important: Use the scheduler service when running Tivoli Storage Managerservices unattended. Set runasservice=yes only to schedule Tivoli Storage Managercommands using the Windows AT command. Setting runasservice=yes mightinterfere with other interactive uses of the Tivoli Storage Manager client.456 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►►RUNASSERViceNoYes►◄ParametersNoYesDoes not force the client command process to continue running, even if theaccount that started the client logs off. This is the default.Forces the client command process to continue running, even if the accountthat started the client logs off.Restrictions:1. When runasservice=yes, the setting for the REPLACE is always overriddento the behavior of replace=no.2. The option runasservice=yes cannot be used with passwordaccess=prompt.3. Backup, archive, restore and retrieve options performed withrunasservice=yes that encounter prompts always fails. To avoid thisproblem, either save the encryption key password with encryptkey=save, orturn off the runasservice option.ExamplesCommand line:-runasservice=yesThis option is valid only on the initial command line. It is not valid in interactivemode.SchedcmddisabledThe schedcmddisabled option specifies whether to disable the scheduling ofcommands by the server action=command option on the define schedule servercommand.This option does not disable the preschedulecmd and postschedulecmd commands.However, you can specify preschedulecmd or postschedulecmd with a blank or anull string to disable the scheduling of these commands.You can disable the scheduling of commands defined by your Tivoli StorageManager administrator by setting the schedcmddisabled option to yes.Use the query schedule command to query the schedules defined by youradministrator.Supported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Chapter 11. Processing options 457

Options FilePlace this option in the client options file (dsm.opt).Syntax►►SCHEDCMDDisabledNoYes►◄ParametersYesNoSpecifies that Tivoli Storage Manager disables the scheduling of commands bythe server using the action=command option on the DEFINE SCHEDULE servercommand.Specifies that Tivoli Storage Manager does not disable the scheduling ofcommands by the server using the action=command option on the DEFINESCHEDULE server command. This is the default.ExamplesOptions file:schedcmddisabled noCommand line:Does not apply.Related information“Query Schedule” on page 613SchedcmdexceptionThe schedcmexception option is used in conjunction with the schedcmddisabledoption to disable the scheduling of commands by the server action=commandoption on the DEFINE SCHEDULE server command, except for specific commandstrings.You must specify the exact string that matches the “objects” definition in theschedule for the scheduled server command to be accepted. If the string does notmatch exactly (for example, there is an extra space or the capitalization isdifferent), the scheduled command action is blocked.You can provide multiple schedcmexception options in the options file. This optionis not honored if schedcmddisabled is not enabled. The placement of this option inthe options file is independent of the placement of the schedcmddisabled option.Supported ClientsThis option is valid for all clients. This option is not valid in the Tivoli StorageManager Server client options set.Options FilePlace this option in the client options file (dsm.opt).458 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► SCHEDCMDException string ►◄ParametersstringFor commands scheduled by the action=command option on the DEFINESCHEDULE server command, this parameter indicates the objects pattern toenable if the schedcmddisabled=yes option is specified. This parameter is casesensitive, and must match the command string on the Tivoli Storage ManagerServer schedule definition exactly.ExamplesOptions file:schedcmddisabled yesschedcmdexception "start dir c: /s"schedcmdexception "start echo hello, world!"Examples:Disable the scheduling of commands by the server action=command optionon the DEFINE SCHEDULE server command, except for two schedulesdefined on the Tivoli Storage Manager Server:Related information“Schedcmddisabled” on page 457SchedlogmaxThe schedlogmax option specifies the maximum size of the schedule log(dsmsched.log) and web client log (dsmwebcl.log), in megabytes.This option causes the log files that get created for scheduler events (dsmsched.log)and web client events (dsmwebcl.log) to wrap around when they reach theirmaximum size. As scheduler and web client events are logged, log records areadded to the end of the log files until the maximum specified size is reached.When the maximum specified size is reached, a log record saying "Continued atbeginning of file" is placed as the last record in the file. Subsequent logging isresumed at the beginning of the file. The end of the wrapped log is indicated by arecord saying "END OF DATA".When you set the schedlogmax option, scheduler and web client log messages arenot saved in a prune file. If you want to prune logs and save the pruned logentries to another file, see the schedlogretention option.If you change from log wrapping (schedlogmax option) to log pruning(schedlogretention option), all existing log entries are retained and the log ispruned using the new schedlogretention criteria.If you change from log pruning (schedlogretention option) to log wrapping(schedlogmax option), all records in the existing logs are copied to a file containingthe pruned entries. For example, log records pruned from the dsmsched.log file arecopied to dsmsched.pru. Log records pruned from dsmwebcl.log are copied toChapter 11. Processing options 459

dsmweblog.pru. The existing logs (dsmsched.log and dsmwebcl.log) are emptied,and logging begins using the new log wrapping criteria.If you simply change the value of the schedlogmax option, the existing log isextended or shortened to accommodate the new size. If the value is reduced, theoldest entries are deleted to reduce the file to the new size.If neither schedlogmax nor schedlogretention is specified, the error log can growwithout any limit on its size. You must manually manage the log contents toprevent the log from depleting disk resources. When the log has been created withneither option specified, if you later issue a command and specify theschedlogretention option, the log is pruned using the retention value specified.When the log has been created with neither option specified, if you later issue acommand and specify the schedlogmax option, the existing log is treated as if itwas a pruned log. That is, the content of the dsmsched.log file is copied to a filecalled dsmsched.pru, the content of dsmwebcl.log is copied to a file calleddsmwebcl.pru, and new log entries are created in dsmsched.log and dsmwebcl.log,and both files wrap when they reach their maximum size.Note: If you specify a non-zero value for schedlogmax (which enables logwrapping), you cannot use the schedlogretention option to create pruned logs.Logs can be pruned or wrapped, but not both.Logs created with the schedlogmax option contain a log header record that containsinformation similar to this example record:LOGHEADERREC 661 104857600 IBM Tivoli Storage Manager 6.3.0.52 11080B Tue Aug 9 06:46:53 2011Note that the dates and time stamps in the LOGHEADERREC text are nottranslated or formatted using the settings specified on the dateformat ortimeformat options.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).You can also set this option on the Client preferences > Scheduler tab in the GUI,by selecting Enable scheduler log file wrapping and by specifying a non-zeromaximum size for the log file. To prevent log file wrapping, set the maximum sizeto zero. When the maximum wrapping is set to zero, clearing or setting the Enablescheduler log file wrapping option has no effect; log wrapping does not occur ifthe maximum size is set to zero.Syntax►► SCHEDLOGMAX size ►◄460 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParameterssizeSpecifies the maximum size, in megabytes, for the log file. The range of valuesis 0 to 2047; the default is 0, which disables log file wrapping and allows thelog file to grow indefinitely.ExamplesOptions file:schedlogmax 100Command line:-schedlogmax=100This option is valid only on the initial command line. It is not valid in interactivemode.SchedlognameThe schedlogname option specifies the path and file name where you want to storeschedule log information.Use this option only when you want to store schedule log information. This optionapplies only when the scheduler is running.If this option is not used, the dsmsched.log file is created in the same directory asthe dsmerror.log file.When you run the schedule command, output from scheduled commands appearson your screen. Output is also sent to the file you specify with this option. If anypart of the path you specify does not exist, Tivoli Storage Manager attempts tocreate it.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Schedule Log text box, in the Preferences editor.Note: Set the DSM_LOG environment variable to name a directory where the log is tobe placed. The directory specified must have permissions which allow write accessfrom the account under which the client is run.Syntax►► SCHEDLOGName filespec ►◄ParametersfilespecSpecifies the path and file name where you want to store schedule logChapter 11. Processing options 461

information when processing scheduled work. If any part of the path youspecify does not exist, Tivoli Storage Manager attempts to create it.If you specify a file name only, the file is stored in your current directory. Thedefault is the current working directory with a file name of dsmsched.log.ExamplesOptions file:schedlogname c:\mydir\schedlog.janCommand line:-schedlogn=c:\mydir\schedlog.janThis option is valid only on the initial command line. It is not valid in interactivemode.Related informationSee “Errorlogname” on page 362 for more information on placement of thedsmsched.log file.SchedlogretentionThe schedlogretention option specifies the number of days to keep entries in theschedule log (dsmsched.log) and the web client log (dsmwebcl.log), and whether tosave the pruned entries in another file.The schedule log (dsmsched.log) is pruned when the scheduler starts and after ascheduled event completes. Pruned entries are written to a file called dsmsched.pru.The web client log (dsmwebcl.log) is pruned during the initial start of the clientacceptor daemon. Pruned entries are written to a file called dsmwebcl.pru.If you change from log pruning (schedlogretention option) to log wrapping(schedlogmax option), all records in the existing log are copied to the pruned log(dsmsched.pru and dsmwebcl.pru), and the existing logs (dsmsched.log anddsmwebcl.log) are emptied, and logging begins using the new log wrappingcriteria.If you change from log wrapping (schedlogmax option) to log pruning(schedlogretention option), all existing log entries are retained and the log ispruned using the new schedlogretention criteria. Pruned entries are saved in theircorresponding *.pru files.If neither schedlogmax nor schedlogretention is specified, the logs can growwithout any limit on their size. You must manually manage the log contents toprevent the log from depleting disk resources. When the log has been created withneither option specified, if you later issue a command and specify theschedlogretention option, the log is pruned using the retention value specified.When the log has been created with neither option specified, if you later issue acommand and specify the schedlogmax option, the existing log is treated as if itwas a pruned log. That is, the content of the dsmsched.log file is copied to a filecalled dsmsched.pru, the content of dsmwebcl.log is copied to dsmwebcl.pru, andnew log entries are created in both dsmsched.log and dsmwebcl.log, and both fileswrap when they reach their maximum size.462 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Note: If you specify schedlogretention option to create pruned logs, you cannotspecify the schedlogmax option. Logs can be pruned or wrapped, but not both.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).You can also set this option on the Client preferences > Scheduler tab in the GUI,by selecting Prune old entries and by specifying a value for Prune entries olderthan. Selecting the Save pruned entries option saves the pruned scheduler logentries in the dsmsched.pru log file. Selecting Save pruned entries also saves webclient log entries in the dsmwebcl.pru log file.Syntax►►SCHEDLOGRetentionNdaysDS►◄ParametersN or daysSpecifies how long to wait before pruning the log.N Do not prune the log. This permits the log to grow indefinitely. This is thedefault.daysSpecifies the number of days to keep log file entries before pruning. Therange of values is zero through 9999.D or SSpecifies whether to save the pruned entries. Use a space or comma to separatethis parameter from the previous one.D Discards the log entries when pruning the log. This is the default.S Saves the log entries when pruning the log.Pruned entries are copied to the file of pruned entries (dsmsched.pru ordsmsched.pru), which is stored in the same directory as the log.ExamplesOptions file:schedlogretention 30 SCommand line:-schedlogretention=30,SThis option is valid only on the initial command line. It is not valid in interactivemode.Chapter 11. Processing options 463

SchedmodeThe schedmode option specifies whether you want to use the polling mode (yourclient node periodically queries the server for scheduled work), or the promptedmode (the server contacts your client node when it is time to start a scheduledoperation).All communication methods can use the client polling mode, but only TCP/IP canuse the server prompted mode.This option applies only if you are using the TCP/IP communication method, andthe schedule command is running.Your administrator can specify that the server support both modes or just onemode. If your administrator specifies that both modes are supported, you canselect either schedule mode. If your administrator specifies only one mode, youmust specify that mode in your dsm.opt file or scheduled work is not processed.If you specify prompted mode, you should consider supplying values for thetcpclientaddress and tcpclientport options in your dsm.opt file or on theschedule command; the client can then be contacted at either an address or a portof your choice (useful for client systems with multiple network interface cards).Note:1. When changing the setting of this option in the client options file (dsm.opt) youmust stop and restart the scheduler service for the setting to take effect.2. The server can also define this option.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Schedule Mode section in the Preferences editor.Syntax►►SCHEDMODePOllingPRompted►◄ParametersPOllingThe client scheduler queries the server for scheduled work at prescribed timeintervals. This is the default. You can set the time intervals using thequeryschedperiod option.PRomptedThe client scheduler waits for the server to contact your client node whenscheduled work needs to be done.Note:464 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

1. Use schedmode prompted in conjunction with the autodeploy option, toenable the scheduler to process the client deployment scheduleimmediately.2. If you use the dsmc schedule command and both schedmode prompted andcommmethod V6Tcpip are specified, the client and Tivoli Storage Managerserver must be configured for IPv6. Additionally, the client host name mustbe set up for the IPv6 address.ExamplesOptions file:schedmode promptedCommand line:-schedmod=poThis option is valid only on the initial command line. It is not valid in interactivemode.Related reference:“Autodeploy” on page 302“Tcpclientaddress” on page 498“Tcpclientport” on page 499SchedrestretrdisabledThe schedrestretrdisabled option specifies whether to disable the execution ofrestore or retrieve schedule operations.Supported ClientsThis option is valid for all clients. The server cannot define this option. The TivoliStorage Manager API does not support this option.Options FilePlace this option in the client options file (dsm.opt) for the scheduler. You can setthis option on the Scheduler tab in the Schedule Command section in thePreferences editor.Syntax►►SCHEDRESTRETRDisabledNoYes►◄ParametersNoYesSpecifies that Tivoli Storage Manager does not disable the execution of restoreand retrieve schedule operations. This is the default.Specifies that Tivoli Storage Manager disable the execution of restore andretrieve schedule operations.Chapter 11. Processing options 465

ExamplesOptions file:schedrestretrdisabled yesCommand line:Does not apply.ScrolllinesThe scrolllines option specifies the number of lines of information that aredisplayed on your screen at one time.Use this option when you set the scrollprompt option to Yes.You can use the scrolllines option with the following commands only:v delete filespacev query archivev query backupv query backupsetv query filespacev query groupv query imagev query nasv query nodev query optionsSupported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommand Line tab, Number of lines to display on screen field of the Preferenceseditor.Syntax►► SCROLLLines number ►◄ParametersnumberSpecifies the number of lines of information that are displayed on your screenat one time. The range of values is 1 through 80; the default is 20.ExamplesOptions file:scrolllines 25Command line:-scrolll=25This option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it is466 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

specified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.ScrollpromptThe scrollprompt option specifies whether you want Tivoli Storage Manager tostop and wait after displaying the number of lines of information you specifiedwith the scrolllines option, or scroll through and stop at the end of theinformation list.You can use the scrollprompt option with the following commands only:v delete filespacev query archivev query backupv query backupsetv query filespacev query groupv query imagev query nasv query nodev query optionsSupported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the client user-options file (dsm.opt). You can set this option onthe Command Line tab, Pause after displaying the following number of linesfield of the Preferences editor.Syntax►►SCROLLPromptNoYes►◄ParametersNo Scrolls to the end of the list and stops. This is the default.YesStops and waits after displaying the number of lines you specified with thescrolllines option. The following prompt is displayed at the bottom of thescreen:Press 'Q’ to quit, 'C’ to continuous scroll, or 'Enter’ tocontinue.ExamplesOptions file:scrollprompt yesCommand line:-scrollp=yesChapter 11. Processing options 467

This option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.SessioninitiationUse the sessioninitiation option to control whether the server or client initiatessessions through a firewall. The default is that the client initiates sessions. You canuse this option with the schedule command.For the client scheduler, you do not need to open any ports on the firewall. If youset the sessioninitiation option to serveronly, the client will not attempt tocontact the server. All sessions must be initiated by server prompted scheduling onthe port defined on the client with the tcpclientport option. Thesessioninitiation option only affects the behavior of the client scheduler runningin the prompted mode. If you set the sessioninitiation option to serveronly,with the exception of client acceptor daemon-managed schedulers, thecommand-line client, the Backup-Archive Client GUI, and web client GUI stillattempt to initiate sessions.Attention: You cannot use the dsmcad for scheduling when you set thesessioninitiation option to serveronlyNote: If you set the sessioninitiation option to serveronly, the client setupwizard and scheduler service are unable to authenticate to the Tivoli StorageManager server. In this case, you can execute scheduler from the command line(dsmc schedule) and enter the password for your node when prompted or use thefollowing dsmcutil command to write the password into the Windows Registry:dsmcutil updatepw /node:nnn /password:ppp /validate:noTo avoid this problem, when configuring the client scheduler using the setupwizard, ensure that the Contact the TSM Server to validate password checkbox onthe TSM Authentication page is unchecked.A similar problem can occur if an encryption key is required for backupoperations. In this case, you can execute the scheduler from the command line(dsmc schedule) and enter the encryption key when prompted. After the passwordand encryption key are updated, you must restart the scheduler.If you set the sessioninitiation option to client, the client initiates sessions withthe server by communicating on the TCP/IP port defined with the server optiontcpport. This is the default. Server prompted scheduling can be used to promptthe client to connect to the server.Note:1. The Tivoli Storage Manager server can specifySESSIONINITiation=clientorserver or SESSIONINITiation=serveronly on theregister node and update node commands. If the server specifiesSESSIONINITiation=clientorserver, the client can decide which method to use.If the server specifies SESSIONINITiation=serveronly, all sessions are initiatedby the server.2. If sessioninitiation is set to serveronly, the value for the tcpclientaddressclient option must be the same as the value for the HLAddress option of theupdate node or register node server command. The value for the468 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

tcpclientport client option must be the same as the value for the LLAddressoption of the update node or register node server command.3. The Tivoli Storage Manager client API does not support this option.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, Session Initiation field of the Preferences editor.Syntax►►SESSIONINITiationClientSERVEROnly►◄ParametersClientSpecifies that the client initiates sessions with the server by communicating onthe TCP/IP port defined with the server option TCPPORT. This is the default.Server prompted scheduling can be used to prompt the client to connect to theserver.SERVEROnlySpecifies that the server will not accept client requests for sessions. All sessionsmust be initiated by server prompted scheduling on the port defined on theclient with the tcpclientport option. Except for client acceptordaemon-managed schedulers, the command-line client, the Backup-ArchiveClient GUI, and web client GUI still attempt to initiate sessions.||If the server AUTHENTICATION option is set to LDAP, do not set the clientsessioninitiation option to serveronly; if you do, schedules cannot run.ExamplesOptions file:sessioninitiation serveronlyCommand line:schedule -sessioninitiation=serveronlyThis option is valid only on the initial command line. It is not valid in interactivemode.Related information“Configuring the client scheduler” on page 33“Tcpclientport” on page 499Chapter 11. Processing options 469

ShmportThe shmport option specifies the TCP/IP port address of a server when usingshared memory. All shared memory communications start with a TCP/IPconnection.Note: The value specified for the shmport option in the client options file (dsm.opt)must match the value specified for shmport in the server options file.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► SHMPort port_number ►◄Parametersport_numberSpecifies the port number. You can specify a value from 1 to 32767. The defaultvalue is 1510.ExamplesOptions file:shmport 1580Command line:Does not apply.ShowmembersUse the showmembers option to display all members of a group.You can use the showmembers option with the query group, query systemstate, andrestore group, commands.The showmembers option is not valid with the inactive option. If you want todisplay members of a group that are not currently active, use the pitdate andpittime options.Supported ClientsThis option is valid for all Windows clients.Syntax►► SHOWMembers ►◄470 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersThere are no parameters for this option.ExamplesCommand line:restore group {virtfs}\* -pick -showmembersSkipmissingsyswfilesUse the Skipmissingsyswfiles option to specify whether the Tivoli StorageManager client skips certain missing VSS writer files and continues the systemstate backup.Setting the skipmissingsyswfile option to yes causes certain VSS writer files thatare not found during a system state backup to be skipped. This option is effectiveonly for missing files from the following VSS writers:v System Writerv Windows Deployment Service Writerv Event Log writerConsider the following items before you use the skipmissingsyswfile option:v Setting the skipmissingsyswfile option to yes enables backups that might havefailed with previous versions of Tivoli Storage Manager to complete.v There is a small risk of an inconsistent backup because a file is skipped.v This risk is minimized by these factors:– The backup can be done only when the system is running.– Critical system files are protected from deletion by Microsoft Windows.Supported ClientsThis option is valid for Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►►SKIPMISSingsyswfilesYesNo►◄ParametersYesNoSpecifies that you want the Tivoli Storage Manager client to skip certain filesthat are not found during system state backup. The files that are not found arelogged to both the error log and the server activity log. The final return code isset to 8. This is the default.Specifies that you want the Tivoli Storage Manager client to stop the backupChapter 11. Processing options 471

when files are not found during system state backup. The files that are notfound are logged to the error log and to the server activity log. The final returncode is 12.ExamplesOptions file:SKIPMISSingsyswfiles yesCommand line:-SKIPMISSingsyswfiles=yesRelated reference:“Backup Systemstate” on page 560SkipntpermissionsThe skipntpermissions option bypasses processing of NTFS security information.Select this option for incremental backups, selective backups, archives, retrievesand restores. Use this option with the archive, incremental, restore, retrieve, andselective commands.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab of the Preferences editor.Syntax►►SKIPNTPermissionsNoYes►◄ParametersNoIf you specify No, the NTFS security information is backed up, restored,archived or retrieved. This is the default.YesIf you specify Yes, the NTFS security information is not backed up, restored,archived or retrieved.ExamplesOptions file:skipntp yesCommand line:–skipntp=yesSkipntsecuritycrcThe skipntsecuritycrc option controls the computation of the security cyclicredundancy check (CRC) for a comparison of NTFS security information during anincremental or selective backup, archive, restore, or retrieve operation.472 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If you set the skipntsecuritycrc option to no (the default), performance might beslower because the program must retrieve all the security descriptors.Use this option with the following commands:v archivev incrementalv restorev retrievev selectiveSupported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►►SKIPNTSecuritycrcNoYes►◄ParametersNoYesIf you specify No, the security CRC is generated during a backup. This is thedefault.If you specify Yes, the security CRC is not generated during a backup. All thepermissions are backed up, but the program cannot determine if thepermissions are changed during the next incremental backup. When theskipntpermissions option is set to yes, the skipntsecuritycrc option does notapply.ExamplesOptions file:skipnts noCommand line:–skipnts=noSnapdiffUsing the snapdiff option with the incremental command streamlines theincremental backup process. The command runs an incremental backup of the filesthat were reported as changed by NetApp instead of scanning all of the volumefor changed files.The snapdiff option is for backing up NAS/N-Series file server volumes that areNFS or CIFS attached.Restriction: None of the NetApp predefined shares, including C$, works with theTivoli Storage Manager snapshot difference option because Tivoli Storage Managerclient cannot determine their mount points programmatically.Chapter 11. Processing options 473

You must configure a user ID and password on the Tivoli Storage Manager clientto enable snapshot difference processing. For more information about setting upthe snapdiff option, see “Configuring NetApp and Tivoli Storage Manager forsnapshot difference incremental backups” on page 70.Use this option with an incremental backup of a NAS file server volume instead ofa simple incremental or incremental with snapshotroot whenever the NAS fileserver is running ONTAP 7.3.0, or later, for performance reasons. Do not use thesnapdiff and snapshotroot options together.The first time you perform an incremental backup with the snapshot differenceoption, a snapshot is created (the base snapshot) and a traditional incrementalbackup is run using this snapshot as the source. The name of the snapshot that iscreated is recorded in the Tivoli Storage Manager database.The second time an incremental backup is run with this option, a newer snapshotis either created, or an existing one is used to find the differences between thesetwo snapshots. The second snapshot is called the diffsnapshot. Tivoli StorageManager then incrementally backs up the files reported as changed by NetApp tothe Tivoli Storage Manager server. The filesystem that you select for snapshotdifference processing must be mounted to the root of the volume. You cannot usethe snapdiff option for any filesystem that is not mounted to the root of thevolume. After backing up data using the snapdiff option, the snapshot that wasused as the base snapshot is deleted from the snapshot directory. On Windowssystems, the snapshot directory is in ~snapshot. Tivoli Storage Manager does notdelete the snapshot if it was not created by Tivoli Storage Manager. You can alsorun a snapshot-difference incremental-backup by specifying the-diffsnapshot=latest option.|||||To perform a snapshot differential backup of read only NetApp filer volumes, theuseexistingbase option must be specified to prevent an attempt to create a newsnapshot on the read only volume. Also, specify the name of the base snapshot touse (basesnapshotname option) and the name of the differential snapshot to use(diffsnapshotname option).For NAS and N-Series file servers that are running ONTAP 7.3.0, or later, you canuse the createnewbase option to backup any files that might have been skippeddue to one of the following reasons:vvvvA file is excluded because the include-exclude file has an exclude rule in effect.A file is excluded when you have not changed the include-exclude file, but youhave removed the rule that excluded the file. The NetApp API only detects filechanges between two snapshots, not changes to the include-exclude file.If you have added an include statement to the option file, that include optiondoes not take effect unless NetApp detects that the file has changed. This isbecause Tivoli Storage Manager does not inspect each file on the volume duringbackup.You have used the dsmc delete backup command to explicitly delete a file fromthe Tivoli Storage Manager inventory. NetApp does not detect that a file hasbeen manually deleted from Tivoli Storage Manager. Therefore, the file remainsunprotected in Tivoli Storage Manager storage until it is changed on the volumeand the change is detected by NetApp, signalling Tivoli Storage Manager toback it up again.Policy changes such as changing the policy from mode=modified tomode=absolute are not detected.474 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvThe entire file space is deleted from the Tivoli Storage Manager inventory. Thiscauses the snapshot difference option to create a snapshot to use as the source,and runs a full incremental backup.A file is excluded from backup because the file name contains a character that isnot in the 7 bit-ASCII character set. The createnewbase option creates a new basesnapshot and uses it as a source to run a full incremental backup. NetAppcontrols what constitutes a changed object.Note: In the list of options used by the traditional incremental command, the lastcolumn shows the interaction of each option with the snapdiff option. Thedefinitions of valid, not valid, and no effect are:Valid Processing runs normally when the option is used.Not validIf the option is used with the snapdiff option, an error message isgenerated.No effectThe option can be used, but it is ignored.||||Table 63. Incremental command: Related optionsOption Where specified With snapdiffasnodename “Asnodename” on page 296 Client options file (dsm.opt) Validor command line.autofsrename “Autofsrename” on page 304 Client options file (dsm.opt)only.No effectbasesnapshotname “Basesnapshotname” onpage 307changingretries “Changingretries” on page310compressalways “Compressalways” on page320compression “Compression” on page 320Client options file (dsm.opt)or command line.Client options file (dsm.opt)or command line.Client options file (dsm.opt)or command line.Client options file (dsm.opt)or command line.ValidNo effectValidValidcreatenewbase “Createnewbase” on page 323 Command line only. Validdiffsnapshot “Diffsnapshot” on page 334 Command line only. Validdiffsnapshotname “Diffsnapshotname” onpage 335Client options file (dsm.opt)or command line.Validdirsonly “Dirsonly” on page 337 Command line only. Validdomain “Domain” on page 340Client options file (dsm.opt) Validor command line only.enablelanfree “Enablelanfree” on page 357 Client options file (dsm.opt) Validor command line.encryptiontype “Encryptiontype” on page Client options file (dsm.opt). Valid358encryptkey “Encryptkey” on page 359 Client options file (dsm.opt). Validexclude.fs.nas “Exclude options” on page Client options file (dsm.opt). No effect365filelist “Filelist” on page 380 Command line only. Not validfilesonly “Filesonly” on page 383 Command line only. ValidChapter 11. Processing options 475

||Table 63. Incremental command: Related options (continued)Option Where specified With snapdiffinclude.fs.nas “Include options” on page395Client options file (dsm.opt)or command line.No effectinclexcl “Inclexcl” on page 394 Client options file (dsm.opt). Valid, but onlywhen a filechange isdetected byNetApp.incrbydate “Incrbydate” on page 404 Command line only. Not validmemoryefficientbackup“Memoryefficientbackup” on page 419Client options file (dsm.opt),server, or command line.No effectmonitor “Monitor” on page 424 Command line only. Not validnojournal “Nojournal” on page 427 Command line only. Not validpostsnapshotcmd “Postsnapshotcmd” on page438preservelastaccessdate“Preservelastaccessdate” on page 441presnapshotcmd “Presnapshotcmd” on page445resetarchiveattribute“Resetarchiveattribute” on page 451skipntpermissions “Skipntpermissions” onpage 472skipntsecuritycrc “Skipntsecuritycrc” onpage 472snapshotproviderfs “Snapshotproviderfs”on page 478snapshotproviderimage“Snapshotproviderimage” on page 479Client options file (dsm.opt)or with the include.fsoption.Client options file (dsm.opt)or command line.Client options file (dsm.opt)or with the include.fsoption.Client options file (dsm.opt).Client options file (dsm.opt)or command line.Client options file (dsm.opt)or command line.Client options file (dsm.opt)or with the include.fsoption.Client options file (dsm.opt)or with the include.imageoption.ValidValidValidValidValidValidNot validNot validsnapshotroot “Snapshotroot” on page 479 Command line only. Not validsubdir “Subdir” on page 489Client options file (dsm.opt) Not validor command line.subfilebackup “Subfilebackup” on page 491 Client options file (dsm.opt) Not validor command line.tapeprompt “Tapeprompt” on page 495 Client options file (dsm.opt) Validor command line.toc “Toc” on page 505 Command line only. Not validuseexistingbase “Useexistingbase” on page Command line only.Valid510virtualfsname “Virtualfsname” on page 513 Command line only. Not valid476 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis option is valid for the following clients:v All Windows clients except IA 64 bitSyntax►► SNAPDiff ►◄ParametersThere are no parameters for this option.ExamplesCommand line:Perform a snapdiff incremental backup from a snapshot taken of anetwork share //homestore.example.com/vol/vol1 mounted on drive H:,where homestore.example.com is a file server.incremental -snapdiff H:Perform a snapdiff incremental backup from a snapshot taken of anetwork share //homestore.example.com/vol/vol1 mounted on drive H:,where homestore.example.com is a file server. The -diffsnapshot optionvalue of LATEST means that the operation uses the latest snapshot (theactive snapshot) for volume H:.incremental -snapdiff H: -diffsnapshot=latestCommand line:Perform a one-time full incremental backup after detecting that theNetApp server has migrated to a unicode-enabled file server from a serverthat did not support unicode file names.dsmc incremental -snapdiff -createnewbase=migrate h:Perform a snapshot difference incremental backup after detecting that theNetApp server has migrated to a unicode-enabled file server from a serverthat did not support unicode file names. This command suppresses thewarning message.dsmc incremental -snapdiff -createnewbase=ign h:Perform a full incremental backup because you have made some include orexclude changes:dsmc incremental -snapdiff -createnewbase=yes h:Related information“Configuring NetApp and Tivoli Storage Manager for snapshot differenceincremental backups” on page 70“SnapMirror support for NetApp snapshot-assisted progressive incremental backup(snapdiff)” on page 72“Basesnapshotname” on page 307“Diffsnapshotname” on page 335Chapter 11. Processing options 477

“Useexistingbase” on page 510“Diffsnapshot” on page 334“Set Password” on page 666SnapshotproviderfsUse the snapshotproviderfs option to enable snapshot-based file backup andarchive operations, and to specify a snapshot provider.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager API doesnot support this option. The server can also define this option.Options FileSpecify this option in the client options file, dsm.opt, to enable snapshots. You canoverride the client-wide option for a specific operation by specifying this option onthe command line for the backup and archive commands. You can also overridethe client-wide option for a specific file system by using the include.fs statement inthe dsm.opt file. You can also set this option using the Preferences editor.Syntax►► SNAPSHOTPROVIDERFs value ►◄ParametersvalueSpecifies one of the following values:VSSSpecifies that VSS should be used to provide OFS support.NONESpecifies that no snapshot provider should be used; OFS support is turned off.This is the default.ExamplesOptions file:snapshotproviderfs VSSinclude.fs d: snapshotproviderfs=vssCommand line:-SNAPSHOTPROVIDERFs=VSSRelated informationFor information about configuring open file support, see “Configuring Open FileSupport” on page 70.478 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

SnapshotproviderimageUse the snapshotproviderimage option to enable snapshot-based image backup,and to specify a snapshot provider.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager API doesnot support this option. The server can also define this option.Options FileSpecify this option in the client options file, dsm.opt, to enable snapshots for allthe file systems on the client. You can override the client-wide option for a specificoperation by specifying this option on the command line for the backup imagecommand. You can also override the client-wide option for a specific file systemusing the include.image statement in the dsm.opt file. You can also set this optionusing the Preferences editor.Syntax►► SNAPSHOTPROVIDERImage value ►◄ParametersvalueSpecifies one of the following values:VSSSpecifies that the VSS should be used to provide online image support.NONESpecifies that no snapshot provider should be used. This turns off online imagesupport. This is the defaultExamplesOptions file:snapshotprovideri VSSinclude.image d: snapshotprovideri=vssCommand line:-SNAPSHOTPROVIDERImage=NONERelated informationFor information about configuring open file support, see “Configuring Open FileSupport” on page 70.SnapshotrootUse the snapshotroot option with the incremental, selective, orarchive commandsin conjunction with a independent software vendor application that provides asnapshot of a logical volume, to associate the data on the local snapshot with thereal file space data that is stored on the Tivoli Storage Manager server.Chapter 11. Processing options 479

This option should be used with an incremental backup of a NAS file servervolume instead of a simple incremental or incremental with snapshotroot optionwhenever the NAS file server is running ONTAP V7.3 for performance reasons.The snapdiff and snapshotroot options should not be used together.The snapshotroot option can be used to back up network share mounted filesystems. Both the back up specification (source) and the snapshotroot value can bea network share mounted file specification. For example, the snapshotroot optioncan be used to back up a network share file system hosted on a network-attachedstorage (NAS) that supports snapshot.In the following example, c:\snapshots\snapshot.0 is network share mountedfrom a NAS file server and \\florance\c$ represents the snapshot created at theNAS file server.dsmc incr \\florance\C$ -snapshotroot=c:\shapshots\snapshot.0You can also specify a directory with the snapshotroot option when backing upeach fileset as a separate file space.The snapshotroot option does not provide any facilities to take a volume snapshot,only to manage data created by a volume snapshot.For example, consider an application that takes a snapshot of the c: drive andmounts it as the NTFS junction point \\florence\c$\snapshots\snapshot.0. Ifyouback up this data using the following command, a unique file space called\\florence\c$\snapshots\snapshot.0 is created on the server.dsmc incremental \\florence\c$\snapshots\snapshot.0However, you might want to associate the snapshot data with the data alreadyprocessed for the c: drive (\\florence\c$). Using the snapshotroot option, youcan associate the data with the file space corresponding to the c: drive(\\florence\c$) on the Tivoli Storage Manager server:dsmc incr c: -snapshotroot=\\florence\c$\snapshots\snapshot.0-ordsmcincr \\florence\c$ -snapshotroot=\\florence\c$\snapshots\snapshot.0On a subsequent day, you can back up a snapshot that was written to an alternatelocation, but managed under the same file space on the server:dsmc incr c: -snapshotroot=\\florence\c$\snapshots\snapshot.1You can perform incremental backups, selective backups, or archives of a singledirectory, directory structure, or single file using the snapshotroot option. In allinstances, the snapshotroot option must identify the root of the logical volume thatwas created by the snapshot. For example:dsmc incr c:\dir1\* -subdir=yes -snapshotroot=\\florence\c$\snapshots\snapshot.1dsmc sel c:\dir1\sub1\file.txt -snapshotroot=\\florence\c$\snapshots\snapshot.1dsmc archive c:\mydocs\*.doc -snapshotroot=\\florence\c$\snapshots\snapshot.1If you want to include or exclude specific file specifications, the include andexclude statements should contain the name of the file system that was the sourceof the snapshot (the c: drive), and not the name of the target of the snapshot(\\florence\c$\snapshots\snapshot.1). This allows you to preserve a set of480 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

include and exclude statements regardless of the name of the logical volume towhich the snapshot is written. The following are examples of include and excludestatements.include c:\dir1\.../*.txt lyrmgmtclassexclude \\florence\c$\mydocs\*.docThe following include-exclude statements are not valid because they contain thename of the snapshot:include \\florence\c$\snapshots\snapshot.1\dir1\...\*.txt 1yrmgmtclassexclude \\florence\c$\mydocs\*.docYou must use the snapshotroot option in conjunction with a single filespecification for a incremental, selective, or archive operation. You cannot specifymultiple file specifications or no file specifications. For example, these commandsare valid:dsmc incr c: -snapshotroot=\\florence\c$\snapshots\snapshot.0dsmc incr c:\dir1\* -snapshotroot=\\florence\c$\snapshots\snapshot.0The following command is invalid because it contains two file specifications:dsmc incr c:\dir1\* e:\dir1\* -snapshotroot=\\florence\c$\snapshots\snapshot.0The following command is invalid because it contains no file specification:dsmc incr -snapshotroot=\\florence\c$\snapshots\snapshot.0Note:1. Ensure that the snapshotroot references a snapshot of the correct volume.Ensure that snapshotroot refers to the root of the snapshot. If these rules arenot followed, unintended results such as files expiring incorrectly can result.2. If you specify the filelist option and the snapshotroot option, all filesspecified in the filelist option are assumed to be located in the same filesystem. If there are entries in the filelistin a different file system, they areskipped and an error is logged. If the filelist contains files that were createdin the file system after the snapshot was taken, these entries are also skipped,and an error is logged.3. You cannot use the snapshotroot option with any backup command, such asbackup image, backup systemstate, etc.4. You cannot use the snapshotroot option with the snapdiff option.5.|||||||Important: Use the snapshotroot option with caution if you are using theTivoli Storage Manager journal-based backup feature. Since there is nocoordination between the Tivoli Storage Manager journal and thevendor-acquired snapshot provider (VSS), unwanted behavior can occur withjournal notifications received after the snapshot occurs. For example, files mightnot be backed up, or they might be backed up redundantly to the TivoliStorage Manager server.6. You can use the snapshotroot option in conjunction with the preschedulecmdand postschedulecmd options, or in a automated script that you execute withthe Tivoli Storage Manager client scheduler.Chapter 11. Processing options 481

Supported ClientsThis option is valid for the following clients:v All Windows clients.Syntax►► SNAPSHOTRoot = snapshot_volume_name ►◄Parameterssnapshot_volume_nameSpecifies the root of the logical volume created by the independent softwarevendor snapshot application.ExamplesCommand line:dsmc incr c: -SNAPSHOTRoot=\\florence\c$\snapshots\snapshot.0SrvoptsetencryptiondisabledThe srvoptsetencryptiondisabled option allows the client to ignore encryptionoptions in a client options set from a Tivoli Storage Manager server.If the option is set to yes in the client options file, the client ignores the followingoptions in a client options set from a Tivoli Storage Manager server:v encryptkey generatev exclude.encryptv include.encryptSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►►SRVOPTSETENCryptiondisablednoyes►◄ParametersyesnoTivoli Storage Manager client ignores the values of the listed encryptionoptions in a client options set from a Tivoli Storage Manager server.Tivoli Storage Managerclient processes the setting of the listed encryptionoptions in a client options set from a Tivoli Storage Manager server. This is thedefault.482 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:srvoptsetencryptiondisabled noCommand line:Does not apply.SrvprepostscheddisabledThe srvprepostscheddisabled option specifies whether to prevent the pre-scheduleand post-schedule commands specified by the Tivoli Storage Manageradministrator from executing on the client system, when performing scheduledoperations.The srvprepostscheddisabled option can be used in conjunction with theschedcmddisabled and srvprepostscheddisabled options to disable the execution ofany unwanted Operating System command by a Tivoli Storage Manageradministrator on a Tivoli Storage Manager client node.Supported ClientsThis option is valid for all Tivoli Storage Manager clients that use the TivoliStorage Manager client scheduler. The server cannot define this option.Options FilePlace this option in the client options file (dsm.opt) for the scheduler. You can setthis option on the Scheduler tab of the Preferences editor, in the ScheduleCommand section.Syntax►►SRVPREPOSTSCHeddisabledNoYes►◄ParametersNoYesSpecifies that Tivoli Storage Manager allows pre-schedule and post-schedulecommands defined by the Tivoli Storage Manager administrator to execute onthe client system, when performing scheduled operations. If a pre-schedule ora post-schedule command is defined by both the client and the Tivoli StorageManager administrator, the command defined by the administrator overridesthe corresponding command defined in the client option file. This is thedefault.Specifies that Tivoli Storage Manager prevents pre-schedule and post-schedulecommands defined by the Tivoli Storage Manager administrator to execute onthe client system, when performing scheduled operations. If a pre-schedule ora post-schedule command is defined by both the client and the Tivoli StorageManager administrator, the command defined by the administrator will notoverride the corresponding command defined in the client option file. Thisoption can be used in conjunction with the schedcmddisabled andsrvprepostscheddisabled options.Chapter 11. Processing options 483

ExamplesOptions file:srvprepostscheddisabled yesCommand line:Does not apply.SrvprepostsnapdisabledThe srvprepostsnapdisabled option specifies whether to prevent the pre-snapshotand post-snapshot commands specified by the Tivoli Storage Manageradministrator from executing on the client system, when performing scheduledimage snapshot backup operations.The srvprepostsnapdisabled option can be used in conjunction with theschedcmddisabled and srvprepostsnapdisabled options to disable the execution ofany unwanted Operating System command by a Tivoli Storage Manageradministrator on a Tivoli Storage Manager client node.Supported ClientsThis option is valid for Windows clients that support the image snapshot backupcommand. The server cannot define this option. The Tivoli Storage Manager APIdoes not support this option.Options FilePlace this option in the client options file (dsm.opt) for the scheduler. You can setthis option on the Snapshot tab of the Preferences editor, in the Snapshot Optionssection.Syntax►►SRVPREPOSTSNApdisabledNoYes►◄|||||||||ParametersNoYesSpecifies that Tivoli Storage Manager allows pre-snapshot and post-snapshotcommands defined by the Tivoli Storage Manager administrator to execute onthe client system, when performing scheduled image snapshot backupoperations. If a pre-snapshot or a post-snapshot command is defined by boththe client and the Tivoli Storage Manager administrator, the command definedby the administrator overrides the corresponding command defined in theclient option file. This is the default.Specifies that Tivoli Storage Manager does not allow pre-snapshot andpost-snapshot commands defined by the Tivoli Storage Manager administratorto execute on the client system, when performing scheduled image snapshotbackup operations. If a pre-snapshot or a post-snapshot command is definedby both the client and the Tivoli Storage Manager administrator, the commanddefined by the administrator will not override the corresponding commanddefined in the client option file. This option can be used in conjunction withthe schedcmddisabled and srvprepostsnapdisabled options.484 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:srvprepostsnapdisabled yesCommand line:Does not apply.SslUse the ssl option to enable Secure Sockets Layer (SSL), to provide secure clientand server communications.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab of the Preferences editor.Syntax►►SSLNoYes►◄ParametersNo Specifies that the Tivoli Storage Manager client does not use SSL to encryptinformation. No is the default.YesSpecifies that the Tivoli Storage Manager uses SSL to encrypt information.To enable SSL, specify ssl=yes and change the value of the tcpport option.Changing the value of the tcpport option is needed, because the Tivoli StorageManager server is typically set up to listen for SSL connections on a separateport.ExamplesOptions file:ssl yesCommand line:Does not apply.Related information“Configuring Tivoli Storage Manager client/server communication with SecureSockets Layer” on page 38.“Sslrequired” on page 486“Tcpport” on page 501Chapter 11. Processing options 485

SslfipsmodeThe sslfipsmode option specifies if the client uses SSL Federal InformationProcessing Standards (FIPS) mode for Secure Sockets Layer (SSL) communicationswith the server. The default is no.Supported clientsThis option is supported on all clients except for Macintosh.Options FileSet this option in the client options file. You cannot specify it as a command lineparameter (using dsmc) and you cannot set this option in a client options set.Syntax►►SSLFIPSMODE =NoYes►◄ParametersNoYesSpecifies that the client does not use SSL FIPS mode for secure communicationswith the server. SSL in FIPS mode is supported only by IBM Tivoli StorageManager 6.3 and newer versions. Set this client option to no if the client usesSSL to connect to a IBM Tivoli Storage Manager that is not at version 6.3, ornewer.Specifies that the client uses SSL FIPS mode for secure communications withthe server. Setting this option to yes restricts SSL session negotiation to useonly FIPS-approved cipher suites. SSL FIPS mode is only supported by IBMTivoli Storage Manager version 6.3 (or newer).ExampleTo enable SSL FIPS mode on the client:SSLFIPSMODE yes||||||||||SslrequiredThe sslrequired option specifies the conditions when SSL is or is not requiredwhen logging on to the Tivoli Storage Manager server or storage agents. Toactually enable SSL so client-to-server and client-to-storage-agent communicationsare secure, you must set the client ssl option to yes.Supported ClientsThis option is supported on all clients.Options FilePlace this option in the client options file or in the GUI, on the Communicationstab. You cannot set this option on the command line.486 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|Syntax||►►SSLREQuiredDefaultYesNoSERVERonly►◄|||||||||||||||||||||||||||||||||||||||ParametersDefaultThis setting indicates that SSL is required to secure communications betweenthe client and server, and client and storage agents, if AUTHENTICATION=LDAP isset on the server. To secure communications using SSL, you must also setssl=yes on the client.If AUTHENTICATION=LOCAL is set on the server, this setting indicates that SSL isnot required. Even though SSL is not required when AUTHENTICATION=LOCAL andsslrequired=default, you can still use SSL by setting the client ssl option toyes.YesIndicates that SSL is always required to secure communications between theclient and server, and between the client and storage agents. sslrequired=yeshas no dependency on the server AUTHENTICATION option. If you setsslrequired=yes on the client, you must also set ssl=yes on the client.No Indicates that you do not require SSL to be used to secure communicationsbetween the client and server or between the client and storage agents. Choosethis option only if you use a virtual private network or other method to secureyour session communications. You can still enable SSL by setting ssl=yes onthe client; but sslrequired=no specifies that SSL is not a prerequisite.SERVERonlyIndicates that SSL is required for client-to-server communications and not forserver-to-storage agent communications. To use SSL for client to servercommunications, set sslrequired=serveronly and ssl=yes. The server settingfor the AUTHENTICATION option can be either LOCAL or LDAP.For client to storage agent communications, use the client lanfreessl option toenable SSL.The following table describes the situations under which authentication succeedsor fails, depending on the settings of the SSLREQUIRED option on the server, andclient, and the setting of the ssl option on the client. The table results assume thatvalid credentials are supplied.Table 64. Effects of server and client SSL settings on success or failure of login attemptsSSLREQUIREDoptionsslrequiredoptionssl option(server setting) (client setting) (client setting) Authentication success or failureYes Yes Yes Authentication succeedsYes Yes No Authentication fails; the clientrejects the sessionYes No Yes Authentication succeedsChapter 11. Processing options 487

|||||||||||||||||||||||||||||||Table 64. Effects of server and client SSL settings on success or failure of loginattempts (continued)SSLREQUIREDoptionsslrequiredoptionssl option(server setting) (client setting) (client setting) Authentication success or failureYes No No Authentication fails; the serverrejects the sessionNo Yes Yes Authentication succeedsNo Yes No Authentication fails; the clientrejects the sessionNo No Yes Authentication succeedsNo No No Authentication succeedsThe following text describes how setting SSLREQUIRED=DEFAULT andSSLREQUIRED=SERVERONLY on the server affects the ssl option on the client.If the server sets SSLREQUIRED=DEFAULT and AUTHENTICATION=LDAP, the client mustset ssl=yes or authentication fails.If the server sets SSLREQUIRED=DEFAULT and AUTHENTICATION=LOCAL, the client can setssl=yes or ssl=no.If the server sets SSLREQUIRED=SERVERONLY, you must set ssl=yes on the client. Theclient lanfreessl option can be set to yes, to secure communications with astorage agent, or to no if secure communications with storage agents is not needed.ExamplesOptions file:sslrequired yessslrequired nosslrequired defaultsslrequired serveronlyCommand line:Not applicable; you cannot set this option on the command line.StagingdirectoryThe stagingdirectory option defines the location where the client can keep anydata it generates in order to perform its operations. The data is deleted whenprocessing is complete.This option is used by Active Directory objects query and restore operations, andby snapshot difference backup.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). When stagingdirectory isspecified on the command line, it overrides the values specified in the options file.488 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► STAGINGDIRectory path ►◄SubdirParameterspathSpecifies the directory path where the client writes staging data. If you do notspecify a staging directory, Tivoli Storage Manager checks for the existence ofthe USER environment variables in the following order, and uses the first pathfound:1. The path specified by the TMP user variable2. The path specified by the TMP system variable3. The path specified by the TEMP user variable4. The path specified by the TEMP system variable5. The Windows system directoryExamplesOptions file:stagingdirectory c:\tsmdataCommand line:-stagingdir="e:\tsmdata"Related information“Query Adobjects” on page 592“Restore Adobjects” on page 629“Diffsnapshot” on page 334“Snapdiff” on page 473The subdir option specifies whether you want to include subdirectories of nameddirectories for processing.You can use the subdir option with the following commands:v archivev delete archivev delete backupv incrementalv query archivev query backupv restorev restore backupsetv restore groupv retrievev selectiveIf you set the subdir option to yes when backing up a specific path and file, TivoliStorage Manager recursively searches all of the subdirectories under that path, andChapter 11. Processing options 489

looks for any instances of the specified file that exist under any of thosesubdirectories. For example, assume that a file called myfile.txt exists on a clientin the following directories://myfile.txt/dir1/myfile.txt/dir1/dir_a/myfile.txt/dir1/dir_b/myfile.txtPerforming a selective backup of that file, as follows, backs up all four instances ofmyfile.txt:dsmc sel /myfile.txt -subdir=yesSimilarly, the following command displays all instances of myfile.txt if youspecify subdir=yes in the client options file or in a client options set.dsmc restore /myfile.txt -pickSupported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►►SUbdirNoYes►◄ParametersNo Subdirectories are not processed. This is the default.YesSubdirectories are processed. Because the client program searches allsubdirectories of a directory that is being processed, processing can take longerto complete. Specify Yes only when necessary.If you use the preservepath option in addition to subdir=yes, it can affectwhich subdirectories are processed.Note:1. When you run the client in interactive mode, and if you use the -subdir=yesoption, the setting persists for all commands entered in interactive mode, untilyou end interactive mode, by typing Quit.2. If subdir=yes is in effect when you restore multiple files, place a directorydelimeter character at the end of the destination file specification. If thedelimeter is omitted, the client displays a message indicating that thedestination file specification is not valid.3. It is a best practice to include only the default value for subdir (No) in a clientoptions file or a client options set.490 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:subdir noCommand line:To restore the structure:\path2\dir1\path2\dir1\file1\path2\dir1\dir2\path2\dir1\dir2\file1enter any of the following commands:rest \path\dir1\* \path2\ -su=yesrest \path\dir1\file* \path2\ -su=yesrest \path\dir1\file1* \path2\ -su=yesThis option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at thebeginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.Related information“Preservepath” on page 443SubfilebackupThe subfilebackup option specifies whether to enable adaptive subfile backup.||||||||||||||Note:1. To use the subfilebackup option, the server must have subfile yes or subfileclient set. Ask your Tivoli Storage Manager administrator to set the correctvalues.2. You can use open file support with subfile backup operations.3. The subfilebackup option does not work correctly for migrated files. If youuse a combination of subfilebackup yes and subfilebackup no for migratedfiles, your data might be corrupted on the server.4. Adaptive subfile backup can be used with selective backups, incrementalbackups, and on file-level backups of VMware virtual machines (Backup VMcommands where VMBACKUPTYPE=FILE is specified).5. Adaptive subfile backup processing occurs only when you back up files; it isnot used for archive operations.6. Restoring files that were backed up with adaptive subfile backup isaccomplished by using the dsmc restore.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.The Tivoli Storage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab of the Preferences editor.Chapter 11. Processing options 491

Syntax►►SUBFILEBackupnoyes►◄ParametersNo Specifies that Tivoli Storage Manager does not use adaptive subfile backup.This is the default.YesSpecifies that Tivoli Storage Manager uses adaptive subfile backup.ExamplesOptions file:subfileb yesCommand line:-subfileb=yesThis option is valid only on the initial command line. It is not valid in interactivemode.SubfilecachepathThe subfilecachepath option specifies the path where the client cache resides foradaptive subfile backup processing.If you do not specify a path, Tivoli Storage Manager creates a path called \cacheunder the directory where the Tivoli Storage Manager executables reside.All directories and subdirectories in the path name you specify with thesubfilecachepath option must exist. For example, if you specify c:\temp\cache,the c:\temp directory must already exist. You should exclude the subfilecachedirectory from backup.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.The Tivoli Storage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab of the Preferences editor.Syntax►► SUBFILECACHEPath path_name ►◄Parameterspath_nameSpecifies the path name where the client cache resides for adaptive subfilebackup processing.492 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:subfilecachep c:\temp\cc_tsmCommand line:-subfilecachep=c:\temp\cc_tsmThis option is valid only on the initial command line. It is not valid in interactivemode.SubfilecachesizeThe subfilecachesize option specifies the client cache size for adaptive subfilebackup.If the cache size is too small, base files for some files will not be cached and subfileprocessing will not apply for them. However, setting the value too large can takeup more disk space than can be spared. The files maintained in the cache shouldclosely reflect the files used on a regular basis.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theBackup tab of the Preferences editor.Syntax►► SUBFILECACHESize size ►◄ParameterssizeSpecifies the size, in megabytes, of the client cache for adaptive subfile backupprocessing. The range is 1 through 1024 (1 GB); the default is 10.ExamplesOptions file:subfilecaches 10Command line:-subfilecaches=10This option is valid only on the initial command line. It is not valid in interactivemode.SystemstatebackupmethodUse the systemstatebackupmethod option to specify which backup method to use toback up the system writer portion of the system state data. The method you selectis used when you backup the system state data.Chapter 11. Processing options 493

Supported clients|This option is valid for Windows clients.Options filePlace this option in the client options file (dsm.opt). When specified in the dsm.optfile, the option affects system state backups created by BACKUP SYSTEMSTATEcommands, and system state data backed up by INCREMENTAL commands.However, the only command that you can specify this option on is the BACKUPSYSTEMSTATE command.Schedule definitionsYou can also specify this option on the options parameter of a schedule definitionon schedules that have both action=backup and subaction=systemstate set.Defining an infrequent schedule with this option set to FULL ensures that youperiodically perform a full backup of Windows system state data.Syntax►►SYSTEMSTATEBACKUPMethodPROGressiveOPPortunisticFULL►◄ParametersPROGressiveWith the PROGressive method, the system writer portion of the system statedata is backed up using the progressive incremental backup method. That is, ifsystem writer files have not changed since the last system state backup, theyare not included in this backup. Only the changed system writer files arebacked up. This is the default system state backup method.This type of system state backup uses the least network bandwidth and TivoliStorage Manager server storage, but it increases the amount of Tivoli StorageManager database processing required to keep track of the changes.OPPortunisticWith the OPPortunistic method, if any system writer files have changed sincethe last system state backup, all system writer files are backed up.This method, like the PROGressive method, also uses the least networkbandwidth and Tivoli Storage Manager server storage if system writer fileshave not changed since the last system state backup. If any system writer fileshave changed since the last system state backup then the system writer isbacked up in full, which uses more network bandwidth and Tivoli StorageManager server storage. With the OPPortunistic method, the amount of TivoliStorage Manager database processing that occurs is less than that caused bythe PROGressive method.FULLWhen FULL is specified, all system writer files are backed up, even if theyhave not changed since the last system state backup.494 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

This type of system state backup uses the most network bandwidth and TivoliStorage Manager server storage because all system writer files are backed upduring each system state backup operation. However, this system state backupmethod causes little Tivoli Storage Manager database processing.ExamplesOptions file:SYSTEMSTATEBACKUPMETHOD FULLSYSTEMSTATEBACKUPMETHOD OPPORTUNISTICCommand line:backup systemstate -SYSTEMSTATEBACKUPMETHOD=FULLTapepromptThe tapeprompt option specifies whether you want Tivoli Storage Manager to waitfor a tape mount if it is required for a backup, archive, restore, or retrieve process,or to be prompted for a choice.In the Tivoli Storage Manager GUI, the Media Mount dialog can display theInformation Not Available value in the Device and Volume Label fields if youperform a standard (also known as classic) restore or retrieve operation. This valuemeans that this information is only available for no query restore or retrieveoperations; not a standard restore or retrieve operation. The Device field displaysthe name of the device on which to mount the media needed to process an object.The Volume Label field displays the name of the volume needed to process anobject.Tape prompting does not occur during a scheduled operation regardless of thesetting for the tapeprompt option.The tapeprompt option can be used with the following commands:v archivev delete archivev delete backupv incrementalv restorev retrievev selectiveNote: The server can also define this option.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab, Prompt before mounting tapes checkbox of the Preferences editor.Chapter 11. Processing options 495

Syntax►►TAPEPromptNoYes►◄ParametersNoYou are not prompted for your choice. The server waits for the appropriatetape to mount. This is the default.Note: For API applications, this permits backup directly to tape.YesYou are prompted when a tape is required to back up, archive, restore, orretrieve data. At the prompt, you can wait for the appropriate tape to bemounted, always wait for a tape to be mounted, skip a particular object, skipall objects on a single tape, skip all objects on all tapes, or cancel the entireoperation.ExamplesOptions file:tapeprompt yesCommand line:-tapep=yesThis option is valid only on the initial command line. It is not valid in interactivemode.TcpadminportUse the tcpadminport option to specify a separate TCP/IP port number on whichthe server waits for requests for administrative client sessions, allowing secureadministrative sessions within a private network.The client tcpadminport setting depends on how the Tivoli Storage Manager servertcpadminport and adminonclientport options are configured. The Tivoli StorageManager server has a tcpadminport setting that indicates on which port the serverlistens for administrative sessions, and the adminonclientport setting, which canbe either yes or no.If tcpadminport is not set on the server, then administrative sessions are allowedon the same port as client sessions.If tcpadminport is set on the server, then administrative sessions are allowed onthe port specified by that setting. In this case, if adminonclientport yes is in effect,then administrative sessions can connect on either the regular client port or theport specified by tcpadminport. Ifadminonclientport no is in effect, thenadministrative sessions can connect only on the port specified by tcpadminport.Supported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.496 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, in the Admin Port field in the Preferences editor.Syntax►►TCPADMINPortadmin_port_address►◄Parametersadmin_port_addressSpecifies the port number of the server. The default value is the value of thetcpport option.ExamplesOptions file:tcpadminport 1502TcpbuffsizeThe tcpbuffsize option specifies the size of the internal TCP/IP communicationbuffer used to transfer data between the client node and server. Although it usesmore memory, a larger buffer can improve communication performance.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, in the Buffer Size field in the Preferences editor.Syntax►► TCPBuffsize size ►◄ParameterssizeSpecifies the size, in kilobytes, that you want to use for the internal TCP/IPcommunication buffer. The range of values is 1 through 512; the default is 32.Depending on the operating system communication settings, your systemmight not accept all values in the range of 1 through 512.ExamplesOptions file:tcpb 32Command line:-tcpbuffsize=32Chapter 11. Processing options 497

This option is valid only on the initial command line. It is not valid in interactivemode.TcpcadaddressThe tcpcadaddress option specifies a TCP/IP address for dsmcad. Normally, thisoption is not needed. Use this option only if your client node has more than oneTCP/IP address, or if TCP/IP is not the default communication method.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►► TCPCADAddress cad_address ►◄Parameterscad_addressSpecifies a TCP/IP Internet domain name or a numeric IP address. You canspecify TCPip or V6Tcpip. This option uses TCP/IP Version 4 if TCPip isspecified and uses Version 6 if V6Tcpip is specified. You can only use IPv6addresses if you specified the commmethod V6Tcpip option.ExamplesOptions file:tcpcada dsmclnt.sanjose.ibm.comCommand line:-tcpcadaddress=128.33.10.249-tcpcadaddress=khoyt.mycompany.mydomain.com-tcpcadaddress=2002:92b:111:221:128:33:10:249This option is valid only on the initial command line of the dsmcad program. It isnot valid with other dsm modules.Related informationSee “Commmethod” on page 317 to determine if your client node has more than oneTCP/IP address, or if TCP/IP is not the default communication method.TcpclientaddressThe tcpclientaddress option specifies a TCP/IP address if your client node hasmore than one address, and you want the server to contact an address other thanthe one that was used to make the first server contact.The server uses this address when it begins the server prompted scheduledoperation.498 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Use this option only if you use the prompted parameter with the schedmode option.If sessioninitiation is set to serveronly, the value for the tcpclientaddress clientoption should be the same as the value for the HLAddress server setting.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, Your TCP/IP address field of the Preferences editor.Syntax►► TCPCLIENTAddress client_address ►◄Parametersclient_addressSpecifies the TCP/IP address you want the server to use to contact your clientnode. Specify a TCP/IP Internet domain name or a numeric IP address. Thenumeric IP address can be either a TCP/IPv4 or TCP/IPv6 address. You canonly use IPv6 addresses if you specified the commmethod V6Tcpip option.ExamplesCommand line:-tcpclientaddress=128.33.10.249-tcpclientaddress=khoyt.mycompany.mydomain.com-tcpclientaddress=2002:92b:111:221:128:33:10:249This option is valid only on the initial command line. It is not valid in interactivemode.TcpclientportThe tcpclientport option specifies a TCP/IP port number for the server to contactthe client when the server begins the server prompted scheduled operation.Use this option only if you specify the prompted parameter with the schedmodeoption.If sessioninitiation is set to serveronly, the value for the tcpclientport clientoption should be the same as the value for the LLAddress server option.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theScheduler tab, in the Your TCP/IP port field in the Preferences editor.Chapter 11. Processing options 499

Syntax►► TCPCLIENTPort client_port_address ►◄Parametersclient_port_addressSpecifies the TCP/IP port address you want the server to use to contact yourclient node. The range of values is 1 through 32767; the default is 1501.ExamplesOptions file:tcpclientp 1502Command line:-tcpclientport=1492This option is valid only on the initial command line. It is not valid in interactivemode.TcpnodelayThe tcpnodelay option specifies whether the client disables the delay of sendingsuccessive small packets on the network, per transaction.Change the value from the default of yes only under one of the followingconditions:v You are directed to change the option by IBM technical support.vYou fully understand the effects of the TCP Nagle algorithm on networktransmissions. Setting the option to no enables the Nagle algorithm, whichdelays sending small successive packets.Supported ClientsThis option is valid for all Windows clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab in the Preferences editor. Select Send transaction to the serverimmediately.Syntax►►TCPNodelayYesNo►◄ParametersNoSpecifies that the server does not allow successive small packets to be sentimmediately over the network. Setting this option to no can degradeperformance.500 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

YesSpecifies that the server or client allows successive small packets to be sentimmediately over the network. The default is yes.ExamplesOptions file:tcpnodelay yesCommand line:Does not apply.TcpportThe tcpport option specifies a TCP/IP port address for a Tivoli Storage Managerserver. You can obtain this address from your administrator.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, in the Server Port field in the Preferences editor.Syntax►► TCPPort port_address ►◄Parametersport_addressSpecifies the TCP/IP port address that is used to communicate with a server.The range of values is 1 through 32767; the default is 1500.ExamplesOptions file:tcpp 1501Command line:-tcpport=1501This option is valid only on the initial command line. It is not valid in interactivemode.TcpserveraddressThe tcpserveraddress option specifies the TCP/IP address for a Tivoli StorageManager server. You can obtain this server address from your administrator.Supported ClientsThis option is valid for all clients.Chapter 11. Processing options 501

Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, in the Server Address field in the Preferences editor.If this option is not specified, the client attempts to contact a Tivoli StorageManager server running on the same computer as the Tivoli Storage Managerclient.Syntax►► TCPServeraddress server_address ►◄Parametersserver_addressSpecifies a1to64character TCP/IP address for a server. Specify a TCP/IPdomain name or a numeric IP address. The numeric IP address can be either aTCP/IP v4 or TCP/IP v6 address. You can only use IPv6 addresses if youspecified the commmethod V6Tcpip option.ExamplesOptions file:tcps dsmchost.endicott.ibm.comCommand line:-tcpserveraddress=129.33.24.99-tcpserveraddress=2002:92b:111:221:128:33:10:249This option is valid only on the initial command line. It is not valid in interactivemode.TcpwindowsizeUse the tcpwindowsize option to specify, in kilobytes, the size you want to use forthe TCP/IP sliding window for your client node.The sending host cannot send more data until it receives an acknowledgment anda TCP receive window update. Each TCP packet contains the advertised TCPreceive window on the connection. A larger window allows the sender to continuesending data and can improve communication performance.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab, Window Size field of the Preferences editor.Syntax►► TCPWindowsize window_size ►◄502 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Parameterswindow_sizeSpecifies the size, in kilobytes, to use for your client node TCP/IP slidingwindow. The range of values is 0 through 2048. A value of 0 allows TivoliStorage Manager to use the operating system default TCP window size. Valuesfrom 1 to 2048 indicate that the window size is in the range of 1KB to 2MB.The default is 63.If you specify a value less than 1, the TCP window sizedefaults to 1. If you specify a value greater than 2048, the TCP window sizedefaults to 2048.||Note:1. The TCP window acts as a buffer on the network. It is not related to thetcpbuffsize option, or to the send and receive buffers allocated in client orserver memory.2. A window size larger than the buffer space on the network adapter mightdegrade throughput due to resending packets that were lost on the adapter.3. Depending on the operating system communication settings, your systemmight not accept all values in the range of values.4. The tcpwindowsize option overrides the operating system's default TCP/IPsession send and receive window sizes.5. Windows provides a larger TCP receive window size when communicatingwith hosts that also provide this support, known as RFC1323. In theseenvironments, a value greater than 63 can be useful.ExamplesOptions file:tcpwindowsize 63Command line:-tcpw=63This option is valid only on the initial command line. It is not valid in interactivemode.TimeformatThe timeformat option specifies the format in which you want to display and entersystem time.Use this option if you want to change the default time format for the language ofthe message repository you are using.By default, the backup-archive and administrative clients obtain formatinformation from the locale definition in effect at the time the client is called.Consult the documentation on your local system for details about setting up yourlocale definition.Note: The timeformat option does not affect the Web client. The Web client usesthe time format for the locale that the browser is running in. If the browser is notrunning in a locale that Tivoli Storage Manager supports, the Web client uses thetime format for US English.You can use the timeformat option with the following commands:v delete archivev delete backupChapter 11. Processing options 503

vvvvvvvvvvvvvvvexpirequery archivequery asrquery backupquery filespacequery imagequery nasquery systemstaterestorerestore imagerestore nasrestore registryrestore systemstateretrieveset event||When you include the timeformat option with a command, it must precede thefromtime, pittime, and totime options.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theRegional Settings tab, Time Format field of the Preferences editor.Syntax►► TIMEformat format_number ►◄Parametersformat_numberDisplays time in one of the formats listed below. Select the format number thatcorresponds to the format you want to use. When you include the timeformatoption in a command, it must precede the fromtime, pittime, and totimeoptions.1 23:00:002 23,00,003 23.00.004 12:00:00 A/P5 A/P 12:00:00ExamplesOptions file:timeformat 4Command line:-time=3This option is valid on the initial command line and in interactive mode. If youuse this option in interactive mode, it affects only the command with which it isspecified. When that command completes, the value reverts to the value at the504 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

eginning of the interactive session. This is the value from the dsm.opt file unlessoverridden by the initial command line or by an option forced by the server.Additional considerations for specifying time and date formatsThe date or time format you specify with this option must be used when usingoptions that take date and time as input. Examples are: totime, fromtime, todate,fromdate, and pittime.For example, if you specify the timeformat option as TIMEFORMAT 4, the value thatyou provide on the fromtime or totime option must be specified as a time such as12:24:00pm. Specifying 13:24:00 would not be valid because TIMEFORMAT 4 requiresan hour integer that is 12 or less. If you want to specify up to 24 hour values on anoption, and if you want to use commas as separators, you must specify TIMEFORMAT2.TocUse the toc option with the backup nas command or the include.fs.nas option tospecify whether Tivoli Storage Manager saves table of contents (TOC) informationfor each file system backup.You should consider the following when deciding whether you want to save TOCinformation:vvvvIf you save TOC information, you can use the QUERY TOC server command todetermine the contents of a file system backup in conjunction with the RESTORENODE server command to restore individual files or directory trees.You can also use the Tivoli Storage Manager Web client to examine the entire filesystem tree and select files and directories to restore.Creation of a TOC requires that you define the TOCDESTINATION attribute inthe backup copy group for the management class to which this backup image isbound. Note that TOC creation requires additional processing, networkresources, storage pool space, and possibly a mount point during the backupoperation.If you do not save TOC information, you can still restore individual files ordirectory trees using the RESTORE NODE server command, provided that youknow the fully qualified name of each file or directory and the image in whichthat object was backed up.Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Options FilePlace the include.fs.nas statement containing the toc value in the client optionsfile (dsm.opt).Syntax►►TOCPreferredYesNo►◄Chapter 11. Processing options 505

TodateParametersYesSpecifies that Tivoli Storage Manager saves TOC information during a NAS filesystem image backup. However, the backup fails if an error occurs duringcreation of the TOC.No Specifies that Tivoli Storage Manager does not save TOC information during aNAS file system image backup.PreferredSpecifies that Tivoli Storage Manager saves TOC information during a NAS filesystem image backup. The backup does not fail if an error occurs duringcreation of the TOC. This is the default.Note: If the mode option is set to differential and you set the toc option to preferredor yes, but the last full image does not have a TOC, Tivoli Storage Managerperforms a full image backup and creates a TOC.ExamplesOptions file:include.fs.nas netappsj/vol/vol0 homemgmtclass toc=yesCommand line:backup nas -nasnodename=netappsj {/vol/vol0} -toc=yesUse the todate option with the totime option to specify an ending date and timeto which you want to search for backups or archives during a restore, retrieve, orquery operationUse the todate and totime options with the fromtime and fromdate options torequest a list of backed up or archived files within a period of time. For example,you might request a list of files that were backed up between 6:00 AM on July 1,2002 and 11:59 PM on July 30, 2002.Use the todate option with the following commands:v delete backupv query archivev query backupv restorev restore groupv retrieveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► TODate = date ►◄506 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

TotimeParametersdateSpecifies an ending date. Enter the date in the format you selected with thedateformat option.When you include dateformat with a command, it must precede the fromdate,pitdate, and todate options.ExamplesCommand line:dsmc restore -todate=12/11/2003 c:\myfiles\Use the totime option with the todate option to specify an ending date and timeto which you want to search for backups or archives during a restore, retrieve, orquery operation. Tivoli Storage Manager ignores this option if you do not specifythe todate option.Use the totime and todate options with the fromtime and fromdate options torequest a list of files that were backed up within a period of time. For example,you might request a list of files that were backed up between 6:00 AM on July 1,2003 and 11:59 PM on July 30, 2003.Use the totime option with the following commands:v delete backupv query archivev query backupv restorev restore groupv retrieveSupported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► TOTime = time ►◄ParameterstimeSpecifies an ending time. If you do not specify a time, the time defaults to23:59:59. Specify the time in the format you selected with the timeformatoption.When you include the timeformat option in a command, it must precede thefromtime, pittime, and totime options.ExamplesCommand line:dsmc query backup -totime=23:59:00 -todate=06/30/2003 c:\mybackups\Chapter 11. Processing options 507

TxnbytelimitThe txnbytelimit option specifies the number of kilobytes the client programbuffers before it sends a transaction to the server.A transaction is the unit of work exchanged between the client and server. Atransaction can contain more than one file or directory, called a transaction group.You can control the amount of data sent between the client and server, before theserver commits the data and changes to the server database, using thetxnbytelimit option. Controlling the amount of data sent changes the speed of theclient to perform the transactions. The amount of data sent applies when files arebatched together during backup or when receiving files from the server during arestore procedure.After the txngroupmax number is reached, the client sends the files to the server,even if the transaction byte limit is not reached.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theGeneral tab, in the Transaction Buffer Size field in the Preferences editor.Syntax►► TXNBytelimit number ►◄ParametersnumberSpecifies the number of kilobytes the client program sends to the server beforecommitting the transaction. The range of values is 300 through 34359738368 (32GB). The default is 25600 KB. The number can be specified as an integer or asan integer with one of the following unit qualifiers:K or k (kilobytes)M or m (megabytes)G or g (gigabytes)If no unit qualifier is specified, the integer is in kilobytes.Restriction: The txnbytelimit option does not support decimal numbers, andonly one-unit letters are allowed. For example: K, M, or G.ExamplesOptions file:txnb 25600txnb 2097152txnb 2097152ktxnb 2048mtxnb 2g508 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

txnb 32GCommand line:-txnb=25600-txnb=16GThis option is valid only on the initial command line. It is not valid in interactivemode.TypeUse the type option with the query node command to specify the type of node toquery. Use this option with the set event command to activate, hold, or release.Supported ClientsThis option is also valid for the set password command with TSM or FILER.This option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Syntax►►TYpe =anynasserverclient►◄ParametersnasSpecifies all NAS nodes registered at the server.serverSpecifies client nodes that are other Tivoli Storage Manager servers.clientSpecifies client nodes that are backup-archive clients.ExamplesCommand line:query node -type=nasUsedirectoryThe usedirectory option queries the Active Directory for the communicationmethod and server with which to connect.This option overrides the commmethod parameters specified in the client options file(dsm.opt). Optimally, the administrator enables only one server and one specificcommunication protocol for a given client node. The specification of thisinformation in Active Directory is done using the Tivoli Storage Manager server onWindows, which has a wizard to assist with this configuration. If a node isregistered to more than one server published in Active Directory, the first serverreturned in the Active Directory query is used. If the client cannot contact theserver, the client session fails.Chapter 11. Processing options 509

Supported ClientsThis option is valid for all Windows clients. The Tivoli Storage Manager client APIdoes not support this option.Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommunication tab of the Preferences editor.Syntax►►USEDIRectoryNoYes►◄ParametersYesNoSpecifies that the client ignores commmethod parameters set in the client optionsfile and query the Active Directory for the communication method and serverwith which to connect.Specifies that the client uses the communication method specified in the optionfile. If there is no communication method specified in the option file thedefault communication method and server are used.ExamplesOptions file:usedirectory noCommand line:-usedir=yesThis option is valid only on the initial command line. It is not valid in interactivemode.||||||||||||||UseexistingbaseThe useexistingbase option is used when you back up snapshots that are onNetApp filer volumes. The useexistingbase option indicates that the latestsnapshot that exists on the volume being backed up, is to be used as the basesnapshot, during a snapshot differential backup operation.If this option is not specified, a new snapshot is created on the volume that isbeing backed up. Because target filer volumes are read only volumes,useexistingbase must be specified when performing snapshot differential backupsof target filer volumes. If useexistingbase is not specified, snapshot differentialbackups of a target filer volume fail because the new snapshot cannot be createdon the read only volume.When backing up target filer volumes, use both the useexistingbase option andthe diffsnapshot=latest option to ensure that the most recent base and mostrecent differential snapshots are used during the volume backup510 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||Supported ClientsThis option can be used with supported Windows clients.Options FileThis option is only valid on the command line.Syntax►► USEEXISTINGBase ►◄ParametersThis option has no parametersExamplesOptions file:Does not apply.Command line:dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff-useexistingbase -basenameshotname="nightly.?"Related informationBasesnapshotnameV2archiveUse the v2archive option with the archive command to archive only files to theserver.Tivoli Storage Manager will not process directories that exist in the path of thesource file specification.This option differs from the filesonly option in that the filesonly option archivesthe directories that exist in the path of the source file specification.The v2archive and dirsonly options are mutually exclusive and an error messageis displayed if you use both options in the same archive command.If you use this option, you might want to consider the following:v You might experience performance problems when retrieving large amounts ofdata archived with this option.v You might want to use this option only if you are concerned about expirationperformance on a server that already contains extremely large amounts ofarchived data.v If there are multiple files with the same name for the v2archive option, the filesare archived multiple times, with their directory structure. The v2archive optionarchives only the files.Chapter 11. Processing options 511

Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Syntax►► V2archive ►◄ParametersThere are no parameters for this option.ExamplesThis command:dsmc archive c:\relx\dir1\ -v2archive -su=yArchives these files:c:\relx\dir1\file1c:\relx\dir1\file2c:\relx\dir1\file3c:\relx\dir1\dir2\file4c:\relx\dir1\dir2\file5Note: Tivoli Storage Manager does not archive c:\relx\dir1 andc:\relx\dir1\dir2.VerboseThe verbose option specifies that you want to display detailed processinginformation on your screen. This is the default.When you run the incremental, selective, orarchive commands, information isdisplayed about each file that is backed up. Use the quiet option if you do notwant to display this information.The following behavior applies when using the verbose and quiet options:v If the server specifies either the quiet or verbose option in the server clientoption set, the server settings override the client values, even if force is set to noon the server.v If you specify quiet in your dsm.opt file, and you specify -verbose on thecommand line, -verbose prevails.v If you specify both -quiet and -verbose on the same command, the last optionencountered during options processing prevails. If you specify -quiet -verbose,-verbose prevails. If you specify -verbose -quiet, -quiet prevails.Supported ClientsThis option is valid for all clients. The server can also define this option. The TivoliStorage Manager client API does not support this option.512 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Options FilePlace this option in the client options file (dsm.opt). You can set this option on theCommand Line tab, Do not display process information on screen checkbox ofthe Preferences editor.Syntax►► VErbose ►◄ParametersThere are no parameters for this option.ExamplesOptions file:verboseCommand line:-verboseThis option is valid only on the initial command line. It is not valid in interactivemode.VerifyimageUse the verifyimage option with the restore image command to specify that youwant to enable detection of bad sectors on the destination target volume.If bad sectors are detected on the target volume, Tivoli Storage Manager issues awarning message on the console and in the error log.Supported ClientsThis option is valid for Windows 32-bit clients only. The Tivoli Storage Managerclient API does not support this option.Syntax►► VERIFYImage ►◄ParametersThere are no parameters for this option.ExamplesCommand line:dsmc restore image d: -verifyimageVirtualfsnameUse the virtualfsname option with the backup group command to specify thename of the virtual file space for the group on which you want to perform theoperation. The virtualfsname cannot be the same as an existing file space name.Chapter 11. Processing options 513

Supported ClientsThis option is valid for all Windows clients.Syntax►► VIRTUALFsname = fsname ►◄ParametersfsnameSpecifies the name of the container for the group on which you want toperform the operation.ExamplesCommand line:backup group -filelist=c:\dir1\filelist1 -groupname=group1-virtualfsname=\virtfs -mode=fullVirtualnodenameThe virtualnodename option specifies the node name of your workstation whenyou want to restore or retrieve files to a different workstation.||||When you use the virtualnodename option in your client options file, or with acommand:vvYou must specify the name you specified with the nodename option in your clientoptions file (dsm.opt). This name should be different from the name returned bythe hostname command on your workstation.Tivoli Storage Manager prompts for the password assigned to the node youspecify, if a password is required (even when the passwordaccess option is set togenerate). If you enter the correct password, you have access to all backups andarchives that originated from the specified node.When connecting to a server, the client must identity itself to the server. This loginidentification is determined in the following ways:vvvIf the nodename and virtualnodename options are not specified, or a virtual nodename is not specified on the command line, the default login ID is the namereturned by the hostname command.If the nodename option is specified, the name specified with the nodename optionoverrides the name returned by the hostname command.If the virtualnodename option is specified, or a virtual node name is specified ona command line, it cannot be the same name as the name returned by thehostname command.Note: The Tivoli Storage Manager client can use file space information whenrestoring files. The file space information can contain the name of the computerfrom which the files were backed up. If you restore from another Tivoli StorageManager client node and do not specify a destination for the restored files, theclient uses the file space information to restore the files. In such a case, the clientattempts to restore the files to the file system on the original computer. If therestoring computer has access to the file system of the original computer, you canrestore files to the original file system. If the restoring computer can not access thefile system of the original computer, the client can return a network error message.514 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If you want to restore the original directory structure but on a different computer,specify only the target file system when you restore. This is true when restoringfiles from another node and when retrieving files from another node.Supported ClientsThis option is valid for all clients.Options FilePlace this option in the client options file (dsm.opt).Syntax►► VIRTUALNodename nodename ►◄ParametersnodenameSpecifies a 1- to 64-character name that identifies the node for which you wantto request Tivoli Storage Manager services. There is no default.ExamplesOptions file:virtualnodename cougarCommand line:-virtualn=bansheeThis option is valid only on the initial command line. It is not valid in interactivemode.VmbackdirUse the vmbackdir option with the backup VM command if you want to changewhere full VM control information is stored on the vStorage backup server.Supported ClientsThe directory specified by this option must be located on a drive that containssufficient free space to contain the control information from a full VM backup.This option is valid for Windows clients that are installed on a vStorage backupserver.Options FileSet this option in the client options file, or specify it on the command line as anoption for the backup vm command.Syntax►► VMBACKDir directory ►◄Chapter 11. Processing options 515

ParametersdirectorySpecifies the path where the full VM backup control information is stored onthe vStorage backup server.The default is \mnt\tsmvmbackup\fullvm\ExamplesOptions file:VMBACKD c:\mnt\tsmvmbackup\Command line:dsmc backup vm -VMBACKUPT=fullvm -VMBACKD=G:\san_temp\VmbacknodeleteUse the vmbacknodelete option with the backup VM command to specify that thefull VM backup files copied to the backup proxy are not deleted at the end of thebackup.Supported ClientsUse this option to keep one or more of your most recent backups on the backupproxy, which allows for faster restore operations that do not require pulling thebackup files from the Tivoli Storage Manager Server.The full VM backup staging directory is BACKUP CURRENT. This directory iswhere VMware exports the full VM files, and where Tivoli Storage Managerperforms the backup. When the backup is complete, this directory is either deleted,or if you have specified the vmbacknodelete option, this directory is renamed witha date and time stamp of the full VM backup.For example:C:\mnt\tsmvmbackup\fullvm\myVMname\BACKUP_DATE_yyyy_mm_dd[hh_mm_ss]\where vmbackdir=c:\mnt\tsmvmbackup and myVMname is the name of your vmwareguest.Important: If you use the vmbacknodelete option, delete saved backup copies toensure that there is sufficient free space available for processing future backups.This option is valid for Windows clients that are configured as a vStorage backupserver of a VMware virtual machine. You can use this option with VCB full VMbackups. You cannot use this option VSTOR full VM backupsOptions FilePlace this option in the client options file (dsm.opt), or on the command line.Syntax►►VMBACKNODeleteNoYes►◄516 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersnoyesSpecifies that the full VM backup files that are copied to the backup proxy isdeleted at the end of the backup. This is the default.Specifies that the full VM backup files that are copied to the backup proxy isnot deleted at the end of the backup, and they are saved in a directory with aname that indicates the date and time of the backup.ExamplesOptions file:VMBACKNOD yesCommand line:dsmc backup vm -vmlist=vm1 -VMBACKUPT=fullvm -VMBACKNOD=yesVmbackuptypeUse the vmbackuptype option with the backup VM, query VM, orrestore VMcommands to specify the type of virtual machine backup to complete.You can specify a VMware file-level backup, a VMware full VM backup, or aHyper-V full VM backup.Supported ClientsThis option is valid on Windows clients that are installed on either a vStoragebackup server or on a Microsoft Hyper-V system. The server can also define thisoption.Options FilePlace this option in the client options file (dsm.opt), or on the command line.Syntax►►VMBACKUPTypeFUllvmFIleHYPERVFULL►◄ParametersFIleSpecifies a file-level backup is performed.FUllvmSpecifies that a full VM backup is performed. This is the default backup type.HYPERVFULLRequired for Hyper-V systems. Specifies a full virtual machine backup of allvirtual machines that are defined on the Hyper-V host machine.If the vmbackuptype=hypervfull option is specified, most of the other optionsassociated with backing up files from a vStorage backup server are notallowed, or they are ignored (for example: VMCHost, VMCUser, VMCPw,VMBackdir, VMFULLNODELETE).Chapter 11. Processing options 517

ExamplesPerform a file-level virtual-machine backup of vm1.example.com.dsmc backup vm vm1 -VMBACKUPT=FIlePerform a full-VM image backup of virtual machine vm1.example.com andvm2.example.com.dsmc backup vm vm1,vm2 -VMBACKUPT=FUllvmOptions file:VMBACKUPT fullCommand line:dsmc backup vm vm1 -VMBACKUPT=file -vmchost=virtctr-vmcuser=virctr_admin -vmcpw=xxxxxPerform a file-level virtual-machine backup of vm1.example.com using theVMware VirtualCenter machine virtctr.example.com, to the Tivoli StorageManager server, using machine name vm1.dsmc backup vm -VMBACKUPT=file -vmchost=vmsrv1 -vmcuser=root-vmcpw=xxxxxPerform a file-level virtual-machine backup of vm1.example.com andvm2.example.com using the VMware ESX Server machinevmserv1.example.com, to the Tivoli Storage Manager server, using machinenames vm1 and vm2.dsmc backup vm -domain.vmfile=vm1[xxxxxxxx]Perform a file-level virtual-machine backup of vm1 with the IP address ofVM, using the VMware ESX Server machine vmserv1.example.com, totheTivoli Storage Manager server with machine name vm1.dsmc backup vm -VMBACKUPT=full -vmchost=virtctr-vmcuser=virctr_admin -vmcpw=xxxxxPerform a full virtual-machine backup of vm1.example.com using theVMware VirtualCenter machine virtctr.example.com, to the Tivoli StorageManager server, using machine name vm1.dsmc backup vm -VMBACKUPT=hypervfull -vmlist="VM 1,VM 2"Perform a full virtual-machine backup of Hyper-V virtual machines named"VM 1" and "VM 2", to the Tivoli Storage Manager server.VmmcUse the vmmc option to store the VMware backups with a management class otherthan the default management class. This option is only valid ifvmbackuptype=fullvmYou can specify this option with the backup VM command, client options filedsm.opt, or the client option that is set by the server.Supported ClientsThis command is valid for clients that are configured to back up VMwaree orHyper-V virtual machines. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt or dsm.sys), or on the commandline.518 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► VMMC class_name ►◄Parametersclass_nameSpecifies a management class that applies to the VMware backup. If you donot set this option, the default management class of the node is used.ExamplesCommand line:dsmc backup vm "myVirtualMachine" -vmmc=myManagmentClassRuns a backup of the virtual machine named myVirtualMachine and savesit according to myManagmentClass.VmbackvcbtransportUse the vmbackvcbtransport option with the backup VM command to specify thetransport mode to be used with VMware Consolidated Backup (VCB).The vmbackvcbtransport option determines how VCB accesses virtual disk data.Important:v Full VM backup uses the VMware VCB support. Use the vmbackvcbtransportoption to control the transport mode for full VM backups.v File-level backup uses the vStorage for Data Protection APIs, and determines thebest available transport. The vmbackvcbtransport option is not necessary forfile-level backups.Supported ClientsThis option is valid only on supported Windows clients that are installed on avStorage backup server.This option is valid for Windows clients that are configured as a VMware backupserver. The server can also define this option.Options FilePlace this option in the client options file, or on the command line.Syntax►►VMBACKVCBTransportRETRYSANLANHOTadd►◄Chapter 11. Processing options 519

ParametersRETRYAttempt access using the SAN to the virtual machine data from the backupproxy. If the SAN access is not available, try the operation again using theLAN transport. RETRY is the default.SANUse the SAN to access virtual machine data from backup proxy.LANUse the LAN to access virtual machine data from the backup proxy. LANaccess is the same as the Network Block Device (NBD) protocol, which can beset on the VCB vcbmounter command.HOTaddUse the VMWare hotadd transport to access virtual machine data from thebackup proxy. See the VMware document Virtual Machine Backup Guide that isspecific for your version of ESX software for a description of the hotaddtransport and the setup that is required. The Virtual Machine Backup Guide isavailable at http://www.vmware.com.Note: The additional setup that is required to use hotadd transport that isdocumented in VMware documentation is not required for file-level backups.ExamplesOptions file:VMBACKVCBTransport lanCommand line:dsmc backup vm vmlocal -vmbackuptype=fullvm -vmbackvcbtransport=lanRelated reference:“Vmbackuptype” on page 517VmchostUse the vmchost option with the backup VM, restore VM, orquery VMcommands to specify the host name of the VMware VirtualCenter or ESX serverthat you want to backup, restore, or query.Use the VirtualCenter if it is available. If you cannot use a VirtualCenter server andyou need to perform backups of multiple systems on multiple ESX servers, do notspecify this option, but instead specify the option with the command so that it canbe varied for each ESX server.Supported ClientsThis command is valid for clients that are configured to perform an off-hostbackup of a VMware virtual machine. The server can also define this option.This option is not supported for Hyper-V backups.Options FilePlace this option in the client options file (dsm.opt), or on the command line.520 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► VMCHost hostname ►◄ParametershostnameSpecifies the host name of the VMware VirtualCenter or ESX server that youwant to backup, restore, or query.ExamplesOptions file:VMCH vcenter.storage.usca.example.comCommand line:-VMCH=esx1.storage.usca.example.comVmcpwUse the vmcpw option with the backup VM, restore VM, orquery VM commandsto specify the password for the VMware VirtualCenter or the ESX user ID that isspecified with the vmcuser option.Use the VirtualCenter if it is available. If you cannot use a VirtualCenter server andyou need to perform backups of multiple systems on multiple ESX servers, do notspecify this option, but instead specify the option with the command so that it canbe varied for each ESX server.Supported ClientsThis option is valid only on supported Windows clients that are installed on avStorage backup server that is used to backup a VMware virtual machine. Thisoption is not valid for Hyper-V backups.Options FilePlace this option in the client options file (dsm.opt), or on the command line.Putting the password in the client options file is a security risk because the file isnot encrypted. Use the client preferences editor to save the encrypted passwordlocally:1. Click Edit > Client Preferences > Authorization > Save encryption keypassword locally.2. Click Edit > Client Preferences > VM Backup. InthePassword field, type thepassword that you want to have saved and encrypted.3. Click OK.As an alternative to the preferences editor, you store the password locally andencrypted, by using the set password command. For example:dsmc SET PASSWORD -type=vmvcenter.us.ibm.com Administrator secretChapter 11. Processing options 521

Syntax►► VMCPw pwname ►◄ParameterspwnameSpecifies the password for the VMware VirtualCenter or ESX server that youwant to backup, restore, or query.ExamplesOptions file:VMCPw SECRETCommand line:-VMCPw=SECRETRelated reference:“Set Password” on page 666VmctlmcThis option specifies the management class to use when backing up VMwarecontrol files. The management class that you specify here overrides the defaultmanagement class, which would otherwise be used to store control files during aVMware backup.To optimize full VM incremental backup and file recovery using Tivoli DataProtection for VMware, control files should be stored in a disk-based storage poolon the Tivoli Storage Manager server. The management class you specify can allowsmaller control files to be stored in a different storage pool than the larger datafiles that are part of a VMware backup.VmcuserUse the vmcuser option with the backup VM, restore VM, orquery VMcommands to specify the user name of the VMware VirtualCenter or ESX serverthat you want to backup, restore, or query.Use the VirtualCenter if it is available. If you cannot use a VirtualCenter server andyou need to perform backups of multiple systems on multiple ESX servers, do notspecify this option, but instead specify the option with the command so that it canbe varied for each ESX server.Supported ClientsThis option is valid for clients that are configured as to perform an off-host backupof VMware virtual machines. The server can also define this option.This option is not valid for Hyper-V backups.Options FilePlace this option in the client options file (dsm.opt), or on the command line.522 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► VMCUser username ►◄ParametersusernameSpecifies the user name of the VMware VirtualCenter or ESX server that youwant to backup, restore, or query.When working with a virtual center, a user id with access to the Windowssystem hosting the virtual center is required. This user id must either haveadministrator privileges, or the minimum privileges identified in the followingtechnote: https://www.ibm.com/support/docview.wss?uid=swg21497028ExamplesOptions file:VMCUser administratorCommand line:backup vm -VMCUser=domainname\administratorCommand line:Example of connecting to an ESX server:backup vm -VMCUser=root||||||||||||||||||||||VmenabletemplatebackupsThe vmenabletemplatebackups option specifies whether the client backs upVMware template virtual machines when it protects virtual machines in a vCenterserver. VMware templates virtual machines cannot be backed up when they are inan ESXi host because ESXi does not support templates.When this option is enabled (VMENABLETEMPLATEBACKUPS YES), you can includeVMware template machines in full VM backup operations. You use the existingBackup VM command and the DOMAIN.VMFULL option to specify the virtualmachines to include in the backup operation.Incremental backups are not supported and snapshots are not taken, so you mustuse MODE=FULL or MODE=IFFULL. Use MODE=IFFULL to force a new backup of VMwaretemplate virtual machines, even if they have not changed since the last backup.When VMTEMPLATESBACKUP is enabled, any backup process that is initiated usingMODE=INCREMENTAL is performed using MODE=FULL. Likewise, any backup processinitiated using MODE=IFINCREMENTAL is processed using MODE=IFFULL. VMwaretemplate VMs are included in a backup only if they have changed since the lastbackup occurred.With this option enabled, make sure that the VMVSTORTRANSPORT options includeNBDSSL or NBD. Using only the SAN or HOTADD transport modes with this optionenabled causes backups of the template machines to fail.Supported clientsThis option can be used with supported Windows clients.Chapter 11. Processing options 523

||||||Options fileYou can set this option on the command line, in the client options file (dsm.opt), oron the server in a client options set.You can also set it in the preferences editor on the VM Backup tab (select theBackup virtual machine templates option).Syntax||►►VMENABLETEMPLATEBACKUPSNoYes►◄|||||||||||||||||||||||||||||||ParametersNo Specifies that template virtual machines are not included in full VM backupoperations; this is the default setting.YesSpecifies that template VMs are included in full VM backup operations.ExamplesOptions fileENABLEVMTEMPLATEBACKUPS YESCommand lineBack up a VMware template VMdsmc backup vm vmnamewhere vmname is the template machine name.Command lineRestore a VMware template VM to the same location and namedsmc restore vm vmnamewhere vmname is the template machine name.Command lineRestore a template virtual machine to a new locationdsmc restore vm vmname -vmname=win7x64-datastore=datastore22 -host=supersht.labx.com-datacenter="Lab Center"where vmname is the template machine name. “win7x64” is the newtemplate VM name. The new datacenter, host, and datastore are alsoincluded.Related reference:“Backup VM” on page 562“Restore VM” on page 647“Domain.vmfull” on page 348VmlimitperdatastoreThe vmlimitperdatastore specifies the maximum number of virtual machines in adata store that can be included in a parallel backup operation.524 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||This option works together with the vmmaxparallel and vmlimitperhost options tooptimize the performance of parallel backups, and to reduce the processor loadthat parallel backs can create on a host in the vSphere infrastructure.Supported clientsThis option can be used with supported Windows clients.Options fileThis option is valid in the client options file (dsm.opt) or on the command line forBackup VM. It can also be included on the server in a client options set. It cannotbe set in the Preferences Editor.Syntax||►►VMLIMITPERDatastore0integer►◄||||||||||||||||||||||||||||ParametersintegerSpecifies the maximum number of virtual machines in any one data store, thatare included during a parallel backup operation. The maximum that you canspecify is 50 VMs. The default is 0 (zero).Specifying 0 means that you are not concerned about how many VMs can bebacked up in parallel from a data store. Instead, you want to limit themaximum number of VMs to include in a parallel backup by using the valuethat you specify on the vmmaxparallel option. The vmlimitperdatastore optionis enforced even when virtual machine data exists in two or more data stores.Adjust the values of vmmaxparallel, vmlimitperhost, and vmlimitperdatastoreto find the values that provide optimal performance for parallel backups, inyour environment.ExamplesOptions fileVMLIMITPERD 5Related reference:“Backup VM” on page 562“Domain.vmfull” on page 348“Vmmaxparallel” on page 527“Vmlimitperhost”VmlimitperhostThe vmlimitperhost specifies the maximum number of virtual machines in an ESXserver that can be included in a parallel backup operation.This option works together with the vmmaxparallel and vmlimitperdatastoreoptions to optimize the performance of parallel backups, and to reduce theprocessor load that parallel backs can create on a host in the vSphereinfrastructure.Chapter 11. Processing options 525

|||||||Supported clientsThis option can be used with supported Windows clients.Options fileThis option is valid in the client options file (dsm.opt) or on the command line forBackup VM. It can also be included on the server in a client options set. It cannotbe set in the Preferences Editor.Syntax||►►VMLIMITPERHost0integer►◄||||||||||||||||||||ParametersintegerSpecifies the maximum number of virtual machines in any one ESX server, thatcan be included in a parallel backup operation. The maximum that you canspecify is 50 VMs. The default is 0 (zero).Specifying 0 means that you are not concerned about how many VMs can bebacked up in parallel from an ESX server. Instead, you want to limit themaximum number of VMs to include in a parallel backup by using the limityou specify on the vmmaxparallel option.Adjust the values of vmmaxparallel, vmlimitperhost, and vmlimitperdatastoreto find the values that provide optimal performance for parallel backups, inyour environment.ExamplesOptions fileVMLIMITPERH 5Related reference:“Backup VM” on page 562“Domain.vmfull” on page 348“Vmmaxparallel” on page 527“Vmlimitperhost” on page 525VmlistUse the vmlist option with the backup VM, query VM, orrestore VM commandsto specify the host name or list of host names of the virtual machine to back up.This option is only valid for Hyper-V backups.Multiple values can be specified (see the following examples).Supported Clients||This option is valid for Windows clients that are installed on a Hyper-V hostserver. The server can also define this option.526 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Options FilePlace this option in the client options file (dsm.opt), or on the command line.Syntax►► VMList vmname[tsmnodename]►◄ParametersvmnameSpecifies the virtual machine name to back up or a list of virtual machinenames.tsmnodenameThis optional parameter can be used in situations where the name of thevirtual machine and Tivoli Storage Manager node name do not match, orwhere DNS name resolution is not available. The option defaults to thehostname portion of the value specified with vmname.ExamplesOptions file:VMList vm1,vm2,vm3VMList vm3.domain.com,vm8.domain.comVMList 9.22.100.85[vm4],9.22.100.90[vm5]VMList 9.22.100.99,9.22.100.101VMList vm3[tsmnodeX]Command line:-VMList=vm1,vm2,9.88.200.4Command line:-vmlist=’myvm1 - 2k8 x64,myvm2 - SLES10 sp2,almadenvm1_win vista’Command line:-vmlist="myvm1 - 2k8 x64,myvm2 - SLES10 sp2,almadenvm1_win vista"Command line:dsmc backup vm -vmbackuptype=HYPERVFULL -vmlist="vm1,vm2,vm3"|||||||||||VmmaxparallelThis option is used to configure parallel backups of several virtual machines, usinga single instance of the backup-archive client. The vmmaxparallel option specifiesthe maximum number of virtual machines that can be backed up to the server, atany one time.This option works together with the vmlimitperhost and vmlimitperdatastoreoptions to optimize the performance of parallel backups, and to reduce theprocessor load that parallel backs can create on a host in the vSphereinfrastructure.Supported clientsThis option can be used with supported Windows clients.Chapter 11. Processing options 527

|||||Options fileThis option is valid in the client options file (dsm.opt) or on the command line forBackup VM. It can also be included on the server in a client options set. It cannotbe set in the Preferences Editor.Syntax||►►VMMAXParallel1integer►◄|||||||||||||||||||||||||||||ParametersintegerSpecifies the maximum number of virtual machines that can be backed up, atany one time, during a parallel backup operation. The default is 1. Themaximum is 50.Adjust the values of vmmaxparallel, vmlimitperhost, and vmlimitperdatastoreto find the values that provide optimal performance for parallel backups, inyour environment.Note: when using client side deduplication, a deduplication session is startedfor each VM. This deduplication session is not counted as one of thevmmaxparallel sessions.The MAXNUMMP server parameter specifies the maximum number of mountpoints a node is allowed to use on the server when the copy destination of thestorage pool is FILE or TAPE. MAXNUMMP must be equal to or greater than theVMMAXPARALLELsetting. When multiple instances of the client are backing upfiles, or when a single client performs parallel backups, additional mountpoints might be needed. If the number of mount points requested exceeds theMAXNUMMP value, the server issues an error (ANS0266I). In response to the error,the client reduces VMMAXPARALLEL to match the number specified by MAXNUMMPand continues the backup with the reduced number of sessions. If additionalANS0266I errors are detected, the client reduces VMMAXPARALLEL by 1 andattempts to continue the backup. If VMMAXPARALLEL is decremented to 1 and theclient receives more ANS0266I errors, the client ends the backup and issues thefollowing error:ANS5228E A backup VM operation failed because VMMAXPARALLEL wasreduced to 1 and the client still cannot obtain a server mount point.ExamplesOptions fileVMMAXP 10528 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||Related reference:“Backup VM” on page 562“Domain.vmfull” on page 348“Vmlimitperhost” on page 525“Vmlimitperdatastore” on page 524VmprocessvmwithindependentUse this option to control whether full VMware virtual machine backups areprocessed if the machine is provisioned with one or more independent diskvolumes.Independent disk volumes do not support snapshots. Any independent diskvolumes found on a virtual machine are not be processed as part of the backupoperation. When the virtual machine is restored, Tivoli Storage Manager recoversthe virtual machine, and only the volumes that participated in snapshot operationsare restored. Configuration information and content of the independent diskvolumes is not preserved in the information stored on the Tivoli Storage Managerserver. Users must recreate the independent disk volumes on the restored machine.If the virtual machine also contains one or more raw device mapping (RDM)volumes configured in physical-compatibility mode (pRDM), use thevmprocessvmwithprdm option to control whether the client backs up any files on thevirtual machine if an independent disk is present.This option is only valid for VMware backups and does not pertain to MicrosoftHyper-V backups.Supported ClientsThis option is valid for Windows and Linux clients that are configured as aVMware backup server. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt) or on the command-lineSyntax►►VMPROCESSVMWITHINDEPENDENTNOYES►◄ParametersNoYesThe backup of the virtual machine fails if one or more independent diskvolumes are detected. No is the default.Virtual machines that contain one or more independent disk volumes arebacked-up. However, the independent disk volumes are not be processed aspart of the virtual machine backup operation.If the virtual machine also contains one or more raw device mapping (RDM)disks that are provisioned in physical-compatibility mode, theVMPROCESSVMWITHPRDM option must also be specified.Chapter 11. Processing options 529

ExamplesOption file:VMPROCESSVMWITHINDEPENDENT YesCommand line:dsmc backup vm vmlocal -vmbackuptype=fullvm -vmprocessvmwithindependent=yesRelated information“Vmprocessvmwithprdm”VmprocessvmwithprdmUse this option to control whether full VMware virtual machine backups areprocessed if the virtual machine has one or more raw device mapping (RDM)volumes provisioned in physical-compatibility mode (pRDM).pRDM volumes do not support snapshots. Any pRDM volumes found on a virtualmachine are not processed as part of the backup operation. When the virtualmachine is restored, Tivoli Storage Manager recovers the virtual machine, and onlythe volumes that participated in snapshot operations are restored. Configurationinformation and content of the pRDM volumes is not preserved in the informationstored on the Tivoli Storage Manager server. Users must re-create the pRDMvolumes on the restored machine.This option does not apply to virtual machines that have one or more RDMvolumes that are provisioned in virtual-compatibility mode (vRDM). BecausevRDM volumes do support snapshot operations, they are included in a fullVMware virtual machine backup.If the virtual machine also contains one or more independent disks, use thevmprocessvmwithindependent option to control whether the client backs up anyfiles on the virtual machine if an independent disk is present.This option is only valid for VMware backups and does not pertain to MicrosoftHyper-V backups.Supported ClientsThis option is valid for Windows and Linux clients that are configured as aVMware backup server. The server can also define this option.Options FilePlace this option in the client options file (dsm.opt) or on the command lineSyntax►►VMPROCESSVMWITHPRDMNOYES►◄ParametersNoThe backup of the virtual machine fails if one or more pRDM volumes aredetected. No is the default.530 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

YesVirtual machines that contain one or more raw device mapping (RDM)volumes that are provisioned in physical-compatibility mode (pRDM) arebacked up. However, the pRDM volumes are not processed as part of thevirtual machine backup operation.If the virtual machine also contains one or more independent disks, theVMPROCESSVMWITHINDEPENDENTDISK option must also be specified.ExamplesOption file:VMPROCESSVMWITHPRDM YesCommand line:dsmc backup vm vmlocal -vmbackuptype=fullvm -vmprocessvmwithprdm=yesRelated information“Vmprocessvmwithindependent” on page 529VmvstortransportThe vmvstortransport option specifies the preferred transports order (hierarchy) touse when backing up or restoring VMware virtual machines. If you do not includea given transport using this option, that transport is excluded and is not used totransfer data.The transport order that you specify determines how the VMware API for DataProtection (VADP) accesses virtual disk data, but it does not influence the datapath that is used between the Tivoli Storage Manager client and the Tivoli StorageManager server. Valid transports include any order or combination of the followingoptions:nbd Network based data transfer. Access virtual disk data using the LAN. Thistransport path is generally available in all configurations.nbdssl Same as nbd, but the data is encrypted before being sent over the LAN.Encryption can decrease performance.san Storage Area Network transfer: Access virtual disk data using the SAN.hotadd If you use the Backup-Archive Client in a virtual machine, the hotaddtransport allows the transport of backed up data to dynamically addedstorage.Separate each transport option from the others with a colon, for example,san:nbd:nbdssl:hotadd.If you do not specify a transport hierarchy, the default transport selection order issan:hotadd:nbdssl:nbd.The first transport that is available is used to transfer the data. If you want toprevent data transport over a particular path, do not include it in the transport list.For example, if it is important to not disrupt LAN traffic, omit the nbd transportsfrom the hierarchy.Set this option in the client options file (dsm.opt).Chapter 11. Processing options 531

Supported clientsThis option is valid for Windows clients that are configured to back up or restorevirtual machine files using VADP.ExamplesIf the SAN is not available, do not transport backups or restores over the LANVMVSTORTRANSPORT sanThe Backup-Archive Client is running in a virtual machine, but do not use thehotadd transportVMVSTORTRANSPORT nbdssl:nbdUse the LAN transport, even if nbdssl is available, to obtain better performanceVMVSTORTRANSPORT nbdThe SAN transport is preferred, but use nbd when the SAN is not available, anddo not use nbdssl or hotaddVMVSTORTRANSPORT san:nbdVssusesystemproviderThe vssusesystemprovider option specifies whether to use the Windows systemprovider, or to let Windows decide the most suitable provider to use.Use the vssusesystemprovider option for Microsoft Windows Volume ShadowCopy Service (VSS) operations, such as system state backup or Tivoli StorageManager for Copy Services backups.Supported ClientsThis option is valid for all Windows clients. The server can also define this option.The Tivoli Storage Manager client API does not support this option.Options FilePlace this option in the client options file (dsm.opt).Syntax►►VSSUSESYSTEMProviderNoYes►◄ParametersYesSpecifies that the Microsoft Windows VSS system provider is used.No Specifies that the default system provider is used. This provider might ormight not be the same as the system provider, depending on what otherproviders are installed on the system. Use no if you want to use the defaultsystem provider and the default system provider is not the Microsoft WindowsVSS provider. No is the default.532 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExamplesOptions file:vssusesystemprovider yesCommand line:Does not apply.|||||||||||||||||||VmtimeoutVMTIMEOut specifies the maximum time, in seconds, to wait before abandoning abackup vm operation, when the INCLUDE.VMTSMVSS option is used to provideapplication protection. You must have an IBM ® Tivoli ® Storage Manager for VirtualEnvironments license installed to use this option.Each backup vm operation that is performed on a virtual machine that is protectedby a INCLUDE.VMTSMVSS option is subject to a timer. The timer value determineshow many seconds the client should wait for the application to quiesce activityand truncate its logs so the backup can be performed. The default time out value issufficient for most environments. However, if your application data cannot bebacked up because the application needs additional time to prepare for thesnapshot, you can increase the time out value. This timer applies only to backupvm operations when the INCLUDE.VMTSMVSS option is set for a virtual machine.Supported clientsThis option can be used with supported Windows clients.Options filePlace this option in the client options file. It cannot be set on the command line orin the Preferences editor.Syntax||►►VMTIMEout180time_out►◄|||||||||||Parameterstime_outSpecifies the time to allow, in seconds, for backup operations to complete whena virtual machine is protected by the application protection option,INCLUDE.VMTSMVSS. The value specified must be an integer between 180 and500. The default is 180 seconds.ExamplesOptions fileVMTIMEout 500Command lineNot applicable; this option cannot be set on the command line.Chapter 11. Processing options 533

||Related reference:“INCLUDE.VMTSMVSS” on page 403WebportsThe webports option enables the use of the Web client outside a firewall.The webports option enables the use of the Web client outside a firewall byspecifying the TCP/IP port number used by the Tivoli Storage Manager clientacceptor service and Web Client Agent service for communications with the Webclient.Values for both the client acceptor service and the Web Client Agent service arerequired.If you do not specify this option, the default value, zero (0), is used for both ports.This causes TCP/IP to randomly assign a free port number for the client acceptorservice and the Web Client Agent service. The port value TCP/IP assigns is in therange of 1024 through 5000.Supported ClientsThis option is valid for all clients. The Tivoli Storage Manager client API does notsupport this option.Options FilePlace this option in the client options file (dsm.opt). To set this option in the ClientPreferences editor, click Edit > Client Preferences > Web Client , and specify theports in the Web Agent Port and Web CAD Port fields.Syntax►► WEBPorts cadport agentport ►◄ParameterscadportSpecifies the required Tivoli Storage Manager client acceptor service portnumber. The range of values is 1000 through 32767. If a value is not specified,the default, zero (0), causes TCP/IP to randomly assign a free port number.agentportSpecifies the required Tivoli Storage Manager Web client agent service portnumber. The range of values is 1000 through 32767. If a value is not specified,the default, zero (0), causes TCP/IP to randomly assign a free port number.ExamplesOptions file:webports 2123 2124Command line:webports 2123, 2124534 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Chapter 12. Using commandsTivoli Storage Manager provides a command-line interface (CLI) that you can useas an alternative to the graphical user interface (GUI). This topic describes how tostart or end a client command session and how to enter commands.The following is a list of tasks related to entering commands.v “Start and end a client command session” on page 538v “Enter client command names, options, and parameters” on page 539v “Wildcard characters” on page 542The following table provides an alphabetical list of the commands and a briefdescription.Table 65. CommandsCommandarchive “Archive” on page 543archive fastback “ArchiveFastBack” on page 546backup fastback “BackupFastBack” on page 549backup group “Backup Group”on page 551backup image “Backup Image”on page 554backup nas “Backup NAS” onpage 558backup systemstate “BackupSystemstate” on page 560backup vm “Backup VM” onpage 562cancel process “CancelProcess” on page 568cancel restore “Cancel Restore”on page 568delete access “Delete Access”on page 569DescriptionArchives files from a workstation to Tivoli StorageManager storage.Archives volumes specified by the fbpolicyname,fbclientname and fbvolumename options for long termretention.Backs up volumes specified by the fbpolicyname,fbclientname and fbvolumename options for long termretention.Creates and backs up a group containing a list of filesfrom one or more file space origins to a virtual file spaceon the Tivoli Storage Manager server.Creates an image backup of one or more file systems orlogical volumes that you specify.Creates an image backup of one or more file systemsbelonging to a Network Attached Storage (NAS) fileserver.Backs up all startable system state and system servicescomponents as one object to provide a consistentpoint-in-time snapshot of the system state. This commandis valid for any supported Windows client.Backs up virtual machines specified in the vmlist option.Displays a list of current NAS (if NDMP support isenabled) image backup and restore processes for which theadministrative user has authority.Displays a list of restartable restore sessions from whichyou can select one to cancel.Deletes authorization rules for files that are stored on theserver.On those clients that support image backup, this commanddeletes authorization rules for images that are stored onthe server.© Copyright IBM Corp. 1993, 2012 535

Table 65. Commands (continued)CommandDescriptiondelete archive “DeleteArchive” on page 570delete backup “DeleteBackup” on page 571delete filespace “DeleteFilespace” on page 574delete group “Delete Group”on page 575expire “Expire” on page 577help “Help” on page 578incremental “Incremental” onpage 579loop “Loop” on page 587macro “Macro” on page 588monitor process “MonitorProcess” on page 589preview archive “PreviewArchive” on page 589preview backup “PreviewBackup” on page 590query access “Query Access”on page 591query adobjects “QueryAdobjects” on page 592query archive “Query Archive”on page 594query backup “Query Backup”on page 596query backupset “QueryBackupset” on page 599query filespace “QueryFilespace” on page 603query group “Query Group”on page 605query image “Query Image”on page 606query inclexcl “QueryInclexcl” on page 608Deletes archived files from Tivoli Storage Manager serverstorage.Deletes active and inactive backup files from TivoliStorage Manager server storage.Deletes file spaces in Tivoli Storage Manager serverstorage.Deletes a group backup on the Tivoli Storage Managerserver.Inactivates backup objects that you specify in the filespecification or with the filelist option.Displays a Table of Contents of help topics for thecommand-line client.Backs up all new or changed files or directories in thedefault client domain or from file systems, directories, orfiles you specify, unless you exclude them from backupservices.Starts an interactive command session.Executes commands within a macro file that you specify.Displays a list of current NAS image backup and restoreprocesses from which you can select one to cancel.Simulates an archive command without sending data tothe server.Simulates a backup command without sending data to theserver.Displays a list of current authorization rules.Displays a list of current authorization rules.Displays a list of archived files.Displays a list of backup versions.Queries a backup set from a local file or the Tivoli StorageManager server. On those clients that support tapedevices, this command can query a backup set from a tapedevice.Displays a list of file spaces in Tivoli Storage Managerstorage. You can also specify a single file space name toquery.Displays information about group backups and theirmembers.Displays information about image backups.Displays a list of include-exclude statements in the orderin which they are processed during backup and archiveoperations.536 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 65. Commands (continued)CommandDescriptionquery mgmtclass “Query Displays information about available management classes.Mgmtclass” on page 609query node “Query Node” onpage 610query options “QueryOptions” on page 611query restore “Query Restore”on page 612query schedule “QuerySchedule” on page 613query session “Query Session”on page 613query systeminfo “QuerySysteminfo” on page 614query systemstate “QuerySystemstate” on page 616query vm “Query VM” onpage 617restart restore “RestartRestore” on page 621restore “Restore” on page 622restore adobjects “RestoreAdobjects” on page 629restore backupset “RestoreBackupset” on page 631restore group “Restore Group”on page 638restore image “Restore Image”on page 640restore nas “Restore NAS” onpage 643restore systemstate “RestoreSystemstate” on page 645restore vm “Restore VM” onpage 647retrieve “Retrieve” on page 652schedule “Schedule” on page656selective “Selective” on page658Displays all the nodes for which an administrative user IDhas authority to perform operations.Displays all or part of your options and their currentsettings.Displays a list of your restartable restore sessions in theserver database.Displays information about scheduled events for yournode.Displays information about your session, including thecurrent node name, when the session was established,server information, and server connection information.Gathers Tivoli Storage Manager system information andoutputs this information to a file or the console.Displays information about the backup of the system stateon the Tivoli Storage Manager server. This command isvalid for all supported Windows clients.Verifies the successful backups of the virtual machinesfrom the vStorage backup server.Displays a list of restartable restore sessions from whichyou can one to restart.Restores copies of backup versions of your files from aTivoli Storage Manager server.Restores individual Active Directory objects from the localActive Directory Deleted Objects container.Restores a backup set from the Tivoli Storage Managerserver or a local file. On those clients that support tapedevices, this command can restore a backup set from atape device.Restores specific members or all members of a groupbackup.Restores a file system or raw volume image backup.Restores the image of a file system belonging to aNetwork Attached Storage (NAS) file server.Restores a backup of the system state. This command isvalid for all supported Windows clients.Restores a full VM backup, and returns the full VMbackup files to the vmbackdir directory on the vStoragebackup server.Retrieves copies of archived files from the Tivoli StorageManager server.Starts the client scheduler on the workstation.Backs up selected files.Chapter 12. Using commands 537

Table 65. Commands (continued)Commandset access “Set Access” on page661DescriptionAuthorizes another user to access your backup versions orarchived copies.On those clients that support image backup, this commandcan set authorization rules for images that are stored onthe server.set event “Set Event” on page664set password “Set Password”on page 666Allows you to specify the circumstances for when archiveddata is deleted.Changes the Tivoli Storage Manager password for yourworkstation.For proper operation, the was node must be restored to the same location andunder the same name.Important: To avoid problems, restore your data at the Network DeploymentManager node or Application Server node level only.Related information:Reading syntax diagramsStart and end a client command sessionYou can start or end a client command session in either batch mode or interactivemode.Use batch mode when you want to enter a single client command. Tivoli StorageManager processes the command and returns to the command prompt.Use interactive mode when you want to enter a series of commands. Since TivoliStorage Manager establishes connection to the server only once for interactivemode, a series of commands can be processed more quickly. Tivoli StorageManager processes the commands and returns to the tsm> prompt.Process commands in batch modeSome options are valid only on the initial command line and not in interactivemode. These options generally affect the operation of the entire session.For example, the command dsmc query session -errorlogname=myerror.log isaccepted and it does name the error log. However, it is accepted simply because itappears in the initial command, even though the option is not valid for the querycommand.There are also some options that are always valid on the initial command line aswell as on individual commands in interactive mode. Therefore, certain options areaccepted on the initial command line even though they have no effect on thecommand being entered. For example, dsmc query session -subdir=yes is a validcommand, but in this case the -subdir option has no effect on the command thatwas entered.When you enter a single command in batch mode, precede it with the executableprogram name, dsmc. For example, to process the incremental command in batchmode, you would enter:538 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

dsmc incrementalTivoli Storage Manager prompts you each time you enter a command if thepasswordaccess option is set to prompt and authentication on the server is set toOn. Type your password and press Enter.You can also enter your password using the password option with a command, butyour password appears on the screen. For example, if your password is secret,enter:dsmc incremental –password=secretIf you set the passwordaccess option to generate in your dsm.opt file, you do notneed to specify the password with the command. Tivoli Storage Manager onlyprompts you for your password if you are registering your workstation with aserver or manually changing your password.Related concepts:Chapter 11, “Processing options,” on page 267Process commands in interactive modeUse the interactive mode (or loop mode) to enter a series of commands.Enter dsmc on the command line and press Enter. When the tsm> commandprompt appears, type the command name and press Enter. Do not precede eachcommand with the executable program name, dsmc. Alternatively, you can enterdsmc loop on the command line to start a client command session in interactivemode. Loop is the default command for dsmc.If a password is required, Tivoli Storage Manager prompts you before you enterthe first command.Type your password and press Enter.You can also enter your password using the password option with the loopcommand, but your password appears on the screen. For example, if yourpassword is secret, enter:dsmc loop –password=secretTo end an interactive session, enter quit at the prompt.Enter client command names, options, and parametersA client command can include one or more of these components: Command name,options, and parameters. The topics that follow describe each of these components.Command nameThe first part of a command is the command name. The command name consistsof a single word, such as help or schedule, or an action word and an object forthat action, such as query archive.Enter the full command name, or its minimum abbreviation.For example, you can enter any of the following versions of the query schedulecommand:Chapter 12. Using commands 539

query scheduleqscq schedquery scOptionsWhen you enter options with a command, always precede the option with a dash(–). Do not put a space between the dash and the option name.Enter more than one option in any order in a command before or after the filespecification. Separate multiple options with a blank space.There are two groups of options that you can use with commands: Client options(set in your options file), or client command options (used on the command line).vClient options: The group of options that are set in your client options file. Youcan override an option in the client options file when you enter the option witha command on the command line.v Client command options: Use a client command option only when you enter theoption with a command on the command line. You cannot set these options inan options file.Related concepts:“Client options reference” on page 294Options in interactive modeIn interactive mode, options that you enter on the initial command line overridethe value that you specified in your options file.This value remains in effect for the entire interactive session unless overridden bya different value on a given interactive command.For example, if you set the subdir option to yes in your dsm.opt file, and youspecify subdir=no on the initial command line, the subdir=no setting remains ineffect for the entire interactive session unless overridden by the subdir=yes valueon a given interactive command. However, the subdir=yes value specified withinthe interactive session only affects the command on which it is entered. When thatcommand completes, the value reverts back to subdir=no, the value at thebeginning of the interactive session.ParametersCommands can have required parameters, optional parameters, or no parametersat all.Required parameters provide information to perform a task. The most commonlyrequired parameter is a file specification.For example, if you want to archive a file named budget.fin from the projectdirectory, you would enter the following:dsmc archive c:\project\budget.finSome commands have optional parameters. If you do not enter a value for anoptional parameter, Tivoli Storage Manager uses the default value. For example,the restore command includes a required parameter, sourcefilespec, that specifiesthe path and file name in storage that you want to restore. The optional parameter,destinationfilespec, specifies the path where you want to place the restored files.540 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If you do not specify the destinationfilespec, by default Tivoli Storage Managerrestores the files to the original source path. If you want to restore the files to adifferent directory, enter a value for destinationfilespec.Example: Restore the file c:\project\budget.fin to the new pathc:\newproj\newbudg.findsmc restore c:\project\budget.fin c:\newproj\newbudg.finEnter parameters in the order indicated in the command syntax diagram.File specification syntaxThere are some syntax rules that you need to know about when entering filespecification parameters, such as filespec, sourcefilespec, anddestinationfilespec.The following are the syntax rules:v Do not use wildcards as part of the file space name or anywhere in thedestinationfilespec. The one exception to this rule is the set access commandwhere wildcards are permitted in the two lowest levels of the file spec.vvvvExample: Allow access to all files in all directories in and below the d:\testdirectory:set access backup d:\test\* * *set access backup d:\test\*\* * *There is a maximum number of file specifications per command:– The Query commands can accept only one file specification.– The restore and retrieve commands can accept a source file specification anda destination file specification.The length of a file specification is limited.– The maximum number of bytes for a file name and file path combined is6255. However, the file name itself cannot exceed 255 bytes Furthermore,directory names (including the directory delimiter) within a path are limitedto 255 bytes. The Unicode representation of a character can occupy severalbytes, so the maximum number of characters that a file name might containcan vary.When using the open file support feature with VSS, the Tivoli StorageManager client adds the snapshot volume name to the path of the objectsbeing processed. The resulting path (snapshot volume name plus object path)must adhere to the limits above. The snapshot volume name can be up to1024 bytes.When entering the sourcefilespec, if the directory name ends with \, then \* isimplied.When entering a destinationfilespec, if the name ends with /, then it isconsidered a directory, otherwise it is considered a file.The following example illustrates these two rules. Even though mydir andyourdir are directories, the command will fail because /* is implied after mydir,and yourdir is considered a file:restore c:\home\mydir\ c:\away\yourdirThe following example illustrates the second rule. Even though mydir andyourdir are directories, the command will fail because mydir and yourdir areconsidered files:restore c:\home\mydir c:\away\yourdirIf a file specification does not begin with a file space name (an opening directorydelimiter), the file specification is assumed to be a subdirectory of the currentChapter 12. Using commands 541

Wildcard charactersvworking directory. The client appends the destination file specification to theworking directory to build the complete path.For example, if the current working directory is c:\home\me and the command isdsmc res c:\fs\dir1\ mydir\, the complete restore path is this:c:\home\me\mydirWhen the file specification contains spaces, it must be enclosed in quotationmarks. For example:dsmc sel "x:\dir one\file1"However, when the filespec is a directory with a trailing backslash, an extrabackslash (\) must be added. If an extra backslash is not added, the filespec willnot be processed correctly, and the operation might cause unexpected results.The following example is incorrect:dsmc sel "x:\dir one\"The following example is correct:dsmc sel "x:\dir one\\"Here is an example of restoring the contents of one directory to another, whenboth directories contain spaces:dsmc rest "x:\dir one\\" "x:\dir two\\"v Microsoft Dfs volumes are accessed using the standard UNC names. Thefollowing are examples of valid syntax to access MS Dfs volumes:\\Server_Name\Dfs_Root_Name\path\\Fault_Tolerant_Name\Dfs_Root_Name\pathRelated reference:“Filelist” on page 380Use wildcard characters when you want to specify multiple files with similarnames in one command. Without wildcard characters, you must repeat thecommand for each file.In a command, you can use wildcard characters in the file name or file extensiononly. You cannot use them to specify destination files, file systems, or server names.You cannot specify a directory whose name contains an asterisk (*) or a questionmark (?).Valid wildcard characters that you can use include:* Asterisk. Matches zero or more characters.? Question mark. Matches any single character at the present position.The following table shows examples of each wildcard.Table 66. Wildcard charactersPattern Matches Does not matchAsterisk (*)ab* ab, abb, abxxx a, b, aa, bbab*rs abrs, abtrs, abrsrs ars, aabrs, abrssab*ef*rs abefrs, abefghrs abefr, abersabcd.* abcd.c, abcd.txt abcd, abcdc, abcdtxtQuestion Mark (?)542 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 66. Wildcard characters (continued)Pattern Matches Does not matchab? abc ab, abab, abzzzab?rs abfrs abrs, abllrsab?ef?rs abdefjrs abefrs, abdefrs, abefjrsab??rs abcdrs, abzzrs abrs, abjrs, abkkkrsClient commands referenceArchiveImportant: Use an asterisk (*) instead of a question mark (?) as a wildcardcharacter when trying to match a pattern on a multibyte code page, to avoidunexpected results.The following sections contain detailed information about each of the TivoliStorage Manager commands.Information for each command includes the following information:v A description of the command.v A syntax diagram of the command.v Detailed descriptions of the command parameters. If the parameter is a constant(a value that does not change), the minimum abbreviation appears in uppercaseletters.v Examples of using the command.The archive command archives a single file, selected files, or all files in a directoryand its subdirectories on a server.Archive files that you want to preserve in their current condition. To releasestorage space on your workstation, delete files as you archive them using thedeletefiles option. Retrieve the archived files to your workstation whenever youneed them again.Use the snapshotroot option with the archive command in conjunction with aindependent software vendor application that provides a snapshot of a logicalvolume, to associate the data on the local snapshot with the real file space datathat is stored on the Tivoli Storage Manager server. The snapshotroot option doesnot provide any facilities to take a volume snapshot, only to manage data createdby a volume snapshot.Supported ClientsThis command is valid for all clients.Syntax►► Archive ▼ filespecoptions►◄Chapter 12. Using commands 543

|||||||||||||||||||||||ParametersfilespecSpecifies the path and name of the file you want to archive. Use wildcardcharacters to include a group of files or to include all files in a directory.To include multiple file specifications, separate each filespec with a spacecharacter. If multiple file specifications are included, and two or more of thespecifications have common parent directories, then it is possible for thecommon directory objects to be archived more than once. The conditions underwhich this behavior occurs are runtime dependent, but the behavior itself hasno adverse effects.For example if the filespec is C:\proposals\drafts\ice.docC:\proposals\drafts\fire.doc, then C:\proposals and C:\proposals\draftsmight be archived twice. The file objects ice.doc and fire.doc are archivedonly once.If you want to avoid including the shared parent directory more than once, useseparate, non-overlapping archive commands to archive each file specification.If you archive a file system, include a trailing slash (C:\).You can specify as many file specifications as available resources or otheroperating system limits allow.You can use the filelist option, instead of file specifications, to identifywhich files to include in this operation. However, these two methods aremutually exclusive. You cannot include file specification parameters and usethe filelist option. If the filelist option is specified, any file specificationsthat are included are ignored.Table 67. Archive command: Related optionsOptionWhere to usearchmcCommand line only.autofsrenameClient options file (dsm.opt) only.changingretriesClient options file (dsm.opt) or command line.compressalwaysClient options file (dsm.opt) or command line.compressionClient options file (dsm.opt) or command line.deletefilesCommand line only.descriptionCommand line only.dirsonlyCommand line only.encryptiontypeClient options file (dsm.opt).encryptkeyClient options file (dsm.opt).filelistCommand line only.filesonlyCommand line only.postsnapshotcmdClient options file (dsm.opt) or with the include.fsoption.preservelastaccessdate Client options file (dsm.opt) or command line.presnapshotcmdClient options file (dsm.opt) or with the include.fsoption.skipntpermissionsClient options file (dsm.opt) or command line.skipntsecuritycrcClient options file (dsm.opt) or command line.snapshotrootCommand line only.544 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 67. Archive command: Related options (continued)Optionsubdirtapepromptv2archiveWhere to useClient options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.ExamplesTaskTaskTaskTaskTaskArchive a single file named budget.jan in the c:\plan\proj1 directory.Command: archive c:\plan\proj1\budget.janArchive all files in the c:\plan\proj1 directory with a file extension of.txt.Command: archive c:\plan\proj1\*.txtArchive all files in the c: drive.Command: archive -subdir=yes c:\*.*Archive all files in the Microsoft Dfs volume, MyDfsVolume. You mustspecify subdir=yes to archive all files in the volume.Command: archive \\myserver\mydfsroot\mydfsvolume\*.* -subdir=yesAssuming that you initiated a snapshot of the C: drive and mounted thesnapshot as \\florence\c$\snapshots\snapshot.0, archive thec:\dir1\sub1 directory tree from the local snapshot and manage it on theTivoli Storage Manager server under the file space name C:.Command: dsmc archive c:\dir1\sub1\* -subdir=yes-snapshotroot=\\florence\c$\snapshots\snapshot.0Related information“Configuring Open File Support” on page 70“Include options” on page 395Open file supportIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications.The snapshot allows the archive to be taken from a point-in-time copy thatmatches the file system at the time the snapshot is taken. Subsequent changes tothe file system are not included in the archive. You can set the snapshotproviderfsparameter of the include.fs option to none to specify which drives do not useopen file support.Use VSS as the snapshot provider for open file support.Note:1. You can use the include.fs option to set snapshot options on a per file systembasis.Chapter 12. Using commands 545

Archive FastBack2. Open file support is only available for local fixed volumes (mounted to eitherdrive letters or volume mount points) formatted with NTFS file systems. Thissupport includes SAN-attached volumes that meet these requirements.3. To enable open file support in a cluster environment, all systems in the clustershould have VSS configured.Use the archive fastback command to archive Tivoli Storage Manager FastBackvolumes specified by the fbpolicyname, fbclientname and fbvolumename options forlong-term retention.Before using this command, configure the client to back up and archive TivoliStorage Manager FastBack data. Also, before you issue this command, at least onesnapshot should exist in the Tivoli Storage Manager FastBack repository for theTivoli Storage Manager FastBack policy being archived or backed up.If a policy specification contains both Windows and Linux FastBack clients, onlythe Windows volumes will be backed up or archived to Tivoli Storage Manager bythe Windows Tivoli Storage Manager client.If a policy specification contains both Windows and Linux FastBack clients, onlythe Linux volumes will be backed up or archived to Tivoli Storage Manager by theLinux Tivoli Storage Manager client.You can use Tivoli Storage Manager FastBack options to archive the latestsnapshots of the following volumes:vvvAll clients and volumes associated with a FastBack policy or a list of FastBackpolicies.All volumes associated with a specific FastBack client or a list of FastBack clientsfor a given FastBack policy.A specific volume or volumes associated with a FastBack client for a givenFastBack policy.Supported ClientsThis option is valid for all Windows clients that are configured as Tivoli StorageManager FastBack dedicated proxies. This command is also valid for Windowsclients that are installed on a Tivoli Storage Manager FastBack server workstation,or a Tivoli Storage Manager FastBack Disaster Recovery (DR) Hub.Syntax,►► ARCHIVE FASTBack FBPolicyname = ▼ name FBServer = name ►►,,►FBClientname = ▼ name FBVolumename = ▼ name546 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

►FBReposlocation = name FBBranch = name ARCHMc = name►◄Important:1. At least one FBpolicyName is always required.2. You can specify up to 10 values for FBPolicyName, if no values are specifiedfor both FBClientName and FBVolumeName.3. When you specify a FBClientName value, there must be only one value forFBPolicyName.4. You can specify up to 10 values for FBClientName if only one PolicyName isspecified, and no values for FBVolumeName are specified.5. When you specify the FBVolumeName option, you can have only one FBPolicy,and only one FBCLientName specified.6. You can specify multiple FBVolumeNames if condition 5 is satisfied.7. You must always specify the FBReposLocation option for Linux.ParametersTable 68. Archive FastBack command: Related optionsOptionfbpolicyname“Fbpolicyname” on page374fbserver “Fbserver” onpage 377fbclientname“Fbclientname” on page373fbvolumename“Fbvolumename” on page378fbreposlocation“Fbreposlocation” onpage 376fbbranch “Fbbranch” onpage 372archmc “Archmc” on page295Where to useCommand line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.ExamplesCommand line:The Tivoli Storage Manager is installed on a FastBack server. Use thiscommand to archive all FastBack volumes for all Windows FastBack clientsthat are defined for FastBack policy1:dsmc archive fastback -fbpolicyname=Policy1-fbserver=myfbserverThe repository location is not required. If you provide the repositorylocation, it is ignored.Chapter 12. Using commands 547

The FastBack server name, -myfbserver, is the short host name of theFastBack server where the client is running.Command line:The Tivoli Storage Manager is installed on a FastBack disaster recoveryhub. Use this command to archive all FastBack volumes for all FastBackclients that are found in the policy named Policy 1:dsmc archive fastback -fbpolicyname="Policy 1"-fbserver=myFbServer -fbbranch=branch1The repository location is not required. If you provide the repositorylocation, it is ignored.The parameter myFbServer specifies the short host name of the FastBackServer whose FastBack branch is specified using the FBBranch optionCommand line:The Tivoli Storage Manager client is installed on a dedicated proxymachine with Tivoli Storage Manager FastBack administrative commandline and FastBack mount. The Tivoli Storage Manager client is connectingto a FastBack server repository. Use this command to archive all FastBackvolumes for all FastBack clients that are found in the policy named Policy1:dsmc archive fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPThe repository location is required.The short host name of the machine where the FastBack server is installedis myFbServer.Command line:The Tivoli Storage Manager client is installed on a dedicated proxymachine with Tivoli Storage Manager FastBack administrative commandline and FastBack mount. The Tivoli Storage Manager client is connectingto a remote branch repository on a FastBack disaster recovery hub. Use thiscommand to archive all FastBack volumes for all FastBack clients that arefound in the policy named Policy 1:dsmc archive fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myfbdrhub.company.com\REP-fbbranch=aFbServerBranchThe repository location is required.The myFbServer value specified with the -fbserver option is the short hostname of the FastBack Server whose FastBack branch is specified using theFBBranch option.The fbbranch option specifies the branch ID of the FastBack server on thedisaster recovery hub.Command line:Archive all volumes protected by FastBack policy named policy1 from theFastBack server named basil, and apply management class"my_tsm_mgmt_class" to the archived volumes.dsmc archive fastback -Fbpolicyname=policy1-FBServer=basil -ARCHMC=”my_tsm_mgmt_class”548 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Backup FastBackUse the backup fastback command to back up Tivoli Storage Manager FastBackvolumes specified by the fbpolicyname, fbclientname and fbvolumename options forlong-term retention.Before using this command, configure the client to back up and archive TivoliStorage Manager FastBack data. Also, before you issue this command, at least onesnapshot should exist in the Tivoli Storage Manager FastBack repository for theTivoli Storage Manager FastBack policy being archived or backed up.If a policy specification contains both Windows and Linux FastBack clients, onlythe Windows volumes will be backed up or archived to Tivoli Storage Manager bythe Windows Tivoli Storage Manager client.Tivoli Storage Manager FastBack options are supported for the incremental backupof the latest snapshots, depending on the option specified:vvvAll clients and volumes associated with a Tivoli Storage Manager FastBackpolicy or a list of Tivoli Storage Manager FastBack policies.All volumes associated with a specific FastBack client or a list of FastBack clientsfor a given Tivoli Storage Manager FastBack policy.A specific volume or volumes associated with a FastBack client for a given TivoliStorage Manager FastBack policy.Supported ClientsThis command is valid for all Windows clients that are configured as Tivoli StorageManager FastBack dedicated proxies. This command is also valid for Windowsclients that are installed on a Tivoli Storage Manager FastBack server workstation,or a Tivoli Storage Manager FastBack Disaster Recovery (DR) Hub.Syntax,►► BACKUP FASTBack FBPolicyname = ▼ name FBServer = name ►►,,►FBClientname = ▼ name FBVolumename = ▼ name►FBReposlocation = name FBBranch = name BACKMc = name►◄Important:1. At least one FBpolicyName is always required.2. You can specify up to 10 values for FBPolicyName, if no values are specifiedfor both FBClientName and FBVolumeName.Chapter 12. Using commands 549

3. When you specify a FBClientName value, there must be only one value forFBPolicyName.4. You can specify up to 10 values for FBClientName if only one PolicyName isspecified, and no values for FBVolumeName are specified.5. When you specify the FBVolumeName option, you can have only one FBPolicy,and only one FBCLientName specified.6. You can specify multiple FBVolumeNames if condition 5 is satisfied.Table 69. Backup FastBack command: Related optionsOptionfbpolicyname“Fbpolicyname” on page374fbserver “Fbserver” onpage 377fbclientname“Fbclientname” on page373fbvolumename“Fbvolumename” on page378fbreposlocation“Fbreposlocation” onpage 376fbbranch “Fbbranch” onpage 372backmc “Backmc” on page306Where to useCommand line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.Command line and scheduler.ExamplesCommand line:The Tivoli Storage Manager is installed on a FastBack server. Use thiscommand to back up all Tivoli Storage Manager FastBack volumes for allWindows FastBack clients that are defined for Tivoli Storage ManagerFastBack policy1:dsmc backup fastback -fbpolicyname=Policy1-fbserver=myfbserverThe repository location is not required. If you provide the repositorylocation, it is ignored.The FastBack server name, -myfbserver, is the short host name of theFastBack server where the client is running.Command line:The Tivoli Storage Manager is installed on a FastBack disaster recoveryhub. Use this command to back up all FastBack volumes for all FastBackclients that are found in the policy named Policy 1:dsmc backup fastback -fbpolicyname="Policy 1"-fbserver=myFbServer -fbbranch=branch1The repository location is not required. If you provide the repositorylocation, it is ignored.550 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

The FastBack server name, myFbServer, is the short host name of theFastBack server whose FastBack branch is specified using the FBBranchoptionCommand line:The Tivoli Storage Manager client is installed on a dedicated proxymachine with FastBack administrative command line and FastBack mount.The Tivoli Storage Manager client is connecting to a FastBack serverrepository. Use this command to back up all FastBack volumes for allFastBack clients that are found in the policy named Policy 1:dsmc backup fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myFbServer.company.com\REPThe repository location is required.The short host name of the machine where the FastBack server is installedis myFbServer.Command line:The Tivoli Storage Manager client is installed on a dedicated proxymachine with FastBack administrative command line and FastBack mount.The Tivoli Storage Manager client is connecting to a remote branchrepository on a FastBack disaster recovery hub. Use this command to backup all FastBack volumes for all FastBack clients that are found in the policynamed Policy 1:dsmc backup fastback -fbpolicyname="Policy 1" -fbserver=myFbServer-fbreposlocation=\\myfbdrhub.company.com\REP-fbbranch=aFbServerBranchThe repository location is required.The myFbServer value specified with the -fbserver option is the short hostname of the FastBack Server whose FastBack branch is specified using theFBBranch option.The fbbranch option specifies the branch ID of the FastBack server on thedisaster recovery hub.Command line:Back up all volumes protected by FastBack policy named policy1 from theFastBack server named basil, and apply the management class"my_tsm_mgmt_class" to the backed up volumes:dsmc backup fastback -Fbpolicyname=policy1-FBServer=basil -BACKMC=”my_tsm_mgmt_class”Backup GroupUse the backup group command to create and back up a group containing a list offiles from one or more file space origins to a virtual file space on the Tivoli StorageManager server.|||A group backup allows you to create a consistent point-in-time backup of a groupof files that is managed as a single logical entity. Objects in the group are subject tothe following processing rules:v Management class rebinding for grouped objects:– During full backups, all objects in a backup group are assigned to the samemanagement class.Chapter 12. Using commands 551

||||||||||||||||vvvvv– During differential backups, if a new management class is specified on aninclude statement for an existing backup group, the following behavioroccurs:- Any new and changed objects in the backup group are bound to the newmanagement class.- Any member objects of the group that are not changed appear as thoughthey have not been bound to the new management class. These unchangedobjects are not included in the “Total number of objects rebound” statisticsthat are displayed when the Backup Group command completes.- The unchanged objects are reassigned to a newly created backup group,and the new backup group is bound to the new management class.However, the original management class name is still displayed for theunchanged group objects.Even though the original management class name is still displayed for theunchanged objects, they are effectively bound to the new management classof the backup group.Existing exclude statements for any files in the group are ignored.All objects in the group are exported together.All objects in the group are expired together as specified in the managementclass. No objects in a group are expired until all other objects in the group areexpired, even when another group they belong to gets expired.If you are performing full and differential group backups to a sequential device,during a restore the data is in no more than two locations. To optimize restoretime, perform periodic full backups to back up the data to one location on thesequential media.During a full group backup, all objects in the filelist are sent to the server.During a differential group backup, only data that has changed since the last fullbackup is sent to the server. Objects in the filelist that have not changed sincethe last full backup are assigned as members of the differential group backup.This data is not resent to the server, reducing backup time.The backup group command requires the following options:filelistSpecifies a list of files to add to a new group.groupnameSpecifies the fully qualified name of the group containing a list of files.virtualfsnameSpecifies the name of the virtual file space for the group on which youwant to perform the operation. The virtualfsname option cannot be thesame as an existing file space name.modeSpecifies whether you want to back up all of the files in the filelist or onlyfiles that have changed since the last full backup.Note:1. If any file in the group backup fails, the entire group backup fails.2. Use the query group command to query members of a group backup on theTivoli Storage Manager server.3. Use the restore group command to restore specific members or all members ofa group backup on the Tivoli Storage Manager server.4. Unless you are running Mac OS X, use the delete group command to delete aspecific group backup from the Tivoli Storage Manager server.552 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

5. Use the query filespace command to display virtual file space names for yournode that are stored on the Tivoli Storage Manager server.6. A group backup can be added to a backup set.Supported ClientsThis command is valid for all Windows clients.Syntax►► Backup GRoup options ►◄ParametersTable 70. Backup Group command: Related optionsOptionfilelist “Filelist” onpage 380groupname “Groupname” onpage 387mode “Mode” on page 420snapshotproviderfs“Snapshotproviderfs” onpage 478snapshotproviderimage“Snapshotproviderimage”on page 479virtualfsname“Virtualfsname” on page513Where to useCommand line only.Command line only.Command line only.Client options file (dsm.opt) or with the include.fs option.Client options file (dsm.opt) or with include.image option.Command line only.ExamplesTaskPerform a full backup of all the files in the c:\dir1\filelist1 file to thevirtual file space name \virtfs containing the group leader group1 file.Command:backup group -filelist=c:\dir1\filelist1 -groupname=group1-virtualfsname=\virtfs -mode=fullRelated information“Include options” on page 395“Query Group” on page 605“Restore Group” on page 638“Delete Group” on page 575“Query Filespace” on page 603Chapter 12. Using commands 553

Backup ImageThe backup image command creates an image backup of one or more volumes onyour system.||These volumes can be formatted NTFS, or unformatted RAW volumes. If a volumeis NTFS-formatted, only those blocks used by the file system are backed up.Important:The last incremental backup time refers to the server time and the file modificationtime refers to the client time. If the client and server time are not synchronized, orthe client and server are in different time zones, this affects incremental-by-datebackup and image backup with mode=incremental.The client backs up the files whose modification date and time (client time) is laterthan the date and time of the last incremental backup of the file system on whichthe file resides (server time).If the server time is ahead of the client time, an incremental-by-date operation orimage backup with mode=incremental skips the files, which had been created ormodified after the last incremental or image backup with a modification dateearlier than the last incremental backup time stamp.If the client time is ahead of the server time, all files that had been created ormodified before the last incremental or image backup and have a modificationtime stamp later than the last incremental backup time stamp, are backed up again.Typically, these files would not get backed up because they had already beenbacked up.The backup date can be checked by the query filespace command.Note:1. The account running the Tivoli Storage Manager client must have administratorauthority to successfully perform any type of image backup.2. The API must be installed to use the backup image command.Use the include.image option to include a file system or logical volume for imagebackup, or to specify volume-specific options for image backup.The backup image command uses the compression option.Supported ClientsThis command is valid for all Windows platforms.Syntax►►Backup Imageoptions▼filespec►◄554 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersfilespecSpecifies the name of one or more logical volumes. If you want to back upmore than one file system, separate their names with spaces. Do not usepattern matching characters. If you do not specify a volume name, the logicalvolumes specified with the domain.image option are processed. If you do notuse the domain.image option to specify file systems to process, an errormessage is displayed and no image backup occurs.Image backup is only supported on a volume that has a mount point assignedor a drive letter assigned. A volume without a drive letter or mount pointcannot be backed up.||Table 71. Backup Image command: Related optionsOptionWhere to usecompressalwaysClient options file (dsm.opt) or command line.“Compressalways” on page320compression“Compression” on page320imagegapsize“Imagegapsize” on page391mode “Mode” on page 420postsnapshotcmd“Postsnapshotcmd” onpage 438presnapshotcmd“Presnapshotcmd” on page445snapshotproviderimage“Snapshotproviderimage”on page 479Client options file or command line.Use with the backup image command, the include.imageoption, or in the options file.Command line only.Use with the backup image command, the include.imageoption, or in the options file.Use with the backup image command, the include.imageoption, or in the options file.Client options file or with include.image option.|||ExamplesTaskTaskTaskTaskBack up a volume that has no drive letter but is mounted as a mountpoint.Command: dsmc backup image m:\mnt\myntfsBack up the h: drive using an image incremental backup that backs uponly new and changed files after the last full image backup.Command: dsmc backup image h: -mode=incrementalPerform an offline image backup of the f: drive.Command: dsmc backup image f: -snapshotproviderimage=nonePerform an online image backup of the f: drive.Command:dsmc backup image f: -snapshotproviderimage=VSSChapter 12. Using commands 555

|TaskBack up the f: drive which is mapped to a volume which has not beenformatted with a file system.Command: dsmc backup image f:Related information“Imagegapsize” on page 391“Snapshotproviderimage” on page 479“Configuring Open File Support” on page 70“Image backup” on page 134“Mode” on page 420“Comparing methods 1 and 2” on page 138 to decide which method is appropriatefor your environment.Offline and online image backupThe traditional offline image backup prevents write access to the volume by othersystem applications during the operation.If open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications.Use VSS as the snapshot provider for open file support.The following considerations apply to offline and online image backups:v If you create an image of the system drive, you cannot restore it to the originallocation. Restore of any image requires that the client have an exclusive lock ofthe volume you are restoring to, so the system drive cannot be restored sinceTivoli Storage Manager is unable to lock the system drive. You can restore animage backup of the system drive to an alternate location.v Because of different system component configurations, the system image not beconsistent across components (such as Active Directory). Some of thesecomponents can be configured to use different volumes where parts are installedon the system drive and others to non-system volumes.v Install the Tivoli Storage Manager client program on the system drive. The clientcannot restore an image to the same volume where the client program isinstalled.v Image backup is only supported on volumes that have a mount point or a driveletter assigned. Tivoli Storage Manager will not back up a volume without amount point or drive letter.v If bad disk sectors are detected on the source drive during a LAN-free orLAN-based image backup, data corruption occur. In this case, bad sectors areskipped when sending image data to the Tivoli Storage Manager server. If baddisk sectors are detected during the image backup, a warning message is issuedafter the image backup completes.556 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Utilizing image backup to perform file system incrementalbackupThere are two methods of utilizing image backups to perform efficient incrementalbackups of your file system. These backup methods allow you to performpoint-in-time restore of your file systems and improve backup and restoreperformance.You can perform the backup only on formatted volumes; not on raw logicalvolumes. You can either use image backup with file system incremental or you can useimage backup with image incremental mode to perform image backups of volumeswith mounted file systems.The following are some examples of using image backup with file system incremental.v To perform a full incremental backup of the file system: dsmc incremental h:v To perform an image backup of the same file system: dsmc backup image h:v To periodically perform incremental backups: dsmc incremental h:You must follow the next steps in the order shown to ensure that the serverrecords additions and deletions accurately.Use this command to restore the file system to its exact state as of the lastincremental backup: dsmc restore image h: -incremental -deletefiles.During the restore, the client does the following:v Restores the most recent image on the server.v Deletes all of the files restored in the previous step which are inactive on theserver. These are files which existed at the time of the image backup, but weresubsequently deleted and recorded by a later incremental backup.v Restores new and changed files from the incremental backups.If you do not follow the steps exactly, two things can occur:1. After the original image is restored, all files backed up with the incrementalcommand are restored individually.2. If you perform a backup image before performing an incremental, files deletedfrom the original image are not deleted from the final restored file system.The following are some examples of using image backup with image incremental mode.v To perform an image backup of the same file system: dsmc backup image h:v To perform an incremental image backup of the file system: dsmc backup imageh: -mode=incrementalThis sends only those files that were added or changed since the last imagebackup to the server.v To periodically perform full image backups: dsmc backup image h:v To restore the image: dsmc restore image h: -incrementalOn restore, Tivoli Storage Manager ignores the deletefiles option when theimage+image incremental technique of backing up has been used. The restorewill include files that were deleted after the last full image backup plus thelatest versions of files added or changed after the last image backup.Note: You should perform full image backups periodically in the following cases.This will improve restore time because fewer changes are applied fromincrementals.Chapter 12. Using commands 557

v When a file system changes substantially (more than 40%).v Once each month.v As appropriate for your environment.The following restrictions apply when using the image backup with imageincremental mode:vvvvvThe file system can have no previous full incremental backups produced by theincremental command.Incremental-by-date image backup does not inactivate files on the server;therefore, when files are restored, none can be deleted.If this is the first image backup for the file system, a full image backup isperformed.Using mode=incremental backs up only files with a changed date, not files withchanged permissions.If file systems are running at or near capacity, an out-of-space condition couldresult during the restore.Backup NASThe backup nas command creates an image backup of one or more file systemsbelonging to a Network Attached Storage (NAS) file server, otherwise known asNDMP Backup. Tivoli Storage Manager prompts you for an administrator ID.The NAS file server performs the outboard data movement. A server process startsin order to perform the backup.Use the nasnodename option to specify the node name for the NAS file server. TheNAS node name identifies the NAS file server to the Tivoli Storage Managerserver; the NAS node name must be registered at the server. Place the nasnodenameoption in your client options file (dsm.opt). The value in the client options file isthe default, but can be overridden on the command line.Use the toc option with the backup nas command or the include.fs.nas option tospecify whether Tivoli Storage Manager saves Table of Contents (TOC) informationfor each file system backup. If you save TOC information, you can use the QUERYTOC server command to determine the contents of a file system backup inconjunction with the RESTORE NODE server command to restore individual filesor directory trees.You can also use the Tivoli Storage Manager Web client to examine the entire filesystem tree and select files and directories to restore. Creation of a TOC requiresthat you define the tocdestination attribute in the backup copy group for themanagement class to which this backup image is bound. TOC creation requiresadditional processing, network resources, storage pool space, and possibly a mountpoint during the backup operation. If you do not save TOC information, you canstill restore individual files or directory trees using the RESTORE NODE servercommand, if you know the fully qualified name of each file or directory and theimage in which that object was backed up.The toc option is only supported for images backed up by Version 5.2 or laterclient and server.558 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Specifying mode =differential on the BACKUP NODE server command or thebackup nas command where no full image exists, shows that a full backup wasstarted. Using the QUERY PROCESS server command shows that a full backup isin process.Use the mode option to specify whether to perform a full or differential NAS imagebackup. A full image backup backs up the entire file system. The default is adifferential NAS image backup on files that change after the last full imagebackup. If an eligible full image backup does not exist, a full image backup isperformed. If a full image exists, whether it is restorable, or expired and beingmaintained because of dependent differential images, specifying mode =differentialsends a differential image backup. If a full image is sent during a differentialbackup, it is reflected as a full image using the QUERY NASBACKUP servercommand. The QUERY NASBACKUP server command also displays NAS imagesthat are restorable and displays full image or differential image as the object type.Use the monitor option to specify whether you want to monitor a NAS file systemimage backup and display processing information on your screen.Use the monitor process command to display a list of all processes for which anadministrative user ID has authority. The administrative user ID should have atleast client owner authority over both the NAS node and the client workstationnode they are using either from command line or from the web.Use the cancel process command to stop NAS backup processing.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}.Supported ClientsThis command is valid for all Windows clients.Syntax►►Backup NASoptions▼ filespec ►◄ParametersfilespecSpecifies the name of one or more file systems on the NAS file server. If youdo not specify this parameter, Tivoli Storage Manager processes all of the filesystems defined by the domain.nas option.If you do not specify the filespec or the domain.nas option, the default all-nasvalue is used for domain.nas and all file systems on the NAS file server arebacked up.Chapter 12. Using commands 559

Table 72. Backup NAS command: Related optionsOptionWhere to usemode “Mode” on page 420 Command line only.monitor “Monitor” on Command line only.page 424nasnodenameClient options file (dsm.opt) or command line.“Nasnodename” on page425toc “Toc” on page 505Command line or with the include.fs.nas option in your clientoptions file (dsm.opt).ExamplesTaskTaskTaskBackup SystemstatePerform the NAS image backup of the entire file system.Command: backup nas -mode=full -nasnodename=nas1 {/vol/vol0}{/vol/vol2}Perform the NAS image backup of the entire file server.Command: backup nas -nasnodename=nas1Perform the NAS image backup of the entire file system and save Table ofContents (TOC) information for the file system backup.Command: backup nas -mode=full -nasnodename=netappsj {/vol/vol0}-toc=yesRelated information“Nasnodename” on page 425“Toc” on page 505“Mode” on page 420“Monitor” on page 424“Cancel Process” on page 568“Domain.nas” on page 344Use the backup systemstate command to back up all startable system state andsystem services components as a single object, to provide a consistent point-in-timesnapshot of the system state.Startable system state components can include the following:v Active Directory (domain controller only)v System volume (domain controller only)v Certificate Server Databasev COM+ databasev Windows Registryv System and boot filesv ASR writer560 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

System services components can include the following:v Background Intelligent Transfer Service (BITS)v Event logsv Removable Storage Management Database (RSM)v Cluster Database (cluster node only)v Remote Storage Servicev Terminal Server Licensingv Windows Management Instrumentation (WMI)v Internet Information Services (IIS) metabasev DHCP databasev Wins databaseThe list of startable system state and system services components is dynamic andcan change depending on service pack and operating system features installed.Tivoli Storage Manager allows for the dynamic discovery and backup of thesecomponents.The system state backup consists of data from several VSS writers. When the filesthat belong to the System Writer change, an incremental backup is used for thesefiles. Using incremental backup on the System Writer files reduces the amount oftime it takes to back up the system state. A full backup is used for all other systemstate data.During system state backup, a progressive incremental backup is used for theSystem Writer files in the system state. If you want to run a full backup of allsystem state data, you can specify include.systemstate mc_name in the clientoptions file (dsm.opt), where mc_name is the name of the management class withcopy group mode absolute.On Windows Vista, Windows 7, and Windows Server 2008 clients running BIOS,backup systemstate also backs up ASR data. ASR data is not backed up on 64-bitarchitectures with Extensible Firmware Interface (EFI).Note:1. To back up Windows system state, your client must be connected to a TivoliStorage Manager Version 5.2.0 or higher server.2. The system and boot files component of system state is backed up only if amember (file) of that component has changed since the last backup. If amember changes, the entire group of files that comprise that component arebacked up.3. The Tivoli Storage Manager Windows client does not allow the backup of anyindividual component.4. Use the include.systemstate option in your client options file (dsm.opt) toassign management classes for backup of system state. The default is to bindthe system state object to the default management class.For example: include.systemstate ALL BASVT2.5. Use the query systemstate command to display information about a backup ofthe system state on the Tivoli Storage Manager server.6. Use the restore systemstate command to restore the backup of the system statefrom the Tivoli Storage Manager server.Supported ClientsThis command is valid for all Windows clients.Chapter 12. Using commands 561

Syntax►► Backup SYSTEMSTate ►◄ParametersThere are no parameters for this command.ExamplesTaskBack up the system state.Command: backup systemstateRelated information“Backing up in preparation for Automated System Recovery (Windows Vista,Windows 7, and Windows Server 2008)” on page 132“Query Systemstate” on page 616“Restore Systemstate” on page 645Backup VMUse the backup vm command to start a full backup of a virtual machine.The Backup VM command can be used to back up both Microsoft Hyper-V virtualmachines and VMware virtual machines. The information for each hypervisor ispresented in its own heading. If you are backing up a virtual machine that is partof a Hyper-V set up, you can skip over the Backing up VMware virtual machines text.If you are backing up a VMware virtual machine, you do not need to read theBacking up Hyper-V virtual machines text.Backing up VMware virtual machinesUse the backup vm command to back up VMware virtual machines.One or more virtual machines are processed using the IBM Tivoli Storage Managerdata mover node. Data mover node is the name given to a configuration where theBackup-Archive Client runs on a vStorage backup server and is configured toprotect the virtual machines in a Virtual Center or ESX/ESXi server. You mustconfigure the VMware virtual machine before using this command. Forinformation on configuring the VMware virtual machine, see “Preparing theenvironment for full backups of VMware virtual machines” on page 148.|||||||||A full VM backup stores a backup copy of all virtual disk images andconfiguration information for a virtual machine. Full VM backups enable acomplete restore of a virtual machine, but they take more time and more serverspace than a file-level or incremental backup.File-level VM backups allow you to individually restore virtual machine files, butit does not have an easy full VM machine recovery procedure. You might want touse a combination of file level VM backups with periodic full VM backups foroptimal results. You must be licensed to use IBM Tivoli Storage Manager forVirtual Environments to use the periodic full backup strategy. The periodic full562 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||strategy is described in the IBM Tivoli Storage Manager for Virtual EnvironmentsVersion 6.4 Data Protection for VMware Installation and User's Guide.If you set the vmenabletemplatebackups option to yes, aBackup VM operationincludes the template VMs, but only if the vStorage backup server is connected toa vCenter Server, and not to an ESX or ESXi host.Virtual machines deployed in vApps are included in Backup VM operations. Thereare no client options needed to protect the vApp VMs.A Full VM backup uses VMware Changed Block Tracking (CBT) to createcontent-aware (used-block only) backups. Tivoli Storage Manager enables changedblock tracking (CBT) on an ESX or ESXi server when a backup begins. VMwareCBT requires an ESX 4.1 (or later) host, with virtual hardware 7 (or later). Youcannot perform incremental or full VM content-aware backups on virtual machinesthat do not support CBT.When CBT is enabled, it tracks disk changes when I/O operations are processedby the ESX or ESXi server storage stack on the following disks:v A virtual disk stored on VMFS; the disk can be an iSCSI disk, a local disk, or adisk that is on a SAN.v A virtual disk stored on NFS.v An RDM that is in virtual compatibility mode.When I/O operations are not processed by the ESX or ESXi storage stack, changedblock tracking cannot be used to track disk changes. The following disks cannotuse CBT:v An RDM that is in physical compatibility mode.v A disk that is accessed directly from inside a VM. For example, vSphere cannottrack changes made to an iSCSI LUN that is accessed by an iSCSI initiator in thevirtual machine.Complete information about changed block tracking requirements is described inthe VMware Virtual Disk API Programming Guide at http://www.vmware.com/support/developer/vddk/. Search for “Low Level Backup Procedures” and readthe “Changed Block Tracking on Virtual Disks” section.For VMware servers that do not support CBT, both the used and the unused areasof the disk are backed up and an informational message is logged in thedsmerror.log file. Use the the -preview option on the Backup VM command toview the current CBT status. CBT status has three values:Off Indicates the CBT configuration parameter (ctkEnabled) has not beenenabled in the virtual machine's configuration parameters. Off is thedefault state.Not SupportedIndicates that the virtual machine does not support CBT. Changed-blockonly backups are not possible.OnIndicates the virtual machine supports CBT and that CBT is enabled in thevirtual machine's configuration parameters (ctkEnabled=true).The client turns on CBT (it sets ctkEnable=true) with each backup attempt.After the client turns CBT on, it remains on, even if the virtual machine isdeleted from the Tivoli Storage Manager server. With CBT enabled, afterthe first full VM backup is performed, only the changed blocks on the diskare backed up or restored.Chapter 12. Using commands 563

If you are no longer performing Tivoli Storage Manager backups of avirtual machine, you can turn off CBT. To turn off CBT, right-click thevirtual machine that you want to turn off CBT for in the vSphere client.Click Edit Settings > Options > General > Configuration Parameters.Then set the ctkEnabled configuration parameter to false.Tip: You can use the compression option with backups only if the backup is beingsaved to a storage pool that has been enabled for client-side deduplication.See “Compression, encryption, and adaptive subfile backup processing” on page400 for more information.||||||||||||||||||||||||You specify the -vmbackuptype and -mode options to indicate how the backups areto be performed. For full VM backups, use -vmbackuptype=fullvm, and specify anyof the following mode options:Full Full mode specifies you want to perform an image backup of all objects ona VMware virtual machine’s disks. Contrast mode=full withmode=incremental, which creates a snapshot containing only the data thathave changed since the last backup.IncrementalIncremental mode specifies that you want to create an image backup ofonly the objects that have changed since the last backup. You must belicensed to use IBM Tivoli Storage Manager for Virtual Environments touse this mode.IFFull IFFull stands for incremental forever full VM backup. In this mode, asnapshot of all used blocks on a VMware virtual machine’s disks arebacked up to the server. You must be licensed to use IBM Tivoli StorageManager for Virtual Environments to use this mode.IFIncrementalIFIncremental stands for incremental forever, incremental. In this mode, asnapshot is created of the blocks that have changed since the last backup.You must be licensed to use IBM Tivoli Storage Manager for VirtualEnvironments to use this mode.The incremental forever backup strategy is described in the IBM Tivoli StorageManager for Virtual Environments Version 6.4 Data Protection for VMware Installationand User's Guide.Supported Clients|||This command is valid on supported Windows clients that are installed on avStorage backup server that protects VMware virtual machines.Syntax||►► Backup VM ▼ ,vmname:vmdk= disk_label -preview options►◄|||ParametersvmnameSpecify the name of one or more virtual machines that you want to back564 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||||up. The name can be the DNS host name or the virtual machine displayname. Separate multiple virtual machine names with commas. If you haveset the vmenabletemplatebackups option to yes, vmname can specify thename of a template VM to back up.If you do not specify vmname, you can identify the virtual machine withone of the following options:v domain.vmfullv domain.vmfile:vmdk=disk_labelThis keyword is an extension to the vmname . It specifies the label of thevirtual machine disk to include in the backup operation. You can exclude adisk by preceding the keyword with the exclusion operator (-). You canalso specify multiple keywords as part of the vmname. For example:“EXCLUDE.VMDISK” on page 370For additional ways to include or exclude disks from processing, see“Domain.vmfull” on page 348, “EXCLUDE.VMDISK” on page 370,“INCLUDE.VMDISK” on page 401.-previewThis option displays information about a virtual machine, including thelabels of the hard disks in the virtual machine. The disk labels can be usedon the backup vm command with :vmdk= or :-vmdk= keywords toinclude or exclude disks from a backup operation. The following is sampleoutput from the -preview parameter:backup vm vm1 -previewFull BACKUP VM of virtual machines ’VM1’.1. vmName:vm1VMDK[1]Label: Hard disk 1VMDK[1]Name: [ds5k_svt_1] tsmcetlnx14/tsmcetlnx14.vmdkVMDK[1]Status: IncludedVMDK[2]Label: Hard disk 2VMDK[2]Name: [ds5k_svt_1] tsmcetlnx14/tsmcetlnx14_1.vmdkVMDK[2]Status: Excluded - user,Independent,pRDMIn this example output from -preview, VMDK 2 was omitted from thebackup. Disks that are included in a backup have a status of “Included”.Skipped disks have a status of “Excluded”, followed by a reason code. Thereason codes can be any of the following:user Indicates that the disk was skipped because it was excluded on adomain.vmfull statement, on the command line, or in the clientoptions file.IndependentIndicates that the disk is an independent disk. Independent diskscannot be part of a snapshot, so they are exclude from backup vmoperations. Ensure that the vmprocesswithindependent option is setto yes or the entire virtual machine will be bypassed by a backupoperation if it contains one or more independent disks.pRDMIndicates that the disk is a physical Raw Device Mapped (pRDM)disk. pRDM disks cannot be part of a snapshot, so they are excludefrom backup vm operations. Ensure that the vmprocesswithprdmoption is set to yes or the entire virtual machine will be bypassedby a backup operation if it contains one or more raw devicemapping (RDM) volumes provisioned in physical-compatibilitymode (pRDM).Chapter 12. Using commands 565

|||||||||||||||||||||||||||||||||||||||||vStorage APIs for data protection example commandsPerform a file-level backup of a VM named vm1:dsmc backup vm vm1 -vmbackuptype=filePerform a file-level virtual machine backup of vm1.example.com using the VMwareVirtualCenter machine named virtctr.example.com:dsmc backup vm vm1 -vmbackuptype=file -vmchost=virtctrPerform an IFIncremental backup of two VMs named vm3 and vm4:dsmc backup vm vm3,vm4 -vmbackuptype=fullvm -mode=ifincremmentalPerform an IFFull backup of a VM named vm1:dsmc backup vm vm1 -vmbackuptype=fullvm -mode=iffullPerform an IFFull VM backup of a VM named vm1, but only include Hard Disk 1in the back up operation:dsmc backup vm "vm1:vmdk=Hard Disk 1" -vmbackuptype=fullvm -mode=iffullPerform an incremental-forever backup of a virtual machine named vm1, butexclude Hard Disk 1 and Hard Disk 4 from the backup operation.dcmc backup vm "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 4"-vmbackuptype=fullvm -mode=iffullPerform an incremental-forever-full backup of two virtual machines named vm1and vm2. On vm1, back up only Hard Disk 2 and Hard Disk 3. On vm2, back upall virtual disks:dsmc backup vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3",vm2 -vmbackuptype=fullvm -mode=iffullPerform parallel backups of the VMware virtual machines that are selected forbackup by using the selection criteria (domain parameters) on the domain.vmfullstatement. Limit the number of parallel backups to 5 virtual machines, and preventmore than 2 of them, on any ESX or ESXi server, from being included in theparallel backup operation:dsmc backup vm –vmmaxparallel=5 –vmlimitperhost=2 –vmlimitperdatastore=0Related links for backing up VMware virtual machines“Query VM” on page 617“Restore VM” on page 647“Domain.vmfile” on page 345“Domain.vmfull” on page 348“Mode” on page 420“Vmbackdir” on page 515“Vmbacknodelete” on page 516“Vmbackuptype” on page 517“Vmchost” on page 520“Vmcpw” on page 521“Vmcuser” on page 522“Vmlimitperdatastore” on page 524566 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||“Vmlimitperhost” on page 525“Vmmaxparallel” on page 527“VMware virtual machine exclude options” on page 370“VMware virtual machine include options” on page 401Backing up Microsoft Hyper-V virtual machinesUse the backup vm command to create a full VM back up Hyper-V virtualmachines.For Hyper-V backup operations, you must specify vmbackuptype=hypervfull. Theonly supported mode option for Hyper-V backups is mode=full (the mode option isnot even examined when you specify vmbackuptype=hypervfull).For Hyper-V backups, you can specify one or more virtual machine names thatyou want to back up. Separate the names with commas. If you want to obtain a listof Hyper-V virtual machines that are defined on the Hyper-V server, type aquestion mark (backup vm ?).Supported Clients|||This command is valid on supported Windows clients that are installed on aHyper-V host server.Syntax|►►Backup VMvmname, options►◄|▼ vmlist=vmlist=?vmname||||||||||ParametersvmnameSpecify the name of the virtual machine that you want to back up.vmlist=vmname_1,vmname_2,vmname_nSpecifies a list of virtual machine names to back up; separate the virtualmachine names with commas. The vmname and vmlist= syntaxes aremutually exclusive; you an specify a virtual machine name or a list ofvirtual machine names, but not both.vmlist=?Displays a list of virtual machines defined to the Hyper-V server.Hyper-V example commandsCreate a full VM backup of a Hyper-V virtual machine, by specifying the virtualmachine name "VM1".dsmc backup vm VM1 -vmbackuptype=hypervfullUse the vmlist= keyword to back up two Hyper-V virtual machines, named vm1and vm5:dsmc backup vm -vmbackuptype=hypervfull -vmlist=vm1,vm5Chapter 12. Using commands 567

|||List all virtual machines defined on the Hyper-V host machine:dsmc backup vm vmlist=?Hyper-V options file examplesCancel ProcessSpecify individual virtual machines in the client options file:backuptype hypervfullvmlist vm1,vm2,vm5Related links for backing up Hyper-V virtual machines“Mode” on page 420“Restore VM” on page 647“Query VM” on page 617“Vmbackuptype” on page 517The cancel process command displays a list of current NAS (if NDMP support isenabled) image backup and restore processes for which the administrative user hasauthority. Tivoli Storage Manager prompts you for an administrator ID.From the list, the administrative user can select one process to cancel. Client ownerprivilege is sufficient authority to cancel the selected NAS image backup or restoreprocesses.Supported ClientsThis command is valid for all Windows clients.Syntax►► Cancel Process ►◄ParametersThere are no parameters for this command.ExamplesTaskCancel current NAS image backup or restore processes.Command: cancel processCancel RestoreThe cancel restore command displays a list of your restartable restore sessions inthe server database.You can only cancel one restartable restore session at a time. Run the cancel restorecommand again to cancel additional restores. To restart restartable restore sessions,use the restart restore command.Use the cancel restore command under the following circumstances:v You cannot back up files affected by the restartable restore.568 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

v You want to cancel restartable restore sessions.v Restartable restore sessions lock the file space so that files cannot be moved offof the sequential volumes of the server.Supported ClientsThis command is valid for all clients.Syntax►► Cancel Restore ►◄ParametersThere are no parameters for this command.ExamplesTaskCancel a restore operation.Command:cancel restoreDelete AccessThe delete access command deletes authorization rules for files that are stored onthe server.When you delete an authorization rule, you revoke user access to any files orimages specified by that rule.Supported ClientsThis command is valid for all clients.Syntax►► Delete ACcess ►◄ParametersThere are no parameters for this command.ExamplesTaskDisplay a list of current authorization rules and select the rules you wantto delete.Command:delete accessSee the following screen example:Index Type Node Owner Path_____ ______ ____________________________________Chapter 12. Using commands 569

Delete Archive1 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 allow marm and susies to access yourfiles, type 24or 2,4, then press Enter.The delete archive command deletes archived files from Tivoli Storage Managerserver storage. Your administrator must give you the authority to delete archivedfiles.Important: When you delete archived files, you cannot retrieve them. Verify thatthe files are obsolete before you delete them.Supported ClientsThis command is valid for all clients.Syntax►►Delete ARchiveoptionsfilespec{ filespacename } filespec►◄ParametersfilespecSpecifies the path and file name that you want to delete from storage. Usewildcard characters to specify a group of files or all files in a directory. You canalso use the filelist option to process a list of files. The Tivoli Storage Managerclient opens the file you specify with this option and processes the list of fileswithin according to the specific command.Note: If you indicate filespacename, do not include a drive letter in the filespecification.{filespacename}Specifies the file space (enclosed in braces) on the server that contains the fileyou want to delete. This is the name on the workstation drive from which thefile was archived.Use the filespacename if the name has changed, or if you are deleting filesarchived from another node with drive labels that are different from yours.You can specify a UNC name; drive label names are only used for removablemedia.You must specify a mixed or lowercase NTFS file space name enclosed inquotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks are valid in loop mode. For example, {"NTFSDrive"} and {’NTFSDrive’}are both valid. In batch mode, only single quotation marks are valid. Thesingle quotation mark requirement is a restriction of the operating system.570 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 73. Delete Archive command: Related optionsOptionWhere to usedateformat “Dateformat” Client options file (dsm.opt) or command line.on page 326descriptionCommand line only.“Description” on page331filelist “Filelist” onpage 380noprompt “Noprompt” onpage 428numberformat“Numberformat” on page429pick “Pick” on page 434subdir “Subdir” on page489tapeprompt “Tapeprompt”on page 495timeformat “Timeformat”on page 503Command line only.Command line only.Client options file (dsm.opt) or command line.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Delete BackupExamplesTaskTaskTaskTaskTaskDelete files from file space abc in the proj directory.Command: delete archive {"abc"}\proj\*Delete a file named budget.Command: delete archive c:\plan\proj1\budget.janDelete all files archived from the c:\plan\proj1 directory with a fileextension of .txt.Command: delete archive c:\plan\proj1\*.txtDelete files archived from the c:\project directory by using the pickoption to display a list of archive copies that match the file specification.From the list, you can select the versions to process.Command: delete archive c:\project\* -pickDelete selected files from the group of files archived with the description"Monthly Budgets 1999" located in c:\projects and its subdirectories.Command: delete ar c:\projects\* -description="Monthly Budgets1999" -pick -subdir=yesRelated information“Filelist” on page 380The delete backup command deletes backup files from Tivoli Storage Managerserver storage. Your administrator must give you authority to delete backup files.Chapter 12. Using commands 571

You can delete your backed up files from the Tivoli Storage Manager client nodeworkstation if the function is enabled on the definition of the Tivoli StorageManager node. When you do this, the Tivoli Storage Manager server takes all ofthe backed up files that meet the 'filespec' and 'deltype' specified and deactivatethem. The server also assigns a deactivation date of 'infinite-minus' so that the filesare no longer available for restore and are purged, immediately on the subsequentrun of file expiration. The file is not physically removed until the expirationprocess runs.Important: After you delete backup files, you cannot restore them. Verify that thebackup files are no longer needed before you delete them. Tivoli Storage Managerprompts whether you want to continue with the delete. If you specify yes, thespecified backup files are immediately deleted and removed from Tivoli StorageManager server storage.Supported ClientsThis command is valid for all clients.Syntax►►Delete BAckupoptionsfilespec{ filespacename } filespec►►objtype=FILEobjtype=IMAGEdeltype=ACTIVEdeltype=INACTIVEdeltype=ALL►◄ParametersfilespecSpecifies the path and file name that you want to delete from storage. Usewildcard characters to specify a group of files or all files in a directory.Separate file specifications with a space. You can also use the filelist optionto process a list of files. The Tivoli Storage Manager client opens the file youspecify with this option and processes the list of files within according to thespecific command.Note: If you indicate filespacename, do not include a drive letter in the filespecification.When using -deltype=inactive or -deltype=active, use wildcard characters tospecify a group of files or all files in a directory.When using -deltype=all, specify a fully-wildcarded directory.objtypeSpecifies the type of backup delete you want to perform. You can specify eitherof the following values:FILESpecifies that you want to delete directories and files. This is the default.IMAGESpecifies that you want to delete an image backup. Specifies that you wantto delete an image backup. Objtype=image is not supported on Mac OS X.572 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

deltypeSpecifies the deletion type. Specify one of the following values:ACTIVEDelete only active file objects. Directory objects are not deleted. This is thedefault.Note: If there are any inactive objects, then after the active object isdeleted, the most current inactive object is changed from inactive to active.To delete all versions of a file, first issue the delete backup command with-deltype=inactive, then issue the command again with -deltype=active.INACTIVEDelete only inactive file objects. Directory objects are not deleted.ALLDelete all active and inactive objects below a given directory, including allsubdirectories and their files.Note: The parent directory of the deleted files and subdirectories is notdeleted. If you specify deltype=ALL, you cannot use the pick optionbecause deltype=ALL and the pick option are mutually exclusive.Table 74. Delete Backup command: Related optionsOptionWhere to usedescriptionCommand line only.“Description” on page331filelist “Filelist” onpage 380fromdate “Fromdate” onpage 384fromtime “Fromtime” onpage 386noprompt “Noprompt” onpage 428pick “Pick” on page 434pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436subdir “Subdir” on page489tapeprompt “Tapeprompt”on page 495timeformat “Timeformat”on page 503todate “Todate” on page506totime “Totime” on page507Command line only.Command line, and in the GUI find function.Command line, and in the GUI find function.Command line only.Command line only.Command line, and in the GUI find function.Command line, and in the GUI find function.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line, and in the GUI find function.Command line, and in the GUI find function.Chapter 12. Using commands 573

Delete FilespaceExamplesTaskTaskTaskTaskDelete all active file objects from file space abc in the proj directory.Command: delete backup {abc}\proj\*Delete all inactive files with names ending in .txt backed up from thec:\plan\proj1 directory and its subdirectories.Command: delete backup c:\plan\proj1\*.txt -deltype=inactive-subdir=yesDelete selected active files backed up from the c:\project directory. Usethe -pick option to display a list of backup copies that match the filespecification. From the list, you can select which versions to delete.Command: delete backup c:\project\* -pickDelete all active and inactive versions of files and subdirectories inc:\user\myproject.Command: delete backup c:\user\myproject\* -deltype=allNote: The backup versions of directory object c:\user\myproject are notdeleted.Related information“Filelist” on page 380The delete filespace command deletes file spaces in Tivoli Storage Manager serverstorage. A file space is a logical space on the server that contains files you backedup or archived.Tivoli Storage Manager assigns a separate file space on the server for eachworkstation file system from which you back up or archive files. The file spacename is the same as the UNC name.When you enter the delete filespace command, a list of your file spaces isdisplayed. From this list, select the file space that you want to delete.Your Tivoli Storage Manager administrator must give you authority to delete a filespace. You need BACKDEL authority if the file space you want to delete containsbackup versions, or ARCHDEL authority if the file space contains archive copies. Ifthe file space contains both backup versions and archive copies, you need bothtypes of authority.Important: When you delete a file space, you delete all backup versions andarchive copies within that file space. When you delete a file space, you cannotrestore the files. Verify that the files are obsolete before you delete them.You can use the delete filespace command to interactively delete NAS file spacesfrom server storage. Use the nasnodename option to identify the NAS file server.Use the class option to specify the class of the file space to delete.Supported ClientsThis command is valid for all clients.574 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►►Delete Filespaceoptions►◄ParametersTable 75. Delete Filespace command: Related optionsOptionclass “Class” on page 310detail “Detail” on page 332nasnodename “Nasnodename” on page 425scrolllines “Scrolllines” on page 466scrollprompt “Scrollprompt” on page467Where to useCommand line only.Command line only.Client options file or command line.Client options file or command line.Client system options file or command line.ExamplesTaskTaskDelete a file space.Command: delete filespaceDelete NAS file spaces from the dagordon NAS file server stored on theserver.Command: delete filespace -nasnodename=dagordon -class=nasRelated information“Nasnodename” on page 425“Class” on page 310Delete GroupUse the delete group command to delete a group backup on the Tivoli StorageManager server.After deleting a group, the group leader (virtualfsname) remains on the TivoliStorage Manager server. It contains no members (file or directories) but is reportedin a subsequent query filespace command. There are no files listed if theshowmembers option is added. Deleting a group does not remove the file space thatit resides in because there might be other groups in it. Use delete filespace if youwant to remove the file space and all the data it contains.Note:1. Use the inactive option to display both active and inactive group backupversions. By default, Tivoli Storage Manager only displays active versions.2. Use the pick option to select a specific group to delete from the Tivoli StorageManager server.3. Use the noprompt option if you want to suppress the confirmation prompt thatnormally appears before you delete a group backup version. By default, TivoliStorage Manager prompts you for confirmation before deleting the groupbackup. Using this option can speed up the delete procedure. However, it alsoChapter 12. Using commands 575

increases the danger of accidentally deleting a group backup version that youwant to save. Use this option with caution.4. Use the query filespace command to display virtual file space names for yournode that are stored on the Tivoli Storage Manager server.Supported ClientsThis command is valid for all Windows clients.Syntax►► Delete GRoup filespecoptions►◄ParametersfilespecSpecifies the virtual file space name and the group name that you want todelete from the server storage.Table 76. Delete Group command: Related optionsOptioninactive “Inactive” onpage 393noprompt “Noprompt” onpage 428pick “Pick” on page 434pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436Where to useCommand line only.Command line only.Command line only.Command line only.Command line only.ExamplesTaskTaskDelete the current active version of the virtfs\group1 group.Command:delete group {virtfs}\group1Delete a backup version of the virtfs\group1 group from a list of activeand inactive versions.Command:delete group {virtfs}\group1 -inactive -pickRelated information“Inactive” on page 393“Pick” on page 434“Noprompt” on page 428“Query Filespace” on page 603576 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ExpireThe expire command inactivates the backup objects you specify in the filespecification or with the filelist option.When working in interactive mode, a prompt notifies you before files are expired.The expire command does not remove workstation files. If you expire a file ordirectory that still exists on your workstation, the file or directory is backed upagain during the next incremental backup unless you exclude the object frombackup processing.If you expire a directory that contains active files, those files will not appear in asubsequent query from the GUI. However, these files are displayed on thecommand line, if you specify the proper query with a wildcard character for thedirectory.Note: Because the expire command changes the server picture of the client filesystem without actually changing the client file system, the expire command is notallowed on files located on a file system monitored by the Tivoli Storage Managerjournal service.Supported ClientsThis command is valid for all clients.Syntax►►EXPireoptionsfilespec►◄ParametersfilespecSpecifies a path and a file name that you want to expire. You can enter onlyone file specification on this command. However, you can use wildcards toselect a group of files or all the files in a directory. If you specify the filelistoption, the filespec designation is ignored.Table 77. Expire command: Related optionsOptionWhere to usedateformat “Dateformat” Client options file (dsm.opt) or command line.on page 326filelist “Filelist” on Command line only.page 380noprompt “Noprompt” on Command line only.page 428numberformatClient options file (dsm.opt) or command line.“Numberformat” on page429pick “Pick” on page 434timeformat “Timeformat”on page 503Command line only.Client options file (dsm.opt) or command line.Chapter 12. Using commands 577

ExamplesTask Inactivate the letter1.txt file in the home directory.Command: expire c:\home\letter1.txtTask Inactivate all files in the admin\mydir directory.Command: expire c:\admin\mydir\*Task Inactivate all files named in the c:\avi\filelist.txt file.Command: expire -filelist=c:\avi\filelist.txtHelpUse the help command to display information about commands, options, andmessages.Tip: If you use the help command on the initial command line, no server contactis made and no password is needed.Supported ClientsThis command is valid for all clients.Syntax►►Helpcommand-name [subcommand-name]option-nameTOC-section-number[ANS]message-number►◄Entering the help command with no arguments causes help to display thecomplete table of contents. Either with the initial command or when HELPdisplays a prompt, you can enter the following parameters.Parameterscommand-name [subcommand-name]Specifies a command name and, optionally, a subcommand name or theirabbreviation, for example: backup image, orbi. In this case the combinationshould be unique. Non-unique abbreviations result in the display of the firstsection of the entire help file matching the abbreviation. This parameter isoptional.option-nameSpecifies the name of an option, for example: domain or do. This parameter isoptional.TOC-section-numberSpecifies a table of contents section number, for example: 1.5.3. This parameteris optional.[ANS]message-numberSpecifies a message number with or without its prefix, for example: ans1036 or1036. This parameter is optional. The severity code is never necessary. Enteringans1036E results in a not-found response.578 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Important: If you enter arguments that do not fit these descriptions you might getunexpected results (or no results) to be displayed. If you enter more than twoarguments, your help request is rejected. Where a command name and an optionname are the same, for example: incremental (command) and incremental(option), you can only get help on the option by entering its table-of-contentssection number.The requested help text is displayed in one or more sections, depending on thenumber of display lines that are available in your command window. Whenenough lines have been displayed to fill the display space, or when the end of therequested help text is displayed, you see a prompt along with instructions for whatcan be entered at that prompt. To continue displaying text for your currentselection, press enter or type the ’d’ key to scroll down. To scroll up in the currentselection, press the ’u’ key and press Enter. Other choices might be presented, soread the prompt instructions.Proper display of the help text requires a usable display width of 72 characters. Adisplay width less than 72 characters causes sentences that are 72 characters wideto wrap to the next line. This can cause the displayed help text to beginsomewhere within the section rather than at the beginning. The undisplayed linescan be viewed by using the scrolling function of the terminal to move up.ExamplesTask Display the table of contents of the help topics.Command: dsmc helpTask Display the information in help topic 2.1.2Command: dsmc help 2.1.2Task Display help information on the archive command.Command: dsmc help archiveTask Display help information on message ANS1036.Command: dsmc help 1036Command: dsmc help ANS1036IncrementalThe incremental command backs up all new or changed data in the locations thatyou specify, unless you exclude them from backup services.You can back up all new or changed files or directories in the default clientdomain or from file systems, directories, or files.To incrementally back up selected files or directories, enter a file specification inthe command. If you do not enter a file specification, the default is to back up filesor directories in the default domain.The following attributes in the management class assigned to the file or directoryaffect whether the data is actually backed up:FrequencyThe number of days that must elapse between successive backups for thefile. The frequency attribute applies only to a full incremental backup.Chapter 12. Using commands 579

This management class attribute is ignored during a journal-based backup.Mode Permits you to back up only files that changed since the last backup(modified) or back up the files whether they changed or not (absolute).SerializationPermits or denies backup of files or directories according to the followingvalues:vvvvstatic: In order to be backed up, data must not be modified duringbackup or archive.shared static: If data in the file or directory changes during each of theallowed attempts to back up or archive it, it is not backed up orarchived. The value of the changingretries option determines howmany attempts are made. The default is 4.dynamic: The object is backed up or archived on the first attemptwhether or not data changes during the process.shared dynamic: The object is backed up or archived on the last attempt,even if data changes during the process.Using the include option in an include-exclude list, you can override the defaultmanagement class for a file or group of files.You can perform either a full incremental backup or an incremental by date backup.The default is a full incremental backup.If you are journaling a file system and the journal is valid, the full incrementalbackup performs a journal-based backup. More than one journal-based backupsession can be started, but only one journal-based backup session can proceed. Allother journal-based backup sessions that need access to the same filespace mustwait until the current journal-based backup session has completed before the nextsession can proceed. You can perform a full incremental backup without thejournal by using the nojournal option.You can also use the selective command to perform a selective backup that backsup only the files, directories or empty directories that you specify regardless ofwhether they have changed.A full incremental backs up all files or directories that are new or have changedsince the last incremental backup. During a full incremental backup, the clientqueries the server or the journal database. Tivoli Storage Manager uses thisinformation to:v Back up new files or directories.v Back up files or directories whose contents have changed.v Mark inactive backup versions on the server for files or directories that aredeleted from the workstation.v Rebind backup versions to management classes if the management classassignments change.Supported ClientsThis command is valid for all clients.Syntax580 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

►►Incrementaloptions►◄▼filespecParametersfilespecSpecifies the path and file name that you want to back up. Use wildcards toselect a group of files or all the files in a directory. You can specify as many filespecifications as available resources or other operating system limits permit.Separate file specifications with a space. You can also use the filelist optionto process a list of files. The Tivoli Storage Manager client opens the file youspecify with this option and processes the list of files within according to thespecific command. If you do not specify a file specification, the default domainor the domain specified as an option is backed up.If you specify a file system, all new and changed files are backed up. Inaddition, the last incremental date for the file space is updated on the server. Ifyou specify a file or directory, the last incremental date is not updated. Thismeans the file or directory might be backed up again if a later backup isperformed using the incrbydate option. If you specify a file system, specify thefile system without a trailing slash.Table 78. Incremental command: Related optionsOptionautofsrename “Autofsrename” on page 304changingretries “Changingretries” on page 310compressalways “Compressalways” on page 320compression “Compression” on page 320diffsnapshot “Diffsnapshot” on page 334dirsonly “Dirsonly” on page 337domain “Domain” on page 340encryptiontype “Encryptiontype” on page 358encryptkey “Encryptkey” on page 359filelist “Filelist” on page 380filesonly “Filesonly” on page 383incrbydate “Incrbydate” on page 404memoryefficientbackup “Memoryefficientbackup” onpage 419nojournal “Nojournal” on page 427postsnapshotcmd “Postsnapshotcmd” on page 438preservelastaccessdate “Preservelastaccessdate” onpage 441presnapshotcmd “Presnapshotcmd” on page 445Where to useClient options file (dsm.opt) only.Client options file (dsm.opt) orcommand line.Client options file (dsm.opt) orcommand line.Client options file (dsm.opt) orcommand line.Command line only.Command line only.Client options file (dsm.opt) orcommand line only.Client options file (dsm.opt).Client options file (dsm.opt).Command line only.Command line only.Command line only.Client user-options file (dsm.opt),server, or command line.Command line only.Client options file (dsm.opt) or withinclude.fs option.Client options file (dsm.opt) orcommand line.Client options file (dsm.opt) or withinclude.fs option.Chapter 12. Using commands 581

Table 78. Incremental command: Related options (continued)OptionWhere to useresetarchiveattribute “Resetarchiveattribute” on Client options file (dsm.opt).page 451skipntpermissions “Skipntpermissions” on page 472 Client options file (dsm.opt) orcommand line.skipntsecuritycrc “Skipntsecuritycrc” on page 472 Client options file (dsm.opt) orcommand line.snapdiff “Snapdiff” on page 473Command line only.snapshotproviderfs “Snapshotproviderfs” on page478snapshotproviderimage “Snapshotproviderimage” onpage 479snapshotroot “Snapshotroot” on page 479subdir “Subdir” on page 489tapeprompt “Tapeprompt” on page 495System-options file (dsm.sys) withina server stanza or with theinclude.fs option.Client options file (dsm.opt) or withthe include.image option.Command line only.Client options file (dsm.opt) orcommand line.Client options file (dsm.opt) orcommand line.ExamplesTaskTaskTaskTaskTaskTaskTaskRun an incremental backup of the default client domain specified in yourclient options file (dsm.opt).Command: IncrementalRun an incremental backup of the c:, d:, and e: drives.Command: ic:d:e:Run an incremental backup of the \home\ngai directory and its contents onthe current drive.Command: i \home\ngai\Assuming that you initiated a snapshot of the C: drive and mounted thesnapshot as \\florence\c$\snapshots\snapshot.0, run an incrementalbackup of all files and directories under the local snapshot and managethem on the Tivoli Storage Manager server under the file space name c:.Command: dsmc inc c: -snapshotroot=\\florence\c$\snapshots\snapshot.0Run a snapdiff incremental backup from a snapshot taken of a networkshare //homestore.example.com/vol1 mounted on drive H:, wherehomestore.example.com is a file server.Run a snapdiff incremental backup from a snapshot taken of a networkshare //homestore.example.com/vol1 mounted on drive H:, wherehomestore.example.com is a file server.Command: incremental -snapdiff H:Run a snapdiff incremental backup from a snapshot taken of a networkshare //homestore.example.com/vol1 mounted on drive H:, where582 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

homestore.example.com is a file server. The -diffsnapshot option value ofLATEST means the operation occurs using the latest snapshot (the activesnapshot) for volume H:.Command: incremental -snapdiff H: -diffsnapshot=LATESTRelated information“Journal-based backup”“Selective” on page 658“Include options” on page 395“Incrthreshold” on page 406Chapter 11, “Processing options,” on page 267 for adaptive subfile backups.Open file supportIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications.Use VSS as the snapshot provider; set snapshotproviderimage orsnapshotproviderfs to VSS.Note:1. You can use the include.fs option to set snapshot options on a per file systembasis.2. Open file support is only available for local fixed volumes (mounted to eitherdrive letters or volume mount points) formatted with NTFS file systems. Thissupport includes SAN-attached volumes that meet these requirements.3. If the client is unable to create a snapshot, failover to non-OFS backup occurs;the same backup support that would be done if the OFS feature was notconfigured.4. To enable open file support in a cluster environment all systems in the clustershould have the OFS feature configured.Journal-based backupIf the journal engine service is installed and running, then by default theincremental command performs a journal-based backup on file systems which arebeing monitored by the journal engine service.Tivoli Storage Manager does not use the journaling facility inherent in WindowsNTFS file systems or any other journaled file system.The journal engine service records changes to an object or its attributes in a journaldatabase. During a journal-based backup, the client obtains a list of files that areeligible for backup from the journal database. Performing backups on a regularbasis maintains the size of the journal.Journal-based backup can increase backup performance. With journal-basedbackup, the client does not scan the local file system or obtain information fromChapter 12. Using commands 583

the server to determine which files to process. Journal-based backup also reducesnetwork traffic between the client and server.Tivoli Storage Manager filters the list based on the current include-exclude list.Tivoli Storage Manager processes, expires, and updates the resulting files accordingto policy constraints, such as serialization. The management-class copy frequencyattribute is ignored during journal-based backup.The journal engine service excludes specific system files (pagefile, registry, etc.)from having changes recorded in the journal. Because changes to these files are notjournaled, Tivoli Storage Manager does not back up these files. See the journalservice configuration file tsmjbbd.ini located in the Tivoli Storage Managerinstallation directory for specific system files that are excluded.To support journal-based backup, you must install the journaling engine service.Install this service by using the dsmcutil command or the GUI Setup wizard.If the file specification on the incremental command is a file space, Tivoli StorageManager processes any journal entries for that file space. Tivoli Storage Managerprocesses directories and wildcarded file specifications in the same way. TivoliStorage Manager uses the domain list if you do not specify a file specification.Note: Journal-based backup might not fall back to the traditional incrementalbackup if the policy domain of your node is changed on the server, depending onwhen the policy set within the domain was last updated and the date of the lastincremental. In this case, you must force a full traditional incremental backup torebind the files to the new domain. Use the nojournal option with the incrementalcommand to specify that you want to perform a traditional full incrementalbackup, instead of the default journal-based backup.When a user deletes a file with a long name, the Windows operating system mightsupply a short, or compressed, name to the journal engine service. After the objectis deleted, the compressed name can be reused and the deletion notice might nolonger identify a unique object. During a journaled incremental backup, theattempt to expire the file fails because the compressed name is not known to theserver. When this occurs, a record is placed in the journal indicating that thecurrent directory is not exactly represented at the server. Use the incrthresholdoption to specify what action is taken when this occurs.Under the following conditions, the journal database is considered invalid and theclient reverts to the traditional full incremental backup:v A journaled file space name has changed.v The client node name has changed.v The client contacts a different server to do the backup.v Policy changes have occurred (new policy set activation).v The journal is corrupt (out of space conditions, disk error).v The journal service is not running.v The journal service is stopped or started for any reason, including system reboot.Journal-based backup differs from the traditional full incremental backup in thefollowing ways:v Tivoli Storage Manager does not enforce non-default copy frequencies (otherthan 0).v Attribute changes to an object require a back up of the entire object.584 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

You can use the nojournal option with the incremental command to perform atraditional full incremental backup instead of the default journal-based backup.Multiple journal-based backup sessions are possible.Backing up NTFS volume mount pointsIf you perform an incremental backup of a file system on which a volume mountpoint exists, IBM Tivoli Storage Manager backs up the directory (junction) wherethe volume is mounted, but it does not traverse or back up the data on themounted volume.For example, if C:\mount is a mount point, then an incremental backup of C: backsup only the junction (C:\mount), and not the data under C:\mount.Related concepts:“Restoring NTFS volume mount points” on page 627“Restoring data on NTFS mounted volumes” on page 627“Backing up data on NTFS mounted volumes”Backing up data on NTFS mounted volumesBacking up a volume from the mount point is especially useful for volumes thathave no drive letter assignment. If the volume mounted on the mount point canalso be referenced by drive letter, then the volume does not have to be backed upover the mount point.For example, if the F: drive is mounted on C:\mount then the data can be backedup by including C:\mount or F: in the domain. In this case, duplicate backups canbe avoided by configuring the domain to back up C:\mount or F:, but not both.To back up the data on the mounted volume, run an incremental backup of themount point using the incremental command:dsmc incremental c:\mountYou can also add C:\mount to the DOMAIN option in order to back up the data onthe mount point as part of a domain incremental backup operation. For example,to back up the system state, C: and the data on the volume mounted on C:\mountas part of a scheduled incremental backup, configure a DOMAIN statement asfollows:domain c: c:\mount systemstateIf you use exclude.dir to exclude C:\mount, then:v The C:\mount directory is not backed up during an incremental backup of C:.v Nothing is backed up during an attempt to back up C:\mount; a message isdisplayed indicating that C:\mount is excluded..Chapter 12. Using commands 585

Related concepts:“Restoring NTFS volume mount points” on page 627“Restoring data on NTFS mounted volumes” on page 627“Backing up NTFS volume mount points” on page 585Back up Microsoft Dfs rootIf you perform an incremental backup of Microsoft Dfs root withdfsbackupmntpnt=yes specified, Tivoli Storage Manager backs up only the junctionpoints, not the subtree under the junctions.If you want to traverse the Dfs tree and back up the files and subdirectories of anyjunction it encounters, specify the dfsbackupmntpnt=no option. If you want tobackup both the Dfs tree structure and the date contained in the Dfs tree you mustrun two backups: one with dfsbackupmntpnt=yes and one withdfsbackupmntpnt=no.This option has no effect if you are backing up individual junctions. Theexclude.dir option behavior for Dfs junctions is same as for mounted virtualvolumes.Note: If a Dfs root is added or modified, Tivoli Storage Manager will not back itup. You must specify the Dfs root in the domain option in the client options file(dsm.opt) regardless of whether DOMAIN ALL-LOCAL is specified.Incremental-by-DateAn incremental-by-date backup backs up new and changed files with amodification date later than the date of the last incremental backup stored at theserver, unless the files are excluded from backup by an exclude statement.If an incremental-by-date is performed on only part of a file system, the date of thelast full incremental is not updated, and the next incremental-by-date will back upthese files again. Use the query filespace command to determine the date and timeof the last incremental backup of the entire file system.To perform an incremental-by-date backup, use the incrbydate option with theincremental command.Unlike a full incremental, an incremental-by-date does not maintain current serverstorage of all your workstation files for the following reasons:v It does not expire backup versions of files that are deleted from the workstation.vvvIt does not rebind backup versions to a new management class if themanagement class has changed.It does not back up files with attributes that have changed, unless themodification 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 to perform backups,but extra time on the weekends, you can perform an incremental-by-date backupon weekdays and a full incremental backup on weekends to maintain currentserver storage of your workstation files.If the incremental command is retried because of a communication failure orsession loss, the transfer statistics will display the number of bytes Tivoli Storage586 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Manager attempted to transfer during all command attempts. Therefore, thestatistics for bytes transferred might not match the file statistics, such as those forfile size.Adaptive subfile backupsIf you plan to perform a backup over a network device with limited bandwidth,such as a modem, you can reduce the network traffic by using the subfilebackupoption.If you plan to use this option, ensure that you specify the subfilebackup,subfilecachepath and subfilecachesize options during the initial backup of yourfile. The options specify whether to perform an adaptive subfile backup along withthe path and size of the data to be transferred.Associate a local snapshot with a server file spaceUse the snapshotroot option with the incremental command in conjunction with avendor-supplied application that provides a snapshot of a logical volume, toassociate the data on the local snapshot with the real file space data that is storedon the Tivoli Storage Manager server.The snapshotroot option does not provide any facilities to take a volume snapshot,only to manage data created by a volume snapshot.LoopThe loop command starts an interactive command-line session that is maintaineduntil you enter quit.If you are required to enter a password, you are prompted for it before the loopmode prompt appears.Note: It is not possible to enter loop mode without a valid server contact. One ofthe consequences is that certain commands, such as restore backupset-location=file, are only accepted on the initial command line when a valid serveris not available.In an interactive command-line session, it is unnecessary to precede each commandname with dsmc and your password, if one is required.In interactive mode, options that you enter on the initial command line overridethe value that you specified in your client options file (dsm.opt). This valueremains in effect for the entire interactive session unless overridden by a differentvalue on a given interactive command. For example, if you set the subdir option toyes in your client options file (dsm.opt), and you specify subdir=no on the initialcommand line, the subdir=no setting remains in effect for the entire interactivesession unless overridden by the subdir=yes value on a given interactivecommand. However, the subdir=yes value only affects the command it is enteredon. When that command completes, the value reverts back to subdir=no, the valueat the beginning of the interactive session.You can enter all valid commands in interactive mode except the schedule andloop commands.Chapter 12. Using commands 587

There are some options that you cannot use in the interactive session created bythe loop command and are identified in the option description by this statement:This option is valid only on the initial command line. It is not valid in interactive mode.Supported ClientsThis command is valid for all clients.Syntax►► LOOP ►◄ParametersThere are no parameters for this command.ExamplesTaskStart an interactive command-line session.Command: dsmcAt the tsm> prompt, enter a command.To end an interactive session, enter quitNote: To interrupt a dsmc command before Tivoli Storage Manager hasfinished processing, enter QQ on the Tivoli Storage Manager console. Inmany cases, but not all, this interrupts the command.Related informationChapter 11, “Processing options,” on page 267 for options that you cannot use ininteractive mode.MacroThe macro command executes a series of commands that you specify in a macrofile.By including the macro command within a macro file, you can nest as many as tenlevels of commands.Comment lines are not supported within the macro file that you specify for themacro command.Supported ClientsThis command is valid for all clients.Syntax►► MAcro macroname ►◄588 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersmacronameSpecifies the fully qualified name of the file containing the commands.ExamplesThe following is an example of how to use the macro command.TaskSelectively back up files in the following directories:v c:\devel\project\projav c:\devel\project\projbv c:\devel\project\projcCommand: macro backabc.macwhere backabc.mac contains the following statements:selective c:\devel\project\proja\*.*selective c:\devel\project\projb\*.*selective c:\devel\project\projc\*.*Monitor ProcessThe monitor process command displays a list of current NAS (if NDMP support isenabled) image backup and restore processes for which the administrative user hasauthority. Tivoli Storage Manager prompts you for an administrator ID.The administrative user can then select one process to monitor. Client ownerprivilege is sufficient authority to monitor the selected NAS image backup orrestore processes.Supported ClientsThis command is valid for all Windows clients.Syntax►► MONitor Process ►◄ParametersThere are no parameters for this command.ExamplesTaskMonitor current NAS image backup or restore processes.Command: monitor processPreview ArchiveThe preview archive command simulates an archive command without sendingdata to the server.The preview archive command generates a tab-delineated text file that can beimported into a spreadsheet program. The preview contains information such asChapter 12. Using commands 589

whether the file is excluded or included. If the file is excluded, the pattern, orreason, that the file is excluded is listed, along with the source for the pattern.Supported ClientsThis command is valid for all clients.Syntax►► PREview Archive filespec-filter=ALL-filter=INCL-filter=EXCL-FILEName= filename►►-CONsole-TRAverse=Yes-TRAverse=No►◄Preview BackupParametersfilespecSpecifies the path and file name that you want to archive. Use wildcardcharacters to select a group of files or all the files in a directory.-filter Specifies the output to display – included objects, excluded objects, orboth.ALL Display output for included and excluded objects. This is thedefault.INCLudedDisplay output for included objects only.EXCLudedDisplay output for excluded objects only.-FILEName=Specifies the filename in which to write the tab-delineated output. Thedefault is dsmprev.txt.-CONsoleOutput is written to the console, and the file.-TRAversePreview the current directory and subdirectories.Yes Preview the current directories and subdirectories. This is thedefault.No Preview only the current directory, not subdirectories.Important: Specifying -traverse does not preview directories excludedusing the exclude.dir option.The preview backup command simulates a backup command without sendingdata to the server.The preview backup command generates a tab-delineated text file that can beimported into a spreadsheet program. The preview contains information such as590 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

whether the file is excluded or included. If the file is excluded, the pattern, orreason, that the file is excluded is listed, along with the source for the pattern.Supported ClientsThis command is valid for all clients.Syntax►► PREview backup filespec-filter=ALL-filter=INCL-filter=EXCL-FILEName= filename►►-CONsole-TRAverse=Yes-TRAverse=No►◄ParametersfilespecSpecifies the path and file name that you want to back up. Use wildcardcharacters to select a group of files or all the files in a directory.-filter Specifies the output to display – included objects, excluded objects, orboth.ALL Display output for included and excluded objects. This is thedefault.INCLudedDisplay output for included objects only.EXCLudedDisplay output for excluded objects only.-FILEName=Specifies the filename in which to write the tab-delineated output. Thedefault is dsmprev.txt.-CONsoleOutput is written to the console, and the file.-TRAversePreview the current directory and subdirectories.Yes Preview the current directories and subdirectories. This is thedefault.No Preview only the current directory, not subdirectories.Important: Specifying -traverse does not preview directories excludedusing the exclude.dir option.Query AccessThe query access command shows who you have given access to backup versionsor archive copies of specific files.Chapter 12. Using commands 591

Tivoli Storage Manager displays a list of authorization rules that you defined withthe set access command or with Node Access List on the graphical user interface(GUI) Utilities menu.The following information is included.v Authority you gave a user to restore backup versions or retrieve archive copies.v The node name of the user to whom you gave authorization.v The files to which the user has access.Supported ClientsThis command is valid for all clients.Syntax►► Query ACcess ►◄Query AdobjectsParametersThere are no parameters for this command.ExamplesTaskDisplay a list of users who have access to your files.Command: query accessUse the query adobjects command to display information about the deleted objectsthat are located on the local Active Directory domain.On Windows Server operating system clients, Active Directory object informationcan also be displayed from full system-state backups on the server.Supported Clients|This command is valid for Windows Server OS clients only.Syntax►►Query ADOBJectssourcepathspecoptions►◄ParameterssourcepathspecSpecifies the Active Directory object or container to query. You can specify anasterisk (*) as a wildcard character. You can specify either the full distinguishedname of an object or a container, or just the name attribute (cn or ou), wherethe wildcard might be used. You can also specify object GUID enclosed inbraces ({}). The following special characters require an escape character, thebackslash, (\), if any of them are contained in the name:\#592 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

+=For example, "cn=test#" is entered as "cn=test\#".Tivoli Storage Manager cannot display any object names that contain anasterisk (*) as part of the name.Table 79. Query Adobjects command: Related optionsOptionWhere to useadlocation “Adlocation” Command line only.on page 295dateformat“Dateformat” Client options file (dsm.opt) or command line.on page 326detail “Detail” on page Command line only.332pitdate (option is ignored Command line only.when adlocation is notspecified)“Pitdate” onpage 435pittime (option is ignoredwhen adlocation is notspecified) “Pittime” onpage 436scrolllines“Scrolllines” on page466scrollprompt“Scrollprompt” on page467timeformat“Timeformat”on page 503Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.ExamplesTaskTaskTaskTaskTaskQuery all local deleted objects.Command: query adobjectsQuery all local deleted objects for a user with the name starting with Fred.Command: query adobjects "cn=Fred*" -detailQuery all objects that are located in the Users container of thebryan.test.example.com domain from the server (Windows Server 2008only).Command: query adobjects "cn=Users,DC=bryan,DC=test,DC=ibm,DC=com"-adloc=serverQuery all local deleted objects for organizational unit testou.Command: query adobjects "ou=testou"Query the local deleted object with a GUID of E079130D-3451-4C69-8349-31747E26C75B.Command: query adobjects {E079130D-3451-4C69-8349-31747E26C75B}Chapter 12. Using commands 593

Query ArchiveThe query archive command displays a list of your archived files and thefollowing information about each file: file size, archive date, file specification,expiration date, and archive description.If you use the detail option with the query archive command, the client displaysthe following additional information:v Last modification datev Creation datev Compressionv Encryption typev Client-side data deduplicationv Retention initiationv Whether or not the file is on holdSize Archive Date - Time File - Expires on - Description---- ------------------- -------------------------------219 B 09/03/2009 09:32:13 \\halley\m$\tsm620c.0901fa\debug\bin\winnt_unicode\dsm.opt 09/03/2010Archive Date: 09/03/2009RetInit:STARTED ObjHeld:NOModified: 09/02/2009 19:43:00 Created: 09/01/2009 15:31:23Compressed: NO Encryption Type: NoneClient-deduplicated: NOSupported ClientsThis command is valid for all clients.Syntax►►Query ARchiveoptionsfilespec{ filespacename } filespec►◄ParametersfilespecSpecifies the path and file name that you want to query. Use wildcardcharacters to specify a group of files or all the files in a directory.If you include filespacename, do not include a drive letter in the filespecification. Drive label names are only used for removable media.{filespacename}Specifies the file space (enclosed in braces) on the server that contains the filethat you want to query. This is the name on the workstation drive from whichthe file was archived. The following example is valid for specifying a UNCname: {'\\machine\C$'}.Use the filespacename if the name has changed or if you are querying files thatwere archived from another node with drive labels that are different fromyours.Note: You must specify a mixed or lowercase NTFS filespacename enclosed inquotation marks within braces, for example, {"NTFSDrive"}. Single quotation594 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

marks or double quotation marks are valid in loop mode. For example:{"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only singlequotation marks are valid.Table 80. Query Archive command: Related optionsOptionWhere to usedateformat “Dateformat” Client options file (dsm.opt) or command line.on page 326descriptionCommand line only.“Description” on page331detail “Detail” on page332dirsonly “Dirsonly” onpage 337filelist “Filelist” onpage 380filesonly “Filesonly” onpage 383fromdate “Fromdate” onpage 384fromnode “Fromnode” onpage 385fromtime “Fromtime” onpage 386numberformat“Numberformat” on page429querysummary“Querysummary” on page447scrolllines“Scrolllines” on page466scrollprompt“Scrollprompt” on page467subdir “Subdir” on page489timeformat “Timeformat”on page 503todate “Todate” on page506totime “Totime” on page507Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Client options file (dsm.opt) or command line.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.ExamplesTask Display a list of all your archived files in the c:\proj directory.Command: q ar c:\proj\*Chapter 12. Using commands 595

TaskTaskTaskTaskTaskTaskDisplay a list of archived files from your c: drive with the description"January Ledgers."Command: query archive c:\ -su=y -descr="January Ledgers"Display a list of all your archived files in the c:\proj directory. Use thedateformat and timeformat options to reformat the dates and times.Command: q ar –date=5 –time=4 c:\proj\*Display a list of all your archived files in the c:\dir1 directory. Use thedetail option to display the last modification date and the creation date ofeach file.Command: q ar -detail c:\dir1\*Display a list of archived files in the c:\proj directory containing a fileextension of .dev. Use the dateformat and timeformat options.Command: q ar –date=5 –time=4 c:\proj\*.devLast week you changed the label of your c: drive to store and archivedsome files. Yesterday you changed the label to dev and archived more files.Display a list of all the files you archived in the c:\proj directory whenthe label was store.Command: q ar {store}\proj\*Last week you archived files from a diskette labeled docs. Display a list ofall the files you archived.Command: q ar {docs}\*Query BackupThe query backup command displays a list of backup versions of your files thatare stored on the Tivoli Storage Manager, or that are inside a backup set from theserver when the backupsetname option is specified.The command displays the following file information:v File specificationv File sizev Backup datev Whether the file is active or inactivev The management class that is assigned to the file. Only the first ten characters ofthe management class name appear.If you use the detail option with the query backup command, the client displaysthe following additional information:v Last modification datev Creation datev Compressionv Encryption typev Client-side data deduplicationSupported ClientsThis command is valid for all clients.596 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►►Query Backupoptionsfilespec{ filespacename } filespec►◄||ParametersfilespecSpecifies the path and file name that you want to query. Use wildcardcharacters to specify a group of files or all the files in a directory. Do not usewild cards when you query NAS file system images with -class=nas optionsetting.If you include filespacename, do not include a drive letter in the filespecification. Drive label names are only used for removable media.You can also use the following value for filespec:systemstateDisplays the list of backup versions of Windows system state.{filespacename}Specifies the file space, enclosed in braces, on the server that contains the fileyou want to query. This is the drive label or UNC name on the workstationdrive from which the file was backed up. The following example shows howto specify a UNC name: {’\\machine\C$’}.Use the filespacename if the name has changed, or if you want to query filesbacked up from another node with drive label names that are different fromyours.You must specify a mixed or lowercase NTFS file space name enclosed inquotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks or double quotation marks are valid in loop mode. For example:{"NTFSDrive"} and {’NTFSDrive’} are both valid. In batch mode, only singlequotation marks are valid.Table 81. Query Backup command: Related optionsOptionWhere to usebackupsetnameCommand line only.“Backupsetname” on page306class “Class” on page 310dateformat “Dateformat”on page 326detail “Detail” on page332dirsonly “Dirsonly” onpage 337filelist “Filelist” onpage 380filesonly “Filesonly” onpage 383fromdate “Fromdate” onpage 384Command line only.Client options file (dsm.opt) or command line.Command line only.Command line only.Command line only.Command line only.Command line only.Chapter 12. Using commands 597

Table 81. Query Backup command: Related options (continued)OptionWhere to usefromowner “Fromnode” on Command line only.page 385fromtime “Fromtime” on Command line only.page 386inactive “Inactive” on Command line only.page 393nasnodenameClient options file (dsm.opt) or command line.“Nasnodename” on page425numberformat“Numberformat” on page429pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436querysummary“Querysummary” on page447scrolllines“Scrolllines” on page466scrollprompt“Scrollprompt” on page467subdir “Subdir” on page489timeformat “Timeformat”on page 503todate “Todate” on page506totime “Totime” on page507Client options file (dsm.opt) or command line.Command line only.Command line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.Examplesdsmc query backup c:\* -subdir=yes -querysummarydsmc query archive c:\* -subdir=yes -querysummaryTask Query files from the abc file space proj directory.Command: q b {"abc"}\proj\*.*Task Display a list of all active and inactive backup versions that were backedup from the c:\proj directory.Command: q backup –ina c:\proj\*Task Display a list of all your backups in the c:\dir1 directory. Use the detailoption to display the last modification date and the creation date of eachfile.598 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Command: q backup -detail c:\dir1\*TaskTaskTaskTaskTaskTaskDisplay a list of all active and inactive backup versions that were backedup from the c:\proj directory. Use the dateformat and timeformat optionsto reformat the dates and times.Command: q b –date=5 –time=4 –ina c:\proj\*Last week you backed up files from a diskette labeled docs. Display a listof those files.Command: q b {docs}\*Query file system images from the nas2 NAS file server.Command: query backup -nasnodename=nas2 -class=nasDisplay a list of all files from your c: drive that are contained in thebackup set weekly_accounting_data.32145678.Command: query backup c:\* -subdir=yes-backupsetname=weekly_accounting_data.32145678Display a list of all the files that are contained in the backup setweekly_accounting.32145678.Command: query filespace -backupsetname=weekly_accounting.32145678Display information about all the active and inactive backup versions ofthe system state on the server.Command: query backup -ina systemstateRelated information“Restore data from a backup set” on page 185Query NAS file system imagesYou can use the query backup command to display information about file systemimages backed up for a NAS file server. Tivoli Storage Manager prompts you foran administrator ID.Query BackupsetWhere supported, use the nasnodename option to identify the NAS file server toquery. Place the nasnodename option in your client options file (dsm.opt). The valuein the client options file is the default, but this value can be overridden on thecommand line.Use the class option to specify the class of the file space to query. To display a listof images belonging to a NAS node, use the -class=nas option.Related reference:“Class” on page 310“Nasnodename” on page 425The query backupset command queries a backup set from a local file, tape device(if applicable) or the Tivoli Storage Manager server.This command displays the backup set name, generation date, retention (for abackup set on a Tivoli Storage Manager server), and user-supplied description.Chapter 12. Using commands 599

Supported ClientsThis command is valid for all clients.Syntax►►Query BACKUPSEToptionsBACKUPSETName=backupsetnamelocalfilenametapedevice►►LOCation=serverfiletape►◄ParametersBACKUPSETName=Specifies the name of a backup set you want to query. You can use wildcardsto specify the backup set name. If you use wildcards or do not specify abackup set name, all backup sets that you own are displayed. This parameteris required.The value of backupsetname depends on the location of the backup set, andcorresponds to one of the three choices below.backupsetnameSpecifies the name of the backup set from the Tivoli Storage Managerserver. If the location parameter is specified, you must set-location=server.localfilenameSpecifies the file name of the first backup set volume. You must set-location=file.tapedeviceSpecifies the name of the tape device containing the backup setvolume. You must use a Windows native device driver, not the devicedriver provided by Tivoli. You must set -location=tape.LOCation=Specifies where Tivoli Storage Manager searches for the backup set. If you donot specify the location parameter, the client searches for backup sets on theTivoli Storage Manager server.serverfiletapeSpecifies that Tivoli Storage Manager searches for the backup set fromthe server. This is the default.Specifies that Tivoli Storage Manager searches for the backup set froma local file.Specifies that Tivoli Storage Manager searches for the backup set froma local tape device.Table 82. Query Backupset command: Related optionsOptionWhere to usedescriptionCommand line only.“Description” on page331600 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 82. Query Backupset command: Related options (continued)OptionWhere to usescrolllines“Scrolllines” Client options file (dsm.opt) or command line.on page 466scrollpromptClient options file (dsm.opt) or command line.“Scrollprompt” on page467ExamplesTaskTaskTaskTaskQuery all backup sets from the Tivoli Storage Manager server.Command: query backupset -backupsetname=*Query a backup set called monthy_financial_data from the Tivoli StorageManager server.Command: query backupset-backupsetname=monthly_financial_data.12345678Query the backup set in the filec:\budget\weekly_budget_data.ost.Command: query backupset -backupsetname=c:\budget\weekly_budget_data.ost loc=fileQuery the backup set from the \\.\tape0 tape device.Command: dsmc query backupset -backupsetname=\\.\tape0 -loc=tapeRelated information“Restore data from a backup set” on page 185Query Backupset without the backupsetname parameterThe query backupset command can be used without the backupsetname parameter.The preferred syntax for query backupset command requires the backupsetnameparameter. Prior to the introduction of the backupsetname parameter, the TivoliStorage Manager client queried backup sets with a different syntax.While you can use syntax from previous releases for this command, do not do sounless you have a specific need and cannot replace the old syntax with the syntaxin Tivoli Storage Manager Version 6.1. For best results, use the backupsetnameparameter.Supported ClientsThis command is valid for all clients. Tape support is only available on AIX,Solaris, and HP-UX.Syntax►►Query BACKUPSEToptionsbackupsetnamelocalfilenametapedeviceLOCation=serverfiletape►◄Chapter 12. Using commands 601

ParametersbackupsetnameSpecifies the name of the backup set from the Tivoli Storage Manager server. Ifthe location parameter is specified, you must set -location=server.localfilenameSpecifies the file name of the first backup set volume. You must set-location=file.tapedeviceSpecifies the name of the tape device containing the backup set volume. Youmust use a Windows native device driver, not the device driver provided byTivoli. You must set -location=tape.LOCation=Specifies where Tivoli Storage Manager searches for the backup set. If you donot specify the location parameter, the client searches for backup sets on theTivoli Storage Manager server.serverfiletapeSpecifies that Tivoli Storage Manager searches for the backup set fromthe server. This is the default.Specifies that Tivoli Storage Manager searches for the backup set froma local file.Specifies that Tivoli Storage Manager searches for the backup set froma local tape device.Table 83. Query Backupset command: Related optionsOptionWhere to usedescriptionCommand line only.“Description” on page331scrolllines“Scrolllines”on page 466scrollprompt“Scrollprompt” on page467Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.ExamplesTaskTaskTaskTaskQuery all backup sets from the Tivoli Storage Manager server.Command: query backupsetQuery a backup set called monthy_financial_data from the Tivoli StorageManager server.Command: query backupset monthly_financial_data.12345678Query the backup set in the filec:\budget\weekly_budget_data.ost.Command: query backupset c:\budget\weekly_budget_data.ost loc=fileQuery the backup set from the \\.\tape0 tape device.Command: dsmc query backupset \\.\tape0 -loc=tapeRelated information“Restore data from a backup set” on page 185602 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Query FilespaceThe query filespace command displays a list of file spaces for a node that arestored on the Tivoli Storage Manager server, or that are inside a backup set fromthe Tivoli Storage Manager server, when the backupsetname option is specified. Youcan also specify a single file space name to query.A file space is a logical space on the server that contains files you backed up orarchived. Tivoli Storage Manager assigns a separate file space on the server foreach node at your workstation from which you back up or archive files.Tivoli Storage Manager assigns a separate file space on the server for each filesystem at your workstation from which you back up or archive files. The file spacename is the same as the file system name.A Unicode file space name might not display correctly if the server is unable todisplay the Unicode name. In this case, use the file space identifier (fsID) toidentify these file spaces on the server. Use the query filespace command with thedetail option to determine the fsID of a file space.Supported ClientsThis command is valid for all clients.Syntax►►Query Filespacefilespacenameoptions►◄ParametersfilespacenameSpecifies an optional character string which can include wildcards. Use thisargument to specify a subset of file spaces. The default is to display all filespaces.Table 84. Query Filespace command: Related optionsOptionWhere to usebackupsetnameCommand line only.“Backupsetname” on page306class “Class” on page 310dateformat “Dateformat”on page 326detail “Detail” on page332fromnode “Fromnode” onpage 385nasnodename“Nasnodename” on page425scrolllines“Scrolllines” on page466Command line only.Client options file (dsm.opt) or command line.Command line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Chapter 12. Using commands 603

Table 84. Query Filespace command: Related options (continued)OptionWhere to usescrollpromptClient options file (dsm.opt) or command line.“Scrollprompt” on page467timeformat “Timeformat”on page 503Client options file (dsm.opt) or command line.ExamplesDisplay your file spaces. Use the dateformat and timeformat options to reformatthe dates and times.query filespace –date=5 –time=4Query a file space from the nas2 NAS file server.query filespace -nasnodename=nas2 -class=nasDisplay the \\florence\c$ file space.query filespace \\florence\c$Display all of the file space names on the server with a file space name ending in'$' belonging to system named florence.query filespace \\florence\*$Display file spaces in the backup set named monthly_accounting.23456789.query filespace -backupsetname=monthly_accounting.23456789Related information“Restore data from a backup set” on page 185“Nasnodename” on page 425“Class” on page 310Query NAS file spacesUse the nasnodename option to identify the NAS file server to query. When usingan interactive command-line session with a non-administrative ID, Tivoli StorageManager prompts for an administrator ID.Place the nasnodename option in your client options file (dsm.opt). The value in theclient options file is the default, but this value can be overridden on the commandline. If the nasnodename option is not specified in the client options file, it must bespecified on the command line when processing NAS file systems.Use the class option to specify the class of the object to query. To display a list offile spaces belonging to a NAS node, use the -class=nas option.604 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Query GroupUse the query group command to display information about a group backup andits members.Note:1. Use the showmembers option to display and select individual group membersthat you want to query. The showmembers option is not valid with the inactiveoption. If you want to display members of a group that are not currently active,use the pitdate and pittime options to specify the backup date and time of themember you want to query.2. Use the query filespace command to display virtual file space names for yournode that are stored on the Tivoli Storage Manager server.3. If you perform a full and differential group backup, a query of this group usingthe -inactive option displays two active backups of the same name, one oftype FULL and one of type DIFF.These backups inactivate any previous full and differential backups:tsm> q group {\fs}\v1 -inactiveSize Backup DateMgmt Class A/I Group—––– ––––––––––– –––––––––– ––– ––––––978 B 06/02/2007 11:57:04 DEFAULT A FULL \fs\v132 B 06/05/2007 13:52:04 DEFAULT A DIFF \fs\v1If you query a group backup without the -inactive option, the query displaysonly the latest group backup, whether it is type FULL or type DIFF:tsm> q group {\fs}\v1Size Backup DateMgmt Class A/I Group—––– ––––––––––– –––––––––– ––– ––––––32 B 06/05/2007 13:52:04 DEFAULT A DIFF \fs\v1Supported ClientsThis option is valid for all clients.Syntax►► Query GRoup filespecoptions►◄ParametersfilespecSpecifies the virtual file space name (enclosed in braces) and the group nameon the server that you want to query.Table 85. Query Group command: Related optionsOptionWhere to usefromnode “Fromnode” on Command line only.page 385inactive “Inactive” on Command line only.page 393pitdate “Pitdate” on Command line only.page 435Chapter 12. Using commands 605

Table 85. Query Group command: Related options (continued)Optionpittime “Pittime” onpage 436showmembers“Showmembers” on page470 (does not apply toMac OS X)Where to useCommand line only.Command line only.ExamplesTaskTaskTaskDisplay all the groups in the virtfs file space.Command:query group {virtfs}\*Display active and inactive versions of the virtfs\group1 file space.Command:query group {virtfs}\group1 -inactiveDisplay the virtfs\group1 file space. Use the showmembers option todisplay a list of group members from which you can select one or more toquery.Command:query group {virtfs}\group1 -showmembersRelated information“Query Filespace” on page 603Query ImageThe query image command displays information about file system images that arestored on the Tivoli Storage Manager server, or that are inside a backup set fromthe Tivoli Storage Manager server, when the backupsetname option is specified.The following information about file system images is displayed:v Image Size - This is the volume size which was backed up.v Stored Size - This is the actual image size stored on the server. Because imagebackup allows you to back up only used blocks in a file system, the storedimage size on the Tivoli Storage Manager server could be smaller than thevolume size. For online image backups, the stored image can be larger than thefile system based on the size of the cache files.v File system typev Backup date and timev Management class assigned to image backupv Whether the image backup is an active or inactive copyv The image nameNote: The Tivoli Storage Manager API must be installed to use the query imagecommand.606 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis command is valid for all Windows clients.Syntax►►Query IMageoptionslogicalvolumenamefilespacename►◄ParameterslogicalvolumenameThe name of a logical volume you want to query. You must specify the exactname of the image. You cannot use wildcards. The default is all active images(unless restricted by one or more options).filespacenameSpecifies the file system name that you want to query.Omitting logicalvolumename and filespacename causes all images to be displayed.Table 86. Query Image command: Related optionsOptionWhere to usebackupsetnameCommand line only.“Backupsetname” on page306dateformat “Dateformat”on page 326fromnode “Fromnode” onpage 385inactive “Inactive” onpage 393numberformat“Numberformat” on page429pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436scrolllines“Scrolllines” on page466scrollprompt“Scrollprompt” on page467timeformat “Timeformat”on page 503Client option file (dsm.opt) or command line.Command line only.Command line only.Client option file (dsm.opt) or command line.Command line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client option file (dsm.opt) or command line.ExamplesTask Display all backed up images.Command: q imageTask Display active and inactive version of the h: image.Chapter 12. Using commands 607

TaskCommand: q im h: -inactiveDisplay all images that are contained within the backup setweekly_backup_data.32145678.Command: query image -backupsetname=weekly_backup_data.32145678Related information“Restore data from a backup set” on page 185|||||||||||||||||Query InclexclThe query inclexcl command displays a list of include-exclude statements in theorder in which they are processed during backup and archive operations. The listdisplays the type of option, the scope of the option (archive, all, and so on), andthe name of the source file.Tivoli Storage Manager excludes some files from file system backup and restoreoperations. You can use the query inclexcl command to display a list of these files.In the output of the command, these files have Operating System next to the path.You can test the validity of patterns you want to use in your include-exclude listbefore you actually insert them in your options file. See the test pattern explanation.Use the detail option to display the management class that is associated with aninclude-exclude statement.Use the display option to display the files that are included or excluded from afile system back up operation.Supported ClientsThis command is valid for all clients.Syntax||►►Query INCLexcltest pattern -DETail basic-DISPLAY= vssexclall►◄||||||||||Parameterstest patternUse for testing the validity of patterns you want to use in your include-excludelist. When you use a test pattern with this command, the following occurs:v The internal include-exclude list is not displayedv The pattern is processed as if it came from an include-exclude statement,including all the usual error checkingv The pattern is displayed as it would appear in the include-exclude listIf the test pattern has no errors, the compiled pattern result is the same as thetest pattern.608 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

||||||||||||||||||||||||||||||||||-DETailDisplays the management class that is associated with the include-excludestatement.-DISPLAY=basic | vssexcl | all-DISPLAY=basic displays the files and directories that have been included orexcluded by one of the following methods:v The objects were included or excluded in the client options file.v The objects were included or excluded in a server-side client option set.v The objects were excluded by the operating system because they arecontained in the HKEY_LOCAL_MACHINES\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackup registry key.v The objects were explicitly excluded by IBM Tivoli Storage Manager.This is the default if a display value is not specified.-DISPLAY=vssexcl displays a list of files that are excluded from a file systembackup, because they are included when a system state backup is performed.Files that are backed up by a backup systemstate operation are protected bythe VSS writer; you cannot include these files in a file system backup byadding them to an include statement in the dsm.opt file, or client option set.-DISPLAY=all displays all files that are included or excluded during a filesystem backup.ExamplesTaskTaskTaskTaskTaskQuery MgmtclassExclude a file from deduplication by excluding it in the client options file:Exclude Dedup *\...\file2Display a basic list of include-exclude statements. Command:query inclexclDisplay a list of files that are excluded from file system backups becausethe VSS writer includes them in system state backups.query inclexcl -display=vssexclDisplay a list of include-exclude statements. Display the management classthat is associated with each statement.query inclexcl -detailTest the validity of this pattern: ..\?x?\*.logquery inclexcl ..\?x?\*.logThe query mgmtclass command displays information about the managementclasses available in your active policy set.Your administrator defines management classes that contain attributes controllingwhether a file is eligible for backup or archive services. Management classes alsodetermine how backups and archives are managed on the server.Your active policy set contains a default management class; it can contain anynumber of additional management classes. You can assign specific managementclasses to files using include options that are located in the client options file(dsm.opt). If you do not assign a management class to a file, Tivoli StorageManager uses the default management class.Chapter 12. Using commands 609

When you archive files, you can override the assigned management class by usingthe archmc option.Supported ClientsThis command is valid for all clients.Syntax►►Query Mgmtclassoptions►◄ParametersTable 87. Query Mgmtclass command: Related optionsOptionWhere to usedetail “Detail” on page Command line only.332fromnode “Fromnode” on Command line only.page 385ExamplesTask Display default and available management classes.Command: query mgmtclassQuery NodeThe query node command displays all the nodes for which an administrative userID has authority to perform operations. Tivoli Storage Manager prompts you foran administrator ID.The administrative user ID should have at least client owner authority over theclient workstation node they are using either from the command line or from theweb.Use the type option to specify the type of node to filter for. The following are thevalid values.v nasv clientv serverv anyThe default is any.Note: When the Tivoli Storage Manager for Virtual Environments license file isinstalled on a VMware vStorage Backup server, the platform string that is storedon the Tivoli Storage Manager server is set to “TDP VMware” for every nodenamethat is used on that machine. This occurs because the server has the TSM for VElicense. The platform string can be used in the context of PVU calculations. If anodename is being used to back up the machine with standard Backup-Archiveclient functions (e.g., file-level or image backup), then this platform string shouldbe interpreted as a “client” for the purposes of PVU calculations.610 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

See in the IBM Tivoli Storage Manager Administrator's Guide for more information.See Estimating processor value units in the IBM Tivoli Storage Manager Administrator'sGuide for more information.Supported ClientsThis command is valid for all clients.Syntax►►Query Nodeoptions►◄ParametersTable 88. Query Node command: Related optionsOptionWhere to usetype “Type” on page 509 Command line only.scrolllinesClient options file (dsm.opt) or command line.“Scrolllines” on page466scrollprompt“Scrollprompt” on page467Client options file (dsm.opt) or command line.Query OptionsExamplesTaskDisplay all NAS nodes.Command: query node -type=nasRelated information“Type” on page 509Use the query options command to display all or part of your options and theircurrent settings relevant to the command-line client.Supported ClientsThis command is valid for all clients.Syntax►►Query Optionsoptionspattern►◄Chapter 12. Using commands 611

ParameterspatternAn optional character string which can include wildcards. Use this argumentto specify a subset of options. The default is to display all options.Table 89. Query Options command: Related optionsOptionWhere to usescrolllinesClient options file (dsm.opt) or command line.“Scrolllines” on page466scrollprompt“Scrollprompt” on page467Client options file (dsm.opt) or command line.Query RestoreExamplesTaskTaskTaskDisplay all options and their values.Command: query optionsDisplay only options beginning with comm.Command: query options comm*Display the value of the replace option.Command: query options replaceThe query restore command displays a list of your restartable restore sessions inthe server database. The list contains these fields: owner, replace, subdir,preservepath, source, and destination.A restartable restore session is created when a wildcard restore command failsbecause of network outage, client failure, server outage, or a similar problem.When such a failure occurs, the file space is locked on the server and its filescannot be moved off the sequential volumes of the server. To unlock the file space,either restart the restore and allow it to complete (query restore command), orcancel the restore (cancel restore command). Use query restore to determine if youhave any restartable restore sessions and which file spaces are affected.Supported ClientsThis command is valid for all clients.Syntax►► Query Restore ►◄ParametersThere are no parameters for this command.ExamplesTask The following example displays the output when you use query restore:612 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Query Schedule--- Restartable Restore Information ---Restartable Session: 1Start date/time: 10/17/2001 15:18:22Source: {"\\ers\c$"}\data\proposals\*Destination: - not specified by user -Restartable Session: 2Start date/time: 10/17/2001 15:20:01Source: {"\\ers\c$"}\data\spreadsheets\*Destination: - not specified by user -The query schedule command displays the events scheduled for your node. Youradministrator can set up schedules to perform automatic backups and archives foryou. To plan your work, use this command to determine when the next scheduledevents occur.The enhanced query schedule command on a Tivoli Storage Manager Version 5.3and above client reports new parameters. The query schedule command prior toTivoli Storage Manager Version 5.3 is referred to as classic. Refer to theAdministrator's Guide and Administrator's Reference for your operating system formore information on the classic and enhanced commands.Supported ClientsThis command is valid for all clients.Syntax►► Query SChedule ►◄Query SessionParametersThere are no parameters for this command.ExamplesTaskDisplay your scheduled events.Command: query scheduleThe query session command displays information about your session, includingthe current node name, when the session was established, server information, andserver connection information.Supported ClientsThis command is valid for all clients.Syntax►► Query SEssion ►◄Chapter 12. Using commands 613

ParametersThere are no parameters for this command.ExamplesTaskQuery SysteminfoDisplay your session information.Command: query sessionA sample query session display follows:Server Name.............: HALLEY_SERVER1Server Type.............: WindowsArchive Retain Protect..: "No"Server Version..........: Ver. 6, Rel. 2, Lev. 0.0Last Access Date........: 09/03/2009 09:08:13Delete Backup Files.....: "No"Delete Archive Files....: "Yes"Deduplication...........: "Server Only"Node Name...............: HALLEYUser Name...............:The possible client-side deduplication values are:v None– This is displayed when connected to pre-V6.1 Tivoli Storage Managerserverv Server Onlyv Client Or ServerUse the query systeminfo command to gather information and output thisinformation to a file or the console.This command is intended primarily as an aid for IBM support to assist indiagnosing problems, although users who are familiar with the concepts addressedby this information might also find it useful.If you use the console option, no special formatting of the output is performed toaccommodate screen height or width. Therefore, the console output can be difficultto read due to length and line-wrapping. If the console output is difficult to read,use the filename option with the query systeminfo command to allow the outputto be written to a file that can subsequently be submitted to IBM support.Supported ClientsThis command is valid for all clients.Syntax►► Query SYSTEMInfo ▼ itemoptions►◄614 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

ParametersitemSpecifies one or more items from which you want to gather information andoutput the information to the file name that you specify with the filenameoption or to the console. The default is to gather all items.You can gather information on one or more of the following items:v DSMOPTFILE - The contents of dsm.opt file.v ENV - Environment variables.v ERRORLOG - The Tivoli Storage Manager error log file.v FILE - Attributes for the file name that you specify.v FILESNOTTOBACKUP - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackupThis key specifies those files that backup products should not back up. Thequery inclexcl command indicates that these files are excluded per the operatingsystem.v INCLEXCL - Compiles a list of include-exclude in the order in which they areprocessed during backup and archive operations.v KEYSNOTTORESTORE - Enumeration of Windows Registry key:HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\BackupRestore\KeysNotToRestoreThis key specifies those Windows Registry keys that backup products should notrestore.v MSINFO - Windows system information (output from MSINFO32.EXE).v OPTIONS - Compiled options.v OSINFO - Name and version of the client operating systemv POLICY - Policy set dump.v REGISTRY - Windows Tivoli Storage Manager-related Windows Registry entries.v SCHEDLOG - The contents of the Tivoli Storage Manager schedule log (usuallydsmsched.log).v SFP - The list of files protected by Windows System File Protection, and for eachfile, indicates whether that file exists. These files are backed up as part of theSYSFILES system object.v SFP= - Indicates whether the specified file (filename) is protected byWindows System File Protection. For example:SFP=C:\WINNT\SYSTEM32\MSVCRT.DLLv SYSTEMSTATE - Windows system state information.v CLUSTER - Windows cluster information.v ENCRYPT - Available encryption methods.Note:1. Use the filename option to specify a file name in which to store theinformation gathered from the items you specify. If you do not specify a filename, by default the information is stored in the dsminfo.txt file.Chapter 12. Using commands 615

2. Use the console option if you want to output the information to the console.Table 90. Query Systeminfo command: Related optionsOptionWhere to useconsole “Console” on Command line only.page 322filename “Filename” on Command line only.page 382ExamplesTaskQuery SystemstateGather and store the contents of the dsm.opt file and the Tivoli StorageManager error log file in the tsminfo.txt file.Command: query systeminfo dsmoptfile errorlog-filename=tsminfo.txtRelated information“Filename” on page 382“Console” on page 322Use the query systemstate command to display information about a backup of thesystem state on the Tivoli Storage Manager server, or system state inside a backupset from the Tivoli Storage Manager server, when the backupsetname option isspecified.The output indicates whether the object is active ("A") or inactive ("I"). Only activeobjects are listed unless the inactive option is specified with the command. TheTivoli Storage Manager Windows client supports standard and detailed format.Supported Clients|This command is valid for supported Windows clients only.Syntax►►Query SYSTEMSTateoptions►◄ParametersTable 91. Query Systemstate command: Related optionsOptionWhere to usebackupsetnameCommand line only.“Backupsetname” on page306dateformat “Dateformat”on page 326inactive “Inactive” onpage 393Client option file (dsm.opt) or command line.Command line only.616 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 91. Query Systemstate command: Related options (continued)OptionWhere to usenumberformatClient option file (dsm.opt) or command line.“Numberformat” on page429pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436showmembers“Showmembers” on page470timeformat “Timeformat”on page 503detail “Detail” on page332Command line only.Command line only.Command line only.Client option file (dsm.opt) or command line.Command line only.ExamplesTaskTaskTaskTaskDisplay information about the active backup of the system state on theTivoli Storage Manager server.Command: query systemstateDisplay information about the active backup of the system state on theTivoli Storage Manager server.Command: query systemstate -detailDisplay information about the active backup of the system state containedwithin the backup set daily_backup_data.12345678.Command: query systemstate-backupsetname=daily_backup_data.12345678To display information about Active Directory, enter the followingcommand: query systemstate -detail.Locate information related to Active Directory in the output.Query VMUse the query VM command to verify the successful backups of virtual machines.The Query VM command can be used to verify backups of both Microsoft Hyper-Vvirtual machines and VMware virtual machines. The information for eachhypervisor is presented in its own section. If you are querying the backups ofHyper-V virtual machines, you can skip over the Query VM for VMware virtualmachines text. If you are querying backups of VMware virtual machines, you donot need to read the Query VM for Hyper-V virtual machines text.Query VM for VMware virtual machinesUse the Query VM command to verify which VMware virtual machines werebacked up.Chapter 12. Using commands 617

Supported ClientsThis command is valid on Windows clients that are installed on a vStorage backupserver.Syntax►► Query VM vmnameoptions►◄ParametersvmnameSpecifies the virtual machine host name that you want to process.You can also specify the wildcard character "*" to show all vm backups on theTivoli Storage Manager server.|Table 92. Query VM command: Related options for VMware virtual machine queries.OptionWhere to usedetail “Detail” on page 332Command line.|Valid for vmbackuptype=fullvminactive “Inactive” on page 393Valid for vmbackuptype=fullvmpitdate “Pitdate” on page 435Valid for vmbackuptype=fullvmpittime “Pittime” on page 436Valid for vmbackuptype=fullvmvmbackuptype “Vmbackuptype” on page 517vmchost “Vmchost” on page 520vmcpw “Vmcpw” on page 521vmcuser “Vmcuser” on page 522Command line.Command line.Command line.Command line or client options file.Command line or client options file.Command line or client options file.Command line or client options file.Query VM examples (VMware)||The following are samples of using the query VM command with full VM andfile-level VM, and with full VM and the -detail option.Full VM618 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

tsm> QUERY VM * -INA -vmbackuptype=FULLVM# Backup Date Mgmt Class Type A/I VirtualMachine__ ___________ __________ ____ ___ _______1 09/26/2008 DEFAULT VMFULL A vm111:34:142 09/26/2008 DEFAULT VMFULL A vm211:34:373 09/26/2008 DEFAULT VMFULL A vm311:34:494 09/26/2008 DEFAULT VMFULL I vm212:35:085 09/26/2008 DEFAULT VMFULL I vm312:35:18|||||||||||||||||||||||||||||Full VM with -detail optionFile Level[root@BAclient]# dsmc q vm Small-SQL -detailIBM Tivoli Storage ManagerCommand Line Backup-Archive Client InterfaceClient Version 6, Release 4, Level 0.0Client date/time: 06/26/2012 14:08:44(c) Copyright by IBM Corporation and other(s) 1990, 2012. All Rights Reserved.Node Name: BAClient-DMSession established with server TSM_SERVER1: WindowsServer Version 6, Release 3, Level 0.0Server date/time: 06/26/2012 14:37:39 Last access: 06/26/2012 14:22:55Query Virtual Machine for Full VM backup# Backup Date Mgmt Class Size Type A/I Virtual Machine--- ------------------- ---------- ----------- ------ --- ---------------1 06/26/2012 14:07:13 STANDARD 19.53 GB FULL A Small-SQLThe size of this incremental backup: n/aThe number of incremental backups since last full: n/aThe amount of extra data: n/aThe TSM objects fragmentation: n/aBackup is represented by: n/aApplication protection type: TSM VSSApplication(s) protected: MS SQL 2008VMDK[1]Label: Hard disk 1VMDK[1]Name: [datastore1] Cloned-Small-SQL/Cloned-Small-SQL-000001.vmdkVMDK[1]Status: ProtectedChapter 12. Using commands 619

tsm> QUERY VM * -vmbackuptype=FILEFilespace Query for Virtual Machine ’vm1’Accessing as node: vm1# Last Incr Date Type File Space Name__ ___________________ ____ _______________1 09/25/2008 12:19:23 NTFS \\vm1\c$ fsID: 22 09/25/2008 12:19:25 NTFS \\vm1\e$ fsID: 33 09/25/2008 12:19:22 NTFS \\vm1\z$ fsID: 1Filespace Query for Virtual Machine ’vm2’Accessing as node: vm2# Last Incr Date Type File Space Name__ ___________________ ____ _______________1 09/25/2008 10:49:10 NTFS \\vm2\c$ fsID: 22 09/25/2008 10:49:09 NTFS \\vm2\h$ fsID: 1Filespace Query for Virtual Machine ’vm3’Accessing as node: vm3# Last Incr Date Type File Space Name__ ___________________ ____ _______________1 09/25/2008 10:49:22 NTFS \\vm3\c$ fsID: 22 09/25/2008 10:49:21 NTFS \\vm3\h$ fsID: 1Query VM for Microsoft Hyper-V virtual machinesUse the Query VM command to verify which Hyper-V virtual machines werebacked up.Supported ClientsThis command is valid on Windows clients that are installed on a Hyper-V hostsystem.Syntax►► Query VM vmnameoptions►◄ParametersvmnameSpecifies the virtual machine host name that you want to process.You can also specify the wildcard character "*" to show all vm backups on theTivoli Storage Manager server.For Hyper-V backup queries, if the vmbackuptype=hypervfull option is missing,the vmlist option values are used. If neither the vmname parameter or thevmlist option is specified, all virtual machines are shown. Wildcards are notallowed for the vmname parameter.Table 93. Query VM command: Related options for Hyper-V virtual machine queries.OptionWhere to useinactive “Inactive” on page 393Command line.Valid for vmbackuptype=hypervfull620 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 93. Query VM command: Related options for Hyper-V virtual machinequeries. (continued)Optionpitdate “Pitdate” on page 435Where to useCommand line.Valid for vmbackuptype=hypervfullpittime “Pittime” on page 436Command line.Valid for vmbackuptype=hypervfullvmbackuptype=hypervfull “Vmbackuptype” on page517Command line or client options file.Query VM examples (Hyper-V)||The following is an example of using the query VM command withvmbackuptype=hypervfull.Hyper-V fulldsmc query vm -vmbackuptype=hypervfull# Backup Date Mgmt Class Type A/I Virtual Machine(numofbytes B)-- ----------- ---------- ---- --- ---------------1 07/24/2009 DEFAULT Full A Windows Vista2 07/25/2009 DEFAULT Full A Windows 20083 08/04/2009 DEFAULT Full A Windows 2008Restart RestoreRelated tasks:“Preparing the environment for full backups of VMware virtual machines” on page148The restart restore command displays a list of your restartable restore sessions inthe server database.You can only restart one restartable restore session at a time. Run the restartrestore command again to restart additional restores.The restarted restore uses the same options you used in the failed restore. Therestarted restore continues from the point at which the restore previously failed.To cancel restartable restore sessions, use the cancel restore command. Use therestart restore command when:vvRestartable restore sessions lock the file space at the server so that files cannotbe moved off the sequential volumes of the server.You cannot back up files affected by the restartable restore.Options from the failed session supersede new or changed options for the restartedsession.Supported ClientsThis command is valid for all clients.Chapter 12. Using commands 621

Syntax►► RESTArt Restore ►◄ParametersThere are no parameters for this command.ExamplesTask Restart a restore.Command: restart restoreRestoreThe restore command obtains copies of backup versions of your files from a TivoliStorage Manager server, or inside a backup set.To restore files, specify the directories or selected files, or select the files from a list.Restore files to the directory from which you backed them up or to a differentdirectory. Tivoli Storage Manager uses the preservepath option with the subtreevalue as the default for restoring files.Note:1. When restoring a directory, its modification date and time is set to the date andtime of the restore, not to the date and time the directory had when it wasbacked up. This is because Tivoli Storage Manager restores the directories first,then adds the files to the directories.2. An error occurs if you attempt to restore a file whose name is the same theshort name of an existing file. For example, if you attempt to restore a file youspecifically named ABCDEF~1.DOC into the same directory where a file namedabcdefghijk.doc exists, the restore fails because the Windows operating systemequates the file named abcdefghijk.doc to a short name of ABCDEF~1.DOC.The restore function treats this as a duplicate file.If this error should occur, perform any of the following actions to correct it:v Restore the file with the short file name to a different location.v Stop the restore and change the name of the existing file.v Disable the short file name support on Windows.v Do not use file names that would conflict with the short file namingconvention; for example, do not use ABCDEF~1.DOC.If you set the subdir option to yes when restoring a specific path and file, TivoliStorage Manager recursively restores all subdirectories under that path, and anyinstances of the specified file that exist under any of those subdirectories.See the Microsoft Knowledge Base article Q121007, How to Disable the 8.3 NameCreation on NTFS Partitions, for more information.If the restore command is retried because of a communication failure or sessionloss, the transfer statistics display the bytes Tivoli Storage Manager attempted totransfer across all command attempts. Therefore, the statistics for bytes transferredmight not match file statistics, such as those for file size.622 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Supported ClientsThis command is valid for all clients.Syntax►►REStoreFILEoptions►►sourcefilespec{ filespacename } sourcefilespec destinationfilespec►►BACKUPSETName=backupsetnamelocalfilenametapedeviceLOCation=serverfiletape►◄ParametersfileThis parameter specifies that the source file specification is an explicit filename. This parameter is required when you restore a file name from thecurrent path, when you do not specify a relative or absolute path, and whenthe file name conflicts with one of the reserved restore command keywords,such as restore backupset.sourcefilespecSpecifies the path and file name in storage that you want to restore. Usewildcard characters to specify a group of files or all the files in a directory.Note: If you include filespacename, do not include a drive letter in the filespecification.{filespacename}Specifies the file space (enclosed in braces) on the server that contains the filesyou want to restore. This is the name on the workstation drive from which thefiles were backed up.Specify the file space name if the drive label name has changed or if you arerestoring files backed up from another node with drive labels that are differentfrom yours.Note: You must specify a mixed or lowercase NTFS file space name enclosedin quotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks or double quotation marks are valid in loop mode. For example:{"NTFSDrive"} and {'NTFSDrive'} are both valid. In batch mode, only singlequotation marks are valid. The single quotation marks requirement is arestriction of the operating system.destinationfilespecSpecifies the path and file name where you want to place the restored files. Ifyou do not specify a destination, Tivoli Storage Manager restores the files tothe original source path.When entering the destinationfilespec, consider the following:Chapter 12. Using commands 623

vvIf the sourcefilespec names a single file, the destinationfilespec can be a file or adirectory. If you are restoring a single file, you can optionally end thespecification with a file name if you want to give the restored file a newname.If the sourcefilespec is wildcarded or subdir=yes is specified, thedestinationfilespec must be a directory and end with a directory delimiter (\).Note: If the destination path or any part of it does not exist, Tivoli StorageManager creates it.BACKUPSETName=Specifies the name of a backup set. This parameter is optional. If you specifythe backupsetname parameter with the restore command, you cannot use thepick option.The value of backupsetname depends on the location of the backup set, andcorresponds to one of the following options:backupsetnameSpecifies the name of the backup set from the Tivoli Storage Managerserver. If the location parameter is specified, you must set-location=server. If the backup set resides in Tivoli Storage Managerserver storage, the backup set must have a TOC.localfilenameSpecifies the file name of the first backup set volume. You must set-location=file.tapedeviceSpecifies the name of the tape device containing the backup setvolume. You must use a Windows native device driver, not the devicedriver provided by Tivoli. You must set -location=tape.LOCation=Specifies where Tivoli Storage Manager searches for the backup set. If you donot specify the location parameter, the client searches for backup sets on theTivoli Storage Manager server.serverfiletapeSpecifies that Tivoli Storage Manager searches for the backup set fromthe server. This is the default.Specifies that Tivoli Storage Manager searches for the backup set froma local file.Specifies that Tivoli Storage Manager searches for the backup set froma local tape device.Table 94. Restore command: Related optionsOptionWhere to useasrmode “Asrmode” on Command line only.page 297dateformat “Dateformat” Client options file (dsm.opt) or command line.on page 326dirsonly “Dirsonly” on Command line only.page 337filelist “Filelist” on Command line only.page 380filesonly “Filesonly” on Command line only.page 383624 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 94. Restore command: Related options (continued)OptionWhere to usefromdate “Fromdate” on Command line only.page 384fromnode “Fromnode” on Command line only.page 385fromtime “Fromtime” on Command line only.page 386ifnewer “Ifnewer” on Command line only.page 391inactive “Inactive” on Command line only.page 393latest “Latest” on page Command line only.413numberformatClient options file (dsm.opt) or command line.“Numberformat” on page429pickNote: If you specify thebackupsetname parameterwith the restorecommand, you cannot usethe pick option.“Pick” onpage 434pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436preservepath“Preservepath” on page443replace “Replace” onpage 450skipntpermissions“Skipntpermissions” onpage 472skipntsecuritycrc“Skipntsecuritycrc” onpage 472subdir “Subdir” on page489tapeprompt “Tapeprompt”on page 495timeformat “Timeformat”on page 503todate “Todate” on page506totime “Totime” on page507Command line only.Command line only.Command line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.Chapter 12. Using commands 625

ExamplesTaskTaskTaskTaskTaskTaskTaskTaskTaskTaskTaskRestore a single file named budget.fin.Command: restore c:\devel\projecta\budget.finRestore a single file named budget.fin which resides in the currentdirectory.Command: restore file budget.finRestore files from the abc NTFS file space proj directory.Command: rest {"abc"}\proj\*.*Restore all files with a file extension of .c from the c:\devel\projectadirectory.Command: rest c:\devel\projecta\*.cRestore all files with an extension of .c from the \devel\projectadirectory located in the winnt file space.Command: rest {winnt}\devel\projecta\*.cRestore all files with a file extension of .c from the c:\devel\projectadirectory to the c:\newdevel\projectn\projecta directory. If the projectnor projectn\projecta directory does not exist, it is created.Command: restore c:\devel\projecta\*.c c:\newdevel\projectn\Restore files in the c:\project directory. Use the pick and inactiveoptions to select active and inactive backup versions.Command: restore c:\project\* -pi -inaRestore all files in the c:\mydir directory to their state as of 1:00 PM onAugust 17, 2002.Command: restore -pitd=8/17/2002 -pitt=13:00:00 c:\mydir\Restore a file from the renamed file space \\your-node\h$_OLD to itsoriginal location. Enter both the source and destination as follows:Command: res \\your-node\h$_OLD\docs\myresume.doc h:\docs\Restore all files in the c:\mydir directory to their state as of 1:00 PM onAugust 17, 2002.Command: restore -pitd=8/17/2002 -pitt=13:00:00 c:\mydir\Restore a single file named budget.fin contained within the backup setdaily_backup_data.12345678.Command: restore c:\projecta\budget.fin-backupsetname=daily_backup_data.12345678 -location=serverRelated information“Restore data from a backup set” on page 185“Preservepath” on page 443626 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Restoring NTFS volume mount pointsWhen restoring a file system that contains a volume mount point, only the mountpoint (directory) is restored. The data on the volume mounted on that directory isnot restored.A mount point can also be restored individually. For example, C:\mount is a mountpoint and has been backed up as part of the C: drive on the system namedSTORMAN. The following command can be used to restore this mount point:dsmc restore {\\storman\c$}\mountThe braces ({ and }) are required if you also backed up the data on the mountedvolume from the mount point. Without the braces, Tivoli Storage Manager restoresdata from the file space with the longest name that matches the file specification. Ifyou backed up the data through the mount point, the backups are stored in a filespace named \\storman\c$\mount. The braces are used to specify that the data berestored from the \\storman\c$ file space.The mount point cannot be restored if any of the following conditions is true:v The mount point already exists.v A non-empty directory matching the mount point name exists.v A file matching the mount point name exists.Related concepts:“Restoring data on NTFS mounted volumes”“Backing up NTFS volume mount points” on page 585“Backing up data on NTFS mounted volumes” on page 585Restoring data on NTFS mounted volumesThe mount point must exist before the data on the mounted volume can berestored to its original location.If the mount point does not exist then you can restore it as described in “RestoringNTFS volume mount points.”For example, C:\mount is a mount point and it has been backed up as part of theC: drive on a system called STORMAN. The data on the mounted volume has alsobeen backed up. After ensuring that the mount point has been restored, thefollowing command can be used to restore the data:dsmc restore c:\mount\* -subdir=yesImportant: If the mount point does not exist, then the data will instead be restoredto the root of the mount point's file system. For example, the following objectsexists on C:\mount:v C:\mount\projects\2009plan.docv C:\mount\projects\2010plan.docv C:\mount\master_list.xlsIf the restore command (shown above) is issued, but the mount point does notexist, then these objects are restored to the root of the C: drive as follows:v C:\projects\2009plan.docv C:\projects\2010plan.docv C:\master_list.xlsChapter 12. Using commands 627

Note: When using the GUI client and Web client to view objects in a file space thatcontains a mount point, the mount point is displayed as an empty directory.Objects from the data on the mounted volume can be viewed and restored byviewing the file space for that mounted volume.Related concepts:“Restoring NTFS volume mount points” on page 627“Backing up NTFS volume mount points” on page 585“Backing up data on NTFS mounted volumes” on page 585Restore Microsoft Dfs junctionsTo restore Microsoft Dfs junctions, you must restore Microsoft Dfs root.If you select the junction point itself, Tivoli Storage Manager restores data underjunction, but not the junction itself. If you select a junction point that no longerexists under Dfs root, Tivoli Storage Manager creates a local directory under Dfsroot with the same name as the junction before restoring data.Restore active filesWhen restoring active and inactive versions of the same file using the replaceoption, only the most recently restored file is replaced.Universal Naming Convention restoresThe client stores files on the Tivoli Storage Manager server using the WindowsUniversal Naming Convention (UNC), not the drive letter. The UNC name is thenetwork name for the file. The system name is a part of the UNC name. Forexample, if your system name is STAR and you have a file named c:\doc\h2.doc,the UNC name is \\star\c$\doc\h2.doc.When you restore files on the same system from which they were backed up, youcan use the local drive letter or the UNC name to refer to the file. For example,either of the following will restore c:\doc\h2.doc to its original location:dsmc restore c:\doc\h2.docdsmc restore \\star\c$\doc\h2.docWhen you restore files on a system with a different name, then you must use theUNC name to refer to the file. This is true even if you are restoring to the samephysical system, but the system name has changed since the backup occurred.For example, if you back up c:\doc\h2.doc on system STAR and you want torestore it to system METEOR then you must use the UNC name to refer to the file.You must also specify a destination restore location. This is because the defaultbehavior is to restore the file to its original location, which would be on systemSTAR. To restore the file to system METEOR, you can run either of the followingon METEOR:dsmc restore \\star\c$\doc\h2.doc c:\dsmc restore \\star\c$\doc\h2.doc \\meteor\c$\Restore from file spaces that are not Unicode-enabledIf you want to restore from file spaces that are not Unicode-enabled, you mustspecify the source on the server and a destination on the client, prior to installingthe Unicode-enabled client.628 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If you want to restore from file spaces that are not Unicode-enabled, you mustspecify the source on the server and a destination on the client. For example, youbacked up your H disk named \\your-node\h$ prior to installing theUnicode-enabled client. After the installation, you issue the following command fora selective backup:sel h:\logs\*.logBefore the backup takes place, the server renames the file space to\\your-node\h$_OLD. The backup continues placing the data specified in the currentoperation into the Unicode-enabled file space named \\your-node\h$. That filespace now contains only the \logs directory and the *.log files. If you want torestore a file from the (old) renamed file space to its original location, you mustenter both the source and destination as follows:restore \\your-node\h$_OLD\docs\myresume.doc h:\docs\Restore named streamsTivoli Storage Manager restores named streams on a file basis only.Windows directories can contain named streams. Named streams attached to adirectory will always be overwritten (regardless of the value of the prompt option)during a restore operation.Restore sparse filesWhen restoring sparse files to a non-NTFS file system, set the Tivoli StorageManager server communication time out value (idletimeout) to the maximumvalue of 255 to avoid client session timeout.Restore AdobjectsTivoli Storage Manager is restricted to restoring sparse files that are less then 4gigabytes in size.The following issues apply if more data is restored than the Microsoft disk quotaallows:vvIf the user performing the restore has a disk quota (e.g., belongs to the BackupOperator Group), Tivoli Storage Manager will not restore any data that exceedsthe disk quota of the restore user and will display a "Disk Full" message.If the user performing the restore does not have a disk quota (e.g., belongs tothe Administrator Group), Tivoli Storage Manager will restore all data andtransfer ownership of those files which exceed the disk quota of the originalowner to the user performing the restore (in this case, the Administrator).Use the restore adobjects command to restore individual Active Directory objectsfrom the local Deleted Objects container.Tivoli Storage Manager clients that run on Windows Server platforms can restoreindividual Active Directory objects from full system-state backups stored on theTivoli Storage Manager server.Supported ClientsThis command is valid for Windows Server OS clients.Chapter 12. Using commands 629

Syntax►►Restore ADOBJectssourcepathspecoptions►◄ParameterssourcepathspecSpecifies the Active Directory object or container to restore. If a container isspecified, its contents are also restored. You can either specify the fulldistinguished name of an object or a container, or just the name attribute ('cn'or 'ou'), where the wildcard might be used. The following special charactersrequire an escape character, the backslash, (\), if any of them are contained inthe name:\#+=For example, "cn=test#" is entered as "cn=test\#".Tivoli Storage Manager cannot display any object names that contain anasterisk (*) as part of the name.Do not use wildcards when you specify a distinguished name.Table 95. Restore Adobjects command: Related optionsOptionWhere to useadlocation “Adlocation” Command line only.on page 295dateformat (the option is Client options file (dsm.opt) or command line.ignored when adlocationis notspecified)“Dateformat” onpage 326pitdate (the option isignored when adlocationis not specified) “Pitdate”on page 435pittime (the option isignored when adlocationis not specified)“Pittime”on page 436replace “Replace” onpage 450timeformat (the option isignored when adlocationis not specified)“Timeformat” on page 503Command line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.ExamplesTaskRestore a specific deleted Active Directory object.630 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

TaskTaskTaskTaskCommand: restore adobj"CN=Administrator,CN=Users,DC=bryan,DC=test,DC=ibm,DC=com"Restore all deleted objects that were originally located in the Userscontainer.Command: restore adobj "CN=Users,DC=bryan,DC=test,DC=ibm,DC=com"Restore individual Active Directory objects from the Tivoli StorageManager server. Use the pitdate and pittime options to select from a listof more recent and less recent backup versions (Windows Server 2008only).Command: restore adobj "cn=guest" -adloc=server-pitdate=03/17/2008 -pittime=11:11:11Restore all deleted users with the name starting with Fred.Command: restore adobjects "cn=Fred*"Restore all deleted organizational units with the name testou.Command: restore adobjects "ou=testou"Restore BackupsetThe restore backupset command restores a backup set from the Tivoli StorageManager server, a local file, or a local tape device. You can restore the entirebackup set, or, in some cases, specific files within the backup set.Supported ClientsThis command is valid for all clients.Syntax►►REStore Backupset{filespacename}SYSTEMSTATEsourcefilespec►►destinationfilespecoptions-BACKUPSETName=backupsetnamelocalfilenametapedevice►►-LOCation=serverfiletape►◄Parameters{filespacename}Specifies the file space (enclosed in braces) on the server that contains the filesyou want to restore. This is the name on the workstation drive from which thefiles were backed up, or the virtual file space name for a group.Specify a file space name when you restore a backup set containing a group.Chapter 12. Using commands 631

Specify a file space name when the sourcefilespec does not exist on the targetcomputer. This can occur if the drive label name has changed or if you arerestoring files backed up from another node with drive labels that are differentfrom yours.Note: You must specify a mixed or lowercase NTFS file space name enclosedin quotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'}are both valid. In batch mode, only single quotation marks are valid. Thesingle quotation marks requirement is a restriction of the operating system.sourcefilespecSpecifies the source path of a portion of the backup set. The default is torestore the entire backup set.SYSTEMSTATESpecifies that you want to restore the entire backup of the system state fromthe backup set. You cannot restore individual system state components fromthe backup set. This parameter is valid only for systems that support systemstate. To restore individual system state components from a backup set, use therestore systemstate command.destinationfilespecSpecifies the destination path for the restored files. If you do not specify asourcefilespec, you cannot specify a destinationfilespec. If you do not specify adestination, Tivoli Storage Manager restores the files to the original sourcepath. If you are restoring more than one file, you must end the filespecification with a directory delimiter (/), otherwise, Tivoli Storage Managerassumes the last name is a file name and reports an error. If you are restoring asingle file, you can optionally end the destination file specification with a filename if you want to give the restored file a new name. When thesourcefilespec does not exist on the target workstation, you must specifydestinationfilespec.-BACKUPSETName=Specifies the name of the backup set from which to perform a restoreoperation. You cannot use wildcard characters to specify the backup set name.The value of backupsetname depends on the location of the backup set, andcorresponds to one of the three choices below.backupsetnameSpecifies the name of the backup set on the server from which toperform a restore operation. If location option is specified, you mustset -location=server.localfilenameSpecifies the file name of the first backup set volume. You must set-location=file.tapedeviceSpecifies the name of the tape device containing the backup setvolume. You must use a Windows native device driver, not the devicedriver provided by Tivoli. You must set -location=tape.-LOCation=Specifies the location of the backup set. If you do not specify the locationparameter, the Tivoli Storage Manager client searches for backup sets on theTivoli Storage Manager server. If you specify the location parameter, the valuemust be one of the three choices below.632 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

serverfiletapeSpecifies that the backup set is on the Tivoli Storage Manager server.This is the default.Specifies that the backup set is on an available file system.Specifies that the backup set is on an available tape device.Table 96. Restore Backupset command: Related optionsOptionWhere to usedirsonly “Dirsonly” on Command line only.page 337filesonly “Filesonly” on Command line only.page 383ifnewer “Ifnewer” on Command line only.page 391preservepathCommand line only.“Preservepath” on page443quiet “Quiet” on page 449replace “Replace” onpage 450skipntpermissions“Skipntpermissions” onpage 472subdir “Subdir” on page489Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.ExamplesTaskRestore the entire backup set called monthly_financial_data.87654321from the server.Command:TaskTaskTaskdsmc restore backupset-backupsetname=monthly_financial_data.87654321-loc=serverRestore the entire backup set from the \\.\tape0 device.Command:dsmc restore backupset-backupsetname=\\.\tape0 -loc=tapeRestore groups from the backup set mybackupset.12345678 on the TivoliStorage Manager server to the c:\newdevel\projectn directory. The groups'virtual file space is accounting.Command:dsmc restore backupset {accounting}\*c:\newdevel\projectn\-backupsetname=mybackupset.12345678-loc=server -subdir=yesRestore the entire backup set contained in the file: c:\budget\weekly_budget_data.ost.Chapter 12. Using commands 633

Command:dsmc restore backupset-backupsetname=c:\budget\weekly_budget_data.ost-loc=fileTaskRestore the \budget\ directory and subdirectories from the backup setcontained in the file: c:\budget\weekly_budget_data.ost.Command:dsmc restore backupset m:\budget\*-backupsetname=c:\budget\weekly_budget_data.ost-loc=file -subdir=yesTaskRestore the file \budget\salary.xls from the backup set contained in thefile: c:\budget\weekly_budget_data.ost.Command:dsmc restore backupset m:\budget\salary.xls-backupsetname=c:\budget\weekly_budget_data.ost-loc=file -subdir=yesTaskRestore the system state contained in the backup set file:\recovery\backupsetfile.name. Replace all components; do not prompt foreach component.Command:dsmc restore backupset systemstate-BACKUPSetname=c:\recovery\backupsetfile.name-loc=file -replace=allRelated information“Restore data from a backup set” on page 185Restore backup sets: considerations and restrictionsThis topic lists some considerations and restrictions that you must be aware ofwhen restoring backup sets.Backup set restore considerationsConsider the following when restoring backup sets:v If the object you want to restore was generated from a Tivoli Storage Managernode whose name is different from your current node, specify the original nodename with the filespacename parameter on any of the restore commands.v If you are unable to restore a backup set from portable media, check with yourTivoli Storage Manager administrator to ensure that the portable media wascreated on a device using a compatible format.v If you use the restore backupset command on the initial command line with theparameter -location=tape or -location=file, the client does not attempt tocontact the Tivoli Storage Manager server.v When restoring a group from a backup set:634 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vv– The entire group, or all groups, in the virtual file space are restored. Youcannot restore a single group by specifying the group name, if there areseveral groups in the same virtual file space. You cannot restore a part of agroup by specifying a file path.– Specify a group by using the following values:- Specify the virtual file space name with the filespacename parameter.- Use the subdir option to include subdirectories.Limited support is provided for restoring backup sets from tape devices attachedto the client system. A native device driver provided by the device manufacturermust always be used. The device driver provided by Tivoli to be used with theTivoli Storage Manager server cannot be used on the client system for restoringlocal backup sets.To enable the client GUI to restore a backup set from a local device, withoutrequiring a server connection, use the localbackupset option.Backup set restore restrictionsBe aware of the following restrictions when restoring backup sets:v A backup set data that was backed up with the API cannot be restored or used.v You cannot restore image data from a backup set using the restore backupsetcommand. You can restore image data from a backup set only with the restoreimage command.v You cannot restore image data from a local backup set (location=tape orlocation=file). You can restore image data from a backup set only from theTivoli Storage Manager server.Related information“Localbackupset” on page 413“Restore” on page 622“Restore Image” on page 640“Restore Backupset” on page 631Restore backup sets in a SAN environmentYou can restore backup sets in a storage area network (SAN) in the followingways:vvIf the backup set is on a SAN-attached storage device, specify the device usingthe filename parameter and use the location=tape option, where applicable.Tivoli Storage Manager restores the backup set directly from the SAN-attachedstorage device, gaining high-speed restore performance.If the backup set is not on local media or a SAN-attached storage device, youcan specify the backup set using the backupsetname option. Use thelocation=server option to restore the backup set directly from the server usingthe LAN.Restore Backupset without the backupsetname parameterThe restore backupset command can be used without the backupsetnameparameter.Chapter 12. Using commands 635

The preferred syntax for restore backupset command requires the backupsetnameparameter. Prior to the introduction of the backupsetname parameter, the TivoliStorage Manager client restored backup sets with a different syntax. The previoussyntax is currently supported, but whenever possible, follow the syntax thatrequires the backupsetname parameter. The previous syntax is documented forthose cases when it cannot be replaced by the preferred syntax.Supported ClientsThis command is valid for all clients.Syntax►►REStore Backupset{filespacename}SYSTEMSTATEsourcefilespec►►destinationfilespecoptionsbackupsetnamelocalfilenametapedevice►►LOCation=serverfiletape►◄ParametersoptionsAll options that are valid with the preferred syntax of restore backupset arevalid with the legacy syntax of restore backupset.{filespacename}Specifies the file space (enclosed in braces) on the server that contains the filesyou want to restore. This is the name on the workstation drive from which thefiles were backed up, or the virtual file space name for a group.Specify a file space name when you restore a backup set containing a group.Specify a file space name when the sourcefilespec does not exist on the targetcomputer. This can occur if the drive label name has changed or if you arerestoring files backed up from another node with drive labels that are differentfrom yours.Note: You must specify a mixed or lowercase NTFS file space name enclosedin quotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks are valid in loop mode. For example: {"NTFSDrive"} and {'NTFSDrive'}are both valid. In batch mode, only single quotation marks are valid. Thesingle quotation marks requirement is a restriction of the operating system.sourcefilespecSpecifies the source path of a portion of the backup set. The default is torestore the entire backup set.SYSTEMSTATESpecifies that you want to restore the entire backup of the system state fromthe backup set. You cannot restore individual system state components from636 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

the backup set. This parameter is valid only for systems that support systemstate. To restore individual system state components from a backup set, use therestore systemstate command.destinationfilespecSpecifies the destination path for the restored files. If you do not specify asourcefilespec, you cannot specify a destinationfilespec. If you do not specify adestination, Tivoli Storage Manager restores the files to the original sourcepath. If you are restoring more than one file, you must end the filespecification with a directory delimiter (/), otherwise, Tivoli Storage Managerassumes the last name is a file name and reports an error. If you are restoring asingle file, you can optionally end the destination file specification with a filename if you want to give the restored file a new name. When thesourcefilespec does not exist on the target workstation, you must specifydestinationfilespec.backupsetnameSpecifies the name of the backup set from the Tivoli Storage Manager server. Ifthe location parameter is specified, you must set -location=server.localfilenameSpecifies the file name of the first backup set volume. You must set-location=file.tapedeviceSpecifies the name of the tape device containing the backup set volume. Youmust use a Windows native device driver, not the device driver provided byTivoli. You must set -location=tape.LOCation=Specifies the location of the backup set. If you do not specify the locationparameter, the Tivoli Storage Manager client searches for backup sets on theTivoli Storage Manager server. If you specify the location parameter, the valuemust be one of the three choices below.serverfiletapeExamplesTaskTaskTaskTaskSpecifies that the backup set is on the Tivoli Storage Manager server.This is the default.Specifies that the backup set is on an available file system.Specifies that the backup set is on an available tape device.Restore the entire backup set called monthly_financial_data.87654321from the server.Command: dsmc restore backupset monthly_financial_data.87654321-loc=serverRestore the entire backup set from the \\.\tape0 device.Command: dsmc restore backupset \\.\tape0 -loc=tapeRestore groups from the backup set mybackupset.12345678 on the TivoliStorage Manager server to the c:\newdevel\projectn directory. The groups'virtual file space is accounting.Command: dsmc restore backupset mybackupset.12345678{accounting}\* c:\newdevel\projectn\ -loc=server -subdir=yesRestore the entire backup set contained in the file: c:\budget\weekly_budget_data.ost.Chapter 12. Using commands 637

Command: dsmc restore backupset c:\budget\weekly_budget_data.ost-loc=fileTaskTaskTaskRestore the \budget\ directory and subdirectories from the backup setcontained in the file: c:\budget\weekly_budget_data.ost.Command: dsmc restore backupset c:\budget\weekly_budget_data.ostm:\budget\* -loc=file -subdir=yesRestore the file \budget\salary.xls from the backup set contained in thefile: c:\budget\weekly_budget_data.ost.Command: dsmc restore backupset c:\budget\weekly_budget_data.ostm:\budget\salary.xls -loc=file -subdir=yesRestore the system state contained in the backup set file:\recovery\backupsetfile.name. Replace all components; do not prompt foreach component.Command: dsmc restore backupset c:\recovery\backupsetfile.namesystemstate -loc=file -replace=allRelated information“Restore data from a backup set” on page 185Restore GroupUse the restore group command to restore specific members or all members of agroup backup.Note:1. Use the pick option to display a list of groups from which you can select onegroup to restore.2. Use the showmembers option with the pick option to display and restore one ormore members of a group. In this case, you first select the group from whichyou want to restore specific members, then you select one or more groupmembers to restore.3. You can restore a group from a backup set.Supported ClientsThis command is valid for all clients.Syntax►► REStore GRoup sourceoptionsdestination►◄ParameterssourceSpecifies the virtual file space name (enclosed in braces) and the group nameon the server that you want to restore.638 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

destinationSpecifies the path where you want to place the group or one or more groupmembers. If you do not specify a destination, the client restores the files totheir original location.Table 97. Restore Group command: Related optionsOptionWhere to usebackupsetnameCommand line only.“Backupsetname” on page306fromdate “Fromdate” onpage 384fromnode “Fromnode” onpage 385fromtime “Fromtime” onpage 386ifnewer “Ifnewer” on page391inactive “Inactive” onpage 393latest “Latest” on page 413pick “Pick” on page 434pitdate “Pitdate” on page435pittime “Pittime” on page436preservepath“Preservepath” on page 443replace “Replace” on page450showmembers “Showmembers”on page 470skipntpermissions“Skipntpermissions” onpage 472skipntsecuritycrc“Skipntsecuritycrc” onpage 472subdir “Subdir” on page 489tapeprompt “Tapeprompt” onpage 495todate “Todate” on page 506totime “Totime” on page 507Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Client options file (dsm.opt) or command line.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.ExamplesTaskRestore all members in the virtfs\group1 group backup to their originallocation on the client system.Command:restore group {virtfs}\group1Chapter 12. Using commands 639

TaskTaskDisplay all groups within the virtfs virtual file space. Use theshowmembers option to display a list of group members from which you canselect one or more to restore.Command:restore group {virtfs}\* -pick -showmembersDisplay a list of groups within the virtfs virtual file space from whichyou can select one or more groups to restore.Command:restore group {virtfs}\* -pickRelated information“Restore Backupset” on page 631Restore ImageThe restore image command restores a file system or raw volume image that wasbacked up using the backup image command.The restore obtains the backup image from a Tivoli Storage Manager server, orinside a backup set from the Tivoli Storage Manager server, when thebackupsetname option is specified. This command can restore an active base image,or a point-in-time base image, with associated incremental updates.Note:1. The account running the Tivoli Storage Manager client must have administratorauthority to successfully perform any type of image restore.2. If you use HSM for Windows or HSM for UNIX, and you restore a file systemimage backup and plan to run reconciliation, you must restore the files thathave been backed up after the image backup. Otherwise, migrated files thathave been created after the image backup expire from the HSM archive storageon the Tivoli Storage Manager server.You can use the verifyimage option with the restore image command to specifythat you want to enable detection of bad sectors on the destination target volume.If bad sectors are detected on the target volume, Tivoli Storage Manager issues awarning message on the console and in the error log.If bad sectors are present on the target volume, you can use the imagetofileoption with the restore image command to specify that you want to restore thesource image to a file. Later, you can use a data copy utility of your choice totransfer the image from the file to a disk volume.Considerations:v The Tivoli Storage Manager API must be installed to use the restore imagecommand.v You can restore an NTFS file system to a FAT32 volume or vice-versa.v The destination volume to which you restore must exist and be the same size orlarger than the source volume.v The physical layout of the target volume (striped, mirrored, etc.) can differ.v The target volume is overwritten with data contained in the image backup.640 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

vvvvIt is not necessary to format a target volume prior to restoring an image backupcontaining a file system.Tivoli Storage Manager requires an exclusive lock to destination volume you arerestoring. The client locks, restores, unlocks, unmounts, and mounts the volumeduring a restore operation. During the restore process the destination volume isnot available to other applications.If you use the pick option, the following information is displayed for file systemimages backed up by the client:– Image Size– Stored Size - This is the actual image size stored on the server. Because imagebackup allows you to back up only used blocks in a file system, the storedimage size on the Tivoli Storage Manager server could be smaller than thevolume size. For online image backups, the stored image can be larger thanthe file system based on the size of the cache files.– File system type– Backup date and time– Management class assigned to image backup– Whether the image backup is an active or inactive copy– The image nameIf for some reason a restored image is corrupted, you should run chkdsk tocheck for and repair any bad sectors or data inconsistencies (unless the restoredvolume is RAW).Supported ClientsThis command is valid for all Windows clients.Syntax►►REStore Imageoptionssourcefilespec"sourcefilespec"►►destinationfilespec►◄ParameterssourcefilespecSpecifies the name of a source image file system to be restored. Only a singlesource image can be specified; you cannot use wildcard characters.destinationfilespecSpecifies the name of an existing mounted file system or the path and filename to which the source file system is restored. The default is the originallocation of the file system. You can restore an NTFS file system to a FAT32volume or vice-versa.Table 98. Restore Image command: Related optionsOptionbackupsetname“Backupsetname” on page306Where to useCommand line only.Chapter 12. Using commands 641

Table 98. Restore Image command: Related options (continued)Optiondateformat “Dateformat”on page 326deletefiles“Deletefiles” on page331fromnode “Fromnode” onpage 385imagetofile“Imagetofile” on page392inactive “Inactive” onpage 393incremental“Incremental” on page405noprompt “Noprompt” onpage 428pick “Pick” on page 434pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436timeformat “Timeformat”on page 503verifyimage“Verifyimage” on page513Where to useClient option file (dsm.opt) or command line.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Command line only.Client option file (dsm.opt) or command line.Command line only.The restore image command does not define or mount the destination file space.The destination volume must exist, must be large enough to hold the source, and ifit contains a file system, must be mounted. The destination volume must bemapped to a drive letter. If an image backup contains a file system, and yourestore them to a different location, be aware of the following points:v If the destination volume is smaller than the source volume, the operation fails.vIf the destination volume is larger than the source, after the restore operationyou lose the difference between the sizes. If the destination volume is located ona dynamic disk the lost space can be recovered by increasing the size of thevolume. This also increases the size of the restored volume.ExamplesTaskTaskRestore the e: drive to its original location.Command: dsmc rest image e:Restore the h: drive to its original location and apply the changes from thelast incremental backup of the original image recorded at the server. Thechanges include deletion of files.Command: dsmc restore image h: -incremental -deletefiles642 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

TaskTaskTaskRestore the d: drive to its original location. Use the verifyimage option toenable detection of bad sectors on the target volume.Command: dsmc restore image d: -verifyimageIf bad sectors present on the target volume, use the imagetofile option torestore the d: drive to the e:\diskD.img file to avoid data corruption.Command: dsmc restore image d: e:\diskD.img -imagetofileRestore the e: drive from the backup set weekly_backup_data.12345678 toits original location.Command: restore image e:-backupsetname=weekly_backup_data.12345678Related information“Verifyimage” on page 513“Imagetofile” on page 392Restore NASThe restore nas command restores the image of a file system belonging to aNetwork Attached Storage (NAS) file server. When using an interactivecommand-line session with a non-administrative ID, Tivoli Storage Managerprompts for an administrator ID.The NAS file server performs the outboard data movement. A server processperforms the restore.If you used the toc option with the backup nas command or the include.fs.nasoption to save Table of Contents (TOC) information for each file system backup,you can use the QUERY TOC server command to determine the contents of a filesystem backup in conjunction with the RESTORE NODE server command torestore individual files or directory trees. You can also use the Web client toexamine the entire file system tree and select files and directories to restore. If youdo not save TOC information, you can still restore individual files or directorytrees using the RESTORE NODE server command, provided that you know thefully qualified name of each file or directory and the image in which that objectwas backed up.Use the nasnodename option to specify the node name for the NAS file server. TheNAS node name identifies the NAS file server to the Tivoli Storage Managerserver. You must register the NAS node name at the server. Place the nasnodenameoption in your client options file (dsm.opt). The value in the client options file isthe default, but this value can be overridden on the command line.You can use the pick option to display a list of NAS images owned by the NASnode you specify. From this list you can select one or more images to restore. Ifyou select multiple images to restore using the pick option, do not use the monitoroption or you will serialize the restores. To start multiple restore processessimultaneously when restoring multiple images, do not specify monitor=yes.Use the monitor option to specify whether you want to monitor a NAS file systemimage restore and display processing information on your screen.Chapter 12. Using commands 643

Use the monitor process command to display a list of current restore processes forall NAS nodes for which your administrative user ID has authority. Theadministrative user ID should have at least client owner authority over both theNAS node and the client workstation node they are using either from commandline or from the web.Use the cancel process command to stop NAS restore processing.A NAS file system specification uses the following conventions:v Regardless of client platform, NAS file system specifications use the forwardslash (/) separator, as in this example: /vol/vol0.v NAS file system designations on the command line require brace delimiters {}around the file system names, such as: {/vol/vol0}.Supported ClientsThis command is valid for all Windows clients.Syntax►►REStore NASoptionssourcefilespecdestinationfilespec►◄ParameterssourcefilespecSpecifies the name of the NAS file system image you want to restore. Thisparameter is required unless you use the pick option to display a list of NASimages from which to choose. You cannot use wildcard characters whenspecifying the sourcefilespec.destinationfilespecSpecifies the name of an existing mounted file system on the NAS device overwhich you want to restore the image. This parameter is optional. The default isthe original location of the file system on the NAS device.Table 99. Restore NAS command: Related optionsOptiondateformat “Dateformat”on page 326inactive “Inactive” onpage 393mode “Mode” on page 420monitor “Monitor” onpage 424nasnodename“Nasnodename” on page425numberformat“Numberformat” on page429pick “Pick” on page 434Where to useClient option file (dsm.opt) or command line.Command line only.Command line only.Command line only.Client options file (dsm.opt) or command line.Client option file (dsm.opt) or command line.Command line only.644 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 99. Restore NAS command: Related options (continued)OptionWhere to usepitdate “Pitdate” on Command line only.page 435pittime “Pittime” on Command line only.page 436timeformat “Timeformat” Client option file (dsm.opt) or command line.on page 503ExamplesTaskTaskRestore SystemstateRestore the NAS file system image /vol/vol1 to the /vol/vol2 file systemon the NAS file server called nas1.Command: restore nas -nasnodename=nas1 {/vol/vol1} {/vol/vol2}Restore inactive NAS images.Command: restore nas -nasnodename=nas2 -pick -inactiveRelated information“Nasnodename” on page 425“Monitor” on page 424“Cancel Process” on page 568Use the restore systemstate command to restore the backup of the system statestored on a Tivoli Storage Manager server, or inside a backup set from a TivoliStorage Manager server, when the backupsetname option is specified.The Tivoli Storage Manager Windows client does not support the currentcommands for restoring individual startable system state components.On Windows Vista, Windows 7, and Windows Server 2008 clients running BIOS,restore systemstate also restores ASR files when running in WinPE (WindowsPreinstallation Environment). The backup-archive client does not back up, andhence cannot restore, ASR data on 64-bit architectures with Extensible FirmwareInterface (EFI).Supported ClientsThis command is valid for all supported Windows clients.SyntaxChapter 12. Using commands 645

►►REStore SYSTEMSTateBOOTABLEBITSEVENTLOGRSMRSSCLUSTERDBTLSWMIIISDHCPWINSDBcomponent_name►◄ParametersTable 100. Restore Systemstate command: Related optionsOptionWhere to useasrmode “Asrmode” on Command line only.page 297backupsetnameCommand line only.“Backupsetname” on page306dateformat “Dateformat”on page 326numberformat“Numberformat” on page429pitdate “Pitdate” onpage 435pittime “Pittime” onpage 436replace “Replace” onpage 450timeformat “Timeformat”on page 503Client option file (dsm.opt) or command line.Client option file (dsm.opt) or command line.Command line only.Command line only.Client option file (dsm.opt) or command line.Client option file (dsm.opt) or command line.ExamplesTaskTaskTaskTaskRestore the entire system state object.Command: restore systemstateRestore the startable system state component.Command: restore systemstate bootableRestore the system service WMI component.Command: restore systemstate wmiRestore the system state object contained within the backup setdaily_backup_data.12345678. Replace all components; do not prompt foreach component.Command: restore systemstate-backupsetname=daily_backup_data.12345678 -replace=all646 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

TaskRestore the WMI component contained within the backup setdaily_backup_data.12345678.Command: restore systemstate wmi-backupsetname=daily_backup_data.12345678 -replace=allRelated information“Recovering a computer when the OS is not working (Windows Vista, Windows 7,Windows Server 2008 and Windows Server 2008 R2)” on page 182|Restore VM|||||||||||||||||||||||||||||||||||Use the restore vm command to restore a virtual machine that was previouslybacked up.The Restore VM command can be used to restore both Microsoft Hyper-V virtualmachines and VMware virtual machines. The information for each type of restoreis presented in its own heading. If you are restoring a virtual machine that is partof a Hyper-V setup, you can skip over the Restore VM for VMware virtual machinestext. If you are restoring a VMware virtual machine, you do not need to read theRestore VM for Hyper-V virtual machines text.Restore VM for VMware virtual machinesThe Restore VM command can be used to restore VMware virtual machines orVMware virtual machine templates.If you have the backup-archive client installed on a separate machine that isconfigured as a vStorage backup server, you can restore a full VM backups to theESX or ESXi server that they came from, or to a different server. To restore a fullVM backup to a different server, use the -host option. The backup-archive clientcopies the data from the Tivoli Storage Manager server over either the LAN orSAN. The client then writes the data directly to the ESX server, by using thetransport method that is specified in the client options file.Restoring a full VM backup creates a new virtual machine; the configurationinformation and content of the new machine is identical to what it was when thebackup occurred. All virtual machine disks are restored to the specifiedpoint-in-time, as virtual disks in the newly created virtual machine.When you restore a specific disk, using the :vmdk= syntax, an existing virtualmachine is updated with the specified virtual disk data. Only the specified disksare restored to the existing virtual machine; other disks in the virtual machine arenot altered. The existing VM that you are restoring the disk to must be poweredoff before you initiate the restore operation.To create a new virtual machine, specify the -vmname parameter and provide aname for the new virtual machine. The -vmname parameter creates a new VM witha configuration that is identical to what it was when the backup occurred. If youalso specify the :vmdk= syntax, data is restore to any disks that are included in the:vmdk= parameters; disk that are not included are restored, but only as unformatteddisks that do not contain data.Virtual machines are restored to their original vApp, Resource Pool, Cluster, or VMFolder, if the containers exist. During a restore, if the destination target (a vCenterChapter 12. Using commands 647

|||||||||||||||||||||or ESXi host) does not have the required containers the virtual machine is restoredto the top-level default location on the target ESXi host. If you use thecommand-line client to restore a virtual machine, and if the virtual machine cannotbe restored to its original inventory location, an informational message (ANS2091I)is displayed. If you use the Java GUI to restore a virtual machine, and if the virtualmachine cannot be restored to its original inventory location, the informationalmessage is not displayed, but the virtual machine is still restored to the top-leveldefault location.Full VM backups that were previously created using VCB can still be restored byusing the original VCB restore steps. To restore full VM backups created by VCB,see “Restoring full VM backups that were created with VMware ConsolidatedBackup” on page 196. If you use VCB to restore a virtual machine, use theVMware converter program on the client to move the restored files to a runningstate on a VMware server. If the backup-archive client is running in a virtualmachine, and if you have performed a file-level back up of the virtual machine’sfiles, you can restore the backed-up files to the virtual machine using the commandline interface or the Java GUI.Supported ClientsThis command is valid on supported Windows clients that are installed on avStorage backup server for a VMware virtual machine.Syntax||►► REStore VM sourcevmspec ▼ :vmdk=all-vmdk:vmdk=cnfg:vmdk=disk label:-vmdk=disk label►||►-VMNAme="newVMname"DATACENTER="myDatacenter"HOST="myHost"DATASTORE="myDatastore"optionsdestinationfilespec►◄|||||||||||||ParametersNote: Any parameter that contains spaces must be enclosed in quotation (" ")marks.sourcevmspecSpecifies the name of the virtual machine (or VM template) that was backedup.VMNAmeThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.Specifies the new name for the virtual machine after it is restored (if you donot want to use the name specified by sourcevmspec). You cannot use wildcardsin the virtual machine name.648 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||||||||||||||||||||||||DATACENTERThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.Specifies the name of the datacenter to restore the VM to as it is defined in thevSphere vCenter. If the datacenter is contained in a folder, you must specifythe -datacenter option when you restore the virtual machine and include thefolder structure of the datacenter in the datacenter name. For example, thefollowing syntax is valid:-datacenter=folder_name/datacenter_nameWhen you restore a virtual machine using the GUI, you must restore thevirtual machine to a different location. If you restore to the original location,you cannot specify the folder name of the datacenter. Without a folder name tohelp locate the original datacenter, the restore fails.HOSTThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.Specifies the domain name of the ESX host server to restore to as it is definedin the vSphere vCenter.DATASTOREThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.Specifies the data store to restore the virtual machine to. The data store can beon a SAN, NAS, or iSCSI device. You can specify only one data store whenrestoring a virtual machine. If you do not specify a datastore parameter, thevirtual machine's vmdk file is restored to the data store it was on when thebackup was created.destinationfilespecThis parameter is for VMware VCB restores only. It specifies the location whereVCB Full VM image files are restored. If this option is not specified thevmbackdir option is used.:vmdk=all-vmdkThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.This option specifies that all virtual disks (*.vmdk files) are included when theVM is restored. This is the default.:vmdk=cnfgThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.This option specifies that the virtual machine configuration information isrestored. The configuration information is always restored when a new virtualmachine is created. However, by default the configuration is not restored whenyou update an existing virtual machine with selected virtual disks.Ordinarily, restoring configuration information to an existing virtual machinefails because the restored configuration information conflicts with the existingvirtual machine configuration information. Use this option if the existingconfiguration file for a virtual machine on the ESX server has been deleted,and you want to use the backed up configuration to re-create it.Chapter 12. Using commands 649

|||||||||||||||||||||||||||||||||||||||||||||||||:vmdk=disk labelThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.This option is used to specify the disk label of the virtual disks to include inthe restore operation. You only specify this option if you want to selectivelyrestore data from specific disks.:-vmdk=disk labelThis parameter is not valid for restoring VMware virtual machines that werebacked up using VCB.This option is used to specify the disk label of one or more virtual disks toexclude from the restore operation.Table 101. Restore VM command: Related options when restoring VMware virtual machinesOptionWhere to usedatacenterCommand line or options file. This parameter is not valid forrestoring VMware virtual machines that were backed up usingVCB.datastoreCommand line or options file. This parameter is not valid forrestoring VMware virtual machines that were backed up usingVCB.hostCommand line or options file. This parameter is not valid forrestoring VMware virtual machines that were backed up usingVCB.inactiveCommand line.pickCommand line. This parameter is not valid for restoringVMware virtual machines that were backed up using VCB.pitdateCommand line. This parameter is not valid for restoringVMware virtual machines that were backed up using VCB.pittimeCommand line. This parameter is not valid for restoringVMware virtual machines that were backed up using VCB.vmbackdirCommand line or client options file.vmbackuptypeCommand line or client options file.vmvstortransport Command line or client options file. This parameter is not validfor restoring VMware virtual machines that were backed upusing VCB.ExamplesTaskTaskTaskRestore the most recent backup version of myVM to its original name. Usethe VMware management interface to delete the original virtual machine,before you restore it using this syntax.dsmc restore vm myvmRestore the most recent backup version of myvm to a new machine that iscreated with the name “Test Machine”, and with the restore target for thedatacenter, ESX host, and datastore all specified on the command.dsmc restore vm myvm -vmname="Test Machine"-datacenter="myDatacenter" -host="myHostName"-datastore="myDatastore"Restore the most recent backup version of myvm. Restore to a datacenternamed mydatacenter. The datacenter is within the vCenter; the relative pathwithin the vCenter is dirA/datacenters/.650 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

|||||||||||||||||||||||||TaskTaskTaskTaskTaskTaskdsmc restore vm myvm -vmname="Test Machine"-datacenter="dirA/datacenters/myDatacenter"-host="myHostName" -datastore="myDatastore"Restore a VM template back to the same location and name.dsmc restore vm vmTemplateNameRestore a VM template to a new location.dsmc restore vm vmTemplateName-vmname=newName-datastore=newDatastore -host=newHost-datacenter=newDatacenterRestore only Hard Disk 2 and Hard Disk 3 to the existing VM named vm1.dsmc restore vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"Restore all disks to the existing virtual machine named vm1, but don'trestore the data from Hard Disk 4.dsmc restore vm "vm1:-vmdk=Hard Disk 4"Restore only the data from hard Disk 1 to the existing virtual machinevm1; do not update any configuration information.Note: When updating an existing virtual machine, the default behavior isto not update the configuration information.dsmc restore vm "vm1:vmdk=Hard Disk 1:-vmdk=cnfg"Restore all disks to the existing virtual machine named vm1.dsmc restore vm "vm1:vmdk=all-vmdk"This updates all virtual disks on an existing virtual machine, named vm1.Note that this is different from the action performed by dsmc restore vmvm1, which creates a new virtual machine named vm1 (vm1 must not existin order for dsmc restore vm vm1 to succeed).||||||||||||Restore VM for Microsoft Hyper-V virtual machinesIf the virtual machine that you are restoring exists on the Hyper-V host server, it isshut down and deleted before it is restored from the image stored on the TivoliStorage Manager. The Restore VM operation then creates the virtual machine suchthat its content and configuration is identical to what it was when the backupoccurred. Even though the client shuts down the virtual machine before deleting it,manually shutting down the virtual machine before running Restore VM is a goodpractice to bring any in-progress application activities to an orderly stop.Supported ClientsThis command is valid on supported Windows clients that are installed on aHyper-V host system.Syntax||►► REStore VM sourcevmspecoptions►◄|Parameters|Any parameter that contains spaces must be enclosed in quotation (" ") marks.Chapter 12. Using commands 651

|||||||||||||||||||||||Note: Any parameter that contains spaces must be enclosed in quotation (" ")marks.sourcevmspecSpecifies the name of the virtual machine that was backed up.Table 102. Restore VM command: Related options when restoring Hyper-V virtual machinesOptionWhere to useinactiveCommand linepickCommand linepitdateCommand linepittimeCommand linevmbackuptypeCommand line or client options file. To restore a Hyper-Vvirtual machine, this option must be set to HYPERVFULL.ExamplesTask Restore the most recent backup version of a virtual machine namedmyVM.dsmc restore vm myvmRelated concepts:“VMware virtual machine exclude options” on page 370“VMware virtual machine include options” on page 401Related tasks:“Preparing the environment for full backups of VMware virtual machines” on page148RetrieveThe retrieve command obtains copies of archived files from the Tivoli StorageManager server. You can retrieve specific files or entire directories.Use the description option to specify the descriptions assigned to the files youwant to retrieve.Use the pick option to display a list of your archives from which you can select anarchive to retrieve.Retrieve the files to the same directory from which they were archived, or to adifferent directory. Tivoli Storage Manager uses the preservepath option with thesubtree value as the default for restoring files.Note:1. When retrieving a directory, its modification date and time is set to the dateand time of the retrieve, not to the date and time the directory had when it wasarchived. This is because Tivoli Storage Manager retrieves the directories first,then adds the files to the directories.2. An error occurs if you attempt to retrieve a file whose name is the same as theshort name of an existing file. For example, if you attempt to retrieve a file youspecifically named ABCDEF~1.DOC into the same directory where a file namedabcdefghijk.doc exists, the retrieve fails because the Windows operating systemequates the file named abcdefghijk.doc to a short name of ABCDEF~1.DOC.The retrieve function treats this as a duplicate file.652 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If this error should occur, perform any of the following actions to correct it:v Retrieve the file with the short file name you specified to a different location.v Stop the retrieval, and change the name of the existing file.v Disable the short file name support on Windows.v Do not use file names that conflict with the short file naming convention. Forexample, do not use ABCDEF~1.DOC.If you are using client Version 3.1.0.5 or later, the workstation name is part of thefile name. Therefore, if you archive files on one workstation and you want toretrieve them to another workstation, you must specify a destination. This is trueeven if you are retrieving to the same physical workstation, but the workstationhas a new name. For example, to retrieve the c:\doc\h2.doc file to its originaldirectory on the workstation, named star, you would enter:dsmc retrieve c:\doc\h2.doc \\star\c$\To retrieve the file to star, which has now been renamed meteor, you would enter:dsmc retrieve c:\doc\h2.doc \\meteor\c$\You could also enter:dsmc retrieve c:\doc\h2.doc \\star\c$\You can enter the command in either of the preceding ways, because if theworkstation name is not included in the specification, the local workstation isassumed (meteor, in this case).Supported ClientsThis command is valid for all clients.Syntax►►RETrieveoptionssourcefilespec{ filespacename } sourcefilespec►►destinationfilespec►◄ParameterssourcefilespecSpecifies the path and file name that you want to retrieve. Use wildcardcharacters to specify a group of files or all the files in a directory.Note: If you include filespacename, do not include a drive letter in the filespecification.{filespacename}Specifies the file space (enclosed in braces) on the server that contains the filesyou want to retrieve. This name is the drive label on the workstation drivefrom which the files were archived.Use the file space name if the drive label name has changed, or if you areretrieving files archived from another node with drive label names that aredifferent from yours.Chapter 12. Using commands 653

Note: You must specify a mixed or lowercase NTFS file space name enclosedin quotation marks and braces. For example, {"NTFSDrive"}. Single quotationmarks or quotation marks are valid in loop mode. For example: {"NTFSDrive"}and {'NTFSDrive'} are both valid. In batch mode, only single quotation marksare valid. The single quotation marks requirement is a restriction of theoperating system.destinationfilespecSpecifies the path and file name where you want the files to reside. If you donot specify a destination, Tivoli Storage Manager restores the files to theoriginal source path.When entering the destinationfilespec consider the following:v If the sourcefilespec names a single file, the destinationfilespec can be a file or adirectory.v If the sourcefilespec is wildcarded or you specify the subdir=yes option, thedestinationfilespec must be a directory and end with a directory delimiter (\).Note: If the destination path or any part of it does not exist, Tivoli StorageManager creates it.Table 103. Retrieve command: Related optionsOptionWhere to usedateformat “Dateformat” Client options file (dsm.opt) or command line.on page 326descriptionCommand line only.“Description” on page331dirsonly “Dirsonly” onpage 337filelist “Filelist” onpage 380filesonly “Filesonly” onpage 383fromdate “Fromdate” onpage 384fromnode “Fromnode” onpage 385fromtime “Fromtime” onpage 386ifnewer “Ifnewer” onpage 391pick “Pick” on page 434preservepath“Preservepath” on page443replace “Replace” onpage 450skipntpermissions“Skipntpermissions” onpage 472Command line only.Command line only.Command line onlyCommand line onlyCommand line only.Command line onlyCommand line onlyCommand line only.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line654 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Table 103. Retrieve command: Related options (continued)OptionWhere to useskipntsecuritycrc Client options file (dsm.opt) or command line“Skipntsecuritycrc” onpage 472subdir “Subdir” on page489tapeprompt “Tapeprompt”on page 495timeformat “Timeformat”on page 503todate “Todate” on page506totime “Totime” on page507Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.ExamplesTaskTaskTaskTaskTaskTaskTaskTaskRetrieve a single file named budget.fin.Command: ret c:\devel\projecta\budget.finRetrieve all files with an extension of .c from the c:\devel\projectadirectory.Command: ret c:\devel\projecta\*.cRetrieve all files with a file extension of .c from the \devel\projectadirectory on the winnt file space.Command: ret {winnt}\devel\projecta\*.cRetrieve all files in the c:\devel directory.Command: ret c:\devel\*Retrieve files from the abc file space proj directory.Command: ret {abc}\proj\*.*Retrieve all files with a file extension of .c from the c:\devel\projectadirectory to the c:\newdevel\projectn\projecta directory. If the \projectnor the \projectn\projecta directory does not exist, it is created.Command: ret c:\devel\projecta\*.c c:\newdevel\projectn\Retrieve files in the c:\project directory. Use the pick option.Command: ret c:\project\* -pickRetrieve a file from the renamed file space \\your-node\h$_OLD to itsoriginal location. Enter both the source and destination as follows:Command: ret \\your-node\h$_OLD\docs\myresume.doc h:\docs\Related information“Client options reference” on page 294Chapter 12. Using commands 655

ScheduleRetrieve archives from file spaces that are notUnicode-enabledIf you want to retrieve archives from file spaces that were renamed by theUnicode-enabled client, you must specify the source on the server and adestination on the client.If you want to retrieve archives from file spaces that were renamed by theUnicode-enabled client, you must specify the source on the server and adestination on the client. For example, you archived files from your H-disk, named\\your-node\h$ prior to installing the client. After the installation, you issue thefollowing archive command:arc h:\logs\*.logBefore the archive takes place, the server renames the file space to\\your-node\h$_OLD. The archive continues placing the data specified in the currentoperation into the Unicode-enabled file space named \\your-node\h$. That filespace now contains only the \logs directory and the *.log files. If you want toretrieve a file from the (old) renamed file space to its original location, you mustenter both the source and destination as follows:retrieve \\your-node\h$_OLD\docs\myresume.doc h:\docs\Retrieve named streamsTivoli Storage Manager retrieves named streams on a file basis only.Directories in Windows systems can contain named streams. Named streamsattached to a directory will always be overwritten (regardless of the value of theprompt option) during the retrieve.Retrieve sparse filesWhen retrieving sparse files to a non-NTFS file system, set the Servercommunication time out value (idletimeout) to the maximum value of 255 to avoidclient session timeout.The following issues apply if more data is restored than the Microsoft disk quotaallows:vvIf the user performing the retrieve has a disk quota (e.g., belongs to the BackupOperator Group), Tivoli Storage Manager will not retrieve any data that exceedsthe disk quota of the retrieve user and will display a "Disk Full" message.If the user performing the retrieve does not have a disk quota (e.g., belongs tothe Administrator Group), Tivoli Storage Manager will retrieve all data andtransfer ownership of those files which exceed the disk quota of the originalowner to the user performing the retrieve (in this case, the Administrator).The schedule command starts the client scheduler on your workstation. The clientscheduler must be running before scheduled work can start.Note:1. The schedule command cannot be used if the managedservices option is set toschedule (does not apply to Mac OS X).2. This command is valid only on the initial command line. It is not valid ininteractive mode or in a macro file.656 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

If the schedmode option is set to polling, the client scheduler contacts the server forscheduled events at the hourly interval you specified with the queryschedperiodoption in your client options file (dsm.opt). If your administrator sets thequeryschedperiod option for all nodes, that setting overrides the client setting.If you are using TCP/IP communications, the server can prompt your workstationwhen it is time to run a scheduled event. To do so, set the schedmode option toprompted in the client options file (dsm.opt) or on the schedule command.After you start the client scheduler, it continues to run and to start scheduledevents until you press Ctrl+Break, restart the workstation, or turn off theworkstation to end it.Note: You cannot enter this command in interactive mode.Supported ClientsThis command is valid for all clients.Syntax►►SCHeduleoptions►◄ParametersTable 104. Schedule command: Related optionsOptionWhere to usemaxcmdretriesClient options file (dsm.opt) or command line.“Maxcmdretries” on page416password “Password” onpage 431queryschedperiod“Queryschedperiod” onpage 446retryperiod“Retryperiod” on page455schedlogname“Schedlogname” on page461schedmode “Schedmode” onpage 464sessioninitiation“Sessioninitiation” onpage 468tcpclientport“Tcpclientport” on page499client options file (dsm.opt)Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Chapter 12. Using commands 657

ExamplesTaskStart the client scheduler.Command: dsmc sch –password=notellWhen you run the schedule command, all messages regarding scheduled work aresent to the dsmsched.log file or to the file you specify with the schedlognameoption in your client options file (dsm.opt). If you do not specify a directory pathwith the file name in the schedlogname option, the dsmsched.log resides in thecurrent working directory.Important: To prevent log write failures and process termination in certain cases,set the DSM_LOG environment variable to name a directory where defaultpermissions allow the required access.Related informationSelectiveThe selective command backs up files that you specify. If you damage or losethese files, you can replace them with backup versions from the server.When you run a selective backup, all the files are candidates for backup unlessyou exclude them from backup, or they do not meet management classrequirements for serialization.During a selective backup, copies of the files are sent to the server even if they didnot change since the last backup. This might result in more than one copy of thesame file on the server. If this occurs, you might not have as many differentdown-level versions of the file on the server as you intended. Your version limitmight consist of identical files. To avoid this, use the incremental command toback up only new and changed files.You can selectively back up single files or directories. You can also use wildcardcharacters to back up groups of related files.If you set the subdir option to yes when backing up a specific path and file, TivoliStorage Manager recursively backs up all subdirectories under that path, and anyinstances of the specified file that exist under any of those subdirectories.During a selective backup, a directory path might be backed up, even if thespecific file that was targeted for backup is not found. For example the followingcommand still backs up dir1 and dir2 even if the file bogus.txt does not exist.selective c:\dir1\dir2\bogus.txtIf the selective command is retried because of a communication failure or sessionloss, the transfer statistics displays the number of bytes Tivoli Storage Managerattempts to transfer during all command attempts. Therefore, the statistics for bytestransferred might not match the file statistics, such as those for file size.Supported ClientsThis command is valid for all clients.658 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► Selective ▼ filespecoptions►◄||||||||||||||||||||||||ParametersfilespecSpecifies the path and name of the file you want to back up. Use wildcardcharacters to include a group of files or to include all files in a directory.To include multiple file specifications, separate each filespec with a spacecharacter. If multiple file specifications are included, and two or more of thespecifications have common parent directories, then it is possible for thecommon directory objects to be backed up more than once. The conditionsunder which this behavior occurs are runtime dependent, but the behavioritself has no adverse effects.For example if the filespec is C:\proposals\drafts\ice.docC:\proposals\drafts\fire.doc, then C:\proposals and C:\proposals\draftsmight be backed up twice. The file objects ice.doc and fire.doc are backed uponly once.If you want to avoid including the shared parent directory more than once, useseparate, non-overlapping selective commands to back up each filespecification.If you back up a file system, include a trailing slash (C:\).You can specify as many file specifications as available resources or otheroperating system limits allow.You can use the filelist option, instead of file specifications, to identifywhich files to include in this operation. However, these two methods aremutually exclusive. You cannot include file specification parameters and usethe filelist option. If the filelist option is specified, any file specificationsthat are included are ignored.Table 105. Selective command: Related optionsOptionWhere to usechangingretriesClient options file (dsm.opt) or command line.“Changingretries” onpage 310compressalways“Compressalways” on page320compression“Compression” on page320dirsonly “Dirsonly” onpage 337filelist “Filelist” onpage 380filesonly “Filesonly” onpage 383Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Command line only.Command line only.Command line only.Chapter 12. Using commands 659

Table 105. Selective command: Related options (continued)OptionWhere to usepostsnapshotcmdClient options file (dsm.opt) or with the include.fs option.“Postsnapshotcmd” onpage 438preservelastaccessdate“Preservelastaccessdate”on page 441presnapshotcmd“Presnapshotcmd” on page445skipntpermissions“Skipntpermissions” onpage 472skipntsecuritycrc“Skipntsecuritycrc” onpage 472snapshotproviderfs“Snapshotproviderfs” onpage 478snapshotroot“Snapshotroot” on page479subdir “Subdir” on page489tapeprompt “Tapeprompt”on page 495Client options file (dsm.opt) or command line.Client options file (dsm.opt) or with the include.fs option.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or with the include.fs option.Command line only.Client options file (dsm.opt) or command line.Client options file (dsm.opt) or command line.ExamplesTaskTaskTaskTaskBack up the proja.dev file in the c:\devel directory.Command: sel c:\devel\proja.devBack up all files in the c:\devel directory whose file names begin withproj.Command: sel c:\devel\proj*.*Back up all files in the c:\devel directory whose file names begin withproj. Back up all files with a file extension of .fin in the c:\planningdirectory.Command: sel c:\devel\proj* c:\planning\*.finAssuming that you initiated a snapshot of the C: drive and mounted thesnapshot as \\florence\c$\snapshots\snapshot.0, run a selective backupof the c:\dir1\sub1 directory tree from the local snapshot and manage iton the Tivoli Storage Manager server under the file space name C:.Command: dsmc sel c:\dir1\sub1\* -subdir=yes -snapshotroot=\\florence\c$\snapshots\snapshot.0Related information“Autofsrename” on page 304660 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Set Access“Include options” on page 395“Subfilebackup” on page 491Open file supportIf open file support has been configured, Tivoli Storage Manager performs asnapshot backup or archive of files that are locked (or "in use") by otherapplications.Use VSS as the snapshot provider; set snapshotproviderimage orsnapshotproviderfs to VSS.Note:1. You can use the include.fs option to set snapshot options on a per file systembasis.2. Open file support is only available for local fixed volumes (mounted to eitherdrive letters or volume mount points) formatted with NTFS file systems. Thissupport includes SAN-attached volumes that meet these requirements.3. If the client is unable to create a snapshot, failover to non-OFS backup occurs;the same backup support that would be done if the OFS feature was notconfigured.4. To enable open file support in a cluster environment all systems in the clustershould have the OFS feature configured.Adaptive subfile backupsIf you perform a backup over a network device with limited bandwidth, such aswith a modem, you can reduce network traffic by using the subfilebackup option.In order to use this feature, you must first specify the adaptive subfile backupoptions during a normal backup.Associate a local snapshot with a server file spaceUse the snapshotroot option with the selective command in conjunction with anindependent software vendor application that provides a snapshot of a logicalvolume, to associate the data on the local snapshot with the real file space datathat is stored on the Tivoli Storage Manager server. The snapshotroot option doesnot provide any facilities to take a volume snapshot, only to manage data createdby a volume snapshot.The set access command gives users at other nodes access to your backup versionsor archived copies.You can also use the set access command to give users at other nodes access toyour backup images.You can give another user access to a specific file or image, multiple files orimages, or all files in a directory. When you give access to another user, that usercan restore or retrieve your objects. Specify in the command whether you aregiving access to archives or backups.Chapter 12. Using commands 661

When a node is exported to another Tivoli Storage Manager server, the access rulescan change on the importing server. If an access rule is applied to all file spaces onthe exporting server, the access rule on the importing server is restricted to onlythose file spaces that are imported. The file spaces are restricted in the access ruleon the importing server for security reasons. Additionally, the access rules do notrecognize the first occurrence of a wildcard character in the file specification whenyou restore or retrieve. This means that if you restore or retrieve with a wildcardcharacter in the file specification, subdirectories are ignored.Tip: If you might export a node to another Tivoli Storage Manager server, do notuse a single wildcard character as the file specification in the access rule. Instead,create an access rule for each filespace.Note: You cannot give access to both archives and backups using a singlecommand.When an existing file space is renamed during Unicode conversion, any accessrules that are defined for the file space remain applicable to the original file space.However, new access rules must be defined to apply to the new Unicode filespace.Supported ClientsThis command is valid for all clients.Syntax►► SET Access ArchiveBackupfilespec{ filespacename } filespecimage-fsTYPE=VM vmnamenode►◄ParametersArchivePermits access to archived files or images.BackupPermits access to backup versions of files or images.filespecSpecifies the path, file, image, or directory to which your are giving access toanother node or user. Use wildcard characters to specify a group of files orimages, or all files in a directory; all objects in a directory branch; or all objectsin a drive. However, you cannot use a wildcard to specify all drives. Use asingle asterisk "*" for the file spec to give access to all files or images owned byyou and backed up on the server. When the command set access backup "*"node is entered, no check is made with the server; it is assumed you have atleast one object backed up.If you give access to a branch of the current working directory, you only needto specify the branch. If you give access to objects that are not in a branch ofthe current working directory, you must specify the complete path. The filespec to which you gave access must have at least one backup version orarchive copy object (file or directory) on the server.To specify all files in a named directory, enter d:\test\mine\proj1\* on thecommand line.662 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

To give access to all objects below a certain level, use an asterisk, directorydelimiter, and an asterisk at the end of your file spec. For example, to giveaccess to all objects below d:\test use file spec d:\test\*\*.Important: Use of the form \*\* alone will not give access to objects in thenamed directory; only those in directories below the named directory areaccessible.The rules are essentially the same when considering the root directory. Enter \*on one set access command and \*\* on another if you want another user tohave access to all files and directories in and below the root directory. The first\* gives access to all directories and all files in the root directory. The second\* allows access to all directories and files below the root directory.|||||Note:1. Use the file space name if the drive label name has changed.2. If you include filespacename, do not include a drive letter in the filespecification.For example:v Your directory structure is multilevel: d:\test\sub1\subsub1.v The d:\test directory contains the h1.txt and h2.txt files.v The d:\test\sub1 directory contains file s1.htm.v The d:\test\sub1\sub2 directory contains the ss1.cpp file.To allow access to all files in the d:\test\sub1\sub2 directory, enter:set access backup d:\test\sub1\sub2\* * *To allow access to only those files in the d:\test directory, enter:set access backup d:\test\* * *To allow access to all files in all directories in and below the d:\test directory,enter:set access backup d:\test\* * *set access backup d:\test\*\* * *{filespacename}Specifies the file space name (enclosed in braces) on the server that containsthe files to which you are giving access. This name is the drive label name onthe workstation drive from which the file was backed up or archived. Use thefile space name if the drive label name has changed.image-fsThe name of the image file system to be shared. This can be specified as anasterisk (*) to allow access to all images owned by the user granting access.TYPE=VM vmnameThis parameter is required if you are using this command to provide anotheruser with access to VMware virtual machine backups. The vmname option canbe specified only if TYPE=VM is specified; vmname is the name of the VMwarevirtual machine that you are permitting access to.nodeSpecifies the client node of the user to whom you are giving access. Usewildcards to give access to more than one node with similar node names. Usean asterisk (*) to give access to all nodes.Chapter 12. Using commands 663

Examples|||TaskTaskTaskTaskGive the user at node_2 authority to restore all files with an extension of.c from the c:\devel\proja directory.set access backup c:\devel\proja\*.c node_2Give the user at node_3 authority to retrieve all files in the c:\develdirectory, but do not permit access to files in subdirectories of c:\devel,such as c:\devel\proj.set access archive c:\devel\* node_3Give all nodes whose names end with bldgb the authority to restore allbackup versions from all directories on the d: drive. The d: drive has thefile space name of project.set ac b {project}\*\* *bldgbGive the node named myOtherNode the authority to restore files backed upby the VMware virtual machine named myTestVM.set access backup TYPE=VM myTestVM myOtherNodeSet EventThe set event command allows you to specify the circumstances for when archiveddata is deleted.You can use the set event command to:v Prevent the deletion of data at the end of its assigned retention period (Deletionhold)v Allow the expiration to take place, as defined by the archive copy group(Release a deletion hold)v Start the expiration clock running when a particular event occurs (Notify theserver that an event has occurred)Objects affected can be specified with a standard Tivoli Storage Manager filespec(including wildcards), a list of files whose names are in the file specified using thefilelist option, or a group of archived files with the description specified withthe description option.Note: When only a is used, all archived copies of files or foldersmatching the filespec are affected. If you only want to affect certain versions of afile, use the -pick option and select from the displayed list.Interaction with down-level servers:If the set event command is issued when the client is connected to a server thatdoes not support event-based policy (previous to Tivoli Storage Manager 5.2.2), thecommand is rejected with an error message indicating that the current server doesnot support event-based policy.Supported ClientsThis command is valid for all clients.664 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Syntax►► SET Event -TYPE= HoldReleaseActivateretention►► -filelist= -description= -pick ►◄ParametersTYPE=Specifies the event type setting. This parameter must be specified.holdPrevents the object from being deleted regardless of expiration policy.releaseAllows normal event-controlled expiration to take place.activateretentionSignals the server that the controlling event has occurred and starts theexpiration clock running.-pickProvides a list of objects from which the user can select to apply the event.The following options can also be used and serve their usual purpose:v Dateformatv Numberformatv Nopromptv Subdirv TimeformatExamplesTaskThe following example displays the verbose and statistics output from theset event command set event type=hold \\user\c$\tsm521\debug\bin\winnt_unicode\dsm.opt, with objects rebound (as opposed to archived orsome other notation).Rebinding--> 274 \\user\c$\tsm521\debug\bin\winnt_unicode\dsm.optRebinding--> 290 \\user\c$\tsm521\debug\bin\winnt_unicode\dsm.optTotal number of objects inspected: 2Total number of objects archived: 0Total number of objects updated: 0Total number of objects rebound: 2Total number of objects deleted: 0Total number of objects expired: 0Total number of objects failed: 0Total number of bytes transferred: 0 BData transfer time:0.00 secNetwork data transfer rate:0.00 KB/secAggregate data transfer rate:0.00 KB/secObjects compressed by: 0%Elapsed processing time: 00:00:02Chapter 12. Using commands 665

TaskThe -pick option used with the set event command set eventtype=activate \user\c$\tsm521\common\winnt shows the event typeinstead of the command name:TSM Scrollable PICK Window - Retention Event : ACTIVATE# Archive Date/Time File Size File---------------------------------------------------------1. | 08/05/2003 08:47:46 766 B \\user\c$\tsm521\common\winnt2. | 08/01/2003 10:38:11 766 B \\user\c$\tsm521\common\winnt3. | 08/05/2003 08:47:46 5.79 KB \\user\c$\tsm521\common\winnt4. | 08/01/2003 10:38:11 5.79 KB \\user\c$\tsm521\common\winnt5. | 08/05/2003 08:47:46 10.18 KB \\user\c$\tsm521\common\winntRelated information“Dateformat” on page 326“Numberformat” on page 429“Noprompt” on page 428“Subdir” on page 489“Timeformat” on page 503Set PasswordThe set password command changes the Tivoli Storage Manager password foryour workstation.If you omit the old and new passwords when you enter the set passwordcommand, you are prompted once for the old password and twice for the newpassword.Passwords can be up to 63 character in length. Password constraints vary,depending on where the passwords are stored and managed, and depending onthe version of the Tivoli Storage Manager server that your client connects to.If your Tivoli Storage Manager server is at version 6.3.3 or later, and if you usean LDAP directory server to authenticate passwordsUse any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are case-sensitive and are subject to more restrictions that canbe imposed by LDAP policies.If your Tivoli Storage Manager server is at version 6.3.3 or later, and if you donot use an LDAP directory server to authenticate passwordsUse any of the following characters to create a password:666 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789~!@#$%^&*_-+=`|(){}[]:;,.?/Passwords are stored in the Tivoli Storage Manager server database andare not case-sensitive.If your Tivoli Storage Manager server is earlier than version 6.3.3Use any of the following characters to create a password:abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-&+.Remember:Passwords are stored in the Tivoli Storage Manager server database andare not case-sensitive.||||||On the command line, enclose a password in quotation marks if the passwordcontains one or more special characters. The quotation marks ensure that thespecial characters are correctly interpreted as password characters. Withoutquotation marks, the special characters can be interpreted as shell escapecharacters, file redirection characters, or other characters that have significance tothe operating system.On Windows systems:Enclose the password in quotation marks (").Command line example:-password="secret>shhh"Quotation marks are not required when you type a password with specialcharacters in an options file.Supported ClientsThis command is valid for all clients.|Syntax||►►SET Passwordoldpwnewpw►|||►otherserver otheruserid otherpasswordTYPE=TSMTYPE=FILERTYPE=VMTYPE=VMGUESTTYPE=FASTBackALLVM►◄|ParametersoldpwSpecifies the current password for your workstation.Chapter 12. Using commands 667

newpwSpecifies the new password for your workstation.TYPESpecifies if this password is for the workstation or file server.Use TYPE=TSM to specify the Tivoli Storage Manager password for yourworkstation. Use TYPE=FILER to specify that this password is for snapshotdifference operations on a file server. The default is TSM.For TYPE=FILER you must specify the file server name, the user ID, and thepassword. For example: dsmc set password -type=filer myfiler fileridfilerpasswd.If you are using the dsmc command in batch mode, and your passwordcontains any special characters (for example, pa$sword), you must enclose thepassword in single quotation marks to avoid truncation. For example:dsmcset password -type=filer myfiler ’pa$sword’Note: When you specify TYPE=FILER, the password is stored in the TSM.PWD fileor the Windows registry without validating that the password is valid.Passwords that are stored with the TYPE=FILER parameter can be sharedbetween Tivoli Storage Manager nodes. For example, a password stored byNODEA can be used by NODEB. Only one set of credentials is stored per fileserver.Use TYPE=VM to set the password needed to log on to an ESX or vCenter server.dsmc SET PASSWORD -type=VM hostname administrator passwordwhere:hostnameSpecifies the name of the virtual machine guest that you want toprotect.administratorSpecifies the account needed to log on to the guest VM.passwordSpecifies the password associated with the login account.Use the Preferences editor to set the vmchost, vmcuser, and vmcpw options. Youcan also use the set password command to save the vmcuser and vmcpw optionsand then set the vmchost option, for example: set password -type=VM vmchostvmcuser vmcpw.When using the set password TYPE=VM option, make sure that the valuespecified for vmchost is the same as the value that is used on the set passwordcommand. When you use set password with TYPE=VM, the vmcuser and vmcpwoptions do not need to be in your client options. For example:dsmc SET PASSWORD -type=VM archon.example.com Administrator secretThis set password command specifies the hostname, user name, and password.All that you need in the client options is the hostname:VMCHOST archon.example.comSpecify TYPE=VMGUEST if you use the INCLUDE.VMTSMVSS option to protect avirtual machine (INCLUDE.VMTSMVSS requires an IBM ® Tivoli ® Storage Managerfor Virtual Environments license). Provide the following on the set passwordcommand:set password -type=vmguest guest_VM_name administrator password668 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

where:guest_VM_nameSpecifies the name of the virtual machine guest that you want toprotect.administratorSpecifies the account needed to log on to the guest VM.passwordSpecifies the password associated with the login account.If you use the same credentials to log on to multiple virtual machines that areprotected by the INCLUDE.VMTSMVSS option, you can set the password for the allof the virtual machines by specifying the ALLVM parameter. The ALLVMparameter causes the same credentials to be used when the client logs on toany guest that is included in an INCLUDE.VMTSMVSS option. The following is anexample of how to use ALLVM. In this example, the user name "Administrator"and the password "Password" are used to log on to any virtual machine thatyou have included on an INCLUDE.VMTSMVSS option:set password -type=vmguest ALLVM Administrator PasswordYou can also set a combination of shared and individual credentials. Forexample, if most virtual machines in your environment use the samecredentials, but a few virtual machines use different credentials, you can usemultiple set password commands to specify the credentials. For example,assume that most virtual machines use “Administrator1” as the login nameand “Password1” as the password. Assume also that one virtual machine,named VM2, uses “Administrator2” as the login name and “Password2” as thepassword. The following commands are used to set the credentials for thisscenario:set password -type=vmguest ALLVM Administrator1 Password1 (setscredentials for most of the VMs).set password -type=vmguest VM2 Administrator2 Password2 (sets uniquecredentials for VM2).Use the TYPE=FastBack parameter to store the Tivoli Storage Manager FastBackcredentials that are required for mounting and dismounting the FastBackvolumes to back up or archive to the Tivoli Storage Manager server.Important: You must define the user credentials that are required to mountand unmount FastBack volumes from a repository to the Tivoli StorageManager client before you enter the Tivoli Storage Manager FastBacksubcommand. Use the reposlocation option to define the credentials.Here is a brief description of the various configurations and credentials thatyou need:vIf the Tivoli Storage Manager client is installed on the Tivoli StorageManager FastBack DR Hub workstation, the client attempts to connect to alocal repository. You must manually define the Tivoli Storage ManagerFastBack admin user ID and the corresponding password using thiscommand:dsmc set password -type=fastback fbserver fbadminuserid fbadminpassIn the previous command, the fbserver is the short host name of the TivoliStorage Manager FastBack Server workstation.Chapter 12. Using commands 669

You must issue the set password command once for each FastBack Serverbranch repository on the FastBack DR Hub machine that the Tivoli StorageManager Backup-Archive Client is expected to connect to.Follow these steps for each of the network share repositories where the TivoliStorage Manager client is connected:1. Configure the repository for remote network access from FastBackManager. Refer to the Tivoli Storage Manager FastBack Installation and User'sGuide for details.This step establishes a domain name, a network share user ID, and anetwork share password to connect remotely to the repository.2. On the Tivoli Storage Manager client workstation, manually enter thefollowing command:dsmc set password type=fastback FBServer domain:networkaccessuseridnetworkaccesspasswordThe fbserver option specifies the short host name of the FastBack serverworkstation. For a FastBack DR Hub, the fbserver option specifies theshort name of the workstation where the DR Hub is installed.Networkaccessuserid is the user ID on the Tivoli Storage Manager clientworkstation that has read access to the network share repository.Domain is the domain name of the user ID.Networkaccesspassword is the password of the network access user ID.These credentials are retrieved based on the short host name that you specifywith the fbserver option.otherserverSpecifies the file server host name if you specify TYPE=FILER. The file serverhost name must be the fully qualified DNS name and cannot be the IP addressin dotted-decimal format or the short local-host name. This parameter onlyapplies if you specify TYPE=FILER.otheruseridSpecifies the user ID to be used for the entity named by the otherserverparameter. This parameter only applies if you specify TYPE=FILER.otherpasswordSpecifies the password to be used for the entity named by the otherserverparameter. This parameter only applies if you specify TYPE=FILER.ExamplesThe following examples use the set password command.TaskChange your password from osecret to nsecret.Command: set password osecret nsecretTaskSet up a user ID and password for the root user on the file servermyFiler.example.com.Command: dsmc set password -type=filer myFiler.example.com rootPlease enter password for user id "root@myFiler.example.com":******** Re-enter the password for verification:******** ANS0302ISuccessfully done.TaskSet up a user ID and password for the root user on the file servermyFiler.example.com.670 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Command: dsmc set password -type=filer myFiler.example.com rootsecretTaskSet up a user ID and password for the FastBack server myFastBackServer.Use the -fbserver option in the archive fastback and backup fastbackcommands for the server name.Command: dsmc set password -type=FASTBack myFastBackServermyUserId "pa$sword"Important:1. The dsmc set password -type=fastback command must be repeated ona dedicated client proxy workstation once for each FastBack repositorywhere the Tivoli Storage Manager Backup-Archive Client is expected toconnect.2. For network share repositories the dsmc set password -type=fastbackcommand should be in this format: dsmc set password -type=fastbackmyFBServer domainName:userId password.3. For a FastBack server or a Tivoli Storage Manager FastBack Hub, theuser ID and password specified must have Tivoli Storage ManagerFastBack administrator privileges. You must issue the dsmc setpassword -type=fastback command once for each FastBack Serverbranch repository on the FastBack DR Hub that the Tivoli StorageManager Backup-Archive Client is expected to connect to.4. The server name specified, myFBServer, in the above example, mustmatch the name to be specified on the -fbserver option specified on thebackup fastback or archive fastback command.Related reference:“Snapdiff” on page 473Chapter 12. Using commands 671

672 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Appendix A. Support informationGetting technical trainingSearching knowledge basesYou can find support information for IBM products from various sources.From the IBM Support Portal at http://www.ibm.com/support/entry/portal/, youcan select the products that you are interested in and search for a wide variety ofrelevant information.Information about Tivoli technical training courses is provided online.Go to the following websites to sign up for training, ask questions, and interactwith others who use IBM storage products.Tivoli software training and certificationChoose from instructor led, online classroom training, self-paced webclasses, Tivoli certification preparation, and other training options at:http://www.ibm.com/software/tivoli/education/.Tivoli Support Technical ExchangeTechnical experts share their knowledge and answer your questions inwebcasts at: http://www.ibm.com/software/sysmgmt/products/support/supp_tech_exch.html.Storage Management communityTo interact with others who use IBM storage management products, visitthe following website: http://www.ibm.com/developerworks/servicemanagement/sm/index.html.Global Tivoli User CommunityTo share information and learn from other Tivoli users throughout theworld, visit the following website: http://www.tivoli-ug.org/.IBM Education AssistantFor short recordings designed to help you use IBM software products moreeffectively, visit the following website: http://publib.boulder.ibm.com/infocenter/ieduasst/tivv1r0/index.jsp.If a problem occurs while you are using one of the Tivoli Storage Manager familyproducts, you can search several knowledge bases.Begin by searching the Tivoli Storage Manager Information Center athttp://pic.dhe.ibm.com/infocenter/tsminfo/v6r4. From this website, you cansearch the current Tivoli Storage Manager documentation.Searching the InternetIf you cannot find an answer to your question in the IBM Tivoli Storage Managerinformation center, search the Internet for the information that might help youresolve the problem.© Copyright IBM Corp. 1993, 2012 673

To search multiple Internet resources, go to the IBM support website athttp://www.ibm.com/support/entry/portal/. You can search for informationwithout signing in.Sign in using your IBM ID and password if you want to customize the site basedon your product usage and information needs. If you do not already have an IBMID and password, click Sign in at the top of the page and follow the instructionsto register.From the support website, you can search various resources including:v IBM technotes.v IBM downloads.v IBM Redbooks ® publications.v IBM Authorized Program Analysis Reports (APARs). Select the product and clickDownloads to search the APAR list.If you still cannot find a solution to the problem, you can search forums andnewsgroups on the Internet for the latest information that might help you findproblem resolution.An independent user discussion list, ADSM-L, is hosted by Marist College. You cansubscribe by sending an email to listserv@vm.marist.edu. The body of the messagemust contain the following text: SUBSCRIBE ADSM-L your_first_nameyour_family_name.To share your experiences and learn from others in the Tivoli Storage Manager andTivoli Storage FlashCopy Manager user communities, go to Service ManagementConnect (http://www.ibm.com/developerworks/servicemanagement/sm/index.html). From there you can find links to product wikis and user communities.Using IBM Support AssistantIBM Support Assistant is a complimentary software product that can help you withproblem determination. It is available for some Tivoli Storage Manager and TivoliStorage FlashCopy Manager products.To learn about which products are supported, go to the IBM Support Assistantdownload web page at http://www.ibm.com/software/support/isa/download.html.IBM Support Assistant helps you gather support information when you must opena problem management record (PMR), which you can then use to track theproblem. The product-specific plug-in modules provide you with the followingresources:v Support linksv Education linksv Ability to submit problem management reportsYou can find more information about the IBM Support Assistant at:http://www.ibm.com/software/support/isa/.You can also install the stand-alone IBM Support Assistant application on anyworkstation. You can then enhance the application by installing product-specificplug-in modules for the IBM products that you use. Find add-ons for specificproducts at http://www.ibm.com/support/docview.wss?uid=swg27012689.674 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Finding product fixesA product fix to resolve a software problem might be available from the IBMsoftware support website.You can determine what fixes are available by checking the IBM software supportwebsite at http://www.ibm.com/support/entry/portal/.vvIf you previously customized the site based on your product usage, follow thesesteps:1. Click the link for the product, or a component for which you want to find afix.2. Click Downloads, and then click Fixes by version.If you have not customized the site based on your product usage, clickDownloads and search for the product.Receiving notification of product fixesYou can receive notifications about fixes, flashes, upgrades, and other news aboutIBM products.To sign up to receive notifications about IBM products, follow these steps:1. From the support page at http://www.ibm.com/support/entry/portal/, clickSign in and sign in using your IBM ID and password. If you do not have anID and password, click register now and complete the registration process.2. Click Manage all my subscriptions in the Notifications pane.3. Click the Subscribe tab, and then click Tivoli.4. Select the products for which you want to receive notifications and clickContinue.5. Specify your notification preferences and click Submit.Contacting IBM Software SupportYou can contact IBM Software Support if you have an active IBM subscription andsupport contract, and if you are authorized to submit problems to IBM.To obtain help from IBM Software Support, complete the following steps:1. Ensure that you have completed the following prerequisites:a. Set up a subscription and support contract.b. Determine the business impact.c. Describe the problem and gather background information.2. Follow the instructions in “Submitting the problem to IBM Software Support”on page 676.Setting up a subscription and support contractSet up a subscription and support contract. The type of contract that you needdepends on the type of product you have.For IBM distributed software products, enroll in IBM Passport Advantage in one ofthe following ways:vOnline: Go to the Passport Advantage website at http://www.ibm.com/software/lotus/passportadvantage/, click How to enroll, and follow theinstructions.Appendix A. Support information 675

vBy telephone: For critical, system-down, or severity 1 issues, you can call1-800-IBMSERV (1-800-426-7378) in the United States. For the telephone numberto call in your country, go to the IBM Software Support Handbook web page athttp://www14.software.ibm.com/webapp/set2/sas/f/handbook/home.htmland click Contacts.Note: IBM distributed software products include, but are not limited to IBM Tivoli,Lotus ® , and Rational ® products, as well as IBM DB2 ® and IBM WebSphere ®products that run on Microsoft Windows or on operating systems such as AIX orLinux.Determining the business impactWhen you report a problem to IBM, you are asked to supply a severity level.Therefore, you must understand and assess the business impact of the problemyou are reporting.Severity 1Severity 2Severity 3Severity 4Critical business impact: You are unable to use the program,resulting in a critical impact on operations. This conditionrequires an immediate solution.Significant business impact: The program is usable but isseverely limited.Some business impact: The program is usable with lesssignificant features (not critical to operations) unavailable.Minimal business impact: The problem causes little impact onoperations, or a reasonable circumvention to the problem hasbeen implemented.Describing the problem and gathering background informationWhen explaining a problem to IBM, it is helpful to be as specific as possible.Include all relevant background information so that IBM Software Supportspecialists can help you solve the problem efficiently.To save time, know the answers to these questions:v What software versions were you running when the problem occurred?v Do you have logs, traces, and messages that are related to the problemsymptoms? IBM Software Support is likely to ask for this information.v Can the problem be re-created? If so, what steps led to the failure?v Have any changes been made to the system? For example, hardware, operatingsystem, networking software, and so on.v Are you using a workaround for this problem? If so, be prepared to explain itwhen you report the problem.Submitting the problem to IBM Software SupportYou can submit the problem to IBM Software Support online or by telephone.OnlineGo to the IBM Software Support website at http://www.ibm.com/support/entry/portal/Open_service_request/Software/Software_support_(general). Sign in to access IBM Service Requests andenter your information into the problem submission tool.By telephoneFor critical, system-down, or severity 1 issues, you can call 1-800-IBMSERV676 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

(1-800-426-7378) in the United States. For the telephone number to call inyour country, go to the IBM Software Support Handbook web page athttp://www14.software.ibm.com/webapp/set2/sas/f/handbook/home.html and click Contacts.Appendix A. Support information 677

678 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Appendix B. Accessibility features for the Tivoli StorageManager product familyAccessibility features help users who have a disability, such as restricted mobilityor limited vision to use information technology products successfully.Accessibility featuresThe following list includes the major accessibility features in the Tivoli StorageManager family of products:v Keyboard-only operationv Interfaces that are commonly used by screen readersv Keys that are discernible by touch but do not activate just by touching themv Industry-standard devices for ports and connectorsv The attachment of alternative input and output devicesThe Tivoli Storage Manager Information Center and related publications areenabled for accessibility. For information about the accessibility features of theinformation center, see the following topic: http://pic.dhe.ibm.com/infocenter/tsminfo/v6r4/topic/com.ibm.help.ic.doc/iehs36_accessibility.html.Keyboard navigationOn Windows, the Tivoli Storage Manager product family follows Microsoftconventions for all keyboard navigation and access. Drag-and-drop support ismanaged by using the Microsoft Windows accessibility option known asMouseKeys. For more information about MouseKeys and other Windowsaccessibility options, see the Windows online help, citing the keyword“MouseKeys”.On other operating systems, these products follow the operating-systemconventions for keyboard navigation and access.Vendor softwareThe Tivoli Storage Manager product family includes certain vendor software that isnot covered under the IBM license agreement. IBM makes no representation aboutthe accessibility features of these products. Contact the vendor for the accessibilityinformation about its products.IBM and accessibilitySee the IBM Human Ability and Accessibility Center (http://www.ibm.com/able)for information about the commitment that IBM has to accessibility.© Copyright IBM Corp. 1993, 2012 679

680 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

NoticesThis information was developed for products and services offered in the U.S.A.IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 JapanThe following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes 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 websites are provided forconvenience only and do not in any manner serve as an endorsement of thosewebsites. The materials at those websites are not part of the materials for this IBMproduct and use of those websites is at your own risk.© Copyright IBM Corp. 1993, 2012 681

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.Licensees of this program who want to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758U.S.A.Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.This information is for planning purposes only. The information herein is subject tochange before the products described become available.This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.COPYRIGHT LICENSE:This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sample682 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

programs are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows: © (your company name) (year). Portions ofthis code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp._enter the year or years_.If you are viewing this information in softcopy, the photographs and colorillustrations may not appear.TrademarksIBM, the IBM logo, and ibm.com ® are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the Web at “Copyright andtrademark information” at http://www.ibm.com/legal/copytrade.shtml.Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.UNIX is a registered trademark of The Open Group in the United States and othercountries.Intel, Intel logo, Intel Inside, Intel Inside logo, Itanium, and Pentium aretrademarks or registered trademarks of Intel Corporation or its subsidiaries in theUnited States and other countries.Notices 683

684 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

GlossaryThis glossary includes terms and definitions for IBM Tivoli Storage Manager and IBM Tivoli StorageFlashCopy Manager products.To view glossaries for other IBM products, go tohttp://www.ibm.com/software/globalization/terminology/.The following cross-references are used in thisglossary:v See refers the reader from a term to a preferredsynonym, or from an acronym or abbreviationto the defined full form.v See also refers the reader to a related orcontrasting term.Aabsolute modeIn storage management, a backupcopy-group mode that specifies that a fileis considered for incremental backup evenif the file has not changed since the lastbackup. See also modified mode.access control list (ACL)In computer security, a list associatedwith an object that identifies all thesubjects that can access the object andtheir access rights. For example, an accesscontrol list is associated with a file thatidentifies the users who can access thatfile and their access rights.access modeAn attribute of a storage pool or a storagevolume that specifies whether the servercan write to or read from the storage poolor storage volume. The access mode canbe read/write, read-only, or unavailable.Volumes in primary storage pools canalso have an access mode of destroyed.Volumes in copy storage pools can alsohave an access mode of offsite.acknowledgmentThe transmission of acknowledgmentcharacters as a positive response to a datatransmission.ACL See access control list.activateTo validate the contents of a policy setand then make it the active policy set.active-data poolA named set of storage pool volumes thatcontain only active versions of clientbackup data.active file systemA file system to which space managementhas been added. With space management,tasks for an active file system includeautomatic migration, reconciliation,selective migration, and recall. Contrastwith inactive file system.active policy setThe activated policy set that contains thepolicy rules in use by all client nodes thatare assigned to the policy domain. Seealso policy domain and policy set.active versionThe most recent backup copy of a filestored. The active version of a file cannotbe deleted until a backup process detectsthat the user has either replaced the filewith a newer version or has deleted thefile from the file server or workstation.Contrast with inactive version.activity logA log that records normal activitymessages that are generated by the server.These messages include information aboutserver and client operations, such as thestart time of sessions or device I/O errors.adaptive subfile backupA type of backup that sends only changedportions of a file to the server, instead ofsending the entire file. Adaptive subfilebackup reduces network traffic andincreases the speed of the backup.administrative clientA program that runs on a file server,workstation, or mainframe thatadministrators use to control and monitorthe Tivoli Storage Manager server.Contrast with backup-archive client.administrative command scheduleA database record that describes the© Copyright IBM Corp. 1993, 2012 685

planned processing of an administrativecommand during a specific time period.See also client schedule.administrative privilege classSee privilege class.administrative sessionA period of time during which anadministrator user ID communicates witha server to perform administrative tasks.Contrast with client node session.administratorA user who is registered to the server asan administrator, and who is authorizedto perform tasks and issue commandsthrough the assignment of anadministrative privilege class.Advanced Program-to-Program Communication(APPC)An implementation of the SNA LU 6.2protocol that allows interconnectedsystems to communicate and share theprocessing of programs.agent nodeA client node that has been granted proxyauthority to perform operations on behalfof another client node, which is the targetnode.aggregateAn object, stored in one or more storagepools, consisting of a group of logical filesthat are packaged together. See also logicalfile and physical file.aggregate data transfer rateA performance statistic that indicates theaverage number of bytes that weretransferred per second while processing agiven operation.APPC See Advanced Program-to-ProgramCommunication.application clientA program that is installed on a system toprotect an application. The Tivoli StorageManager server provides backup servicesto an application client.archiveTo copy programs, data, or files to otherstorage media, usually for long-termstorage or security. Contrast with retrieve.archive copyA file or group of files that was archivedto server storage.archive copy groupA policy object containing attributes thatcontrol the generation, destination, andexpiration of archived files.archive-retention grace periodThe number of days that the storagemanager retains an archived file when theserver is unable to rebind the file to anappropriate management class. See alsobind.association(1) The defined relationship between aclient node and a client schedule. Anassociation identifies the name of aschedule, the name of the policy domainto which the schedule belongs, and thename of a client node that performsscheduled operations.(2) On a configuration manager, thedefined relationship between a profile andan object such as a policy domain. Profileassociations define the configurationinformation that is distributed to amanaged server when it subscribes to theprofile.audit To check for logical inconsistenciesbetween information that the server hasand the actual condition of the system.The storage manager can auditinformation about items such as volumes,libraries, and licenses. For example, whena storage manager audits a volume, theserver checks for inconsistencies betweeninformation about backed-up or archivedfiles that are stored in the database andthe actual data that are associated witheach backup version or archive copy inserver storage.authenticationThe process of checking a user's passwordbefore permitting user access to the TivoliStorage Manager server. Authenticationcan be turned on or off by anadministrator with system privilege.authentication ruleA specification that another user can useto either restore or retrieve files fromstorage.686 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

authorityThe right to access objects, resources, orfunctions. See also privilege class.authorization ruleA specification that permits another userto either restore or retrieve a user's filesfrom storage.authorized userA user who has administrative authorityfor the Tivoli Storage Manager client on aworkstation. This user changespasswords, performs open registrations,and deletes file spaces.AutoFSSee automounted file system.automatic detectionA feature that detects, reports, andupdates the serial number of a drive orlibrary in the database when the pathfrom the local server is defined.automatic migrationThe process that is used to automaticallymove files from a local file system tostorage, based on options and settingsthat are chosen by a root user on aworkstation. See also threshold migrationand demand migration.automatic reconciliationThe process that is used to reconcile filesystems at regular intervals. The intervalsare set by a user with root user authority.See also reconciliation.automounted file system (AutoFS)A file system that is managed by anautomounter daemon. The automounterdaemon monitors a specified directorypath, and automatically mounts the filesystem to access data.Bbackup-archive clientA program that runs on a workstation orfile server and provides a means for usersto back up, archive, restore, and retrievefiles. Contrast with administrative client.backup copy groupA policy object containing attributes thatcontrol the generation, destination, andexpiration of backup versions of files. Abackup copy group belongs to amanagement class.backup-retention grace periodThe number of days the storage managerretains a backup version after the serveris unable to rebind the file to anappropriate management class.backup setA portable, consolidated group of activeversions of backup files that are generatedfor a backup-archive client.backup set collectionA group of backup sets that are created atthe same time and which have the samebackup set name, volume names,description, and device classes. The serveridentifies each backup set in the collectionby its node name, backup set name, andfile type.backup versionA file or directory that a client nodebacked up to server storage. More thanone backup version can exist in serverstorage, but only one backup version isthe active version. See also active versionand inactive version.bind To associate all versions of a file with amanagement class name. See rebind.binderyA database that consists of three systemfiles for a NetWare server. The filescontain user IDs and user restrictions.Ccache To place a duplicate copy of a file onrandom access media when the servermigrates a file to another storage pool inthe hierarchy.cache fileA snapshot of a logical volume created byLogical Volume Snapshot Agent. Blocksare saved immediately before they aremodified during the image backup andtheir logical extents are saved in the cachefiles.CAD See client acceptor.central schedulerA function that permits an administratorto schedule client operations andadministrative commands. The operationscan be scheduled to occur periodically oron a specific date. See client schedule andadministrative command schedule.Glossary 687

client A software program or computer thatrequests services from a server.client acceptorAn HTTP service that serves the appletfor the web client to web browsers. OnWindows systems, the client acceptor isinstalled and run as a service. On AIX,UNIX, and Linux systems, the clientacceptor is run as a daemon, and is alsocalled the client acceptor daemon (CAD).client acceptor daemon (CAD)See client acceptor.client domainThe set of drives, file systems, or volumesthat the user selects to back up or archivedata, using the backup-archive client.client nodeA file server or workstation on which thebackup-archive client program has beeninstalled, and which has been registeredto the server.client node sessionA session in which a client nodecommunicates with a server to performbackup, restore, archive, retrieve, migrate,or recall requests. Contrast withadministrative session.client options fileAn editable file that identifies the serverand communication method, andprovides the configuration for backup,archive, hierarchical storage management,and scheduling.client option setA group of options that are defined onthe server and used on client nodes inconjunction with client options files.client-polling scheduling modeA method of operation in which the clientqueries the server for work. Contrast withserver-prompted scheduling mode.client scheduleA database record that describes theplanned processing of a client operationduring a specific time period. The clientoperation can be a backup, archive,restore, or retrieve operation, a clientoperating system command, or a macro.See also administrative command schedule.client/serverPertaining to the model of interaction indistributed data processing in which aprogram on one computer sends a requestto a program on another computer andawaits a response. The requestingprogram is called a client; the answeringprogram is called a server.client system-options fileA file, used on AIX, UNIX, or Linuxsystem clients, containing a set ofprocessing options that identify theservers to be contacted for services. Thisfile also specifies communication methodsand options for backup, archive,hierarchical storage management, andscheduling. This file is also called thedsm.sys file. See also client user-options file.client user-options fileA file that contains the set of processingoptions that the clients on the system use.The set can include options thatdetermine the server that the clientcontacts, and options that affect backupoperations, archive operations,hierarchical storage managementoperations, and scheduled operations.This file is also called the dsm.opt file.For AIX, UNIX, or Linux systems, see alsoclient system-options file.closed registrationA registration process in which only anadministrator can register workstations asclient nodes with the server. Contrastwith open registration.collocationThe process of keeping all data belongingto a single-client file space, a single clientnode, or a group of client nodes on aminimal number of sequential-accessvolumes within a storage pool.Collocation can reduce the number ofvolumes that must be accessed when alarge amount of data must be restored.collocation groupA user-defined group of client nodeswhose data is stored on a minimalnumber of volumes through the processof collocation.commit pointA point in time when data is consideredconsistent.688 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Common Programming Interface forCommunications (CPI-C)A call-level interface that provides aconsistent application programminginterface (API) for applications that useprogram-to-program communications.CPI-C uses LU 6.2 architecture to create aset of interprogram services that canestablish and end a conversation, sendand receive data, exchange controlinformation, and notify a partner programof errors.communication methodThe method by which a client and serverexchange information. See alsoTransmission Control Protocol/InternetProtocol.communication protocolA set of defined interfaces that permitcomputers to communicate with eachother.compressionA function that removes repetitivecharacters, spaces, or strings of charactersfrom the data being processed andreplaces the repetitive characters withcontrol characters. Compression reducesthe amount of storage space that isrequired for the data.configuration managerA server that distributes configurationinformation, such as policies andschedules, to managed servers accordingto their profiles. Configurationinformation can include policy andschedules. See also managed server andprofile.conversationA connection between two programs overa session that allows them tocommunicate with each other whileprocessing a transaction.copy backupA full backup in which the transaction logfiles are not deleted so that backupprocedures that use incremental ordifferential backups are not disruptedcopy groupA policy object containing attributes thatcontrol how backup versions or archivecopies are generated, where backupversions or archive copies are initiallylocated, and when backup versions orarchive copies expire. A copy groupbelongs to a management class. See alsoarchive copy group, backup copy group,backup version, and management class.copy storage poolA named set of volumes that containcopies of files that reside in primarystorage pools. Copy storage pools areused only to back up the data that isstored in primary storage pools. A copystorage pool cannot be a destination for abackup copy group, an archive copygroup, or a management class (forspace-managed files). See also primarystorage pool and destination.CPI-C See Common Programming Interface forCommunications.DdaemonA program that runs unattended toperform continuous or periodic functions,such as network control.damaged fileA physical file in which Tivoli StorageManager has detected read errors.data access control modeA mode that controls whether a commandcan access a migrated file, see a migratedfile as zero-length, or receive aninput/output error if it attempts to accessa migrated file. See also execution mode.database backup seriesOne full backup of the database, plus upto 32 incremental backups made sincethat full backup. Each full backup that isrun starts a new database backup series.A number identifies each backup series.database snapshotA complete backup of the entire databaseto media that can be taken off-site. Whena database snapshot is created, the currentdatabase backup series is not interrupted.A database snapshot cannot haveincremental database backups associatedwith it. See also database backup series.Contrast with full backup.data centerIn a virtualized environment, a containerthat holds hosts, clusters, networks, anddata stores.Glossary 689

data deduplicationA method of reducing storage needs byeliminating redundant data. Only oneinstance of the data is retained on storagemedia. Other instances of the same dataare replaced with a pointer to the retainedinstance.data manager serverA server that collects metadatainformation for client inventory andmanages transactions for the storageagent over the local area network. Thedata manager server informs the storageagent with applicable library attributesand the target volume identifier.data moverA device that moves data on behalf of theserver. A network-attached storage (NAS)file server is a data mover.data storage-management applicationprogramminginterface (DSMAPI)A set of functions and semantics that canmonitor events on files, and manage andmaintain the data in a file. In an HSMenvironment, a DSMAPI uses events tonotify data management applicationsabout operations on files, stores arbitraryattribute information with a file, supportsmanaged regions in a file, and usesDSMAPI access rights to control access toa file object.data storeIn a virtualized environment, the locationwhere virtual machine data is stored.deduplicationSee data deduplication.default management classA management class that is assigned to apolicy set. This class is used to governbacked up or archived files when a file isnot explicitly associated with a specificmanagement class through theinclude-exclude list.demand migrationThe process that is used to respond to anout-of-space condition on a file system forwhich hierarchical storage management(HSM) is active. Files are migrated toserver storage until space usage drops tothe low threshold that was set for the filesystem. If the high threshold and lowthreshold are the same, one file ismigrated.desktop clientThe group of backup-archive clients thatincludes clients on Microsoft Windows,Apple, and Novell NetWare operatingsystems.destinationA copy group or management classattribute that specifies the primary storagepool to which a client file will be backedup, archived, or migrated.device classA named set of characteristics that areapplied to a group of storage devices.Each device class has a unique name andrepresents a device type of disk, file,optical disk, or tape.device configuration file(1) For a server, a file that containsinformation about defined device classes,and, on some servers, defined librariesand drives. The information is a copy ofthe device configuration information inthe database.(2) For a storage agent, a file that containsthe name and password of the storageagent, and information about the serverthat is managing the SAN-attachedlibraries and drives that the storage agentuses.device driverA program that provides an interfacebetween a specific device and theapplication program that uses the device.disaster recovery manager (DRM)A function that assists in preparing andusing a disaster recovery plan file for theserver.disaster recovery planA file that is created by the disasterrecovery manager (DRM) that containsinformation about how to recovercomputer systems if a disaster occurs andscripts that can be run to perform somerecovery tasks. The file includesinformation about the software andhardware that is used by the server, andthe location of recovery media.690 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

domainA grouping of client nodes with one ormore policy sets, which manage data orstorage resources for the client nodes. Seepolicy domain or client domain.DRM See disaster recovery manager.DSMAPISee data storage-managementapplication-programming interface.dynamic serializationA type of copy serialization in which afile or folder is backed up or archived onthe first attempt regardless of whether itchanges during a backup or archive.EEA See extended attribute.EB See exabyte.EFS See Encrypted File System.Encrypted File System (EFS)A file system that uses file system-levelencryption.enterprise configurationA method of setting up servers so that theadministrator can distribute theconfiguration of one of the servers to theother servers, using server-to-servercommunication. See also configurationmanager, managed server, profile, andsubscription.enterprise loggingThe process of sending events from aTivoli Storage Manager server to adesignated event server. The event serverroutes the events to designated receivers,such as to a user exit. See also event.error logA data set or file that is used to recorderror information about a product orsystem.estimated capacityThe available space, in megabytes, of astorage pool.event(1) An administrative command or aclient operation that is scheduled to berun using Tivoli Storage Managerscheduling.(2) A message that an Tivoli StorageManager server or client issues. Messagescan be logged using Tivoli StorageManager event logging.event recordA database record that describes actualstatus and results for events.event serverA server to which other servers can sendevents for logging. The event serverroutes the events to any receivers that areenabled for the sending server's events.exabyte (EB)For processor storage, real and virtualstorage, and channel volume, 1 152 921504 606 846 976 bytes. For disk storagecapacity and communications volume, 1000 000 000 000 000 000 bytes.excludeThe process of identifying files in aninclude-exclude list. This process preventsthe files from being backed up ormigrated whenever a user or scheduleenters an incremental or selective backupoperation. A file can be excluded frombackup and space management, backuponly, or space management only.exclude-include listSee include-exclude list.execution modeA mode that controls thespace-management related behavior ofcommands that run under the dsmmodecommand.expirationThe process by which files, data sets, orobjects are identified for deletion becausetheir expiration date or retention periodhas passed.expiring fileA migrated or premigrated file that hasbeen marked for expiration and removalfrom storage. If a stub file or an originalcopy of a premigrated file is deleted froma local file system, or if the original copyof a premigrated file is updated, thecorresponding migrated or premigratedfile is marked for expiration the next timereconciliation is run.extendTo increase the portion of available spacethat can be used to store database orrecovery log information.Glossary 691

extended attribute (EA)Names or value pairs that are associatedwith files or directories. There are threeclasses of extended attributes: userattributes, system attributes, and trustedattributes.extent The part of a file that is created duringthe data-deduplication process. Extentsare compared with other file extents toidentify duplicates.external libraryA type of library that is provided byTivoli Storage Manager that permitsLAN-free data movement for StorageTeklibraries that are managed by AutomatedCartridge System Library Software(ACSLS). To activate this function, theTivoli Storage Manager library type mustbe EXTERNAL.Ffile access timeOn AIX, UNIX, or Linux systems, thetime when the file was last accessed.file ageFor migration prioritization purposes, thenumber of days since a file was lastaccessed.file device typeA device type that specifies the use ofsequential access files on disk storage asvolumes.file serverA dedicated computer and its peripheralstorage devices that are connected to alocal area network that stores programsand files that are shared by users on thenetwork.file spaceA logical space in server storage thatcontains a group of files that have beenbacked up or archived by a client node,from a single logical partition, file system,or virtual mount point. Client nodes canrestore, retrieve, or delete their file spacesfrom server storage. In server storage,files belonging to a single file space arenot necessarily stored together.file space ID (FSID)A unique numeric identifier that theserver assigns to a file space when it isstored in server storage.file stateThe space management mode of a filethat resides in a file system to whichspace management has been added. A filecan be in one of three states: resident,premigrated, or migrated. See also residentfile, premigrated file, and migrated file.file system migrator (FSM)A kernel extension that intercepts all filesystem operations and provides any spacemanagement support that is required. Ifno space management support isrequired, the operation is passed to theoperating system, which performs itsnormal functions. The file systemmigrator is mounted over a file systemwhen space management is added to thefile system.file system stateThe storage management mode of a filesystem that resides on a workstation onwhich the hierarchical storagemanagement (HSM) client is installed. Afile system can be in one of these states:native, active, inactive, or global inactive.frequencyA copy group attribute that specifies theminimum interval, in days, betweenincremental backups.FSID See file space ID.FSM See file system migrator.full backupThe process of backing up the entireserver database. A full backup begins anew database backup series. See alsodatabase backup series and incrementalbackup. Contrast with database snapshot.fuzzy backupA backup version of a file that might notaccurately reflect what is currently in thefile because the file was backed up at thesame time as it was being modified.fuzzy copyA backup version or archive copy of a filethat might not accurately reflect theoriginal contents of the file because it wasbacked up or archived the file while thefile was being modified. See also backupversion and archive copy.G692 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

General Parallel File SystemA high-performance shared-disk filesystem that can provide data access fromnodes in a cluster environment.gigabyte (GB)In decimal notation, 1 073 741 824 whenreferring to memory capacity; in all othercases, it is defined as 1 000 000 000.global inactive stateThe state of all file systems to whichspace management has been added whenspace management is globally deactivatedfor a client node. When spacemanagement is globally deactivated,hierarchical storage management (HSM)cannot perform migration, recall, orreconciliation. However, a root user canupdate space management settings andadd space management to additional filesystems. Users can access resident andpremigrated files.Globally Unique Identifier (GUID)An algorithmically determined numberthat uniquely identifies an entity within asystem.GPFS See General Parallel File System.GPFS node setA mounted, defined group of GPFS filesystems.group backupThe backup of a group containing a list offiles from one or more file space origins.GUID See Globally Unique Identifier.Hhierarchical storage management (HSM)A function that automatically distributesand manages data on disk, tape, or bothby regarding devices of these types andpotentially others as levels in a storagehierarchy that range from fast, expensivedevices to slower, cheaper, and possiblyremovable devices. The objectives are tominimize access time to data andmaximize available media capacity.hierarchical storage management (HSM) clientA client program that works with theTivoli Storage Manager server to providehierarchical storage management (HSM)for a system. See also hierarchical storagemanagement and space manager client.HSM See hierarchical storage management.HSM clientSee hierarchical storage management client.IILM See information lifecycle management.image A file system or raw logical volume thatis backed up as a single object.image backupA backup of a full file system or rawlogical volume as a single object.inactive file systemA file system for which spacemanagement has been deactivated.Contrast with active file system.inactive versionA backup version of a file that is eithernot the most recent backup version, orthat is a backup version of a file that nolonger exists on the client system. Inactivebackup versions are eligible for expirationprocessing according to the managementclass assigned to the file. Contrast withactive version.include-exclude fileA file containing statements to determinethe files to back up and the associatedmanagement classes to use for backup orarchive. See also include-exclude list.include-exclude listA list of options that include or excludeselected files for backup. An excludeoption identifies files that should not bebacked up. An include option identifiesfiles that are exempt from the exclusionrules or assigns a management class to afile or a group of files for backup orarchive services.incremental backup(1) A copy of all database data that haschanged since the most recent successfulfull backup operation. An incrementalbackup is also known as a cumulativebackup image because each incrementalbackup includes the contents of theprevious incremental backup.(2) The process of backing up informationin the database that is new or changedsince the last full backup. Contrast withfull backup. See also database backup series.Glossary 693

(3) For Data Protection for MicrosoftExchange Server, a backup in which thetransaction logs are backed up and thencleared.individual mailbox restoreSee mailbox restore.information lifecycle management (ILM)GPFS policy-based file management forstorage pools and file sets.inode The internal structure that describes theindividual files on AIX, UNIX, or Linuxsystems. An inode contains the node,type, owner, and location of a file.inode numberA number specifying a particular inodefile in the file system.IP addressA unique address for a device or logicalunit on a network that uses the IPstandard.Jjob fileA generated file that containsconfiguration information for a migrationjob. The file is XML format and can becreated and edited in the hierarchicalstorage management (HSM) client forWindows client graphical user interface.journal-based backupA method for backing up Windows clientsand AIX clients that exploits the changenotification mechanism in a file toimprove incremental backup performanceby reducing the need to fully scan the filesystem.journal daemonOn AIX, UNIX, or Linux systems, aprogram that tracks change activity forfiles residing in file systems.journal serviceIn Microsoft Windows, a program thattracks change activity for files residing infile systems.Kkilobyte (KB)For processor storage, real and virtualstorage, and channel volume, 210 or 1 024bytes. For disk storage capacity andcommunications volume, 1 000 bytes.LLAN See local area network.LAN-free data movementThe movement of client data between aclient system and a storage device on astorage area network (SAN), bypassingthe local area network. This process isalso referred to as LAN-free data transfer.LAN-free data transferSee LAN-free data movement.leader dataBytes of data, from the beginning of amigrated file, that are stored in the file'scorresponding stub file on the local filesystem. The amount of leader data that isstored in a stub file depends on the stubsize that is specified.library(1) A repository for demountable recordedmedia, such as magnetic disks andmagnetic tapes.(2) A collection of one or more drives, andpossibly robotic devices (depending onthe library type), which can be used toaccess storage volumes.library clientA server that uses server-to-servercommunication to access a library that ismanaged by another storage managementserver. See also library manager.library managerA server that controls device operationswhen multiple storage managementservers share a storage device. See alsolibrary client.local (1) Pertaining to a device, file, or systemthat is accessed directly from a usersystem, without the use of acommunication line.(2) For HSM products, pertaining to thedestination of migrated files that arebeing moved.local area network (LAN)A network that connects several devicesin a limited area (such as a singlebuilding or campus) and that can beconnected to a larger network.local shadow volumesData that is stored on shadow volumeslocalized to a disk storage subsystem.694 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

LOFS See loopback virtual file system.logical fileA file that is stored in one or more serverstorage pools, either by itself or as part ofan aggregate. See also aggregate andphysical file.logical occupancyThe space that is used by logical files in astorage pool. This space does not includethe unused space created when logicalfiles are deleted from aggregate files, so itmight be less than the physicaloccupancy.logical unit (LU)An access point through which a user orapplication program accesses the SystemsNetwork Architecture (SNA) network tocommunicate with another user orapplication program.logical unit number (LUN)In the Small Computer System Interface(SCSI) standard, a unique identifier that isused to differentiate devices, each ofwhich is a logical unit (LU).logical volumeA portion of a physical volume thatcontains a file system.logical volume backupA backup of a file system or logicalvolume as a single object.loopback virtual file system (LOFS)A file system that is created by mountinga directory over another local directory,also known as mount-over-mount. ALOFS can also be generated using anautomounter.LU See logical unit.LUN See logical unit number.Mmacro fileA file that contains one or more storagemanager administrative commands,which can be run only from anadministrative client using the MACROcommand. Contrast with Tivoli StorageManager command script.mailbox restoreA function that restores MicrosoftExchange Server data (from IBM DataProtection for Microsoft Exchangebackups) at the mailbox level ormailbox-item level.managed objectIn Tivoli Storage Manager, a definition inthe database of a managed server thatwas distributed to the managed server bya configuration manager. When amanaged server subscribes to a profile, allobjects that are associated with thatprofile become managed objects in thedatabase of the managed server. Ingeneral, a managed object cannot bemodified locally on the managed server.Objects can include policy, schedules,client option sets, server scripts,administrator registrations, serverdefinitions, and server group definitions.managed serverA Tivoli Storage Manager server thatreceives configuration information from aconfiguration manager using asubscription to one or more profiles.Configuration information can includedefinitions of objects such as policy andschedules. See also configuration manager,subscription, and profile.management classA policy object that users can bind to eachfile to specify how the server manages thefile. The management class can contain abackup copy group, an archive copygroup, and space management attributes.See also copy group, space manager client,bind, and rebind.maximum transmission unitThe largest possible unit of data that canbe sent on a given physical medium in asingle frame. For example, the maximumtransmission unit for Ethernet is 1500bytes.MB See megabyte.media serverIn a z/OS ® environment, a program thatprovides access to z/OS disk and tapestorage for Tivoli Storage Manager serversthat run on operating systems other thanz/OS.megabyte (MB)(1) 1 048 576 bytes (2 to the 20th power)when used in this publication.Glossary 695

(2) For processor storage, real and virtualstorage, and channel volume, 2 to thepower of 20 or 1 048 576 bits. For diskstorage capacity and communicationsvolume, 1 000 000 bits.metadataData that describes the characteristics ofdata; descriptive data.migrateTo move data from one storage location toanother. In Tivoli Storage Managerproducts, migrating can mean movingdata from a client node to server storage,or moving data from one storage pool tothe next storage pool defined in theserver storage hierarchy. In both cases themovement is controlled by policy, such asthresholds that are set. See also migrationthreshold.migrated fileA file that has been copied from a localfile system to Tivoli Storage Managerstorage. For HSM clients on UNIX orLinux systems, the file is replaced with astub file on the local file system. OnWindows systems, creation of the stub fileis optional. See also stub file and residentfile. For HSM clients on UNIX or Linuxsystems, contrast with premigrated file.migrate-on-close recall modeA mode that causes a migrated file to berecalled back to its originating file systemtemporarily. Contrast with normal recallmode and read-without-recall recall mode.migration jobA specification of files to migrate, andactions to perform on the original filesafter migration. See also job file.migration thresholdHigh and low capacities for storage poolsor file systems, expressed as percentages,at which migration is set to start andstop.mirroringThe process of writing the same data tomultiple locations at the same time.Mirroring data protects against data losswithin the recovery log.modeA copy group attribute that specifieswhether to back up a file that has notbeen modified since the last time the filewas backed up. See modified mode andabsolute mode.modified modeIn storage management, a backupcopy-group mode that specifies that a fileis considered for incremental backup onlyif it has changed since the last backup. Afile is considered a changed file if thedate, size, owner, or permissions of thefile have changed. See also absolute mode.mount limitThe maximum number of volumes thatcan be simultaneously accessed from thesame device class. The mount limitdetermines the maximum number ofmount points. See also mount point.mount pointOn the Tivoli Storage Manager server, alogical drive through which volumes in asequential access device class areaccessed. For removable-media devicetypes, such as tape, a mount point is alogical drive that is associated with aphysical drive. For the file device type, amount point is a logical drive that isassociated with an I/O stream. Thenumber of mount points for a device classis defined by the value of the mount limitattribute for that device class. See alsomount limit.mount retention periodThe maximum number of minutes thatthe server retains a mountedsequential-access media volume that isnot being used before it dismounts thesequential-access media volume.mount wait periodThe maximum number of minutes thatthe server waits for a sequential-accessvolume mount request to be satisfiedbefore canceling the request.MTU See maximum transmission unit.NNagle algorithmAn algorithm that reduces congestion ofTCP/IP networks by combining smallerpackets and sending them together.named pipeA type of interprocess communication696 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

that permits message data streams to passbetween peer processes, such as betweena client and a server.NAS See network-attached storage.NAS nodeA client node that is a network-attachedstorage (NAS) file server. Data for theNAS node is transferred by a NAS fileserver that is controlled by the networkdata management protocol (NDMP). ANAS node is also called a NAS file servernode.native file systemA file system that is locally added to thefile server and is not added for spacemanagement. The hierarchical storagemanager (HSM) client does not providespace management services to the filesystem.native formatA format of data that is written to astorage pool directly by the Tivoli StorageManager server. Contrast with non-nativedata format.NDMPSee Network Data Management Protocol.NetBIOSSee Network Basic Input/Output System.network-attached storage (NAS) file serverA dedicated storage device with anoperating system that is optimized forfile-serving functions. A NAS file servercan have the characteristics of both anode and a data mover.Network Basic Input/Output System (NetBIOS)A standard interface to networks andpersonal computers that is used on localarea networks to provide message,print-server, and file-server functions.Application programs that use NetBIOSdo not have to handle the details of LANdata link control (DLC) protocols.Network Data Management Protocol (NDMP)A protocol that allows a networkstorage-management application tocontrol the backup and recovery of anNDMP-compliant file server, withoutinstalling vendor-acquired software onthat file server.network data-transfer rateA rate that is calculated by dividing thetotal number of bytes that are transferredby the data transfer time. For example,this rate can be the time that is spenttransferring data over a network.node A file server or workstation on which thebackup-archive client program has beeninstalled, and which has been registeredto the server.node nameA unique name that is used to identify aworkstation, file server, or PC to theserver.node privilege classA privilege class that gives anadministrator the authority to remotelyaccess backup-archive clients for a specificclient node or for all clients in a policydomain. See also privilege class.non-native data formatA format of data that is written to astorage pool that differs from the formatthat the server uses for operations.normal recall modeA mode that causes a migrated file to becopied back to its originating file systemwhen it is accessed.Ooffline volume backupA backup in which the volume is lockedso that no other system applications canaccess it during the backup operation.online volume backupA backup in which the volume isavailable to other system applicationsduring the backup operation.open registrationA registration process in which users canregister their workstations as client nodeswith the server. Contrast with closedregistration.operator privilege classA privilege class that gives anadministrator the authority to disable orhalt the server, enable the server, cancelserver processes, and manage removablemedia. See also privilege class.options fileA file that contains processing options. OnWindows and NetWare systems, the file isGlossary 697

called dsm.opt. On AIX, UNIX, Linux,and Mac OS X systems, the file is calleddsm.sys.originating file systemThe file system from which a file wasmigrated. When a file is recalled usingnormal or migrate-on-close recall mode, itis always returned to its originating filesystem.orphaned stub fileA file for which no migrated file can befound on the Tivoli Storage Managerserver that the client node is contactingfor space management services. Forexample, a stub file can be orphanedwhen the client system-options file ismodified to contact a server that isdifferent than the one to which the filewas migrated.out-of-space protection modeA mode that controls whether theprogram intercepts out-of-spaceconditions. See also execution mode.PpacingIn SNA, a technique by which thereceiving system controls the rate oftransmission of the sending system toprevent overrun.packet In data communication, a sequence ofbinary digits, including data and controlsignals, that is transmitted and switchedas a composite whole.page A defined unit of space on a storagemedium or within a database volume.partial-file recall modeA recall mode that causes the hierarchicalstorage management (HSM) function toread just a portion of a migrated file fromstorage, as requested by the applicationaccessing the file.password generationA process that creates and stores a newpassword in an encrypted password filewhen the old password expires.Automatic generation of a passwordprevents password prompting. Passwordgeneration can be set in the options file(passwordaccess option). See also optionsfile.path An object that defines a one-to-onerelationship between a source and adestination. Using the path, the sourceaccesses the destination. Data can flowfrom the source to the destination, andback. An example of a source is a datamover (such as a network-attachedstorage [NAS] file server), and anexample of a destination is a tape drive.pattern-matching characterSee wildcard character.physical fileA file that is stored in one or morestorage pools, consisting of either a singlelogical file, or a group of logical files thatare packaged together as an aggregate.See also aggregate and logical file.physical occupancyThe amount of space that is used byphysical files in a storage pool. This spaceincludes the unused space that is createdwhen logical files are deleted fromaggregates. See also physical file, logical file,and logical occupancy.plug-inA self-contained software component thatmodifies (adds, or changes) the functionin a particular system. When a plug-in isadded to a system, the foundation of theoriginal system remains intact.policy domainA grouping of policy users with one ormore policy sets, which manage data orstorage resources for the users. The usersare client nodes that are associated withthe policy domain.policy privilege classA privilege class that gives anadministrator the authority to managepolicy objects, register client nodes, andschedule client operations for clientnodes. Authority can be restricted tocertain policy domains. See also privilegeclass.policy setA group of rules in a policy domain. Therules specify how data or storageresources are automatically managed forclient nodes in the policy domain. Rulescan be contained in management classes.See also active policy set and managementclass.698 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

premigrated fileA file that has been copied to TivoliStorage Manager storage, but has notbeen replaced with a stub file on the localfile system. An identical copy of the fileresides both on the local file system andin Tivoli Storage Manager storage.Premigrated files occur on UNIX andLinux file systems to which spacemanagement has been added. Contrastwith migrated file and resident file.premigrated files databaseA database that contains informationabout each file that has been premigratedto Tivoli Storage Manager storage. Thedatabase is stored in a hidden directorynamed .SpaceMan in each file system towhich space management has beenadded.premigrationThe process of copying files that areeligible for migration to Tivoli StorageManager storage, but leaving the originalfile intact on the local file system.premigration percentageA space management setting that controlswhether the next eligible candidates in afile system are premigrated followingthreshold or demand migration.primary storage poolA named set of volumes that the serveruses to store backup versions of files,archive copies of files, and files migratedfrom client nodes. See also destination andcopy storage pool.privilege classA level of authority that is granted to anadministrator. The privilege classdetermines which administrative tasks theadministrator can perform. See also nodeprivilege class, operator privilege class, policyprivilege class, storage privilege class, andsystem privilege class.profileA named group of configurationinformation that can be distributed from aconfiguration manager when a managedserver subscribes. Configurationinformation can include registeredadministrator IDs, policies, clientschedules, client option sets,administrative schedules, storage managercommand scripts, server definitions, andQquotaserver group definitions. See alsoconfiguration manager and managed server.(1) For HSM on AIX, UNIX, or Linuxsystems, the limit (in megabytes) on theamount of data that can be migrated andpremigrated from a file system to serverstorage.(2) For HSM on Windows systems, auser-defined limit to the space that isoccupied by recalled files.RrandomizationThe process of distributing schedule starttimes for different clients within aspecified percentage of the schedule'sstartup window.raw logical volumeA portion of a physical volume that iscomprised of unallocated blocks and hasno journaled file system (JFS) definition.A logical volume is read/write accessibleonly through low-level I/O functions.read-without-recall recall modeA mode that causes hierarchical storagemanagement (HSM) to read a migratedfile from storage without storing it backon the local file system. The last piece ofinformation read from the file is stored ina buffer in memory on the local filesystem. Contrast with normal recall modeand migrate-on-close recall mode.rebindTo associate all backed-up versions of afile with a new management class name.For example, a file that has an activebackup version is rebound when a laterversion of the file is backed up with adifferent management class association.See also bind.recall In Tivoli Storage Manager, to copy amigrated file from server storage back toits originating file system using the spacemanagement client. See also transparentrecall, selective recall, and recall mode.recall modeA mode that is assigned to a migrated filewith the dsmattr command thatdetermines how the file is processedwhen it is recalled. It determines whetherthe file is stored on the local file system,Glossary 699

is migrated back to Tivoli StorageManager storage when it is closed, or isread from Tivoli Storage Manager storagewithout storing it on the local file system.receiverA server repository that contains a log ofserver and client messages as events. Forexample, a receiver can be a file exit, auser exit, or the Tivoli Storage Managerserver console and activity log. See alsoevent.reclamationThe process of consolidating theremaining data from manysequential-access volumes onto fewer,new sequential-access volumes.reclamation thresholdThe percentage of space that asequential-access media volume musthave before the server can reclaim thevolume. Space becomes reclaimable whenfiles are expired or are deleted.reconciliationThe process of synchronizing a file systemwith the Tivoli Storage Manager server,and then removing old and obsoleteobjects from the Tivoli Storage Managerserver.recovery logA log of updates that are about to bewritten to the database. The log can beused to recover from system and mediafailures. The recovery log consists of theactive log (including the log mirror) andarchive logs.registerTo define a client node or administratorID that can access the server.registryA repository that contains access andconfiguration information for users,systems, and software.remote(1) Pertaining to a system, program, ordevice that is accessed through acommunication line.(2) For HSM products, pertaining to theorigin of migrated files that are beingmoved.resident fileOn a Windows system, a complete file ona local file system that might also be amigrated file because a migrated copy canexist in Tivoli Storage Manager storage.On a UNIX or Linux system, a completefile on a local file system that has notbeen migrated or premigrated, or that hasbeen recalled from Tivoli Storage Managerstorage and modified. Contrast with stubfile and premigrated file. See migrated file.restoreTo copy information from its backuplocation to the active storage location foruse. For example, to copy informationfrom server storage to a clientworkstation.retentionThe amount of time, in days, that inactivebacked-up or archived files are kept in thestorage pool before they are deleted.Copy group attributes and defaultretention grace periods for the domaindefine retention.retrieveTo copy archived information from thestorage pool to the workstation for use.The retrieve operation does not affect thearchive version in the storage pool.roll backTo remove changes that were made todatabase files since the last commit point.root userA system user who operates withoutrestrictions. A root user has the specialrights and privileges needed to performadministrative tasks.SSAN See storage area network.scheduleA database record that describes clientoperations or administrative commands tobe processed. See administrative commandschedule and client schedule.scheduling modeThe type of scheduling operation for theserver and client node that supports twoscheduling modes: client-polling andserver-prompted.scratch volumeA labeled volume that is either blank orcontains no valid data, that is not defined,and that is available for use.700 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

script A series of commands, combined in a file,that carry out a particular function whenthe file is run. Scripts are interpreted asthey are run. Contrast with Tivoli StorageManager command script.Secure Sockets Layer (SSL)A security protocol that providescommunication privacy. With SSL,client/server applications cancommunicate in a way that is designed toprevent eavesdropping, tampering, andmessage forgery.selective backupThe process of backing up certain files ordirectories from a client domain. The filesthat are backed up are those that are notexcluded in the include-exclude list. Thefiles must meet the requirement forserialization in the backup copy group ofthe management class that is assigned toeach file. Contrast with incremental backup.selective migrationThe process of copying user-selected filesfrom a local file system to Tivoli StorageManager storage and replacing the fileswith stub files on the local file system.Contrast with threshold migration anddemand migration.selective recallThe process of copying user-selected filesfrom Tivoli Storage Manager storage to alocal file system. Contrast with transparentrecall.serializationThe process of handling files that aremodified during backup or archiveprocessing. See dynamic serialization, staticserialization, shared static serialization, andshared dynamic serialization.server A software program or a computer thatprovides services to other softwareprograms or other computers.server options fileA file that contains settings that controlvarious server operations. These settingsaffect such things as communications,devices, and performance.server-prompted scheduling modeA client/server communication techniquewhere the server contacts the client nodewhen tasks must be done. Contrast withclient-polling scheduling mode.server storageThe primary, copy, and active-data storagepools that are used by the server to storeuser files such as backup versions, archivecopies, and files migrated from spacemanager client nodes (space-managedfiles). See also active-data pool, primarystorage pool, copy storage pool, storage poolvolume, and volume.sessionA logical or virtual connection betweentwo stations, software programs, ordevices on a network that allows the twoelements to communicate and exchangedata.session resource usageThe amount of wait time, processor time,and space that is used or retrieved duringa client session.shared dynamic serializationA value for serialization that specifies thata file must not be backed up or archivedif it is being modified during theoperation. Tivoli Storage Manager retriesthe backup or archive operation a numberof times; if the file is being modifiedduring each attempt, Tivoli StorageManager will back up or archive the fileon its last try. See also serialization.Contrast with dynamic serialization, sharedstatic serialization, and static serialization.shared libraryA library device that is used by multiplestorage manager servers.shared static serializationA copy-group serialization value thatspecifies that a file must not be modifiedduring a backup or archive operation.Tivoli Storage Manager attempts to retrythe operation a number of times. If thefile is in use during each attempt, the fileis not backed up or archived. See alsoserialization. Contrast with dynamicserialization, shared dynamic serialization,and static serialization.snapshotAn image backup type that consists of apoint-in-time view of a volume.space-managed fileA file that is migrated from a client nodeGlossary 701

y the space manager client. The spacemanager client recalls the file to the clientnode on demand.space managementThe process of keeping sufficient freestorage space available on a local filesystem for new data by migrating files toserver storage. Synonymous withhierarchical storage management.space manager clientA program that runs on a UNIX or Linuxsystem to manage free space on the localfile system by migrating files to serverstorage. The program can recall the fileseither automatically or selectively. Alsocalled hierarchical storage management(HSM) client.space monitor daemonA daemon that checks space usage on allfile systems for which space managementis active, and automatically startsthreshold migration when space usage ona file system equals or exceeds its highthreshold.sparse fileA file that is created with a length greaterthan the data it contains, leaving emptyspaces for the future addition of data.special fileOn AIX, UNIX, or Linux systems, a filethat defines devices for the system, ortemporary files that are created byprocesses. There are three basic types ofspecial files: first-in, first-out (FIFO);block; and character.SSL See Secure Sockets Layer.stabilized file spaceA file space that exists on the server butnot on the client.stanza A group of lines in a file that togetherhave a common function or define a partof the system. Each stanza is identified bya name that occurs in the first line of thestanza. Depending on the type of file, astanza is ended by the next occurrence ofa stanza name in the file, or by an explicitend-of-stanza marker. A stanza can alsobe ended by the end of the file.startup windowA time period during which a schedulemust be initiated.static serializationA copy-group serialization value thatspecifies that a file must not be modifiedduring a backup or archive operation. Ifthe file is in use during the first attempt,the storage manager cannot back up orarchive the file. See also serialization.Contrast with dynamic serialization, shareddynamic serialization, and shared staticserialization.storage agentA program that enables the backup andrestoration of client data directly to andfrom storage attached to a storage areanetwork (SAN).storage area network (SAN)A dedicated storage network that istailored to a specific environment,combining servers, systems, storageproducts, networking products, software,and services.storage hierarchy(1) A logical order of primary storagepools, as defined by an administrator. Theorder is typically based on the speed andcapacity of the devices that the storagepools use. The storage hierarchy isdefined by identifying the next storagepool in a storage pool definition. See alsostorage pool.(2) An arrangement of storage deviceswith different speeds and capacities. Thelevels of the storage hierarchy include:main storage, such as memory anddirect-access storage device (DASD)cache; primary storage (DASD containinguser-accessible data); migration level 1(DASD containing data in a space-savingformat); and migration level 2 (tapecartridges containing data in aspace-saving format).storage poolA named set of storage volumes that arethe destination that is used to store clientdata. A storage pool contains backupversions, archive copies, and files that aremigrated from space manager clientnodes. A primary storage pool is backedup to a copy storage pool. See alsoprimary storage pool, copy storage pool, andactive-data pool.storage pool volumeA volume that has been assigned to a702 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

storage pool. See also volume, active-datapool, copy storage pool, and primary storagepool.storage privilege classA privilege class that gives anadministrator the authority to control howstorage resources for the server areallocated and used, such as monitoringthe database, the recovery log, and serverstorage. See also privilege class.stub A shortcut on the Windows file systemthat is generated by the hierarchicalstorage management (HSM) client for amigrated file that allows transparent useraccess. A stub is the sparse filerepresentation of a migrated file, with areparse point attached.stub fileA file that replaces the original file on alocal file system when the file is migratedto storage. A stub file contains theinformation that is necessary to recall amigrated file from Tivoli Storage Managerstorage. It also contains additionalinformation that can be used to eliminatethe need to recall a migrated file.stub file sizeThe size of a file that replaces the originalfile on a local file system when the file ismigrated to Tivoli Storage Managerstorage. The size that is specified for stubfiles determines how much leader datacan be stored in the stub file. The defaultfor stub file size is the block size definedfor a file system minus 1 byte.subscriptionIn a Tivoli environment, the process ofidentifying the subscribers that theprofiles are distributed to. For TivoliStorage Manager, a subscription is theprocess by which a managed serverreceives configuration informationassociated with a particular profile on aconfiguration manager. See also managedserver, configuration manager, and profile.system privilege classA privilege class that gives anadministrator the authority to issue allserver commands. See also privilege class.Systems Network Architecture (SNA)The description of the logical structure,formats, protocols, and operationalsequences for transmitting informationthrough and controlling the configurationand operation of networks.Ttape libraryA set of equipment and facilities thatsupport an installation's tapeenvironment. The tape library can includetape storage racks, mechanisms forautomatic tape mounting, a set of tapedrives, and a set of related tape volumesmounted on those drives.tape volume prefixThe high-level-qualifier of the file nameor the data set name in the standard tapelabel.target nodeA client node for which other client nodes(called agent nodes) have been grantedproxy authority. The proxy authorityallows the agent nodes to performoperations such as backup and restore onbehalf of the target node, which owns thedata.TCA See trusted communications agent.TCP/IPSee Transmission Control Protocol/InternetProtocol.threshold migrationThe process of moving files from a localfile system to Tivoli Storage Managerstorage based on the high and lowthresholds that are defined for the filesystem. Contrast with demand migration,selective migration, and migration job.throughputIn storage management, the total bytes inthe workload, excluding overhead, thatare backed up or restored, divided byelapsed time.timeoutA time interval that is allotted for anevent to occur or complete beforeoperation is interrupted.timestamp control modeA mode that determines whethercommands preserve the access time for afile or set it to the current time.Tivoli Storage Manager command scriptA sequence of Tivoli Storage ManagerGlossary 703

administrative commands that are storedin the database of the Tivoli StorageManager server. The script can run fromany interface to the server. The script caninclude substitution for commandparameters and conditional logic.tombstone objectA small subset of attributes of a deletedobject. The tombstone object is retainedfor a specified period, and at the end ofthe specified period, the tombstone objectis permanently deleted.Transmission Control Protocol/Internet Protocol(TCP/IP)An industry-standard, nonproprietary setof communication protocols that providesreliable end-to-end connections betweenapplications over interconnected networksof different types.transparent recallThe process that is used to automaticallyrecall a file to a workstation or file serverwhen the file is accessed. See also recallmode. Contrast with selective recall.trusted communications agent (TCA)A program that handles the sign-onpassword protocol when clients usepassword generation.UUCS-2 A 2-byte (16-bit) encoding scheme basedon ISO/IEC specification 10646-1. UCS-2defines three levels of implementation:Level 1-No combining of encodedelements allowed; Level 2-Combining ofencoded elements is allowed only forThai, Indic, Hebrew, and Arabic; Level3-Any combination of encoded elementsare allowed.UNC See Universal Naming Convention name.UnicodeA character encoding standard thatsupports the interchange, processing, anddisplay of text that is written in thecommon languages around the world,plus some classical and historical texts.The Unicode standard has a 16-bitcharacter set defined by ISO 10646.Unicode-enabled file spaceUnicode file space names provide supportfor multilingual workstations withoutregard for the current locale.Unicode transformation format 8Unicode Transformation Format (UTF),8-bit encoding form, which is designedfor ease of use with existing ASCII-basedsystems. The CCSID value for data inUTF-8 format is 1208.Universal Naming Convention (UNC) nameThe server name and network namecombined. These names together identifythe resource on the domain.Universally Unique Identifier (UUID)The 128-bit numeric identifier that is usedto ensure that two components do nothave the same identifier.UTF-8 See Unicode transformation format 8.UUID See Universally Unique Identifier.VvalidateTo check a policy set for conditions thatcan cause problems if that policy setbecomes the active policy set. Forexample, the validation process checkswhether the policy set contains a defaultmanagement class.versionA backup copy of a file stored in serverstorage. The most recent backup copy of afile is the active version. Earlier copies ofthe same file are inactive versions. Thenumber of versions retained by the serveris determined by the copy groupattributes in the management class.virtual file spaceA representation of a directory on anetwork-attached storage (NAS) filesystem as a path to that directory.virtual volumeAn archive file on a target server thatrepresents a sequential media volume to asource server.volumeA discrete unit of storage on disk, tape orother data recording medium thatsupports some form of identifier andparameter list, such as a volume label orinput/output control. See also scratchvolume, and storage pool volume.volume history fileA file that contains information aboutvolumes that have been used by the704 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

server for database backups and forexport of administrator, node, policy, orserver data. The file also has informationabout sequential-access storage poolvolumes that have been added, reused, ordeleted. The information is a copy ofvolume information that is recorded inthe server database.Volume Shadow Copy ServiceA set of Microsoft applicationprogramminginterfaces (APIs) that youcan use to create shadow copy backups ofvolumes, exact copies of files, includingall open files, and so on.VSS See Volume Shadow Copy Service.VSS BackupA backup operation that uses MicrosoftVolume Shadow Copy Service (VSS)technology. The backup operationproduces an online snapshot(point-in-time consistent copy) ofMicrosoft Exchange data. This copy canbe stored on local shadow volumes or onTivoli Storage Manager server storage.VSS Fast RestoreAn operation that restores data from alocal snapshot. The snapshot is the VSSbackup that resides on a local shadowvolume. The restore operation retrievesthe data by using a file-level copymethod.VSS Instant RestoreAn operation that restores data from alocal snapshot. The snapshot is the VSSbackup that resides on a local shadowvolume. The restore operation retrievesthe data by using a hardware-assistedrestore method (for example, a FlashCopyoperation).VSS offloaded backupA backup operation that uses a MicrosoftVolume Shadow Copy Service (VSS)hardware provider (installed on analternate system) to move IBM DataProtection for Microsoft Exchange data tothe Tivoli Storage Manager server. Thistype of backup operation shifts thebackup load from the production systemto another system.VSS RestoreA function that uses a Microsoft VolumeShadow Copy Service (VSS) softwareprovider to restore VSS Backups (IBMData Protection for Microsoft Exchangedatabase files and log files) that reside onTivoli Storage Manager server storage totheir original location.Wwildcard characterA special character such as an asterisk (*)or a question mark (?) that can be used torepresent one or more characters. Anycharacter or set of characters can replacethe wildcard character.workload partition (WPAR)A partition within a single operatingsystem instance.workstationA terminal or personal computer at whicha user can run applications and that isusually connected to a mainframe or anetwork.worldwide nameA 64-bit, unsigned name identifier that isunique.Glossary 705

706 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

IndexNumerics128-bit AES encryption support 118Aabsolute mode 244accessibility features 679active backup versionsdisplaying 100, 174, 596restoring 174Active Directoryquery for communication method andserver with which to connect 509active directory objectsmodifying CAD and agentservices 202restore restrictions andlimitations 200restoring 198, 200, 202restoring from system statebackup 198restoring using GUI and commandline 199adaptive subfile backup 491excluding files from 365including files for 395restore permissions 91specifying client cache path 492specifying client cache size 493adlocation option 295administrative clientallowing secure sessions within aprivate network 496archiveassign description to 213, 216, 331associating local snapshot with serverfile space 216, 480binding management class to 216,295case sensitive file name conflicts 308command 543compressing files 321configuring client-node proxysupport 216copy group attributes 241copy mode 244delete files after 331delete individual archives from serverfile space 218, 570deleting file spaces 205directory tree 214display the last modification date andlast access datecreation date 594files only 511grace period retention 240how managed 239improving speed using sharememory 269include files for 395information, query 594archive (continued)list of files 216, 380more than one file specification 216number of attempts to archive openfiles 310only files; not directories 216overriding management classduring 246packages 213primary tasks 213process directories only (notfiles) 337query user access 592retrievingusing command line 219shared data on multiple clients undera single node name 216, 296specifying whether to includesubdirectories for 216starting a web client session 97summary of options 270suppress confirmation prompt beforedeleting 428using commands 215archive copy group 240archive fastbackcommand 546archive maximum file size 119archmc option 295asnodename option 296ASRbackup system driveWindows Vista, 7, 2008 134dsm.optWindows Vista, 7, 2008 133preparationWindows Vista, 7, 2008 132restore procedureWindows Vista, 7, 2008, 2008R2 182WinPE CDWindows Vista, 7, 2008, 2008R2 182asrmode option 297, 532attributespreserving in tombstone objects 201auditlogging option 298auditlogname option 300authenticationTivoli Storage Manager client 92authorizationauthorizing user to restore or retrieveyour files 202options 284auto-update 3, 302autodeploy option 302autofsrename option 304Automated System Recovery (ASR)back up 132automating backup servicesdisplaying scheduled work 227, 229automating backup services (continued)options for 233process commands after backup 437process commands beforebackup 440starting client scheduler 35Bback up 130configuring support for client nodeproxy backups 127include-exclude list 117Microsoft Dfs trees and files 170network-attached storage (NAS) 558new or changed files 120NTFS file spaces 168number of attempts to back up openfiles 310parallel 525, 527removable media using drivelabel 168system services, assigningmanagement class 130VM templates 523Windows Vista system state 130with limited bandwidth 117backing upin parallel sessions 155Backing up cluster groups 59backing up data 148backing up virtual machines on aHyper-V system 159backing up volume mount pointsNTFS 585backmc option 306backup 109automating using Client ServiceConfiguration Utility 251case sensitive file name conflicts 308copy mode 244displaying processing status 163excluding domains 110excluding system servicescomponents 130excluding system services from 130excluding system state objectfrom 130file-level VMware 154grace period retention 240image 134client domain 343, 345, 348with incremental backup 557image, offline and online 134improving speed using sharememory 269incrementalassociating local snapshot withserver file space 587client command line 110command line 110© Copyright IBM Corp. 1993, 2012 707

ackup (continued)incremental-by-dateclient command line 110command line 110multi-session, send files contiguouslyto the server 316Net Appliance CIFS sharedefinitions 162one server session per filespecification 316overview 105primary tasks 105process directories only (notfiles) 337query user access 592selectiveassociating local snapshot withserver file space 661back up list of files 110client command line 110command line 110shared data on multiple clients undera single node name 296starting a web client session 97subdirectories 110summary of options 270system state, assigning managementclass 130backup and restoreNAS file servers using CIFS 144backup comparison: incremental,journal-based, incremental-by-date 124backup copy group 106, 240attributes 241backup fastback command 549backup filesassigning management class 245backup group command 551backup image command 554backup maximum file size 119backup nas command 558Backup NTFS data on mountedvolumes 585backup operators grouprequired user security rights forbackup and restore 89backup planning 105backup setenabling GUI for local restore 185restore 173, 185restore systemstate from 631, 636restoring in a SAN environment 635backup setsrestore considerations 188, 634backup systemstate command 560backup vm command 562backup with client node proxyagent node 127overview 127target node 127backup-archive clientoverview 1backup-archive scheduler serviceinstall 251backupsetenabling GUI for local restore of 413backupsetname option 306basesnapshotname option 307batch mode 538starting a session 94bottom-up processinginclude-exclude list 86bypass processing of NTFS securityinformation 472CC++ redistributable filesforced reboot 10cancel process command 568cancel restore command 568casesensitiveaware option 308central schedulingsummary of options 282Certificate Authoritiesroot certificates 41Certificate Authorities 41changingretries option 310class option 310classic (standard) restore 178client 3client TCP/IP address other than theone for first server contact 498client TCP/IP port number other thanthe one for first server contact 499registering with server 75setting password 75size for the TCP/IP sliding windowfor client node 502client acceptor daemonmanage scheduler, Web client, orboth 414client acceptor serviceconfiguring to manage scheduler 33client command optionsoverview 540client componentsWindows client 6client node proxy archiveoverview 216client node proxy backupscheduling 129client optionsdisplay current settings 611excludeexclude.archive 77exclude.backup 77exclude.compression 77exclude.dir 77exclude.file 77exclude.file.backup 77exclude.image 77exclude.subfile 77exclude.systemobject 77guitreeviewafterbackup 387order of processing (precedence) 286overriding using command line 286overview 540using with commands 286client options filecreating and modifying 27generating in shared directory 29required options for 27client options file (continued)specifying include-excludeoptions 76client options reference 294client schedulerdisplaying scheduled work 227, 229options for 233starting 35, 656starting automatically 98Client schedulerrun at startup 226Client Service Configuration Utilitycommands for installing clientservices 255configure CAD to manage existingscheduler service 253create new scheduler and associateCAD to manage scheduler 253options for installing clientservices 262using to automate backups 251client servicesconsiderations 89client user-optionscreating multiple files 29client user-options fileoverriding using commands 286client-node proxy support 127, 216client-server communicationclient TCP/IP address other than theone for first server contact 498client TCP/IP port number other thanthe one for first server contact 499establishing 27identify your workstation to theserver 426maximum disk I/O buffer size clientuses when reading or writingfiles 339method 317name of a named pipe 424query Active Directory forcommunication method and serverwith which to connect 509reconnection attempts afterfailure 318reconnection interval afterfailure 319size for the TCP/IP sliding windowfor client node 502size of internal TCP/IPcommunication buffer 497specifying number of kilobytes clientbuffers before sending transaction toserver 508TCP/IP address for dsmcad 498TCP/IP address of Tivoli StorageManager server 501TCP/IP port address of Tivoli StorageManager server 501TCP/IP port address on which toestablish shared memoryconnection 470whether to send small transactions toserver without buffering themfirst 500clientview option 311708 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

closed registrationpermissions 75using 75Cluster configuration wizard 59cluster drivesenabling management of 315Cluster groupsbacking up 59cluster resourcespermissions 91clusterdisksonly command 312clusternode option 315collocatebyfilespec option 316command lineassigning description to archive 216display current settings for clientoptions 611displayingEuro characters in prompt 95processing status 163enabling 8.3 short names 353ending a session 101entering commands 539general rules when entering optionswith commands 287NAS file systems backup 142overriding management class duringarchive 246overview of parameters 540performing image backup 140performing point-in-time restore 206restoring files and directories 175restrictions for NAS file systems 140return codes for operations 237specifying file specification 541specifying options file duringsession 430starting a session 94using wildcard characters 542command parametersoverview 540command processing, summary ofoptions 284command sessionending 538starting 538command-line promptdisplayingEuro characters 95commandsarchive 543archive fastback 546backup fastback 549backup group 551backup image 554backup nas 558backup systemstate 560backup vm 562batch mode 538cancel process 568cancel restore 568clusterdisksonly 312delete access 569delete archive 570delete backup 572delete filespace 574delete group 575commands (continued)entering 539entering on command line 539expire 577general rules when entering optionswith 287help 578incremental 579interactive (loop) mode 539loop 587macro 588maximum file specificationspermitted 541monitor process 589overview of parameters 540preview archive 589preview backup 590query access 592query adobjects 592query archive 594query backup 596query backupset 599, 601query filespace 603query group 605query image 606query inclexcl 608query mgmtclass 609query node 610query options 611query restore 612query schedule 613query session 613query systeminfo 614query systemstate 616query VM 617restart restore 621restore 622restore adobjects 629restore backupset 631, 636restore backupset considerations 188,634restore group 638restore image 640restore NAS 643restore systemstate 645restore vm 647retrieve 652schedule 656scheduled, enabling or disabling 234selective backup 658set access 661set event 664set password 666specifying file specification 541using 535using in executables 237using options with 286using wildcard characters 542commmethod option 317commrestartduration option 318commrestartinterval option 319communication methodsinstallable software 7Shared MemoryWindows client 7summary 268communication methods (continued)TCP/IPWindowss client 7communicationsestablishing through firewall 35establishing with Secure Sockets Layer(SSL) 38compressalways option 320compressiondisabling processing 400enabling processing 400include-exclude statements 400compression option 321compression processingexclude from backup 400exclude options 400include files for 395compression, encryption, and subfilebackup processingback up 400exclude from backup 400exclude options 400concurrent backups 155configure the client for datadeduplication 52configuringjournal engine service 42open file support 70optional tasks 27required tasks 27the client scheduler 33the Web client 31Configuring cluster protection 59console option 322, 323console windowdisplayingEuro characters 95containing quotation marks 96copy destination attribute 244copy frequency attribute 242copy group name attribute 241copy groups 240archive 240backup 240copy mode attributeabsolute 244modified 244copy serialization attribute 243copy type attribute 242Createnewbase 323customer supportcontact 675Ddata deduplication 49data deduplication clientconfiguration 52data deduplication filesexclude 54datacenter option 325datastore option 326date formatspecifying 326dateformat option 326dedupcachepath option 328dedupcachesize option 329Index 709

deduplication option 329default domainexcluding domains from backup 110,340default management class 239default policy domain 239definitions 685deletefile space 205NAS or client objects 310delete access command 569delete archive command 570delete backup command 572delete group command 575delete individual backups from server filespace 112deleted file systems 167deletefiles option 331deletingauthorizations 202individual archives from server filespace 218, 570individual backups from server filespace 572deleting file spaces 205description option 331detail option 332diagnosticsoptions 286diffsnapshot option 334diffsnapshotname option 335directoriesassigning management class for 336excluding 77excluding from backupprocessing 365incremental backup processingoverview 120processing duringincremental-by-date 124restoring from command line 175restoring from GUI 175specifying on command line 541directoryarchiving 214dirmc option 336dirsonly option 337disability 679disablenqr option 338discretionary access control list(permissions)back up 168disk space requirementsclient 6Windows client 6diskbuffsize option 339diskcachelocation option 339displayingarchive information 594online help 101restartable restore sessions 612scheduled events 613session information 613domainback up using the GUI 110include for image backup 343, 345,348domain (continued)include for incremental backup 340include for NAS image backup 344specifying drives in the default 110domain listusing universal naming convention tospecify 169domain option 340domain.image option 343, 345, 348domain.nas option 344drive labelusing to backup removablemedia 168DSM_CONFIG environment variable 30DSM_DIR environment variable 30DSM_LOG environment variable 30dsm.opt filecreating and modifying 27required options for 27specifying a drive specification usingwildcards 82dsm.smp filecopying to dsm.opt 27location 27dsmc commandusing options 96dsmcutil utilitycommands for installing clientservices 255options for installing clientservices 262overview 254dsmerlog.pru file 360dsmerror.log file 360dsmsched.log 459, 462dsmwebcl.log 459, 462duplicate file namesavoiding 173dynamic and shared serialization 243Eeducationsee Tivoli technical training 673enable8dot3namesupport option 353enablearchiveretentionprotectionoption 354enablededupcache option 355enablelanfree option 357encrypting data during archive 118encrypting data during backup 118encryptionmultiple clients under a single nodename 296of file data 118saving encryption key password 359encryption processingdetermine encryption cipher used incurrent session 118excluding files from 365include files for 395query systeminfo command 614encryptiontype option 358encryptkey optionencryptkey=generate 359encryptkey=promptencryptkey=save 359enhanced query schedule 227enhanced query schedule command 613environment prerequisites 6environment variables 30error logpruning 363specifying path and file name 362error processing, summary ofoptions 284errorlogmax option 360errorlogname option 362errorlogretention option 360, 363event loggingscheduler 229event-based policy retention protectionarchive 249backup 249excludeEXCLUDE.VMDISK 370exclude data deduplication files 54exclude options 365, 370exclude.archive 77exclude.backup 77exclude.compression 77exclude.dir 77exclude.file 77exclude.file.backup 77exclude.image 77exclude.subfile 77exclude.systemobject 77preview 85processing 86wildcard characters 82, 84exclude.image option 77EXCLUDE.VMDISK 370excluding filesremotely accessed 81system files 81using wildcard characters 84wildcard characters 82excluding system objects 130executable filereturn codes from 237expire command 577Ffbbranch option 372fbclient option 373fbpolicyname option 374fbreposlocation option 376fbserver option 377fbvolumename option 378featuresWindows client 8filerestoring active and inactiveversions 628file namesavoiding duplicate 173file spacedelete 205, 574determining fsID 332excluding 77NAS or client objects 310performing an image backup 554710 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

file specificationmaximum allowed oncommands 541file systemsdeleted 167excluding from backupprocessing 365GPFS, multinode clusterenvironment 340image backup of 134file-level VM backuprestore 194filelist option 380filename option 382filesarchivedirectory tree 214archive a list of 216, 380archived, overriding managementclass 246archiving 543archiving more than one filespecification 216assigning management classes 167backing up Microsoft Dfs 170backing up open 165binding management classes to 247compressing during archive orbackup 321definition of changed 120delete after archive 331delete individual archives from serverfile space 218, 570delete individual backups from serverfile space 572encryption 118excluding groups 82, 84include-excludecreating in Unicode format 395including groups 82, 84managing growth duringcompression 320maximum file size for operations 119processing include-exclude 86query archive information 594query backup information 596query user access 592renaming file spaces that are notUnicode to Unicode-enabled 304,579, 658reset Windows archive attribute afterbackup 451restoring files belonging to anothernode 204restoring from command line 175restoring from GUI 175restoring to another workstation 204retrievingarchives using command line 219files belonging to anothernode 204to another workstation 204sorting list of 100filesonly option 384firewallestablishing communicationsthrough 35, 388, 501firewall (continued)specifying TCP/IP ports for the Webclient 534using Web client through 534whether server or client initiatessessions through 468fixed drivesbacking up 168fixes, obtaining 675format and languagesummary of options 283fromdate option 384fromnode option 385fromtime option 386full backups, creating 151full incrementalcomparing with journal-based,incremental-by-date 124description 120when to use 124full VM backuprestore 193full VM backup 193fuzzy backup 243Ggetting startedchanging your password 89client scheduler 89command-line session 89displaying online help 89ending a session 89GUI session 89sorting file lists 89Web client session 89glossary 685GPFS file systemmultinode cluster environment 340graphical user interfacechanging password 99delete individual files or images fromserver file space 572displaying active and inactive backupversions 100, 174displaying online help 101displaying processing status 163enabling for local backupsetrestore 413enabling local backup set 185ending a session 101performing image backup 139restore files and directories 175starting a session 93to back up objects 109group backupdisplay active and inactiveobjects 393display all members of 470overview 126specify name of group 387specify virtual file space namefor 514specifying full or differential 420groupname option 387GUIending a session 101GUI (continued)overriding management class duringarchive 246performing point-in-time restore 206starting a session 93guitreeviewafterbackup option 387Hhardware requirementsWindows client 6helpdisplaying online 101Internet resources 101online forum 101service and technical support 101help command 578host option 388httpport option 388Hyper-Vbacking up 159backup limitations 161IIBM Publications Center xiiiIBM Support Assistant 674ieobjtype option 390ifnewer option 391imagerestoring 183using chkdsk to repair 183using chkdsk tool to repair 640using fsck to repair 183, 640image backupconfiguring online image backup 69considerations 135deleting 572excluding files from 365file systems or logical volumes 554include files for; assign managementclass to 395include.dedup 395incremental-by-date imagebackup 138offline and online 134perform 134point-in-time restore 557revoke access 569specifying selective orincremental 420using command line 140using the GUI 139using with file systemincremental 138using with incremental-by-date 137with incremental backup 137, 557image backup, considerations 135imagegapsize option 392imagetofile option 393inactive backup versionsdisplaying 100, 174, 596restoring 174inactive option 393inclexcl option 394Index 711

include optionmanagement class 245processing 86wildcard characters 82, 84include options 401include VM templates in back ups 523include-exclude listcreating 76preview 85query order of processing 608size restriction 86to control processing 117include-exclude options filespecifying path and file name of 394Unicode-enabled file spaces 394include-exclude processingoptions for 77overview 77INCLUDE.VMTSMVSS option 403incrbydate option 404incremental and selective commands withsnapshotroot option 130incremental backupassociating local snapshot with serverfile space 480back up new and changed files withmodification date later than lastbackup 404by date 110client command line 110client domain 340client Java GUI 109command line 110description 120directories, processing overview 120GPFS, multinode clusterenvironment 340memory-conserving algorithm 419new and changed files 120new and changed files withmodification date later than lastbackup 404of directoriesprocessing overview 120process a list of files 380with image backup 137, 557incremental command 579journal-based backup 583incremental option 405incremental-by-datecommand line 110comparing with incremental,journal-based 124description 124of directoriesprocessing overview 124when to use 124incremental-by-date backup 124client command line 110client Java GUI 109using with image backup 137incrthreshold option 406input stringscontaining blanks 96installbackup-archive scheduler service 251installation requirements 6installation requirements (continued)client 6installation types for the Windowsclient 10installingoverview 1installing the Windows client 10installing Tivoli Storage Managersilent installation 19interactive mode 539interactive sessionending 587starting 95, 587using 587Internet, searching for problemresolution 674, 675JJava GUIconfiguration restrictions 94journal based backuprestoring 123journal based backupsrestoring 123journal database fileserrorlog 43journaldir 43NlsRepos 43journal engine serviceconfiguring 42journal-based backup 121, 583comparing with incremental,incremental-by-date 124excluding directories 79excluding files 79include-exclude optionsjournal-based backup 79performing traditional fullincremental, instead of 427, 583specifying how to respond tounsuccessful expire of object 406when to use 124journaled file spacespecifying directories with active filesto expire 406journalpipe 43journalpipe option 407JournalSettings stanza 43Kkeyboard 679knowledge bases, searching 673LLAN-based image backuponline and offline image backup 554LAN-free data movement 357enabling communications for 114,407, 409options 114prerequisites 114shared memory port for 409lanfreecommmethod option 407lanfreeshmport option 409lanfreessl option 410lanfreetcpport option 409lanfreetcpserveraddress option 411language option 412last access datespecifying whether to update duringbackup or archive 120, 441latest option 413limitationsHyper-V support 161limited bandwidthback up 117local backup setenabling GUI for local restore 185local snapshotassociating local snapshot with serverfile space 130localbackupset option 413logSee also schedule logDSM_LOG environmentvariable 362, 461error log, pruning 360errorlogname option 362errorlogretention option 362schedlogname option 461, 656schedlogretention option 461, 656specifying path and file name 362,461, 656web client 459logical volumeimage backup of 134restoring 183logsdsmsched.log 462dsmsched.pru 462dsmwebcl.log 462dsmwebcl.pru 462truncating application logs 403loop command 587Mmacro command 588maintenance 3, 302managedservices option 414management classassigning 167management classes 117assigning to directories 246, 336assigning to files 245binding archive files to 216binding to files 247default 240displaying 241displaying information about 609overriding during archiveprocessing 246overriding the default 245processing 245questions to consider 245selecting for files 245specifying with include option 245using management class,example 245maxcmdretries option 416712 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Mbobjrefreshthresh 417Mbpctrefreshthresh 418memory requirementsWindows client 6memoryefficientbackup option 419messagesdisplaying on screen 512specifying language type 412stop displaying 449Microsoft Cluster Server cluster nodesFAQs 67installing scheduler service 58installing Tivoli Storage Manager 58,67Microsoft Dfs junctionrestore 628Microsoft Dfs trees and filesback up 170migrationWeb client 3Web client language files 3mobile dial-up support 98mode option 420modesbatch 538interactive (loop) 539modified mode 244monitor option 424monitor process command 589NNamed Pipe communication methodoptions 269namedpipename option 424NASbacking up file systems 140deleting file spaces 205, 574query node command 610restore file systems 207, 643restore NAS command 643NAS file servers using CIFSbackup and restore 144NAS file systems backupcommand line 142Web clientGUI 141nasnodename option 425Net Appliancebacking up CIFS sharedefinitions 162Network Attached Storage (NAS)assigning management class to filesystems 395backup file systems 140specifying full or differentialbackup 420Network Data Management Protocol(NDMP) 8Network File System (NFS)backup file systems 162network-attached storage (NASdisplay nodes for which admin ID hasauthority 610network-attached storage (NAS)backup file systems 558network-attached storage (NAS)(continued)cancel backup and restoreprocesses 568, 589deleting file spaces 205, 574display file spaces on server 603excluding files from backup 365monitoring backup or restoreoperations 424querying file system images belongingto 596restore file systems 207, 643specifying for query 509specifying node name foroperations 425specifying whether to save table ofcontents for each file systembackup 505networked file systemsinclude-exclude statements 79networked file systems 79new for IBM Tivoli Storage ManagerVersion 6.4 xixno query restore 178nodespecifying type to query 509node name 27node name, setting 27node option, summary 270nodename option 204, 426nojournal option 427noprompt option 428NTFSbacking up volume mountpoints 585Restoring volume mount points 627NTFS file spacesback up 168NTFS mounted volumesBacking up data on 585NTFS security informationbypass processing of 472whether to compute CRC forcomparison of 473numberformatspecifying 429numberformat option 429Ooffline image backup 134online helpdisplaying 101online forum 101service and technical support 101online image backup 134specifying gap size of stripedvolumes 392open file supportfor backup operations 107include files for 395installing and configuring 70overview 107snapshot 214open registrationpermissions 76using 76operating system re-installationWindows Vista, 7, 2008 182operating system requirementsclients 6optfile option 430options 370, 401adlocation 295archive, summary 270archmc 295asnodename 296asrmode 297, 532auditlogging 298auditlogname 300authorization options 284autodeploy 302autofsrename 304backmc 306backupexcluding system state 365backup, summary 270backupsetname 306basesnapshotname 307casesensitiveaware 308central scheduling, summary 282changingretries 310class 310clientview 311clusternode 315collocatebyfilespec 316command processing, summary 284commmethod 317commrestartduration 318commrestartinterval 319communication, summary 268compressalways 320compression 321console 322, 323datacenter 325datastore 326dateformat 326dedupcachepath 328dedupcachesize 329deduplication 329deletefiles 331description 331detail 332diagnostics 286diffsnapshot 334diffsnapshotname 335dirmc 336dirsonly 337disablenqr 338diskbuffsize 339diskcachelocation 339domain 340domain.image 343, 345, 348domain.nas 344enable8dot3namesupport 353enablearchiveretentionprotection 354enablededupcache 355enablelanfree 357encryptiontype 358encryptkeyencryptkey=generate 359encryptkey=prompt 359encryptkey=save 359errorlogmax 360Index 713

options (continued)errorlogname 362errorlogretention 363excludeexclude.archive 77, 365exclude.backup 77, 365exclude.compression 77, 365exclude.dir 77, 365exclude.encrypt 365exclude.file 77, 365exclude.file.backup 77, 365exclude.fs.nas 365exclude.image 77, 365exclude.subfile 365exclude.systemobject 77exclude.systemservice 365wildcard characters 82, 84exclude.dedup 365EXCLUDE.VMDISK 370fbbranch 372fbclient 373fbpolicyname 374fbreposlocation 376fbserver 377fbvolumename 378filelist 380filename 382filesonly 384format and language, summary 283fromdate 384fromnode 385fromtime 386general rules when entering withcommands 287groupname 387guitreeviewafterbackup 387host 388httpport 388ieobjtype 390ifnewer 391imagegapsize 392imagetofile 393inactive 393inclexcl 394includewildcard characters 82, 84include.archive 395include.backup 395include.compression 395include.encrypt 395include.file 395include.fs 395include.fs.nas 395include.image 395include.subfile 395include.systemstate 395INCLUDE.VMTSMVSS 403incrbydate 404incremental 405incrthreshold 406journalpipe 407lanfreecommmethod 407lanfreeshmport 269, 409lanfreessl 410lanfreetcpport 409lanfreetcpserveraddress 411language 412options (continued)latest 413localbackupset 413managedservices 414maxcmdretries 416mbobjrefreshthresh 417mbpctrefreshthresh 418memoryefficientbackup 419mode 420monitor 424namedpipename 424nasnodename 425nodename 426nojournal 427noprompt 428numberformat 429optfile 430order of processing (precedence) 286password 431passwordaccess 433pick 434pitdate 435pittime 436postnschedulecmd 437postschedulecmd 437postsnapshotcmd 439prenschedulecmd 440preschedulecmd 440preservelastaccessdate 441preservepath 443presnapshotcmd 445queryschedperiod 446querysummary 447quiet 449replace 450resetarchiveattribute 451resourceutilization 453restore and retrieve, summary 279retryperiod 455revokeremoteaccess 456runasservice 456schedcmddisabled 457, 458schedlogmax 459schedlogname 461schedlogretention 462schedmode 464schedrestretrdisabled 465scrolllines 466scrollprompt 467sessioninitiation 468shmport 470showmembers 470skipmissingsyswfiles 471skipntpermissions 472skipntsecuritycrc 473snapdiff 70, 473snapshotproviderfs 478snapshotproviderimage 479snapshotroot 480specifying in commands 286srvoptsetencryptiondisabled 482srvprepostscheddisabled 483srvprepostsnapdisabled 484ssl 485sslrequired 486stagingdirectory 488subdir 489options (continued)subfilebackup 491subfilecachepath 492subfilecachesize 493system stateexclude from backupprocessing 365systemstatebackupmethod 494tapeprompt 495tcpadminport 496tcpbuffsize 497tcpcadaddress 498tcpclientaddress 498tcpclientport 499tcpnodelay 500tcpport 501tcpserveraddress 501tcpwindowsize 502timeformat 503toc 505todate 506totime 507transaction processing, summary 285txnbytelimit 508type 509usedirectory 509useexistingbase 510v2archive 511verbose 512verifyimage 513virtualfsname 514virtualnodename 514vmbackdir 515vmbacknodelete 516vmbackuptype 517vmbackvcbtransport 519vmchost 520vmcpw 521vmcuser 522vmenabletemplatebackups 523vmlimitperdatastore 525vmlimitperhost 525vmlist 526vmmaxparallel 527vmmc 518vmprocesswithindependent 529vmprocesswithprdm 530VMTIMEOut 533vmvstortransport 531Web client, summary 286webports 534options fileASR recoveryWindows Vista, 7, 2008 133owner security information (SID)back up 168Pparallel backups 155, 525, 527parametersyes and no, alternatives 294partial incrementalincremental by date, running 110Passport Advantage 675passwordchanging 99, 666714 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

password (continued)number of characters 99setting 431setting for client 75specifying whether to generateautomatically or set as userprompt 433using 94valid characters 99password option 431passwordaccess option 433performanceimproving speed of backups, restores,archives, retrieves 269restore operations 177transaction options 285transaction processing 508performing traditional full incrementalbackup 583Persistent Storage Manager 145back up 145pick option 434pitdate 435pittime option 436point-in-time restoreimage backup 557policies, storage management 239policy domainsdefault policy domain 239standard policy domain 239policy setsactive policy set 239portable mediarestoring backup sets 185postnschedulecmd option 437postsnapshotcmd option 439preferences editorexcluding domains from backup 110prenschedulecmd option 440preschedulecmd option 440preservelastaccessdate option 441preservepath option 443Presnapshotcmd option 445previewinclude-exclude list 85preview archive command 589preview backup command 590primary group SIDback up 168problem determinationdescribing problem for IBM SoftwareSupport 676determining business impact for IBMSoftware Support 676submitting a problem to IBMSoftware 676processing optionsauthorization 284backup and archive 270central scheduling 282communication 268diagnostics 286error processing 284format and language 283node option 269, 270overview 267restore and retrieve 279processing options (continued)server and node 269specifying in commands 286transaction processing 285using 267Web client 286processing time 109Protecting cluster disks 59proxied session restrictions 127, 128, 216publicationsdownload xiiiorder xiiisearch xiiiTivoli Storage Manager xivQqueryamount of information that displayson screen 466backups, establish point-in-time 435,436based on date and time of backup,archive 384, 386description for 331display active and inactiveobjects 393files for another node 385groupcommand 605display members of 470include-exclude list 608NAS or client objects 310nodes to which client has proxyauthority 216nodes to which client has proxy nodeauthority 127process directories only (notfiles) 337scrolling preferences after displayinginformation on screen 467system information 614system state 616query access command 592query adobjects command 592query archive command 594query backup command 596query backupset command 599, 601query filespace command 603query group command 605query image command 606query inclexcl command 608query mgmtclass command 609query node command 610query options command 611query restore command 612query scheduleenhanced 227query schedule command 613query schedule command, enhanced 613query session command 613query systeminfo command 614encryption processing 614query systemstate command 616query VM command 617queryschedperiod option 446querysummary option 447quiesce applications 403quiet option 449Rraw logical volumeimage backup of 134restoring 183reanimatetombstone objects 198rebinding files to a different managementclass 248registeringclient with server 75using closed registration 75using open registration 75, 76remote network connectionestablishing 98remotely accessed filesexcluding 81UNC names 81removable mediaback up 168replace option 450resetarchiveattribute option 451resourceutilization option 453restart restore command 621restartable restore 178restartable restore sessions, display 612restore 180, 640active and inactive file versions 628active directory objects 198, 199, 200,202active version 174ASR (Automated System Recovery)files 181ASR recovery mode 297, 532authorizing another user 202backup setsupported tape devices 631, 636backup setsoverview 185backups, establish point-in-time 435,436based on date and time ofbackup 384, 386classic (also known as standard) 178create list of backup versions to 434directories 175display active and inactiveobjects 393estimating processing time 109files 175files and directories 175files belonging to another node 204files for another node 385from file spaces that are notUnicode-enabled 629from portable mediaoverview 185from system state backup 198groupcommand 638GUI, displaying active and inactiveversions 100image 183considerations 640Index 715

estore (continued)image (continued)enable detection of bad sectors ontarget volume 513to a file 393using chkdsk tool to repair 183using fsck tool to repair 183image, suppress confirmationprompt 428improving speed using sharememory 269inactive version 174large number of files 177list of files 380local backup set using the GUI 185logical volume 183Microsoft Dfs junction 628Microsoft Dfs trees and files 183modify CAD and agent services 202most recent backup version 413NAS file systems 207command line 210Web client 207NAS files and directories using webclient 208Net Appliance CIFS shares 191no query 178overview 173primary tasks 173process directories only (notfiles) 337raw logical volume 183replace existing file with latestbackup 391restartable 178restrictions and limitations 200sorting file list 100sparse files 629sparse files to a non-NTFS filesystem 629sparse files, size restriction for 629standard (also known as classic) 178starting a web client session 97summary of options 279system state 645to different workstation 514using commands 175using fsck tool to repair 640using GUI and command line 199using the GUI 175using universal naming conventionnames 174VMware Consolidated Backup 192whether to prompt before overwritingexisting files 450Windows Vista system state 180workstation, to another 204restore adobjects command 629restore backupset command 631, 636restore backupset commandconsiderations 188, 634restore command 622using multiple 177restore full VM backupVCB backups 196restore group command 638restore image command 640restore maximum file size 119restore NAS command 643restore procedureASR 182Windows Vista, 7, 2008, 2008 R2 182restore systemstate command 645restore vm command 647Restoring data on mounted volumesNTFS 627Restoring data on NTFS mountedvolumes 627Restoring NTFS volume mountpoints 627restoring point-in-time 206using command line 206using GUI 206restoring your systemASR recovery modeWindows Vista, 7, 2008 182restrictionsasnodename option 296runasservice and encryptkey 456runasservice and passwordaccess 456runasservice and replace 456within a proxied session 127, 128,216retain extra versions attribute 242retain only versions attribute 243retain versions attribute 244retention grace periodarchive 240, 248backup 240, 248retrievearchive copies 218archive files by name 219authorizing another user 202based on date and time ofarchive 384, 386description for 331files belonging to another node 204files for another node 385improving speed using sharememory 269list of files 380primary tasks 213process directories only (notfiles) 337replace existing file with latest archiveif existing file is newer 391sorting file list 100starting a web client session 97summary of options 279to different workstation 514whether to prompt before overwritingexisting files 450workstation, to another 204retrieve command 652retrieve maximum file size 119retrievingarchives using command line 219retryperiod option 455return codes for operations 237revokeremoteaccess option 456runasservice option 456SSANrestoring backup sets using 635schedcmddisabled option 457, 458schedlogmax option 459schedlogname option 461schedlogretention option 462schedmode option 464schedrestretrdisabled option 465schedule command 656schedule logcontrolling the size 459specifying number of days to keepentries and whether to save prunedentries 462specifying path and file name to storeschedule log information 461scheduled (automated) backupsclosing files before backup 165displaying scheduled work 227, 229options for 233process commands after backup 437process commands beforebackup 440restart applications after backup 165starting 35scheduled commandsenabling-disabling 234scheduled events, displaying 613scheduled servicesdisabling scheduled commands 457,458restrictions for NAS file systems 140schedulerconfiguring 33displaying scheduled work 227, 229event logging 229number of hours between contacts toserver for scheduled work 446number of minutes between attemptsto process scheduledcommands 455options for 233polling mode or prompted mode 464starting 35whether server or client initiatessessions through firewall 468whether to disable execution ofrestore or retrieve operations 465scheduler serviceinstalling on Microsoft Cluster Servercluster nodes 58installing on Veritas Cluster Servercluster nodes 58Scheduler Service ConfigurationUtility 33scheduler wizard 33schedulingclient node proxy backup 127, 129scrolllines option 466scrollprompt option 467Secure Sockets Layer (SSL)establishing communications with 38selective backup 480, 658client command line 110client Java GUI 109command line 110716 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

selective backup (continued)overview 110, 126selective command 658self-contained application protection 403serializationcopy serializationdynamic 243shared static 243static 243servercommunicating with 27establishing communications throughfirewall 35establishing communications with 27establishing communications withSecure Sockets Layer (SSL) 38query Active Directory forcommunication method and serverwith which to connect 509TCP/IP address of Tivoli StorageManager server 501TCP/IP port address for 501server and node optionssummary 269server optionsSslfipsmode 486service and technical support 101Service recovery settings 226session information, displaying 613sessioninitiation option 468set access command 661restore-retrieve authorization 202set event command 664set password command 666settingenvironment variablesDSM_CONFIG 30DSM_DIR 30DSM_LOG 30user privileges 98shared dynamic serialization 243, 310shared memory communication methodoptions 269shared static serialization 243, 310shmport option 470showmembers option 470silent installation 19skipmissingsyswfiles option 471skipntpermissions option 472skipntsecuritycrc option 473snapdiff option 70, 473snapshotopen file support 214snapshot difference 70, 473snapshotproviderfs option 478snapshotproviderimage option 479snapshotroot option 480snapshotroot option with incremental andselective commands 130software supportdescribing problem for IBM SoftwareSupport 676determining business impact for IBMSoftware Support 676submitting a problem 676Software Supportcontact 675sparse filesrestore size restriction 629restoring 629restoring to a non-NTFS filesystem 629specifying whether to update last accessdate 441srvoptsetencryptiondisabled option 482srvprepostscheddisabled option 483srvprepostsnapdisabled option 484SSL (Secure Socket Layer)establishig communications with 38ssl option 485Sslfipsmode option 486sslrequired option 486stagingdirectory option 488standard (classic) restore 178standard management classcopy destination 244copy frequency 242copy group name 241copy modeabsolute 244modified 244copy serialization 243copy type 242deduplicate data attribute 245default values 241retain extra versions 242retain only version 243retain versions 244versions data deletedactive versions 242inactive versions 242versions data exists 242standard policy domain 239Start the client scheduler at startup 226startingautomatically 98overview 1starting a sessionbatch mode 94interactive mode 95static serialization 243storagedisplaying restartable restoresessions 612Storage Agentfor LAN-free data movement 114using for LAN-free datamovement 357storage area networkfor LAN-free data movement 114restoring backup sets using 357, 635using for LAN-free datamovement 357storage management policies 239assigning management classes tofiles 167copy groups 240default management class 239display on backup-archive client orWeb client GUI 167include-exclude list 240management classes 240policy domainsdefault 239storage management policies (continued)policy domains (continued)standard 239policy setsactive policy set 239subdir option 489subdirectoriesarchive 216include in backup 110subfilebackup option 491subfilecachepath option 492subfilecachesize option 493supportgathering system informationfor 322, 382, 614support contract 675support information 673support subscription 675swing-enabled browsernecessary to run web client 97syntax diagramreading xvirepeating values xvirequired choices xvisystem access control list (auditinginformation)back up 168system filesexcluding 81system informationgathering 322, 382system recoveryWindows Vista, 7, 2008 182system restore 181system servicesassigning management class 130components, exclude frombackup 130exclude from backup processing 365system stateassigning management class 79, 130,395back up 130, 560display active and inactiveobjects 393exclude from backup processing 79,365query 616restore 645restore from backup set 631, 636restoring 180systemstatebackupmethod option 494Ttapeprompt option 495tasksclosed registration 75open registration 75TCP/IP communication methodoptions 268tcpadminport option 496tcpbuffsize option 497tcpcadaddress option 498tcpclientaddress option 498tcpclientport option 499tcpnodelay option 500Index 717

tcpserveraddress option 501tcpwindowsize option 502time formatspecifying 503timeformat option 503Tivoli Storage Managerclient componentsWindows client 6communication methodsWindows client 7environment prerequisites 6FAQs 67hardware, disk space, memoryrequirementsWindows client 6installation requirements 6installing on Microsoft Cluster Servercluster nodes 58, 67installing on Veritas Cluster Servercluster nodes 58online forum 102password 94upgrading from earlier versions of theproduct 1Tivoli Storage Manager clientauthentication 92Tivoli Storage Manager FastBackconfiguration 56Tivoli Storage Manager FastBackconfiguration wizard 9, 57Tivoli Storage Manager FastBack databackup 162Tivoli Storage Manager FastBack datarestore 162Tivoli Storage Manager FastBackinstallation requirements 9Tivoli Storage Manager passwordusing 94Tivoli technical training 673toc option 505todate option 506tombstone objectspreserving attributes 201reanimate 198totime option 507traditional full incremental backup 121training, Tivoli technical 673transaction processing 508summary of options 285txnbytelimit option 508type option 509UUNC namesexcluding files 81remotely accessed files 81restore files 174Unicodepre-backup considerations 114, 115renaming file spaces that are notUnicode to Unicode-enabled 304,579, 658restore from file spaces that are notUnicode-enabled 629universal naming conventionback up shared files and directoriesusing 169restore 174using to specify domain list 169updates_622_client 132, 133, 134, 297,560, 645updating the client 3upgrading the backup-archive client fromearlier versions of the product 1usedirectory option 509useexistingbase option 510user privilegessetting 98using multiple sessions 163Vv2archive option 511verbose option 512verifyimage option 513Veritas Cluster Server cluster nodesFAQs 67installing scheduler service 58installing Tivoli Storage Manager 58,67versions datadeleted attribute 242exists attribute 242virtualfsname option 514virtualnodename option 514VM 146vmbackdir option 515vmbacknodelete option 516vmbackuptype option 517, 518vmbackvcbtransport 519vmchost option 520vmcpw option 521vmctlmc optionoptionsvmctlmc 522vmcuser option 522vmenabletemplatebackups option 523vmlimitperdatastore option 525vmlimitperhost option 525vmlist option 526vmmaxparallel option 527vmprocesswithindependent 529vmprocesswithprdm 530VMTIMEOut option 533vmvstortransport option 531VMware 370, 401VMware backup 154VMware Consolidated Backuprestoring data 192VMware exclude options 370VMware include options 401VMware virtual machine backups 151types 146VMware virtual machines backupsfile-level backups, preparing for 152Volume Shadowcopy Service (VSS)configuring for online imagebackup 70configuring for open file support 70VSS (see Volume ShadowcopyService) 70vStorage backup serveroff-host backup 148Wweb clientenable to run in a swing-enabledbrowser 97starting 97supported browsers 97Web clientconfiguring in clusterenvironment 58establishing communications throughfirewall 35, 388GUI 141NASfile systems backup 141restrict administrator from accessingclient running Web client 456restrictions for NAS file systems 140specifying TCP/IP port addressfor 388summary of options 286unsupported functions 105using through a firewall 534webports option 534whether to compute CRC for comparisonof NTFS security information 473wildcard charactersguidelines 542include or exclude files 81include or exclude groups of files 82specifying a drive specification indsm.opt 82to include or exclude groups offiles 84Windows archive attributereset after backup 451Windows clientclient components 6communication methods 7disk space requirements 6forced reboot 10hardware requirements 6initial installation 11installation prerequisites 10installation types 11, 15, 19initial installation 10modify an installed client 10, 23reinstallation 10, 23silent installation 10uninstalling 10, 23upgrade installation 10installing 10memory requirements 6reinstallation 19upgrade installation 15Windows componentsinstallable 6Windows supported file systems 8WinPE CDWindows Vista, 7, 2008, 2008 R2 182718 IBM Tivoli Storage Manager for Windows Backup-Archive Clients: Installation and User's Guide

Product Number: 5608-E01, 5608-E02, 5608-E03Printed in USASC23-9792-06