IBM Spectrum Protect for UNIX and Linux Backup-Archive ... · IBM Spectrum Protect for UNIX and Linux Backup-Archive Clients V ersion 8.1.0 Installa tion and User's Guide IBM

IBM Spectrum Protect for UNIX and LinuxBackup-Archive ClientsVersion 8.1.0

Installation and User's Guide

IBM

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

This edition applies to version 8, release 1, modification 0 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, 2016.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 . . . . . . . . . . . . . . xivConventions used in this publication . . . . . xivReading syntax diagrams . . . . . . . . . xiv

What's new for Version 8.1 . . . . . 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 . . 2

Client environment requirements . . . . . . . 4AIX client environment . . . . . . . . . . 4

AIX client installable components . . . . . 5System requirements for the AIX client . . . 5AIX client communication methods . . . . . 5Backup-archive client features that are availableon AIX . . . . . . . . . . . . . . 5

HP-UX Itanium 2 API environment . . . . . . 5HP-UX Itanium 2 API installable component . 6System requirements for the HP-UX Itanium 2API . . . . . . . . . . . . . . . 6HP-UX Itanium 2 API communication methods 6

Linux on Power Systems client environment . . . 6Linux on Power Systems client installablecomponents. . . . . . . . . . . . . 6System requirements for clients on Linux onPower Systems . . . . . . . . . . . 6Linux on Power Systems client communicationmethods . . . . . . . . . . . . . . 6

Linux x86_64 client environment. . . . . . . 7Linux x86_64 client installable components . . 7System requirements for Linux x86_64 clients . 7Linux x86_64 client communication methods . 7

Linux on System z client environment . . . . . 8Linux on System z client installablecomponents. . . . . . . . . . . . . 8System requirements for Linux on System zclients . . . . . . . . . . . . . . 8Linux on System z client communicationmethods . . . . . . . . . . . . . . 8

Mac OS X client environment . . . . . . . . 8Mac OS X client installable components . . . 8System requirements for Mac OS X clients . . 9Mac OS X client communication methods. . . 9

Oracle Solaris client environment . . . . . . 9Oracle Solaris client installable components . . 9System requirements for Oracle Solaris clients 9Oracle Solaris client communication methods 10

NDMP support requirements (Extended Editiononly) . . . . . . . . . . . . . . . . 10Installation requirements for backing up andarchiving Tivoli Storage Manager FastBack clientdata . . . . . . . . . . . . . . . . . 10Install the UNIX and Linux backup-archive clients 11

Installing the AIX client . . . . . . . . . 11Uninstalling the AIX client . . . . . . . . 14Installing the HP-UX Itanium 2 API . . . . . 15

Increasing the default limit of the datasegment size . . . . . . . . . . . . 16

Uninstalling the HP-UX Itanium 2 API . . . . 17Installing the backup-archive client on Linux onPower Systems (Little Endian) . . . . . . . 17Uninstalling the backup-archive client on Linuxon Power Systems (Little Endian) . . . . . . 19Installing the backup-archive client on UbuntuLinux on Power Systems (Little Endian) . . . . 20Uninstalling the client on Ubuntu Linux onPower Systems (Little Endian) . . . . . . . 22Installing the API on Linux on Power Systems(Big Endian) . . . . . . . . . . . . . 22Uninstalling the API on Linux on Power Systems(Big Endian) . . . . . . . . . . . . . 24Installing the Linux x86_64 client . . . . . . 25Uninstalling the Linux x86_64 client . . . . . 28Installing the Ubuntu Linux x86_64 client . . . 30Uninstalling the Ubuntu Linux x86_64 client . . 32Installing the Linux on System z client . . . . 33Uninstalling the Linux on System z client . . . 36Installing the Mac OS X client . . . . . . . 38Uninstalling the Mac OS X client . . . . . . 39Installing the Oracle Solaris client . . . . . . 40Uninstalling the Oracle Solaris client . . . . . 42Software updates . . . . . . . . . . . 43

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

Chapter 2. Configure the IBM SpectrumProtect client . . . . . . . . . . . . 45UNIX and Linux client root and authorized usertasks. . . . . . . . . . . . . . . . . 45Enable non-administrators to manage their owndata . . . . . . . . . . . . . . . . . 47

Restricting IBM Spectrum Protect access to a usergroup . . . . . . . . . . . . . . . 48Enabling encryption for backup-archive clientusers . . . . . . . . . . . . . . . 48

Client options file overview . . . . . . . . . 49Creating and modifying the client system-optionsfile . . . . . . . . . . . . . . . . 51Creating a default client-user options file . . . 53Creating a customized client user-options file . . 54

Environment variables. . . . . . . . . . . 55Set language environment variables . . . . . 55

© Copyright IBM Corp. 1993, 2016 iii

Set processing environment variables . . . . . 56Set Bourne and Korn shell variables . . . . . 58Set C shell variables . . . . . . . . . . 58Set API environment variables . . . . . . . 59

Web client configuration overview. . . . . . . 59Configuring the web client on AIX, Linux, Mac,and Solaris systems. . . . . . . . . . . 60

Configuring the scheduler . . . . . . . . . 60Comparison between client acceptor-managedservices and traditional scheduler services . . . 61Configuring the client to use the client acceptorservice to manage the scheduler . . . . . . 62

Start the client scheduler . . . . . . . . . . 63Scheduling events using the command-line client 63

Configuring IBM Spectrum Protect client/servercommunication across a firewall . . . . . . . 65Configuring IBM Spectrum Protect client/servercommunication with Secure Sockets Layer . . . . 67

Certificate Authorities root certificates . . . . 70Configure your system for journal-based backup . . 71

Journal daemon configuration . . . . . . . 71JournalSettings stanza . . . . . . . . . 72JournalExcludeList stanza . . . . . . . 73JournaledFileSystemSettings stanza . . . . 74Overriding stanzas . . . . . . . . . . 76

Client-side data deduplication . . . . . . . . 77Configuring the client for data deduplication . . 81Excluding files from data deduplication . . . . 83

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

Requirements for automated client failover . . 85Restrictions for automated client failover . . 86Failover capabilities of IBM Spectrum Protectcomponents . . . . . . . . . . . . 87

Configuring the client for automated failover . . 87Determining the status of replicated client data 89Preventing automated client failover . . . . . 90Forcing the client to fail over . . . . . . . 91

Configuring the client to back up and archive TivoliStorage Manager FastBack data . . . . . . . . 91Cluster environment configuration and use . . . . 93

Overview of cluster environments . . . . . . 93Active/Active: Pool cluster resources . . . . 93Active/Passive: Fault tolerant . . . . . . 93Concurrent access . . . . . . . . . . 93

Configuring the backup-archive client in a clusterenvironment . . . . . . . . . . . . . 93Enabling web client access in a ClusterEnvironment . . . . . . . . . . . . . 99Migrating legacy AIXIBM PowerHASystemMirror setups . . . . . . . . . . 101

AIX configuration considerations prior toperforming snapshot-based file backups andarchives . . . . . . . . . . . . . . . 102Configuring NetApp and IBM Spectrum Protect forsnapshot difference incremental backups . . . . 103

Protecting clustered-data ONTAP NetApp fileserver volumes . . . . . . . . . . . . 104SnapMirror support for NetAppsnapshot-assisted progressive incrementalbackup (snapdiff) . . . . . . . . . . . 107

Register your workstation with a server . . . . 110Closed registration. . . . . . . . . . . 111Open registration . . . . . . . . . . . 111

Creating an include-exclude list . . . . . . . 112Include-exclude options . . . . . . . . . 113

Exclude file spaces and directories . . . . 113Exclude files and directories from ajournal-based backup . . . . . . . . . 114Control processing with exclude statements 114System files to exclude . . . . . . . . 116Include and exclude files that containwildcard characters . . . . . . . . . 117Include and exclude groups of files withwildcard characters . . . . . . . . . 117Examples using wildcards with include andexclude patterns . . . . . . . . . . 118

Symbolic link and alias processing . . . . . 120Determine compression and encryptionprocessing . . . . . . . . . . . . . 120Preview include-exclude list files . . . . . . 121Include and exclude option processing . . . . 121

Chapter 3. Getting started . . . . . . 125IBM Spectrum Protect client authentication . . . 125Starting a Java GUI session . . . . . . . . . 126

IBM Spectrum Protect password . . . . . . 127Setup wizard . . . . . . . . . . . . 127

Starting a command-line session . . . . . . . 127Using batch mode . . . . . . . . . . . 128Issuing a series of commands by usinginteractive mode . . . . . . . . . . . 128

Specifying input strings that contain blank spacesor quotation marks . . . . . . . . . . . 129Starting: Additional considerations . . . . . . 130Starting a web client session . . . . . . . . 130

User privileges . . . . . . . . . . . . 131Start the client scheduler automatically . . . . . 131Changing your password . . . . . . . . . 132Sorting file lists using the backup-archive clientGUI . . . . . . . . . . . . . . . . 133Displaying online help . . . . . . . . . . 134Ending a session . . . . . . . . . . . . 135Online forums . . . . . . . . . . . . . 135

Chapter 4. Backing up your data . . . 137Planning your backups . . . . . . . . . . 137Which files are backed up . . . . . . . . . 137When to back up and when to archive files . . . 138Pre-backup considerations (UNIX and Linux). . . 139

LAN-free data movement . . . . . . . . 139LAN-free prerequisites . . . . . . . . 139LAN-free data movement options . . . . 139

Incremental backups on memory-constrainedsystems . . . . . . . . . . . . . . 140Incremental backups on systems with a largenumber of files . . . . . . . . . . . . 140Include-exclude options to control processing 142Data encryption during backup or archiveoperations . . . . . . . . . . . . . 142File system and ACL support . . . . . . . 143

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

Maximum file size for operations. . . . . . 146Long user and group names . . . . . . . 147Mac OS X volume names . . . . . . . . 147

Mac OS X volume naming precautions . . . 147Mac OS X volume naming precautions ondual boot systems . . . . . . . . . . 148

Mac OS X Unicode enablement . . . . . . 149Mac OS X Time Machine backup disk . . . . 149

Performing an incremental, selective, orincremental-by-date backup (UNIX and Linux) . . 150

Full and partial incremental backup . . . . . 150Journal-based backup on AIX and Linux . . 152

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

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

Selective backup . . . . . . . . . . . 157Solaris global zone and non-global zonesbackups . . . . . . . . . . . . . . 158Saving access permissions . . . . . . . . 158Setting a virtual mount point . . . . . . . 158Backing up data using the Java GUI . . . . . 159Backing up data using the command line . . . 160Deleting backup data . . . . . . . . . . 162Deleting file spaces . . . . . . . . . . 163

Backing up files from one or more file spaces for agroup backup (UNIX and Linux) . . . . . . . 164Backing up data with client-node proxy support(UNIX and Linux) . . . . . . . . . . . . 164

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

Examples of how to schedule a backup of anIBM PowerHA SystemMirror cluster. . . . 167Scheduling a backup of a GPFS file system 169

Associate a local snapshot with a server file space(UNIX and Linux) . . . . . . . . . . . . 170Image backup . . . . . . . . . . . . . 170

Performing prerequisite tasks before creating animage backup . . . . . . . . . . . . 171

Volume device type support for an imagebackup . . . . . . . . . . . . . 172

Utilizing image backups to perform file systemincremental backups . . . . . . . . . . 174

Method 1: Using image backups with filesystem incremental backups . . . . . . 174Method 2: Using image backups withincremental-by-date image backups . . . . 175Comparing methods 1 and 2 . . . . . . 175

Performing an image backup using the GUI . . 176Performing an image backup using thecommand line . . . . . . . . . . . . 177

Snapshot-based file backup and archive andsnapshot-based image backup . . . . . . . . 178Protecting Btrfs file systems . . . . . . . . 179

Backing up and restoring Btrfs file systems . . 179Backing up and restoring Btrfs subvolumes . . 181

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

Backing up NAS file systems with the webclient GUI using NDMP protocol . . . . . . 183Back up NAS file systems using the commandline. . . . . . . . . . . . . . . . 184

Backup network file systems . . . . . . . . 186Back up NFS file systems with the globalnamespace feature. . . . . . . . . . . 186

Back up AIX workload partition file systems . . . 187Backing up Solaris Zettabyte file systems . . . . 188AIX JFS2 encrypted file system backup . . . . . 189Back up AIX JFS2 extended attributes . . . . . 190Backing up VMware virtual machines . . . . . 191

Preparing the environment for full backups ofVMware virtual machines . . . . . . . . 192Creating full backups for VMware virtualmachines . . . . . . . . . . . . . . 193Parallel backups of virtual machines. . . . . 194

Back up and archive Tivoli Storage ManagerFastBack data . . . . . . . . . . . . . 194Display backup processing status. . . . . . . 195Backup (UNIX and Linux): Additionalconsiderations . . . . . . . . . . . . . 198

Stored files . . . . . . . . . . . . . 198Special file systems . . . . . . . . . . 199NFS or virtual mount points . . . . . . . 199Management classes . . . . . . . . . . 199Back up symbolic links . . . . . . . . . 199

Examples: Incremental or selective backup ofsymbolic links . . . . . . . . . . . 200Incremental backup of a domain only . . . 201

Hard links . . . . . . . . . . . . . 202Sparse files . . . . . . . . . . . . . 202NFS hard and soft mounts . . . . . . . . 202Deleted file systems . . . . . . . . . . 203Opened files. . . . . . . . . . . . . 203Wildcard characters . . . . . . . . . . 204

Chapter 5. Restoring your data . . . . 207Restoring an image . . . . . . . . . . . 207

Restoring an image using the GUI . . . . . 208Restoring an image using the command line . . 210

Restore data from a backup set . . . . . . . 210Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 212Backup set restore . . . . . . . . . . . 213Restoring backup sets using the GUI . . . . 214Backup set restores using the clientcommand-line interface . . . . . . . . . 215

Restoring or retrieving data during a failover. . . 215Restore an image to file . . . . . . . . . . 217Manage GPFS file system data with storage pools 217Restoring data to a point in time . . . . . . . 218Restore AIX encrypted files. . . . . . . . . 220Restore AIX workload partition file systems . . . 220Restore NAS file systems . . . . . . . . . 222

Restoring NAS file systems using the web client 222

Contents v

Options and commands to restore NAS filesystems from the command line . . . . . . 223

Restore active or inactive backups . . . . . . 224Restoring data using the GUI . . . . . . . . 225Command line restore examples . . . . . . . 225

Examples: Command line restores for largeamounts of data . . . . . . . . . . . 227Standard query restore, no-query restore, andrestartable restore . . . . . . . . . . . 227

Standard query restore process . . . . . 228No-query restore process . . . . . . . 228Restartable restore process . . . . . . . 229

Restoring Solaris Zettabyte (ZFS) file systems . . 229Additional restore tasks . . . . . . . . . . 230

Authorizing another user to restore or retrieveyour files . . . . . . . . . . . . . . 230Restoring or retrieving files from another clientnode . . . . . . . . . . . . . . . 231Restore or retrieve files to another workstation 232Restoring a disk in case of disk loss . . . . . 232Deleting file spaces . . . . . . . . . . 233Enable SELinux to restore files on the Red HatEnterprise Linux 5 client . . . . . . . . 234

Chapter 6. Archive and retrieve yourdata (UNIX and Linux). . . . . . . . 235Archive files. . . . . . . . . . . . . . 235

Archiving data with the GUI . . . . . . . 235Archive data examples by using the commandline. . . . . . . . . . . . . . . . 236

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

Archiving data with client node proxy . . . . 237Deleting archive data . . . . . . . . . . 239Advanced archive tasks . . . . . . . . . 240

Access permissions . . . . . . . . . 240Archive and retrieve symbolic links . . . . 240Hard links . . . . . . . . . . . . 241

Retrieve archives . . . . . . . . . . . . 241Retrieving data with the GUI . . . . . . . 242Retrieve data examples by using the commandline. . . . . . . . . . . . . . . . 242Archive management classes . . . . . . . 243

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

Evaluate schedule return codes in schedulescripts . . . . . . . . . . . . . . . 248Return codes from preschedulecmd andpostschedulecmd scripts . . . . . . . . . 249

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

Display information about completed work . . . 254Specify scheduling options . . . . . . . . . 255Scheduler options for commands . . . . . . . 255Enable or disable scheduled commands . . . . 255Manage multiple schedule requirements on onesystem . . . . . . . . . . . . . . . 256

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 . . . . . . . 264Copy serialization attribute . . . . . . . . 265Copy mode parameter . . . . . . . . . 265Copy destination attribute . . . . . . . . 266Retain versions attribute. . . . . . . . . 266Deduplicate data attribute . . . . . . . . 266

Select a management class for files . . . . . . 266Assign 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. Processing options . . . 273Processing options overview . . . . . . . . 273Communication options . . . . . . . . . . 274

TCP/IP options . . . . . . . . . . . 274Shared memory options . . . . . . . . . 275

Server options . . . . . . . . . . . . . 275Backup and archive processing options . . . . . 276Restore and retrieve processing options. . . . . 285Scheduling options . . . . . . . . . . . 288Format and language options . . . . . . . . 289Command processing options . . . . . . . . 290Authorization options . . . . . . . . . . 290Error processing options. . . . . . . . . . 291Transaction processing options . . . . . . . 291Web client options. . . . . . . . . . . . 292Diagnostics options . . . . . . . . . . . 292Using options with commands . . . . . . . 293

Entering options with a command . . . . . 293Initial command-line-only options . . . . . 299Client options that can be set by the IBMSpectrum Protect server . . . . . . . . . 300

Client options reference . . . . . . . . . . 302Absolute . . . . . . . . . . . . . . 302

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

Afmskipuncachedfiles . . . . . . . . . 303Archmc . . . . . . . . . . . . . . . 304Archsymlinkasfile . . . . . . . . . . 305Asnodename . . . . . . . . . . . . . 305

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

Auditlogging . . . . . . . . . . . . 307Auditlogname . . . . . . . . . . . . 309Autodeploy . . . . . . . . . . . . . 311Autofsrename . . . . . . . . . . . . 312Automount . . . . . . . . . . . . . 314Backmc . . . . . . . . . . . . . . . 315Backupsetname . . . . . . . . . . . . 315Basesnapshotname . . . . . . . . . . . 316Cadlistenonport . . . . . . . . . . . 318Changingretries . . . . . . . . . . . 319Class . . . . . . . . . . . . . . . 319Collocatebyfilespec . . . . . . . . . . 320Commmethod . . . . . . . . . . . . . 321Commrestartduration . . . . . . . . . . 323Commrestartinterval . . . . . . . . . . 323Compressalways . . . . . . . . . . . . 324Compression . . . . . . . . . . . . . 325Console . . . . . . . . . . . . . . 327Createnewbase . . . . . . . . . . . . 328Datacenter . . . . . . . . . . . . . 329Datastore . . . . . . . . . . . . . 330Dateformat . . . . . . . . . . . . . 330Dedupcachepath . . . . . . . . . . . . 334Dedupcachesize . . . . . . . . . . . . 334Deduplication . . . . . . . . . . . . 335Defaultserver . . . . . . . . . . . . 336Deletefiles . . . . . . . . . . . . . 337Description . . . . . . . . . . . . . 338Detail . . . . . . . . . . . . . . . 339Diffsnapshot . . . . . . . . . . . . 340Diffsnapshotname . . . . . . . . . . . 341Dirmc . . . . . . . . . . . . . . . 342Dirsonly . . . . . . . . . . . . . . 343Disablenqr . . . . . . . . . . . . . 344Diskbuffsize . . . . . . . . . . . . 345Diskcachelocation . . . . . . . . . . 345Domain . . . . . . . . . . . . . . . 347Domain.image . . . . . . . . . . . . 351Domain.nas . . . . . . . . . . . . . 352Domain.vmfull . . . . . . . . . . . . 353Dontload . . . . . . . . . . . . . . 360Dynamicimage . . . . . . . . . . . . 361Efsdecrypt . . . . . . . . . . . . . 362Enablearchiveretentionprotection . . . . . 363Enablededupcache . . . . . . . . . . . 364Enableinstrumentation . . . . . . . . . 365Enablelanfree . . . . . . . . . . . . 367Encryptiontype . . . . . . . . . . . . 368Encryptkey . . . . . . . . . . . . . 369Errorlogmax . . . . . . . . . . . . . 371Errorlogname . . . . . . . . . . . . 373Errorlogretention . . . . . . . . . . 373Exclude options . . . . . . . . . . . 375

Controlling symbolic link and aliasprocessing . . . . . . . . . . . . 378

Controlling compression processing . . . . 378Processing NAS file systems . . . . . . 379Virtual machine exclude options . . . . . 379

Fbbranch . . . . . . . . . . . . . . 381Fbclientname . . . . . . . . . . . . 382Fbpolicyname . . . . . . . . . . . . 383Fbreposlocation . . . . . . . . . . . 385Fbserver . . . . . . . . . . . . . . 386Fbvolumename . . . . . . . . . . . . 387Filelist . . . . . . . . . . . . . . 388Filename . . . . . . . . . . . . . . 391Filesonly . . . . . . . . . . . . . 392Followsymbolic . . . . . . . . . . . . 393Forcefailover . . . . . . . . . . . . 394Fromdate . . . . . . . . . . . . . . 395Fromnode . . . . . . . . . . . . . . 396Fromowner . . . . . . . . . . . . . 397Fromtime . . . . . . . . . . . . . . 397Groupname . . . . . . . . . . . . . 398Groups (deprecated) . . . . . . . . . . 399Host . . . . . . . . . . . . . . . 399Httpport . . . . . . . . . . . . . . 399Hsmreparsetag . . . . . . . . . . . . 400Ieobjtype . . . . . . . . . . . . . 401Ifnewer . . . . . . . . . . . . . . 402Imagegapsize . . . . . . . . . . . . 403Imagetofile . . . . . . . . . . . . . 404Inactive . . . . . . . . . . . . . . 404Inclexcl . . . . . . . . . . . . . . 405

Considerations for Unicode-enabled clients 406Include options. . . . . . . . . . . . 406

Controlling symbolic link and aliasprocessing . . . . . . . . . . . . 412Compression and encryption backupprocessing . . . . . . . . . . . . 412Processing NAS file systems . . . . . . 412Virtual machine include options . . . . . 413

Incrbydate . . . . . . . . . . . . . 421Incremental . . . . . . . . . . . . . 422Instrlogmax . . . . . . . . . . . . . 423Instrlogname . . . . . . . . . . . . 424Lanfreecommmethod . . . . . . . . . . 425Lanfreeshmport . . . . . . . . . . . . 426Lanfreetcpport . . . . . . . . . . . . 427Lanfreessl . . . . . . . . . . . . . 428Lanfreetcpserveraddress . . . . . . . . 429Latest . . . . . . . . . . . . . . . 430Localbackupset . . . . . . . . . . . . 430Makesparsefile . . . . . . . . . . . . 431Managedservices . . . . . . . . . . . 432Maxcmdretries . . . . . . . . . . . . 434Mbobjrefreshthresh . . . . . . . . . . 435Mbpctrefreshthresh . . . . . . . . . . 436Memoryefficientbackup . . . . . . . . . 437Mode . . . . . . . . . . . . . . . 438Monitor . . . . . . . . . . . . . . 441Myreplicationserver . . . . . . . . . . 442Nasnodename . . . . . . . . . . . . . 444Nfstimeout . . . . . . . . . . . . . 445Nodename . . . . . . . . . . . . . . 446Nojournal . . . . . . . . . . . . . 447

Contents vii

Noprompt . . . . . . . . . . . . . . 448Nrtablepath . . . . . . . . . . . . . 448Numberformat . . . . . . . . . . . . 449Optfile . . . . . . . . . . . . . . 451Password . . . . . . . . . . . . . . 452Passwordaccess . . . . . . . . . . . . 454Passworddir . . . . . . . . . . . . . 455Pick . . . . . . . . . . . . . . . 456Pitdate . . . . . . . . . . . . . . 457Pittime . . . . . . . . . . . . . . 458Postschedulecmd/Postnschedulecmd . . . . . 459Postsnapshotcmd . . . . . . . . . . . 460Preschedulecmd/Prenschedulecmd . . . . . 462Preservelastaccessdate . . . . . . . . . 463Preservepath . . . . . . . . . . . . 464Presnapshotcmd . . . . . . . . . . . . 467Queryschedperiod . . . . . . . . . . . 468Querysummary . . . . . . . . . . . . 469Quiet . . . . . . . . . . . . . . . 470Quotesareliteral . . . . . . . . . . . 471Removeoperandlimit . . . . . . . . . . 472Replace . . . . . . . . . . . . . . 473Replserverguid . . . . . . . . . . . . 474Replservername . . . . . . . . . . . . 476Replsslport . . . . . . . . . . . . . 477Repltcpport . . . . . . . . . . . . . 479Repltcpserveraddress . . . . . . . . . 481Resourceutilization . . . . . . . . . . 483

Regulating backup and archive sessions . . 483Regulating restore sessions . . . . . . . 484Multiple client session considerations . . . 484

Retryperiod . . . . . . . . . . . . . 485Revokeremoteaccess . . . . . . . . . . 486Schedcmddisabled . . . . . . . . . . . 487Schedcmdexception . . . . . . . . . . 488Schedlogmax . . . . . . . . . . . . . 488Schedlogname . . . . . . . . . . . . 490Schedlogretention . . . . . . . . . . 491Schedmode . . . . . . . . . . . . . 493Schedrestretrdisabled . . . . . . . . . 494Scrolllines . . . . . . . . . . . . . 495Scrollprompt . . . . . . . . . . . . 496Servername . . . . . . . . . . . . . 497Sessioninitiation . . . . . . . . . . 498Shmport . . . . . . . . . . . . . . 500Showmembers . . . . . . . . . . . . . 501Skipacl . . . . . . . . . . . . . . 501Skipaclupdatecheck . . . . . . . . . . 502Snapdiff . . . . . . . . . . . . . . 503Snapdiffhttps . . . . . . . . . . . . 507Snapshotcachesize . . . . . . . . . . 509Snapshotproviderfs . . . . . . . . . . 510Snapshotproviderimage . . . . . . . . . 510Snapshotroot . . . . . . . . . . . . 511Srvoptsetencryptiondisabled . . . . . . . 514Srvprepostscheddisabled . . . . . . . . 514Srvprepostsnapdisabled . . . . . . . . . 515Ssl . . . . . . . . . . . . . . . . 516Sslfipsmode . . . . . . . . . . . . . 517Sslrequired . . . . . . . . . . . . . 518Ssldisablelegacytls . . . . . . . . . . 520

Stagingdirectory . . . . . . . . . . . 521Subdir . . . . . . . . . . . . . . . 522Tapeprompt . . . . . . . . . . . . . 524Tcpadminport . . . . . . . . . . . . 525Tcpbuffsize . . . . . . . . . . . . . 526Tcpcadaddress . . . . . . . . . . . . 526Tcpclientaddress . . . . . . . . . . . 527Tcpclientport . . . . . . . . . . . . 528Tcpnodelay . . . . . . . . . . . . . 529Tcpport . . . . . . . . . . . . . . 529Tcpserveraddress . . . . . . . . . . . 530Tcpwindowsize . . . . . . . . . . . . 531Timeformat . . . . . . . . . . . . . 532Toc . . . . . . . . . . . . . . . . 535Todate . . . . . . . . . . . . . . . 536Totime . . . . . . . . . . . . . . . 537Txnbytelimit . . . . . . . . . . . . 538Type . . . . . . . . . . . . . . . 539Updatectime . . . . . . . . . . . . . 540Useexistingbase . . . . . . . . . . . 540Usereplicationfailover . . . . . . . . . 541Users (deprecated). . . . . . . . . . . 542V2archive . . . . . . . . . . . . . 542Verbose . . . . . . . . . . . . . . 543Verifyimage . . . . . . . . . . . . . 544Virtualfsname . . . . . . . . . . . . 545Virtualmountpoint . . . . . . . . . . 545Virtualnodename . . . . . . . . . . . 547Vmbackdir . . . . . . . . . . . . . 548Vmbackupmailboxhistory . . . . . . . . . 549Vmbackuptype . . . . . . . . . . . . 549Vmchost . . . . . . . . . . . . . . 550Vmcpw . . . . . . . . . . . . . . . 551Vmctlmc . . . . . . . . . . . . . . 552Vmcuser . . . . . . . . . . . . . . 553Vmdatastorethreshold . . . . . . . . . 554Vmdefaultdvportgroup . . . . . . . . . 556Vmdefaultdvswitch . . . . . . . . . . 557Vmdefaultnetwork . . . . . . . . . . 557Vmenabletemplatebackups . . . . . . . . 558Vmlimitperdatastore . . . . . . . . . . 560Vmlimitperhost . . . . . . . . . . . . 561Vmmaxbackupsessions . . . . . . . . . . 562Vmmaxparallel . . . . . . . . . . . . 564Vmmaxrestoresessions . . . . . . . . . 566Vmmaxvirtualdisks . . . . . . . . . . 566Vmmc . . . . . . . . . . . . . . . 568Vmnoprdmdisks . . . . . . . . . . . . 568Vmnovrdmdisks . . . . . . . . . . . . 569Vmpreferdagpassive . . . . . . . . . . 570Vmprocessvmwithindependent . . . . . . . 571Vmprocessvmwithprdm . . . . . . . . . . 572Vmskipctlcompression . . . . . . . . . 574Vmskipmaxvirtualdisks . . . . . . . . . 574Vmskipmaxvmdks. . . . . . . . . . . 575Vmtagdefaultdatamover . . . . . . . . . 576Vmtagdatamover . . . . . . . . . . . . 578Vmverifyifaction . . . . . . . . . . . 580Vmverifyiflatest . . . . . . . . . . . 582Vmvstortransport . . . . . . . . . . . 583Vmtimeout . . . . . . . . . . . . . 584

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

Webports . . . . . . . . . . . . . . 585Wildcardsareliteral . . . . . . . . . . 586

Chapter 11. Using commands . . . . 589Start and end a client command session . . . . 592

Process commands in batch mode . . . . . 592Process commands in interactive mode . . . . 593

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

Command name . . . . . . . . . . . 593Options . . . . . . . . . . . . . . 594

Options in interactive mode . . . . . . 594Parameters . . . . . . . . . . . . . 594File specification syntax . . . . . . . . . 595

Wildcard characters . . . . . . . . . . . 596Client commands reference . . . . . . . . . 597Archive . . . . . . . . . . . . . . . 597Archive FastBack . . . . . . . . . . . . 599Backup FastBack . . . . . . . . . . . . 602Backup Group . . . . . . . . . . . . . 604Backup Image . . . . . . . . . . . . . 606

Static, dynamic, and snapshot image backup 609Utilizing image backup to perform file systemincremental backup . . . . . . . . . . 610

Backup NAS . . . . . . . . . . . . . 611Backup VM . . . . . . . . . . . . . . 614Cancel Process . . . . . . . . . . . . . 621Cancel Restore . . . . . . . . . . . . . 621Delete Access . . . . . . . . . . . . . 622Delete Archive . . . . . . . . . . . . . 623Delete Backup . . . . . . . . . . . . . 624Delete Filespace . . . . . . . . . . . . 628Delete Group . . . . . . . . . . . . . 629Expire . . . . . . . . . . . . . . . . 630Help . . . . . . . . . . . . . . . . 632Incremental . . . . . . . . . . . . . . 633

Journal-based backup. . . . . . . . . . 637Incremental-by-Date . . . . . . . . . . 639Associate a local snapshot with a server filespace . . . . . . . . . . . . . . . 639

Loop . . . . . . . . . . . . . . . . 639Macro . . . . . . . . . . . . . . . . 641Monitor Process . . . . . . . . . . . . 642Preview Archive . . . . . . . . . . . . 642Preview Backup . . . . . . . . . . . . 643Query Access . . . . . . . . . . . . . 644Query Archive . . . . . . . . . . . . . 645Query Backup . . . . . . . . . . . . . 647

Query NAS file system images . . . . . . 650Query Backupset . . . . . . . . . . . . 650

Query Backupset without the backupsetnameparameter . . . . . . . . . . . . . 652

Query Filespace . . . . . . . . . . . . 653Query NAS file spaces . . . . . . . . . 655

Query Group . . . . . . . . . . . . . 656

Query Image . . . . . . . . . . . . . 657Query Inclexcl . . . . . . . . . . . . . 659Query Mgmtclass . . . . . . . . . . . . 660Query Node. . . . . . . . . . . . . . 661Query Options . . . . . . . . . . . . . 662Query Restore . . . . . . . . . . . . . 663Query Schedule . . . . . . . . . . . . 664Query Session . . . . . . . . . . . . . 664Query Systeminfo . . . . . . . . . . . 665Query VM . . . . . . . . . . . . . . 667Restart Restore . . . . . . . . . . . . . 668Restore . . . . . . . . . . . . . . . 669

Restore from file spaces that are notUnicode-enabled . . . . . . . . . . . 673

Restore Backupset . . . . . . . . . . . 674Restore backup sets: considerations andrestrictions . . . . . . . . . . . . . 677Restore backup sets in a SAN environment . . 678Restore Backupset without the backupsetnameparameter . . . . . . . . . . . . . 678

Restore Group . . . . . . . . . . . . . 680Restore Image . . . . . . . . . . . . . 682Restore NAS . . . . . . . . . . . . . 685Restore VM . . . . . . . . . . . . . . 687Retrieve . . . . . . . . . . . . . . . 693

Retrieve archives from file spaces that are notUnicode-enabled . . . . . . . . . . . 695

Schedule . . . . . . . . . . . . . . . 696Selective . . . . . . . . . . . . . . . 698

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

Set Access . . . . . . . . . . . . . . 701Set Event. . . . . . . . . . . . . . . 703Set Netappsvm . . . . . . . . . . . . 705Set Password . . . . . . . . . . . . . 706Set Vmtags . . . . . . . . . . . . . . 712

Data protection tagging overview . . . . . 713Representation of tags in the IBM SpectrumProtect extension . . . . . . . . . . 714Supported data protection tags . . . . . 714Inheritance of data protection settings . . . 721Tips for data protection tagging . . . . . 722

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

Notices . . . . . . . . . . . . . . 727

Glossary . . . . . . . . . . . . . 731

Index . . . . . . . . . . . . . . . 733

Contents ix

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

Tables

1. Minimum disk space needed for automaticclient deployment . . . . . . . . . . . 2

2. Default log file location. . . . . . . . . . 43. AIX client communication methods . . . . . 54. Supported features on AIX . . . . . . . . 55. HP-UX Itanium 2 API communication methods 66. Linux on Power Systems client communication

methods . . . . . . . . . . . . . . 77. Linux on Intel x86_64 client communication

methods . . . . . . . . . . . . . . 78. Linux on System z client communication

methods . . . . . . . . . . . . . . 89. Mac OS X client communication methods 9

10. Oracle Solaris client communication methods 1011. HP-UX Itanium 2 client: Language codes for

installation packages . . . . . . . . . 1512. Package names, contents, and default directory 1813. Package names, contents, and default directory 2014. Package names, contents, and default directory 2315. Language pack identifiers . . . . . . . . 2516. Package names, contents, and default directory 2617. Language pack identifiers . . . . . . . . 2918. Package names, contents, and default directory 3019. Language pack identifiers . . . . . . . . 3320. Package names, contents, and default directory 3421. Language pack identifiers . . . . . . . . 3722. Installation package names and descriptions 4023. Tasks for root users, authorized users, and

other users . . . . . . . . . . . . . 4524. Mac OS X authorization tools and associated

IBM Spectrum Protect applications . . . . . 4725. Client acceptor-managed services versus

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

directories. . . . . . . . . . . . . 11328. Options for controlling processing using

include and exclude statements . . . . . 11429. Wildcard and other special characters 11830. Using wildcard characters with include and

exclude patterns . . . . . . . . . . 11931. Options for controlling symbolic link and

alias processing . . . . . . . . . . . 12032. Options for controlling compression and

encryption . . . . . . . . . . . . 12033. Working with your files using the

backup-archive client GUI . . . . . . . 13334. Supported file systems and ACL support 14335. Maximum file size . . . . . . . . . . 14636. Command-line backup examples . . . . . 16037. Volume device-type support for an image

backup. . . . . . . . . . . . . . 17238. Comparing incremental image backup

methods . . . . . . . . . . . . . 17639. LVM1 and LVM2 image operation

comparisons . . . . . . . . . . . . 177

40. NAS options and commands . . . . . . 18441. Backup and restore capabilities for VMware

virtual machines on Linux platforms . . . . 19142. Client command line informational messages 19543. Backup set GUI restore restrictions . . . . 21144. Backup set command-line restore restrictions 21145. Sample WPAR restore commands with

dsm.opt file . . . . . . . . . . . . 22246. NAS options and commands . . . . . . 22347. Command-line restore examples . . . . . 22648. Command line archive examples . . . . . 23649. Symbolic link management table for archive

and retrieve . . . . . . . . . . . . 24150. Command line examples of retrieving

archives . . . . . . . . . . . . . 24351. Sample classic query schedule output 25352. Sample enhanced query schedule output 25453. Client return codes and their meanings 25954. Default attribute values in the standard

management class . . . . . . . . . . 26355. TCP/IP options . . . . . . . . . . . 27456. Shared memory communication options 27557. Sample client system-options file . . . . . 27658. Backup and archive processing options 27659. Restore and retrieve processing options 28560. Scheduling options. . . . . . . . . . 28861. Format and language options . . . . . . 28962. Command processing options . . . . . . 29063. Authorization options. . . . . . . . . 29064. Error processing options . . . . . . . . 29165. Transaction processing options . . . . . . 29166. Web client options . . . . . . . . . . 29267. Diagnostics options . . . . . . . . . 29368. Client command options . . . . . . . . 29469. Options that are valid on the initial command

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

Protect server . . . . . . . . . . . 30171. Sample time format settings in the locale

configuration (t_fmt line) . . . . . . . 33372. Sample date format settings in the locale

configuration (d_fmt line) . . . . . . . 33473. Interaction of domain definitions from several

sources. . . . . . . . . . . . . . 35174. Other optional parameters . . . . . . . 41075. Incremental command: Related options 50576. Effects of server and client SSL settings on

success or failure of login attempts . . . . 51977. Sample time format settings in the locale

configuration (t_fmt line) . . . . . . . 53478. Sample date format settings in the locale

configuration (d_fmt line) . . . . . . . 53579. Commands . . . . . . . . . . . . 58980. Wildcard characters . . . . . . . . . 59681. Archive command: Related options . . . . 59882. Archive FastBack command: Related options 601

© Copyright IBM Corp. 1993, 2016 xi

83. Backup FastBack command: Related options 60384. Backup Group command: Related options 60685. Backup Image command: Related options 60886. Backup NAS command: Related options 61387. Delete Archive command: Related options 62388. Delete Backup command: Related options 62689. Delete Filespace command: Related options 62890. Delete Group command: Related options 63091. Expire command: Related options. . . . . 63192. Incremental command: Related options 63593. Query Archive command: Related options 64694. Query Backup command: Related options 64895. Query Backupset command: Related options 65196. Query Backupset command: Related options 65397. Query Filespace command: Related options 65498. Query Group command: Related options 65699. Query Image command: Related options 658

100. Query Mgmtclass command: Related options 660

101. Query Node command: Related options 661102. Query Options command: Related options 662103. Query Systeminfo command: Related options 666104. Query VM command: Related options for

VMware virtual machine queries. . . . . . 667105. Restore command: Related options . . . . 671106. Restore Backupset command: Related options 675107. Restore Group command: Related options 681108. Restore Image command: Related options 684109. Restore NAS command: Related options 687110. Restore VM command: Related options when

restoring VMware virtual machines . . . . 691111. Retrieve command: Related options . . . . 694112. Schedule command: Related options . . . . 697113. Selective command: Related options . . . . 699114. Order of precedence of vSphere inventory

objects . . . . . . . . . . . . . . 722

xii IBM Spectrum Protect for UNIX and Linux 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.The server program also supplies hierarchical storage management (HSM)services, and enables systems to perform as a migration server.

v An administrative client program that you can access from a web browser orfrom 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.

Associated with IBM Spectrum Protect, but sold separately, are the IBM SpectrumProtect for Space Management and IBM Spectrum Protect HSM for Windows clientprograms. These products automatically migrate eligible files to storage tomaintain specific levels of free space on local file systems and automatically recallmigrated files when they are accessed. It also enables users to migrate and recallspecific files.

The terms hierarchical storage management and space management have the samemeaning throughout this publication.Related concepts:“Planning your backups” on page 137“What's new for Version 8.1” 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.

© Copyright IBM Corp. 1993, 2016 xiii

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.

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 : Colon

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

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

v , Commav = Equal Signv - Hyphenv () Parenthesesv . Periodv Spacev " 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.

About this publication xv

►► 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 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 UNIX and Linux Backup-Archive Clients: Installation and User's Guide

What's new for Version 8.1

IBM Spectrum Protect Version 8.1 introduces new features and updates.

For a list of new features and updates in this release, see Backup-archive clientupdates.Related information:“About this publication” on page xiii

© Copyright IBM Corp. 1993, 2016 xvii

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

xviii IBM Spectrum Protect for UNIX and Linux 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” on page xvii“Planning your backups” on page 137

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

For information about upgrading your current AIX® IBM PowerHA®

SystemMirror® setups, see “Migrating legacy AIXIBM PowerHA SystemMirrorsetups” on page 101.

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 If you are upgrading from the IBM Tivoli® Storage Manager Version 7.1.2 or

earlier backup-archive client on the Oracle Solaris operating system, you mustuninstall any previously installed language packages before you proceed withthe upgrade.

v For Mac users, updates to the Mac OS X client contained in IBM SpectrumProtect V6.3, or newer versions, require you to consider the following items:– When you use the Mac OS X client that is provided in this release, ensure

that the dsm.sys and dsm.opt files are encoded by using Unicode (UTF-8).UTF-8 encoding enables the use of characters from any language in the

© Copyright IBM Corp. 1993, 2016 1

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

options files. If your dsm.sys or dsm.opt files were previously encoded asMacRoman (or anything other than UTF-8), open them in an editor likeTextEdit and save them with UTF-8 encoding, and without the .txtextension. Your include-exclude lists can be encoded as either UTF-8 orUTF-16. For more information about using Unicode, see “Considerations forUnicode-enabled clients” on page 406.

– IBM Spectrum Protect server file spaces that were created by Mac OS 9 clientscannot be managed by the Mac OS X client that was provided in IBMSpectrum Protect V6.3. Use q file node f=d on the server to list files storedfor a node. Any Mac-platform files that do not start with a slash (/) wereprobably created by an older Mac client. You cannot restore or otherwisemanage these files by using the Mac OS X client that is provided in thisrelease. You can manage these files, but you must use a Mac client that isinstalled on a version 6.2.2 or older client node.

v For a list of new and changed messages since the previous IBM SpectrumProtect 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 workstations that already have the backup-archive clientinstalled.

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

IBM Spectrum Protect for ERP applications do not use the same installationtechnology that is used by the client installation program. Because of that, theclient installation dependency check is not able to detect whether the API librarythat is 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, the APIlibrary that is installed might not be compatible with the API library that wasinstalled by the IBM Spectrum Protect for ERP application. The newly deployedAPI library can cause the IBM Spectrum Protect for ERP applications to fail.

Do not schedule automatic client deployments to workstations that have the IBMSpectrum Protect for ERP application installed on them.

The IBM Spectrum Protect server can be configured to automatically upgradebackup-archive clients on supported Linux and UNIX systems. The existing clientsmust be at version 5.5 or later.

Important: For automatic client deployment to be operational, the followingconditions apply:v The client computer must have the minimum free disk space as shown in

Table 1.

Table 1. Minimum disk space needed for automatic client deployment

Operating systems Free disk space required

AIX 1500 MB

Solaris 1200 MB

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

Table 1. Minimum disk space needed for automatic client deployment (continued)

Operating systems Free disk space required

Linux on Power® 350 MB

Linux x86_64 950 MB

Linux on System z® 350 MB

Mac OS X 200 MB

v In IBM Spectrum Protect 6.3 and later, 32-bit backup-archive clients are nolonger supported. If the deployment manager detects a 32-bit backup-archiveclient running on a 64-bit operating system, it upgrades the client to the 64-bitversion.

v The passwordaccess option must be set to generate.To store the password on the client, a user must log on to local workstationonce, to provide the password. If the client automatic deployment processcannot find the node password, the following events 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.sh script is started.Sun 10/11/2009 10:16:04.37 deployclient.sh is removing the deployment

manager and temporary files possibly left from the previous installation.Sun 10/11/2009 10:17:10.53 WARNING: Still waiting for the result of query

system 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 errors areprobably caused by a network problem (the client cannot be reached).

– The dsmc query systeminfo command is left running.– The deployment process cannot start, so no messages are sent to the server.

v The client is deployed from the server as a scheduled task; the client schedulerdaemon must be running.

v The client is deployed as a postschedule operating system command; scheduledoperating system commands must be enabled on the client.

Note: The command that is specified by the postschedulecmd option in the clientsystem-options file (dsm.sys) will be overridden by the deployment script, butthe command that is specified by the preschedulecmd option will be run.Suppress the preschedulecmd option for the deployment task by specifying thefollowing option in the schedule definition:-preschedulecmd=""

v You must configure your server to perform backup-archive client automaticdeployments. See the IBM Spectrum Protect server documentation forinstructions.

The deployment manager writes log and trace data for a deployment operation tothe client’s disk. The default location of the logs is shown in Table 2 on page 4. Thexxxx represents the version, release, modification, and fix pack information for thedeployed backup-archive client.

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

Table 2. Default log file location.

Operating System Directory

AIX /usr/tivoli/client/IBM_ANR_UNX/Vxxxx/log/

Oracle Solaris, Linux /opt/tivoli/tsm/client/IBM_ANR_UNX/Vxxxx/log/

Mac /Library/Application Support/tivoli/tsm/client/ba/bin/IBM_ANR_MAC/Vxxxx/log

When you define a schedule to deploy the client updates, you can specify anon-default retrieval target location for UNIX and Linux platforms. Specifying anon-default retrieval target location changes the location of the log and trace files.For example, the default retrieval target location for AIX is /usr/tivoli/client/. Ifyou specify /tmp/tivoli/client as the target location, the log and trace files willbe under /tmp/tivoli/client/IBM_ANR_UNX/Vxxxx/log.

On the Mac OS X platform, you cannot change the retrieval target location. Thedeployment manager's working directory is relative to the working directory of theclient scheduler. For example, if the user starts the client scheduler from /mydir,the log and trace files will be under /mydir/IBM_AMR_MAC/Vxxxx/log.

A semaphore is used to prevent a client from being updated by differentdeployment managers at the same time. The semaphore expires 24 hours from thelast client deployment. New clients cannot be deployed until the semaphoreexpires.Related reference:“Autodeploy” on page 311

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 “AIX client environment”v “HP-UX Itanium 2 API environment” on page 5v “Linux on Power Systems client environment” on page 6v “Linux x86_64 client environment” on page 7v “Linux on System z client environment” on page 8v “Mac OS X client environment” on page 8v “Oracle Solaris client environment” on page 9v “NDMP support requirements (Extended Edition only)” on page 10

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

AIX client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the AIX platform.



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

The installable components for the AIX 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 64-bit API

The API can be separately installed. The other components are all installed whenyou install the AIX package (tivoli.tsm.client.api.64bit).

System requirements for the AIX clientThe IBM Spectrum Protect AIX client requires a minimum amount of hardware,disk space, memory, and software.

For software and hardware requirements for all supported versions of AIX clients,including the most recent fix packs, seetechnote 1052226.

AIX client communication methodsThe TCP/IP and shared memory communication methods are available for the AIXbackup-archive client.

You can use the following communication methods with the IBM Spectrum ProtectVersion 8.1.0 AIX client:

Table 3. AIX client communication methods

To use this communicationmethod:

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

TCP/IP TCP/IP (Standard withsupported AIX platforms)

AIX,Linux, Windows

Shared Memory TCP/IP (Standard withsupported AIX platforms)

AIX

Backup-archive client features that are available on AIXThis topic lists the features that are supported on AIX.

Table 4. Supported features on AIX

Features Supported on AIX?

Backup-archive command-line and GUI yes

Journal-based backup yes

LAN-free operations yes

Online image backup yes

Offline image backup yes

HP-UX Itanium 2 API environmentReview API environment information, installable components, and hardware andsoftware requirements for the HP-UX Itanium 2 platform.



HP-UX Itanium 2 API installable componentYou can install only the HP-UX Itanium 2 API in IBM Spectrum Protect Version8.1.0.

System requirements for the HP-UX Itanium 2 APIThe IBM Spectrum Protect HP-UX Itanium 2 API requires a minimum amount ofhardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of the HP-UXItanium 2 API, including the most recent fix packs, seetechnote 1197146.

HP-UX Itanium 2 API communication methodsThe TCP/IP and shared memory communication methods are available for theHP-UX Itanium 2 API.

Table 5. HP-UX Itanium 2 API communication methods



TCP/IP TCP/IP (Standard withHP-UX)

AIX, Linux, Windows

Linux on Power Systems client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the Linux on PowerSystems™ client platforms.

Linux on Power Systems client installable componentsThe backup-archive client command-line, Java GUI, web backup-archive, and APIcomprise the Linux on Power Systems backup-archive client installablecomponents.

You can install the following components with IBM Spectrum Protect Version 8.1.0:v Backup-archive clientv Administrative clientv Backup-archive Java graphical user interface (GUI)v Web backup-archive clientv IBM Spectrum Protect API (64-bit)

System requirements for clients on Linux on Power SystemsThe IBM Spectrum Protect clients on Linux on Power Systems require a minimumamount of hardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of clients onLinux on Power Systems, including the most recent fix packs, seetechnote 1169963.

Linux on Power Systems client communication methodsBackup-archive clients on Linux on Power Systems can use either TCP/IP orshared memory as the communications method for client-server communications.


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

Table 6 lists the available Linux on Power Systems client communications methods,and the IBM Spectrum Protect server operating systems that you can use themwith.

Table 6. Linux on Power Systems client communication methods



TCP/IP TCP/IP (Standard withLinux)

AIX, Linux, Windows

Shared Memory TCP/IP (Standard withLinux)

Linux on Power Systems

Linux x86_64 client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the Linux on Intel(Linux x86_64) platform.

Linux x86_64 client installable componentsThe backup-archive client command-line, Java GUI, web backup-archive,administrative client, and the API comprise the Linux on Intel (Linux x86_64)backup-archive client installable components.

You can install the following components with IBM Spectrum Protect Version 8.1.0:v Backup-archive clientv Administrative clientv Backup-archive Java graphical user interface (GUI)v Web backup-archive clientv IBM Spectrum Protect API

System requirements for Linux x86_64 clientsThe IBM Spectrum Protect Linux x86_64 clients require a minimum amount ofhardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of Linuxx86_64 clients, including the most recent fix packs, seetechnote 1052223.

Linux x86_64 client communication methodsThe TCP/IP and shared memory communication methods are available for theLinux on Intel (Linux x86_64) backup-archive client.

You can use the following communication methods with the IBM Spectrum ProtectVersion 8.1.0 Linux on Intel (Linux x86_64) client:

Table 7. Linux on Intel x86_64 client communication methods




AIX, Linux, Windows


Linux x86_64



Linux on System z client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the Linux on System zplatform.

Linux on System z client installable componentsThe backup-archive client command-line, administrative client, web backup-archiveclient, and API comprise the Linux on System z backup-archive client installablecomponents.

You can install the following components with IBM Spectrum Protect Version 8.1.0:v Backup-archive clientv Administrative clientv Web backup-archive clientv IBM Spectrum Protect API

System requirements for Linux on System z clientsIBM Spectrum Protect Linux System z clients require a minimum amount ofhardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of LinuxSystem z clients, including the most recent fix packs, seetechnote 1066436.

Linux on System z client communication methodsThe TCP/IP and shared memory communication methods are available for theLinux on System z backup-archive client.

You can use the following communication methods with the IBM Spectrum ProtectVersion 8.1.0 Linux on System z client:

Table 8. Linux on System z client communication methods




AIX, Linux, Windows


Linux on System z

Mac OS X client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the Mac OS X client.

Mac OS X client installable componentsThe backup-archive client command-line, Java GUI, web backup-archive, and APIcomprise the Mac OS X backup-archive client installable components.

The following components are installed with IBM Spectrum Protect Version 8.1.0:v Backup-archive clientv Administrative clientv Web backup-archive clientv IBM Spectrum Protect API



v Backup-archive Java graphical user interface (GUI)

Tip: The dsmj shell script file for the Java GUI is installed in the followinglocation:/Library/Application Support/tivoli/tsm/client/ba/bin

System requirements for Mac OS X clientsThe IBM Spectrum Protect Mac OS X clients require a minimum amount ofhardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of Mac OS Xclients, including the most recent fix packs, seetechnote 1053584.

Mac OS X client communication methodsThe TCP/IP communication methods are available for the Mac OS Xbackup-archive client.

You can use the following communication methods with the IBM Spectrum ProtectVersion 8.1.0 Mac OS X client:

Table 9. Mac OS X client communication methods



TCP/IP TCP/IP (standard with MacOS X)

AIX, Linux, Windows

Oracle Solaris client environmentThis section contains client environment information, backup-archive clientcomponents, and hardware and software requirements for the Oracle Solarisplatform.

Oracle Solaris client installable componentsThe IBM Spectrum Protect command-line, Java GUI, web backup-archive, and APIcomprise the Solaris backup-archive client installable components.

You can install the following client components:v Backup-archive clientv Administrative clientv Backup-archive Java graphical user interface (GUI)v Web backup-archive clientv IBM Spectrum Protect API

System requirements for Oracle Solaris clientsThe IBM Spectrum Protect Oracle Solaris clients require a minimum amount ofhardware, disk space, memory, and software.

For software and hardware requirements for all supported versions of IBMSpectrum Protect Oracle Solaris clients, including the most recent fix packs, see thefollowing IBM support pages:v For Oracle Solaris SPARC client requirements, see

technote 1052211.v For Oracle Solaris x86_64 client requirements, see technote 1232956.


http://www.ibm.com/support/docview.wss?uid=swg21053584http://www.ibm.com/support/docview.wss?uid=swg21052211http://www.ibm.com/support/docview.wss?uid=swg21232956

Oracle Solaris client communication methodsThe TCP/IP and shared memory communication methods are available for theOracle Solaris backup-archive client.

You can use the following communication methods with the Oracle Solaris client:

Table 10. Oracle Solaris client communication methods



TCP/IP TCP/IP (Standard withSolaris)

AIX, Linux, Windows

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.

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.


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/

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 Disaster

Recovery Hub is installed. In this case, the prerequisites are: the FastBackDisaster Recovery Hub setup, and the FastBack shell.

v Install backup-archive client on a workstation where neither the FastBack serveror the FastBack Disaster Recovery Hub is installed. In this case, the FastBackshell is still required.

Related concepts:“Configuring the client to back up and archive Tivoli Storage Manager FastBackdata” on page 91

Install the UNIX and Linux backup-archive clientsThis section provides instructions to install and set up IBM Spectrum Protect UNIXand Linux clients.

Note: You must log on as the root user to install the backup-archive client on aUNIX or Linux workstation.

The supported UNIX and Linux clients and the location of the installationinstructions for each client are listed here.v “Installing the AIX client”v “Installing the HP-UX Itanium 2 API” on page 15v “Installing the backup-archive client on Linux on Power Systems (Little Endian)”

on page 17v “Installing the backup-archive client on Ubuntu Linux on Power Systems (Little

Endian)” on page 20v “Installing the API on Linux on Power Systems (Big Endian)” on page 22v “Installing the Linux x86_64 client” on page 25v “Installing the Ubuntu Linux x86_64 client” on page 30v “Installing the Linux on System z client” on page 33v “Installing the Mac OS X client” on page 38v “Installing the Oracle Solaris client” on page 40Related concepts:Chapter 2, “Configure the IBM Spectrum Protect client,” on page 45

Installing the AIX clientYou can install the AIX backup-archive client from the product installation media.

About this task

In IBM Spectrum Protect Version 8.1.0, a 64-bit version of the AIX client isprovided in the distribution libraries. You cannot upgrade a previously installed


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

32-bit AIX client to new the 64-bit AIX client. If you have a 32-bit client that isinstalled from a previous version of IBM Spectrum Protect, use SMIT to performthe following steps:1. Uninstall the 32-bit client (tivoli.tsm.client.ba).2. Uninstall any national language files that were previously installed.3. Uninstall the API (tivoli.tsm.client.api.32bit).

Next, use SMIT to install the following packages in the IBM Spectrum ProtectV8.1.0 distribution libraries, in the following order:1. Install the 64-bit API (tivoli.tsm.client.api.64bit).2. Install the 64-bit client (tivoli.tsm.client.ba.64bit).

If you already have a 64-bit IBM Spectrum Protect V6.3 (or newer) client installed,you can upgrade the client instead of uninstalling it and reinstalling it.

If you have a 64-bit client from an earlier version of IBM Spectrum Protectinstalled (for example, V6.1, or V6.2) you must uninstall the client, language packs,and API. Then, install the new IBM Spectrum Protect API and client.

All of the packages that are needed to install the client are in the AIX clientpackage, and they overwrite any older runtime applications on your system duringinstallation. The LibC (C Set ++) runtime library is required.

When you use the installp command to install this client, do not change thedefault field values for the following two choices:v AUTOMATICALLY install requisite software?v OVERWRITE same or newer versions?

Disabling or changing the values allows a lower-level client component to installover a currently higher installed component. Under such circumstances, functioncalls between components at different levels might not be valid any longer.

Install the following packages. They are all provided on the installation media. Youneed an Extended Edition license to use the NAS client.

The following files are listed in order of dependency. For example, the API isdependent on the Global Security Kit (GSKit). When you install all of them usingSMIT, you can select them (F7) in any order.

GSKit8.gskcrypt64.ppc.rte and GSKit8.gskssl64.ppc.rteIBM GSKit 64-bit (required by the 64-bit client API).

tivoli.tsm.client.api.64bitInstalls the 64-bit API.

tivoli.tsm.client.ba.64bitInstalls the following 64-bit client files:v Backup-archive Java client (GUI)v Backup-archive web clientv NAS backup client

tivoli.tsm.filepath_aixInstalls the file path kernel extension that is required for journal-basedbackup.

tivoli.tsm.client.jbb.64bitInstalls the journal-based backup component.


Each package is installed in the following default installation directory:v The backup-archive, web client, and administrative client (dsmadmc) 64-bit files

are installed in the /usr/tivoli/tsm/client/ba/bin64 directory.v The IBM Spectrum Protect 64-bit API files are installed in the

/usr/tivoli/tsm/client/api/bin64 directory.v The sample system-options file, dsm.sys.smp, is placed in the installation

directory.

This installation procedure can be used to install new distributions or updates fromdownloaded installation media. The downloaded files that you use to install theclient might be compressed. Depending on the package file format, either copy orextract the files to disk and use these instructions to install the components.

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

If you are copying the client files into a local directory first, a .toc file isautomatically created by the installp command. You can create a .toc filemanually by running /usr/sbin/inutoc in the local directory to which you copiedthe IBM Spectrum Protect image. From the AIX command line, enter:

/usr/sbin/inutoc /usr/sys/inst.images

A .toc file is created in that directory.

Procedure1. Log in as the root user.2. Mount the volume that you are installing from.3. From the AIX command line, type smitty install and press Enter.4. Select Install and Update Software and press Enter.5. Select Install and Update From ALL Available Software and press Enter.6. At the INPUT device/directory for software prompt, press the F4 key and

specify the directory that contains the installation images, and press Enter.7. At the SOFTWARE to install prompt, press the F4 key. Select the IBM Spectrum

Protect file sets you want to install by pressing the F7 key. Then, press theEnter key.

8. On the Install and Update From ALL Available Software panel, press the F4 keyto change any entry fields, or use the default fields. Press Enter twice to beginthe installation.

9. After the installation completes, press F10 to exit.

Results

When file sets are installed, they are automatically committed on the system. Theprevious version of backup-archive client software is replaced by the newlyinstalled version.

The backup-archive client files are installed in the /usr/tivoli/tsm/client/ba/bin64 directory. If you move the client files to another directory, you must performthe following steps:1. Make sure that the permissions of the installed files have not changed.


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

2. Update the symbolic links for the installed files in the following directories:v The /usr/bin directoryv The /usr/lib directory for IBM Spectrum Protect libraries

3. Ensure that every user of the backup-archive client sets the DSM_DIRenvironment variable to the newly installed directory.

What to do next

After the installation completes, see Chapter 2, “Configure the IBM SpectrumProtect client,” on page 45 for required and optional tasks to complete before youuse the backup-archive client.

Note:

v AIX workload partitions (WPAR) are supported as follows:– Supported in global environments– Supported with non-shared system WPARs– Supported with shared system WPARs (backup-archive client logs and

configuration files must be defined to non-default locations)– No support for application WPARs– No support for image backup– No support for backup set restore from tape

v On AIX Version 6.1, if you are using encrypted file systems (EFS) with thebackup-archive client, and if the EFS user keystore password is different fromthe user login password, the EFS keystore is not automatically opened when youlog on. If the EFS keystore is not open when you log on, the client might notrestore a non-EFS file into an EFS file system. You can prevent the EFS filesystem restore problem one of the following ways:– Start the backup-archive client by using the efskeymgr -o command. For

example: efskeymgr -o ./dsmj– Synchronize the keystore password with the user login password by using the

efskeymgr -n command. For example: efskeymgr -n

Uninstalling the AIX clientYou can use the following procedures to uninstall the IBM Spectrum Protect AIXbackup-archive client.

Before you begin

IBM Spectrum Protect client modules and components are tightly integrated andinstalled file sets are automatically committed. There is no option for rollbacks ofuninstalled components.

Procedure1. Enter the following AIX command: smitty remove.2. Press the ENTER key.3. In the SOFTWARE name field, press F4 to list the IBM Spectrum Protect file

sets that you want to uninstall; press the ENTER key.4. Select the IBM Spectrum Protect file sets that you want to uninstall; press the

ENTER key.


Note: The journal-based backup feature is contained in two file sets. Select bothtivoli.tsm.client.jbb.64bit and tivoli.tsm.filepath_aix. If you uninstallthe file sets one at a time, uninstall the tivoli.tsm.client.jbb.64bit file setfirst.

5. In the PREVIEW only? field (the remove operation does not occur), select No;press the ENTER key.

Installing the HP-UX Itanium 2 APIYou can install the HP-UX Itanium 2 API from the product installation media.

About this task

The following source packages are available on the installation media:

tsmcli/hp11ia64/gskcrypt64-8.x.x.x.hpux.ia64.tar.Z and tsmcli/hp11ia64/gskssl64-8.x.x.x.hpux.ia64.tar.Z

Contains the GSKit. If you have a previous version of the GSKit, uninstall itbefore you install the new version.

tsmcli/hp11ia64/TIVsmCapi64In this package, the software selection name that is used by swlist for thetop-level product name is TIVsm64. The component under TIVsm64 isTIVsm.CLIENT_API64.

Default installation directories

Here are the default directories where some files are stored as part of the clientinstallation:v The IBM Spectrum Protect API files are installed in the /opt/tivoli/tsm/client/

api/bin64 directory.v The sample system-options file, dsm.sys.smp, is placed in the installation

directory.

To remove previous backup-archive client versions, log in as the root user andenter the following command:/usr/sbin/swremove -x mount_all_filesystems=false -v TIVsm64

If you installed additional languages in a Version 7.1.2 or earlier client, run thefollowing command to remove them:/usr/sbin/swremove -x mount_all_filesystems=false -v TIVsm64.C

Documents

IBM Spectrum Protect for UNIX and Linux Backup-Archive ... · IBM Spectrum Protect for UNIX and Linux Backup-Archive Clients V ersion 8.1.0 Installa tion and User's Guide IBM