IBM Spectrum ProtectWindows 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 page751.

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........................................................................................................ xxiReading 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............................................................................................................... 2Windows client environment requirements.......................................................................................... 3

NDMP support requirements (Extended Edition only)................................................................................4Installation requirements for backing up and archiving Tivoli Storage Manager FastBack client data.... 4Client configuration wizard for Tivoli Storage Manager FastBack.............................................................. 5Windows client installation overview.......................................................................................................... 5

Windows client installation might require a reboot...............................................................................6Installation procedures.......................................................................................................................... 6Troubleshooting problems during installation ................................................................................... 18Software updates (Windows clients)...................................................................................................18

Installing the client management service.................................................................................................18

Chapter 2. Configure the IBM Spectrum Protect client.......................................... 19Client options file overview....................................................................................................................... 19

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

Environment variables (Windows).............................................................................................................24Configuring the language for displaying the backup-archive client GUI..................................................25Web client configuration overview............................................................................................................ 25

Configuring the web client on Windows systems................................................................................26Configuring the scheduler..........................................................................................................................28

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

Starting the client scheduler (Windows)...................................................................................................31Scheduling events using the GUI.........................................................................................................31

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

Creating a symbolic link to access the latest GSKit library.................................................................36Certificate Authorities root certificates............................................................................................... 38

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

Client-side data deduplication.................................................................................................................. 45Configuring the client for data deduplication...................................................................................... 49Excluding files from data deduplication.............................................................................................. 51

iii

Automated client failover configuration and use......................................................................................52Automated client failover overview..................................................................................................... 52Configuring the client for automated failover......................................................................................55Determining the status of replicated client data.................................................................................57Preventing automated client failover...................................................................................................58Forcing the client to fail over................................................................................................................59

Configuring the client to back up and archive Tivoli Storage Manager FastBack data............................ 59Configuring the backup-archive client to protect FastBack client data................................................... 60Backups in a cluster server environment..................................................................................................62

Protecting data in MSCS clusters (Windows Server clients)............................................................... 62Configure the web client in a cluster environment..............................................................................63Frequently asked questions.................................................................................................................70

Configuring online-image backup support................................................................................................72Configuring Open File Support.................................................................................................................. 72Configuring NetApp and IBM Spectrum Protect for snapshot difference incremental backups............ 73

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

Register your workstation with a server....................................................................................................80Closed registration............................................................................................................................... 81Open registration..................................................................................................................................81

Creating an include-exclude list ............................................................................................................... 81Include-exclude options...................................................................................................................... 82Determine compression and encryption processing.......................................................................... 90Preview include-exclude list files........................................................................................................ 91Include and exclude option processing...............................................................................................92Processing rules when using UNC names........................................................................................... 93

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

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

Secure password storage........................................................................................................................ 100Backup-archive client operations and security rights............................................................................ 101

Backup Operators group operations................................................................................................. 103Considerations before you start using a Backup Operators group account.....................................103

Permissions required to restore files that use adaptive subfile backup................................................104Permissions required to back up, archive, restore or retrieve files on cluster resources..................... 104IBM Spectrum Protect client authentication.......................................................................................... 104User account control............................................................................................................................... 105

Enabling client access to network shares when UAC is enabled..................................................... 105Starting a Java GUI session.....................................................................................................................106

IBM Spectrum Protect password...................................................................................................... 107Setup wizard.......................................................................................................................................107

Starting a command-line session............................................................................................................107Using batch mode.............................................................................................................................. 108Issuing a series of commands by using interactive mode................................................................ 108Displaying Euro characters in a command-line prompt....................................................................109Use options on the DSMC command................................................................................................. 109

Specifying input strings that contain blank spaces or quotation marks................................................ 110Using the web client in the new security environment...........................................................................110

Starting a web client session............................................................................................................. 111Starting a web user interface session for file-restore operations..........................................................112

Downloading system logs.................................................................................................................. 113Start the client scheduler automatically.................................................................................................115Changing your password......................................................................................................................... 115Sorting file lists using the backup-archive client GUI............................................................................ 117

iv

Displaying online help............................................................................................................................. 118Ending a session...................................................................................................................................... 118Online forums.......................................................................................................................................... 119

Chapter 4. Backing up your data.........................................................................121Planning your backups (Windows).......................................................................................................... 121Which files are backed up....................................................................................................................... 122Open file support for backup operations................................................................................................ 123Backing up data using the backup-archive client GUI........................................................................... 125

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

LAN-free data movement...................................................................................................................130Unicode file spaces (Windows)..........................................................................................................132Incremental backups on memory-constrained systems..................................................................132Incremental backups on systems with a large number of files........................................................133Control processing with an include-exclude list............................................................................... 134Data encryption during backup or archive operations...................................................................... 134Maximum file size for operations.......................................................................................................135How the client handles long user and group names.........................................................................136

Incremental, selective, or incremental-by-date backups (Windows)................................................... 136Full and partial incremental backup..................................................................................................136Incremental-by-date backup............................................................................................................ 140Comparing incremental-by-date, journal-based, and NetApp snapshot difference to full

incremental and partial incremental backups............................................................................. 140Snapshot differential backup with HTTPS (Windows)...................................................................... 141Selective backup................................................................................................................................ 143

Backing up files from one or more file spaces for a group backup (Windows)......................................143Backing up data with client-node proxy support (Windows)................................................................. 144

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

Associate a local snapshot with a server file space (Windows)............................................................. 147Backing up Windows system state......................................................................................................... 148Backing up Automated System Recovery files....................................................................................... 149Preparation for Automated System Recovery........................................................................................ 150

Creating a client options file for Automated System Recovery........................................................ 150Backing up the boot drive and system drive for Automated System Recovery............................... 151

Image backup.......................................................................................................................................... 152Performing prerequisite tasks before creating an image backup.....................................................153Utilizing image backups to perform file system incremental backups.............................................154Performing an image backup using the GUI......................................................................................156Performing an image backup using the command line.....................................................................157

Back up NAS file systems using Network Data Management Protocol..................................................157Backing up NAS file systems with the backup-archive client GUI using NDMP protocol................159Back up NAS file systems using the command line.......................................................................... 160Methods for backing up and recovering data on NAS file servers accessed by CIFS protocol....... 162

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

Preparing the environment for full backups of VMware virtual machines....................................... 165Creating full backups for VMware virtual machines..........................................................................167Parallel backups of virtual machines.................................................................................................169

Back up virtual machines on a Hyper-V system..................................................................................... 169Back up and archive Tivoli Storage Manager FastBack data..................................................................169Backing up Net Appliance CIFS share definitions.................................................................................. 170

v

Display backup processing status...........................................................................................................170Backup (Windows): Additional considerations.......................................................................................173

Open files............................................................................................................................................173Ambiguous file space names in file specifications............................................................................174Management classes......................................................................................................................... 174Deleted file systems...........................................................................................................................175Removable media backup..................................................................................................................175Fixed drives........................................................................................................................................ 176NTFS and ReFS file spaces................................................................................................................ 176Universal Naming Convention names................................................................................................176Microsoft Dfs file protection methods............................................................................................... 177

Chapter 5. Restoring your data...........................................................................181Duplicate file names................................................................................................................................ 181Universal Naming Convention names restore........................................................................................ 182Active or inactive backup restore............................................................................................................182Restoring files and directories................................................................................................................ 183

Restoring data by using the backup-archive client GUI................................................................... 183Examples for restoring data using the command line...................................................................... 183

Restoring Windows system state............................................................................................................187Restoring Automated System Recovery files..........................................................................................188Restoring the operating system when the computer is working............................................................188Recovering a computer when the Windows OS is not working ............................................................. 188

Creating a bootable WinPE CD...........................................................................................................189Restoring the Windows operating system with Automated System Recovery................................ 189

Microsoft Dfs tree and file restore...........................................................................................................189Restoring an image.................................................................................................................................. 190

Restoring an image using the GUI..................................................................................................... 191Restoring an image using the command line.................................................................................... 192

Restore data from a backup set.............................................................................................................. 192Restore backup sets: considerations and restrictions......................................................................194Backup set restore............................................................................................................................. 195Restoring backup sets using the GUI................................................................................................ 196Backup set restores using the client command-line interface.........................................................197

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

Restoring full VM backups................................................................................................................. 199Scenarios for running full VM instant access and full VM instant restore from the backup-

archive client command line.........................................................................................................203Scenario: Restoring file-level VM backups........................................................................................207Restoring full VM backups that were created with VMware Consolidated Backup......................... 210

Restore Windows individual Active Directory objects............................................................................ 212Reanimate tombstone objects or restoring from a system state backup........................................ 212Restoring Active Directory objects using the GUI and command line..............................................213Restrictions and limitations when restoring Active Directory objects............................................. 214Preserve attributes in tombstone objects......................................................................................... 215Modifying the client acceptor and agent services to use the web client..........................................215

Restoring or retrieving data during a failover......................................................................................... 216Authorizing another user to restore or retrieve your files...................................................................... 217Restoring or retrieving files from another client node............................................................................218Restoring or retrieving your files to another workstation.......................................................................219Deleting file spaces..................................................................................................................................220Restoring data to a point in time............................................................................................................. 221Restoring data from a retention set........................................................................................................ 222Restore NAS file systems........................................................................................................................ 223

Restoring NAS file systems using the backup-archive client GUI.................................................... 224Restoring NAS files and directories using the backup-archive client GUI....................................... 225

vi

Options and commands to restore NAS file systems from the command line................................ 226

Chapter 6. Archive and retrieve your data (Windows)..........................................229Archive files..............................................................................................................................................229

Snapshot backup or archive with open file support..........................................................................230Archiving data with the GUI............................................................................................................... 230Archive data examples by using the command line..........................................................................231Archiving data with client node proxy............................................................................................... 232Deleting archive data......................................................................................................................... 234

Retrieve archives..................................................................................................................................... 234Retrieving archives with the GUI....................................................................................................... 235Retrieve archive copies by using the command line.........................................................................235

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

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

Client-acceptor scheduler services versus the traditional scheduler services..................................... 241Setting the client scheduler process to run as a background task and start automatically at startup 242Examples: Display information about scheduled work.......................................................................... 243Display information about completed work............................................................................................245

Examples: event logs......................................................................................................................... 245Specify scheduling options......................................................................................................................248Enable or disable scheduled commands................................................................................................ 249Change processing options used by the scheduler service................................................................... 249Manage multiple schedule requirements on one system...................................................................... 250

Chapter 8. Client return codes............................................................................253

Chapter 9. Storage management policies............................................................255Policy domains and policy sets............................................................................................................... 255Management classes and copy groups................................................................................................... 255Display information about management classes and copy groups....................................................... 257

Copy group name attribute................................................................................................................ 257Copy type attribute............................................................................................................................ 257Copy frequency attribute................................................................................................................... 257Versions data exists attribute............................................................................................................ 258Versions data deleted attribute......................................................................................................... 258Retain extra versions attribute.......................................................................................................... 258Retain only version attribute..............................................................................................................258Copy serialization attribute................................................................................................................258Copy mode parameter....................................................................................................................... 259Copy destination attribute................................................................................................................. 260Retain versions attribute....................................................................................................................260Deduplicate data attribute.................................................................................................................260

Select a management class for files....................................................................................................... 260Assign a management class to files........................................................................................................ 261Override the management class for archived files................................................................................. 262Select a management class for directories.............................................................................................262Bind management classes to files.......................................................................................................... 262Rebind backup versions of files.............................................................................................................. 263Retention grace period............................................................................................................................ 263Event-based policy retention protection................................................................................................ 264

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

vii

Chapter 10. Client Service Configuration Utility.................................................. 265Install the backup-archive scheduler service.........................................................................................265

Using the Client Service Configuration Utility (Windows)................................................................. 265dsmcutil command...............................................................................................................................269

Dsmcutil commands: Required options and examples.................................................................... 269Dsmcutil valid options........................................................................................................................279

Chapter 11. Processing options.......................................................................... 283Processing options overview...................................................................................................................283Communication options.......................................................................................................................... 284

TCP/IP options................................................................................................................................... 284Named Pipes option...........................................................................................................................285Shared memory options.....................................................................................................................285

Backup and archive processing options................................................................................................. 285Restore and retrieve processing options................................................................................................ 294Scheduling options.................................................................................................................................. 297Format and language options..................................................................................................................298Command processing options.................................................................................................................298Authorization options.............................................................................................................................. 299Error processing options......................................................................................................................... 299Transaction processing options.............................................................................................................. 300Web client options................................................................................................................................... 301Diagnostics options................................................................................................................................. 301Using options with commands................................................................................................................ 301

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

Client options reference.......................................................................................................................... 309Absolute.......................................................................................................................................... 310Adlocation...................................................................................................................................... 311Archmc...............................................................................................................................................311Asnodename...................................................................................................................................... 312Asrmode.............................................................................................................................................314Auditlogging..................................................................................................................................315Auditlogname..................................................................................................................................317Autodeploy...................................................................................................................................... 319Autofsrename..................................................................................................................................320Backmc...............................................................................................................................................322Backupsetname............................................................................................................................... 322Basesnapshotname.........................................................................................................................323Cadlistenonport........................................................................................................................... 324Casesensitiveaware.................................................................................................................... 325Changingretries........................................................................................................................... 326Class................................................................................................................................................. 327Clientview...................................................................................................................................... 327Clusterdisksonly.........................................................................................................................328Clustersharedfolder.................................................................................................................. 330Clusternode....................................................................................................................................331Collocatebyfilespec.................................................................................................................. 332Commmethod...................................................................................................................................... 333Commrestartduration.................................................................................................................. 334Commrestartinterval.................................................................................................................. 334Compressalways............................................................................................................................. 335Compression....................................................................................................................................336Console.............................................................................................................................................337Createnewbase............................................................................................................................... 339

viii

Csv..................................................................................................................................................... 340Datacenter...................................................................................................................................... 343Datastore........................................................................................................................................ 343Dateformat...................................................................................................................................... 344Dedupcachepath............................................................................................................................. 346Dedupcachesize............................................................................................................................. 347Deduplication............................................................................................................................... 347Deletefiles....................................................................................................................................348Description....................................................................................................................................349Detail...............................................................................................................................................350Diffsnapshot..................................................................................................................................351Diffsnapshotname.........................................................................................................................353Dirmc................................................................................................................................................. 354Dirsonly.......................................................................................................................................... 354Disablenqr...................................................................................................................................... 355Diskbuffsize..................................................................................................................................356Diskcachelocation.......................................................................................................................356Domain...............................................................................................................................................357Domain.image..................................................................................................................................360Domain.nas...................................................................................................................................... 361Domain.vmfull............................................................................................................................... 362Enable8dot3namesupport............................................................................................................368Enablearchiveretentionprotection......................................................................................369Enablededupcache.........................................................................................................................370Enableinstrumentation..............................................................................................................371Enablelanfree............................................................................................................................... 373Encryptiontype............................................................................................................................. 374Encryptkey...................................................................................................................................... 375Errorlogmax....................................................................................................................................376Errorlogname..................................................................................................................................378Errorlogretention.......................................................................................................................378Exclude options........................................................................................................................... 380Fbbranch.......................................................................................................................................... 386Fbclientname..................................................................................................................................387Fbpolicyname..................................................................................................................................388Fbreposlocation........................................................................................................................... 389Fbserver.......................................................................................................................................... 391Fbvolumename..................................................................................................................................392Filelist.......................................................................................................................................... 393Filename.......................................................................................................................................... 395Filesonly........................................................................................................................................ 396Forcefailover............................................................................................................................... 397Fromdate.......................................................................................................................................... 398Fromnode.......................................................................................................................................... 398Fromtime.......................................................................................................................................... 399Groupname........................................................................................................................................ 400Host................................................................................................................................................... 400Httpport.......................................................................................................................................... 401Hsmreparsetag............................................................................................................................... 401Ieobjtype........................................................................................................................................ 402Ifnewer.............................................................................................................................................403Imagegapsize..................................................................................................................................404Imagetofile....................................................................................................................................405Inactive.......................................................................................................................................... 405Inclexcl.......................................................................................................................................... 406Include options.................................................................................................................................. 407Incrbydate...................................................................................................................................... 423Incremental....................................................................................................................................423

ix

Incrthreshold............................................................................................................................... 424Instrlogmax....................................................................................................................................425Instrlogname..................................................................................................................................426Journalpipe....................................................................................................................................427Lanfreecommmethod.......................................................................................................................427Lanfreeshmport............................................................................................................................. 429Lanfreetcpport............................................................................................................................. 429Lanfreessl...................................................................................................................................... 430Lanfreetcpserveraddress......................................................................................................... 431Language.......................................................................................................................................... 431Latest...............................................................................................................................................432Localbackupset............................................................................................................................. 433Managedservices........................................................................................................................... 434Maxcmdretries............................................................................................................................... 435Mbobjrefreshthresh.................................................................................................................... 436Mbpctrefreshthresh.................................................................................................................... 437Memoryefficientbackup..............................................................................................................437Mode................................................................................................................................................... 439Monitor.............................................................................................................................................441Myprimaryserver........................................................................................................................... 442Myreplicationserver.................................................................................................................. 443Namedpipename............................................................................................................................... 444Nasnodename....................................................................................................................................445Nodename.......................................................................................................................................... 446Nojournal (Windows)......................................................................................................................... 447Noprompt.......................................................................................................................................... 447Nrtablepath....................................................................................................................................448Numberformat..................................................................................................................................449Optfile.............................................................................................................................................451Password.......................................................................................................................................... 451Passwordaccess............................................................................................................................. 453Pick................................................................................................................................................... 454Pitdate.............................................................................................................................................455Pittime.............................................................................................................................................456Postschedulecmd/Postnschedulecmd...................................................................................... 456Postsnapshotcmd........................................................................................................................... 458Preschedulecmd/Prenschedulecmd...........................................................................................459Preservelastaccessdate............................................................................................................461Preservepath..................................................................................................................................462Presnapshotcmd............................................................................................................................. 464Queryschedperiod.........................................................................................................................465Querysummary..................................................................................................................................466Quiet................................................................................................................................................. 468Replace.............................................................................................................................................468Replserverguid............................................................................................................................. 470Replservername............................................................................................................................. 471Replsslport....................................................................................................................................472Repltcpport....................................................................................................................................473Repltcpserveraddress................................................................................................................ 475Resetarchiveattribute..............................................................................................................476Resourceutilization.................................................................................................................. 477Retryperiod....................................................................................................................................479Revokeremoteaccess.................................................................................................................... 480Runasservice..................................................................................................................................481Schedcmddisabled.........................................................................................................................481Schedcmdexception.......................................................................................................................482Schedgroup...................................................................................................................................... 483Schedlogmax....................................................................................................................................484

x

Schedlogname..................................................................................................................................485Schedlogretention.......................................................................................................................486Schedmode........................................................................................................................................ 488Schedrestretrdisabled..............................................................................................................489Scrolllines....................................................................................................................................490Scrollprompt..................................................................................................................................491Sessioninitiation.......................................................................................................................492Setwindowtitle............................................................................................................................. 493Shmport.............................................................................................................................................494Showmembers....................................................................................................................................494Skipmissingsyswfiles................................................................................................................ 495Skipntpermissions.......................................................................................................................496Skipntsecuritycrc.......................................................................................................................497Skipsystemexclude.......................................................................................................................498Snapdiff.......................................................................................................................................... 498Snapdiffchangelogdir................................................................................................................ 503Snapdiffhttps............................................................................................................................... 504Snapshotproviderfs.................................................................................................................... 506Snapshotproviderimage..............................................................................................................507Snapshotroot..................................................................................................................................508Srvoptsetencryptiondisabled.................................................................................................510Srvprepostscheddisabled......................................................................................................... 511Srvprepostsnapdisabled............................................................................................................512Ssl..................................................................................................................................................... 512Sslacceptcertfromserv..............................................................................................................513Ssldisablelegacytls.................................................................................................................. 514Sslfipsmode........................................................................................................................................515Sslrequired....................................................................................................................................516Stagingdirectory.........................................................................................................................518Subdir...............................................................................................................................................519Systemstatebackupmethod......................................................................................................... 521Tagschedule....................................................................................................................................522Tapeprompt...................................................................................................................................... 525Tcpadminport..................................................................................................................................526Tcpbuffsize....................................................................................................................................527Tcpcadaddress............................................................................................................................... 528Tcpclientaddress.........................................................................................................................528Tcpclientport............................................................................................................................... 529Tcpnodelay...................................................................................................................................... 530Tcpport.............................................................................................................................................530Tcpserveraddress.........................................................................................................................531Tcpwindowsize............................................................................................................................... 532Timeformat...................................................................................................................................... 533Toc..................................................................................................................................................... 534Todate...............................................................................................................................................535Totime...............................................................................................................................................536Txnbytelimit..................................................................................................................................536Type................................................................................................................................................... 537Usedirectory..................................................................................................................................538Useexistingbase........................................................................................................................... 539Usereplicationfailover............................................................................................................540V2archive........................................................................................................................................ 540Verbose.............................................................................................................................................541Verifyimage....................................................................................................................................542Virtualfsname............................................................................................................................... 542Virtualnodename........................................................................................................................... 543Vmautostartvm............................................................................................................................... 544Vmbackdir........................................................................................................................................ 545

xi

Vmbackuplocation.........................................................................................................................545Vmbackupmailboxhistory............................................................................................................547Vmbackuptype..................................................................................................................................547Vmchost.............................................................................................................................................548Vmcpw................................................................................................................................................. 549Vmctlmc.............................................................................................................................................550Vmcuser.............................................................................................................................................551Vmdatastorethreshold................................................................................................................ 552Vmdefaultdvportgroup.......................................................................................................................553Vmdefaultdvswitch............................................................................................................................ 554Vmdefaultnetwork............................................................................................................................. 555Vmdiskprovision........................................................................................................................... 556Vmenabletemplatebackups......................................................................................................... 556Vmexpireprotect........................................................................................................................... 558Vmiscsiadapter............................................................................................................................. 559Vmiscsiserveraddress................................................................................................................ 560Vmlimitperdatastore.................................................................................................................. 560Vmlimitperhost............................................................................................................................. 562Vmmaxbackupsessions.................................................................................................................. 563Vmmaxparallel............................................................................................................................... 565Vmmaxrestoresessions................................................................................................................ 566Vmmaxrestoreparalleldisks..................................................................................................... 567Vmmaxrestoreparallelvms......................................................................................................... 568Vmmaxvirtualdisks.............................................................................................................................569Vmmc................................................................................................................................................... 571Vmmountage...................................................................................................................................... 571Vmnocbtcontinue........................................................................................................................... 572Vmnoprdmdisks............................................................................................................................... 573Vmnovrdmdisks............................................................................................................................... 574Vmpreferdagpassive.................................................................................................................... 574Vmprocessvmwithindependent...................................................................................................575Vmprocessvmwithprdm.................................................................................................................. 576Vmrestoretype............................................................................................................................... 577Vmskipctlcompression................................................................................................................ 580Vmskipmaxvirtualdisks......................................................................................................................580Vmskipmaxvmdks.............................................................................................................................. 581Vmstoragetype............................................................................................................................... 581Vmtagdatamover............................................................................................................................. 582Vmtagdefaultdatamover..............................................................................................................585Vmtempdatastore........................................................................................................................... 587Vmverifyifaction................................................................................................................................. 587Vmverifyiflatest.................................................................................................................................. 589Vmvstorcompr..................................................................................................................................590Vmvstortransport.........................................................................................................................591Vmtimeout........................................................................................................................................ 592Vssaltstagingdir.........................................................................................................................593Vssusesystemprovider................................................................................................................ 594Webports.......................................................................................................................................... 595

Chapter 12. Using commands.............................................................................597Start and end a client command session................................................................................................600

Process commands in batch mode....................................................................................................600Process commands in interactive mode........................................................................................... 601

Enter client command names, options, and parameters....................................................................... 601Command name................................................................................................................................. 601Options............................................................................................................................................... 602Parameters......................................................................................................................................... 602

xii

File specification syntax.....................................................................................................................603Wildcard characters.................................................................................................................................604Client commands reference.................................................................................................................... 605Archive.................................................................................................................................................. 605

Open file support................................................................................................................................607Archive FastBack.............................................................................................................................. 607Backup FastBack.................................................................................................................................610Backup Group....................................................................................................................................... 613Backup Image....................................................................................................................................... 615

Offline and online image backup....................................................................................................... 617Utilizing image backup to perform file system incremental backup................................................ 617

Backup NAS............................................................................................................................................618Backup Systemstate..........................................................................................................................620Backup VM..............................................................................................................................................622Cancel Process...................................................................................................................................629Cancel Restore...................................................................................................................................629Delete Access..................................................................................................................................... 630Delete Archive...................................................................................................................................631Delete Backup..................................................................................................................................... 632Delete Filespace.............................................................................................................................. 636Delete Group....................................................................................................................................... 637Expire.................................................................................................................................................... 639Help.........................................................................................................................................................640Incremental......................................................................................................................................... 641

Open file support................................................................................................................................645Journal-based backup (Windows).....................................................................................................645Backing up NTFS or ReFS volume mount points...............................................................................647Back up Microsoft Dfs root.................................................................................................................648Incremental-by-Date......................................................................................................................... 648Associate a local snapshot with a server file space..........................................................................648

Loop.........................................................................................................................................................649Macro.......................................................................................................................................................649Monitor Process.................................................................................................................................650Preview Archive.................................................................................................................................651Preview Backup...................................................................................................................................652Query Access....................................................................................................................................... 653Query Adobjects.................................................................................................................................653Query Archive..................................................................................................................................... 655Query Backup....................................................................................................................................... 657

Query NAS file system images...........................................................................................................661Query Backupset.................................................................................................................................661

Query Backupset without the backupsetname parameter........................................................662Query Filespace.................................................................................................................................664

Query NAS file spaces........................................................................................................................666Query Group......................................................................................................................................... 666Query Image......................................................................................................................................... 668Query Inclexcl...................................................................................................................................670Query Mgmtclass.................................................................................................................................671Query Node............................................................................................................................................672Query Options..................................................................................................................................... 673Query Restore..................................................................................................................................... 674Query Schedule...................................................................................................................................675Query Session..................................................................................................................................... 675Query Systeminfo.............................................................................................................................. 676Query Systemstate............................................................................................................................ 678Query VM................................................................................................................................................ 679Restart Restore.................................................................................................................................683Restore.................................................................................................................................................. 684

xiii

Restoring NTFS or ReFS volume mount points................................................................................. 689Restore Microsoft Dfs junctions.........................................................................................................690Restore active files.............................................................................................................................690Universal Naming Convention restores............................................................................................. 690Restore from file spaces that are not Unicode-enabled...................................................................691Restore named streams.....................................................................................................................691Restore sparse files............................................................................................................................691

Restore Adobjects............................................................................................................................ 691Restore Backupset............................................................................................................................ 693

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

Restore Group..................................................................................................................................... 699Restore Image..................................................................................................................................... 701Restore NAS......................................................................................................................................... 704Restore Systemstate........................................................................................................................706Restore VM............................................................................................................................................706

Preview virtual machine restore operations..................................................................................... 716Retrieve................................................................................................................................................ 718

Retrieve archives from file spaces that are not Unicode-enabled................................................... 722Retrieve named streams....................................................................................................................722Retrieve sparse files...........................................................................................................................722

Schedule................................................................................................................................................ 722Selective..............................................................................................................................................724

Open file support................................................................................................................................726Associate a local snapshot with a server file space..........................................................................726

Set Access....................................................................................................................................