IBM Spectrum Protect for Windows Backup-Archive Clients ... · Performing an image backup using the...

854
IBM Spectrum Protect for Windows Backup-Archive Clients Version 8.1.2 Installation and User's Guide IBM

Transcript of IBM Spectrum Protect for Windows Backup-Archive Clients ... · Performing an image backup using the...

  • IBM Spectrum Protect for WindowsBackup-Archive ClientsVersion 8.1.2

    Installation and User's Guide

    IBM

  • IBM Spectrum Protect for WindowsBackup-Archive ClientsVersion 8.1.2

    Installation and User's Guide

    IBM

  • Note:Before you use this information and the product it supports, read the information in “Notices” on page 805.

    This edition applies to version 8, release 1, modification 2 of IBM Spectrum Protect (product numbers 5725-W98,5725-W99, and 5725-X15) and to all subsequent releases and modifications until otherwise indicated in new editions.

    © Copyright IBM Corporation 1993, 2017.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

  • Contents

    Tables . . . . . . . . . . . . . . . xi

    About this publication . . . . . . . . xiiiWho should read this publication. . . . . . . xiiiPublications . . . . . . . . . . . . . . xiiiConventions used in this publication . . . . . xivReading syntax diagrams . . . . . . . . . xiv

    What's new for Version 8.1.2 . . . . . xvii

    Chapter 1. Installing the IBM SpectrumProtect backup-archive clients . . . . . 1Upgrading the backup-archive client . . . . . . 1

    Upgrade path for clients and servers . . . . . 1Additional upgrade information . . . . . . . 1Automatic backup-archive client deployment . . 1

    Client environment requirements . . . . . . . 3Windows client environment requirements . . . 3

    Windows client installable components . . . 3System requirements for Windows clients. . . 3Windows client communication methods . . . 3Backup-archive client features that are availableon Windows platforms . . . . . . . . . 4Windows supported file systems. . . . . . 4

    NDMP support requirements (Extended Edition only) 4Installation requirements for backing up andarchiving Tivoli Storage Manager FastBack client data 5Client configuration wizard for Tivoli StorageManager FastBack . . . . . . . . . . . . 6Windows backup-archive client installation overview 6

    Windows client installation might require a reboot 6Installation procedures . . . . . . . . . . 7

    Installing the Windows client for the first time 7Upgrading the Windows client . . . . . . 11Reinstalling the Windows client . . . . . 13Silent installation . . . . . . . . . . 14Modifying, repairing, or uninstalling theWindows client . . . . . . . . . . . 17

    Troubleshooting problems during installation . . 19Software updates . . . . . . . . . . . 20

    Installing the client management service to collectdiagnostic information. . . . . . . . . . . 20

    Chapter 2. Configure the IBM SpectrumProtect client . . . . . . . . . . . . 21Client options file overview . . . . . . . . . 21

    Creating and modifying the client options file . . 23Create a shared directory options file . . . . . 25Creating multiple client options files . . . . . 25

    Environment variables. . . . . . . . . . . 26Configuring the language for displaying the JavaGUI . . . . . . . . . . . . . . . . . 27Web client configuration overview. . . . . . . 27

    Configuring the web client on Windows systems 28

    Configuring the scheduler . . . . . . . . . 30Comparison between client acceptor-managedservices and traditional scheduler services . . . 30Configuring the client to use the client acceptorservice to manage the scheduler . . . . . . 31

    Starting the client scheduler . . . . . . . . . 32Scheduling events using the GUI . . . . . . 33

    Configuring IBM Spectrum Protect client/servercommunication across a firewall . . . . . . . 33Configuring IBM Spectrum Protect client/servercommunication with Secure Sockets Layer . . . . 36

    Creating a symbolic link to access the latestGSKit library . . . . . . . . . . . . . 39Certificate Authorities root certificates . . . . 40

    Configure your system for journal-based backup . . 41Configuring the journal engine service . . . . 41

    JournalSettings stanza (Windows) . . . . . 43JournalExcludeList stanza . . . . . . . 44JournaledFileSystemSettings stanza . . . . 45Overriding stanzas . . . . . . . . . . 48

    Client-side data deduplication . . . . . . . . 48Configuring the client for data deduplication . . 52Excluding files from data deduplication . . . . 54

    Automated client failover configuration and use . . 56Automated client failover overview . . . . . 56

    Requirements for automated client failover . . 57Restrictions for automated client failover . . 58Failover capabilities of IBM Spectrum Protectcomponents . . . . . . . . . . . . 59

    Configuring the client for automated failover . . 59Determining the status of replicated client data 61Preventing automated client failover . . . . . 62Forcing the client to fail over . . . . . . . 62

    Configuring the client to back up and archive TivoliStorage Manager FastBack data . . . . . . . . 63Configuring the backup-archive client to protectFastBack client data . . . . . . . . . . . 64Configuring the backup-archive client in a clusterserver environment . . . . . . . . . . . . 66

    Protecting data in MSCS clusters (WindowsServer clients) . . . . . . . . . . . . 66

    Configuring cluster protection (WindowsServer clients) . . . . . . . . . . . 67

    Configure the web client in a cluster environment 68Configure the web client to process clusterdisk resources . . . . . . . . . . . 68

    Frequently asked questions . . . . . . . . 75Configuring online-image backup support . . . . 78Configuring Open File Support . . . . . . . . 78Configuring NetApp and IBM Spectrum Protect forsnapshot difference incremental backups . . . . 79

    Protecting clustered-data ONTAP NetApp fileserver volumes . . . . . . . . . . . . 81SnapMirror support for NetAppsnapshot-assisted progressive incremental backup(snapdiff) . . . . . . . . . . . . . . 84

    © Copyright IBM Corp. 1993, 2017 iii

    |||||||||||

  • Register your workstation with a server . . . . . 87Closed registration . . . . . . . . . . . 87Open registration . . . . . . . . . . . 88

    Creating an include-exclude list . . . . . . . 88Include-exclude options . . . . . . . . . 89

    Exclude file spaces and directories. . . . . 89Include-exclude statements for networked filesystems. . . . . . . . . . . . . . 91Exclude files and directories from ajournal-based backup . . . . . . . . . 91Control processing with exclude statements . 91System files to exclude . . . . . . . . 92Exclude files with UNC names . . . . . . 93Include and exclude files that containwildcard characters . . . . . . . . . . 93Include and exclude groups of files withwildcard characters . . . . . . . . . . 94Examples using wildcards with include andexclude patterns . . . . . . . . . . . 95

    Determine compression and encryptionprocessing . . . . . . . . . . . . . . 96Preview include-exclude list files . . . . . . 97Include and exclude option processing . . . . 98Processing rules when using UNC names . . . 99

    Explicit use of UNC names for remote drives 100Conversion of DOS pathnames for fixed andremote drives . . . . . . . . . . . 100Character-class matching examples . . . . 100

    Chapter 3. Getting started . . . . . . 101Configuring the client security settings to connectto the IBM Spectrum Protect server version 8.1.2and later . . . . . . . . . . . . . . . 101

    Default security settings for the client (fast path) 101Configuring the client without automaticcertificate distribution . . . . . . . . . 103

    Secure password storage . . . . . . . . . 106Backup-archive client operations and securityrights . . . . . . . . . . . . . . . . 107

    Backup Operators group operations . . . . . 109Considerations before you start using a BackupOperators group account . . . . . . . . 110

    Permissions required to restore files that useadaptive subfile backup . . . . . . . . . . 110Permissions required to back up, archive, restore orretrieve files on cluster resources . . . . . . . 110IBM Spectrum Protect client authentication . . . 111User account control . . . . . . . . . . . 112

    Enabling client access to network shares whenUAC is enabled. . . . . . . . . . . . 112

    Starting a Java GUI session . . . . . . . . . 113IBM Spectrum Protect password . . . . . . 113Setup wizard . . . . . . . . . . . . 113

    Starting a command-line session . . . . . . . 114Using batch mode . . . . . . . . . . . 114Issuing a series of commands by usinginteractive mode . . . . . . . . . . . 114Displaying Euro characters in a command-lineprompt . . . . . . . . . . . . . . 115Use options on the DSMC command . . . . 116

    Specifying input strings that contain blank spacesor quotation marks . . . . . . . . . . . 116Using the web client in the new securityenvironment . . . . . . . . . . . . . . 117

    Starting a web client session . . . . . . . 117User privileges . . . . . . . . . . . 118

    Start the client scheduler automatically . . . . . 119Changing your password . . . . . . . . . 119Sorting file lists using the backup-archive clientGUI . . . . . . . . . . . . . . . . 120Displaying online help . . . . . . . . . . 122Ending a session . . . . . . . . . . . . 122Online forums . . . . . . . . . . . . . 122

    Chapter 4. Backing up your data . . . 125Planning your backups (Windows) . . . . . . 125Which files are backed up . . . . . . . . . 126Open file support for backup operations . . . . 127Backing up data using the GUI . . . . . . . 129

    Specifying drives in your domain . . . . . 130Backing up data using the command line . . . . 130Deleting backup data . . . . . . . . . . . 132When to back up and when to archive files . . . 133Pre-backup considerations (Windows) . . . . . 134

    LAN-free data movement . . . . . . . . 134LAN-free prerequisites . . . . . . . . 134LAN-free data movement options . . . . 135

    Unicode file spaces (Windows) . . . . . . 135Incremental backups on memory-constrainedsystems . . . . . . . . . . . . . . 135Incremental backups on systems with a largenumber of files . . . . . . . . . . . . 136Control processing with an include-exclude list 137Data encryption during backup or archiveoperations . . . . . . . . . . . . . 137Maximum file size for operations. . . . . . 138How the client handles long user and groupnames . . . . . . . . . . . . . . . 139

    Incremental, selective, or incremental-by-datebackups (Windows) . . . . . . . . . . . 139

    Full and partial incremental backup . . . . . 139Journal-based backup. . . . . . . . . 141

    Incremental-by-date backup . . . . . . . 143Comparing incremental-by-date, journal-based,and NetApp snapshot difference to fullincremental and partial incremental backups . . 144Snapshot differential backup with an HTTPSconnection . . . . . . . . . . . . . 145

    Running a snapshot differential backup withan HTTPS connection . . . . . . . . 146

    Selective backup . . . . . . . . . . . 147Backing up files from one or more file spaces for agroup backup (Windows) . . . . . . . . . 147Backing up data with client-node proxy support(Windows) . . . . . . . . . . . . . . 148

    Enabling multiple node operations from theGUI . . . . . . . . . . . . . . . 149Setting up encryption . . . . . . . . . 150Scheduling backups with client-node proxysupport . . . . . . . . . . . . . . 150

    iv IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    |||||||||||||||||||

    |||||||

  • Associate a local snapshot with a server file space(Windows) . . . . . . . . . . . . . . 151Backing up Windows system state . . . . . . 152Backing up Automated System Recovery files . . 153Preparation for Automated System Recovery . . . 154

    Creating a client options file for AutomatedSystem Recovery . . . . . . . . . . . 154Backing up the boot drive and system drive forAutomated System Recovery . . . . . . . 155

    Image backup . . . . . . . . . . . . . 156Performing prerequisite tasks before creating animage backup . . . . . . . . . . . . 157Utilizing image backups to perform file systemincremental backups . . . . . . . . . . 158

    Method 1: Using image backups with filesystem incremental backups . . . . . . 158Method 2: Using image backups withincremental-by-date image backups . . . . 159Comparing methods 1 and 2 . . . . . . 160

    Performing an image backup using the GUI . . 160Performing an image backup using thecommand line . . . . . . . . . . . . 161

    Back up NAS file systems using Network DataManagement Protocol . . . . . . . . . . 162

    Backing up NAS file systems with the webclient GUI using NDMP protocol . . . . . . 163Back up NAS file systems using the commandline. . . . . . . . . . . . . . . . 164Methods for backing up and recovering data onNAS file servers accessed by CIFS protocol . . 166

    Support for CDP Persistent Storage Manager . . . 167Backing up VMware virtual machines . . . . . 168

    Preparing the environment for full backups ofVMware virtual machines . . . . . . . . 169Creating full backups for VMware virtualmachines . . . . . . . . . . . . . . 171Parallel backups of virtual machines. . . . . 173

    Back up virtual machines on a Hyper-V system 173Hyper-V backup support limitations. . . . . 173

    Back up and archive Tivoli Storage ManagerFastBack data . . . . . . . . . . . . . 174Backing up Net Appliance CIFS share definitions 174Display backup processing status. . . . . . . 174Backup (Windows): Additional considerations . . 177

    Open files . . . . . . . . . . . . . 177Ambiguous file space names in filespecifications . . . . . . . . . . . . 178Management classes . . . . . . . . . . 178Deleted file systems . . . . . . . . . . 179Removable media backup . . . . . . . . 179Fixed drives . . . . . . . . . . . . . 180NTFS and ReFS file spaces . . . . . . . . 180Universal Naming Convention names . . . . 180

    Examples: UNC names in domain lists . . . 180Examples: UNC name backup . . . . . . 181

    Microsoft Dfs file protection methods . . . . 182

    Chapter 5. Restoring your data . . . . 185Duplicate file names . . . . . . . . . . . 185Universal Naming Convention names restore. . . 186Active or inactive backup restore . . . . . . . 186

    Restoring files and directories . . . . . . . . 187Restoring data by using the GUI . . . . . . 187Examples for restoring data using the commandline. . . . . . . . . . . . . . . . 187

    Examples: Restoring large amounts of data 189Standard query restore, no-query restore, andrestartable restore . . . . . . . . . . 190

    Restoring Windows system state . . . . . . . 191Restoring Automated System Recovery files . . . 192Restoring the operating system when the computeris working . . . . . . . . . . . . . . 192Recovering a computer when the Windows OS isnot working . . . . . . . . . . . . . . 193

    Creating a bootable WinPE CD . . . . . . 193Restoring the Windows operating system withAutomated System Recovery . . . . . . . 193

    Microsoft Dfs tree and file restore . . . . . . 193Restoring an image . . . . . . . . . . . 194

    Restoring an image using the GUI . . . . . 195Restoring an image using the command line . . 196

    Restore data from a backup set . . . . . . . 196Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 198Backup set restore . . . . . . . . . . . 199Restoring backup sets using the GUI . . . . 200Backup set restores using the clientcommand-line interface . . . . . . . . . 201

    Restore Net Appliance CIFS shares . . . . . . 202Restoring data from a VMware backup . . . . . 202

    Restoring full VM backups . . . . . . . . 203Shadow copy considerations for restoring anapplication protection backup from the datamover . . . . . . . . . . . . . . 205

    Scenarios for running full VM instant access andfull VM instant restore from the backup-archiveclient command line . . . . . . . . . . 207

    Full VM instant restore cleanup and repairscenarios . . . . . . . . . . . . . 210Recovering from non-standard errorconditions . . . . . . . . . . . . 212

    Scenario: Restoring file-level VM backups . . . 213Restoring full VM backups that were createdwith VMware Consolidated Backup . . . . . 216

    Restore Windows individual Active Directoryobjects. . . . . . . . . . . . . . . . 217

    Reanimate tombstone objects or restoring from asystem state backup . . . . . . . . . . 218Restoring Active Directory objects using theGUI and command line . . . . . . . . . 219Restrictions and limitations when restoringActive Directory objects . . . . . . . . . 219Preserve attributes in tombstone objects . . . 221Modifying the client acceptor and agent servicesto use the web client . . . . . . . . . . 221

    Restoring or retrieving data during a failover. . . 222Authorizing another user to restore or retrieveyour files . . . . . . . . . . . . . . . 223Restoring or retrieving files from another clientnode . . . . . . . . . . . . . . . . 224Restoring or retrieving your files to anotherworkstation . . . . . . . . . . . . . . 225

    Contents v

  • Deleting file spaces . . . . . . . . . . . 226Restoring data to a point in time . . . . . . . 227Restore NAS file systems . . . . . . . . . 228

    Restoring NAS file systems using the web client 229Restoring NAS files and directories using theweb client . . . . . . . . . . . . . 230Options and commands to restore NAS filesystems from the command line . . . . . . 231

    Chapter 6. Archive and retrieve yourdata (Windows) . . . . . . . . . . 233Archive files. . . . . . . . . . . . . . 233

    Snapshot backup or archive with open filesupport . . . . . . . . . . . . . . 234Archiving data with the GUI . . . . . . . 234Archive data examples by using the commandline. . . . . . . . . . . . . . . . 235

    Associate a local snapshot with a server filespace (Windows) . . . . . . . . . . 236

    Archiving data with client node proxy . . . . 236Deleting archive data . . . . . . . . . . 238

    Retrieve archives . . . . . . . . . . . . 238Retrieving archives with the GUI . . . . . . 239Retrieve archive copies by using the commandline. . . . . . . . . . . . . . . . 239

    Chapter 7. IBM Spectrum Protectscheduler overview . . . . . . . . . 241Examples: Blank spaces in file names in scheduledefinitions . . . . . . . . . . . . . . 242Preferential start times for certain nodes . . . . 242Scheduler processing options . . . . . . . . 243

    Evaluate schedule return codes in schedulescripts . . . . . . . . . . . . . . . 244Return codes from preschedulecmd andpostschedulecmd scripts . . . . . . . . . 245

    Client-acceptor scheduler services versus thetraditional scheduler services . . . . . . . . 246Setting the client scheduler process to run as abackground task and start automatically at startup . 246Examples: Display information about scheduledwork . . . . . . . . . . . . . . . . 248Display information about completed work . . . 250

    Examples: event logs . . . . . . . . . . 251Specify scheduling options . . . . . . . . . 254Enable or disable scheduled commands . . . . 254Change processing options used by the schedulerservice. . . . . . . . . . . . . . . . 255Manage multiple schedule requirements on onesystem . . . . . . . . . . . . . . . 255

    Chapter 8. Client return codes . . . . 259

    Chapter 9. Storage managementpolicies . . . . . . . . . . . . . . 261Policy domains and policy sets . . . . . . . 261Management classes and copy groups . . . . . 262Display information about management classesand copy groups . . . . . . . . . . . . 263

    Copy group name attribute. . . . . . . . 263Copy type attribute . . . . . . . . . . 263Copy frequency attribute . . . . . . . . 264Versions data exists attribute . . . . . . . 264Versions data deleted attribute . . . . . . 264Retain extra versions attribute . . . . . . . 264Retain only version attribute . . . . . . . 265Copy serialization attribute . . . . . . . . 265Copy mode parameter . . . . . . . . . 266Copy destination attribute . . . . . . . . 266Retain versions attribute. . . . . . . . . 266Deduplicate data attribute . . . . . . . . 266

    Select a management class for files . . . . . . 267Assign a management class to files . . . . . . 267Override the management class for archived files 268Select a management class for directories . . . . 268Bind management classes to files . . . . . . . 269Rebind backup versions of files . . . . . . . 270Retention grace period . . . . . . . . . . 270Event-based policy retention protection. . . . . 271

    Archive files on a data retention server . . . . 271

    Chapter 10. IBM Spectrum ProtectClient Service Configuration Utility . . 273Install the backup-archive scheduler service . . . 273

    Using the Client Service Configuration Utility(Windows) . . . . . . . . . . . . . 273

    Examples: Automating backups . . . . . 274Examples: Configuring the client acceptor tomanage an existing scheduler service . . . 276Creating a new scheduler and associating aclient acceptor to manage the scheduler . . 276

    dsmcutil command . . . . . . . . . . . 277Dsmcutil commands: Required options andexamples . . . . . . . . . . . . . . 278Dsmcutil valid options . . . . . . . . . 287

    Chapter 11. Processing options . . . 291Processing options overview . . . . . . . . 291Communication options . . . . . . . . . . 292

    TCP/IP options . . . . . . . . . . . 292Named Pipes option . . . . . . . . . . 293Shared memory options . . . . . . . . . 293

    Backup and archive processing options . . . . . 293Restore and retrieve processing options. . . . . 302Scheduling options . . . . . . . . . . . 305Format and language options . . . . . . . . 306Command processing options . . . . . . . . 306Authorization options . . . . . . . . . . 307Error processing options. . . . . . . . . . 307Transaction processing options . . . . . . . 308Web client options. . . . . . . . . . . . 309Diagnostics options . . . . . . . . . . . 309Using options with commands . . . . . . . 309

    Entering options with a command . . . . . 310Initial command-line-only options . . . . . 315Client options that can be set by the IBMSpectrum Protect server . . . . . . . . . 316

    Client options reference . . . . . . . . . . 317Absolute . . . . . . . . . . . . . . 318

    vi IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    ||

    ||

  • Adlocation . . . . . . . . . . . . . 319Archmc . . . . . . . . . . . . . . . 319Asnodename . . . . . . . . . . . . . 320

    Session settings and schedules for a proxyoperation . . . . . . . . . . . . . 322

    Asrmode . . . . . . . . . . . . . . 323Auditlogging . . . . . . . . . . . . 324Auditlogname . . . . . . . . . . . . 326Autodeploy . . . . . . . . . . . . . 328Autofsrename . . . . . . . . . . . . 329Backmc . . . . . . . . . . . . . . . 331Backupsetname . . . . . . . . . . . . 332Basesnapshotname . . . . . . . . . . . 333Cadlistenonport . . . . . . . . . . . 334Casesensitiveaware . . . . . . . . . . 335Changingretries . . . . . . . . . . . 336Class . . . . . . . . . . . . . . . 337Clientview . . . . . . . . . . . . . 338Clusterdisksonly . . . . . . . . . . . 338Clusternode . . . . . . . . . . . . . 341Collocatebyfilespec . . . . . . . . . . 342Commmethod . . . . . . . . . . . . . 343Commrestartduration . . . . . . . . . . 344Commrestartinterval . . . . . . . . . . 345Compressalways . . . . . . . . . . . . 346Compression . . . . . . . . . . . . . 347Console . . . . . . . . . . . . . . 348Createnewbase . . . . . . . . . . . . 350Datacenter . . . . . . . . . . . . . 352Datastore . . . . . . . . . . . . . 352Dateformat . . . . . . . . . . . . . 352Dedupcachepath . . . . . . . . . . . . 355Dedupcachesize . . . . . . . . . . . . 355Deduplication . . . . . . . . . . . . 356Deletefiles . . . . . . . . . . . . . 357Description . . . . . . . . . . . . . 358Detail . . . . . . . . . . . . . . . 359Diffsnapshot . . . . . . . . . . . . 360Diffsnapshotname . . . . . . . . . . . 362Dirmc . . . . . . . . . . . . . . . 363Dirsonly . . . . . . . . . . . . . . 364Disablenqr . . . . . . . . . . . . . 364Diskbuffsize . . . . . . . . . . . . 365Diskcachelocation . . . . . . . . . . 366Domain . . . . . . . . . . . . . . . 367Domain.image . . . . . . . . . . . . 370Domain.nas . . . . . . . . . . . . . 371Domain.vmfull . . . . . . . . . . . . 372Enable8dot3namesupport . . . . . . . . . 381Enablearchiveretentionprotection . . . . . 383Enablededupcache . . . . . . . . . . . 384Enableinstrumentation . . . . . . . . . 385Enablelanfree . . . . . . . . . . . . 387Encryptiontype . . . . . . . . . . . . 388Encryptkey . . . . . . . . . . . . . 389Errorlogmax . . . . . . . . . . . . . 391Errorlogname . . . . . . . . . . . . 392Errorlogretention . . . . . . . . . . 393Exclude options . . . . . . . . . . . 395

    Controlling compression processing . . . . 398Processing NAS file systems . . . . . . 398

    Virtual machine exclude options . . . . . 399Fbbranch . . . . . . . . . . . . . . 402Fbclientname . . . . . . . . . . . . 403Fbpolicyname . . . . . . . . . . . . 405Fbreposlocation . . . . . . . . . . . 406Fbserver . . . . . . . . . . . . . . 408Fbvolumename . . . . . . . . . . . . 409Filelist . . . . . . . . . . . . . . 410Filename . . . . . . . . . . . . . . 413Filesonly . . . . . . . . . . . . . 414Forcefailover . . . . . . . . . . . . 415Fromdate . . . . . . . . . . . . . . 416Fromnode . . . . . . . . . . . . . . 416Fromtime . . . . . . . . . . . . . . 417Groupname . . . . . . . . . . . . . 418Host . . . . . . . . . . . . . . . 418Httpport . . . . . . . . . . . . . . 419Hsmreparsetag . . . . . . . . . . . . 419Ieobjtype . . . . . . . . . . . . . 421Ifnewer . . . . . . . . . . . . . . 422Imagegapsize . . . . . . . . . . . . 422Imagetofile . . . . . . . . . . . . . 423Inactive . . . . . . . . . . . . . . 424Inclexcl . . . . . . . . . . . . . . 425

    Considerations for Unicode-enabled clients 425Include options. . . . . . . . . . . . 426

    Compression and encryption processing . . 431Processing NAS file systems . . . . . . 431Virtual machine include options . . . . . 432

    Incrbydate . . . . . . . . . . . . . 442Incremental . . . . . . . . . . . . . 443Incrthreshold . . . . . . . . . . . . 443Instrlogmax . . . . . . . . . . . . . 444Instrlogname . . . . . . . . . . . . 445Journalpipe . . . . . . . . . . . . . 446Lanfreecommmethod . . . . . . . . . . 447Lanfreeshmport . . . . . . . . . . . . 448Lanfreetcpport . . . . . . . . . . . . 449Lanfreessl . . . . . . . . . . . . . 450Lanfreetcpserveraddress . . . . . . . . 451Language . . . . . . . . . . . . . . 451Latest . . . . . . . . . . . . . . . 452Localbackupset . . . . . . . . . . . . 453Managedservices . . . . . . . . . . . 454Maxcmdretries . . . . . . . . . . . . 456Mbobjrefreshthresh . . . . . . . . . . 456Mbpctrefreshthresh . . . . . . . . . . 457Memoryefficientbackup . . . . . . . . . 458Mode . . . . . . . . . . . . . . . 460Monitor . . . . . . . . . . . . . . 464Myprimaryserver . . . . . . . . . . . 464Myreplicationserver . . . . . . . . . . 465Namedpipename . . . . . . . . . . . . 467Nasnodename . . . . . . . . . . . . . 467Nodename . . . . . . . . . . . . . . 468Nojournal . . . . . . . . . . . . . 470Noprompt . . . . . . . . . . . . . . 470Nrtablepath . . . . . . . . . . . . . 471Numberformat . . . . . . . . . . . . 472Optfile . . . . . . . . . . . . . . 474Password . . . . . . . . . . . . . . 474

    Contents vii

    ||

    ||

    ||

  • Passwordaccess . . . . . . . . . . . . 476Pick . . . . . . . . . . . . . . . 477Pitdate . . . . . . . . . . . . . . 478Pittime . . . . . . . . . . . . . . 479Postschedulecmd/Postnschedulecmd . . . . . 480Postsnapshotcmd . . . . . . . . . . . 482Preschedulecmd/Prenschedulecmd . . . . . 483Preservelastaccessdate . . . . . . . . . 485Preservepath . . . . . . . . . . . . 486Presnapshotcmd . . . . . . . . . . . . 488Queryschedperiod . . . . . . . . . . . 490Querysummary . . . . . . . . . . . . 491Quiet . . . . . . . . . . . . . . . 492Quotesareliteral . . . . . . . . . . . 493Replace . . . . . . . . . . . . . . 494Replserverguid . . . . . . . . . . . . 496Replservername . . . . . . . . . . . . 497Replsslport . . . . . . . . . . . . . 498Repltcpport . . . . . . . . . . . . . 500Repltcpserveraddress . . . . . . . . . 501Resetarchiveattribute . . . . . . . . . 502Resourceutilization . . . . . . . . . . 504

    Regulating backup and archive sessions . . 505Regulating restore sessions . . . . . . . 505Multiple client session considerations . . . 506

    Retryperiod . . . . . . . . . . . . . 507Revokeremoteaccess . . . . . . . . . . 507Runasservice . . . . . . . . . . . . 508Schedcmddisabled . . . . . . . . . . . 509Schedcmdexception . . . . . . . . . . 510Schedgroup . . . . . . . . . . . . . 511Schedlogmax . . . . . . . . . . . . . 512Schedlogname . . . . . . . . . . . . 514Schedlogretention . . . . . . . . . . 515Schedmode . . . . . . . . . . . . . 516Schedrestretrdisabled . . . . . . . . . 518Scrolllines . . . . . . . . . . . . . 518Scrollprompt . . . . . . . . . . . . 519Sessioninitiation . . . . . . . . . . 520Setwindowtitle . . . . . . . . . . . . 522Shmport . . . . . . . . . . . . . . 523Showmembers . . . . . . . . . . . . . 524Skipmissingsyswfiles . . . . . . . . . 524Skipntpermissions . . . . . . . . . . 525Skipntsecuritycrc . . . . . . . . . . 526Skipsystemexclude . . . . . . . . . . 527Snapdiff . . . . . . . . . . . . . . 528Snapdiffchangelogdir . . . . . . . . . 533Snapdiffhttps . . . . . . . . . . . . 534Snapshotproviderfs . . . . . . . . . . 536Snapshotproviderimage . . . . . . . . . 536Snapshotroot . . . . . . . . . . . . 537Srvoptsetencryptiondisabled . . . . . . . 540Srvprepostscheddisabled . . . . . . . . 540Srvprepostsnapdisabled . . . . . . . . . 541Ssl . . . . . . . . . . . . . . . . 542Sslacceptcertfromserv . . . . . . . . . 544Ssldisablelegacytls . . . . . . . . . . 544Sslfipsmode . . . . . . . . . . . . . 545Sslrequired . . . . . . . . . . . . . 546Stagingdirectory . . . . . . . . . . . 548

    Subdir . . . . . . . . . . . . . . . 549Systemstatebackupmethod . . . . . . . . 551Tapeprompt . . . . . . . . . . . . . 552Tcpadminport . . . . . . . . . . . . 553Tcpbuffsize . . . . . . . . . . . . . 554Tcpcadaddress . . . . . . . . . . . . 555Tcpclientaddress . . . . . . . . . . . 556Tcpclientport . . . . . . . . . . . . 557Tcpnodelay . . . . . . . . . . . . . 557Tcpport . . . . . . . . . . . . . . 558Tcpserveraddress . . . . . . . . . . . 559Tcpwindowsize . . . . . . . . . . . . 559Timeformat . . . . . . . . . . . . . 561Toc . . . . . . . . . . . . . . . . 562Todate . . . . . . . . . . . . . . . 563Totime . . . . . . . . . . . . . . . 564Txnbytelimit . . . . . . . . . . . . 565Type . . . . . . . . . . . . . . . 566Usedirectory . . . . . . . . . . . . 567Useexistingbase . . . . . . . . . . . 568Usereplicationfailover . . . . . . . . . 569V2archive . . . . . . . . . . . . . 570Verbose . . . . . . . . . . . . . . 570Verifyimage . . . . . . . . . . . . . 571Virtualfsname . . . . . . . . . . . . 572Virtualnodename . . . . . . . . . . . 572Vmautostartvm . . . . . . . . . . . . 573Vmbackdir . . . . . . . . . . . . . 574Vmbackuplocation . . . . . . . . . . . 575Vmbackupmailboxhistory . . . . . . . . . 577Vmbackuptype . . . . . . . . . . . . 578Vmchost . . . . . . . . . . . . . . 579Vmcpw . . . . . . . . . . . . . . . 580Vmctlmc . . . . . . . . . . . . . . 580Vmcuser . . . . . . . . . . . . . . 582Vmdatastorethreshold . . . . . . . . . 583Vmdefaultdvportgroup . . . . . . . . . 584Vmdefaultdvswitch . . . . . . . . . . 585Vmdefaultnetwork . . . . . . . . . . 586Vmdiskprovision . . . . . . . . . . . 587Vmenabletemplatebackups . . . . . . . . 588Vmexpireprotect . . . . . . . . . . . 589Vmiscsiadapter . . . . . . . . . . . . 590Vmiscsiserveraddress . . . . . . . . . 591Vmlimitperdatastore . . . . . . . . . . 592Vmlimitperhost . . . . . . . . . . . . 593Vmlist . . . . . . . . . . . . . . . 594Vmmaxbackupsessions . . . . . . . . . . 595Vmmaxparallel . . . . . . . . . . . . 597Vmmaxpersnapshot . . . . . . . . . . . 599Vmmaxrestoresessions . . . . . . . . . 600Vmmaxrestoreparalleldisks . . . . . . . 601Vmmaxsnapshotretry . . . . . . . . . . 602Vmmaxvirtualdisks . . . . . . . . . . 603Vmmc . . . . . . . . . . . . . . . 604Vmmountage . . . . . . . . . . . . . 605Vmnoprdmdisks . . . . . . . . . . . . 606Vmnovrdmdisks . . . . . . . . . . . . 607Vmpreferdagpassive . . . . . . . . . . 608Vmprocessvmwithindependent . . . . . . . 609Vmprocessvmwithphysdisks . . . . . . . . 610

    viii IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    ||

    ||

    ||

    ||

    ||||||

    ||

    ||

    ||||

    ||

    ||||

    ||

  • Vmprocessvmwithprdm . . . . . . . . . . 611Vmrestoretype . . . . . . . . . . . . 612Vmskipctlcompression . . . . . . . . . 615Vmskipmaxvirtualdisks . . . . . . . . . 615Vmskipmaxvmdks. . . . . . . . . . . 616Vmskipphysdisks . . . . . . . . . . . 617Vmstoragetype . . . . . . . . . . . . 618Vmtagdatamover . . . . . . . . . . . . 619Vmtagdefaultdatamover . . . . . . . . . 621Vmtempdatastore . . . . . . . . . . . 623Vmverifyifaction . . . . . . . . . . . 624Vmverifyiflatest . . . . . . . . . . . 626Vmvstortransport . . . . . . . . . . . 627Vssaltstagingdir . . . . . . . . . . . 628Vssusesystemprovider . . . . . . . . . 629Vmtimeout . . . . . . . . . . . . . 630Webports . . . . . . . . . . . . . . 631Wildcardsareliteral . . . . . . . . . . 632

    Chapter 12. Using commands . . . . 635Start and end a client command session . . . . 638

    Process commands in batch mode . . . . . 638Process commands in interactive mode . . . . 639

    Enter client command names, options, andparameters . . . . . . . . . . . . . . 639

    Command name . . . . . . . . . . . 640Options . . . . . . . . . . . . . . 640

    Options in interactive mode . . . . . . 640Parameters . . . . . . . . . . . . . 640File specification syntax . . . . . . . . . 641

    Wildcard characters . . . . . . . . . . . 642Client commands reference . . . . . . . . . 643Archive . . . . . . . . . . . . . . . 643

    Open file support . . . . . . . . . . . 645Archive FastBack . . . . . . . . . . . . 646Backup FastBack . . . . . . . . . . . . 649Backup Group . . . . . . . . . . . . . 652Backup Image . . . . . . . . . . . . . 654

    Offline and online image backup . . . . . . 656Utilizing image backup to perform file systemincremental backup . . . . . . . . . . 657

    Backup NAS . . . . . . . . . . . . . 658Backup Systemstate . . . . . . . . . . . 660Backup VM . . . . . . . . . . . . . . 662Cancel Process . . . . . . . . . . . . . 678Cancel Restore . . . . . . . . . . . . . 678Delete Access . . . . . . . . . . . . . 679Delete Archive . . . . . . . . . . . . . 679Delete Backup . . . . . . . . . . . . . 681Delete Filespace . . . . . . . . . . . . 685Delete Group . . . . . . . . . . . . . 686Expire . . . . . . . . . . . . . . . . 688Help . . . . . . . . . . . . . . . . 689Incremental . . . . . . . . . . . . . . 691

    Open file support . . . . . . . . . . . 695Journal-based backup. . . . . . . . . . 695Backing up NTFS or ReFS volume mount points 696

    Backing up data on NTFS or ReFS mountedvolumes . . . . . . . . . . . . . 697

    Back up Microsoft Dfs root . . . . . . . . 697Incremental-by-Date . . . . . . . . . . 698

    Associate a local snapshot with a server filespace . . . . . . . . . . . . . . . 698

    Loop . . . . . . . . . . . . . . . . 698Macro . . . . . . . . . . . . . . . . 699Monitor Process . . . . . . . . . . . . 700Preview Archive . . . . . . . . . . . . 701Preview Backup . . . . . . . . . . . . 702Query Access . . . . . . . . . . . . . 703Query Adobjects . . . . . . . . . . . . 703Query Archive . . . . . . . . . . . . . 705Query Backup . . . . . . . . . . . . . 707

    Query NAS file system images . . . . . . 711Query Backupset . . . . . . . . . . . . 711

    Query Backupset without the backupsetnameparameter . . . . . . . . . . . . . 712

    Query Filespace . . . . . . . . . . . . 714Query NAS file spaces . . . . . . . . . 716

    Query Group . . . . . . . . . . . . . 716Query Image . . . . . . . . . . . . . 718Query Inclexcl . . . . . . . . . . . . . 719Query Mgmtclass . . . . . . . . . . . . 721Query Node. . . . . . . . . . . . . . 722Query Options . . . . . . . . . . . . . 723Query Restore . . . . . . . . . . . . . 724Query Schedule . . . . . . . . . . . . 725Query Session . . . . . . . . . . . . . 725Query Systeminfo . . . . . . . . . . . 726Query Systemstate . . . . . . . . . . . 728Query VM . . . . . . . . . . . . . . 729Restart Restore . . . . . . . . . . . . . 737Restore . . . . . . . . . . . . . . . 737

    Restoring NTFS or ReFS volume mount points 742Restoring data on NTFS mounted volumes 742

    Restore Microsoft Dfs junctions . . . . . . 743Restore active files. . . . . . . . . . . 743Universal Naming Convention restores . . . . 743Restore from file spaces that are notUnicode-enabled . . . . . . . . . . . 744Restore named streams . . . . . . . . . 744Restore sparse files . . . . . . . . . . 744

    Restore Adobjects. . . . . . . . . . . . 745Restore Backupset . . . . . . . . . . . 746

    Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 749Restore backup sets in a SAN environment . . 750Restore Backupset without the backupsetnameparameter . . . . . . . . . . . . . 750

    Restore Group . . . . . . . . . . . . . 753Restore Image . . . . . . . . . . . . . 754Restore NAS . . . . . . . . . . . . . 758Restore Systemstate . . . . . . . . . . . 760Restore VM . . . . . . . . . . . . . . 760Retrieve . . . . . . . . . . . . . . . 769

    Retrieve archives from file spaces that are notUnicode-enabled . . . . . . . . . . . 772Retrieve named streams . . . . . . . . . 773Retrieve sparse files . . . . . . . . . . 773

    Schedule . . . . . . . . . . . . . . . 773Selective . . . . . . . . . . . . . . . 775

    Open file support . . . . . . . . . . . 777

    Contents ix

    ||

  • Associate a local snapshot with a server filespace . . . . . . . . . . . . . . . 778

    Set Access . . . . . . . . . . . . . . 778Set Event. . . . . . . . . . . . . . . 781Set Netappsvm . . . . . . . . . . . . 783Set Password . . . . . . . . . . . . . 784Set Vmtags . . . . . . . . . . . . . . 790

    Data protection tagging overview . . . . . 791Representation of tags in the IBM SpectrumProtect vSphere Client plug-in . . . . . . 792Supported data protection tags . . . . . 792Inheritance of data protection settings . . . 800Tips for data protection tagging . . . . . 802

    Appendix. Accessibility features forthe IBM Spectrum Protect productfamily. . . . . . . . . . . . . . . 803

    Notices . . . . . . . . . . . . . . 805

    Glossary . . . . . . . . . . . . . 809

    Index . . . . . . . . . . . . . . . 811

    x IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    ||

  • Tables

    1. Windows client communication methods . . . 42. Supported features on Windows platforms 43. Stoppable services . . . . . . . . . . 114. File path and name limits . . . . . . . . 225. Client acceptor-managed services versus

    traditional scheduler services. . . . . . . 306. Data deduplication settings: Client and server 517. Options for excluding file spaces and

    directories . . . . . . . . . . . . . 908. Options for controlling processing using

    include and exclude statements . . . . . . 919. Wildcard and other special characters . . . . 94

    10. Specifying a drive specification usingwildcards . . . . . . . . . . . . . 95

    11. Using wildcard characters with include andexclude patterns . . . . . . . . . . . 96

    12. Options for controlling compression andencryption processing . . . . . . . . . 96

    13. UNC name patterns and DOS patterns 10014. Required user security rights for IBM

    Spectrum Protect backup and restore services . 10815. Working with your files using the

    backup-archive client GUI . . . . . . . 12116. Planning your backups . . . . . . . . 12517. Command line backup examples . . . . . 13118. Maximum file size . . . . . . . . . . 13819. Comparing incremental image backup

    methods . . . . . . . . . . . . . 16020. NAS options and commands . . . . . . 16421. Backup and restore capabilities for VMware

    virtual machines on Windows platforms . . 16822. Client command line informational messages 17523. UNC examples . . . . . . . . . . . 18124. Command-line restore examples . . . . . 18825. Backup set GUI restore restrictions . . . . 19826. Backup set command-line restore restrictions 19827. Components for the restore command when

    you restore files to the same computer . . . 21428. Components for the restore command when

    you restore files to a different computer. . . 21529. NAS options and commands . . . . . . 23130. Command-line archive examples . . . . . 23531. Command line examples of retrieving

    archives . . . . . . . . . . . . . 24032. Sample classic query schedule output 24933. Sample enhanced query schedule output 25034. Client return codes and their meanings 25935. Default attribute values in the standard

    management class . . . . . . . . . . 26336. TCP/IP options . . . . . . . . . . . 29237. Named Pipes communication option 29338. Shared memory communication options 29339. Backup and archive processing options 29340. Restore and retrieve processing options 30241. Scheduling options. . . . . . . . . . 30542. Format and language options . . . . . . 306

    43. Command processing options . . . . . . 30744. Authorization options. . . . . . . . . 30745. Error processing options . . . . . . . . 30746. Transaction processing options . . . . . . 30847. Web client options . . . . . . . . . . 30948. Diagnostics options . . . . . . . . . 30949. Client command options . . . . . . . . 31150. Options that are valid on the initial command

    line only . . . . . . . . . . . . . 31651. Options that can be set by the IBM Spectrum

    Protect server . . . . . . . . . . . 31752. Setting the value of the asnodename option to

    distribute backups.. . . . . . . . . . 32053. Clusternode and clusterdisksonly

    combinations. . . . . . . . . . . . 34054. Interaction of domain definitions from several

    sources. . . . . . . . . . . . . . 37055. System services components and

    corresponding keywords . . . . . . . . 39756. Other optional parameters . . . . . . . 42957. Incremental command: Related options 53058. Effects of server and client SSL settings on

    success or failure of login attempts . . . . 54759. Commands . . . . . . . . . . . . 63560. Wildcard characters . . . . . . . . . 64361. Archive command: Related options . . . . 64462. Archive FastBack command: Related options 64763. Backup FastBack command: Related options 65064. Backup Group command: Related options 65365. Backup Image command: Related options 65566. Backup NAS command: Related options 66067. Delete Archive command: Related options 68068. Delete Backup command: Related options 68469. Delete Filespace command: Related options 68670. Delete Group command: Related options 68771. Expire command: Related options. . . . . 68972. Incremental command: Related options 69373. Query Adobjects command: Related options 70474. Query Archive command: Related options 70675. Query Backup command: Related options 70976. Query Backupset command: Related options 71277. Query Backupset command: Related options 71378. Query Filespace command: Related options 71579. Query Group command: Related options 71780. Query Image command: Related options 71981. Query Mgmtclass command: Related options 72282. Query Node command: Related options 72383. Query Options command: Related options 72384. Query Systeminfo command: Related options 72785. Query Systemstate command: Related options 72886. Query VM command: Related options for

    VMware virtual machine queries. . . . . . 73087. Query VM command: Related options for

    Hyper-V virtual machine queries. . . . . . 73388. Restore command: Related options . . . . 74089. Restore Adobjects command: Related options 745

    © Copyright IBM Corp. 1993, 2017 xi

    |||

    ||

    |||

  • 90. Restore Backupset command: Related options 74891. Restore Group command: Related options 75392. Restore Image command: Related options 75693. Restore NAS command: Related options 75994. Restore VM command: Related options when

    restoring VMware virtual machines . . . . 76495. Restore VM command: Related options when

    restoring Hyper-V virtual machines . . . . 768

    96. Retrieve command: Related options . . . . 77197. Schedule command: Related options . . . . 77498. Selective command: Related options . . . . 77699. Order of precedence of vSphere inventory

    objects . . . . . . . . . . . . . . 801

    xii IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • About this publication

    IBM Spectrum Protect™ is a client/server licensed product that provides storagemanagement services in a multiplatform computer environment.

    The backup-archive client program enables 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, IBM Spectrum Protect includes thefollowing components:v A server program that acts as a backup and archive server for distributed

    workstations and file servers.v An administrative client program that you can access from a web browser or

    from the command line. The program enables the IBM Spectrum Protectadministrator to control and monitor server activities, define storagemanagement policies for backup, archive, and space management services, andset up schedules to perform those services at regular intervals.

    v An application programming interface (API) that you can use to enhance anexisting application with storage management services. When an application isregistered with a server as a client node, the application can back up, restore,archive, and retrieve objects from storage.

    v A web backup-archive client that enables an authorized administrator, help deskperson, or other users to perform backup, restore, archive, and retrieve servicesby using a web browser on a remote system.

    Related concepts:“Planning your backups (Windows)” on page 125“What's new for Version 8.1.2” on page xviiChapter 1, “Installing the IBM Spectrum Protect backup-archive clients,” on page 1

    Who should read this publicationThis publication provides instructions for a user to install, configure, and use theIBM Spectrum Protect client.

    Unless otherwise specified, references to Windows refer to all supported MicrosoftWindows operating systems.

    PublicationsThe IBM Spectrum Protect product family includes IBM Spectrum ProtectSnapshot, IBM Spectrum Protect for Space Management, IBM Spectrum Protect forDatabases, and several other storage management products from IBM®.

    To view IBM product documentation, see IBM Knowledge Center.

    © Copyright IBM Corp. 1993, 2017 xiii

    http://www.ibm.com/support/knowledgecenter

  • Conventions used in this publicationThis publication uses the following typographical conventions:

    Example Description

    autoexec.ncfhsmgui.exe

    A series of lowercase letters with an extension indicates program filenames.

    DSMI_DIR A series of uppercase letters indicates return codes and other values.

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

    timeformat Boldface italic type indicates a backup-archive client option. The boldtype is used to introduce the option, or used in an example.

    dateformat Italic type indicates an option, the value of an option, a new term, aplaceholder for information you provide, or for special emphasis in thetext.

    maxcmdretries Monospace type indicates fragments of a program or information as itmight appear on a display screen, such a command example.

    plus sign (+) 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.v The ───► symbol at the end of a line indicates that the syntax diagram continues

    on the next line.v The ►─── symbol at the beginning of a line indicates that a syntax diagram

    continues from the previous line.v 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)v Above the line (default element)v Below the line (optional element)

    Symbols

    Enter these symbols exactly as they appear in the syntax diagram.v * Asteriskv { } Bracesv : Colonv , Commav = Equal Signv - Hyphenv () Parenthesesv . Periodv Space

    xiv IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • v " quotation markv 'single quotation mark

    Variables

    Italicized lowercase items such as indicate variables. In this example,you can specify a when you enter the cmd_name command.

    ►► cmd_name ►◄

    Repetition

    An 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 choices

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

    ►► cmd_name ABC

    ►◄

    Optional choices

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

    About this publication xv

  • ►► cmd_nameABC

    ►◄

    Repeatable choices

    A 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

    ►◄

    Defaults

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

    ►►A

    cmd_nameBC

    ►◄

    xvi IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • What's new for Version 8.1.2

    IBM Spectrum Protect Version 8.1.2 introduces new features and updates.

    For a list of new features and updates in this release and previous Version 8.1releases, see Backup-archive client updates.

    New and changed information in this product documentation is indicated by avertical bar (|) to the left of the change.

    Protect your client with enhanced security settingsBeginning in IBM Spectrum Protect Version 8.1.2, several changes areintroduced in the backup-archive client to work with the IBM SpectrumProtect V8.1.2 server, which provides enhancements to improve thesecurity between client and server communications.

    After the IBM Spectrum Protect server is upgraded to V8.1.2 andconfigured with the improved security protocol, and the backup-archiveclient is upgraded to V8.1.2, the security settings for the client must beconfigured to work with the security enhancements on the server. For moreinformation about the configuring the client for different security scenarios,see “Configuring the client security settings to connect to the IBMSpectrum Protect server version 8.1.2 and later” on page 101.

    The following changes are available in this release:

    New sslacceptcertfromserv option, changes to three existing SSL-relatedoptions

    To simplify the process of distributing server certificates, IBMSpectrum Protect now includes a new sslacceptcertfromservoption to control whether the backup-archive client or the APIapplication accepts and trusts the IBM Spectrum Protect server'sSecure Sockets Layer (SSL) public certificate the first time theyconnect.

    In addition, three SSL-related options ssl, ssldisablelegacytls,and sslarequired have changed. Their operation varies dependingon whether operation is with IBM Spectrum Protect server V8.1.2or with IBM Spectrum Protect server V8.1.1 and earlier V8 levels,and V7.1.7 and earlier levels.

    For a description of these option settings and important versioninformation, see “Sslacceptcertfromserv” on page 544, “Ssl” onpage 542, “Ssldisablelegacytls” on page 544, and “Sslrequired”on page 546.

    The IBM Spectrum Protect password location is changedBeginning in V8.1.2, the IBM Global Security Kit (GSKit) keystoresare used to store all IBM Spectrum Protect passwords. When youupgrade to IBM Spectrum Protect V8.1.2 backup-archive client, theexisting passwords are automatically migrated to new locations onthe client system.

    For more information about the new password location and relatedconsiderations, see “Secure password storage” on page 106.

    A new way of importing server certificates is available with thedsmcert utility. For information about importing server certificates,

    © Copyright IBM Corp. 1993, 2017 xvii

    http://www.ibm.com/support/knowledgecenter/SSEQVQ_8.1.2/client/r_new_for_version.html

  • see “Configuring IBM Spectrum Protect client/servercommunication with Secure Sockets Layer” on page 36.

    Because of the use of the new secure password storage, newprocedures for granting password access to non-administrativeusers are available.

    For Windows clients, see “Backup-archive client operations andsecurity rights” on page 107.

    Automatically deploy backup-archive client updatesThe IBM Spectrum Protect server administrator can use servercommands to schedule updates for one or more backup-archiveclients. The updates can be fix packs or new releases. This featurewas available in previous releases of IBM Spectrum Protect, but animproved procedure is available for V8.1.2. For more information,see Schedule automatic updates for backup-archive clients.

    Deprecated functionsThe following functions are deprecated in this release:

    lanfreessl and replsslport optionsTwo SSL-related options, lanfreessl and replsslport, aredeprecated and unavailable if you are connecting to anIBM Spectrum Protect server V8.1.2 and later. Theseoptions are still valid and available if you are connecting toan IBM Spectrum Protect server V8.1.1 and earlier V8levels, and V7.1.7 and earlier levels.

    IBM Spectrum Protect web clientYou can no longer use the web client to connect to the IBMSpectrum Protect V8.1.2 or later server. However, you canstill use the web client to connect to IBM Spectrum ProtectV8.1.1, V8.1.0, or V7.1.7 or earlier servers. For moreinformation, see “Using the web client in the new securityenvironment” on page 117.

    NDMP command-line and web client operationsIf you are connecting to IBM Spectrum Protect serverV8.1.2 or later, you can no longer use the clientcommand-line interface or web client to back up or restoreNAS file servers using Network Data ManagementProtocol (NDMP). Alternatively, you can use IBM SpectrumProtect server commands with the administrativecommand-line client (dsmadmc) to restore NDMP data. Formore information, see the NDMP information in “Usingthe web client in the new security environment” on page117.

    Open registrationIf the client is connecting to IBM Spectrum Protect serverV8.1.2 or later, the open registration feature is no longeravailable. To connect to the IBM Spectrum Protect server,you must use closed registration. For more information, see“Closed registration” on page 87.

    Open registration is still available if the client is connectingto IBM Spectrum Protect V8.1.1, V8.1.0, or V7.1.7 andearlier servers.

    xviii IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • For more information about security improvements on the server, seeProtect your storage environment with an improved security protocol.

    Enhanced support for Data Protection for Microsoft Hyper-V running onWindows Server 2016

    Back up virtual machines by using resilient change tracking (RCT)To improve the scalability and performance of virtual machine(VM) backups, resilient change tracking (RCT) is used for all VMbackup operations of Hyper-V hosts that run on the MicrosoftWindows Server 2016 operating system.

    For more information, see Virtual machine backups with resilientchange tracking (RCT).

    Exercise more control over backup operations on VMs with physicaldisks You can control whether full Hyper-V RCT VM backups are

    processed if the VM has one or more physical disks (pass-throughdisks) provisioned.

    For more information, see the following options:v “Vmprocessvmwithphysdisks” on page 610v “Vmskipphysdisks” on page 617

    Specify the number of snapshot attempts and the level of dataconsistency for backup operations

    To determine the total number of snapshot attempts to try for avirtual machine that fails during backup processing due tosnapshot failure, use the INCLUDE.VMSNAPSHOTATTEMPTS option. Youcan choose to attempt application-consistent or crash-consistentsnapshots.

    For more information, see “INCLUDE.VMSNAPSHOTATTEMPTS” on page437.

    Exclude VM disks from or include VM disks in backup operationsYou can use the exclude.vmdisk option to exclude a VM disk(VHDX) from VM backup operations or use the include.vmdiskoption to include a VM disk in VM backup operations.

    For more information, see the following topics:v “Exclude.vmdisk” on page 399v “Include.vmdisk” on page 434v “Domain.vmfull” on page 372v “Backup VM” on page 662

    Enhanced support for Data Protection for Microsoft Hyper-V running onWindows Server 2012 and 2012 R2

    Scalability and reliability of VM backups are improvedVMs are logically grouped into a single snapshot to reduce oreliminate snapshot conflicts at the Hyper-V host level. Improvedsnapshot retry processing simplifies scheduling and improvesreliability across cluster nodes.v To control the number of VMs to include in a snapshot, use the

    vmmaxpersnapshot option. For more information, see“Vmmaxpersnapshot” on page 599.

    Backup-archive client updates xix

    https://www.ibm.com/support/knowledgecenter/SSEQVQ_8.1.2/srv.common/r_techchg_srv_sec_812.htmlhttps://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.hv/c_ve_hv_ovw_rct.htmlhttps://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.hv/c_ve_hv_ovw_rct.html

  • v To control how many snapshot retries are attempted, use thevmmaxsnapshotretry option. For more information, see“Vmmaxsnapshotretry” on page 602.

    Use these grouping and retry improvements along with thevmmaxparallel option to help improve performance.

    For information, see Tuning scheduled VM backups for WindowsServer 2012 and 2012 R2 clusters.

    Enhanced Virtual Volumes (VVOL) supportVVOL support is enhanced to include support for persisted snapshots onthe hardware storage and application protection. For more informationabout new VVOL support features, see IBM Spectrum Protect for VirtualEnvironments: Data Protection for VMware updates.

    To use enhanced VVOL features, use the options that are described in thefollowing sections:

    Specify the location for virtual machine backup and restore operations:local, server, or both

    For virtual machines that are hosted on VVOL datastores, you cannow specify one of the following backup locations for backup andrestore operations: local, server, or both. A local backup is apersisted snapshot on the hardware storage.

    To specify the backup location for the Backup VM or Restore VMcommand, use the vmbackuplocation option. For more information,see “Vmbackuplocation” on page 575.

    You can also specify the backup location or locations to querywhen you run the Query VM command. For more information, see“Query VM” on page 729.

    The Local Backup Management (IBM Spectrum Protect) tags areavailable for local backups. For more information, see “Supporteddata protection tags” on page 792.

    Create a schedule groupYou can use the schedgroup option to create a group that containsmultiple schedules. You can then use the IBM Spectrum ProtectvSphere Client plug-in to assign the schedule group to an object inthe VMware vSphere Web client rather than an individualschedule. An example of the use of this option is to group multipledaily local backup schedules with a single IBM Spectrum Protectserver backup schedule.

    For more information, see “Schedgroup” on page 511.

    Restore multiple virtual disks simultaneouslyYou can use the IBM Spectrum Protect client restore multiple virtual diskssimultaneously on the Microsoft Windows and Linux operating systems byusing the vmmaxrestoreparalleldisks option.

    For instructions about setting the option settings, see“Vmmaxrestoreparalleldisks” on page 601.

    The snapdiffchangelogdir client option is added for snapshot differentialbackup operations

    Snapshot differential backups no longer use the stagingdirectory optionfor storing snapshot differential change log files. Beginning with V8.1.2,

    xx IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    https://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.hv/c_ve_hv_schedclus_hv2012.html#c_ve_hv_schedclus_hv2012https://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.hv/c_ve_hv_schedclus_hv2012.html#c_ve_hv_schedclus_hv2012https://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.user/r_techchg_ve.htmlhttps://www.ibm.com/support/knowledgecenter/SSERB6_8.1.2/ve.user/r_techchg_ve.html

  • use the new snapdiffchangelogdir option to specify the location where theclient stores persistent change logs for snapshot differential backups.

    For a description of the option settings and important information aboutmigrating from prior client versions, see “Snapdiffchangelogdir” on page533.

    Related information:“About this publication” on page xiii

    Backup-archive client updates xxi

  • xxii IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • Chapter 1. Installing the IBM Spectrum Protect backup-archiveclients

    The IBM Spectrum Protect backup-archive client helps you protect information onyour workstations.

    You can maintain backup versions of your files that you can restore if the originalfiles are damaged or lost. You can also archive infrequently used files, preservethem in their current state, and retrieve them when necessary.

    The backup-archive client works in conjunction with the IBM Spectrum Protectserver. Contact your IBM Spectrum Protect server administrator to obtain backupor archive access to the server, or refer to the server publications to install andconfigure the IBM Spectrum Protect server.Related concepts:“What's new for Version 8.1.2” on page xvii“Planning your backups (Windows)” on page 125

    Upgrading the backup-archive clientThe following sections explain what you need to do if you are upgrading to IBMSpectrum Protect backup-archive client Version 8.1.2 from a previous version.

    Upgrade path for clients and serversIBM Spectrum Protect clients and servers can be upgraded at different times. Thecombination of servers and clients that you deploy must be compatible with eachother.

    To prevent disruption of your backup and archive activities while you upgradefrom one release to another, follow the compatibility guidelines for IBM SpectrumProtect clients and servers in technote 1053218.

    Additional upgrade informationWhen you upgrade the backup-archive client, there is additional information toconsider before you use the new client software.

    Be aware of the following information when you upgrade a backup-archive client:v The size of the buffer to record change notifications for a particular journal file

    system (DirNotifyBufferSize) has changed. The default value is 16 KB.v For a list of new and changed messages since the previous IBM Spectrum

    Protect release, see the client_message.chg file in the client package.

    Automatic backup-archive client deploymentThe IBM Spectrum Protect server administrator can automatically deploy abackup-archive client to update workstations where the backup-archive client isalready installed.

    The IBM Spectrum Protect server can be configured to automatically upgradebackup-archive clients on client workstations. The existing backup-archive clientsmust be at version 6.4.3 or later.

    © Copyright IBM Corp. 1993, 2017 1

    http://www.ibm.com/support/docview.wss?uid=swg21053218

  • For more information about automatically deploying client upgrades from theserver, see the following documents:v For IBM Spectrum Protect 8.1.2 or later servers, see technote 2004596.v For IBM Tivoli® Storage Manager V7.1 servers and IBM Spectrum Protect V8.1.0

    and V8.1.1 servers, see technote 1673299.

    Restrictions: The following restrictions apply to automatic client deployment:v The Windows cluster services environment is not supported.v Only the backup-archive client can be deployed from the IBM Spectrum Protect

    server. Other related products such as IBM Spectrum Protect for SpaceManagement, IBM Spectrum Protect HSM for Windows, IBM Spectrum Protectfor Virtual Environments, and other Data Protection products are not supported.If a deployment of an unsupported product is attempted, the deploymentprocess stops with a failure message.

    v Do not schedule automatic client deployments to workstations that already havethe IBM Spectrum Protect for ERP application installed on them.When the server administrator schedules automatic backup-archive clientdeployments, the updated client packages (which include the client componentsand the API library) are installed on the workstations that receive them. Adependency check is performed by the client installation program to ensure thatthe API library does not conflict with the client package that is already installed.IBM Spectrum Protect for ERP applications do not use the same installationtechnology that is used by the client installation program. Therefore, the clientinstallation dependency check is not able to detect whether the API library thatis being used by the IBM Spectrum Protect for ERP applications is compatiblewith the API library that will be installed by automatic client deployments. If aclient package is automatically deployed to and installed on a workstation, theAPI library that is installed might not be compatible with the API library thatwas installed by the IBM Spectrum Protect for ERP application. The newlydeployed API library can cause the IBM Spectrum Protect for ERP applicationsto fail.

    How the autodeploy client option can affect client deployment

    You can use the autodeploy option to conditionally enable automatic clientdeployment, if the deployment does not require a restart of the client workstation.

    By default, the autodeploy option is enabled, and the client workstation is restartedif required.

    To use automatic deployment but not restart the system, specify the autodeploynoreboot option.

    To turn off automatic client deployment, add autodeploy no to the client optionsfile.

    You can set the autodeploy option in the following places:v On a schedule definition on the IBM Spectrum Protect server. Schedule

    definitions that deploy client software updates have an action=deploy statement.On those schedules, you can include the autodeploy option as part of thecommand that you include on the –postnschedulecmd statement.

    v On the client node, in an options file that is associated with the client scheduleror client acceptor. The deployment manager detects options files that areassociated with the scheduler or client acceptor. If multiple scheduler or client

    2 IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    ||

    |

    ||

    ||||||

    http://www.ibm.com/support/docview.wss?uid=swg22004596http://www.ibm.com/support/docview.wss?uid=swg21673299

  • acceptor processes are running on the same computer at the same time, and theprocesses use different options files, the deployment manager uses theautodeploy option value that is set in one of the options files.

    v On the client in the client options file (dsm.opt). The autodeploy option that isset in the client options file overrides any other autodeploy setting.

    Related reference:“Autodeploy” on page 328

    Client environment requirementsEach of the IBM Spectrum Protect clients has hardware and software requirements.

    The following list shows the location of the environment prerequisites for eachsupported platform.v “Windows client environment requirements”v “NDMP support requirements (Extended Edition only)” on page 4

    For current information about the client environment prerequisites for all of thesupported backup-archive client platforms, see technote 1243309.

    Windows client environment requirementsThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the supported Windowsplatforms.

    Windows client installable componentsThe backup-archive client is comprised of several installable components.

    The installable components for the Windows backup-archive client are as follows:v Backup-archive command-line clientv Administrative clientv Backup-archive client graphical user interface, which uses Oracle Java™

    technologyv Backup-archive web clientv IBM Spectrum Protect API (64-bit)

    System requirements for Windows clientsThe backup-archive client on Windows requires a minimum amount of disk spacefor installation and a supported operating system.

    For software and hardware requirements for all supported versions of Windowsclients, including the most recent fix packs, seetechnote 1197133.

    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 Windowsbackup-archive client:

    Chapter 1. Installing the IBM Spectrum Protect backup-archive clients 3

    http://www.ibm.com/support/docview.wss?uid=swg21243309http://www.ibm.com/support/docview.wss?uid=swg21197133

  • Table 1. Windows client communication methods

    To use this communicationmethod:

    Install this software: To connect to these IBMSpectrum Protect servers:

    TCP/IP TCP/IP (Standard with allsupported Windows

    AIX®, Linux, Windows

    Named Pipes Named Pipes (Standard withall supported Windowsplatforms)

    Windows

    Shared Memory TCP/IP (Standard with allsupported Windowsplatforms)

    Windows

    Backup-archive client features that are available on WindowsplatformsThis topic lists which features are supported or not supported on the variousWindows platforms.

    Table 2 shows the supported and unsupported features on the various Windowsplatforms.

    Table 2. Supported features on Windows platforms

    Features Windows 10Windows Server 2012

    Windows Server 2012 R2Windows Server 2016

    Journal-based backup yes yes

    Online image backup yes yes

    Offline image backup yes yes

    System state support with Volume Shadowcopy Services(VSS)

    yes yes

    LAN-free operations yes yes

    Automated System Recovery (ASR) yes BIOS: yes

    UEFI: yes

    Open File Support (OFS) yes yes

    Windows supported file systemsThe IBM Spectrum Protect Windows backup-archive client is supported on specificfile systems.

    The Windows backup-archive client supports the following types of file systems:v File Allocation Table (FAT and FAT32)v Microsoft New Technology File System (NTFS)v Microsoft Resilient File System (ReFS). ReFS was introduced on Windows Server

    2012 systems.

    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 Spectrum Protect Extended Edition.

    4 IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • NDMP support requires the following hardware and software:v IBM Spectrum Protect Extended Editionv Tape drive and tape library. For supported combinations, go to: product

    information

    Installation requirements for backing up and archiving Tivoli StorageManager FastBack client data

    Before 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 V6.1.3.x (where x is 1 or higher) or V6.2 or laterv Tivoli Storage Manager server V6.1.3 or higherv Tivoli Storage Manager Administration Center V6.1.3

    – Required only if you want to use integrated Tivoli Storage Manager FastBack- administration.Starting with V7.1, the Administration Center component is no longerincluded in Tivoli Storage Manager or IBM Spectrum Protect distributions.FastBack users who have an Administration Center from a previous serverrelease, can continue to use it to create and modify FastBack schedules. If youdo not already have an Administration Center installed, you can downloadthe previously-released version from ftp://public.dhe.ibm.com/storage/tivoli-storage-management/maintenance/admincenter/v6r3/. If you do not alreadyhave an Administration Center installed, you must create and modifyFastBack schedules on the IBM Spectrum Protect server. For informationabout creating schedules on the server, see the IBM Spectrum Protect serverdocumentation.

    The Tivoli Storage Manager FastBack environment must be running. Forinformation about installing and setting up Tivoli Storage Manager FastBack, seethe product information at Tivoli Storage Manager FastBack.

    For information about integrating IBM Spectrum Protect and Tivoli StorageManager FastBack, see Integrating Tivoli Storage Manager FastBack and IBMSpectrum Protect.

    You can install the IBM Spectrum Protect client in one of the following ways:v Install the backup-archive client on a workstation where the FastBack server is

    installed. In this case, the prerequisites are: the FastBack server, the FastBackshell, and the FastBack mount.

    v Install the backup-archive client on a workstation where the FastBack DisasterRecovery Hub is installed. In this case, the prerequisites are: the FastBackDisaster Recovery Hub setup, the FastBack shell, and the FastBack mount.

    v Install the backup-archive client on a workstation where neither the FastBackserver or the FastBack Disaster Recovery Hub is installed. In this case, ensurethat 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 63

    Chapter 1. Installing the IBM Spectrum Protect backup-archive clients 5

    http://www.ibm.com/software/products/spectrum-protect-familyhttp://www.ibm.com/software/products/spectrum-protect-familyftp://public.dhe.ibm.com/storage/tivoli-storage-management/maintenance/admincenter/v6r3/ftp://public.dhe.ibm.com/storage/tivoli-storage-management/maintenance/admincenter/v6r3/http://www.ibm.com/support/knowledgecenter/SS9NU9/http://www.ibm.com/support/knowledgecenter/SSGSG7_6.4.0/com.ibm.itsm.srv.fbint.doc/t_fbint.htmlhttp://www.ibm.com/support/knowledgecenter/SSGSG7_6.4.0/com.ibm.itsm.srv.fbint.doc/t_fbint.html

  • Client configuration wizard for Tivoli Storage Manager FastBackThe backup-archive client provides a wizard to configure the backup-archive clientfor 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 IBM Spectrum Protect server on a scheduled basis.Related concepts:“Configuring the backup-archive client to protect FastBack client data” on page 64

    Windows backup-archive client installation overviewYou can install the IBM Spectrum Protect Windows backup-archive client from theinstallation media.

    Before you begin

    Before you begin a Windows client installation, ensure that the system that youwant to install the client on meets the client requirements. Then, determine thetype of installation that you need to perform, and follow the steps in theappropriate procedure.

    For the hardware and software requirements for the Windows client, see technote1197133.Related concepts:“Automatic backup-archive client deployment” on page 1Related tasks:“Creating and modifying the client options file” on page 23“Starting a web client session” on page 117

    Windows 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:v An automatic client deployment pushes a client upgrade to a node, and the

    client or the scheduler sets the AUTODEPLOY=NOREBOOT option.v A manual installation or upgrade of the client is started.v A client silent installation is started, even if the options to suppress reboot

    prompts, 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++ redistributable

    6 IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

    http://www.ibm.com/support/docview.wss?uid=swg21197133http://www.ibm.com/support/docview.wss?uid=swg21197133

  • package is installed. Monitor other applications after the client is installed to seewhether there are any applications that were stopped and not restarted.

    Installation proceduresThe procedure that you follow to install the IBM Spectrum Protect Windowsbackup-archive client depends on the type of installation that you want to perform.

    Procedures are provided for each of the following installation types:

    Installation type Installation description

    Installing the Windows client for the firsttime

    Describes how to install the Windowsbackup-archive client for the first time. Thisprocedure presumes that the Windowscomputer that you are installing the clienton has never had a previous version of theclient installed on it before.

    Upgrading the Windows client Describes how to upgrade an earlier versionof the Windows backup-archive client to thislatest version.

    Reinstalling the Windows client Describes how to reinstall the Windowsbackup-archive client, if you uninstalled it.

    Silent installation Describes how to install the Windowsbackup-archive client silently, without userinteraction during the installation procedure.

    Repairing, modifying, or uninstalling theWindows client

    Describes how to add or remove featuresfrom an installed backup-archive client(modify), replace damaged files or missingregistry keys (repair), or uninstall theWindows backup-archive client.

    Installing the Windows client for the first timeComplete this procedure to install the Windows backup-archive client for the firsttime.

    Before you begin

    If you have an earlier version of the Windows backup-archive client that is alreadyinstalled on a node and you want to upgrade it to Version 8.1.2, see “Upgradingthe Windows client” on page 11.

    Important: You must know the host name or IP address of the IBM SpectrumProtect 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 IBM SpectrumProtect server administrator before you start this procedure.

    Procedure1. Download the appropriate package file from one of the following websites.v Download the client package from Passport Advantage or Fix Central.v For the latest information, updates, and maintenance fixes, go to the IBM

    Support Portal.2. Install the product by using the compressed installation file that you

    download from Passport Advantage®.

    Chapter 1. Installing the IBM Spectrum Protect backup-archive clients 7

    http://www.ibm.com/software/passportadvantage/http://www.ibm.com/support/fixcentral/http://www.ibm.com/support/entry/portal/supporthttp://www.ibm.com/support/entry/portal/support

  • a. Copy the downloaded compressed installation package to a local disk or toa network-accessible share. Be sure to extract the installation files to anempty directory.

    b. To extract the installation files to the same directory, double-click thecompressed installation package.

    c. By default, the uncompressed files are stored in the current disk drive, inthe download_directory\TSMClient directory. If the installation programdetects files from another client installation attempt in this directory, youare prompted about whether to overwrite the old files. If you receive thisprompt, enter A to overwrite the existing files; this selection ensures thatonly the files from the current installation are used.

    d. Double-click the spinstall.exe file to start the client installation program.3. Select a language to use for this installation and click OK.4. If the installation wizard indicates that one or more Microsoft C++

    redistributable files must be installed, click Install. These files are needed torun the Windows client.

    5. On the IBM Spectrum Protect client welcome screen, click Next to begininstalling the client software.

    6. Accept the default installation directory by clicking Next, or specify a differentinstallation directory. The default installation directory is C:\ProgramFiles\Tivoli\TSM.

    7. Select the installation type: Typical or Custom.

    Option Description

    Typical A typical installation installs the followingcomponents:

    v The backup-archive client GUI files(needed to use the Java GUI)

    v The backup-archive client web files(needed to use the web client)

    v The client API files (as needed by yourclient and operating system)

    Custom A custom installation installs the same filesas a typical installation. However, you canchoose to install the following optionalcomponents:

    v The API SDK files (only needed if you aredeveloping applications that work withthe backup-archive client

    v The Administrative Client command-linefiles (required to remotely runadministrator functions on the IBMSpectrum Protect server

    8. Click Next, then click Install.9. When the installer completes the installation, click Finish.

    10. Verify the installation. Click Start > All Programs > IBM Spectrum Protect.The client components that you installed are shown in the list of IBMSpectrum Protect 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 the

    8 IBM Spectrum Protect for Windows Backup-Archive Clients: Installation and User's Guide

  • administrative command-line client. If you installed other components, suchas the API Runtime and SDK, they are not shown in this list.

    11. Click Backup-Archive GUI to start the client GUI. The Client Options FileConfiguration Wizard starts. Click Next to start the wizard.

    12. On the Options File Task screen, select Create a new options file and clickNext.

    13. On the Client Node Name screen, specify a node name. A node nameuniquely identifies your node to the IBM Spectrum Protect server. The defaultnode name is the short host name of the Windows computer that you areinstalling the client on. Accept the default node name or specify a new nodename. Click Next.

    14. On the IBM Spectrum Protect Client/Server Communications screen, specifythe communications method to use when the client communicates with theserver and click Next. This information must be provided to you by your IBMSpectrum Protect server administrator. If you are not sure what to select,accept the default setting (TCP/IP). If the default setting does not work whenthe client attempts to connect to the server, contact the server administrator todetermine which communications method to specify.

    15. On the TCP/IP Options screen, specify the server address and portinformation that your IBM Spectrum Protect administrator provided to you. Inthe Server Address field, specify the IP address or fully qualified domainname of the IBM Spectrum Protect server. In the Port Number field, specifythe port number that the server listens on for client communications. Thedefault port number is 1500. Click Next.

    16. 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 andCtrl 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 wantto. Click Next.

    17. 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 selected. You can modify these extensions later ifyou want to. Click Next.

    18. The Domains for Backup screen specifies the default file systems and objectsto include in client operations for incremental and image backups.a. To configure the default file systems for incremental backups, in the

    Backup Type field, select Incremental. 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 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. To configure the default file systems for image backups, in the BackupType field, select Image. By default, Back up all local file systems isselected. If you do not want to back up all local file systems as the default

    Chapter 1. Installing the IBM Spectrum Protect backup-archive clients 9

  • action during image backups, clear this option and individually select thefile systems to include. You can override the default selection when youinitiate an image backup operation.

    c. Click Next.19. On the Confirm and apply