IBM Spectrum ProtectUNIX and Linux Backup-Archive ClientsVersion 8.1.9

Installation and User's Guide

IBM

Note:

Before you use this information and the product it supports, read the information in “Notices” on page725.

This edition applies to version 8, release 1, modification 9 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 International Business Machines Corporation 1993, 2019.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp.

Contents

Tables................................................................................................................. xv

About this publication ........................................................................................ xxiWho should read this publication..............................................................................................................xxiPublications .............................................................................................................................................. xxiConventions used in this publication....................................................................................................... xxiiReading syntax diagrams......................................................................................................................... xxii

Backup-archive client updates........................................................................... xxv

Chapter 1. Installing the IBM Spectrum Protect 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............................................................................................................... 3AIX client environment...........................................................................................................................3HP-UX Itanium 2 API environment........................................................................................................4Linux on Power Systems client environment.........................................................................................4Linux x86_64 client environment.......................................................................................................... 5Linux on System z client environment................................................................................................... 6Mac OS X client environment................................................................................................................. 7Oracle Solaris client environment..........................................................................................................7

NDMP support requirements (Extended Edition only)................................................................................8Installation requirements for backing up and archiving Tivoli Storage Manager FastBack client data.... 8Install the UNIX and Linux backup-archive clients.....................................................................................9

Installing the AIX client..........................................................................................................................9Uninstalling the AIX client................................................................................................................... 12Installing the HP-UX Itanium 2 API.....................................................................................................12Uninstalling the HP-UX Itanium 2 API.................................................................................................14Installing the client on Linux on Power Systems (Little Endian).........................................................15Uninstalling the client on Linux on Power (Little Endian)....................................................................18Installing the client on Ubuntu Linux on Power Systems (Little Endian)............................................19Uninstalling the client on Ubuntu Linux on Power Systems (Little Endian)........................................22Installing the API on Linux on Power Systems (Big Endian)...............................................................23Uninstalling the API on Linux on Power Systems (Big Endian)...........................................................25Installing the Linux x86_64 client....................................................................................................... 26Uninstalling the Linux x86_64 client................................................................................................... 30Installing the Ubuntu Linux x86_64 client.......................................................................................... 31Uninstalling the Ubuntu Linux x86_64 client...................................................................................... 35Installing the Linux on System z client................................................................................................ 36Uninstalling the Linux on System z client............................................................................................ 39Installing the Mac OS X client.............................................................................................................. 40Uninstalling the Mac OS X client.......................................................................................................... 41Installing the Oracle Solaris x86_64 client......................................................................................... 42Uninstalling the Oracle Solaris x86_64 client..................................................................................... 44Installing the Oracle Solaris SPARC API..............................................................................................45Uninstalling the Oracle Solaris SPARC API..........................................................................................46Software updates (AIX, Linux, Mac, and Solaris clients).................................................................... 47

Installing the client management service.................................................................................................47

iii

Chapter 2. Configure the IBM Spectrum Protect client.......................................... 49UNIX and Linux client root and authorized user tasks............................................................................. 49Enable non-root users to manage their own data.................................................................................... 51

Enabling encryption for backup-archive client users..........................................................................51Enable non-root users to manage shared data.........................................................................................52Client options file overview....................................................................................................................... 53

Creating and modifying the client system-options file....................................................................... 54Creating a default client-user options file........................................................................................... 56Creating a customized client user-options file....................................................................................58

Environment variables (AIX, Linux, Mac, Solaris)..................................................................................... 58Set language environment variables................................................................................................... 58Set processing environment variables................................................................................................ 59Set Bourne and Korn shell variables....................................................................................................61Set C shell variables............................................................................................................................. 61Set API environment variables............................................................................................................ 61

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

Configuring the scheduler..........................................................................................................................63Comparison between client acceptor-managed services and traditional scheduler services.......... 64Configuring the client to use the client acceptor service to manage the scheduler.......................... 64

Start the client scheduler (AIX, Linux, Mac, Solaris)................................................................................ 66Scheduling events using the command-line client............................................................................. 66

Configuring IBM Spectrum Protect client/server communication across a firewall................................68Configuring IBM Spectrum Protect client/server communication with Secure Sockets Layer............... 70

Creating a symbolic link to access the latest GSKit library.................................................................72Certificate Authorities root certificates............................................................................................... 74

Configure your system for journal-based backup.....................................................................................75Journal daemon configuration.............................................................................................................75

Client-side data deduplication.................................................................................................................. 80Configuring the client for data deduplication...................................................................................... 84Excluding files from data deduplication.............................................................................................. 86

Automated client failover configuration and use......................................................................................87Automated client failover overview..................................................................................................... 87Configuring the client for automated failover......................................................................................90Determining the status of replicated client data.................................................................................92Preventing automated client failover...................................................................................................93Forcing the client to fail over................................................................................................................94

Configuring the client to back up and archive Tivoli Storage Manager FastBack data............................ 94Cluster environment configuration and use..............................................................................................95

Overview of cluster environments....................................................................................................... 96Configuring the backup-archive client in a cluster environment........................................................ 96Enabling web client access in a Cluster Environment ......................................................................101Migrating legacy AIXIBM PowerHA SystemMirror setups................................................................ 103

AIX configuration considerations prior to performing snapshot-based file backups and archives......104Configuring NetApp and IBM Spectrum Protect for snapshot difference incremental backups.......... 104

Protecting clustered-data ONTAP NetApp file server volumes........................................................106SnapMirror support for NetApp snapshot-assisted progressive incremental backup (snapdiff)....109

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

Creating an include-exclude list .............................................................................................................112Include-exclude options....................................................................................................................113Symbolic link and alias processing....................................................................................................120Determine compression and encryption processing........................................................................ 120Preview include-exclude list files...................................................................................................... 121Include and exclude option processing............................................................................................ 122

iv

Chapter 3. Getting started................................................................................. 125Configuring the client security settings to connect to the IBM Spectrum Protect server version

8.1.2 and later.................................................................................................................................... 125Configuring by using the default security settings (fast path).......................................................... 125Configuring without automatic certificate distribution..................................................................... 128

Secure password storage........................................................................................................................ 130IBM Spectrum Protect client authentication.......................................................................................... 131Starting a Java GUI session.....................................................................................................................132

IBM Spectrum Protect password...................................................................................................... 133Setup wizard.......................................................................................................................................133

Starting a command-line session............................................................................................................133Using batch mode.............................................................................................................................. 134Issuing a series of commands by using interactive mode................................................................ 134

Specifying input strings that contain blank spaces or quotation marks................................................ 135Starting: Additional considerations.........................................................................................................135Using the web client in the new security environment...........................................................................136

Starting a web client session............................................................................................................. 136Starting a web user interface session for file-restore operations..........................................................137

Downloading system logs.................................................................................................................. 138Start the client scheduler automatically.................................................................................................140Changing your password......................................................................................................................... 140Sorting file lists using the backup-archive client GUI............................................................................ 142Displaying online help............................................................................................................................. 143Ending a session...................................................................................................................................... 143Online forums.......................................................................................................................................... 144

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

LAN-free data movement...................................................................................................................147Incremental backups on memory-constrained systems..................................................................148Incremental backups on systems with a large number of files........................................................148Include-exclude options to control processing................................................................................ 150Data encryption during backup or archive operations......................................................................150File system and ACL support............................................................................................................. 151Maximum file size for operations.......................................................................................................155Long user and group names...............................................................................................................155Mac OS X volume names....................................................................................................................156Mac OS X Unicode enablement......................................................................................................... 157Mac OS X Time Machine backup disk................................................................................................ 157

Performing an incremental, selective, or incremental-by-date backup (UNIX and Linux)................... 158Full and partial incremental backup..................................................................................................158Incremental-by-date backup............................................................................................................ 162Comparing incremental-by-date, journal-based, and NetApp snapshot difference to full

incremental and partial incremental backups............................................................................. 162Snapshot differential backup with HTTPS (Linux)............................................................................ 163Selective backup................................................................................................................................ 165Solaris global zone and non-global zones backups.......................................................................... 165Saving access permissions................................................................................................................ 166Setting a virtual mount point............................................................................................................. 166Backing up data using the Java GUI..................................................................................................166Backing up data using the command line......................................................................................... 167Deleting backup data......................................................................................................................... 170Deleting file spaces............................................................................................................................ 171

v

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

Enabling multiple node operations from the GUI............................................................................. 173Setting up encryption.........................................................................................................................174Scheduling backups with client-node proxy support....................................................................... 174

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

Performing prerequisite tasks before creating an image backup.....................................................179Utilizing image backups to perform file system incremental backups.............................................181Performing an image backup using the GUI......................................................................................183Performing an image backup using the command line.....................................................................185

Snapshot-based file backup and archive and snapshot-based image backup..................................... 185Protecting Btrfs file systems................................................................................................................... 186

Backing up and restoring Btrfs file systems......................................................................................187Backing up and restoring Btrfs subvolumes..................................................................................... 188

Back up NAS file systems using Network Data Management Protocol..................................................189Backing up NAS file systems with the backup-archive client GUI using NDMP protocol................190Back up NAS file systems using the command line.......................................................................... 191

Backup network file systems.................................................................................................................. 193Back up NFS file systems with the global namespace feature.........................................................193

Back up AIX workload partition file systems..........................................................................................194Backing up Solaris Zettabyte file systems.............................................................................................. 195AIX JFS2 encrypted file system backup................................................................................................. 196Back up AIX JFS2 extended attributes...................................................................................................197Backing up VMware virtual machines..................................................................................................... 197

Preparing the environment for full backups of VMware virtual machines....................................... 199Creating full backups for VMware virtual machines..........................................................................200Parallel backups of virtual machines.................................................................................................202

Back up and archive Tivoli Storage Manager FastBack data..................................................................202Display backup processing status...........................................................................................................202Backup (UNIX and Linux): Additional considerations............................................................................ 205

Stored files......................................................................................................................................... 205Special file systems............................................................................................................................206NFS or virtual mount points............................................................................................................... 206Management classes......................................................................................................................... 206Back up symbolic links.......................................................................................................................207Hard links........................................................................................................................................... 209Sparse files......................................................................................................................................... 209NFS hard and soft mounts................................................................................................................. 209Deleted file systems...........................................................................................................................210Opened files....................................................................................................................................... 210Wildcard characters........................................................................................................................... 211

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

Restoring an image using the GUI..................................................................................................... 214Restoring an image using the command line.................................................................................... 215

Restore data from a backup set.............................................................................................................. 216Restore backup sets: considerations and restrictions......................................................................218Backup set restore............................................................................................................................. 219Restoring backup sets using the GUI................................................................................................ 220Backup set restores using the client command-line interface.........................................................220

Restoring or retrieving data during a failover......................................................................................... 221Restore an image to file...........................................................................................................................222Manage GPFS file system data with storage pools.................................................................................223Restoring data to a point in time............................................................................................................. 224Restoring data from a retention set........................................................................................................ 226

vi

Restore AIX encrypted files.................................................................................................................... 227Restore AIX workload partition file systems.......................................................................................... 227Restore NAS file systems........................................................................................................................ 229

Restoring NAS file systems using the backup-archive client GUI.................................................... 229Options and commands to restore NAS file systems from the command line................................ 230

Restore active or inactive backups......................................................................................................... 231Restoring data using the GUI.................................................................................................................. 231Command line restore examples............................................................................................................ 232

Examples: Command line restores for large amounts of data......................................................... 233Standard query restore, no-query restore, and restartable restore.................................................234

Restoring Solaris Zettabyte (ZFS) file systems.......................................................................................235Additional restore tasks.......................................................................................................................... 236

Authorizing another user to restore or retrieve your files.................................................................236Restoring or retrieving files from another client node...................................................................... 237Restore or retrieve files to another workstation............................................................................... 238Restoring a disk in case of disk loss.................................................................................................. 238Deleting file spaces............................................................................................................................ 239Enable SELinux to restore files on the Red Hat Enterprise Linux 5 client........................................ 240

Chapter 6. Archive and retrieve your data (UNIX and Linux)................................ 241Archive files..............................................................................................................................................241

Archiving data with the GUI............................................................................................................... 241Archive data examples by using the command line..........................................................................242Archiving data with client node proxy............................................................................................... 244Deleting archive data......................................................................................................................... 245Advanced archive tasks..................................................................................................................... 246

Retrieve archives..................................................................................................................................... 247Retrieving data with the GUI..............................................................................................................248Retrieve data examples by using the command line........................................................................ 248Archive management classes............................................................................................................ 249

Chapter 7. IBM Spectrum Protect scheduler overview........................................ 251Examples: Blank spaces in file names in schedule definitions.............................................................. 252Preferential start times for certain nodes...............................................................................................252Scheduler processing options................................................................................................................. 253

Evaluate schedule return codes in schedule scripts.........................................................................254Return codes from preschedulecmd and postschedulecmd scripts................................................254

Client-acceptor scheduler services versus the traditional scheduler services..................................... 255Setting the client scheduler process to run as a background task and start automatically at startup 256Examples: Display information about scheduled work.......................................................................... 258Display information about completed work............................................................................................259Specify scheduling options......................................................................................................................260Scheduler options for commands........................................................................................................... 260Enable or disable scheduled commands................................................................................................ 260Manage multiple schedule requirements on one system...................................................................... 261

Chapter 8. Client return codes............................................................................263

Chapter 9. Storage management policies............................................................265Policy domains and policy sets............................................................................................................... 265Management classes and copy groups................................................................................................... 266Display information about management classes and copy groups....................................................... 267

Copy group name attribute................................................................................................................ 268Copy type attribute............................................................................................................................ 268Copy frequency attribute................................................................................................................... 268Versions data exists attribute............................................................................................................ 268Versions data deleted attribute......................................................................................................... 268

vii

Retain extra versions attribute.......................................................................................................... 268Retain only version attribute..............................................................................................................268Copy serialization attribute................................................................................................................269Copy mode parameter....................................................................................................................... 269Copy destination attribute................................................................................................................. 270Retain versions attribute....................................................................................................................270Deduplicate data attribute.................................................................................................................270

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

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

Chapter 10. Processing options.......................................................................... 277Processing options overview...................................................................................................................277Communication options.......................................................................................................................... 278

TCP/IP options................................................................................................................................... 278Shared memory options.....................................................................................................................279

Server options..........................................................................................................................................279Backup and archive processing options................................................................................................. 280Restore and retrieve processing options................................................................................................ 289Scheduling options.................................................................................................................................. 292Format and language options..................................................................................................................294Command processing options.................................................................................................................294Authorization options.............................................................................................................................. 294Error processing options......................................................................................................................... 295Transaction processing options.............................................................................................................. 295Web client options................................................................................................................................... 296Diagnostics options................................................................................................................................. 297Using options with commands................................................................................................................ 297

Entering options with a command.....................................................................................................298Initial command-line-only options.................................................................................................... 304Client options that can be set by the IBM Spectrum Protect server................................................ 304

Client options reference.......................................................................................................................... 306Absolute.......................................................................................................................................... 306Afmskipuncachedfiles................................................................................................................ 307Archmc...............................................................................................................................................308Archsymlinkasfile.......................................................................................................................308Asnodename...................................................................................................................................... 309Auditlogging..................................................................................................................................311Auditlogname..................................................................................................................................312Autodeploy...................................................................................................................................... 314Autofsrename..................................................................................................................................315Automount........................................................................................................................................ 316Backmc...............................................................................................................................................317Backupsetname............................................................................................................................... 318Basesnapshotname.........................................................................................................................319Cadlistenonport........................................................................................................................... 320Changingretries........................................................................................................................... 321Class................................................................................................................................................. 321Collocatebyfilespec.................................................................................................................. 322Commmethod...................................................................................................................................... 323Commrestartduration.................................................................................................................. 324

viii

Commrestartinterval.................................................................................................................. 325Compressalways............................................................................................................................. 325Compression....................................................................................................................................326Console.............................................................................................................................................328Createnewbase............................................................................................................................... 329Csv..................................................................................................................................................... 330Datacenter...................................................................................................................................... 333Datastore........................................................................................................................................ 333Dateformat...................................................................................................................................... 334Dedupcachepath............................................................................................................................. 337Dedupcachesize............................................................................................................................. 338Deduplication............................................................................................................................... 338Defaultserver............................................................................................................................... 339Deletefiles....................................................................................................................................340Description....................................................................................................................................341Detail...............................................................................................................................................342Diffsnapshot..................................................................................................................................343Diffsnapshotname.........................................................................................................................344Dirmc................................................................................................................................................. 345Dirsonly.......................................................................................................................................... 346Disablenqr...................................................................................................................................... 347Diskbuffsize..................................................................................................................................347Diskcachelocation.......................................................................................................................348Domain...............................................................................................................................................349Domain.image..................................................................................................................................353Domain.nas...................................................................................................................................... 354Domain.vmfull............................................................................................................................... 355Dontload.......................................................................................................................................... 361Dynamicimage..................................................................................................................................362Efsdecrypt...................................................................................................................................... 363Enablearchiveretentionprotection......................................................................................363Enablededupcache.........................................................................................................................365Enableinstrumentation..............................................................................................................366Enablelanfree............................................................................................................................... 367Encryptiontype............................................................................................................................. 368Encryptkey...................................................................................................................................... 369Errorlogmax....................................................................................................................................371Errorlogname..................................................................................................................................372Errorlogretention.......................................................................................................................373Exclude options........................................................................................................................... 374Fbbranch.......................................................................................................................................... 381Fbclientname..................................................................................................................................382Fbpolicyname..................................................................................................................................383Fbreposlocation........................................................................................................................... 384Fbserver.......................................................................................................................................... 385Fbvolumename..................................................................................................................................386Filelist.......................................................................................................................................... 387Filename.......................................................................................................................................... 389Filesonly........................................................................................................................................ 390Followsymbolic............................................................................................................................. 391Forcefailover............................................................................................................................... 392Fromdate.......................................................................................................................................... 393Fromnode.......................................................................................................................................... 394Fromowner........................................................................................................................................ 395Fromtime.......................................................................................................................................... 395Groupname........................................................................................................................................ 396Groups (deprecated).........................................................................................................................396Host................................................................................................................................................... 397

ix

Httpport.......................................................................................................................................... 397Hsmreparsetag............................................................................................................................... 397Ieobjtype........................................................................................................................................ 399Ifnewer.............................................................................................................................................399Imagegapsize..................................................................................................................................400Imagetofile....................................................................................................................................401Inactive.......................................................................................................................................... 401Inclexcl.......................................................................................................................................... 402Include options.................................................................................................................................. 403Incrbydate...................................................................................................................................... 420Incremental....................................................................................................................................421Instrlogmax....................................................................................................................................421Instrlogname..................................................................................................................................422Lanfreecommmethod.......................................................................................................................423Lanfreeshmport............................................................................................................................. 425Lanfreetcpport............................................................................................................................. 425Lanfreessl...................................................................................................................................... 426Lanfreetcpserveraddress......................................................................................................... 427Latest...............................................................................................................................................427Localbackupset............................................................................................................................. 428Makesparsefile............................................................................................................................. 429Managedservices........................................................................................................................... 430Maxcmdretries............................................................................................................................... 431Mbobjrefreshthresh.................................................................................................................... 432Mbpctrefreshthresh.................................................................................................................... 433Memoryefficientbackup..............................................................................................................434Mode................................................................................................................................................... 435Monitor.............................................................................................................................................438Myreplicationserver.................................................................................................................. 438Nasnodename....................................................................................................................................440Nfstimeout...................................................................................................................................... 441Nodename.......................................................................................................................................... 442Nojournal (AIX, Linux)........................................................................................................................443Noprompt.......................................................................................................................................... 443Nrtablepath....................................................................................................................................444Numberformat..................................................................................................................................445Optfile.............................................................................................................................................447Password.......................................................................................................................................... 447Passwordaccess............................................................................................................................. 449Passworddir....................................................................................................................................450Pick................................................................................................................................................... 451Pitdate.............................................................................................................................................452Pittime.............................................................................................................................................453Postschedulecmd/Postnschedulecmd...................................................................................... 453Postsnapshotcmd........................................................................................................................... 455Preschedulecmd/Prenschedulecmd...........................................................................................456Preservelastaccessdate............................................................................................................457Preservepath..................................................................................................................................458Presnapshotcmd............................................................................................................................. 461Queryschedperiod.........................................................................................................................462Querysummary..................................................................................................................................463Quiet................................................................................................................................................. 464Quotesareliteral.........................................................................................................................465Removeoperandlimit.................................................................................................................... 466Replace.............................................................................................................................................466Replserverguid............................................................................................................................. 467Replservername............................................................................................................................. 469Replsslport....................................................................................................................................470

x

Repltcpport....................................................................................................................................472Repltcpserveraddress................................................................................................................ 474Resourceutilization.................................................................................................................. 475Retryperiod....................................................................................................................................477Revokeremoteaccess.................................................................................................................... 478Schedcmddisabled.........................................................................................................................479Schedcmdexception.......................................................................................................................479Schedgroup...................................................................................................................................... 480Schedlogmax....................................................................................................................................481Schedlogname..................................................................................................................................482Schedlogretention.......................................................................................................................483Schedmode........................................................................................................................................ 485Schedrestretrdisabled..............................................................................................................486Scrolllines....................................................................................................................................487Scrollprompt..................................................................................................................................488Servername...................................................................................................................................... 489Sessioninitiation.......................................................................................................................490Setwindowtitle............................................................................................................................. 491Shmport.............................................................................................................................................492Showmembers....................................................................................................................................493Skipacl.............................................................................................................................................493Skipaclupdatecheck.................................................................................................................... 494Snapdiff.......................................................................................................................................... 494Snapdiffchangelogdir................................................................................................................ 499Snapdiffhttps............................................................................................................................... 501Snapshotcachesize.......................................................................................................................502Snapshotproviderfs.................................................................................................................... 503Snapshotproviderimage..............................................................................................................504Snapshotroot..................................................................................................................................504Srvoptsetencryptiondisabled.................................................................................................506Srvprepostscheddisabled......................................................................................................... 507Srvprepostsnapdisabled............................................................................................................508Ssl..................................................................................................................................................... 509Sslacceptcertfromserv..............................................................................................................510Ssldisablelegacytls.................................................................................................................. 511Sslfipsmode........................................................................................................................................512Sslrequired....................................................................................................................................512Stagingdirectory.........................................................................................................................514Subdir...............................................................................................................................................515Tagschedule....................................................................................................................................517Tapeprompt...................................................................................................................................... 520Tcpadminport..................................................................................................................................522Tcpbuffsize....................................................................................................................................522Tcpcadaddress............................................................................................................................... 523Tcpclientaddress.........................................................................................................................524Tcpclientport............................................................................................................................... 524Tcpnodelay...................................................................................................................................... 525Tcpport.............................................................................................................................................526Tcpserveraddress.........................................................................................................................526Tcpwindowsize............................................................................................................................... 527Timeformat...................................................................................................................................... 528Toc..................................................................................................................................................... 531Todate...............................................................................................................................................532Totime...............................................................................................................................................532Txnbytelimit..................................................................................................................................533Type................................................................................................................................................... 534Updatectime....................................................................................................................................535Useexistingbase........................................................................................................................... 535

xi

Usereplicationfailover............................................................................................................536Users (deprecated)...........................................................................................................................537V2archive........................................................................................................................................ 537Verbose.............................................................................................................................................538Verifyimage....................................................................................................................................539Virtualfsname............................................................................................................................... 539Virtualmountpoint.......................................................................................................................539Virtualnodename........................................................................................................................... 541Vmbackdir........................................................................................................................................ 541Vmbackuplocation.........................................................................................................................542Vmbackupmailboxhistory............................................................................................................544Vmbackuptype..................................................................................................................................544Vmchost.............................................................................................................................................545Vmcpw................................................................................................................................................. 546Vmctlmc.............................................................................................................................................547Vmcuser.............................................................................................................................................548Vmdatastorethreshold................................................................................................................ 548Vmdefaultdvportgroup.......................................................................................................................550Vmdefaultdvswitch............................................................................................................................ 551Vmdefaultnetwork............................................................................................................................. 551Vmenabletemplatebackups......................................................................................................... 552Vmlimitperdatastore.................................................................................................................. 554Vmlimitperhost............................................................................................................................. 555Vmmaxbackupsessions.................................................................................................................. 556Vmmaxparallel............................................................................................................................... 558Vmmaxrestoresessions................................................................................................................ 559Vmmaxrestoreparalleldisks..................................................................................................... 560Vmmaxrestoreparallelvms......................................................................................................... 561Vmmaxvirtualdisks.............................................................................................................................563Vmmc................................................................................................................................................... 564Vmnocbtcontinue........................................................................................................................... 564Vmnoprdmdisks............................................................................................................................... 565Vmnovrdmdisks............................................................................................................................... 566Vmpreferdagpassive.................................................................................................................... 567Vmprocessvmwithindependent...................................................................................................568Vmprocessvmwithprdm.................................................................................................................. 569Vmskipctlcompression................................................................................................................ 570Vmskipmaxvirtualdisks......................................................................................................................570Vmskipmaxvmdks.............................................................................................................................. 571Vmtagdatamover............................................................................................................................. 572Vmtagdefaultdatamover..............................................................................................................574Vmverifyifaction................................................................................................................................. 576Vmverifyiflatest.................................................................................................................................. 578Vmvstorcompr..................................................................................................................................579Vmvstortransport.........................................................................................................................580Vmtimeout........................................................................................................................................ 581Webports.......................................................................................................................................... 582Wildcardsareliteral.................................................................................................................. 583

Chapter 11. Using commands.............................................................................585Start and end a client command session................................................................................................588

Process commands in batch mode....................................................................................................588Process commands in interactive mode........................................................................................... 588

Enter client command names, options, and parameters....................................................................... 589Command name................................................................................................................................. 589Options............................................................................................................................................... 589Parameters......................................................................................................................................... 590

xii

File specification syntax.....................................................................................................................590Wildcard characters.................................................................................................................................592Client commands reference.................................................................................................................... 592Archive.................................................................................................................................................. 593Archive FastBack.............................................................................................................................. 595Backup FastBack.................................................................................................................................597Backup Group....................................................................................................................................... 600Backup Image....................................................................................................................................... 602

Static, dynamic, and snapshot image backup...................................................................................605Utilizing image backup to perform file system incremental backup................................................ 605

Backup NAS............................................................................................................................................606Backup VM..............................................................................................................................................608Cancel Process...................................................................................................................................615Cancel Restore...................................................................................................................................615Delete Access..................................................................................................................................... 616Delete Archive...................................................................................................................................616Delete Backup..................................................................................................................................... 618Delete Filespace.............................................................................................................................. 622Delete Group....................................................................................................................................... 623Expire.................................................................................................................................................... 624Help.........................................................................................................................................................626Incremental......................................................................................................................................... 627

Journal-based backup (AIX, Linux)................................................................................................... 631Incremental-by-Date......................................................................................................................... 632Associate a local snapshot with a server file space..........................................................................632

Loop.........................................................................................................................................................633Macro.......................................................................................................................................................634Monitor Process.................................................................................................................................635Preview Archive.................................................................................................................................635Preview Backup...................................................................................................................................636Query Access....................................................................................................................................... 637Query Archive..................................................................................................................................... 638Query Backup....................................................................................................................................... 640

Query NAS file system images...........................................................................................................643Query Backupset.................................................................................................................................643

Query Backupset without the backupsetname parameter........................................................645Query Filespace.................................................................................................................................646

Query NAS file spaces........................................................................................................................648Query Group......................................................................................................................................... 648Query Image......................................................................................................................................... 650Query Inclexcl...................................................................................................................................652Query Mgmtclass.................................................................................................................................653Query Node............................................................................................................................................654Query Options..................................................................................................................................... 655Query Restore..................................................................................................................................... 656Query Schedule...................................................................................................................................657Query Session..................................................................................................................................... 657Query Systeminfo.............................................................................................................................. 658Query VM................................................................................................................................................ 659Restart Restore.................................................................................................................................663Restore.................................................................................................................................................. 664

Restore from file spaces that are not Unicode-enabled...................................................................668Restore Backupset............................................................................................................................ 668

Restore backup sets: considerations and restrictions......................................................................671Restore backup sets in a SAN environment...................................................................................... 672Restore Backupset without the backupsetname parameter................................................... 672

Restore Group..................................................................................................................................... 675Restore Image..................................................................................................................................... 677

xiii

Restore NAS......................................................................................................................................... 679Restore VM............................................................................................................................................681

Preview virtual machine restore operations..................................................................................... 691Retrieve................................................................................................................................................ 693

Retrieve archives from file spaces that are not Unicode-enabled................................................... 696Schedule................................................................................................................................................ 696Selective..............................................................................................................................................698

Associate a local snapshot with a server file space..........................................................................700Set Access............................................................................................................................................701Set Event..............................................................................................................................................703Set Netappsvm ...................................................................................................................................705Set Password....................................................................................................................................... 706Set Vmtags............................................................................................................................................711

Data protection tagging overview......................................................................................................712

Appendix A. Accessibility...................................................................................723

Notices..............................................................................................................725Glossary............................................................................................................ 729

Index................................................................................................................ 731

xiv

Tables

1. Upgrading the client from different server versions.....................................................................................2

2. AIX client communication methods............................................................................................................. 4

3. Supported features on AIX ...........................................................................................................................4

4. HP-UX Itanium 2 API communication methods...........................................................................................4

5. Linux on Power Systems client communication methods..............................................