
Backup-Archive Client Command Line Help


Version 8.1.13


Contents


1.0 What's new for version 8.1.13
2.0 Using commands
  2.1 Start and end a client command session
    2.1.1 Process commands in batch mode
    2.1.2 Process commands in interactive mode
  2.2 Enter client command names, options, and parameters
    2.2.1 Command name
    2.2.2 Options
      2.2.2.1 Options in interactive mode
    2.2.3 Parameters
    2.2.4 File specification syntax
  2.3 Wildcard characters
  2.4 Client commands reference
  2.5 Archive
  2.6 Archive FastBack
  2.7 Backup FastBack
  2.8 Backup Group
  2.9 Backup Image
    2.9.1 Static, dynamic, and snapshot image backup
    2.9.2 Utilizing image backup to perform file system incremental
    backup
  2.10 Backup NAS
  2.11 Backup VM
  2.12 Cancel Process
  2.13 Cancel Restore
  2.14 Delete Access
  2.15 Delete Archive
  2.16 Delete Backup
  2.17 Delete Filespace
  2.18 Delete Group
  2.19 Expire
  2.20 Help
  2.21 Incremental
    2.21.1 Journal-based backup
    2.21.2 Incremental-by-Date
    2.21.3 Associate a local snapshot with a server file space
  2.22 Loop
  2.23 Macro
  2.24 Monitor Process
  2.25 Preview Archive
  2.26 Preview Backup
  2.27 Query Access
  2.28 Query Archive
  2.29 Query Backup
    2.29.1 Query NAS file system images
  2.30 Query Backupset
    2.30.1 Query Backupset without the backupsetname parameter
  2.31 Query Filespace
    2.31.1 Query NAS file spaces
  2.32 Query Group
  2.33 Query Image
  2.34 Query Inclexcl
  2.35 Query Mgmtclass
  2.36 Query Node
  2.37 Query Options
  2.38 Query Restore
  2.39 Query Schedule
  2.40 Query Session
  2.41 Query Systeminfo
  2.42 Query VM
  2.43 Restart Restore
  2.44 Restore
    2.44.1 Restore from file spaces that are not Unicode-enabled
  2.45 Restore Backupset
    2.45.1 Restore backup sets: considerations and restrictions
    2.45.2 Restore backup sets in a SAN environment
    2.45.3 Restore Backupset without the backupsetname parameter
  2.46 Restore Group
  2.47 Restore Image
  2.48 Restore NAS
  2.49 Restore VM (VMware)
    2.49.1 Preview virtual machine restore operations (VMware)
  2.50 Retrieve
    2.50.1 Retrieve archives from file spaces that are not
    Unicode-enabled
  2.51 Schedule
  2.52 Selective
    2.52.1 Associate a local snapshot with a server file space
  2.53 Set Access
  2.54 Set Event
  2.55 Set Netappsvm
  2.56 Set Password
  2.57 Set Vmtags
    2.57.1 Data protection tagging overview
      2.57.1.1 Representation of tags in the IBM Spectrum Protect
      vSphere Client plug-in
      2.57.1.2 Supported data protection tags
      2.57.1.3 Inheritance of data protection settings
      2.57.1.4 Tips for data protection tagging
3.0 Processing options
  3.1 Server options
  3.2 Setting options in an options file
  3.3 Using options with commands
    3.3.1 Entering options with a command
    3.3.2 Initial command-line-only options
    3.3.3 Client options that can be set by the IBM Spectrum Protect
    server
  3.4 Client options reference
    3.4.1 Absolute
    3.4.2 Afmskipuncachedfiles
    3.4.3 Archmc
    3.4.4 Archsymlinkasfile
    3.4.5 Asnodename
      3.4.5.1 Session settings and schedules for a proxy operation
    3.4.6 Auditlogging
    3.4.7 Auditlogname
    3.4.8 Autodeploy
    3.4.9 Autofsrename
    3.4.10 Automount
    3.4.11 Backmc
    3.4.12 Backupsetname
    3.4.13 Basesnapshotname
    3.4.14 Cadlistenonport
    3.4.15 Changingretries
    3.4.16 Class
    3.4.17 Collocatebyfilespec
    3.4.18 Commmethod
    3.4.19 Commrestartduration
    3.4.20 Commrestartinterval
    3.4.21 Compressalways
    3.4.22 Compression
    3.4.23 Console
    3.4.24 Createnewbase
    3.4.25 Csv
    3.4.26 Datacenter
    3.4.27 Datastore
    3.4.28 Dateformat
    3.4.29 Dedupcachepath
    3.4.30 Dedupcachesize
    3.4.31 Deduplication
    3.4.32 Defaultserver
    3.4.33 Deletefiles
    3.4.34 Description
    3.4.35 Detail
    3.4.36 Diffsnapshot
    3.4.37 Diffsnapshotname
    3.4.38 Dirmc
    3.4.39 Dirsonly
    3.4.40 Disablenqr
    3.4.41 Diskbuffsize
    3.4.42 Diskcachelocation
    3.4.43 Domain
    3.4.44 Domain.image
    3.4.45 Domain.nas
    3.4.46 Domain.vmfull
    3.4.47 Dontload
    3.4.48 Dynamicimage
    3.4.49 Efsdecrypt
    3.4.50 Enablearchiveretentionprotection
    3.4.51 Enablededupcache
    3.4.52 Enableinstrumentation
    3.4.53 Enablelanfree
    3.4.54 Encryptiontype
    3.4.55 Encryptkey
    3.4.56 Errorlogmax
    3.4.57 Errorlogname
    3.4.58 Errorlogretention
    3.4.59 Exclude options
      3.4.59.1 Controlling symbolic link and alias processing
      3.4.59.2 Controlling compression processing
      3.4.59.3 Processing NAS file systems
      3.4.59.4 Virtual machine exclude options
        3.4.59.4.1 Exclude.vmdisk
        3.4.59.4.2 Exclude.vmlocalsnapshot
    3.4.60 Fbbranch
    3.4.61 Fbclientname
    3.4.62 Fbpolicyname
    3.4.63 Fbreposlocation
    3.4.64 Fbserver
    3.4.65 Fbvolumename
    3.4.66 Filelist
    3.4.67 Filename
    3.4.68 Filesonly
    3.4.69 Followsymbolic
    3.4.70 Forcefailover
    3.4.71 Fromdate
    3.4.72 Fromnode
    3.4.73 Fromowner
    3.4.74 Fromtime
    3.4.75 Groupname
    3.4.76 Groups (deprecated)
    3.4.77 Host
    3.4.78 Httpport
    3.4.79 Hsmreparsetag
    3.4.80 Ieobjtype
    3.4.81 Ifnewer
    3.4.82 Imagegapsize
    3.4.83 Imagetofile
    3.4.84 Inactive
    3.4.85 Inclexcl
      3.4.85.1 Considerations for Unicode-enabled clients
    3.4.86 Include options
      3.4.86.1 Controlling symbolic link and alias processing
      3.4.86.2 Compression and encryption backup processing
      3.4.86.3 Processing NAS file systems
      3.4.86.4 Virtual machine include options
        3.4.86.4.1 Include.vm
        3.4.86.4.2 Include.vmdisk
        3.4.86.4.3 Include.vmlocalsnapshot
        3.4.86.4.4 Include.vmresetcbt
        3.4.86.4.5 INCLUDE.VMSNAPSHOTATTEMPTS
        3.4.86.4.6 INCLUDE.VMTSMVSS
    3.4.87 Incrbydate
    3.4.88 Incremental
    3.4.89 Instrlogmax
    3.4.90 Instrlogname
    3.4.91 Lanfreecommmethod
    3.4.92 Lanfreeshmport
    3.4.93 Lanfreetcpport
    3.4.94 Lanfreessl
    3.4.95 Lanfreetcpserveraddress
    3.4.96 Latest
    3.4.97 Localbackupset
    3.4.98 Makesparsefile
    3.4.99 Managedservices
    3.4.100 Maxcmdretries
    3.4.101 Mbobjrefreshthresh
    3.4.102 Mbpctrefreshthresh
    3.4.103 Memoryefficientbackup
    3.4.104 Mode
    3.4.105 Monitor
    3.4.106 Myreplicationserver
    3.4.107 Nasnodename
    3.4.108 Nfstimeout
    3.4.109 Nodename
    3.4.110 Nojournal
    3.4.111 Noprompt
    3.4.112 Nrtablepath
    3.4.113 Numberformat
    3.4.114 Optfile
    3.4.115 Password
    3.4.116 Passwordaccess
    3.4.117 Passworddir
    3.4.118 Pick
    3.4.119 Pitdate
    3.4.120 Pittime
    3.4.121 Postschedulecmd/Postnschedulecmd
    3.4.122 Postsnapshotcmd
    3.4.123 Preschedulecmd/Prenschedulecmd
    3.4.124 Preservelastaccessdate
    3.4.125 Preservepath
    3.4.126 Presnapshotcmd
    3.4.127 Queryschedperiod
    3.4.128 Querysummary
    3.4.129 Quiet
    3.4.130 Quotesareliteral
    3.4.131 Removeoperandlimit
    3.4.132 Replace
    3.4.133 Replserverguid
    3.4.134 Replservername
    3.4.135 Replsslport
    3.4.136 Repltcpport
    3.4.137 Repltcpserveraddress
    3.4.138 Resourceutilization
      3.4.138.1 Regulating backup and archive sessions
      3.4.138.2 Regulating restore sessions
      3.4.138.3 Multiple client session considerations
    3.4.139 Retryperiod
    3.4.140 Revokeremoteaccess
    3.4.141 Schedcmddisabled
    3.4.142 Schedcmdexception
    3.4.143 Schedgroup
    3.4.144 Schedlogmax
    3.4.145 Schedlogname
    3.4.146 Schedlogretention
    3.4.147 Schedmode
    3.4.148 Schedrestretrdisabled
    3.4.149 Scrolllines
    3.4.150 Scrollprompt
    3.4.151 Servername
    3.4.152 Sessioninitiation
    3.4.153 Setwindowtitle
    3.4.154 Shmport
    3.4.155 Showmembers
    3.4.156 Skipacl
    3.4.157 Skipaclupdatecheck
    3.4.158 Snapdiff
    3.4.159 Snapdiffchangelogdir
    3.4.160 Snapdiffhttps
    3.4.161 Snapshotcachesize
    3.4.162 Snapshotproviderfs
    3.4.163 Snapshotproviderimage
    3.4.164 Snapshotroot
    3.4.165 Srvoptsetencryptiondisabled
    3.4.166 Srvprepostscheddisabled
    3.4.167 Srvprepostsnapdisabled
    3.4.168 Ssl
    3.4.169 Sslacceptcertfromserv
    3.4.170 Ssldisablelegacytls
    3.4.171 Sslfipsmode
    3.4.172 Sslrequired
    3.4.173 Stagingdirectory
    3.4.174 Subdir
    3.4.175 Tagschedule
      3.4.175.1 Using the tagschedule option for ad hoc backup
      operations
      3.4.175.2 Using the tagschedule option to rebalance scheduled
      operations
    3.4.176 Tapeprompt
    3.4.177 Tcpadminport
    3.4.178 Tcpbuffsize
    3.4.179 Tcpcadaddress
    3.4.180 Tcpclientaddress
    3.4.181 Tcpclientport
    3.4.182 Tcpnodelay
    3.4.183 Tcpport
    3.4.184 Tcpserveraddress
    3.4.185 Tcpwindowsize
    3.4.186 Timeformat
    3.4.187 Toc
    3.4.188 Todate
    3.4.189 Totime
    3.4.190 Txnbytelimit
    3.4.191 Type
    3.4.192 Updatectime
    3.4.193 Useexistingbase
    3.4.194 Usereplicationfailover
    3.4.195 Users (deprecated)
    3.4.196 V2archive
    3.4.197 Verbose
    3.4.198 Verifyimage
    3.4.199 Virtualfsname
    3.4.200 Virtualmountpoint
    3.4.201 Virtualnodename
    3.4.202 Vmbackdir
    3.4.203 Vmbackuplocation
    3.4.204 Vmbackupmailboxhistory
    3.4.205 Vmbackuptype
    3.4.206 Vmchost
    3.4.207 Vmcpw
    3.4.208 Vmctlmc
    3.4.209 Vmcuser
    3.4.210 Vmdatastorethreshold
    3.4.211 Vmdefaultdvportgroup
    3.4.212 Vmdefaultdvswitch
    3.4.213 Vmdefaultnetwork
    3.4.214 Vmenabletemplatebackups
    3.4.215 Vmlimitperdatastore
    3.4.216 Vmlimitperhost
    3.4.217 Vmmaxbackupsessions
    3.4.218 Vmmaxparallel
    3.4.219 Vmmaxrestoresessions
    3.4.220 Vmmaxrestoreparalleldisks (VMware)
    3.4.221 Vmmaxrestoreparallelvms (VMware)
    3.4.222 Vmmaxvirtualdisks
    3.4.223 Vmmc
    3.4.224 Vmnocbtcontinue
    3.4.225 Vmnoprdmdisks
    3.4.226 Vmnovrdmdisks
    3.4.227 Vmpreferdagpassive
    3.4.228 Vmprocessvmwithindependent
    3.4.229 Vmprocessvmwithprdm
    3.4.230 Vmskipctlcompression
    3.4.231 Vmskipmaxvirtualdisks
    3.4.232 Vmskipmaxvmdks
    3.4.233 Vmtagdatamover
    3.4.234 Vmtagdefaultdatamover
    3.4.235 Vmverifyifaction
    3.4.236 Vmverifyiflatest
    3.4.237 Vmvstorcompr
    3.4.238 Vmvstortransport
    3.4.239 Vmtimeout
    3.4.240 Webports
    3.4.241 Wildcardsareliteral
4.0 Display a message


1.0 What's new for version 8.1.13


IBM Spectrum(R) Protect 8.1.13 introduces new features and updates.

The web user interface is available for backup, archive, and retrieve
operations
         In addition to the existing file restore function in the IBM
         Spectrum Protect web user interface, you can now run file
         backup, archive, and retrieve operations in the web user
         interface.

Data replication to multiple servers
         IBM Spectrum Protect 8.1.13 supports multi-target replication,
         which is the process of replicating client data from a source
         replication server to multiple target replication servers. In
         previous releases, data can be replicated only to a single
         target replication server. You can now specify up to two target
         replication servers to use during automated client failover.
         For more information, see 3.4.106 Myreplicationserver.
         In the client documentation, the previously used term for these
         servers, secondary server, is replaced with the term failover
         server.

Snapshot difference incremental backups are discontinued if you upgrade
to NetApp Data ONTAP 9.10.1 or later
         If you upgrade to NetApp Data ONTAP 9.10.1 or later, snapshot
         difference incremental backups are no longer supported.
         Instead, use the following methods to protect NetApp filers:

         *  Run snapshot difference incremental backups with an earlier
            supported version of ONTAP until it reaches end-of-support
            by NetApp.

         *  Use NDMP volume-based backup.

         *  Run incremental backup operations without the snapdiff
            option.

         For more information, see
         https://www.ibm.com/support/pages/node/6449354.

Changes in the IBM Spectrum Protect server backdel parameter
         When a group backup, image backup, or system state backup is
         interrupted or fails, the client attempts to clean up the
         incomplete backup on the IBM Spectrum Protect server when the
         next backup is run. If the server administrator gave the client
         node permission to delete backups by setting the backdel option
         to Yes, the incomplete backup is removed. If the backdel option
         is set to No, the incomplete backup is deactivated and will
         expire according to the policy definition on the server.

FIPS installable rpm packages are available for Linux(R) x86_64 clients
         Federal Information Processing Standards (FIPS) installable
         packages are available for the Linux x86_64 clients.

         As no supported GSKit rpm packages are available for the Linux
         on Power(R) Systems (Little Endian) and Linux on System z®
         clients, FIPS installable packages are not available for these
         Linux clients. You can install the backup-archive client in
         non-FIPS mode and then restart the operating system in FIPS
         mode to use the backup-archive client.

Maintenance updates
         Updates for APARs are provided.


2.0 Using commands


The backup-archive client provides a command-line interface (CLI) that
you can use as an alternative to the graphical user interface (GUI).
This topic describes how to start or end a client command session and
how to enter commands.

*  2.1 Start and end a client command session

*  2.2 Enter client command names, options, and parameters

*  2.3 Wildcard characters

The following table provides an alphabetical list of the commands and a
brief description.

Table 1. Commands

+------------------------+--------------------------------------------+
| Command                  Description                                |
+------------------------+--------------------------------------------+
| archive                  Archives files from a workstation to IBM   |
|                          Spectrum Protect storage.                  |
+------------------------+--------------------------------------------+
| backup fastback          Backs up volumes specified by the          |
|                          fbpolicyname , fbclientname and            |
|                          fbvolumename options for long term         |
|                          retention.                                 |
+------------------------+--------------------------------------------+
| backup group             Creates and backs up a group containing a  |
|                          list of files from one or more file space  |
|                          origins to a virtual file space on the IBM |
|                          Spectrum Protect server.                   |
+------------------------+--------------------------------------------+
| backup image             Creates an image backup of one or more     |
|                          file systems or logical volumes that you   |
|                          specify.                                   |
+------------------------+--------------------------------------------+
| backup nas               Creates an image backup of one or more     |
|                          file systems belonging to a Network        |
|                          Attached Storage (NAS) file server.        |
+------------------------+--------------------------------------------+
| backup vm                Backs up virtual machines specified in the |
|                          vmlist option.                             |
+------------------------+--------------------------------------------+
| cancel process           Displays a list of current NAS (if NDMP    |
|                          support is enabled) image backup and       |
|                          restore processes for which the            |
|                          administrative user has authority.         |
+------------------------+--------------------------------------------+
| cancel restore           Displays a list of restartable restore     |
|                          sessions from which you can select one to  |
|                          cancel.                                    |
+------------------------+--------------------------------------------+
| delete access            Deletes authorization rules for files that |
|                          are stored on the server.                  |
|                          On those clients that support image        |
|                          backup, this command deletes authorization |
|                          rules for images that are stored on the    |
|                          server.                                    |
|                                                                     |
+------------------------+--------------------------------------------+
| delete archive           Deletes archived files from IBM Spectrum   |
|                          Protect server storage.                    |
+------------------------+--------------------------------------------+
| delete backup            Deletes active and inactive backup files   |
|                          from IBM Spectrum Protect server storage.  |
+------------------------+--------------------------------------------+
| delete filespace         Deletes file spaces in IBM Spectrum        |
|                          Protect server storage.                    |
+------------------------+--------------------------------------------+
| delete group             Deletes a group backup on the IBM Spectrum |
|                          Protect server.                            |
+------------------------+--------------------------------------------+
| expire                   Inactivates backup objects that you        |
|                          specify in the file specification or with  |
|                          the filelist option.                       |
+------------------------+--------------------------------------------+
| help                     Displays a Table of Contents of help       |
|                          topics for the command-line client.        |
+------------------------+--------------------------------------------+
| incremental                                                         |
|                          Backs up all new or changed files or       |
|                          directories in the default client domain   |
|                          or from file systems, directories, or      |
|                          files you specify, unless you exclude them |
|                          from backup services.                      |
+------------------------+--------------------------------------------+
| loop                     Starts an interactive command session.     |
+------------------------+--------------------------------------------+
| macro                    Executes commands within a macro file that |
|                          you specify.                               |
+------------------------+--------------------------------------------+
| monitor process          Displays a list of current NAS image       |
|                          backup and restore processes from which    |
|                          you can select one to cancel.              |
+------------------------+--------------------------------------------+
| preview archive          Simulates an archive command without       |
|                          sending data to the server.                |
+------------------------+--------------------------------------------+
| preview backup           Simulates a backup command without sending |
|                          data to the server.                        |
+------------------------+--------------------------------------------+
| query access             Displays a list of current authorization   |
|                          rules.                                     |
+------------------------+--------------------------------------------+
| query archive            Displays a list of archived files.         |
+------------------------+--------------------------------------------+
| query backup             Displays a list of backup versions.        |
+------------------------+--------------------------------------------+
| query backupset          Queries a backup set from a local file or  |
|                          the IBM Spectrum Protect server. On those  |
|                          clients that support tape devices, this    |
|                          command can query a backup set from a tape |
|                          device.                                    |
+------------------------+--------------------------------------------+
| query filespace          Displays a list of file spaces in IBM      |
|                          Spectrum Protect storage. You can also     |
|                          specify a single file space name to query. |
+------------------------+--------------------------------------------+
| query group              Displays information about group backups   |
|                          and their members.                         |
+------------------------+--------------------------------------------+
| query image              Displays information about image backups.  |
+------------------------+--------------------------------------------+
| query inclexcl           Displays a list of include-exclude         |
|                          statements in the order in which they are  |
|                          processed during backup and archive        |
|                          operations.                                |
+------------------------+--------------------------------------------+
| query mgmtclass          Displays information about available       |
|                          management classes.                        |
+------------------------+--------------------------------------------+
| query node               Displays all the nodes for which an        |
|                          administrative user ID has authority to    |
|                          perform operations.                        |
+------------------------+--------------------------------------------+
| query options            Displays all or part of your options and   |
|                          their current settings.                    |
+------------------------+--------------------------------------------+
| query restore            Displays a list of your restartable        |
|                          restore sessions in the server database.   |
+------------------------+--------------------------------------------+
| query schedule           Displays information about scheduled       |
|                          events for your node.                      |
+------------------------+--------------------------------------------+
| query session            Displays information about your session,   |
|                          including the current node name, when the  |
|                          session was established, server            |
|                          information, and server connection         |
|                          information.                               |
+------------------------+--------------------------------------------+
| query systeminfo         Gathers IBM Spectrum Protect system        |
|                          information and outputs this information   |
|                          to a file or the console.                  |
+------------------------+--------------------------------------------+
| query vm                 Verifies the successful backups of the     |
|                          virtual machines from the vStorage backup  |
|                          server.                                    |
+------------------------+--------------------------------------------+
| restart restore          Displays a list of restartable restore     |
|                          sessions from which you can one to         |
|                          restart.                                   |
+------------------------+--------------------------------------------+
| restore                  Restores copies of backup versions of your |
|                          files from the IBM Spectrum Protect        |
|                          server.                                    |
+------------------------+--------------------------------------------+
| restore backupset        Restores a backup set from the IBM         |
|                          Spectrum Protect server or a local file.   |
|                          On those clients that support tape         |
|                          devices, this command can restore a backup |
|                          set from a tape device.                    |
+------------------------+--------------------------------------------+
| restore group            Restores specific members or all members   |
|                          of a group backup.                         |
+------------------------+--------------------------------------------+
| restore image            Restores a file system or raw volume image |
|                          backup.                                    |
+------------------------+--------------------------------------------+
| restore nas              Restores the image of a file system        |
|                          belonging to a Network Attached Storage    |
|                          (NAS) file server.                         |
+------------------------+--------------------------------------------+
| restore vm               Restores a full VM backup, and returns the |
|                          full VM backup files to the vmbackdir      |
|                          directory on the vStorage backup server.   |
+------------------------+--------------------------------------------+
| retrieve                 Retrieves copies of archived files from    |
|                          the IBM Spectrum Protect server.           |
+------------------------+--------------------------------------------+
| schedule                 Starts the client scheduler on the         |
|                          workstation.                               |
+------------------------+--------------------------------------------+
| selective                Backs up selected files.                   |
+------------------------+--------------------------------------------+
| set access               Authorizes another user to access your     |
|                          backup versions or archived copies.        |
|                          On those clients that support image        |
|                          backup, this command can set authorization |
|                          rules for images that are stored on the    |
|                          server.                                    |
+------------------------+--------------------------------------------+
| set event                Allows you to specify the circumstances    |
|                          for when archived data is deleted.         |
+------------------------+--------------------------------------------+
| set netappsvm            Associates the login credentials for a     |
|                          cluster management server with a NetApp    |
|                          storage virtual machine and the data SVM   |
|                          name (data Vserver). This command must be  |
|                          entered before you can create a snapshot   |
|                          difference incremental backup of a         |
|                          clustered NetApp volume.                   |
+------------------------+--------------------------------------------+
| set password             Changes the IBM Spectrum Protect password  |
|                          for your workstation.                      |
+------------------------+--------------------------------------------+

For proper operation, the was node must be restored to the same location
and under the same name.

Important: To avoid problems, restore your data at the Network
Deployment Manager node or Application Server node level only.


2.1 Start and end a client command session


You can start or end a client command session in either batch mode or
interactive mode.

Use batch mode when you want to enter a single client command. The
backup-archive client processes the command and returns to the command
prompt.

Use interactive mode when you want to enter a series of commands. Since
the client establishes connection to the server only once for
interactive mode, a series of commands can be processed more quickly.
The client processes the commands and returns to the Protect> prompt.


2.1.1 Process commands in batch mode


Some options are valid only on the initial command line and not in
interactive mode. These options generally affect the operation of the
entire session.

For example, the command dsmc query session -errorlogname=myerror.log is
accepted and it does name the error log. However, it is accepted simply
because it appears in the initial command, even though the option is not
valid for the query command.

There are also some options that are always valid on the initial command
line as well as on individual commands in interactive mode. Therefore,
certain options are accepted on the initial command line even though
they have no effect on the command being entered. For example, dsmc
query session -subdir=yes is a valid command, but in this case the
-subdir option has no effect on the command that was entered.

When you enter a single command in batch mode, precede it with the
executable program name, dsmc. For example, to process the incremental
command in batch mode, you would enter:

   dsmc incremental

The backup-archive client prompts you each time you enter a command if
the passwordaccess option is set to prompt and authentication on the
server is set to On. Type your password and press Enter.

You can also enter your password using the password option with a
command, but your password appears on the screen. For example, if your
password is secret, enter:

   dsmc incremental –password=secret

If you set the passwordaccess option to generate in your dsm.opt file,
you do not need to specify the password with the command. The client
only prompts you for your password if you are registering your
workstation with a server or manually changing your password.


2.1.2 Process commands in interactive mode


Use the interactive mode (or loop mode) to enter a series of commands.

Enter dsmc on the command line and press Enter. When the Protect>
command prompt appears, type the command name and press Enter. Do not
precede each command with the executable program name, dsmc.
Alternatively, you can enter dsmc loop on the command line to start a
client command session in interactive mode. Loop is the default command
for dsmc.

If a password is required, the backup-archive client prompts you before
you enter the first command.

Type your user ID and password and press Enter.

You can also enter your password using the password option with the loop
command, but your password appears on the screen. For example, if your
password is secret, enter:

   dsmc loop –password=secret

To end an interactive session, enter quit at the prompt.

Note for UNIX and Linux clients:

In loop mode, following a restore operation directly from tape, the
mount point is not released in case additional restore requests are made
to that volume. If you request a backup operation in the same session
and that mount point is the only one available, the backup operation
will stop with the following message:

  Waiting for mount of offline media

In this case, the mount point is not released until one of the following
conditions is met:

*  The device class MOUNTRETENTION limit is satisfied.

*  The client idletimeout period is satisfied.

*  The dsmc loop session is closed after the restore operation
   completes, allowing you to start a subsequent loop mode session to
   perform the backup operation.


2.2 Enter client command names, options, and parameters


A client command can include one or more of these components: Command
name, options, and parameters. The topics that follow describe each of
these components.




2.2.1 Command name


The first part of a command is the command name. The command name
consists of a single word, such as help or schedule, or an action word
and an object for that action, such as query archive.

Enter the full command name, or its minimum abbreviation.

For example, you can enter any of the following versions of the query
schedule command:

   query schedule
   q sc
   q sched
   query sc


2.2.2 Options


When you enter options with a command, always precede the option with a
dash (–). Do not put a space between the dash and the option name.

Enter more than one option in any order in a command before or after the
file specification. Separate multiple options with a blank space.

There are two groups of options that you can use with commands: Client
options (set in your options file), or client command options (used on
the command line).

*  Client options: The group of options that are set in your client
   options file. You can override an option in the client options file
   when you enter the option with a command on the command line.

*  Client command options: Use a client command option only when you
   enter the option with a command on the command line. You cannot set
   these options in an options file.


2.2.2.1 Options in interactive mode


In interactive mode, options that you enter on the initial command line
override the value that you specified in your options file.

This value remains in effect for the entire interactive session unless
overridden by a different value on a given interactive command.

For example, if you set the subdir option to yes in your dsm.opt or
dsm.sys file, and you specify subdir=no on the initial command line, the
subdir=no setting remains in effect for the entire interactive session
unless overridden by the subdir=yes value on a given interactive
command. However, the subdir=yes value specified within the interactive
session only affects the command on which it is entered. When that
command completes, the value reverts back to subdir=no, the value at the
beginning of the interactive session.


2.2.3 Parameters


Commands can have required parameters, optional parameters, or no
parameters at all.

Required parameters provide information to perform a task. The most
commonly required parameter is a file specification.

For example, if you want to archive a file named budget.fin from the
project directory, you would enter the following:

   dsmc archive /project/budget.fin

Some commands have optional parameters. If you do not enter a value for
an optional parameter, the backup-archvie client uses the default value.
For example, the restore command includes a required parameter,
sourcefilespec, that specifies the path and file name in storage that
you want to restore. The optional parameter, destinationfilespec,
specifies the path where you want to place the restored files. If you do
not specify the destinationfilespec, by default, the client restores the
files to the original source path. If you want to restore the files to a
different directory, enter a value for destinationfilespec.

Example: Restore the file /project/budget.fin to the new path
/newproj/newbudg.fin
            dsmc restore /project/budget.fin /newproj/

Enter parameters in the order indicated in the command syntax diagram.


2.2.4 File specification syntax


There are some syntax rules that you need to know about when entering
file specification parameters such as filespec, sourcefilespec, and
destinationfilespec.

The following are the syntax rules:

*
   Do not use wildcards as part of the file space name or anywhere in
   the destinationfilespec. The one exception to this rule is the set
   access command where wildcards are permitted in the two lowest levels
   of the file spec.

   Example: Allow access to all files in all directories in and
   subordinate to the /home directory:
              set access backup /home/* * *
              set access backup /home/*/* * *

            With UNIX clients, do not use wildcards in a directory path
            name, for example:

               /home/j*asler/file1.c

*  There is a maximum number of file specifications per command:

   *  The Query commands can accept only one file specification.
   *  The restore and retrieve commands can accept a source file
      specification and a destination file specification.
   *  There is a limit of 20 operands on some commands. This limit is to
      prevent excessive sessions that are caused when wildcards are
      expanded by the UNIX shell command processor.

      You can prevent shell expansion from causing you to go over the
      20-operand limit by placing quotation marks around your source
      filespec expansion characters for restore commands.

      Note: Using quotation marks has the side affect of causing a
      no-query restore.

      You can use the removeoperandlimit option to specify that the
      backup-archive client removes the 20-operand limit. If you specify
      the removeoperandlimit option with the incremental, selective,
      archive, or backup image command, the 20-operand limit is not
      enforced and is restricted only by available resources or other
      operating system limits.

*  The length of a file specification is limited.

   *  On AIX, Solaris, and Mac: The maximum number of characters for a
      file name is 255. The maximum combined length of the file name and
      path name is 1024 characters. The Unicode representation of a
      character can occupy several bytes, so the maximum number of
      characters that a file name might contain can vary.

   *  On Linux: The maximum length for a file name is 255 bytes. The
      maximum combined length of both the file name and path name is
      4096 bytes. This length matches the PATH_MAX that is supported by
      the operating system. The Unicode representation of a character
      can occupy several bytes, so the maximum number of characters that
      comprises a path and file name can vary. The actual limitation is
      the number of bytes in the path and file components, which might
      correspond to an equal number of characters.

      On Linux: For archive or retrieve operations, the maximum length
      that you can specify for a path and file name (combined) remains
      at 1024 bytes.

*
   When you enter the sourcefilespec, if the directory name ends with /,
   then /* is implied.

   When you enter a destinationfilespec, if the name ends with /, then
   it is considered a directory, otherwise it is considered a file.

   The following example illustrates these two rules. Even though mydir
   and yourdir are directories, the command will fail because /* is
   implied after mydir, and yourdir is considered a file.

   restore /home/mydir/ /away/yourdir

   restore c:\home\mydir\ c:\away\yourdir

*
   If a file specification does not begin with a directory delimiter,
   the file specification is assumed to be a subdirectory of the current
   working directory. The client appends the file specification to the
   working directory to build the complete path.

   For example, if the current working directory is /home/me and the
   command is dsmc res "/fs/dir1/*" mydir/, the complete restore path is
   this: /home/me/mydir

*  The only command that accepts a simple file space name is the
   incremental command. The following example is valid:

      dsmc i /Users

   The following example is not valid, because the command is the
   selective command:

      dsmc sel /Users




2.3 Wildcard characters


Use wildcard characters when you want to specify multiple files with
similar names in one command. Without wildcard characters, you must
repeat the command for each file.

In a command, you can use wildcard characters in the file name or file
extension only. You cannot use them to specify destination files, file
systems, or server names. You cannot specify a directory whose name
contains an asterisk (*) or a question mark (?).

Valid wildcard characters that you can use include:

*
         Asterisk. Matches zero or more characters.

?
         Question mark. Matches any single character at the present
         position.

The following table shows examples of each wildcard.

Table 2. Wildcard characters

+-----------------------+----------------------+----------------------+
| Pattern                 Matches                Does not match       |
+-----------------------+----------------------+----------------------+
|  Asterisk (*)                                                       |
+-----------------------+----------------------+----------------------+
| ab*                     ab, abb, abxxx         a, b, aa, bb         |
+-----------------------+----------------------+----------------------+
| ab*rs                   abrs, abtrs, abrsrs    ars, aabrs, abrss    |
+-----------------------+----------------------+----------------------+
| ab*ef*rs                abefrs, abefghrs       abefr, abers         |
+-----------------------+----------------------+----------------------+
| abcd.*                  abcd.c, abcd.txt       abcd, abcdc, abcdtxt |
+-----------------------+----------------------+----------------------+
| Question Mark (?)                                                   |
+-----------------------+----------------------+----------------------+
| ab?                     abc                    ab, abab, abzzz      |
+-----------------------+----------------------+----------------------+
| ab?rs                   abfrs                  abrs, abllrs         |
+-----------------------+----------------------+----------------------+
| ab?ef?rs                abdefjrs               abefrs, abdefrs,     |
|                                                abefjrs              |
+-----------------------+----------------------+----------------------+
| ab??rs                  abcdrs, abzzrs         abrs, abjrs, abkkkrs |
+-----------------------+----------------------+----------------------+

Important: Use an asterisk (*) instead of a question mark (?) as a
wildcard character when trying to match a pattern on a multibyte code
page, to avoid unexpected results.

Note: In batch mode, enclose values containing wildcards in quotation
marks. Otherwise, UNIX shells expand unquoted wildcards, and it is easy
to exceed the 20 operand limit. It is more efficient to let the client
process wildcard file specifications because many fewer server
interactions are needed to complete the task. For example:

   dsmc selective "/home/me/*.c"


2.4 Client commands reference


The following sections contain detailed information about each of the
backup-archive client commands.

Information for each command includes the following information:

*  A description of the command.

*  A syntax diagram of the command.

*  Detailed descriptions of the command parameters. If the parameter is
   a constant (a value that does not change), the minimum abbreviation
   appears in uppercase letters.

*  Examples of using the command.


2.5 Archive


The archive command archives a single file, selected files, or all files
in a directory and its subdirectories on a server.

Archive files that you want to preserve in their current condition. To
release storage space on your workstation, delete files as you archive
them using the deletefiles option. Retrieve the archived files to your
workstation whenever you need them again.

Use the snapshotroot option with the archive command along with an
independent software vendor application that provides a snapshot of a
logical volume to associate the data on the local snapshot with the real
file space data that is stored on the IBM Spectrum Protect server. The
snapshotroot option does not provide any facilities to take a volume
snapshot, only to manage data that is created by a volume snapshot.

AIX(R) only: You can enable snapshot-based file archive by using the
option snapshotproviderfs=JFS2.

Supported Clients

This command is valid for all clients.

Syntax

            .------------------.
            V                  |
>>-Archive------ --filespec---+--+-------------+--------------><
                                  '- --options-'



Parameters

filespec
         Specifies the path and name of the file you want to archive.
         Use wildcard characters to include a group of files or to
         include all files in a directory.
         To include multiple file specifications, separate eachfilespec
         parameter with a space character. If multiple file
         specifications are included, and two or more of the
         specifications have common parent directories, then it is
         possible for the common directory objects to be archived more
         than once. The conditions under which this behavior occurs are
         runtime-dependent, but the behavior itself has no adverse
         effects.

         For example, if the filespec is /home/amr/ice.doc
         /home/amr/fire.doc, then /home and /home/amr might be archived
         twice. The file objects ice.doc, and fire.doc, are archived
         only once.
         If you want to avoid including the shared parent directory more
         than once, use separate, non-overlapping archive commands to
         archive each file specification.
         If you archive a file system, include a trailing slash
         (/home/).
         There is a limit of 20 operands. This limit prevents excessive
         sessions that are caused when wildcards are expanded by the
         UNIX shell command processor. You can prevent shell expansion
         from causing you to go over the 20-operand limit by placing
         quotation marks around file specifications that contain
         wildcards ("home/docs/*").
         You can use the removeoperandlimit option to specify that the
         20-operand limit is removed. If you specify the
         removeoperandlimit option, the 20-operand limit is not enforced
         and is restricted only by available resources or other
         operating system limits. For example, remove the 20 operand
         limit to archive 21 file specifications:

         selective -removeoperandlimit filespec1 filespec2 ... filespec21
         You can use the filelist option, instead of file
         specifications, to identify which files to include in this
         operation. However, these two methods are mutually exclusive.
         You cannot include file specification parameters and use the
         filelist option. If the filelist option is specified, any file
         specifications that are included are ignored.

Table 3. Archive command: Related options

+-----------------------+---------------------------------------------+
| Option                | Where to use                                |
+-----------------------+---------------------------------------------+
| archmc                | Command line only.                          |
+-----------------------+---------------------------------------------+
| archsymlinkasfile     | Client user-options file (dsm.opt) or       |
|                       | command line.                               |
+-----------------------+---------------------------------------------+
| autofsrename          | Client options file (dsm.opt) only.         |
+-----------------------+---------------------------------------------+
| changingretries       | Client system options file or command line. |
+-----------------------+---------------------------------------------+
| compressalways        | Client user-options file (dsm.opt) or       |
|                       | command line.                               |
+-----------------------+---------------------------------------------+
| compression           | dsm.sys file within a server stanza or      |
|                       | command line.                               |
+-----------------------+---------------------------------------------+
| deletefiles           | Command line only.                          |
+-----------------------+---------------------------------------------+
| description           | Command line only.                          |
+-----------------------+---------------------------------------------+
| dirsonly              | Command line only.                          |
+-----------------------+---------------------------------------------+
| encryptiontype        | dsm.sys file within a server stanza.        |
+-----------------------+---------------------------------------------+
| encryptkey            | dsm.sys file within a server stanza.        |
+-----------------------+---------------------------------------------+
| filelist              | Command line only.                          |
+-----------------------+---------------------------------------------+
| filesonly             | Command line only.                          |
+-----------------------+---------------------------------------------+
| preservelastaccessdat | Client user-options file (dsm.opt) or       |
| e                     | command line.                               |
+-----------------------+---------------------------------------------+
| removeoperandlimit    | Command line only.                          |
+-----------------------+---------------------------------------------+
| snapshotcachesize     | Client options file (dsm.opt) or include.fs |
|                       | option.                                     |
+-----------------------+---------------------------------------------+
| snapshotroot          | Command line only.                          |
+-----------------------+---------------------------------------------+
| subdir                | Client options file (dsm.opt) or command    |
|                       | line.                                       |
+-----------------------+---------------------------------------------+
| tapeprompt            | Client options file (dsm.opt) or command    |
|                       | line.                                       |
+-----------------------+---------------------------------------------+
| v2archive             | Command line only.                          |
+-----------------------+---------------------------------------------+

Examples

Task
         Archive a single file that is named budget in the /home/proj1
         directory.

         Command: archive /home/proj1/budget

Task
         Archive all files in the /home/proj1 directory with a file
         extension of .txt.

         Command: archive "/home/proj1/*.txt"

Task
         Archive all files in the directory tree that is headed by the
         /home directory.

         Command: archive -subdir=yes "/home/*"

Task
         Assuming that you initiated a snapshot of the /usr file system
         and mounted the snapshot as /snapshot/day1, archive the
         /usr/dir1/sub1 directory tree from the local snapshot and
         manage it on the IBM Spectrum Protect server under the file
         space name /usr.

         Command: dsmc archive /usr/dir1/sub1/ -subdir=yes
         -snapshotroot=/snapshot/day1


2.6 Archive FastBack


Use the archive fastback command to archive Tivoli(R) Storage Manager
FastBack volumes specified by the fbpolicyname, fbclientname and
fbvolumename options for long-term retention.

Before using this command, ensure your system is configured for Tivoli
Storage Manager FastBack. Also, before you issue this command, at least
one snapshot should exist in the FastBack repository for the FastBack
policy being archived or backed up.

If a policy specification contains both Windows and Linux FastBack
clients, only the Linux volumes will be backed up or archived to the IBM
Spectrum Protect server by the Linux backup-archive client.

You can use Tivoli Storage Manager FastBack options to archive the
latest snapshots of the following volumes:

*  All clients and volumes associated with a specific FastBack policy or
   a list of FastBack policies.

*  All volumes associated with a specific FastBack client or a list of
   FastBack clients for a given FastBack policy.

*  A specific volume or volumes associated with a specific FastBack
   client for a given FastBack policy.

Supported Clients

This option is valid for Linux x86_64 clients.

Syntax

                                      .-,----.
                                      V      |
>>-ARCHIVE FASTBack--FBPolicyname--=----name-+------------------>

>--FBServer--=--name--+---------------------------+------------->
                      |                  .-,----. |
                      |                  V      | |
                      '-FBClientname--=----name-+-'

>--+---------------------------+-------------------------------->
   |                  .-,----. |
   |                  V      | |
   '-FBVolumename--=----name-+-'

>--+--------------------------+--+-------------------+---------->
   '-FBReposlocation--=--name-'  '-FBBranch--=--name-'

>--+-----------------+-----------------------------------------><
   '-ARCHMc--=--name-'



Important:

1. At least one FBpolicyName is always required.

2. You can specify up to 10 values for FBPolicyName, if no values are
   specified for both FBClientName and FBVolumeName.

3. When you specify a FBClientName value, there must be only one value
   for FBPolicyName.

4. You can specify up to 10 values for FBClientName if only one
   PolicyName is specified, and no values for FBVolumeName are
   specified.

5. When you specify the FBVolumeName option, you can have only one
   FBPolicy, and only one FBCLientName specified.

6. You can specify multiple FBVolumeNames if condition 5 is satisfied.

7. You must always specify the FBReposLocation option for Linux.

Parameters

Table 4. Archive FastBack command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| fbpolicyname       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbserver           | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbclientname       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbvolumename       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbreposlocation    | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbbranch           | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| archmc             | Command line and scheduler.                    |
+--------------------+------------------------------------------------+

Examples

Command line:
         The backup-archive client is installed on a Linux proxy client
         machine. Use this command to archive all FastBack volumes for
         all Linux FastBack clients that are defined for FastBack
         policy1:

         dsmc archive fastback -fbpolicyname=Policy1
           -fbserver=myfbserver -fbreposlocation=myfbserver@WORKGROUP

         The FastBack server name, -myFbDrHub is the short host name of
         the FastBack Disaster Recovery Hub server where the repository
         is located.

         The -fbreposlocation parameter specifies the location of the
         repository. The repository location is required. If you do not
         provide the repository location, the command fails.

         FBServer should point to the short host name of the FastBack DR
         hub in this case.

Command line:
         The repository, rep_server1, is located on the FastBack DR hub,
         myFbDrHub.

         dsmc archive fastback -fbpolicyname="Policy 1"
           -fbserver=myFbDrHub -fbreposlocation=\\myFbDrHub\rep_server1

         The repository location is required. If you do not provide the
         repository location, the command fails.

         The FastBack server name, -myFbDrHub, is the short host name of
         the FastBack Disaster Recovery Hub where the repository is
         located.

         FBServer should point to the short host name of the FastBack DR
         hub in this case.

Command line:
         Archive all volumes protected by FastBack policy named policy1
         from the FastBack server named basil:

         dsmc archive fastback -Fbpolicyname=policy1
           -FBServer=basil -ARCHMC="my_tsm_mgmt_class"
           -fbreposlocation=basil@WORKGROUP


2.7 Backup FastBack


Use the backup fastback command to back up Tivoli Storage Manager
FastBack volumes specified by the fbpolicyname, fbclientname and
fbvolumename options for long-term retention.

Before using this command, configure your system for Tivoli Storage
Manager FastBack. Also, before you issue this command, at least one
snapshot should exist in the Tivoli Storage Manager FastBack repository
for the Tivoli Storage Manager FastBack policy being archived or backed
up.

If a policy specification contains both Windows and Linux FastBack
clients, only the Linux volumes will be backed up or archived to the IBM
Spectrum Protect server by the Linux backup-archive client.

Tivoli Storage Manager FastBack options are supported for the
incremental backup of the latest snapshots, depending on the option
specified:

*  All clients and volumes associated with the FastBack policy or a list
   of FastBack policies.

*  All volumes associated with a specific FastBack client or a list of
   FastBack clients for a given FastBack policy.

*  A specific volume or volumes associated with a specific FastBack
   client for a given FastBack policy.

Supported Clients

This command is valid for Linux x86_64 clients that are configured as
Tivoli Storage Manager FastBack dedicated proxies.

Syntax for Linux Clients

                                     .-,----.
                                     V      |
>>-BACKUP FASTBack--FBPolicyname--=----name-+------------------->

>--FBServer--=--name--+---------------------------+------------->
                      |                  .-,----. |
                      |                  V      | |
                      '-FBClientname--=----name-+-'

>--+---------------------------+--FBReposlocation--=--name------>
   |                  .-,----. |
   |                  V      | |
   '-FBVolumename--=----name-+-'

>--+-------------------+--+-----------------+------------------><
   '-FBBranch--=--name-'  '-BACKMc--=--name-'



Important:

1. At least one FBpolicyName is always required.

2. You can specify up to 10 values for FBPolicyName, if no values are
   specified for both FBClientName and FBVolumeName.

3. When you specify a FBClientName value, there must be only one value
   for FBPolicyName.

4. You can specify up to 10 values for FBClientName if only one
   PolicyName is specified, and no values for FBVolumeName are
   specified.

5. When you specify the FBVolumeName option, you can have only one
   FBPolicy, and only one FBCLientName specified.

6. You can specify multiple FBVolumeNames if condition 5 is satisfied.

7. You must specify the FBReposLocation option.

Table 5. Backup FastBack command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| fbpolicyname       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbserver           | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbclientname       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbvolumename       | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbreposlocation    | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| fbbranch           | Command line and scheduler.                    |
+--------------------+------------------------------------------------+
| backmc             | Command line and scheduler.                    |
+--------------------+------------------------------------------------+

Examples

Command line:
         The backup-archive client is installed on a Linux proxy client
         machine. Use this command to back up all FastBack volumes for
         all Linux FastBack clients that are defined for FastBack
         policy1:

         dsmc backup fastback -fbpolicyname=Policy1
           -fbserver=myfbserver
           -fbreposlocation=myfbserver@WORKGROUP

         The repository location is required. If you do not provide the
         repository location, the command will fail.

         The FastBack server name, -myfbserver, is the short host name
         of the FastBack server where the repository is located.

Command line:
         The repository, rep_server1, is located on the FastBack
         Disaster Recovery Hub, myFbDrHub

         dsmc backup fastback -fbpolicyname="Policy 1"
           -fbserver=myFbDrHub -fbreposlocation=\\myFbDrHub\rep_server1

         The FastBack server name, -myFbDrHub, is the short host name of
         the FastBack Disaster Recovery Hub server where the repository
         is located.

         The -fbreposlocation option specifies the location of the
         repository. The repository location is required. If you do not
         provide the repository location, the command fails.

         The FBServer option should point to the short host name of the
         FastBack DR hub in this case.

Command line:
         Back up all volumes protected by FastBack policy named policy1
         from the FastBack server named basil:

         dsmc backup fastback -Fbpolicyname=policy1
           -FBServer=basil -BACKMC="my_tsm_mgmt_class"
           -fbreposlocation=basil@WORKGROUP


2.8 Backup Group


Use the backup group command to create and back up a group containing a
list of files from one or more file space origins to a virtual file
space on the IBM Spectrum Protect server.

AIX only: You can enable snapshot-based group backup by using the option
snapshotproviderfs=JFS2.

A group backup allows you to create a consistent point-in-time backup of
a group of files that is managed as a single logical entity. Objects in
the group are subject to the following processing rules:

*  Management class rebinding for grouped objects:

   *  During full backups, all objects in a backup group are assigned to
      the same management class.

   *  During differential backups, if a new management class is
      specified on an include statement for an existing backup group,
      the following behavior occurs:

      *  Any new and changed objects in the backup group are bound to
         the new management class.

      *  Any member objects of the group that are not changed appear as
         though they have not been bound to the new management class.
         These unchanged objects are not included in the Total number of
         objects rebound statistics that are displayed when the Backup
         Group command completes.

      *  The unchanged objects are reassigned to a newly created backup
         group, and the new backup group is bound to the new management
         class. However, the original management class name is still
         displayed for the unchanged group objects.

         Even though the original management class name is still
         displayed for the unchanged objects, they are effectively bound
         to the new management class of the backup group.

*  Existing exclude statements for any files in the group are ignored.

*  All objects in the group are exported together.

*  All objects in the group are expired together as specified in the
   management class. No objects in a group are expired until all other
   objects in the group are expired, even when another group they belong
   to gets expired.

*  If you are performing full and differential group backups to a
   sequential device, during a restore the data is in no more than two
   locations. To optimize restore time, perform periodic full backups to
   back up the data to one location on the sequential media.

*  During a full group backup, all objects in the filelist are sent to
   the server. During a differential group backup, only data that has
   changed since the last full backup is sent to the server. Objects in
   the filelist that have not changed since the last full backups are
   assigned as members of the differential group backup. This data is
   not resent to the server, reducing backup time.

The backup group command requires the following options:

filelist
         Specifies a list of files to add to a new group.

groupname
         Specifies the fully qualified name of the group containing a
         list of files.

virtualfsname
         Specifies the name of the virtual file space for the group on
         which you want to perform the operation. The virtualfsname
         option cannot be the same as an existing file space name.

mode
         Specifies whether you want to back up all of the files in the
         filelist or only files that have changed since the last full
         backup.

Note:

1. If any file in the group backup fails, the entire group backup fails.

2. Use the query group command to query members of a group backup on the
   IBM Spectrum Protect server.

3. Use the restore group command to restore specific members or all
   members of a group backup on the server.

4. Unless you are running Mac OS X, use the delete group command to
   delete a specific group backup from the server.

5. Use the query filespace command to display virtual file space names
   for your node that are stored on the server.

6. A group backup can be added to a backup set.

7. When a group backup is interrupted or fails due to some reason, the
   client attempts to clean up the incomplete backup on the IBM Spectrum
   Protect server when the same group is backed up again. If the server
   option BACKDEL is set to Yes, the client will remove the incomplete
   group backup before attempting another group backup. If the BACKDEL
   option is set to No, the client will inactivate the incomplete
   backup. The inactivated backup will expire according to the policy
   definition on the server.

Supported Clients

This command is valid for all UNIX and Linux clients except Mac OS X.

Syntax

>>-Backup GRoup-- --options-----------------------------------><



Parameters

Table 6. Backup Group command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| groupname          | Command line only.                             |
+--------------------+------------------------------------------------+
| mode               | Command line only.                             |
+--------------------+------------------------------------------------+
| snapshotproviderfs | System-options file (dsm.sys) within a server  |
|                    | stanza or with the include.fs option.          |
+--------------------+------------------------------------------------+
| virtualfsname      | Command line only.                             |
+--------------------+------------------------------------------------+

See these client processing option topics for more information.

Examples

Task
         Perform a full backup of all the files in the
         /home/dir1/filelist1 file to the virtual file space name
         accounting containing the group leader /home/group1 file.

         Command:

         backup group -filelist=/home/dir1/filelist1 -groupname=group1
         -virtualfsname=/virtfs -mode=full


2.9 Backup Image


The backup image command creates an image backup of one or more volumes
on your system.

You can use the backup image command to back up NTFS or ReFS, or
unformatted RAW volumes. If a volume is NTFS-formatted, only those
blocks that are used by the file system are backed up. On ReFS volumes,
all blocks are backed up.

If you set the imagegapsize option to 0, all blocks, including unused
blocks at the end of the volume, are backed up.

If you specify an AIX JFS2 file system for image backup, only those
blocks that are used by the file system are backed up. If you set the
imagegapsize option to zero, all blocks, including blocks at the end of
the volume, are backed up.

Note:

1. By default, snapshot-based image backup is enabled for JFS2 volumes.
   To turn off snapshot-based image backups, set
   -snapshotproviderimage=NONE on this command.

2. For the Linux clients, image backup is only supported on partitions
   with id 0x83 or logical volumes that are created with the Linux
   Logical Volume Manager. Backing up other partitions, such as extended
   partitions that contain mounted file systems or database data, can
   produce inconsistent backup data if the data changes during the image
   backup operation.

3. For Linux clients on z Systems(R), image backup of DASD devices with
   raw-track access mode is not supported. Only full-track access mode
   is supported.

4. Backup image is not supported on any GPFS file system.

5. The IBM Spectrum Protect API must be installed to use the backup
   image command.

6. When you change the attribute of a JFS2 file system to an HSM-managed
   file system, an image backup is not done for that file system.

7. The image backup operation is not supported on any partition that
   resides on a multipath device.

Important: The last incremental backup time refers to the server time
and the file modification time refers to the client time. If the client
and server time are not synchronized, or the client and server are in
different time zones, this affects incremental-by-date backup and image
backup where mode=incremental.

The client backs up the files that have modification dates and times (on
the client) that are later than the date and time of the last
incremental backup of the file system on which the file is stored (on
the server).

If the server time is ahead of the client time, incremental-by-date
backups, or image backup with mode=incremental, skip the files, which
had been created or modified after the last incremental or image backup
with a modification date earlier than the last incremental backup time
stamp.

If the client time is ahead of the server time, all files that had been
created or modified before the last incremental or image backup and have
a modification time stamp later than the last incremental backup time
stamp, are backed up again. Typically, these files would not get backed
up because they had already been backed up.

The backup date can be checked by the query filespace command.

The backup-archive client must support the raw device type on the
specific platform to perform an image backup of a raw device. You can
perform an image backup only on local devices. Clustered devices or file
systems as well as devices or file systems that are shared between two
or more systems are not supported. If you want to perform an image
backup for a file system that is mounted on a raw device, the raw device
must be supported.

Use the include.image option to include a file system or logical volume
for image backup, or to specify volume-specific options for image
backup.

The backup image command uses the compression option.

Note: When an image backup is interrupted or fails due to some reason,
the client attempts to clean up the incomplete backup on the IBM
Spectrum Protect server when the image backup is run again. If the
server option BACKDEL is set to Yes, the client will remove the
incomplete image backup before attempting another image backup. If the
BACKDEL option is set to No, the client will inactivate the incomplete
backup. The inactivated backup will expire according to the policy
definition on the server.

Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Syntax

                                  .------------------.
                                  V                  |
>>-Backup Image--+-------------+----+--------------+-+---------><
                 '- --options-'    '- --filespec-'



Parameters

filespec
         Specifies the name of one or more logical volumes. If you want
         to back up more than one file system, separate their names with
         spaces. Do not use pattern matching characters. If you do not
         specify a volume name, the logical volumes that are specified
         with the domain.image option are processed. If you do not use
         the domain.image option to specify file systems to process, an
         error message is displayed and no image backup occurs.

         Specify the file space over which the logical volume is mounted
         or the logical volume name. If there is a file system that is
         configured in the system for a given volume, you cannot back up
         the volume with the device name.



         For example, if the /dev/lv01 file space is mounted on the
         /home volume, you can issue backup image /home, but backup
         image /dev/lv01 fails with an error:

         ANS1063E Invalid path specified

         There is a limit of 20 operands. This limit prevents excessive
         sessions that are caused when wildcards are expanded by the
         UNIX shell command processor. You can prevent shell expansion
         from causing you to go over the 20-operand limit by placing
         quotation marks around file specifications that contain
         wildcards ("home/docs/*").

         You can use the removeoperandlimit option to specify that the
         20-operand limit is removed. If you specify the
         removeoperandlimit option, the 20-operand limit is not enforced
         and is restricted only by available resources or other
         operating system limits. For example, remove the 20 operand
         limit to backup 21 file specifications:

         backup image -removeoperandlimit filespec1 filespec2 ... filespec21



         Note: For Sun systems, specify either a file system name or a
         raw device name (block device type).



Table 7. Backup Image command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| asnodename         | Client system options file ( dsm.sys ) or      |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| compressalways     | Client system options file ( dsm.sys ) or      |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| compression        | Client options file or command line.           |
+--------------------+------------------------------------------------+
| dynamicimage       | Use with the backup image command or the       |
|                    | include.image option in the options file.      |
+--------------------+------------------------------------------------+
| imagegapsize       | Use with the backup image command, the         |
|                    | include.image option, or in the options file.  |
+--------------------+------------------------------------------------+
| mode               | Command line only.                             |
+--------------------+------------------------------------------------+
| postsnapshotcmd    | Use with the backup image command, the         |
|                    | include.image option, or in the options file.  |
+--------------------+------------------------------------------------+
| presnapshotcmd     | Use with the backup image command, the         |
|                    | include.image option, or in the options file.  |
+--------------------+------------------------------------------------+
| removeoperandlimit | Command line only.                             |
+--------------------+------------------------------------------------+
| snapshotcachesize  | Use with the backup image command, the         |
|                    | include.image option, or in the options file.  |
+--------------------+------------------------------------------------+
| snapshotproviderim | Client options file or with include.image      |
| age                | option.                                        |
+--------------------+------------------------------------------------+

Examples

Task
         Back up the /home/test file space over which the logical volume
         is mounted and perform an image incremental backup that backs
         up only new and changed files after the last full image backup.

          dsmc backup image /home/test -mode=incremental

Task
         Perform a static image backup of the logical volume that is
         mounted at the /home directory.

         dsmc backup image /home -snapshotproviderimage=none

Task
         Perform a dynamic image backup of the logical volume that is
         mounted at the /home directory.

         Command: dsmc backup image /home -dynamicimage=yes

Task
         Perform a snapshot image backup of the /home directory.

         AIX client: dsmc backup image /home
             -snapshotproviderimage=JFS2
          LINUX client: dsmc backup image /home
             -snapshotproviderimage=LINUX_LVM

Task
         Back up the /dev/lv01 raw logical volume.

         dsmc backup image /dev/lv01

Task
         Perform a raw image backup of the whole disk or partition via
         the /dev/mapper/mpath1 multipath device.

         dsmc backup image /dev/mapper/mpath1
         -snapshotproviderimage=none


2.9.1 Static, dynamic, and snapshot image backup


The traditional image backup prevents write access to the volume by
other system applications during the operation.

Use the dynamicimage option to back up the volume as is without
remounting it read-only. Corruption of the backup can occur if
applications write to the volume while the backup is in progress. In
this case, run fsck after a restore.

The dynamicimage option is not supported for JFS2 volumes.

For Linux x86_64 clients only: By default, the backup-archive client
runs a snapshot image backup of file systems residing on a logical
volume created by the Linux Logical Volume Manager during which the
volume is available to other system applications. Snapshot image backup
requires a version 5.1 IBM Spectrum Protect server.

For AIX clients only: By default, backup-archive client runs a snapshot
image backup of JFS2 volumes during which the volume is available to
other system applications. AIX allows the creation of a snapshot of a
JFS2 volume while it is still online. The snapshot is created inside the
same volume group as the source volume. You must ensure that the volume
group provides enough free disk space to create the snapshot. The
snapshot contains the old data blocks while the modified data is stored
in the source volume. Use the snapshotcachesize option with the backup
image command, in the dsm.sys file, or with the include.image option to
specify an appropriate snapshot size so that all old data blocks can be
stored while the image backup occurs.

The Linux Logical Volume Manager allows the creation of a snapshot of a
logical volume while the logical volume itself is still online. The
snapshot is created inside the same volume group as the source logical
volume. You must ensure that the volume group provides enough free disk
space to create the snapshot. The snapshot contains the old data blocks
while the modified data is stored in the source logical volume. Use the
snapshotcachesize option with the backup image command, in the dsm.sys
file, or with the include.image option to specify an appropriate
snapshot size so that all old data blocks can be stored while the image
backup occurs. A snapshot size of 100 percent will ensure a valid
snapshot.


2.9.2 Utilizing image backup to perform file system incremental backup


There are two methods of utilizing image backups to perform efficient
incremental backups of your file system. These backup methods allow you
to perform point-in-time restore of your file systems and improve backup
and restore performance.

You can perform the backup only on formatted volumes; not on raw logical
volumes. You can either use image backup with file system incremental or
you can use image backup with image incremental mode to perform image
backups of volumes with mounted file systems.

The following are some examples of using image backup with file system
incremental.

*  To perform a full incremental backup of the file system: dsmc
   incremental /myfilesystem

*  To perform an image backup of the same file system: dsmc backup image
   /myfilesystem

*  To periodically perform incremental backups: dsmc incremental
   /myfilesystem

You must follow the next steps in the order shown to ensure that the
server records additions and deletions accurately.

Use this command to restore the file system to its exact state as of the
last incremental backup: dsmc restore image /myfilesystem -incremental
-deletefiles.

During the restore, the client does the following:

*  Restores the most recent image on the server.
*  Deletes all of the files restored in the previous step which are
   inactive on the server. These are files which existed at the time of
   the image backup, but were subsequently deleted and recorded by a
   later incremental backup.
*  Restores new and changed files from the incremental backups.

If you do not follow the steps exactly, two things can occur:

1. After the original image is restored, all files backed up with the
   incremental command are restored individually.

2. If you perform a backup image before performing an incremental, files
   deleted from the original image are not deleted from the final
   restored file system.

The following are some examples of using image backup with image
incremental mode.

*  To perform an image backup of the same file system: dsmc backup image
   /myfilesystem

*  To perform an incremental image backup of the file system: dsmc
   backup image /myfilesystem -mode=incremental

   This sends only those files that were added or changed since the last
   image backup to the server.

*  To periodically perform full image backups: dsmc backup image
   /myfilesystem

*  To restore the image: dsmc restore image /myfilesystem -incremental

   On restore, the backup-archive client ignores the deletefiles option
   when the image+image incremental technique of backing up has been
   used. The restore will include files that were deleted after the last
   full image backup plus the latest versions of files added or changed
   after the last image backup.

Note: You should perform full image backups periodically in the
following cases. This will improve restore time because fewer changes
are applied from incrementals.

*  When a file system changes substantially (more than 40%).
*  Once each month.
*  As appropriate for your environment.

The following restrictions apply when using the image backup with image
incremental mode:

*  The file system can have no previous full incremental backups
   produced by the incremental command.

*  Incremental-by-date image backup does not inactivate files on the
   server; therefore, when files are restored, none can be deleted.

*  If this is the first image backup for the file system, a full image
   backup is performed.

*  Using mode=incremental backs up only files with a changed date, not
   files with changed permissions.

*  If file systems are running at or near capacity, an out-of-space
   condition could result during the restore.


2.10 Backup NAS


The backup nas command creates an image backup of one or more file
systems that belong to a Network Attached Storage (NAS) file server,
otherwise known as NDMP Backup. You are prompted for the IBM Spectrum
Protect administrator ID.

The NAS file server performs the outboard data movement. A server
process starts in order to perform the backup.

Use the nasnodename option to specify the node name for the NAS file
server. The NAS node name identifies the NAS file server to the IBM
Spectrum Protect server; the NAS node name must be registered at the
server. Place the nasnodename option in your client options file
(dsm.opt). The value in the client options file is the default, but can
be overridden on the command line.

Use the toc option with the backup nas command or the include.fs.nas
option to specify whether the IBM Spectrum Protect server saves Table of
Contents (TOC) information for each file system backup. If you save TOC
information, you can use the QUERY TOC server command to determine the
contents of a file system backup with the RESTORE NODE server command to
restore individual files or directory trees.

You can also use the IBM Spectrum Protect web client to examine the
entire file system tree and select files and directories to restore.
Creation of a TOC requires that you define the tocdestination attribute
in the backup copy group for the management class to which this backup
image is bound. TOC creation requires more processing, network
resources, storage pool space, and possibly a mount point during the
backup operation. If you do not save TOC information, you can still
restore individual files or directory trees using the RESTORE NODE
server command, if you know the fully qualified name of each file or
directory and the image in which that object was backed up.

The toc option is only supported for images that are backed up by
version 5.2 or later client and server.

Specifying mode =differential on the BACKUP NODE server command or the
backup nas command where no full image exists, shows that a full backup
was started. Using the QUERY PROCESS server command shows that a full
backup is in process.

Use the mode option to specify whether to perform a full or differential
NAS image backup. A full image backup backs up the entire file system.
The default is a differential NAS image backup on files that change
after the last full image backup. If an eligible full image backup does
not exist, a full image backup is performed. If a full image exists,
whether it is restorable, or expired and being maintained because of
dependent differential images, specifying mode =differential sends a
differential image backup. If a full image is sent during a differential
backup, it is reflected as a full image using the QUERY NASBACKUP server
command. The QUERY NASBACKUP server command also displays NAS images
that are restorable and displays full image or differential image as the
object type.

Use the monitor option to specify whether you want to monitor a NAS file
system image backup and display processing information on your screen.

Use the monitor process command to display a list of all processes for
which an administrative user ID has authority. The administrative user
ID should have at least client owner authority over both the NAS node
and the client workstation node they are using either from command line
or from the web.

Use the cancel process command to stop NAS backup processing.

Regardless of client platform, NAS file system specifications use the
forward slash (/) separator, as in this example: /vol/vol0.



Supported Clients

This command is valid for AIX, and Solaris clients only.

Syntax

                                .------------------.
                                V                  |
>>-Backup NAS--+-------------+------ --filespec---+-----------><
               '- --options-'



Parameters

filespec
         Specifies the name of one or more file systems on the NAS file
         server. If you do not specify this parameter, the
         backup-archive client processes all of the file systems that
         are defined by the domain.nas option.

         If you do not specify the filespec or the domain.nas option,
         the default all-nas value is used for domain.nas and all file
         systems on the NAS file server are backed up.

Table 8. Backup NAS command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| mode               | Command line only.                             |
+--------------------+------------------------------------------------+
| monitor            | Command line only.                             |
+--------------------+------------------------------------------------+
| nasnodename        | Client options file ( dsm.sys ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| toc                | Command line or with the include.fs.nas option |
|                    | in your client options file ( dsm.sys ).       |
+--------------------+------------------------------------------------+

Examples

Task
         Perform the NAS image backup of the entire file system.

         Command: backup nas -mode=full -nasnodename=nas1 /vol/vol0
         /vol/vol2

Task
         Perform the NAS image backup of the entire file server.

         Command: backup nas -nasnodename=nas1

Task
         Perform the NAS image backup of the entire file system and save
         Table of Contents (TOC) information for the file system backup.

         Command: backup nas -mode=full -nasnodename=netappsj /vol/vol0
         -toc=yes


2.11 Backup VM


Use the backup vm command to start a full backup of a virtual machine.



Backing up VMware virtual machines

Use the backup vm command to back up VMware virtual machines.

One or more virtual machines are backed up by the IBM Spectrum Protect
data mover node. Data mover node is the name that is given to a
configuration where the backup-archive client runs on a vStorage backup
server and is configured to protect the virtual machines in a Virtual
Center or ESX/ESXi server. You must configure the VMware virtual machine
before you use this command. For information about configuring the
VMware virtual machine, see Preparing the environment for full backups
of VMware virtual machines

A full VM backup stores a backup copy of all virtual disk images and
configuration information for a virtual machine. Full VM backups enable
a complete restore of a virtual machine, but they take more time and
more server space than an incremental backup.

If you set vmenabletemplatebackups option to yes, a backup vm operation
includes the template VMs, but only if the vStorage backup server is
connected to a vCenter Server, and not to an ESX or ESXi host.

If a snapshot fails during backup processing, the client attempts to
back up the VMware virtual machine one more time. To control the number
of total snapshot attempts, set the INCLUDE.VMSNAPSHOTATTEMPTS option in
the client options file.

Data protection tags are used to configure the backup policy of virtual
machines in VMware objects. The tags and categories are created when you
use one of the following methods:

*  Enable tagging support on the data mover node with the vmtagdatamover
   option and run the backup vm command.

*  Use the IBM Spectrum Protect vSphere Client plug-in to manage IBM
   Spectrum Protect backups.

*  Run the set vmtags command on any data mover node.

When the vmtagdatamover option is set to yes, all tags that are assigned
to a virtual machine are backed up during backup vm operations. The tags
are restored when the restore vm command is run. Tags that are assigned
to other inventory objects are not backed up and cannot be restored.

For more information about data protection tags, see 2.57.1 Data
protection tagging overview.

A Full VM backup uses VMware Changed Block Tracking (CBT) to create
content-aware (used-block only) backups. The client enables changed
block tracking (CBT) on an ESX or ESXi server when a backup begins.
VMware CBT requires an ESX 4.1 (or later) host, with virtual hardware 7
(or later). You cannot perform incremental or full VM content-aware
backups on virtual machines that do not support CBT.

When CBT is enabled, it tracks disk changes when I/O operations are
processed by the ESX or ESXi server storage stack on the following
disks:

*  A virtual disk that is stored on VMFS; the disk can be an iSCSI disk,
   a local disk, or a disk that is on a SAN.

*  A virtual disk that is stored on NFS.

*  An RDM that is in virtual compatibility mode.

When I/O operations are not processed by the ESX or ESXi storage stack,
changed block tracking cannot be used to track disk changes. The
following disks cannot use CBT:

*  An RDM that is in physical compatibility mode.

*  A disk that is accessed directly from inside a VM. For example,
   vSphere cannot track changes that are made to an iSCSI LUN that is
   accessed by an iSCSI initiator in the virtual machine.

Complete information about changed block tracking requirements is
described in the VMware Virtual Disk API Programming Guide in the VMware
product documentation. In the guide, search for "Low Level Backup
Procedures" and read the "Changed Block Tracking on Virtual Disks"
section.

For VMware servers that do not support CBT, both the used and the unused
areas of the disk are backed up and an informational message is logged
in the dsmerror.log file. Use the -preview option on the backup vm
command to view the current CBT status. CBT status has three values:

Off
         Indicates the CBT configuration parameter (ctkEnabled) is not
         enabled in the virtual machine's configuration parameters. Off
         is the default state.

Not Supported
         Indicates that the virtual machine does not support CBT.
         Changed-block only backups are not possible.

On
         Indicates the virtual machine supports CBT and that CBT is
         enabled in the virtual machine's configuration parameters
         (ctkEnabled=true).
         The client turns on CBT (it sets ctkEnable=true) with each
         backup attempt. After the client turns on CBT, it remains on,
         even if the virtual machine is deleted from the IBM Spectrum
         Protect server. With CBT enabled, after the first full VM
         backup is performed, only the changed blocks on the disk are
         backed up or restored.
         If you are no longer performing IBM Spectrum Protect backups of
         a virtual machine, you can turn off CBT. To turn off CBT,
         right-click the virtual machine that you want to turn off CBT
         for in the vSphere client. Click Edit Settings -> Options ->
         General -> Configuration Parameters . Then, set the ctkEnabled
         configuration parameter to false.

Tip: You can use the compression option with backups only if the backup
is being saved to a storage pool that was enabled for client-side
deduplication.

You specify the -vmbackuptype and -mode options to indicate how the
backups are to be performed. For full VM backups, use
-vmbackuptype=fullvm, and specify any of the following mode options:

IFFull
         Incremental-forever-full mode. In this mode, a snapshot of all
         used blocks on a virtual machine’s disks are backed up to the
         server. You must be licensed to use IBM Spectrum Protect for
         Virtual Environments: Data Protection for VMware, or IBM
         Spectrum Protect for Virtual Environments: Data Protection for
         Microsoft Hyper-V to use this option.

IFIncremental
         Incremental-forever-incremental. In this mode, a snapshot is
         created of the blocks that changed since the last backup. You
         must be licensed to use IBM Spectrum Protect for Virtual
         Environments: Data Protection for VMware, or IBM Spectrum
         Protect for Virtual Environments: Data Protection for Microsoft
         Hyper-V to use this option.

For information about the incremental-forever backup strategy, see
Backup and restore types.

Supported Clients

This command is valid only on supported Linux clients that are installed
on a vStorage backup server that protects VMware virtual machines.

Syntax

                .-,------.
                V        |
              .---vmname-+-.
>>-Backup VM--+------------+------------------------------------>

>--+--------------------------------+--------------------------->
   | .-,--------------------------. |
   | V                            | |
   '---vmname--:vmdk=--disk_label-+-'

>--+----------------------+--+------------------------+--------><
   '- -VMBACKUPUPDATEGUID-'  '- -PREView-- --options-'



Parameters

vmname
         Specify the name of one or more virtual machines that you want
         to back up. The name is the virtual machine display name.
         Separate multiple virtual machine names with commas. If you set
         the vmenabletemplatebackups option to yes, vmname can specify
         the name of a template VM to back up.

         VMware vCenter allows for two or more virtual machines to have
         the same display name. However, the backup-archive client
         requires that all virtual machine names in a vCenter server
         configuration be unique. To prevent errors during processing,
         ensure that all virtual machines have a unique display name.

         Wildcard characters can be used in virtual machine names that
         are specified as this parameter. However, wildcard processing
         differs, depending on which backup mode is used.

         *  For backups that use mode=iffull or mode=ifincremental,
            wildcards can be used to match VM name patterns. For
            example:

            *  backup vm VM_TEST* includes all virtual machines that
               have names that begin with VM_TEST

            *  backup vm VM?? includes any virtual machine that has a
               name that begins with the letters "VM", followed by 2
               characters

         Restriction: Do not use the word "aggregate" as a VM name. The
         word "aggregate" is reserved for the VM name field in an IBM
         Spectrum Protect message. Messages that contain the word
         "aggregate" as the VM name show statistics that represent the
         total value of all VM guests that are backed up per data mover.
         If you do not specify vmname, you can identify the virtual
         machine with the domain.vmfull option.

:vmdk=disk_label
         This keyword is an extension to the vmname. It specifies the
         label (name) of the virtual machine disk to include in the
         backup operation. You can exclude a disk by preceding the
         keyword with the exclusion operator (-). For more ways to
         include or exclude disks from processing, see domain.vmfull,
         INCLUDE.VMDISK, EXCLUDE.VMDISK.

-VMBACKUPUPDATEGUID
         To use this option, you must have a license agreement to use
         IBM Spectrum Protect for Virtual Environments: Data Protection
         for VMware.
         This option updates the globally unique identifier (GUID) for
         the virtual machine that you are backing up. This parameter is
         intended for use only in the following scenario:

         You want to restore a previously backed up virtual machine
         named ORION. But, before you shut down and replace the copy of
         ORION that is running in your production environment, you want
         to verify the configuration of the restored virtual machine
         before you use it to replace the existing ORION.

         1. You restore the ORION virtual machine and give it a new
            name: dsmc restore vm Orion -vmname=Orion2

         2. You update and verify the ORION2 virtual machine and
            determine that it is ready to replace the existing virtual
            machine that is named ORION.

         3. You power down and delete ORION.

         4. You rename ORION2 so that it is now named ORION.

         5. The next time that you backup ORION, by using either an
            incremental-forever full, or incremental-forever-incremental
            backup, you add the -VMBACKUPUPDATEGUID parameter to the
            backup vm command. This option updates the GUID, on the IBM
            Spectrum Protect server, so the new GUID is associated with
            the stored backups for the ORION virtual machine. The chain
            of incremental backups is preserved; there is no need to
            delete existing backups and replace them with new backups.

-PREView
         This option displays information about a virtual machine,
         including the labels of the hard disks in the virtual machine,
         and the management class information for a virtual machine.

         You can use the disk labels with the :vmdk= or :-vmdk= keywords
         to include or exclude disks from a backup operation. The
         following text is sample output from the -preview parameter:

         backup vm vm1 -preview
         Full BACKUP VM of virtual machines 'VM1'

         vmName:vm1
         VMDK[1]Label: Hard disk 1
         VMDK[1]Name: [ds5k_svt_1] tsmcetlnx14/tsmcetlnx14.vmdk
         VMDK[1]Status: Included
         VMDK[2]Label: Hard disk 2
         VMDK[2]Name: [ds5k_svt_1] tsmcetlnx14/tsmcetlnx14_1.vmdk
         VMDK[2]Status: Excluded - user,Independent,pRDM

         This example output from -preview shows that VMDK 2 was
         excluded by the previous backup. Disks that were included in a
         backup have a status of Included. Disks that were excluded from
         the backup have a status of Excluded, followed by a reason
         code. The reason codes can be any of the following:

         user
                  Indicates that the disk was skipped because it was
                  excluded on a domain.vmfull statement, on the command
                  line, or in the client options file.

         Independent
                  Indicates that the disk is an independent disk.
                  Independent disks cannot be part of a snapshot, so
                  they are excluded from backup vm operations. Ensure
                  that the vmprocessvmwithindependent option is set to
                  yes or the entire virtual machine is bypassed by a
                  backup operation if it contains one or more
                  independent disks.

         pRDM
                  Indicates that the disk is a physical Raw Device
                  Mapped (pRDM) disk. pRDM disks cannot be part of a
                  snapshot, so they are excluded from backup vm
                  operations. Ensure that the vmprocessvmwithprdm option
                  is set to yes or the entire virtual machine is
                  bypassed by a backup operation if it contains one or
                  more raw device mapping (RDM) volumes that are
                  provisioned in physical-compatibility mode (pRDM).

         The output from the -preview parameter also shows the
         management class name that is associated with the virtual
         machine, along with information about where the management
         class was set. This information can help you verify whether the
         domain and tag values are set correctly for the management
         class. For example:

         backup vm -preview
         Full BACKUP VM of virtual machines specified in DOMAIN.VMFULL option.

           1. vmName: tag_vm_2
                DomainKeyword:  all-vm
                toolsRunningStatus: guestToolsNotRunning
                toolsVersionStatus: guestToolsNotInstalled
                consolidationNeeded: No
                Change Block Tracking: On
                managementClassName: STANDARD
                managementClassLocation: Node Default

                VMDK[1]Label:   'Hard disk 1' (Hard Disk 1)
                VMDK[1]Name:    '[Raid1-lannds2] tag_vm_2/tag_vm_2.vmdk'
                VMDK[1]Status:  Included
         ...

         12. vmName: vm-jean
                DomainKeyword:  all-vm
                toolsRunningStatus: guestToolsNotRunning
                toolsVersionStatus: guestToolsNotInstalled
                consolidationNeeded: No
                Change Block Tracking: On
                managementClassName: MGMTCLASS1 (invalid)
                managementClassLocation: VM Tag Management Class (IBM Spectrum Protect)

                VMDK[1]Label:   'Hard disk 1' (Hard Disk 1)
                VMDK[1]Name:    '[Raid1-lannds2] vm-jean/vm-jean.vmdk'
                VMDK[1]Status:  Included


         where:

         managementClassName
                  Displays the name of the management class that the
                  virtual machine is bound to.

                  If the "(invalid)" label is shown next to the
                  management class name, either the name was incorrectly
                  specified, the management class was removed on the IBM
                  Spectrum Protect server, or no backup copy group was
                  found in the management class on the server. When the
                  management class name is invalid, the virtual machine
                  backup operation fails.

         managementClassLocation
                  Displays where the management class was set. The
                  following locations are possible:

                  Node Default
                           The management class is set on the default
                           domain of the VMware datacenter node.

                  VMMC option
                           The management class is set with the vmmc
                           option.

                  VMCTLMC option
                           The management class is set with the vmctlmc
                           option.

                  INCLUDE.VM option
                           The management class is set with the
                           include.vm option.

                  VM Tag Management Class (IBM Spectrum Protect)
                           The management class is set as a tag value of
                           the Management Class (IBM Spectrum Protect)
                           tag category. Tag values can be set with data
                           protection settings in the IBM Spectrum
                           Protect vSphere Client plug-in in the vSphere
                           Web Client, or by using tools such as VMware
                           vSphere PowerCLI version 5.5 R2 or later.

         Important: In order to display the management class information
         that is set by tags, you must set the vmtagdatamover yes option
         in the client options file, or you must include the
         -vmtagdatamover=yes parameter when you run the dsmc backup vm
         command. If you did not set the vmtagdatamover option or if it
         is set to no, the client ignores any management class tag
         values, and displays the management class definition that is
         set in the default domain of the datacenter node, the vmmc
         option, or the include.vm option.

Return codes for virtual machine backup operations

Backup operations for virtual machines can complete with the return
codes that are shown in the following table.



+----------+----------------------------------------------------------+
| Return   | Description                                              |
| code     |                                                          |
+----------+----------------------------------------------------------+
| 0        | A command to back up one or more virtual machines        |
|          | completed successfully.                                  |
+----------+----------------------------------------------------------+
| 8        | A command to back up multiple virtual machines succeeded |
|          | for only some of the virtual machines that were targeted |
|          | by the command. Examine the log file to determine the    |
|          | processing status for each of the targeted virtual       |
|          | machines.                                                |
+----------+----------------------------------------------------------+
| 12       | Indicates that either of the following error conditions  |
|          | occurred:                                                |
|          |  * The backup command could not back up any of the       |
|          | virtual machines that were targets of the backup         |
|          | operation.                                               |
|          |  * The backup command failed and it stopped before all   |
|          | virtual machines that were specified were inspected.     |
|          | Examine the log file to determine the reason for the     |
|          | failure.                                                 |
+----------+----------------------------------------------------------+

Tip about the final statistics: If you are running multiple backup
sessions, the value that is displayed in the Data transfer time field in
the final statistics can be higher than the value in the Elapsed
processing time field. The data transfer time is the sum of the times
that each backup takes to send data across the network. This number does
not include the time for the data mover to read the data from disk
before sending it, nor the time to wait for server transactions to
complete. This number can be greater than the elapsed processing time if
the operation uses multiple concurrent sessions to move data, such as
multi-session backup operations. This value includes the time that it
takes to send data more than once due to retries, such as when a file
changes during a backup operation.

vStorage API for data protection example commands

Perform an IFIncremental backup of two VMs named vm3 and vm4.

dsmc backup vm vm3,vm4 -vmbackuptype=fullvm -mode=ifincremental

Perform an IFFull backup of a VM named vm1.

dsmc backup vm vm1 -vmbackuptype=fullvm -mode=iffull

Perform an IFFull VM backup of a VM named vm1, but include only Hard
Disk 1 in the backup operation.

dsmc backup vm "vm1:vmdk=Hard Disk 1" -vmbackuptype=fullvm -mode=iffull

Perform an incremental-forever backup of a virtual machine that is named
vm1, but exclude Hard Disk 1 and Hard Disk 4 from the backup operation.

dcmc backup vm "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 4"
  -vmbackuptype=fullvm -mode=iffull

Perform an incremental-forever-full backup of two virtual machines that
are named vm1 and vm2. On vm1, back up only Hard Disk 2 and Hard Disk 3.
On vm2, back up all virtual disks.

dsmc backup vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3",
  vm2 -vmbackuptype=fullvm -mode=iffull

Perform parallel incremental-forever-full backups of the VMware virtual
machines that are selected for backup by using the selection criteria
(domain parameters) on the domain.vmfull statement. Set the maximum
number of parallel backups to 5 virtual machines and 10 sessions and
limit the backups to 5 VMs per host and 5 VMs per datastore.

dsmc backup vm -vmbackuptype=fullvm -mode=iffull -vmmaxparallel=5
  -vmmaxbackupsessions=10 -vmlimitperhost=5 -vmlimitperdatastore=5

Related links for backing up VMware virtual machines
         *  2.42 Query VM

         *  2.49 Restore VM (VMware)

         *  3.4.46 Domain.vmfull

         *  3.4.86.4.1 Include.vm

         *  3.4.101 Mbobjrefreshthresh

         *  3.4.102 Mbpctrefreshthresh

         *  3.4.104 Mode

         *  3.4.202 Vmbackdir

         *  3.4.203 Vmbackuplocation

         *  3.4.204 Vmbackupmailboxhistory

         *  3.4.205 Vmbackuptype

         *  3.4.206 Vmchost

         *  3.4.208 Vmctlmc

         *  3.4.207 Vmcpw

         *  3.4.209 Vmcuser

         *  3.4.210 Vmdatastorethreshold

         *  3.4.214 Vmenabletemplatebackups

         *  3.4.215 Vmlimitperdatastore

         *  3.4.216 Vmlimitperhost

         *  3.4.217 Vmmaxbackupsessions

         *  3.4.218 Vmmaxparallel

         *  3.4.222 Vmmaxvirtualdisks

         *  3.4.223 Vmmc

         *  3.4.227 Vmpreferdagpassive

         *  3.4.228 Vmprocessvmwithindependent

         *  3.4.229 Vmprocessvmwithprdm

         *  3.4.230 Vmskipctlcompression

         *  3.4.231 Vmskipmaxvirtualdisks

         *  3.4.233 Vmtagdatamover

         *  3.4.234 Vmtagdefaultdatamover

         *  3.4.235 Vmverifyifaction

         *  3.4.236 Vmverifyiflatest

         *  3.4.238 Vmvstortransport

         *  3.4.237 Vmvstorcompr

         *  3.4.239 Vmtimeout

         *  2.57 Set Vmtags

         *  Virtual machine exclude options

         *  Virtual machine include options


2.12 Cancel Process


The cancel process command displays a list of current NAS (if NDMP
support is enabled) image backup and restore processes for which the
administrative user has authority. You are prompted for the IBM Spectrum
Protect administrator ID.

From the list, the administrative user can select one process to cancel.
Client owner privilege is sufficient authority to cancel the selected
NAS image backup or restore processes.

Supported Clients

This command is valid for AIX, Linux, and Solaris clients only.

Syntax

>>-Cancel Process----------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Cancel current NAS image backup or restore processes.

         Command: cancel process


2.13 Cancel Restore


The cancel restore command displays a list of your restartable restore
sessions in the server database.

You can cancel only one restartable restore session at a time. Run the
cancel restore command again to cancel more restores. To restart
restartable restore sessions, use the restart restore command.

Use the cancel restore command under the following circumstances:

*  You cannot back up files that are affected by the restartable
   restore.

*  Restartable restore sessions lock the file space so that files cannot
   be moved off of the sequential volumes of the server.

Supported Clients

This command is valid for all clients.

Syntax

>>-Cancel Restore----------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Cancel a restore operation.

         cancel restore




2.14 Delete Access


The delete access command deletes authorization rules for files that are
stored on the server.

When you delete an authorization rule, you revoke user access to any
files or images that are specified by that rule.

Supported Clients

This command is valid for all clients.

Syntax

>>-Delete-- --ACcess------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Display a list of current authorization rules and select the
         rules that you want to delete.

         delete access



         See the following screen example:



         Index   Type       Node    Owner   Path
         _____   _______    ____________________________________
         1       Backup     NODE1   USER1   home/dev/proja/list/
         2       Archive    NODE3   LUIE    home/fin/budg/depta/
         3       Backup     NODE4   USER2   home/plan/exp/deptc/
         4       Archive    NODE5   USER2S  home/mfg/invn/parta/
         Enter Index of rule(s) to delete, or quit to cancel:

         To delete the authorization rules that allow luie and user2s to
         access your files or images, type 2 4 or 2,4 and press Enter.




2.15 Delete Archive


The delete archive command deletes archived files from IBM Spectrum
Protect server storage. Your administrator must give you the authority
to delete archived files.

Important: When you delete archived files, you cannot retrieve them.
Verify that the files are obsolete before you delete them.

Supported Clients

This command is valid for all clients.

Syntax

>>-Delete ARchive--+-------------+------------------------------>
                   '- --options-'

>--+- --filespec----------------------+-----------------------><
   '- --{--filespacename--}--filespec-'



Parameters

filespec
         Specifies the path and file name that you want to delete from
         storage. Use wildcard characters to specify a group of files or
         all files in a directory. You can also use the filelist option
         to process a list of files. The backup-archive client opens the
         file that you specify with this option and processes the list
         of files within according to the specific command.

         Note: If you indicate filespacename, do not include a drive
         letter in the file specification.

{filespacename}
         Specifies the file space (enclosed in braces) on the server
         that contains the file you want to delete. This is the name on
         the workstation drive from which the file was archived.

         Use the filespacename if the name was changed, or if you are
         deleting files that are archived from another node with drive
         labels that are different from yours.



Table 9. Delete Archive command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| noprompt           | Command line only.                             |
+--------------------+------------------------------------------------+
| numberformat       | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| subdir             | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| tapeprompt         | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Delete a file that is named budget.

         dsmc delete archive /user/home/proj1/budget

Task
         Delete all files that are archived from the /user/home/proj1
         directory with a file extension of .txt.

         dsmc del arch "/user/home/proj1/*.txt"

Task
         Delete files that are archived from the /user/project directory
         by using the pick option to display a list of archive copies
         that match the file specification. From the list, you can
         select the versions to process.

         dsmc delete archive "/user/project/*" -pick

Task
         Delete selected files from the group of files that are archived
         with the description "Monthly Budgets 2010" located in
         /user/projects and its subdirectories.

         dsmc delete ar "/user/projects/*" -description="Monthly Budgets
         2010" -pick -subdir=yes


2.16 Delete Backup


The delete backup command deletes files, images, and virtual machines
that were backed up to IBM Spectrum Protect server storage. Your
administrator must give you authority to delete objects.

When you delete files, the IBM Spectrum Protect server takes all of the
backed up files that meet the filespec and deltype options that are
specified and deactivates them. The server also assigns a deactivation
date of infinite-minus so that the files are no longer available for
restore and are purged, immediately on the subsequent run of file
expiration. The file is not physically removed until the expiration
process runs.

Important: After you delete backup files, you cannot restore them;
verify that the backup files are no longer needed before you delete
them. You are prompted to choose whether you want to continue with the
delete. If you specify yes, the specified backup files are scheduled for
deletion and removed from server storage.

Restriction: Files that are contained in a retention set are not deleted
when you issue the delete backup command. These files are retained in
server storage to satisfy long-term data retention requirements and
expire according to the retention set's own expiration date after which
they are eligible for deletion. Therefore, they are still available for
normal file processing operations, such as query or restore operations,
until the retention set expires.

Supported Clients

This command is valid for all clients.

Syntax

>>-Delete BAckup-- --+-----------------------------------+----->
                      '-+-filespec----------------------+-'
                        '-{--filespacename--}--filespec-'

>--+------------------------------------------------+----------->
   | .-objtype=FILE-------------------------------. |
   '-+--------------------------------------------+-'
     +-objtype=IMAGE------------------------------+
     '-objtype=VM-+--------------------+- vmname-'
                  |         .-BOTH---. |
                  '--FROM -+-SERVER-+-'
                            '-LOCAL--'

   .-deltype=ACTIVE-------.
>--+----------------------+-+---------+------------------------><
   +-+------------------+-+ '-options-'
   | '-deltype=INACTIVE-' |
   '-+-------------+------'
     '-deltype=ALL-'



Parameters

filespace/filespec
filespec
         Specifies the path and file name that you want to delete from
         storage. To specify a file in another file space, precede the
         file name with the file space name. Use wildcard characters to
         specify a group of files or all files in a directory. Separate
         file specifications with a space. You can also use the filelist
         option to process a list of files. The backup-archive client
         opens the file that is specified with this option and processes
         the list of files within according to the specific command.

         Note: If you indicate filespacename, do not include a drive
         letter in the file specification.

         When you use -deltype=inactive or -deltype=active, use wildcard
         characters to specify a group of files or all files in a
         directory.

         When you use -deltype=all, specify a fully wildcarded
         directory.

objtype
         Specifies the type of object that you want to delete. You can
         specify either of the following values:

         FILE
                  Specifies that you want to delete directories and
                  files. This value is the default object type.

         IMAGE
                  Specifies that you want to delete an image backup.
                  Specifies that you want to delete an image backup.
                  Objtype=image is not supported on Mac OS X.

         VM vmname
                  Specifies that you want to delete one or more versions
                  of a virtual machine backup; the virtual machine is
                  identified by the vmname variable parameter. The
                  virtual machine name cannot contain wildcard
                  characters.

                  This feature is available only if the client operates
                  as a data mover for IBM Spectrum Protect for Virtual
                  Environments.



                  When objtype=VM is specified, the filelist option
                  cannot be used. Specifying objtype=VM changes the
                  behavior of the -deltype option. When objtype=vm is
                  specified, you can use either -deltype=active or
                  -deltype=inactive. You cannot use -deltype=all.
                  Specifying -deltype=inactive displays a list of both
                  inactive and active backups. You can use this list to
                  specify which virtual machine backups that you want to
                  delete. To delete only active virtual machine backups,
                  use -deltype=active.

                  When you specify -objtype=VM, this command deletes
                  only virtual machine backups that were created with
                  any of the following modes: IFINCR, and IFFULL.

                  For backups that were created with the version 7.1 or
                  earlier clients: Individual incremental backups
                  (backups that were created by using MODE=INCR) that
                  were created after a full backup was run cannot be
                  deleted with this command. However, if you delete a
                  full virtual machine image backup (created by using
                  MODE=FULL), and if the server has any incremental
                  backups (MODE=INCR) that were created for this VM
                  after the full backup, then deleting the full VM
                  backup also deletes the files that were created by a
                  MODE=INCR backup.

                  If you delete an active backup for a virtual machine,
                  the most recent inactive copy becomes the active
                  backup. If you specify the -pick or -inactive option,
                  only the backup that you specify is deleted. If you
                  select a backup that is created by MODE=IFINCR, only
                  the selected incremental backup is deleted; other
                  incremental backups for the virtual machine are not
                  deleted.

                  -FROM
                           Specify the backup location or locations
                           where virtual machine backups are deleted.
                           You can specify one of the following values:

                           SERVER
                                    Backups of virtual machines are
                                    deleted from the IBM Spectrum
                                    Protect server.

                           LOCAL
                                    Persisted snapshots of virtual
                                    machines are deleted from the
                                    hardware storage.

                           BOTH
                                    Backups of virtual machines that are
                                    on the IBM Spectrum Protect server
                                    and snapshots that are on the
                                    hardware storage are deleted. This
                                    value is the default.
                                    Specifying this value displays a
                                    list of backup locations. From the
                                    list, you can select the location
                                    from which to delete virtual machine
                                    backups.

deltype
         Specifies the deletion type. Specify one of the following
         values:

         ACTIVE
                  Delete only active file objects. Directory objects are
                  not deleted. This value is the default deletion type.

                  Note: If there are any inactive objects, then after
                  the active object is deleted, the most current
                  inactive object is changed from inactive to active.



                  To delete all versions of a file, first issue the
                  delete backup command with -deltype=inactive, then
                  enter the command again with -deltype=active.

         INACTIVE
                  Delete only inactive file objects. Directory objects
                  are not deleted.

         ALL
                  Delete all active and inactive objects below a
                  particular directory, including all subdirectories and
                  their files.

                  Note: The parent directory of the deleted files and
                  subdirectories is not deleted. If you specify
                  deltype=ALL, you cannot use the pick option because
                  deltype=ALL and the pick option are mutually
                  exclusive.

Table 10. Delete Backup command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromdate           | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+
| fromtime           | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+
| noprompt           | Command line only.                             |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| pitdate            | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+
| pittime            | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+
| subdir             | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| tapeprompt         | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client options file ( dsm.opt ) or command     |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| todate             | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+
| totime             | Command line, and in the GUI find function.    |
+--------------------+------------------------------------------------+

Examples

Task
         Delete all active and inactive file objects that are named
         budget in directory /data/plan/proj1.

         Commands:

         delete backup /data/plan/proj1/budget.jan
           -deltype=inactive
         delete backup /data/plan/proj1/budget.jan
           -deltype=active



Task
         Delete all inactive files that have a .txt extension that were
         backed up from the /data/plan/proj1 directory and its
         subdirectories.

         Command: delete backup "/data/plan/proj1/*.txt"
         -deltype=inactive -subdir=yes

Task
         Delete selected active files that are backed up from the
         /home/marymb/project directory. Use the -pick option to display
         a list of backup copies that match the file specification. From
         the list, you can select which versions to delete.

         Command: delete backup "/home/marymb/project/*" -pick

Task
         Delete all active and inactive versions of files and
         subdirectories in the /home/storman/myproject directory. Then,
         delete all active and inactive versions of the /user/myproject
         directory.

         Command:

         delete backup "/home/storman/myproject*"
          -deltype=all


2.17 Delete Filespace


The delete filespace command deletes file spaces in IBM Spectrum Protect
server storage. A file space is a logical space on the server that
contains files you backed up or archived.

You must be an authorized user to use this command.

IBM Spectrum Protect assigns a separate file space on the server for
each workstation file system from which you back up or archive files.
The file space name is the same as the file system name.

When you enter the delete filespace command, a list of your file spaces
is displayed. From this list, select the file space that you want to
delete.

Your IBM Spectrum Protect administrator must give you authority to
delete a file space. You need BACKDEL authority if the file space you
want to delete contains backup versions, or ARCHDEL authority if the
file space contains archive copies. If the file space contains both
backup versions and archive copies, you need both types of authority.

Important: When you delete a file space, you delete all backup versions
and archive copies within that file space. When you delete a file space,
you cannot restore the files. Verify that the files are obsolete before
you delete them.

You can use the delete filespace command to interactively delete NAS
file spaces from server storage. Use the nasnodename option to identify
the NAS file server. Use the class option to specify the class of the
file space to delete.

Supported Clients

This command is valid for all clients.

Syntax

>>-Delete Filespace--+-------------+---------------------------><
                     '- --options-'



Parameters

Table 11. Delete Filespace command: Related options

+-------------------------------+-------------------------------------+
| Option                        | Where to use                        |
+-------------------------------+-------------------------------------+
| class                         | Command line only.                  |
+-------------------------------+-------------------------------------+
| detail                        | Command line only.                  |
+-------------------------------+-------------------------------------+
| nasnodename                   | Client system options file or       |
|                               | command line.                       |
+-------------------------------+-------------------------------------+
| scrolllines                   | Client system options file or       |
|                               | command line.                       |
+-------------------------------+-------------------------------------+
| scrollprompt                  | Client system options file or       |
|                               | command line.                       |
+-------------------------------+-------------------------------------+

Examples

Task
         Delete a file space.

         Command: delete filespace

Task
         Delete NAS file spaces from the dagordon NAS file server stored
         on the server.

         Command: delete filespace -nasnodename=dagordon -class=nas


2.18 Delete Group


Use the delete group command to delete a group backup on the IBM
Spectrum Protect server.

After you delete a group, the group leader (virtualfsname) remains on
the IBM Spectrum Protect server. It contains no members (file or
directories) but is reported in a subsequent query filespace command. No
files are listed if the showmembers option is added. Deleting a group
does not remove the file space that it resides in because there might be
other groups in it. Use delete filespace if you want to remove the file
space and all the data it contains.

Note:

1. Use the inactive option to display both active and inactive group
   backup versions. By default, the client displays active versions.

2. Use the pick option to select a specific group to delete from the IBM
   Spectrum Protect server.

3. Use the noprompt option if you want to suppress the confirmation
   prompt that normally appears before you delete a group backup
   version. By default, the client prompts you for confirmation before
   you delete the group backup. Using this option can speed up the
   delete procedure. However, it also increases the danger of
   accidentally deleting a group backup version that you want to save.
   Use this option with caution.

4. Use the query filespace command to display virtual file space names
   for your node that are stored on the server.

Supported Clients

This command is valid for all UNIX and Linux clients, except for Mac OS
X.

Syntax

>>-Delete GRoup-- --filespec--+-------------+-----------------><
                               '- --options-'



Parameters

filespec
         Specifies the virtual file space name and the group name that
         you want to delete from the server storage.

Table 12. Delete Group command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| noprompt           | Command line only.                             |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Delete the current active version of the /virtfs/group1 group.

         Command:

         delete group /virtfs/group1

Task
         Delete a backup version of the /virtfs/group1 group from a list
         of active and inactive versions.

         Command:

         delete group /virtfs/group1 -inactive -pick


2.19 Expire


The expire command deactivates the backup objects that you specify in
the file specification or with the filelist option. You can specify an
individual file to expire, or a file that contains a list of files to
expire. If OBJTYPE=VM, this command deactivates the current backup for a
virtual machine.

When you are working in interactive mode, a prompt notifies you before
files are expired.

The expire command does not remove workstation files. If you expire a
file or directory that still exists on your workstation, the file or
directory is backed up again during the next incremental backup, unless
you exclude the object from backup processing.

If you expire a directory that contains active files, those files are
not displayed in a subsequent query from the GUI. However, these files
are displayed on the command line, if you specify the correct query with
a wildcard character for the directory.

Note: Because the expire command changes the server picture of the
client file system without changing the client file system, the expire
command is not allowed on files that are on a file system that is
monitored by the IBM Spectrum Protect journal daemon.

Supported Clients

This command is valid for all clients.

Syntax

               .-OBJTYPE=FILE-- --filespec-.
>>-EXPire-- --+----------------------------+--+------------------------+-->
                                               '-OBJTYPE=VM-- --vmname-'

>--+---------+-------------------------------------------------><
   '-options-'



Parameters

OBJTYPE=FILE filespec
         Specifies a path and a file name that you want to expire. You
         can enter only one file specification on this command. However,
         you can use wildcards to select a group of files or all the
         files in a directory. If you specify the filelist option, the
         filespec designation is ignored.

OBJTYPE=VM vmname
         vmname specifies the name of a virtual machine. The active
         backup for the specified virtual machine is expired. The
         virtual machine name cannot contain wildcard characters.

         When objtype=VM is specified, the expire command expires only
         full virtual machine backups (MODE=IFFULL) for the virtual
         machine that is specified on the vmname parameter.

         This feature is available only if the client operates as a data
         mover for IBM Spectrum Protect for Virtual Environments.

Table 13. Expire command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| noprompt           | Command line only.                             |
+--------------------+------------------------------------------------+
| numberformat       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| timeformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Deactivate the letter1.txt file in the home directory.

         Command: expire "/home/letter1.txt"

Task
         Deactivate all files in the /admin/mydir directory.

         Command: expire /admin/mydir/*

Task
         Deactivate all files that are named in the
         /home/avi/filelist.txt file.

         Command: expire -filelist=/home/avi/filelist.txt


2.20 Help


Use the help command to display information about commands, options, and
messages.

Tip: If you use the help command on the initial command line, no server
contact is made and no password is needed.

Supported Clients

This command is valid for all clients.

Syntax

>>-Help--+--------------------------------+--------------------><
         +-command-name [subcommand-name]-+
         +-option-name--------------------+
         +-TOC-section-number-------------+
         '-[ANS]message-number------------'



Entering the help command with no arguments causes help to display the
complete table of contents. Either with the initial command or when HELP
displays a prompt, you can enter the following parameters.

Parameters

command-name [subcommand-name]
         Specifies a command name and, optionally, a subcommand name or
         their abbreviation, for example: backup image, or b i. In that
         case, the combination must be unique. Non-unique abbreviations
         result in the display of the first section of the entire help
         file that matches the abbreviation. This parameter is optional.

option-name
         Specifies the name of an option, for example: domain or do.
         This parameter is optional.

TOC-section-number
         Specifies a table of contents section number, for example:
         1.5.3. This parameter is optional.

[ANS]message-number
         Specifies a message number with or without its prefix, for
         example: ans1036 or 1036. This parameter is optional. The
         severity code is never necessary. Entering ans1036E results in
         a not-found response.

Important: If you enter arguments that do not fit these descriptions,
you may get unexpected results (or no results) to be displayed. If you
enter more than two arguments, your help request is rejected. Where a
command name and an option name are the same, for example: incremental
(command) and incremental (option), you can get help on the option by
entering its table-of-contents section number.

The requested help text is displayed in one or more sections, depending
on the number of display lines that are available in your command
window. When enough lines are displayed to fill the display space, or
when the end of the requested help text is displayed, you see a prompt
along with instructions for what can be entered at that prompt. To
continue displaying text for your current selection, press enter or type
the 'd' key to scroll down. To scroll up in the current selection, press
the 'u' key and press Enter. Other choices might be presented, so read
the prompt instructions.

Proper display of the help text requires a usable display width of 72
characters. A display width fewer than 72 characters causes sentences
that are 72 characters wide to wrap to the next line. This can cause the
displayed help text to begin somewhere within the section rather than at
the beginning. The undisplayed lines can be viewed by using the
scrolling function of the terminal to move up.

Examples

Task
         Display the table of contents of the help topics.

         Command: dsmc help

Task
         Display the information in help topic 2.1.2

         Command: dsmc help 2.1.2

Task
         Display help information on the archive command.

         Command: dsmc help archive

Task
         Display help information on message ANS1036.

         Command: dsmc help 1036

         Command: dsmc help ANS1036


2.21 Incremental


The incremental command backs up all new or changed data in the
locations that you specify, unless you exclude them from backup
services.

You can back up all new or changed files or directories in the default
client domain or from file systems, directories, or files.

To incrementally back up selected files or directories, enter a file
specification in the command. If you do not enter a file specification,
the default is to back up files or directories in the default domain.

AIX only: You can enable snapshot-based incremental backup by using the
option snapshotproviderfs=JFS2.

The following attributes in the management class that is assigned to the
file or directory affect whether the data is backed up:

Frequency
         The number of days that must elapse between successive backups
         of the object. The frequency attribute applies only to a full
         incremental backup.

         This management class attribute is ignored during a
         journal-based backup.

Mode
         Specifies whether changes since the last backup operation
         affect the processing. If mode=modified, only objects that
         changed since the last backup operation are processed. If
         mode=absolute, every object is processed, regardless of whether
         the object changed since the last backup operation.

         If the copy group mode is set to modified, it can be overridden
         by using the client absolute option. For more information about
         the absolute option, see 3.4.1 Absolute.

Serialization
         Permits or denies backup of files or directories according to
         the following values:

         *  static: To be backed up, data must not be modified during
            backup or archive.

         *  shared static: If data in the file or directory changes
            during each of the allowed attempts to back up or archive
            it, it is not backed up or archived. The value of the
            changingretries option determines how many attempts are
            made. The default is 4.

         *  dynamic: The object is backed up or archived on the first
            attempt whether or not data changes during the process.

         *  shared dynamic: The object is backed up or archived on the
            last attempt, even if data changes during the process.

Using the include option in an include-exclude list, you can override
the default management class for a file or group of files.

You can perform either a full incremental backup or an
incremental-by-date backup. The default is a full incremental backup.

If you are journaling a file system and the journal is valid, the full
incremental backup performs a journal-based backup. More than one
journal-based backup session can be started, but only one journal-based
backup session can proceed. All other journal-based backup sessions that
need access to the same file space must wait until the current
journal-based backup session completes before the next session can
proceed. You can perform a full incremental backup without the journal
by using the nojournal option.

You can also use the selective command to perform a backup that backs up
only the files, directories, or empty directories that you specify
regardless of whether they were changed.

A full incremental backs up all files and directories that are new or
were changed since the last incremental backup. During a full
incremental backup, the client queries the server. IBM Spectrum Protect
uses this information when it performs the following actions:

*  Backing up new files or directories.
*  Backing up files or directories whose contents were changed since the
   previous backup.
*  Marking inactive backup versions on the server for files or
   directories that are deleted from the workstation.
*  Rebinding backup versions to management classes if the management
   class assignments change.

Supported Clients

This command is valid for all clients.

Syntax

                                 .--------------------.
                                 V                    |
>>-Incremental--+-------------+----+----------------+-+--------><
                '- --options-'    +- --filespec---+
                                   '- --"filespec"-'



Parameters

filespec
         Specifies the path and file name that you want to back up. Use
         wildcard characters to select a group of files or all the files
         in a directory. If you do not specify a file specification, the
         domain option determine what to back up.

         If you specify a file system, all new and changed files are
         backed up. In addition, the last incremental date for the file
         space is updated on the server. If you specify a file or
         directory, the last incremental date is not updated. This means
         that the file or directory might be backed up again if a later
         backup is performed by using the incrbydate option. If you
         specify a file system, specify the file system without a
         trailing slash.

Table 14. Incremental command: Related options

+-----------------------------------------+---------------------------+
| Option                                  | Where to use              |
+-----------------------------------------+---------------------------+
| absolute                                | Command line only.        |
+-----------------------------------------+---------------------------+
| changingretries                         | dsm.sys file or command   |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| compressalways                          | Client user-options file  |
|                                         | ( dsm.opt ) or command    |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| compression                             | dsm.sys file within a     |
|                                         | server stanza or command  |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| detail                                  | Command line only.        |
+-----------------------------------------+---------------------------+
| diffsnapshot                            | Command line only.        |
+-----------------------------------------+---------------------------+
| dirsonly                                | Command line only.        |
+-----------------------------------------+---------------------------+
| domain                                  | dsm.sys file or the       |
|                                         | client user-options file  |
|                                         | ( dsm.opt ) or command    |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| encryptiontype                          | System-options file (     |
|                                         | dsm.sys ) within a server |
|                                         | stanza.                   |
+-----------------------------------------+---------------------------+
| encryptkey                              | System-options file (     |
|                                         | dsm.sys ) within a server |
|                                         | stanza.                   |
+-----------------------------------------+---------------------------+
| filelist                                | Command line only.        |
+-----------------------------------------+---------------------------+
| filesonly                               | Command line only.        |
+-----------------------------------------+---------------------------+
| incrbydate                              | Command line only.        |
+-----------------------------------------+---------------------------+
| memoryefficientbackup                   | Client user-options file  |
|                                         | ( dsm.opt ), client       |
|                                         | system-options file (     |
|                                         | dsm.sys ), server, or     |
|                                         | command line.             |
+-----------------------------------------+---------------------------+
| nojournal                               | Command line only.        |
+-----------------------------------------+---------------------------+
| preservelastaccessdate                  | Client user-options file  |
|                                         | ( dsm.opt ) or command    |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| removeoperandlimit                      | Command line only.        |
+-----------------------------------------+---------------------------+
| snapdiff                                | Command line only.        |
+-----------------------------------------+---------------------------+
| snapshotcachesize                       | Client options file (     |
|                                         | dsm.opt ) or with the     |
|                                         | include.fs option.        |
+-----------------------------------------+---------------------------+
| snapshotproviderfs                      | System-options file (     |
|                                         | dsm.sys ) within a server |
|                                         | stanza or with the        |
|                                         | include.fs option.        |
+-----------------------------------------+---------------------------+
| snapshotroot                            | Command line only.        |
+-----------------------------------------+---------------------------+
| subdir                                  | Client user-options file  |
|                                         | ( dsm.opt ) or command    |
|                                         | line.                     |
+-----------------------------------------+---------------------------+
| tapeprompt                              | Client user-options file  |
|                                         | ( dsm.opt ) or command    |
|                                         | line.                     |
+-----------------------------------------+---------------------------+

Examples

Task
         Run an incremental backup of the client domain that is
         specified in your client user-options file (dsm.opt).

         Incremental
         Run an incremental backup that backs up all files in the domain
         regardless of whether they were changed since the last backup.

         Incremental -absolute

Task
         Run an incremental backup for the /home, /usr, and /proj file
         systems.

         Incremental /home /usr /proj

Task
         Run an incremental backup for the /proj/test directory.

         Incremental /proj/test/

Task
         Run an incremental-by-date backup for the /home file system.

         Incremental -incrbydate /home

Task
         Run an incremental backup of the abc file in the /fs/dir1
         directory.

         Incremental -subdir=yes /fs/dir1/abc

Task
         Run an incremental backup of the directory object /fs/dir1, but
         not any of the files in the /fs/dir1 directory.

         Incremental /fs/dir1

Task
         Run an incremental backup of the directory object /fs/dir1, all
         of the files in the fs/dir1 directory, and all files and
         subdirectories under /fs/dir1.

         Incremental -subdir=yes /fs/dir1/

Task
         Assuming that you initiated a snapshot of the /usr file system
         and mounted the snapshot as /snapshot/day1, run an incremental
         backup of all files and directories under the local snapshot
         and manage them on the IBM Spectrum Protect server under the
         file space name /usr.

         dsmc inc /usr -snapshotroot=/snapshot/day1

Task
         Run an incremental backup for the /home file system by using
         the snapdiff option and specify the option to create the
         difference snapshot. In the following example, /home is the NFS
         mount point for a NAS/N-Series file server volume.

         incremental /home -snapdiff -diffsnapshot=create


2.21.1 Journal-based backup


A backup for a particular file system is journal-based when the IBM
Spectrum Protect journal daemon is installed and configured to journal
the file system, and a valid journal has been established.

Journal-based backup is supported on the AIX Backup-Archive Client, on
JFS and JFS2 file systems.

Journal-based backup is supported on the Linux Backup-Archive client on
Ext2, Ext3, Ext4; XFS, ReiserFS, JFS, VxFS, and NSS. GPFS is not
supported for journal-based backups on Linux.

If the journal daemon is installed and running, then by default the
incremental command performs a journal-based backup on file systems
which are being monitored by the journal engine daemon. The following
conditions must be met in order to successfully perform a journal-based
backup:

*  The journal daemon must be set up to monitor the file system that
   contains the files and directories being backed up.

*  A full incremental backup must have been run successfully at least
   once on the file system being backed up.

*  The file space image of the file system at the server cannot have
   been modified by an administrative command since the last full
   incremental backup.

*  The storage management policy for the files being backed up cannot
   have been updated since the last full incremental backup.

The journal daemon records changes to an object or its attributes in a
journal database. During a journal-based backup, the client obtains a
list of files that are eligible for backup from the journal database.
Journal-based backup can increase backup performance because the client
does not scan the local file system or contact the server to determine
which files to process. Journal-based backup also reduces network
traffic between the client and server

The backup-archive client filters the list based on the current
include-exclude list and processes, expires, and updates the resulting
files according to policy constraints, such as serialization. However,
the client ignores the server frequency attribute during a journal-based
backup. The reason for this is because a journal-based backup eliminates
the backup version query to the server; therefore, the client does not
know how many days have transpired since the last backup of the file.

The journal daemon does not record changes in UNIX special files.

The journal daemon excludes specific system files from having changes
recorded in the journal. Because changes to these files are not
journaled, the client does not back up these files. See the journal
daemon configuration file tsmjbbd.ini located in the backup-archive
client installation directory for specific system files that are
excluded.

Note:

1. When using antivirus software, there are limitations to journal-based
   backup. Some antivirus software can incorrectly generate change
   notifications to the IBM Spectrum Protect journal service, causing
   files that have not changed to be incorrectly backed up during
   journal based backup. To avoid these problems, use Norton Anti-Virus
   Corporate Edition 8.0 and higher.

2. A journal-based backup might not fall back to the traditional
   incremental backup if the policy domain of your node is changed on
   the server. This depends on when the policy set within the domain was
   last updated and the date of the last incremental backup. In this
   case, you must force a full traditional incremental backup to rebind
   the files to the new domain. Use the nojournal option with the
   incremental command to specify that you want to perform a traditional
   full incremental backup, instead of the default journal-based backup.

   Add an exclude snapshot statement to the tsmjbbd.ini file for AIX 6.1
   (or later) to prevent JFS2 internal snapshot directories from being
   monitored by the journal-based backup daemon. If you do not exclude
   the snapshot directories, the files in them are backed up. Backing up
   the snapshot directories is redundant and wastes server space.

Under the following conditions, the journal database is considered
invalid and the client reverts to the traditional full incremental
backup:

*  A journaled file space name has changed.
*  The client node name has changed.
*  The client contacts a different server to do the backup.
*  Policy changes have occurred (new policy set activation).
*  The journal is corrupt (out of space conditions, disk error).
*  The journal is not running.

Journal-based backup differs from the traditional full incremental
backup in the following ways:

*  IBM Spectrum Protect does not enforce non-default copy frequencies
   (other than 0).
*  Changes to UNIX special files are not detected.

You can use the nojournal option with the incremental command to perform
a traditional full incremental backup instead of the default
journal-based backup.


2.21.2 Incremental-by-Date


An incremental-by-date backup backs up new and changed files with a
modification date later than the date of the last incremental backup
stored at the server, unless the files are excluded from backup by an
exclude statement.

If an incremental-by-date is performed on only part of a file system,
the date of the last full incremental is not updated, and the next
incremental-by-date will back up these files again. Changes to the
access control lists (ACL) or Extended Attributes do not cause the files
to be backed up during an incremental-by-date. Use the query filespace
command to determine the date and time of the last incremental backup of
the entire file system.

To perform an incremental-by-date backup, use the incrbydate option with
the incremental command.

Unlike a full incremental, an incremental-by-date does not maintain
current server storage of all your workstation files for the following
reasons:

*  It does not expire backup versions of files that are deleted from the
   workstation.

*  It does not rebind backup versions to a new management class if the
   management class has changed.

*  It does not back up files with attributes that have changed, unless
   the modification dates and times have also changed.

*  It ignores the copy group frequency attribute of management classes.

For these reasons, if you have limited time during the week to perform
backups, but extra time on the weekends, you can perform an
incremental-by-date backup on weekdays and a full incremental backup on
weekends to maintain current server storage of your workstation files.

If the incremental command is retried because of a communication failure
or session loss, the transfer statistics will display the number of
bytes that the client attempted to transfer during all command attempts.
Therefore, the statistics for bytes transferred might not match the file
statistics, such as those for file size.


2.21.3 Associate a local snapshot with a server file space


Use the snapshotroot option with the incremental command in conjunction
with a vendor-supplied application that provides a snapshot of a logical
volume, to associate the data on the local snapshot with the real file
space data that is stored on the IBM Spectrum Protect server.

The snapshotroot option does not provide any facilities to take a volume
snapshot, only to manage data created by a volume snapshot.


2.22 Loop


The loop command starts an interactive command line session that is
maintained until you enter quit.

If you are required to enter a password, you are prompted for it before
the loop mode prompt appears.

Note: It is not possible to enter loop mode without a valid server
contact. One of the consequences is that certain commands, such as
restore backupset -location=file, are only accepted on the initial
command line when a valid server is not available.



In an interactive command line session, it is unnecessary to precede
each command name with dsmc and your password, if one is required.

In interactive mode, options that you enter on the initial command line
override the value that you specified in your client user-options file
(dsm.opt) or dsm.sys file. This value remains in effect for the entire
interactive session unless overridden by a different value on a given
interactive command. For example, if you set the subdir option to yes in
your client user-options file (dsm.opt), and you specify subdir=no on
the initial command line, the subdir=no setting remains in effect for
the entire interactive session unless overridden by the subdir=yes value
on a given interactive command. However, the subdir=yes value only
affects the command it is entered on. When that command completes, the
value reverts back to subdir=no, the value at the beginning of the
interactive session.

You can enter all valid commands in interactive mode except the schedule
and loop commands.

There are some options that you cannot use in the interactive session
created by the loop command and are identified in the option description
by this statement: This option is valid only on the initial command
line. It is not valid in interactive mode.

See individual client option topics to determine whether they can be
used in interactive mode.

Note:

1. In loop mode, following a restore operation directly from tape, the
   mount point is not released in case additional restore requests are
   made to that volume. If you request a backup operation in the same
   session and that mount point is the only one available, the backup
   operation stops with the following message:

     Waiting for mount of offline media

   In this case, the mount point is not released until one of the
   following conditions is met:

   *  The device class MOUNTRETENTION limit is satisfied.

   *  The client idletimeout period is satisfied.

   *  The dsmc loop session is closed after the restore operation
      completes, allowing you to start a subsequent loop mode session to
      perform the backup operation.

2. In interactive mode, you cannot enter a file specification that
   contains national language characters. If a command contains national
   characters, process the command in batch mode by preceding the
   command with the executable program name, dsmc.

Supported Clients

This command is valid for all clients.

Syntax

>>-LOOP--------------------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Start an interactive command line session.

         Command: dsmc



         At the Protect> prompt, enter a command.



         There are two methods for ending an interactive session:



         *  Enter quit

         *  If you set editor=yes, you can do the following:

            1. Press the Escape key (Esc).

            2. Type Q and press the Enter key.



            Note: The default setting is editor=yes.



         Note: To interrupt a dsmc command before the client has
         finished processing, enter QQ on the IBM Spectrum Protect
         console. In many cases, but not all, this interrupts the
         command.




2.23 Macro


The macro command runs a series of commands that you specify in a macro
file.

By including the macro command within a macro file, you can nest as many
as 10 levels of commands.

Comment lines are not supported within the macro file that you specify
for the macro command.

Supported Clients

This command is valid for all clients.

Syntax

>>-MAcro-- --macroname----------------------------------------><



Parameters

macroname
         Specifies the fully qualified name of the file that contains
         the commands.

Examples

The following is an example of how to use the macro command.

Task
         Selectively back up files in the following directories:

         *  /devel/project/proja

         *  /devel/project/projb

         *  /devel/project/projc



         Command: macro backabc.mac



         Where backabc.mac contains the following statements:

          Selective /devel/project/proja/
          Selective /devel/project/projb/
          Selective /devel/project/projc/




2.24 Monitor Process


The monitor process command displays a list of current NAS (if NDMP
support is enabled) image backup and restore processes for which the
administrative user has authority. You are prompted for the IBM Spectrum
Protect administrator ID.

The administrative user can then select one process to monitor. Client
owner privilege is sufficient authority to monitor the selected NAS
image backup or restore processes.

Supported Clients

This command is valid for AIX, Linux, and Solaris clients only.

Syntax

>>-MONitor Process---------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Monitor current NAS image backup or restore processes.

         Command: monitor process


2.25 Preview Archive


The preview archive command simulates an archive command without sending
data to the server.

The preview archive command generates a tab-delineated text file that
can be imported into a spreadsheet program. The preview contains
information such as whether the file is excluded or included. If the
file is excluded, the pattern, or reason, that the file is excluded is
listed, along with the source for the pattern.

Supported Clients

This command is valid for all clients.

Syntax

                               .- -filter=ALL--.
>>-PREview--Archive--filespec--+- -filter=INCL-+---------------->
                               '- -filter=EXCL-'

>--+----------------------+--+-----------+---------------------->
   '- -FILEName= filename-'  '- -CONsole-'

   .- -TRAverse=Yes-.
>--+----------------+------------------------------------------><
   '- -TRAverse=No--'



Parameters

filespec
         Specifies the path and file name that you want to archive. Use
         wildcard characters to select a group of files or all the files
         in a directory.

-filter
         Specifies the output to display. You can display included
         objects, excluded objects, or both.

         ALL
                  Display output for included and excluded objects. This
                  is the default.

         INCLuded
                  Display output for included objects only.

         EXCLuded
                  Display output for excluded objects only.

-FILEName=
         Specifies the filename in which to write the tab-delineated
         output. The default is dsmprev.txt.

-CONsole
         Output is written to the console, and the file.

-TRAverse
         Preview the current directory and subdirectories.

         Yes
                  Preview the current directories and subdirectories.
                  This is the default.

         No
                  Preview only the current directory, not
                  subdirectories.



         Important: Specifying -traverse does not preview directories
         excluded using the exclude.dir option.


2.26 Preview Backup


The preview backup command simulates a backup command without sending
data to the server.

The preview backup command generates a tab-delineated text file that can
be imported into a spreadsheet program. The preview contains information
such as whether the file is excluded or included. If the file is
excluded, the pattern, or reason, that the file is excluded is listed,
along with the source for the pattern.

Supported Clients

This command is valid for all clients.

Syntax

                              .- -filter=ALL--.
>>-PREview--backup--filespec--+- -filter=INCL-+----------------->
                              '- -filter=EXCL-'

>--+----------------------+--+-----------+---------------------->
   '- -FILEName= filename-'  '- -CONsole-'

   .- -TRAverse=Yes-.
>--+----------------+------------------------------------------><
   '- -TRAverse=No--'



Parameters

filespec
         Specifies the path and file name that you want to back up. Use
         wildcard characters to select a group of files or all the files
         in a directory.

-filter
         Specifies the output to display. You can display included
         objects, excluded objects, or both.

         ALL
                  Display output for included and excluded objects. This
                  is the default.

         INCLuded
                  Display output for included objects only.

         EXCLuded
                  Display output for excluded objects only.

-FILEName=
         Specifies the filename in which to write the tab-delineated
         output. The default is dsmprev.txt.

-CONsole
         Output is written to the console, and the file.

-TRAverse
         Preview the current directory and subdirectories.

         Yes
                  Preview the current directories and subdirectories.
                  This is the default.

         No
                  Preview only the current directory, not
                  subdirectories.



         Important: Specifying -traverse does not preview directories
         excluded using the exclude.dir option.


2.27 Query Access


The query access command shows who was given access to backup versions
or archive copies of specific files.

The backup-archive client displays a list of authorization rules that
you defined with the set access command or with the Utilities -> Node
Access List menu in the backup-archive client graphical user interface
(GUI).

The following information is included.

*  Authority that you gave a user to restore backup versions or retrieve
   archive copies.
*  The node name of the user to whom you gave authorization.
*  The ID of the user at that node to whom you gave authorization.
*  The files to which the user has access.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query ACcess------------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Display a list of users who have access to your files.

         Command: query access


2.28 Query Archive


The query archive command displays a list of your archived files and the
following information about each file: file size, archive date, file
specification, expiration date, and archive description.

If you use the detail option with the query archive command, the client
displays the following additional information:

*  Last modification date
*  Last access date
*  Last file attributes (inode) change date
*  Compression type
*  Encryption type
*  Client-side data deduplication
*  Retention initiation
*  Whether the file is on hold
*  Size of ACL metadata (IBM Spectrum Scale), for AIX and Linux clients
*  Server storage information (media class, volume ID, and restore
   order), for AIX and Linux clients

The following example shows sample output when the query archive command
is issued with the detail option:.

Size Archive Date - Time File - Expires on - Description
---- ------------------- -------------------------------
219 B 08/15/2016 09:32:13 /Volumes/Data/info.txt 08/16/2016
Archive Date: 08/16/2016
RetInit:STARTED Obj
Held:NO
Modified: 03/02/2016 19:43:00 Accessed: 03/03/2016 09:31:23 Inode changed: 03/02/2016 19:43:00
Compression Type: LZ4 Encryption Type: None Client-deduplicated: YES
ACL Size: 0  Media Class: Fixed  Volume ID: 0008  Restore Order: 00000000-0000001F-00000000-00600774

For more information about the compression type, see 3.4.22 Compression.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query ARchive--+-------------+--+- --filespec---+----------><
                  '- --options-'  '- --"filespec"-'



Parameters

filespec
         Specifies the path and file name that you want to query. Use
         wildcard characters to specify a group of files or all the
         files in a directory. If you use wildcard characters, enclose
         the file specification in double quotation marks. Specify an
         asterisk (*) to query all archived files in the current
         directory.

Table 15. Query Archive command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| detail             | Command line only.                             |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromdate           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromtime           | Command line only.                             |
+--------------------+------------------------------------------------+
| numberformat       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| querysummary       | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| subdir             | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| todate             | Command line only.                             |
+--------------------+------------------------------------------------+
| totime             | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Display a list of all your archived files in the current
         working directory.

         Command: q archive "*"

Task
         Display a list of all your archived files in the /devel
         directory and all of its subdirectories.

         Command: query archive "/devel/*" -subdir=yes

Task
         Display a list of all your archived files in the current
         directory. Use the dateformat and timeformat options to
         reformat the dates and times.

         Command: q ar –date=5 –time=1 "*"

Task
         Display a list of all your archived files in the current
         directory. Use the detail option to display the last
         modification date and the last access date of each file.

         Command: q ar -detail "*"

Task
         Display a list of archived files in the /home/proj directory
         whose first four characters of the file name begin with proj.

         Command: q ar "/home/proj/proj*"


2.29 Query Backup


The query backup command displays a list of backup versions of your
files that are stored on the IBM Spectrum Protect server, or that are
inside a backup set from the server when the backupsetname option is
specified.

The command displays the following file information:

*  File specification

*  File size

*  Backup date

*  Whether the file is active or inactive

*  The management class that is assigned to the file. Only the first 10
   characters of the management class name are displayed.

If you use the detail option with the query backup command, the client
displays the following extra information:

*  Last modification date

*  Last access date

*  Last file attributes (inode) change date

*  Compression type

*  Encryption type

*  Client-side data deduplication

*  Whether the file is migrated or premigrated. A value of Yes means
   that the file is migrated or premigrated. A value of No means that
   the file is not migrated or premigrated.

*  File inode number (for AIX and Linux clients)

*  Size of ACL metadata (IBM Spectrum Scale) (for AIX and Linux clients)

*  Server storage information (media class, volume ID, and restore
   order) (for AIX and Linux clients)

The following example shows sample output when the query backup command
is issued with the detail option:

      Size        Backup Date                Mgmt Class           A/I File
      ----        -----------                ----------           --- ----
1,500,000  B  08/15/2016 16:01:25             DEFAULT              A  /home/test/mydir/myfile1.txt
    Modified: 08/15/2016 16:00:10 Accessed: 08/16/2016 15:31:23 Inode changed: 08/15/2016 16:00:10
Compression Type: LZ4  Encryption Type: None  Client-deduplicated: YES  Migrated: NO  Inode#: 22691
ACL Size: 0  Media Class: Fixed  Volume ID: 0008 Restore Order: 00000000-0000001F-00000000-00600774


For more information about the compression type, see 3.4.22 Compression.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query Backup--+-------------+--+- --filespec---+-----------><
                 '- --options-'  '- --"filespec"-'



Parameters

filespec
         Specifies the path and file name that you want to query. Use
         wildcard characters to specify a group of files or all the
         files in a directory. If you use wildcard characters, enclose
         the file specification in double quotation marks. Specify an
         asterisk (*) to display information about backup versions for
         all of your files in the current directory. Do not use
         wildcards characters when you query NAS file system images with
         -class=nas option setting.

Table 16. Query Backup command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| backupsetname      | Command line only.                             |
+--------------------+------------------------------------------------+
| class              | Command line only.                             |
+--------------------+------------------------------------------------+
| dateformat         | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| detail             | Command line only.                             |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromdate           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromtime           | Command line only.                             |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| nasnodename        | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| numberformat       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| querysummary       | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| subdir             | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| todate             | Command line only.                             |
+--------------------+------------------------------------------------+
| totime             | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Display a list of all active and inactive backup versions of
         your files in the current directory.

         dsmc query backup –inactive "*"

Task
         Display a list of all your backups in the current directory.
         Use the detail option to display the last modification date and
         the last access date of each file.

         dsmc q backup -detail "*"

Task
         Display a list of files that were backed up from the /home/proj
         directory with file names that begin with proj.

         dsmc q b "/home/proj/proj*"

Task
         Display a list of active and inactive backup file versions in
         the /home file system.

         dsmc q b –ina –su=yes /home/

Task
         Query file system images from the nas2 NAS file server.

         dsmc query backup -nasnodename=nas2 -class=nas


2.29.1 Query NAS file system images


You can use the query backup command to display information about file
system images backed up for a NAS file server. The client prompts you
for an administrator ID.

Where supported, use the nasnodename option to identify the NAS file
server to query. Place the nasnodename option in your client
system-options file (dsm.sys). The value in the client system-options
file is the default, but this value can be overridden on the command
line.

Use the class option to specify the class of the file space to query. To
display a list of images belonging to a NAS node, use the -class=nas
option.


2.30 Query Backupset


The query backupset command queries a backup set from a local file, tape
device (if applicable), or the IBM Spectrum Protect server.

This command displays the backup set name, generation date, retention
(for a backup set on the IBM Spectrum Protect server), and user-supplied
description.

Supported Clients

This command is valid for all clients.

Tape support is only available on AIX and Oracle Solaris clients.

Syntax

>>-Query BACKUPSET--+---------+--BACKUPSETName=----------------->
                    '-options-'

>--+-backupsetname-+--+-----------------------+----------------><
   +-localfilename-+  '-LOCation=--+-server-+-'
   '-tapedevice----'               +-file---+
                                   '-tape---'



Parameters

BACKUPSETName=
         Specifies the name of a backup set you want to query. You can
         use wildcards to specify the backup set name. If you use
         wildcards or do not specify a backup set name, all backup sets
         that you own are displayed. This parameter is required.

         When a backup set is created, the server assigns root as the
         owner of the backup set. When querying a backup set on the
         server, a non-root user does not see the backup set listed,
         even if they know the backup set name and use it in the query.

         The value of backupsetname depends on the location of the
         backup set, and corresponds to one of these three choices:

         backupsetname
                  Specifies the name of the backup set from the server.
                  If the location parameter is specified, you must set
                  -location=server.

         localfilename
                  Specifies the file name of the first backup set
                  volume. You must set -location=file.

         tapedevice
                  Specifies the name of the tape device that contains
                  the backup set volume. You must use a Windows native
                  device driver, not the device driver that is provided
                  by IBM(R). You must set -location=tape.

LOCation=
         Specifies where the backup-archive client searches for the
         backup set. If you do not specify the location parameter, the
         client searches for backup sets on the IBM Spectrum Protect
         server.

         server
                  Specifies that the client searches for the backup set
                  from the server. This location is the default.

         file
                  Specifies that the client searches for the backup set
                  from a local file.

         tape
                  Specifies that the client searches for the backup set
                  from a local tape device.

Table 17. Query Backupset command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Query all backup sets from the IBM Spectrum Protect server.

         Command: query backupset -backupsetname=*

Task
         Query a backup set that is called monthy_financial_data from
         the IBM Spectrum Protect server.

         Command: query backupset
         -backupsetname=monthly_financial_data.12345678

Task
         Query the backup set in the file
         /home/budget/weekly_budget_data.ost.

         Command: dsmc query backupset
         -backupsetname="/home/budget/weekly_budget_data.ost" -loc=file

Task
         Query the backup set from the /dev/rmt0 tape device.

         Command: dsmc query backupset -backupsetname=/dev/rmt0
         -loc=tape


2.30.1 Query Backupset without the backupsetname parameter


The query backupset command can be used without the backupsetname
parameter.





The preferred syntax for query backupset command requires the
backupsetname parameter. Prior to the introduction of the backupsetname
parameter, the backup-archive client queried backup sets with a
different syntax.

While you can use syntax from previous releases for this command, do not
do so unless you have a specific need and cannot replace the old syntax
with the syntax in Tivoli Storage Manager 6.1. For best results, use the
backupsetname parameter.

Supported Clients

This command is valid for all clients.

Tape support is only available on AIX and Oracle Solaris clients.

Syntax

>>-Query BACKUPSET--+---------+--+-backupsetname-+-------------->
                    '-options-'  +-localfilename-+
                                 '-tapedevice----'

>--+-----------------------+-----------------------------------><
   '-LOCation=--+-server-+-'
                +-file---+
                '-tape---'



Parameters

backupsetname
         Specifies the name of the backup set from the IBM Spectrum
         Protect server. If the location parameter is specified, you
         must set -location=server.

localfilename
         Specifies the file name of the first backup set volume. You
         must set -location=file.

tapedevice
         Specifies the name of the tape device containing the backup set
         volume. You must use a Windows native device driver, not the
         device driver provided by IBM. You must set -location=tape.

LOCation=
         Specifies where the client searches for the backup set. If you
         do not specify the location parameter, the client searches for
         backup sets on the IBM Spectrum Protect server.

         server
                  Specifies that the client searches for the backup set
                  from the server. This is the default.

         file
                  Specifies that the client searches for the backup set
                  from a local file.

         tape
                  Specifies that the client searches for the backup set
                  from a local tape device.

Table 18. Query Backupset command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Query all backup sets from the IBM Spectrum Protect server.

         Command: query backupset

Task
         Query a backup set called monthy_financial_data from the IBM
         Spectrum Protect server.

         Command: query backupset monthly_financial_data.12345678

Task
         Query the backup set in the file
         /home/budget/weekly_budget_data.ost.

         Command: dsmc query backupset
         /home/budget/weekly_budget_data.ost -loc=file

Task
         Query the backup set from the /dev/rmt0 tape device.

         Command: dsmc query backupset /dev/rmt0 -loc=tape


2.31 Query Filespace


The query filespace command displays a list of file spaces for a node.
The file spaces are stored on the IBM Spectrum Protect server, or inside
a backup set from the server when the backupsetname option is specified.
You can also specify a single file space name to query.

A file space is a logical space on the server that contains files you
backed up or archived. A separate file space is assigned on the server
for each node at your workstation from which you back up or archive
files.

A separate file space is assigned on the server for each file system at
your workstation from which you back up or archive files. The file space
name is the same as the file system name.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query Filespace--+-------------------+--+-------------+-----><
                    '- --filespacename-'  '- --options-'



Parameters

filespacename
         Specifies an optional character string that can include
         wildcards. Use this argument to specify a subset of file
         spaces. The default is to display all file spaces.

Table 19. Query Filespace command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| backupsetname      | Command line only.                             |
+--------------------+------------------------------------------------+
| class              | Command line only.                             |
+--------------------+------------------------------------------------+
| dateformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| detail             | Command line only.                             |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| nasnodename        | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| scrolllines        | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client user-options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Display your file spaces. Use the dateformat and timeformat options to
reformat the dates and times.

query filespace -date=5 -time=4

Display the /home file space.

query filespace /home

Display file space names that include the pattern smith.

query filespace "*smith*"

Query a file space from the nas2 NAS file server.

query filespace -nasnodename=nas2 -class=nas

Display detailed file space information that shows the replication
status during a failover.

Command:
         query filespace -detail

Output:
         #   Last Incr Date       Type   fsID  Unicode  Replication  File Space Name
         ---  --------------       ------ ----  -------  -----------  --------------
           1  00/00/0000 00:00:00  HFS       3  Yes      Current      /

                 Last Store Date     Server                  Local
                 ---------------     ------                  -----
                    Backup Data :    04/29/2013 16:49:55     04/29/2013 16:49:55
                   Archive Data :    No Date Available       No Date Available



2.31.1 Query NAS file spaces


Use the nasnodename option to identify the NAS file server to query.
When using an interactive command-line session with a non-administrative
ID, the client prompts you for an administrator ID.

Place the nasnodename option in your client system-options file
(dsm.sys). The value in the client system-options file is the default,
but this value can be overridden on the command line. If the nasnodename
option is not specified in the client system-options file, it must be
specified on the command line when processing NAS file systems.

Use the class option to specify the class of the object to query. To
display a list of file spaces belonging to a NAS node, use the
-class=nas option.


2.32 Query Group


Use the query group command to display information about a group backup
and its members.

Note:

1. Use the showmembers option to display and select individual group
   members that you want to query. The showmembers option is not valid
   with the inactive option. If you want to display members of a group
   that are not currently active, use the pitdate and pittime options to
   specify the backup date and time of the member you want to query.

2. Use the query filespace command to display virtual file space names
   for your node that are stored on the IBM Spectrum Protect server.

3. If you perform a full and differential group backup, a query of this
   group using the -inactive option displays two active backups of the
   same name, one of type FULL and one of type DIFF.

   Protect> q group {/fs}/v1 -inactive

   Size Backup Date          Mgmt Class A/I Group
   ---- -----------          ---------- --- ------
    978 B 06/02/2007 11:57:04  DEFAULT   A  FULL /fs/v1
     32 B 06/05/2007 13:52:04  DEFAULT   A  DIFF /fs/v1


   If you query a group backup without the -inactive option, the query
   displays only the latest group backup, whether it is type FULL or
   type DIFF:



   Protect> q group {/fs}/v1

   Size Backup Date          Mgmt Class A/I Group
   ---- -----------          ---------- --- ------
     32 B 06/05/2007 13:52:04  DEFAULT   A  DIFF /fs/v1


Supported Clients

This command is valid for all clients, except for Mac OS X.

Syntax

>>-Query GRoup-- --filespec--+-------------+------------------><
                              '- --options-'



Parameters

filespec
         Specifies the virtual file space name and the group name on the
         server that you want to query.

Table 20. Query Group command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| showmembers (does  | Command line only.                             |
| not apply to Mac   |                                                |
| OS X)              |                                                |
+--------------------+------------------------------------------------+

Examples

Task
         Display all the groups in the /virtfs file space.

         Command:

         query group /virtfs/*

Task
         Display active and inactive versions of the /virtfs/group1 file
         space.

         Command:

         query group /virtfs/group1 -inactive

Task
         Display the /virtfs/group1 file space. Use the showmembers
         option to display a list of group members from which you can
         select one or more to query.

         Command:

         query group /virtfs/group1 -showmembers


2.33 Query Image


The query image command displays information about file system images
that are stored on the IBM Spectrum Protect server, or that are inside a
backup set from the IBM Spectrum Protect server, when the backupsetname
option is specified.

The following information about file system images is displayed:

*  Image Size - The volume size which was backed up.

*  Stored Size - The actual image size that is stored on the server. The
   stored image on the IBM Spectrum Protect server is the same size as
   the volume capacity. For online snapshot-based image backups, the
   stored image can be larger than the file system based on the size of
   the cache files. The stored image on the server is the same size as
   the volume capacity.

*  File system type

*  Backup date and time

*  Management class that is assigned to image backup

*  Whether the image backup is an active or inactive copy

*  The image name

Note: The IBM Spectrum Protect API must be installed to use the query
image command.

Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Syntax

>>-Query IMage--+-------------+--+- --logicalvolumename-+-----><
                '- --options-'  '- --filespacename-----'



Parameters

logicalvolumename
         The name of a logical volume you want to query. You must
         specify the exact name of the image. You cannot use wildcards.
         The default is all active images (unless restricted by one or
         more options).

filespacename
         Specifies the file system name that you want to query.

         Omitting logicalvolumename and filespacename causes all images
         to be displayed.

Table 21. Query Image command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| backupsetname      | Command line only.                             |
+--------------------+------------------------------------------------+
| dateformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| numberformat       | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Display all backed up images.

         Command: q image

Task
         Display all backed up images that are owned by kutras at node
         avalon .

         Command: query image -fromnode=avalon -fromowner=kutras

Task
         Display active and inactive version of the /usr image.

         Command: q i /usr -inactive

Task
         Display all images that are contained within the backup set
         weekly_backup_data.32145678.

         Command: query image -backupsetname=weekly_backup_data.32145678


2.34 Query Inclexcl


The query inclexcl command displays a list of include-exclude statements
in the order in which they are processed during backup and archive
operations. The list displays the type of option, the scope of the
option (archive, all, and so on), and the name of the source file.

The backup-archive client excludes some files from file system backup
and restore operations. You can use the query inclexcl command to
display a list of these files. In the output of the command, these files
have Operating System next to the path.

You can test the validity of patterns you want to use in your
include-exclude list before you actually insert them in your options
file. See the test pattern explanation.

Use the detail option to display the management class that is associated
with an include-exclude statement.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query INCLexcl-- --+--------------+--+----------+----------><
                       '-test pattern-'  '- -DETail-'



Parameters

test pattern
         Use for testing the validity of patterns you want to use in
         your include-exclude list. When you use a test pattern with
         this command, the following occurs:

         *  The internal include-exclude list is not displayed

         *  The pattern is processed as if it came from an
            include-exclude statement, including all the usual error
            checking

         *  The pattern is displayed as it would appear in the
            include-exclude list

         If the test pattern has no errors, the compiled pattern result
         is the same as the test pattern.

-DETail
         Displays the management class that is associated with the
         include-exclude statement.

Examples

Task
         Exclude a file from deduplication by excluding it in the client
         options file:

         Exclude Dedup *\...\file2

Task
         Display a basic list of include-exclude statements. Command:

         query inclexcl

Task
         Display a list of include-exclude statements. Display the
         management class that is associated with each statement.

         query inclexcl -detail

Task
         Test the validity of this pattern: /.../?x?/*.log

         query inclexcl /.../?x?/*.log


2.35 Query Mgmtclass


The query mgmtclass command displays information about the management
classes available in your active policy set.

Your administrator defines management classes that contain attributes
which control whether a file is eligible for backup or archive services.
Management classes also determine how backups and archives are managed
on the server.

Your active policy set contains a default management class; it can
contain any number of extra management classes. You can assign specific
management classes to files using include options that are located in
the client user-options file (dsm.opt). If you do not assign a
management class to a file, the default management class is used.

When you archive files, you can override the assigned management class
by using the archmc option.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query Mgmtclass--+-------------+----------------------------><
                    '- --options-'



Parameters

Table 22. Query Mgmtclass command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| detail             | Command line only.                             |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Display default and available management classes.

         Command: query mgmtclass


2.36 Query Node


The query node command displays all the nodes for which an
administrative user ID has authority to perform operations. You are
prompted for the IBM Spectrum Protect administrator ID.

Ideally, the administrative user ID has at least client owner authority
over the client workstation node they are using either from the command
line or from the web.

Use the type option to specify the type of node to filter for. The
following are the valid values:

*  nas
*  client
*  server
*  any

The default is any.

Note: When the IBM Spectrum Protect for Virtual Environments: Data
Protection for VMware license file is installed on a vStorage backup
server, the platform string that is stored on the IBM Spectrum Protect
server is set to "TDP VMware" for every nodename that is used on that
machine. The platform string can be used in the context of PVU
calculations. If a nodename is being used to back up the machine with
standard Backup-Archive client functions (for example, file-level or
image backup), then this platform string would be interpreted as a
"client" for the purposes of PVU calculations.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query Node--+-------------+---------------------------------><
               '- --options-'



Parameters

Table 23. Query Node command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| type               | Command line only.                             |
+--------------------+------------------------------------------------+
| scrolllines        | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Display all NAS nodes.

         Command: query node -type=nas

Task
         Display all client nodes that are backup-archive clients.

         Command: query node -type=client


2.37 Query Options


Use the query options command to display all or part of your options and
their current settings that are relevant to the command-line client.



Supported Clients

This command is valid for all clients.

Syntax

>>-Query Options--+-------------+---- --pattern---------------><
                  '- --options-'



Parameters

pattern
         An optional character string that can include wildcards. Use
         this argument to specify a subset of options. The default is to
         display all options.

Table 24. Query Options command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| scrolllines        | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| scrollprompt       | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Display all options and their values.

         query options



Task
         Display only options that begin with comm.

         query options comm*

Task
         Display the value of the replace option.

         query options replace

Task
         Issue the command to display all options and their values. The
         failover status information is displayed.

         query options

         Output:

         MYPRIMARYSERVERNAME: SERVER1
         MYREPLICATIONSERVER: TARGET
              REPLSERVERNAME: TARGET
                     Address: 192.0.2.9
                        Port: 1501
                     SSLPort: 1502
                        GUID: 39.5a.da.d1.ae.92.11.e2.82.d3.00.0c.29.2f.07.d3
                        Used: yes


2.38 Query Restore


The query restore command displays a list of your restartable restore
sessions in the server database. The list contains these fields: owner,
replace, subdir, preservepath, source, and destination.

A restartable restore session is created when a wildcard restore command
fails because of network outage, client failure, server outage, or a
similar problem. When such a failure occurs, the file space is locked on
the server and its files cannot be moved off the sequential volumes of
the server. To unlock the file space, either restart the restore and
allow it to complete (query restore command), or cancel the restore
(cancel restore command). Use query restore to determine if you have any
restartable restore sessions and which file spaces are affected.

Supported Clients

This command is valid for all clients.

Syntax

>>-Query Restore----------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Display your restartable restore session in the server
         database.

         Command: query restore


2.39 Query Schedule


The query schedule command displays the events that are scheduled for
your node. Your administrator can set up schedules to perform automatic
backups and archives for you. To plan your work, use this command to
determine when the next scheduled events occur.



Supported Clients

This command is valid for all clients.

Syntax

>>-Query SChedule----------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Display your scheduled events.

         Command: query schedule


2.40 Query Session


The query session command displays information about your session,
including the current node name, when the session was established,
server information, and server connection information.



Supported Clients

This command is valid for all clients.

Syntax

>>-Query SEssion-----------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Display your session information.

         Command: query session



         A sample query session display follows:



         Server Name.............: HALLEY_SERVER1
         Server Type.............: Windows
         Archive Retain Protect..: "No"
         Server Version..........: Ver. 6, Rel. 2, Lev. 0.0
         Last Access Date........: 09/03/2009 09:08:13
         Delete Backup Files.....: "No"
         Delete Archive Files....: "Yes"
         Deduplication...........: "Server Only"

         Node Name...............: HALLEY
         User Name...............:

         Possible client-side deduplication values:

         *  None

            *  Displayed when connected to an IBM Spectrum Protect
               server earlier than version 6.1.
         *  Server Only
         *  Client Or Server

Task
         A sample query session display with LAN-free enabled follows:

         IBM Spectrum Protect Server Connection Information

         Server Name.............: TEMPLAR
         Server Type.............: AIX
         Archive Retain Protect..: "No"
         Server Version..........: Ver. 6, Rel. 1, Lev. 4.0
         Last Access Date........: 08/12/10   22:10:15
         Delete Backup Files.....: "No"
         Delete Archive Files....: "Yes"

         Node Name...............: LAN2
         User Name...............: root

         Storage Agent Name......: TEMPLAR_STA
         Storage Agent Type......: AIX
         Storage Agent Version...: Ver. 6, Rel. 1, Lev. 3.3


2.41 Query Systeminfo


Use the query systeminfo command to gather information and output this
information to a file or the console.

This command is intended primarily as an aid for IBM support to help
diagnosing problems. However, users who are familiar with the concepts
addressed by this information might also find it useful.

If you use the console option, no special formatting of the output is
performed to accommodate screen height or width. Therefore, the console
output can be difficult to read due to length and line-wrapping. If the
console output is difficult to read, use the filename option with the
query systeminfo command. This combination allows the output to be
written to a file that can be submitted to IBM support.

Supported Clients

This command is valid for all clients.

Syntax

                     .--------------.
                     V              |
>>-Query SYSTEMInfo------ --item---+--+-------------+---------><
                                       '- --options-'



Parameters

item
         Specifies one or more items from which you want to gather
         information and output the information to the file name that
         you specify with the filename option or to the console. The
         default is to gather all items.

You can gather information on one or more of the following items:

*  DB2UDB -DATABase=dbconfigname - Verifies that the Configuration
   Wizard successfully transferred the DB2(R) UDB, backup-archive client,
   and storage subsystem settings to the master backup node. Replace
   dbconfigname with the DB2 UDB configuration name provided in the
   Configuration Wizard. This item is only valid for AIX when both the
   DB2 Integration Module and Hardware Devices Snapshot Integration
   Module are installed.

*  DSMOPTFILE - The contents of dsm.opt file.

*  DSMSYSFILE - The contents of the dsm.sys file.

*  ENV - Environment variables.

*  ERRORLOG - The client error log file.

*  FILE - Attributes for the file name that you specify.

*  INCLEXCL - Compiles a list of include-exclude in the order in which
   they are processed during backup and archive operations.

*  OPTIONS - Compiled options.

*  OSINFO - Name and version of the client operating system (includes
   ULIMIT information for UNIX).

*  POLICY - Policy set dump.

*  SCHEDLOG - The contents of the schedule log (usually dsmsched.log).

*  CLUSTER - AIX cluster information.

*  ENCRYPT - Available encryption methods.

Note:

1. Use the filename option to specify a file name in which to store the
   information that is gathered from the items you specify. If you do
   not specify a file name, by default the information is stored in the
   /Library/Application Support/tivoli/tsm/client/ba/bin/dsminfo.txt
   file (for Mac OS X) or the dsminfo.txt file (for other UNIX and
   Linux).

2. Use the console option if you want to output the information to the
   console.

Table 25. Query Systeminfo command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| console            | Command line only.                             |
+--------------------+------------------------------------------------+
| filename           | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Gather and store the contents of the dsm.opt file and the IBM
         Spectrum Protect error log file in the tsminfo.txt file.

         Command: query systeminfo dsmoptfile errorlog
         -filename=tsminfo.txt


2.42 Query VM


Use the query VM command to list and verify the successful backups of
virtual machines (VMs).



Query VM for VMware virtual machines

Use the query vm command to determine which VMware virtual machines were
backed up.

Supported Clients

This command is valid on Linux clients that are installed on a vStorage
backup server.

Syntax

>>-Query VM-- --vmname--+--------------------+--+---------+---><
                         |         .-BOTH---. |  '-options-'
                         '--FROM -+-SERVER-+-'
                                   '-LOCAL--'



Parameters

vmname
         Specifies the virtual machine host name that you want to query.
         If you omit the virtual machine name, the command displays all
         VM backups on the IBM Spectrum Protect server.

-FROM
         Specifies the backup location or locations to query. You can
         specify one of the following values:

         SERVER
                  The query is limited to backups that are on the IBM
                  Spectrum Protect server.

         LOCAL
                  The query is limited to persisted snapshots that are
                  on the hardware storage.

         BOTH
                  The query lists information for both backups that are
                  on the IBM Spectrum Protect server and snapshots that
                  are on the hardware storage. This value is the
                  default.

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

+---------------------------------------+-----------------------------+
| Option                                | Where to use                |
+---------------------------------------+-----------------------------+
| detail                                | Command line.               |
| Valid for vmbackuptype=fullvm         |                             |
+---------------------------------------+-----------------------------+
| inactive                              | Command line.               |
|                                       |                             |
| Valid for vmbackuptype=fullvm         |                             |
+---------------------------------------+-----------------------------+
| pitdate                               | Command line.               |
|                                       |                             |
| Valid for vmbackuptype=fullvm         |                             |
+---------------------------------------+-----------------------------+
| pittime                               | Command line.               |
|                                       |                             |
| Valid for vmbackuptype=fullvm         |                             |
+---------------------------------------+-----------------------------+
| vmbackuptype                          | Command line or client      |
|                                       | options file.               |
+---------------------------------------+-----------------------------+
| vmchost                               | Command line or client      |
|                                       | options file.               |
+---------------------------------------+-----------------------------+
| vmcpw                                 | Command line or client      |
|                                       | options file.               |
+---------------------------------------+-----------------------------+
| vmcuser                               | Command line or client      |
|                                       | options file.               |
+---------------------------------------+-----------------------------+

Query VM examples (VMware)

The following are examples of using the query VM command and the command
with the -detail option.

Full VM
         q vm devesx04-24 -ina
         Query Virtual Machine for Full VM backup

          #      Backup Date       Mgmt Class  Size         Type     A/I Location  Virtual Machine
         ---  -------------------  ----------  -----------  ------   --- --------  ---------------
           1  12/07/2016 14:45:24  DDMGMT         47.85 GB  IFFULL    I  SERVER    devesx04-24
           2  12/14/2016 17:38:05  DDMGMT         47.85 GB  IFINCR    A  SERVER    devesx04-24
           3  01/23/2017 14:07:44  DDMGMT         47.85 GB  SNAPSHOT  I  LOCAL     devesx04-24
           4  02/01/2017 08:59:52  DDMGMT         47.85 GB  SNAPSHOT  A  LOCAL     devesx04-24
         ANS1900I Return code is 0.


Query all VMware virtual machines that were backed up using
-vmbacktype=fullvm:

q vm * -vmbackuptype=fullvm


2.43 Restart Restore


The restart restore command displays a list of your restartable restore
sessions in the server database.

You can restart only one restartable restore session at a time. Run the
restart restore command again to restart further restores.

The restarted restore uses the same options that you used in the failed
restore. The restarted restore continues from the point at which the
restore previously failed.

To cancel restartable restore sessions, use the cancel restore command.
Use the restart restore command when:

*  Restartable restore sessions lock the file space at the server so
   that files cannot be moved off the sequential volumes of the server.

*  You cannot back up files that are affected by the restartable
   restore.

Options from the failed session supersede new or changed options for the
restarted session.

Supported Clients

This command is valid for all clients.

Syntax

>>-RESTArt Restore---------------------------------------------><



Parameters

There are no parameters for this command.

Examples

Task
         Restart a restore.

         Command: restart restore


2.44 Restore


The restore command obtains copies of backup versions of your files from
the IBM Spectrum Protect server, or inside a backup set.

To restore files, specify the directories or selected files, or select
the files from a list. Restore files to the directory from which you
backed them up or to a different directory. The backup-archive client
uses the preservepath option with the subtree value as the default for
restoring files.

Note:

1. On UNIX and Linux systems when a symbolic link is created its
   modification time is set to the current system time and cannot be
   changed. So, when restoring a symbolic link its modification date and
   time is set to the date and time of the restore, not to the date and
   time the link had when it was backed up. As a result, the client
   backs up the symbolic link during the next incremental backup because
   its modification time changed since the last backup.

If you set the subdir option to yes when you restore a specific path and
file, the client recursively restores all subdirectories under that
path, and any instances of the specified file that exist under any of
those subdirectories.

When you restore an entire directory or directory tree, and you do not
specify the inactive, latest, pick, todate, and fromdate options on the
restore command, the client tracks which objects are restored. If the
restore process is interrupted for any reason, you can restart the
restore at the point of interruption by entering the restart restore
command. It is possible to create more than one restartable restore
session. Restores are only restartable if the file specification is
fully wildcarded. For example, for a restore that is restartable, enter:

  dsmc rest /home/* -sub=yes

For a restore that is not restartable, enter:

  dsmc rest "/Users/user1/file?.c" -sub=yes

Use the query restore command to display a list of your restartable
restore sessions in the server database. Further backups of the file
system cannot be performed unless the restartable restore completes by
using the restart restore command or is canceled by using the cancel
restore command.

  dsmc rest "/Users/user1/file?.c" -sub=yes

Supported Clients

This command is valid for all clients.

Syntax

            .- --FILE-.
>>-REStore--+----------+--+-------------+----------------------->
                          '- --options-'

>--+- --sourcefilespec---+--+-------------------------+-------->
   '- --"sourcefilespec"-'  '- --destinationfilespec-'

>--+-----------------------------------+------------------------>
   '-BACKUPSETName=--+-backupsetname-+-'
                     +-localfilename-+
                     '-tapedevice----'

>--+-----------------------+-----------------------------------><
   '-LOCation=--+-server-+-'
                +-file---+
                '-tape---'



Parameters

file
         This parameter specifies that the source file specification is
         an explicit file name. This parameter is required when you
         restore a file name from the current path, when you do not
         specify a relative or absolute path, and when the file name
         conflicts with one of the reserved restore command keywords,
         such as restore backupset.

sourcefilespec
         Specifies the path and file name in storage that you want to
         restore. Use wildcard characters to specify a group of files or
         all the files in a directory.

{filespacename}
         Specifies the file space (enclosed in braces) on the server
         that contains the files you want to restore. This is the name
         on the workstation drive from which the files were backed up.

         Specify the file space name if the drive label name has changed
         or if you are restoring files that were backed up from another
         node that had drive labels that are different from yours.



destinationfilespec
         Specifies the path and file name where you want to place the
         restored files. If you do not specify a destination, the client
         restores the files to the original source path.

         *  If the sourcefilespec names a single file, the
            destinationfilespec can be a file or a directory. If you are
            restoring a single file, you can optionally end the
            specification with a file name if you want to give the
            restored file a new name.
         *  If the sourcefilespec is wildcarded or subdir=yes is
            specified, the destinationfilespec must be a directory and
            end with a directory delimiter (\).



         Note: If the destination path or any part of it does not exist,
         the client creates it.



         Note: If you do not specify a destination, the client
         determines whether the original file system can be reached. If
         the original file system cannot be reached, the client will not
         restore the file. In this case, you can specify a different
         destination and try the command again.

BACKUPSETName=
         Specifies the name of a backup set. This parameter is optional.
         If you specify the backupsetname parameter with the restore
         command, you cannot use the pick option.

         The value of backupsetname depends on the location of the
         backup set, and corresponds to one of the following options:

         backupsetname
                  Specifies the name of the backup set from the IBM
                  Spectrum Protect server. If the location parameter is
                  specified, you must set -location=server. If the
                  backup set resides in IBM Spectrum Protect server
                  storage, the backup set must have a TOC.

         localfilename
                  Specifies the file name of the first backup set
                  volume. You must set -location=file.

         tapedevice
                  Specifies the name of the tape device that contains
                  the backup set volume. You must use a Windows-provided
                  device driver, not the device driver that is provided
                  by IBM. You must set -location=tape.

LOCation=
         Specifies where the client searches for the backup set. If you
         do not specify the location parameter, the client searches for
         backup sets on the IBM Spectrum Protect server.

         server
                  Specifies that the client searches for the backup set
                  from the server. This is the default location.

         file
                  Specifies that the client searches for the backup set
                  from a local file.

         tape
                  Specifies that the client searches for the backup set
                  from a local tape device.

Table 27. Restore command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only.                             |
+--------------------+------------------------------------------------+
| followsymbolic     | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| fromdate           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| fromtime           | Command line only.                             |
+--------------------+------------------------------------------------+
| ifnewer            | Command line only.                             |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| latest             | Command line only.                             |
+--------------------+------------------------------------------------+
| numberformat       | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
| Note: If you       |                                                |
| specify the        |                                                |
| backupsetname      |                                                |
| parameter with the |                                                |
| restore command,   |                                                |
| you cannot use the |                                                |
| pick option.       |                                                |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| preservepath       | Command line only.                             |
+--------------------+------------------------------------------------+
| replace            | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| subdir             | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| tapeprompt         | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| timeformat         | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| todate             | Command line only.                             |
+--------------------+------------------------------------------------+
| totime             | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Restore a single file named budget in the
         /Users/user1/Documents directory.

         restore /home/devel/projecta/budget

Task
         Restore a single file named budget, which exists in the current
         directory.

         restore file budget

Task
         Restore all files with a file extension of .c from the
         /home/devel/projecta directory.

         restore "/home/devel/projecta/*.c"

Task
         Restore files in the /user/project directory. Use the pick and
         inactive options to select active and inactive backup versions.

         restore "/user/project/*" -pick -inactive

Task
         Restore all files from the /home/devel/projecta directory that
         end with the character .c to the
         /home/newdevel/projectn/projecta directory. If the projectn or
         the projectn/projecta directory does not exist, it is created.

         restore "/home/devel/projecta/*.c" /home/newdevel/projectn/

Task
         Restore all files in the /home/mydir directory to their state
         as of 1:00 PM on August 17, 2002.

         restore -pitd=8/17/2002 -pitt=13:00:00 /home/mydir/

Task
         Restore all objects in the /home/myid/ directory. Since this
         restore operation is fully wildcarded, if the restore process
         is interrupted, a restartable restore session is created.

         res "/home/myid/*"

Task
         Restore all files in the /home/mydir directory to their state
         as of 1:00 PM on August 17, 2002.

         restore -pitd=8/17/2002 -pitt=13:00:00 /home/mydir/


2.44.1 Restore from file spaces that are not Unicode-enabled


If you want to restore from file spaces that are not Unicode-enabled,
you must specify the source on the server and a destination on the
client, prior to installing the Unicode-enabled client.

Note: This Unicode section applies only to Mac OS X.

For example, assume that Jaguar is the name of your startup disk and you
back up all of the .log files in the /Users/user5/Documents directory.
Before the backup takes place, the server renames the file space to
Jaguar_OLD. The backup places the data specified in the current
operation into the Unicode-enabled file space named /. The new
Unicode-enabled file space now contains only the /Users/user5/Documents
directory and the *.log files specified in the operation.

If you want to restore a file from the renamed (old) file space to its
original location, you must enter both the source and destination as
follows:

   restore Jaguar_OLD/Users/user5/Documents
     /mylog.log /Users/user5/Documents/


2.45 Restore Backupset


The restore backupset command restores a backup set from the IBM
Spectrum Protect server, a local file, or a local tape device. You can
restore the entire backup set, or, in some cases, specific files within
the backup set.



Supported Clients

This command is valid for all clients.

Syntax

>>-REStore Backupset--+-------------------------------------+--->
                      '-+-----------------+--sourcefilespec-'
                        '-{filespacename}-'

>--+---------------------+--+---------+-- -BACKUPSETName=  --->
   '-destinationfilespec-'  '-options-'

>--+-backupsetname-+--+----------------------------+-----------><
   +-localfilename-+  '- -LOCation= --+-server-+-'
   '-tapedevice----'                    +-file---+
                                        '-tape---'



Parameters

{filespacename}
         Specifies the file space (enclosed in braces) on the server
         that contains the files you want to restore. This is the name
         on the workstation drive from which the files were backed up,
         or the virtual file space name for a group.

         Specify a file space name when you restore a backup set
         containing a group.

         Specify a file space name when the sourcefilespec does not
         exist on the target computer. This can occur if the drive label
         name has changed or if you are restoring files that were backed
         up from another node that had drive labels that are different
         from yours.



sourcefilespec
         Specifies the source path of a portion of the backup set. The
         default is to restore the entire backup set.

destinationfilespec
         Specifies the destination path for the restored files. If you
         do not specify a sourcefilespec, you cannot specify a
         destinationfilespec. If you do not specify a destination, the
         backup-archive client restores the files to the original source
         path. If you are restoring more than one file, you must end the
         file specification with a directory delimiter (/), otherwise,
         the client assumes that the last name is a file name and
         reports an error. If you are restoring a single file, you can
         optionally end the destination file specification with a file
         name if you want to give the restored file a new name. When the
         sourcefilespec does not exist on the target workstation, you
         must specify destinationfilespec.

-BACKUPSETName=
         Specifies the name of the backup set from which to perform a
         restore operation. You cannot use wildcard characters to
         specify the backup set name. The value of backupsetname depends
         on the location of the backup set, and corresponds to one of
         the following three choices:

         backupsetname
                  Specifies the name of the backup set on the server
                  from which to perform a restore operation. If location
                  option is specified, you must set -location=server.

         localfilename
                  Specifies the file name of the first backup set
                  volume. You must set -location=file.

         tapedevice
                  Specifies the name of the tape device containing the
                  backup set volume. You must use a Windows-provided
                  device driver, not the device driver that is provided
                  by IBM. You must set -location=tape.

-LOCation=
         Specifies the location of the backup set. If you do not specify
         the location parameter, the client searches for backup sets on
         the IBM Spectrum Protect server. If you specify the location
         parameter, the value must be one of the following three
         choices:

         server
                  Specifies that the backup set is on the IBM Spectrum
                  Protect server. Server is the default location.

         file
                  Specifies that the backup set is on an available file
                  system.

         tape
                  Specifies that the backup set is on an available tape
                  device.

Table 28. Restore Backupset command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only.                             |
+--------------------+------------------------------------------------+
| ifnewer            | Command line only.                             |
+--------------------+------------------------------------------------+
| preservepath       | Command line only.                             |
+--------------------+------------------------------------------------+
| quiet              | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| replace            | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| subdir             | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Restore the entire backup set called
         monthly_financial_data.87654321 from the server.

         dsmc restore backupset
           -backupsetname=monthly_financial_data.87654321
            -loc=server

Task
         Restore the entire backup set contained in the file:
         /home/budget/weekly_budget_data.ost.

         dsmc restore backupset
           -backupsetname="/home/budget/weekly_budget_data.ost"
            -loc=file

Task
         Restore the entire backup set from the /dev/rmt0 device.

         dsmc restore backupset
           "-backupsetname=/dev/rmt0" -loc=tape

Task
         Restore a single file named /home/jones/budget.dev from the
         /dev/rmt0 tape device, to the original source path.

         dsmc restore backupset
           -backupsetname=/dev/rmt0 "/home/jones/budget.dev"
            -loc=tape

Task
         Restore all files in the budget directory that contain a file
         extension of .txt from the tapes on the /dev/rmt0 device, to
         the original source path.

         dsmc restore backupset "/home/budget/*.txt"
           -backupsetname=/dev/rmt0 -loc=tape

Task
         Restore the entire backup set contained in local file named
         "/home/jones/bset01.file"

         dsmc restore backupset
           -backupsetname="/home/jones/bset01.file"
            -loc=file

Task
         Restore groups from the backup set mybackupset.12345678 on the
         IBM Spectrum Protect server to the /home/devel/projectb
         directory. The groups' virtual file space is accounting.

         dsmc restore backupset {/accounting}/*
            /home/devel/projectb/
           -backupsetname=mybackupset.12345678 -loc=server
            -subdir=yes

Task
         Restore groups from the local backup set mybackupset.ost to the
         /home/devel/projectb/ directory. The groups' virtual file space
         is accounting.

         dsmc restore backupset {/accounting}/*
            /home/devel/projectb/
            -backupsetname=mybackupset.ost
            -loc=server -subdir=yes


2.45.1 Restore backup sets: considerations and restrictions


This topic lists some considerations and restrictions that you must be
aware of when restoring backup sets.



Backup set restore considerations

Consider the following when restoring backup sets:

*  If the object you want to restore was generated from a client node
   whose name is different from your current node, specify the original
   node name with the filespacename parameter on any of the restore
   commands.

*  If you are unable to restore a backup set from portable media, check
   with your IBM Spectrum Protect administrator to ensure that the
   portable media was created on a device using a compatible format.

*  If you use the restore backupset command on the initial command line
   with the parameter -location=tape or -location=file, the client does
   not attempt to contact the IBM Spectrum Protect server.

*
   When restoring a group from a backup set:

   *  The entire group, or all groups, in the virtual file space are
      restored. You cannot restore a single group by specifying the
      group name, if there are several groups in the same virtual file
      space. You cannot restore a part of a group by specifying a file
      path.

   *
      Specify a group by using the following values:

      *  Specify the virtual file space name with the filespacename
         parameter.

      *  Use the subdir option to include subdirectories.

*  Limited support is provided for restoring backup sets from tape
   devices attached to the client system. A native device driver
   provided by the device manufacturer must always be used. The device
   driver provided by IBM to be used with the IBM Spectrum Protect
   server cannot be used on the client system for restoring local backup
   sets.

*  If a backup set contains files from several owners, the backup set
   itself is owned by the root user ID, and non-root user IDs cannot see
   the backup set. In this case, non-root user IDs can restore their
   files by obtaining the backup set name from the IBM Spectrum Protect
   administrator. Non-root users can restore only their own files.

*  To enable the client GUI to restore a backup set from a local device,
   without requiring a server connection, use the localbackupset option.

Backup set restore restrictions

Be aware of the following restrictions when restoring backup sets:

*  A backup set data that was backed up with the API cannot be restored
   or used.

*  You cannot restore image data from a backup set using the restore
   backupset command. You can restore image data from a backup set only
   with the restore image command.

*  You cannot restore image data from a local backup set (location=tape
   or location=file). You can restore image data from a backup set only
   from the IBM Spectrum Protect server.


2.45.2 Restore backup sets in a SAN environment


You can restore backup sets in a storage area network (SAN) in the
following ways:

*  If the backup set is on a SAN-attached storage device, specify the
   device using the filename parameter and use the location=tape option,
   where applicable. The backup-archive client restores the backup set
   directly from the SAN-attached storage device, gaining high-speed
   restore performance.

   Note: You must ensure that the correct tape is mounted in the
   SAN-attached tape drive prior to issuing the restore command. The
   backup-archive client will not initiate a SCSI autochanger to mount
   the tape automatically.

*  If the backup set is not on local media or a SAN-attached storage
   device, you can specify the backup set using the backupsetname
   option. Use the location=server option to restore the backup set
   directly from the server using the LAN.


2.45.3 Restore Backupset without the backupsetname parameter


The restore backupset command can be used without the backupsetname
parameter.

The preferred syntax for restore backupset command requires the
backupsetname parameter. Before the introduction of the backupsetname
parameter, the backup-archive client restored backup sets with a
different syntax. The previous syntax is supported, but whenever
possible, follow the syntax that requires the backupsetname parameter.
The previous syntax is documented for those cases when it cannot be
replaced by the preferred syntax.

Supported Clients

This command is valid for all clients.

Syntax

>>-REStore Backupset--+-------------------------------------+--->
                      '-+-----------------+--sourcefilespec-'
                        '-{filespacename}-'

>--+---------------------+--+---------+--+-backupsetname-+------>
   '-destinationfilespec-'  '-options-'  +-localfilename-+
                                         '-tapedevice----'

>--+-----------------------+-----------------------------------><
   '-LOCation=--+-server-+-'
                +-file---+
                '-tape---'



Parameters

options
         All options that are valid with the preferred syntax of restore
         backupset are valid with the previous syntax of restore
         backupset.

{filespacename}
         Specifies the file space (enclosed in braces) on the server
         that contains the files you want to restore. This is the name
         on the workstation drive from which the files were backed up,
         or the virtual file space name for a group.

         Specify a file space name when you restore a backup set
         containing a group.

         Specify a file space name when the sourcefilespec does not
         exist on the target computer. This can occur if the drive label
         name has changed or if you are restoring files that were backed
         up from another node that had drive labels that are different
         from yours.



sourcefilespec
         Specifies the source path of a portion of the backup set. The
         default is to restore the entire backup set.

destinationfilespec
         Specifies the destination path for the restored files. If you
         do not specify a sourcefilespec, you cannot specify a
         destinationfilespec. If you do not specify a destination, the
         client restores the files to the original source path. If you
         are restoring more than one file, you must end the file
         specification with a directory delimiter (/), otherwise, the
         client assumes that the last name is a file name and reports an
         error. If you are restoring a single file, you can optionally
         end the destination file specification with a file name if you
         want to give the restored file a new name. When the
         sourcefilespec does not exist on the target workstation, you
         must specify the destinationfilespec.

backupsetname
         Specifies the name of the backup set from the IBM Spectrum
         Protect server. If the location parameter is specified, you
         must set -location=server.

localfilename
         Specifies the file name of the first backup set volume. You
         must set -location=file.

tapedevice
         Specifies the name of the tape device containing the backup set
         volume. You must use a Windows-provided device driver, not the
         device driver that is provided by IBM. You must set
         -location=tape.

LOCation=
         Specifies the location of the backup set. If you do not specify
         the location parameter, the client searches for backup sets on
         the IBM Spectrum Protect server. If you specify the location
         parameter, the value must be one of the following three
         choices:

         server
                  Specifies that the backup set is on the server. Server
                  is the default location.

         file
                  Specifies that the backup set is on an available file
                  system.

         tape
                  Specifies that the backup set is on an available tape
                  device.

Examples

Task
         Restore the entire backup set called
         monthly_financial_data.87654321 from the server.

         dsmc restore backupset monthly_financial_data.87654321
         -loc=server

Task
         Restore the entire backup set contained in the file:
         /home/budget/weekly_budget_data.ost.

         dsmc restore backupset "/home/budget/weekly_budget_data.ost"
         -loc=file

Task
         Restore the entire backup set from the /dev/rmt0 device.

         dsmc restore backupset "/dev/rmt0" -loc=tape

Task
         Restore a single file named /home/jones/budget.dev from the
         /dev/rmt0 tape device, to the original source path.

         dsmc restore backupset /dev/rmt0 "/home/jones/budget.dev"
         -loc=tape

Task
         Restore all files in the budget directory that contain a file
         extension of .txt from the tape(s) on the /dev/rmt0 device, to
         the original source path.

         dsmc restore backupset /dev/rmt0 "/home/budget/*.txt" -loc=tape

Task
         Restore the entire backup set contained in local file
         "/home/jones/bset01.file"

         dsmc restore backupset "/home/jones/bset01.file" -loc=file

Task
         Restore groups from the backup set mybackupset.12345678 on the
         IBM Spectrum Protect server to the /home/devel/projectb
         directory. The groups' virtual file space is accounting.

         dsmc restore backupset mybackupset.12345678 {/accounting}/*
         /home/devel/projectb/ -loc=server -subdir=yes

Task
         Restore groups from the local backup set mybackupset.ost to the
         /home/devel/projectb/ directory. The groups' virtual file space
         is accounting.

         dsmc restore backupset mybackupset.ost {/accounting}/*
         /home/devel/projectb/ -loc=server -subdir=yes


2.46 Restore Group


Use the restore group command to restore specific members or all members
of a group backup.

Note:

1. Use the pick option to display a list of groups from which you can
   select one group to restore.

2. Use the showmembers option with the pick option to display and
   restore one or more members of a group. In this case, you first
   select the group from which you want to restore specific members,
   then you select one or more group members to restore.

3. You can restore a group from a backup set.

Supported Clients

This command is valid for all clients, except Mac OS X.

Syntax

>>-REStore GRoup--+---------+----source----+-------------+-----><
                  '-options-'              '-destination-'



Parameters

source
         Specifies the virtual file space name and the group name on the
         server that you want to restore.

destination
         Specifies the path where you want to place the group or one or
         more group members. If you do not specify a destination, the
         client restores the files to their original location.

Table 29. Restore Group command: Related options

+---------------------+-----------------------------------------------+
| Option              | Where to use                                  |
+---------------------+-----------------------------------------------+
| backupsetname       | Command line only.                            |
+---------------------+-----------------------------------------------+
| followsymbolic      | Client options file (dsm.opt) or command      |
|                     | line.                                         |
+---------------------+-----------------------------------------------+
| fromdate            | Command line only.                            |
+---------------------+-----------------------------------------------+
| fromnode            | Command line only.                            |
+---------------------+-----------------------------------------------+
| fromowner           | Command line only.                            |
+---------------------+-----------------------------------------------+
| fromtime            | Command line only.                            |
+---------------------+-----------------------------------------------+
| ifnewer             | Command line only.                            |
+---------------------+-----------------------------------------------+
| inactive            | Command line only.                            |
+---------------------+-----------------------------------------------+
| latest              | Command line only.                            |
+---------------------+-----------------------------------------------+
| pick                | Command line only.                            |
+---------------------+-----------------------------------------------+
| pitdate             | Command line only.                            |
+---------------------+-----------------------------------------------+
| pittime             | Command line only.                            |
+---------------------+-----------------------------------------------+
| preservepath        | Command line only.                            |
+---------------------+-----------------------------------------------+
| replace             | Client options file (dsm.opt) or command      |
|                     | line.                                         |
+---------------------+-----------------------------------------------+
| showmembers         | Command line only.                            |
| (does not apply to  |                                               |
| Mac OS X)           |                                               |
+---------------------+-----------------------------------------------+
| subdir              | Client user options file (dsm.opt) or command |
|                     | line.                                         |
+---------------------+-----------------------------------------------+
| tapeprompt          | Client user options file (dsm.opt) or command |
|                     | line.                                         |
+---------------------+-----------------------------------------------+
| todate              | Command line only.                            |
+---------------------+-----------------------------------------------+
| totime              | Command line only.                            |
+---------------------+-----------------------------------------------+

Examples

Task
         Restore all members in the /virtfs/group1 group backup to their
         original location on the client system.

         Command:

         restore group /virtfs/group1

Task
         Display all groups within the /virtfs virtual file space. Use
         the showmembers option to display a list of group members from
         which you can select one or more to restore.

         Command:

         restore group /virtfs/
           * -pick -showmembers

Task
         Display a list of groups within the /virtfs virtual file space
         from which you can select one or more groups to restore.

         Command:

         restore group /virtfs/* -pick


2.47 Restore Image


The restore image command restores a file system or raw volume image
that was backed up using the backup image command.

The restore obtains the backup image from the IBM Spectrum Protect
server, or inside a backup set from the IBM Spectrum Protect server,
when the backupsetname option is specified. This command can restore an
active base image, or a point-in-time base image, with associated
incremental updates.

Note:

1. Using the incremental option with the restore image command to
   perform a dynamic image backup is not supported.

2. If you use IBM Spectrum Protect HSM for Windows or IBM Spectrum
   Protect for Space Management, and you restore a file system image
   backup and plan to run reconciliation, you must restore the files
   that were backed up after the image backup. Otherwise, migrated files
   that were created after the image backup expire from the HSM archive
   storage on the IBM Spectrum Protect server.

You can use the verifyimage option with the restore image command to
specify that you want to enable detection of bad sectors on the
destination target volume. If bad sectors are detected on the target
volume, teh client issues a warning message on the console and in the
error log.

If bad sectors are present on the target volume, you can use the
imagetofile option with the restore image command to specify that you
want to restore the source image to a file. Later, you can use a data
copy utility of your choice to transfer the image from the file to a
disk volume.

Considerations:

*  The API must be installed to use the restore image command.

*  Image restore is not supported for the Sun QFS file system.

*  Image restore is not supported for GPFS file systems on Linux x86_64,
   Linux on POWER(R) and Linux on System z.

*  On Linux systems, some file systems such as ext2, ext3, ext4, btrfs,
   and xfs use a universally unique identifier (UUID) to identify
   themselves to the operating system. If you create an image backup of
   such a volume and you restore it to a different location, you might
   have two volumes with the same UUID. If you use UUID to define your
   file systems in /etc/fstab, be aware that the backup-archive client
   might be unable to correctly mount the restored file system because
   the UUIDs conflict. To avoid this situation, restore the image to its
   original location. If you must restore it to a different location,
   change the UUID of either the original or restored volume before you
   mount the restored file system. Refer to the Linux documentation for
   instructions on how to change a UUID. You might also need to manually
   edit the /etc/fstab file so the original volume, the restored volume,
   or both volumes can be mounted.

*  If you use the pick option, the following information is displayed
   for file system images that were backed up by the client:

   *  Image Size
   *  Stored Size - This value is the actual image size that is stored
      on the IBM Spectrum Protect server. The stored image on the server
      is the same size as the volume capacity.
   *  File system type
   *  Backup date and time
   *  Management class that is assigned to image backups
   *  Whether the image backup is an active or inactive copy
   *  The image name

*  If for some reason a restored image is corrupted, you can use the
   fsck tool to attempt to repair the image.

Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Syntax

>>-REStore Image--+-------------+--+- --sourcefilespec---+----->
                  '- --options-'  '- --"sourcefilespec"-'

>--+-------------------------+---------------------------------><
   '- --destinationfilespec-'



Parameters

sourcefilespec
         Specifies the name of a source image file system to be
         restored. Only a single source image can be specified; you
         cannot use wildcard characters.

destinationfilespec
         Specifies the name of an existing mounted file system or the
         path and file name to which the source file system is restored.
         The default is the original location of the file system.

Table 30. Restore Image command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| backupsetname      | Command line only.                             |
+--------------------+------------------------------------------------+
| dateformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| deletefiles        | Command line only.                             |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only.                             |
+--------------------+------------------------------------------------+
| imagetofile        | Command line only.                             |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| incremental        | Command line only.                             |
+--------------------+------------------------------------------------+
| noprompt           | Command line only.                             |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| timeformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| verifyimage        | Command line only.                             |
+--------------------+------------------------------------------------+

The restore image command does not define or mount the destination file
space. The destination volume must exist, must be large enough to hold
the source, and if it contains a file system, must be mounted. If an
image backup contains a file system, and you restore them to a different
location, be aware of the following points:

*  If the destination volume is smaller than the source volume, the
   operation fails.

*  If the destination volume is larger than the source, after the
   restore operation you lose the difference between the sizes. The lost
   space can be recovered by increasing the size of the volume, which
   also increases the size of the restored volume.

Examples

Task
         Restore the /home/test directory over which the logical volume
         is mounted, to its original location.

         Command: dsmc rest image /home/test

Task
         Restore the /home/proj directory over which the logical volume
         is mounted, to its original location and apply the changes from
         the last incremental backup of the original image that is
         recorded on the server. The changes include deletion of files.

         Command: dsmc restore image /home/proj -incremental
         -deletefiles

Task
         Restore the /usr file system to its original location. Use the
         verifyimage option to enable detection of bad sectors on the
         target volume.

         Command: dsmc restore image /usr -verifyimage

Task
         If bad sectors present on the target volume, use the
         imagetofile option to restore the /usr file system to the
         /home/usr.img file to avoid data corruption.

         Command: dsmc restore image /usr /home/usr.img -imagetofile


2.48 Restore NAS


The restore nas command restores the image of a file system that belongs
to a Network Attached Storage (NAS) file server. When you are using an
interactive command-line session with a non-administrative ID, you are
prompted for an administrator ID.

The NAS file server performs the outboard data movement. A server
process performs the restore.

If you used the toc option with the backup nas command or the
include.fs.nas option to save Table of Contents (TOC) information for
each file system backup, you can use the QUERY TOC server command to
determine the contents of a file system backup with the RESTORE NODE
server command to restore individual files or directory trees. You can
also use the web client to examine the entire file system tree and
select files and directories to restore. If you do not save TOC
information, you can still restore individual files or directory trees
with the RESTORE NODE server command, if you know the fully qualified
name of each file or directory and the image in which that object was
backed up.

Use the nasnodename option to specify the node name for the NAS file
server. The NAS node name identifies the NAS file server to the IBM
Spectrum Protect server. You must register the NAS node name at the
server. Place the nasnodename option in your client system-options file
(dsm.sys). The value in the client system-options file is the default,
but this value can be overridden on the command line.

You can use the pick option to display a list of NAS images that are
owned by the NAS node you specify. From this list, you can select one or
more images to restore. If you select multiple images to restore with
the pick option, do not use the monitor option or you serialize the
restores. To start multiple restore processes simultaneously when you
are restoring multiple images, do not specify monitor=yes.

Use the monitor option to specify whether you want to monitor a NAS file
system image restore and display processing information on your screen.

Use the monitor process command to display a list of current restore
processes for all NAS nodes for which your administrative user ID has
authority. The administrative user ID should have at least client owner
authority over both the NAS node and the client workstation node they
are using either from command line or from the web.

Use the cancel process command to stop NAS restore processing.

Regardless of client platform, NAS file system specifications use the
forward slash (/) separator, as in this example: /vol/vol0.

Supported Clients

This command is valid for AIX, and Solaris clients only.

Syntax

>>-REStore NAS--+-------------+---- --sourcefilespec----------->
                '- --options-'

>--+-------------------------+---------------------------------><
   '- --destinationfilespec-'



Parameters

sourcefilespec
         Specifies the name of the NAS file system image you want to
         restore. This parameter is required unless you use the pick
         option to display a list of NAS images from which to choose.
         You cannot use wildcard characters when you specify the
         sourcefilespec.

destinationfilespec
         Specifies the name of an existing mounted file system on the
         NAS device over which you want to restore the image. This
         parameter is optional. The default is the original location of
         the file system on the NAS device.

Table 31. Restore NAS command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| inactive           | Command line only.                             |
+--------------------+------------------------------------------------+
| mode               | Command line only.                             |
+--------------------+------------------------------------------------+
| monitor            | Command line only.                             |
+--------------------+------------------------------------------------+
| nasnodename        | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| numberformat       | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| pitdate            | Command line only.                             |
+--------------------+------------------------------------------------+
| pittime            | Command line only.                             |
+--------------------+------------------------------------------------+
| timeformat         | Client user option file (dsm.opt) or command   |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Restore the NAS file system image /vol/vol1 to the /vol/vol2
         file system on the NAS file server called nas1.

         Command: restore nas -nasnodename=nas1 /vol/vol1 /vol/vol2

Task
         Restore inactive NAS images.

         Command: restore nas -nasnodename=nas2 -pick -inactive


2.49 Restore VM (VMware)


Use the restore vm command to restore a virtual machine (VM) that was
previously backed up.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Restore VM for VMware virtual machines

The restore vm command can be used to restore VMware virtual machines or
VMware virtual machine templates.

If the backup-archive client is installed on a separate system that is
configured as a vStorage backup server, you can restore full virtual
machine backups to the ESX or ESXi server that they came from, or to a
different server. To restore a full virtual machine backup to a
different server, use the HOST parameter. The backup-archive client
copies the data from the IBM Spectrum Protect server over either the LAN
or SAN. The client then writes the data directly to the ESX server, by
using the transport method that is specified in the client options file.

Restoring a full virtual machine backup creates a new virtual machine;
the configuration information and content of the new machine is
identical to what it was when the backup occurred. All virtual machine
disks are restored to the specified point-in-time, as virtual disks in
the newly created virtual machine.

To create a new virtual machine, specify the vmname parameter and
provide a name for the new virtual machine. The vmname parameter creates
a new virtual machine with a configuration that is identical to what it
was when the backup occurred.

Virtual machines are restored to their original resource pool, cluster,
or folder if the containers exist. During a restore operation, if the
destination target (a vCenter or ESXi host) does not have the required
containers, the VM is restored to the top-level default location on the
target ESXi host. If you use the command-line client to restore a
virtual machine, and if the virtual machine cannot be restored to its
original inventory location, an informational message (ANS2091I) is
displayed. If you use the Java(TM) GUI to restore a virtual machine, and if
the virtual machine cannot be restored to its original inventory
location, the informational message is not displayed, but the virtual
machine is still restored to the top-level default location.

Data protection tags that were backed up with the run backup vm command
are restored with the virtual machine. Data protection tags are used to
exclude virtual machines from backups and to specify the retention
policy of backups.

Supported Clients

This command is valid on supported Linux clients that are installed on a
vStorage backup server for a VMware virtual machine.

Syntax

               .-;---------------------------.
               V .-vmname1,vmname2---------. |
>>-REStore VM----+-------------------------+-+------------------>
                 +-VM=vmname1,vmname2------+
                 +- -VM=vmname1,vmname2----+
                 +-vmname:vmdk=all-vmdk----+
                 +-vmname:vmdk=cnfg--------+
                 +-vmname:vmdk=disk_label--+
                 +-vmname:-vmdk=disk_label-+
                 '-VMHost=host1,host2------'

>--+----------------------------+--+-----------+--+---------+--->
   +- -VMNAme=--+-newVMname---+-+  '- -PREView-'  '-options-'
   |            +-*-----------+ |
   |            +-<timestamp>-+ |
   |            +-<date>------+ |
   |            '-<time>------' |
   +-DATACENTER="myDatacenter"--+
   +-HOST="myHost"--------------+
   '-DATASTORE="myDatastore"----'

>--+---------------------+-------------------------------------><
   '-destinationfilespec-'



Parameters

Any parameter that contains spaces must be enclosed in quotation marks
(" ").

vmname
         Specify the name of one or more virtual machines that you want
         to restore. The name is the virtual machine display name.
         Separate multiple VM names with commas (for example,
         vm1,vm2,vm5). If you backed up template VMs, the vmname
         parameter can specify the name of a template VM to restore.

         Wildcard characters can be used to select VMs names that match
         a pattern. An asterisk (*) matches any sequence of characters.
         A question mark (?) matches any single character. For example:

         *  restore vm VM_TEST* restores all VMs that have names that
            begin with "VM_TEST".

         *  restore vm VM?? restores any VM that has a name that begins
            with the letters "VM", followed by 2 characters.

         Specifying one or more VMs to restore is required.

vm=vmname
         The vm= keyword specifies that the next set of values is a list
         of virtual machine names. The vm= keyword is the default and is
         not required.

         Wildcard characters can be used in VM names. For the
         specification of the vmname parameter, see vmname .

         In the following example, vm= is specified and commas are used
         to separate two machine names.

         restore vm vm=my_vm1,my_vm2

-vm=vmname
         You can exclude a virtual machine from a restore operation by
         specifying the exclude operator (-) before the vm= keyword.
         Use the -vm= keyword to exclude a list of virtual machines from
         a larger group of VM backups, such as a group of VMs that begin
         with a VM name pattern. For example, if you need to restore all
         the VMs that start with Dept99_ but prevent vm2 from being
         restored, issue the following command:

         restore vm vm=Dept99_*;-vm=vm2

         Wildcard characters can be used with the -vm= keyword to
         exclude VM names that match a pattern. For example:

         *  Exclude all files that have test in the host name:

            -vm=*test*

         *  Include all virtual machines with names such as: test20,
            test25, test29, test2A:

            vm=test2?

         Note: You cannot use the exclude operator (-) to exclude a VM
         host domain. The exclude operator works only at the virtual
         machine name level.

vmname:vmdk=all-vmdk
         This option specifies that all virtual disks (*.vmdk files) are
         included when the virtual machine is restored. This parameter
         is the default for vmdk specifications.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

vmname:vmdk=cnfg
         This option specifies that the virtual machine configuration
         information is restored. The configuration information is
         always restored when a new virtual machine is created. However,
         by default the configuration is not restored when you update an
         existing virtual machine with selected virtual disks.
         Ordinarily, restoring configuration information to an existing
         virtual machine fails because the restored configuration
         information conflicts with the existing virtual machine
         configuration information. Use this option if the existing
         configuration file for a virtual machine on the ESXi server has
         been deleted, and you want to use the backed-up configuration
         to re-create it.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

vmname:vmdk=disk_label
         This option is used to specify the disk label of a virtual disk
         to include in the restore operation. Specify this option only
         if you want to restore one or more specific disks, but not all
         disks. Repeat this option for each disk you want to restore.
         The following considerations apply to each disk that you want
         to restore:

         *  The disk must exist on the VM before you initiate the
            restore operation. If the disk does not exist, you must
            create it. You can use the -preview parameter to identify
            the original disk label, capacity, and datastore. The
            -preview output does not include provisioning information.

         *  The existing disk must be at least as large as the disk you
            want to restore.

         *  The existing disk label must be the same as the disk you
            want to restore.

         *  Any data on the existing disk is overwritten.
         Only the specified disks are restored. Other disks on the VM
         are not altered.
         The VM that you are restoring the disk to must be powered off
         before you initiate the restore operation.
         Required: On the restore vm command, the label names of the
         vmdk files that you want to include (with the
         vmname:vmdk=disk_label parameter) in a restore VM operation
         must be specified as the English-language label name. The label
         name must be as it is displayed in the output of the -preview
         parameter. Examples of the English vmdk labels are "Hard Disk
         1", "Hard Disk 2", and so on.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

vmname:-vmdk=disk_label
         This option is used to specify the disk label of one or more
         virtual disks to exclude from the restore operation.

         Required: On the restore vm command, the label names of the
         vmdk files that you want to include (with the
         vmname:vmdk=disk_label parameter) in a restore VM operation
         must be specified as the English-language label name. The label
         name must be as it is displayed in the output of the -preview
         parameter. Examples of the English vmdk labels are "Hard Disk
         1", "Hard Disk 2", and so on.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

vmhost=hostname
         This option restores all virtual machines that are defined to
         the Virtual Center or to the ESX server that is specified on
         the vmchost option. The host name that you specify must match
         the fully qualified host name or IP address, as it is specified
         in the vCenter server Hosts and Clusters view.

         Separate multiple host names with commas (for example,
         host1,host2,host5).

         This parameter can include multiple ESX servers that are
         separated by commas.

         When you connect directly to an ESXi or ESX host, the vmchost
         option applies only if the vmhost is the server that you
         connect to. If it is not, a warning level message is sent to
         the console and is recorded in the dsmerror.log file; it is
         also recorded as a server event message.

         If you backed up VM templates, they are included in the restore
         operation.

VMName=
         Specifies the new name for the virtual machine after it is
         restored, if you do not want to use the name specified by the
         VM= parameter.

         newVMname
                  Specify a new VM name to use for the restored VM.

                  The following characters are not supported in names of
                  restored VMs:

                  : ; ' \ / " ? , < > |

                  A restore command that includes unsupported characters
                  will fail with error message ANS9117E.

                  VMware does not support VM names of greater than 80
                  characters in length.

         *
                  Use the * (asterisk) symbol as a wildcard to represent
                  the original name of the VM that is being restored.
                  Placing valid characters before or after the asterisk
                  creates a prefix or suffix in the name of the restored
                  VM.

                  The following characters are not supported in names of
                  restored VMs:

                  : ; ' \ / " ? , < > |

                  A restore command that includes unsupported characters
                  will fail with error message ANS9117E.

                  VMware does not support VM names of greater than 80
                  characters in length.

                  You can use the * symbol in the following manner:

                  *  Use the original VM name for the restored VM name
                     by specifying vmname=*.

                  *  Append a suffix to the original VM name for the
                     restored VM. For example, if the original VM name
                     is VM1, you can append the suffix "_restored" to
                     VM1 by specifying the following command:

                     dsmc restore vm VM1 -VMName=*_restored

                     The name of the restored VM is VM1_restored.

                  *  Insert a prefix before the original VM name for the
                     restored VM. For example, if the original VM name
                     is VM2, you can insert the prefix "new_" to VM2 by
                     specifying the following command:

                     dsmc restore vm VM2 -vmname=new_*

                     The name of the restored VM is new_VM2.

         <timestamp>
                  Appends a timestamp with the date and time of the
                  restore operation to the name of the restored VM. The
                  <timestamp> parameter is a keyword, and must include
                  the bracket symbols ("<" and ">"). The format for the
                  timestamp string is determined by the DATEFORMAT and
                  TIMEFORMAT options in the dsm.opt file. A dash is used
                  as a delimiter for the timestamp that is returned by
                  the <timestamp> parameter.

                  For example, to restore two VMs named VM5 and VM6, and
                  append the date and time of restore to the restored VM
                  names, issue the following command:

                  dsmc restore vm VM5,VM6 -vmn=*_<timestamp>

                  The names of the restored VMs are
                  VM5_06-22-2017_14-56-55 and VM6_06-22-2017_14-56-55.

         <date>
                  Appends the date of the restore operation to the name
                  of the restored VM. The <date> parameter is a keyword,
                  and must include the bracket symbols ("<" and ">").
                  The format of the date string is determined by the
                  DATEFORMAT option in the dsm.opt file. A dash is used
                  as a delimiter for the date that is returned by the
                  <date> parameter.

                  For example, to insert the prefix "new_" before the VM
                  named VM3, and append the restore date to the restored
                  VM name, issue the following command:

                  dsmc restore vm VM3 -vmname=new_*_<date>

                  The name of the restored VM is new_VM3_06-22-2017.

         <time>
                  Appends the time of the restore operation to the name
                  of the restored VM. The <time> parameter is a keyword,
                  and must include the bracket symbols ("<" and ">").
                  The format of the time string is determined by the
                  TIMEFORMAT option in the dsm.opt file. A dash is used
                  as a delimiter for the time that is returned by the
                  <time> parameter.

                  For example, to append the suffix "_today_" after the
                  VM named VM8, and add the restore time to the restored
                  VM name, issue the following command:

                  dsmc restore vm VM8 -vmn=*_today_<time>

                  The name of the restored VM is VM8_today_14-56-55.
         Note: This parameter is not valid for restoring VMware virtual
         machines that are backed up using VCB or if the FROM parameter
         specifies LOCAL.

DATACENTER
         Specifies the name of the data center to restore the virtual
         machine to as it is defined in the vSphere vCenter. If the data
         center is contained in a folder, you must specify the
         -datacenter option when you restore the virtual machine and
         include the folder structure of the data center in the data
         center name. For example, the following syntax is valid:

         -datacenter=folder_name/datacenter_name

         When you restore a virtual machine by using the GUI, you must
         restore the virtual machine to a different location. If you
         restore to the original location, you cannot specify the folder
         name of the data center. Without a folder name to help locate
         the original data center, the restore operation fails.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

HOST
         Specifies the domain name of the ESX host server to restore to
         as it is defined in the vSphere vCenter.
         This parameter is case-sensitive and must be the same value as
         the host name that is shown in the VMware vSphere Web Client.
         To confirm the host name in the vSphere Web client, select a
         host and click Manage -> Networking -> TCP/IP configuration ->
         DNS .
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

DATASTORE
         Specifies the VMware datastore to restore the virtual machine
         to. The datastore can be on a SAN, NAS, iSCSI device, or VMware
         virtual volume (VVOL). You can specify only one datastore when
         you restore a virtual machine. If you do not specify a
         datastore parameter, the virtual machine's VMDK file is
         restored to the datastore it was on when the backup was
         created.
         Note: This parameter is not valid for restoring VMware virtual
         machines that were backed up using VCB.

-PREView
         Use this parameter to verify the results of a restore operation
         without restoring any VMs. The -preview parameter provides a
         list of VMs that will be restored and information about the
         VMs, such as labels of the hard disks in the VM, and the
         management class for a VM.

         When you issue the -preview parameter with the restore vm
         command, the restore operation does not start. The restore
         operation starts only if the -preview parameter is removed from
         the command.

         For more information, see 2.49.1 Preview virtual machine
         restore operations (VMware).

Table 32. Restore VM command: Related options used for restoring VMware
virtual machines

+----------------------------------+----------------------------------+
| Option                           | Where to use                     |
+----------------------------------+----------------------------------+
| datacenter                       | Command line or options file.    |
|                                  | This parameter is not valid for  |
|                                  | restoring VMware virtual         |
|                                  | machines that were backed up     |
|                                  | using VCB.                       |
+----------------------------------+----------------------------------+
| datastore                        | Command line or options file.    |
|                                  | This parameter is not valid for  |
|                                  | restoring VMware virtual         |
|                                  | machines that were backed up     |
|                                  | using VCB.                       |
+----------------------------------+----------------------------------+
| host                             | Command line or options file.    |
|                                  | This parameter is not valid for  |
|                                  | restoring VMware virtual         |
|                                  | machines that were backed up     |
|                                  | using VCB.                       |
+----------------------------------+----------------------------------+
| inactive                         | Command line.                    |
+----------------------------------+----------------------------------+
| pick                             | Command line. This parameter is  |
|                                  | not valid for restoring VMware   |
|                                  | virtual machines that were       |
|                                  | backed up using VCB.             |
+----------------------------------+----------------------------------+
| pitdate                          | Command line. This parameter is  |
|                                  | not valid for restoring VMware   |
|                                  | virtual machines that were       |
|                                  | backed up using VCB.             |
+----------------------------------+----------------------------------+
| pittime                          | Command line. This parameter is  |
|                                  | not valid for restoring VMware   |
|                                  | virtual machines that were       |
|                                  | backed up using VCB.             |
+----------------------------------+----------------------------------+
| vmbackdir                        | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmbackuplocation                 | Command line.                    |
+----------------------------------+----------------------------------+
| vmbackuptype                     | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmchost                          | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmcpw                            | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmcuser                          | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmdefaultdvportgroup             | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmdefaultdvswitch                | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmdefaultnetwork                 | Command line or client options   |
|                                  | file                             |
+----------------------------------+----------------------------------+
| vmdiskprovision                  | Command line or client options   |
| This parameter is only valid     | file.                            |
| when instantrestore is specified |                                  |
| for the vmrestoretype value.     |                                  |
+----------------------------------+----------------------------------+
| vmexpireprotect                  | Command line or client options   |
| This parameter is only valid     | file.                            |
| when either instantaccess or     |                                  |
| instantrestore is specified for  |                                  |
| the vmrestoretype value.         |                                  |
+----------------------------------+----------------------------------+
| vmiscsiadapter                   | Command line or client options   |
| This parameter is only valid     | file.                            |
| when either instantaccess or     |                                  |
| instantrestore is specified for  |                                  |
| the vmrestoretype value.         |                                  |
+----------------------------------+----------------------------------+
| vmmaxrestoresessions             | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmmaxrestoreparalleldisks        | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmmaxrestoreparallelvms          | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmmountage                       | Command line.                    |
+----------------------------------+----------------------------------+
| vmnoprdmdisks                    | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmnovrdmdisks                    | Command line or client options   |
|                                  | file.                            |
+----------------------------------+----------------------------------+
| vmstoragetype                    | Command line or client options   |
| This parameter is only valid     | file.                            |
| when either instantaccess or     |                                  |
| instantrestore is specified for  |                                  |
| the vmrestoretype value.         |                                  |
+----------------------------------+----------------------------------+
| vmvstortransport                 | Command line or client options   |
|                                  | file. This parameter is not      |
|                                  | valid for restoring VMware       |
|                                  | virtual machines that were       |
|                                  | backed up using VCB.             |
+----------------------------------+----------------------------------+

Tip about the final statistics: If you are running multiple restore
sessions, the value that is displayed in the Data transfer time field in
the final statistics can be higher than the value in the Elapsed
processing time field. The data transfer time is the sum of the times
that each restore operation takes to send data across the network. This
number does not include the time for the data mover to read the data
from disk before sending it, nor the time to wait for server
transactions to complete. This number can be greater than the elapsed
processing time if the operation uses multiple concurrent sessions to
move data, such as multi-session restore operations. This value includes
the time that it takes to send data more than once due to retry
operations.

Examples

Task
         Restore the most recent backup version of myVM to its original
         name. Use the VMware management interface to delete the
         original virtual machine, before you restore it using this
         syntax.

         dsmc restore vm myvm

Task
         Restore the most recent backup version of myvm to a new virtual
         machine that is created with the name "Test Machine", and with
         the restore target for the data center, ESX host, and datastore
         all specified on the command.

         dsmc restore vm myvm -vmname="Test Machine"
           -datacenter="myDatacenter" -host="myHostName"
            -datastore="myDatastore"

Task
         Restore the most recent backup version of myvm with the new
         name myvm_restored.

         dsmc restore vm myvm -vmname="*_restored"
           -datacenter="myDatacenter" -host="myHostName"
            -datastore="myDatastore"

Task
         Restore the most recent backup version of myvm with a new name,
         showing date and time, similar to myvm_03-22-2017_14-41-24.

         dsmc restore vm myvm -vmname="*_<timestamp>"
           -datacenter="myDatacenter" -host="myHostName"
            -datastore="myDatastore"

Task
         Restore the most recent backup version of myvm. Restore to a
         data center named mydatacenter. The data center is within the
         vCenter; the relative path within the vCenter is
         dirA/datacenters/.

         dsmc restore vm myvm -vmname="Test Machine"
           -datacenter="dirA/datacenters/myDatacenter"
           -host="myHostName" -datastore="myDatastore"

Task
         Restore a virtual machine template back to the same location
         and name.

         dsmc restore vm vmTemplateName

Task
         Restore a virtual machine template to a new location.

         dsmc restore vm vmTemplateName -vmname=newName
           -datastore=newDatastore -host=newHost
            -datacenter=newDatacenter

Task
         Restore only Hard Disk 2 and Hard Disk 3 to the existing
         virtual machine that is named vm1.

         dsmc restore vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"

Task
         Restore all disks to the existing virtual machine named vm1,
         but do not restore the data from Hard Disk 4.

         dsmc restore vm "vm1:-vmdk=Hard Disk 4"

Task
         Restore only the data from Hard Disk 1 to the existing virtual
         machine vm1; do not update any configuration information.

         Note: When you restore an existing virtual machine, the default
         behavior is to not update the configuration information.

         dsmc restore vm "vm1:vmdk=Hard Disk 1:-vmdk=cnfg"

Task
         Restore all disks to the existing virtual machine named vm1.

         dsmc restore vm "vm1:vmdk=all-vmdk"

         This command updates all virtual disks on an existing virtual
         machine, named vm1. Note that this action is different from the
         action that is performed by dsmc restore vm vm1, which creates
         a new virtual machine named vm1 (vm1 must not exist in order
         for dsmc restore vm vm1 to succeed).

Task
         Set a maximum of three sessions to be used for restore
         operations for virtual disks in the VM vm1:

         dsmc restore vm vm1 -vmmaxrestoresessions=3

Task
         Restore the VM named Accounts and all VMs that begin with
         Dept99:

         dsmc restore vm Accounts,Dept99*

Task
         Restore all VMs that begin with the word "Payroll" but exclude
         any VMs that contain the word "temp" in the name:

         dsmc restore vm vm=Payroll*;-vm=*temp*

Task
         Restore the virtual machines VM1, VM2, and VM3 with new VM
         names that are based on the original VM names. Append the
         suffix "_restored_" and the date and time of the restore
         operation to the VM name:

         dsmc restore vm vm=VM1,VM2,VM3 -vmname=*_restored_<timestamp>

         The restored VMs are named VM1_restored_07-28-2017_13-28-00,
         VM2_restored_07-28-2017_13-28-00, and
         VM2_restored_07-28-2017_13-28-00.

Task
         Restore all VMs from the host esx03 that were backed up to the
         IBM Spectrum Protect server, and of all the VMs being restored,
         restore the VM named esx03-02 without the VM disk Hard Disk 1:

         dsmc restore vm VMHOST=esx03.example.com;esx03-2:-vmdk=Hard Disk 1

Task
         Restore all virtual machines on ESXi hosts named brovar,
         doomzoo, and kepler:

         dsmc restore vm
         vmhost=brovar.example.com,doomzoo.example.com,kepler.example.com

Task
         Verify that the VM named Dept99_VM1 is restored correctly
         without restoring the VM:

         dsmc restore vm VM=Dept99_VM1 -vmname=*_restored -preview

Important: For Windows virtual machines: If you attempt to run a full VM
restore of an application protection backup that was created with 2 or
more snapshot attempts, the system provider snapshot is present on the
restored VM. As the application writes to the disk, the shadow storage
space grows until it runs out of disk space.

In general, if application protection was used during a backup, use only
application protection restore. When you restore the application, the
volume is automatically reverted. However, if you must restore the full
VM, you must either revert or delete the shadow copy.

After you restore the entire VM, verify that the restore was successful,
and the data is not corrupted. If the data is not corrupted, delete the
shadow copy. If the data is corrupted, revert the shadow copy to restore
data integrity.

You can determine which shadow copy to delete or revert by looking for
the dsmShadowCopyID.txt file in the root directory of each restored
volume. This file contains the snapshot IDs of the shadow copies that
were created during the snapshot attempts. You can use the diskshadow
command delete shadows to delete these IDs, or the revert command to
revert the shadow copy. After the delete or revert is completed, you can
also delete the dsmShadowCopyID.txt file.



For more information, see 3.4.86.4.5 INCLUDE.VMSNAPSHOTATTEMPTS.


2.49.1 Preview virtual machine restore operations (VMware)


You can use the -preview parameter to verify the results of a restore
operation without restoring any virtual machines (VMs). The -preview
parameter provides a list of VMs that will be restored and information
about the VMs. To understand how to use the -preview parameter with the
restore vm command, review information about the options that are
displayed and examples of the restore vm -preview command.

The -preview parameter returns options and their values only if the
options override the default values or if no default exists.

The options that are displayed depend on various factors:

*  The following options apply to all VM restore operations:

   VMNAME
   DATACENTER
   DATASTORE
   HOST

*  The following options are displayed when they are set in the client
   options file:

   VMDEFAULTDVPORTGROUP
   VMDEFAULTDVSWITCH
   VMDEFAULTNETWORK

*  The following option is always displayed only during previews of
   non-instant restore operations:

   VMBACKDIR

   The value that is returned for this option is the directory CTL files
   that are cached for both backup and restore operations.

*  The following options are displayed when set during previews of
   instant access restore operations:

   VMDISKPROVISION
   VMAUTOSTARTVM

When you issue the -preview parameter with the restore vm command, the
restore operation does not start. The restore operation starts only if
the -preview parameter is removed from the command.

Examples

Task
         Preview the operation to restore the VM named VM8, and exclude
         the disk Hard Disk 1. The VM is restored to the ESXi host
         server esx03 with a new VM name that ends with -restore.

         The command also displays the port group for the NICs to use,
         the distributed virtual switch (dvSwitch) that contains the
         port group, and the network for the NICs to use during the
         restore operation.

         dsmc restore vm "VM8:-vmdk:Hard Disk 1" -vmname="* -restore"
         -vmdfaultdvportgroup=portgroup1 -vmdefaultdvswitch=switch1
         -vmdefaultnetwork=network1 -host=esx03.example.com -preview

         Command output:

         Restore function invoked.

         Restore VM command started. Total number of virtual machines to process: 1

         1.      VM Name: 'VM8'
                 Mode: 'Incremental Forever - Full'
                 Backup Time: IFFULL 05/22/2017 11:08:33

                 Disk 1 Label:        'Hard Disk 1'
                 Disk 1 Name:         '[TSMV5K2:DS1_VMData (26TB)] VM8/TestVM8.vmdk'
                 Disk 1 Status:       Excluded by user
                 Disk 1 Capacity:     42,949,672,960
                 Disk 1 Data to Send: 42,878,369,792

                 Disk 2 Label:        'Hard Disk 2'
                 Disk 2 Name:         '[TSMV5K2:DS1_VMData (26TB)] VM8/TestVM8_1.vmdk'
                 Disk 2 Status:       Selected
                 Disk 2 Capacity:     10,737,418,240
                 Disk 2 Data to Send: 10,737,418,240

                 Destination Name:       'VM8 -restore'
                 Destination Host:       'esx03.example.com'
                 Destination vPortGroup: 'portgroup1'
                 Destination Switch:     'switch1'
                 Destination Network:    'network1'
                 Destination CTL Folder: 'C:\mnt\tsmvmbackup'

Task
         Preview the instant restore operation of the VM named VM8,
         which also excludes the disk Hard Disk 1. The VM is restored to
         the ESXi host server esx03 with a new VM name that ends with
         -restore.

         The command also displays the port group for the NICs to use,
         the distributed virtual switch (dvSwitch) that contains the
         port group, and the network for the NICs to use during the
         restore operation. The new VM is provisioned as a thick VM and
         will be restarted automatically after the restore operation.

         restore vm "VM8:-vmdk=Hard Disk 1" -vmname="* -restore"
         -vmdefaultdvportgroup=portgroup1 -vmdefaultdvswitch=switch1
         -vmdefaultnetwork=network1 -host=esx03.storage.example.com
         -vmrestoretype=instantrestore -vmdiskprovision=thick
         -vmautostartvm=yes -preview

         Command output:

         1.      VM Name: 'VM8'
                 Mode: 'Incremental Forever - Full'
                 Backup Time: IFFULL 05/22/2017 11:08:33

                 Disk 1 Label:        'Hard Disk 1'
                 Disk 1 Name:         '[TSMV5K2:DS1_VMData (26TB)] VM8/TestVM8.vmdk'
                 Disk 1 Status:       Excluded by user
                 Disk 1 Capacity:     42,949,672,960
                 Disk 1 Data to Send: 42,878,369,792

                 Disk 2 Label:        'Hard Disk 2'
                 Disk 2 Name:         '[TSMV5K2:DS1_VMData (26TB)] VM8/TestVM8_1.vmdk'
                 Disk 2 Status:       Selected
                 Disk 2 Capacity:     10,737,418,240
                 Disk 2 Data to Send: 10,737,418,240

                 Destination Name:       'VM8 -restore'
                 Destination Host:       'esx03.example.com'
                 Destination vPortGroup: 'portgroup1'
                 Destination Switch:     'switch1'
                 Destination Network:    'network1'
                 Destination Provision:  'THICK'
                 Destination Autostart:  YES

Related reference
2.49 Restore VM (VMware)


2.50 Retrieve


The retrieve command obtains copies of archived files from the IBM
Spectrum Protect server. You can retrieve specific files or entire
directories.

Use the description option to specify the descriptions that are assigned
to the files you want to retrieve.

Use the pick option to display a list of your archives from which you
can select an archive to retrieve.

Retrieve the files to the same directory from which they were archived,
or to a different directory. he backup-archive client uses the
preservepath option with the subtree value as the default for restoring
files.

Note: When a directory is retrieved, its modification date and time is
set to the date and time of the retrieval, not to the date and time the
directory had when it was archived. This is because the backup-archive
client retrieves the directories first, then adds the files to the
directories.

Supported Clients

This command is valid for all clients.

Syntax

>>-RETrieve--+-------------+--+- --sourcefilespec---+---------->
             '- --options-'  '- --"sourcefilespec"-'

>--+-------------------------+---------------------------------><
   '- --destinationfilespec-'



Parameters

sourcefilespec
         Specifies the path and file name that you want to retrieve. Use
         wildcard characters to specify a group of files or all the
         files in a directory.

destinationfilespec
         Specifies the path and file name where you want the files to be
         written. If you do not specify a destination, the client
         restores the files to the original source path.

         Note: If you do not specify a destination, the backup-archive
         client determines whether the original file system can be
         reached. If the original file system cannot be reached, the
         client does not restore the file.

         This failure can also occur if you remove the virtualmountpoint
         option from the dsm.sys file. In this case, you can specify a
         different destination, or restore the original
         virtualmountpoint option to the dsm.sys file, restart the
         client, and try the command again.

Table 33. Retrieve command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| dateformat         | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| description        | Command line only.                             |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only                              |
+--------------------+------------------------------------------------+
| followsymbolic     | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| fromdate           | Command line only                              |
+--------------------+------------------------------------------------+
| fromnode           | Command line only.                             |
+--------------------+------------------------------------------------+
| fromowner          | Command line only                              |
+--------------------+------------------------------------------------+
| fromtime           | Command line only                              |
+--------------------+------------------------------------------------+
| ifnewer            | Command line only                              |
+--------------------+------------------------------------------------+
| pick               | Command line only.                             |
+--------------------+------------------------------------------------+
| preservepath       | Command line only.                             |
+--------------------+------------------------------------------------+
| replace            | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| subdir             | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| tapeprompt         | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| timeformat         | Client user options file ( dsm.opt ) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| todate             | Command line only.                             |
+--------------------+------------------------------------------------+
| totime             | Command line only.                             |
+--------------------+------------------------------------------------+

Examples

Task
         Retrieve a single file named budget.

         retrieve /home/devel/projecta/budget

Task
         Retrieve all files with an extension of .c from the
         /home/devel/projecta directory.

         retrieve "/home/devel/projecta/*.c"

Task
         Retrieve all files in the /home directory.

         retrieve /home/

Task
         Retrieve all files with a file extension of .c from the
         /home/devel/projecta directory to the
         /home/newdevel/projectn/projecta directory. If the /projectn or
         the /projectn/projecta directory does not exist, it is created.

         retrieve "/home/devel/projecta/*.c" /home/newdevel/projectn/

Task
         Retrieve files in the /user/project directory. Use the pick
         option.

         ret "/user/project/*" -pick

Task
         Retrieve all files that were archived from the /proj directory
         with the description "2012 survey results".

         retrieve "/proj/*" -desc="2012 survey results"

Task
         Retrieve archived file /home/devel/budget with description "my
         budget" to the /dev/rmt1 tape drive.

         mkfifo fifo
         dd if=fifo of=/dev/rmt1&
         dsmc retrieve -replace=yes -description="mybudget"
         /home/devel/budget fifo

Task
         Retrieve a file from the renamed file space Jaguar_OLD to its
         original location. Enter both the source and destination as
         follows:

         ret Jaguar_OLD/user5/Documents/myresume.doc
         /Users/user5/Documents/


2.50.1 Retrieve archives from file spaces that are not Unicode-enabled


If you want to retrieve archives from file spaces that were renamed by
the Unicode-enabled client, you must specify the source on the server
and a destination on the client.

This section applies to Mac OS X only. For example, assume that Jaguar
is the name of your startup disk and you archive all of the .log files
in the /Users/user5/Documents directory. Before the archive takes place,
the server renames the file space to Jaguar_OLD. The archive places the
data specified in the current operation into the Unicode-enabled file
space named /. The new Unicode-enabled file space now contains only the
Users/user5/Documents directory and the *.log files specified in the
operation.

If you want to retrieve a file from the renamed (old) file space to its
original location, you must enter both the source and destination as
follows:

   retrieve Jaguar_OLD/Users/user5/Documents
     /mylog.log /Users/user5/Documents/


2.51 Schedule


The schedule command starts the client scheduler on your workstation.
The client scheduler must be running before scheduled work can start.

Authorized User: The schedule command starts the client scheduler on
your workstation. The client scheduler must be running before scheduled
work can start.

Note:

1. The schedule command cannot be used if the managedservices option is
   set to schedule.

2. For Mac OSX only, to use the schedule command, specify
   managedservices none in the dsm.sys file.

3. This command is valid only on the initial command line. It is not
   valid in interactive mode or in a macro file.

If the schedmode option is set to polling, the client scheduler contacts
the server for scheduled events at the hourly interval you specified
with the queryschedperiod option in your client user-options file
(dsm.opt). If your administrator sets the queryschedperiod option for
all nodes, that setting overrides the client setting.

If you are using TCP/IP communications, the server can prompt your
workstation when it is time to run a scheduled event. To do so, set the
schedmode option to prompted in the client user-options file (dsm.opt)
or on the schedule command.

You can use the sessioninitiation option with the schedule command to
control whether the server or client initiates sessions through a
firewall.

After you start the client scheduler, it continues to run and to start
scheduled events until you press Ctrl+C, stop the scheduler process with
the UNIX kill command, start the workstation again, or turn off the
workstation to end it.

After you start the client scheduler, it continues to run and to start
scheduled events until you press Ctrl+C, press the Q key twice, start
the workstation again, or turn off the workstation to end it.

Note: You cannot enter this command in interactive mode.

Supported Clients

This command is valid for all clients.

Syntax

>>-SCHedule--+-------------+-----------------------------------><
             '- --options-'



Parameters

Table 34. Schedule command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| maxcmdretries      | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| password           | client user options file (dsm.opt)             |
+--------------------+------------------------------------------------+
| queryschedperiod   | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| retryperiod        | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| schedlogname       | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| schedmode          | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| sessioninitiation  | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| tcpclientport      | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+

Examples

Task
         Start the client scheduler.

         Command: dsmc sch -password=notell

Task
         For AIX: Start the scheduler at system bootup time by entering
         this command in the /etc/inittab file. Ensure that the
         passwordaccess option is set to generate.

         Command: tsm::once:/usr/bin/dsmc sched > /dev/null 2>&1 #TSM

Task
         Interactively start the scheduler and keep it running in the
         background.

         Command: nohup dsmc sched 2> /dev/null &

When you run the schedule command, all messages that regard scheduled
work are sent to the dsmsched.log file or to the file you specify with
the schedlogname option in your client system-options file (dsm.sys). If
you do not specify a directory path with the file name in the
schedlogname option, the dsmsched.log resides in the current working
directory, except for Mac OS X. For Mac OS X, the dsmsched.log resides
in the /Library/Logs/tivoli/tsm/ directory.

Important: To prevent log write failures and process termination in
certain cases, set the DSM_LOG environment variable to name a directory
where default permissions allow the required access.


2.52 Selective


The selective command backs up files that you specify. If you damage or
mislay these files, you can replace them with backup versions from the
server.

When you run a selective backup, all the files are candidates for backup
unless you exclude them from backup, or they do not meet management
class requirements for serialization.

During a selective backup, copies of the files are sent to the server
even if they did not change since the last backup - which can result in
more than one copy of the same file on the server. If this occurs, you
might not have as many different down-level versions of the file on the
server as you intended. Your version limit might consist of identical
files. To avoid this, use the incremental command to back up only new
and changed files.

You can selectively back up single files or directories. You can also
use wildcard characters to back up groups of related files.

If you set the subdir option to yes when you back up a specific path and
file, the client recursively backs up all subdirectories under that
path, and any instances of the specified file that exist under any of
those subdirectories.

During a selective backup, a directory path might be backed up, even if
the specific file that was targeted for backup is not found. For
example, the following command still backs up dir1 and dir2 even if the
file bogus.txt does not exist.

   selective /Users/user1/Documents/dir1/bogus.txt

   selective "/dir1/dir2/bogus.txt"

If the selective command is retried because of a communication failure
or session loss, the transfer statistics displays the number of bytes
that the client attempts to transfer during all command attempts.
Therefore, the statistics for bytes transferred might not match the file
statistics, such as those for file size.

You can use the removeoperandlimit option to specify that the 20-operand
limit is removed. If you specify the removeoperandlimit option with the
selective command, the 20-operand limit is not enforced and is
restricted only by available resources or other operating system limits.

Supported Clients

This command is valid for all clients.

Syntax

              .------------------.
              V                  |
>>-Selective------ --filespec---+--+-------------+------------><
                                    '- --options-'



Parameters

filespec
         Specifies the path and name of the file you want to back up.
         Use wildcard characters to include a group of files or to
         include all files in a directory.
         To include multiple file specifications, separate each filespec
         with a space character. If multiple file specifications are
         included, and two or more of the specifications have common
         parent directories, then it is possible for the common
         directory objects to be backed up more than once. The
         conditions under which this behavior occurs are
         runtime-dependent, but the behavior itself has no adverse
         effects.

         For example, if the filespec is /home/amr/ice.doc
         /home/amr/fire.doc, then /home and /home/amr might be backed up
         twice. The file objects, ice.doc and fire.doc, are backed up
         only once.
         If you want to avoid including the shared parent directory more
         than once, use separate, non-overlapping selective commands to
         back up each file specification.
         If you back up a file system, include a trailing slash
         (/home/).
         There is a limit of 20 operands. This limit prevents excessive
         sessions that are caused when wildcards are expanded by the
         UNIX shell command processor. You can prevent shell expansion
         from causing you to go over the 20-operand limit by placing
         quotation marks around file specifications that contain
         wildcards ("home/docs/*").
         You can use the removeoperandlimit option to specify that the
         20-operand limit is removed. If you specify the
         removeoperandlimit option, the 20-operand limit is not enforced
         and is restricted only by available resources or other
         operating system limits. For example, remove the 20 operand
         limit to backup 21 file specifications:

         selective -removeoperandlimit filespec1 filespec2 ... filespec21
         You can use the filelist option, instead of file
         specifications, to identify which files to include in this
         operation. However, these two methods are mutually exclusive.
         You cannot include file specification parameters and use the
         filelist option. If the filelist option is specified, any file
         specifications that are included are ignored.

Table 35. Selective command: Related options

+--------------------+------------------------------------------------+
| Option             | Where to use                                   |
+--------------------+------------------------------------------------+
| changingretries    | Client system options file (dsm.sys) or        |
|                    | command line.                                  |
+--------------------+------------------------------------------------+
| compressalways     | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| compression        | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| dirsonly           | Command line only.                             |
+--------------------+------------------------------------------------+
| filelist           | Command line only.                             |
+--------------------+------------------------------------------------+
| filesonly          | Command line only.                             |
+--------------------+------------------------------------------------+
| preservelastaccess | Client user options file (dsm.opt) or command  |
| date               | line.                                          |
+--------------------+------------------------------------------------+
| removeoperandlimit | Command line only.                             |
+--------------------+------------------------------------------------+
| snapshotcachesize  | Client options file (dsm.opt) or with the      |
|                    | include.fs option.                             |
+--------------------+------------------------------------------------+
| snapshotproviderfs | System-options file (dsm.sys) within a server  |
|                    | stanza or with the include.fs option.          |
+--------------------+------------------------------------------------+
| snapshotroot       | Command line only.                             |
+--------------------+------------------------------------------------+
| subdir             | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+
| tapeprompt         | Client user options file (dsm.opt) or command  |
|                    | line.                                          |
+--------------------+------------------------------------------------+

Examples

Task
         Back up the proja file in the /home/devel directory.

         Command: selective /home/devel/proja

Task
         Back up all files in the /home/devel directory whose file names
         begin with proj.

         Command: selective "/home/devel/proj*"

Task
         Back up all files in the /home/devel directory whose file names
         begin with proj. Back up the single file that is named budget
         in the /user/home directory.

         Command: selective "/home/devel/proj*" /user/home/budget

Task
         Back up the /home file system.

         Command: selective /home/ -subdir=yes

Task
         Assuming that you initiated a snapshot of the /usr file system
         and mounted the snapshot as /snapshot/day1, run a selective
         backup of the /usr/dir1/sub1 directory tree from the local
         snapshot and manage it on the IBM Spectrum Protect server under
         the file space name /usr.

         Command: dsmc sel "/usr/dir1/sub1/*" -subdir=yes
         -snapshotroot=/snapshot/day1


2.52.1 Associate a local snapshot with a server file space


Use the snapshotroot option with the selective command in conjunction
with an independent software vendor application that provides a snapshot
of a logical volume, to associate the data on the local snapshot with
the real file space data that is stored on the IBM Spectrum Protect
server. The snapshotroot option does not provide any facilities to take
a volume snapshot, only to manage data created by a volume snapshot.

AIX only: You can perform a snapshot-based selective backup by
specifying the option snapshotproviderfs=JFS2.


2.53 Set Access


The set access command gives users at other nodes access to your backup
versions or archived copies.

You can also use the set access command to give users at other nodes
access to your backup images.

You can give another user access to a specific file or image, multiple
files or images, or all files in a directory. When you give access to
another user, that user can restore or retrieve your objects. Specify in
the command whether you are giving access to archives or backups.

For VMware virtual machines, you can give a user at another node access
to the backups of a specific virtual machine.

When a node is exported to another IBM Spectrum Protect server, the
access rules can change on the importing server. If an access rule is
applied to all file spaces on the exporting server, the access rule on
the importing server is restricted to only those file spaces that are
imported. The file spaces are restricted in the access rule on the
importing server for security reasons. Additionally, the access rules do
not recognize the first occurrence of a wildcard character in the file
specification when you restore or retrieve. This means that if you
restore or retrieve with a wildcard character in the file specification,
subdirectories are ignored.

Tip: If you export a node to another IBM Spectrum Protect server, do not
use a single wildcard character as the file specification in the access
rule. Instead, create an access rule for each filespace.

Note: You cannot give access to both archives and backups using a single
command.

When an existing file space is renamed during Unicode conversion, any
access rules that are defined for the file space remain applicable to
the original file space. However, new access rules must be defined to
apply to the new Unicode file space.

Supported Clients

This command is valid for all clients.

Syntax

>>-SET Access--+- --Archive-+--+- --filespec--------+--------->
               '- --Backup--'  +-image-fs------------+
                                '-TYPE=VM-- --vmname-'

>-- --node--+----------+--------------------------------------><
             '- --user-'



Parameters

Archive
         Permits access to archived files or images.

Backup
         Permits access to backup versions of files or images.

filespec
         Specifies the path, file, image, or directory to which your are
         giving access to another node or user. Use wildcard characters
         to specify a group of files or images, or all files in a
         directory; all objects in a directory branch; or all objects in
         a file system. Use a single asterisk "*" for the file spec to
         give access to all files or images owned by you and backed up
         on the server. When the command set access backup "*" node is
         entered, no check is made with the server; it is assumed you
         have at least one object backed up.

         If you give access to a branch of the current working
         directory, you only need to specify the branch. If you give
         access to objects that are not in a branch of the current
         working directory, you must specify the complete path. The file
         spec to which you gave access must have at least one backup
         version or archive copy object (file or directory) on the
         server.



         To specify all files in a named directory, enter
         /home/mine/proj1/* on the command line.



         To give access to all objects below a certain level, use an
         asterisk, directory delimiter, and an asterisk at the end of
         your file spec. For example, to give access to all objects
         below home/test, use file spec home/test/*/*.



         Important: Use of the form /*/* alone will not give access to
         objects in the named directory; only those in directories below
         the named directory are accessible.



         The rules are essentially the same when considering the root
         directory. Enter /* on one set access command and /*/* on
         another if you want another user to have access to all files
         and directories in and below the root directory. The first /*
         gives access to all directories and all files in the root
         directory. The second /* allows access to all directories and
         files below the root directory.



         For example:



         *  Your directory structure is multilevel: /home/sub1/subsub1.

         *  The /home directory contains the h1.txt and h2.txt files.

         *  The /home/sub1 directory contains file s1.htm.

         *  The /home/sub1/sub2 directory contains the ss1.cpp file.



         To allow access to all files in the /home/sub1/sub2 directory,
         enter:

           set access backup /home/sub1/sub2/* * *



         To allow access to only those files in the /home directory,
         enter:

           set access backup /home/* * *



         To allow access to all files in all directories in and below
         the /home directory, enter:

           set access backup /home/* * *
           set access backup /home/*/* * *

image-fs
         The name of the image file system to be shared. This can be
         specified as an asterisk (*) to allow access to all images
         owned by the user granting access.

-TYPE=VM vmname
         This parameter is required if you are using this command to
         provide another user with access to VMware virtual machine
         backups. The vmname option can be specified only if -TYPE=VM is
         specified; vmname is the name of the VMware virtual machine
         that you are permitting access to.

node
         Specifies the client node of the user to whom you are giving
         access. Use wildcards to give access to more than one node with
         similar node names. Use an asterisk (*) to give access to all
         nodes.

user
         This is an optional parameter that restricts access to the
         named user at the specified node. To allow any authorized user
         to access your backed up or archived data, specify root as the
         user.

         Restriction: Access can be granted to root user only. For other
         users, this feature is not supported.

Examples

Task
         Give the user at node_2 authority to restore the budget file
         from the /home/user directory.

         set access backup /home/user/budget node_2

Task
         Give node_3 the authority to retrieve all files in the
         /home/devel/proja directory.

         set ac archive /home/devel/proja/ node_3

Task
         Give all nodes whose names end with bldgb the authority to
         restore all backup versions from directories with a file space
         name of project.

         set ac b "{project}/*" "*bldgb"

Task
         Give any authorized user on node1 authority to retrieve all
         files in the /home/devel/projb directory.

         set access archive /home/devel/projb/ node1 root

Task
         Give the node named myOtherNode the authority to restore files
         backed up by the VMware virtual machine named myTestVM.

         set access backup -TYPE=VM myTestVM myOtherNode


2.54 Set Event


Using the set event command, you can specify the circumstances for when
archived data is deleted.

You can use the set event command in the following ways:

*  Prevent the deletion of data at the end of its assigned retention
   period (Deletion hold)

*  Allow the expiration to take place, as defined by the archive copy
   group (Release a deletion hold)

*  Start the expiration clock to run when a particular event occurs
   (Notify the server that an event occurred)

Objects that are affected can be specified with a standard file
specification (including wildcards), a list of files whose names are in
the file that is specified using the filelist option, or a group of
archived files with the description specified with the description
option.

Note: When only a <filespec> is used, all archived copies of files or
folders that match the filespec are affected. If you want to affect
certain versions of a file, use the -pick option and select from the
displayed list.

The set event command is a function of the IBM Spectrum Protect for Data
Retention licensed feature. Ensure that the backup-archive client is
connected to an IBM Spectrum Protect for Data Retention server,
otherwise, a license module will be activated and can cause your server
to lose compliance.

Supported Clients

This command is valid for all clients.

Syntax

>>-SET Event---- -TYPE=--+-Hold--------------+------------------>
                         +-Release-----------+
                         '-Activateretention-'

>-- --<filespec>-- -- -filelist=<filespec>-------------------->

>-- -- -description=-- -pick----------------------------------><



Parameters

TYPE=
         Specifies the event type setting. This parameter must be
         specified.

hold
         Prevents the object from being deleted regardless of expiration
         policy.

release
         Allows normal event-controlled expiration to take place.

activateretention
         Signals the server that the controlling event occurred and
         starts to run the expiration clock.

-pick
         Provides a list of objects from which the user can select to
         apply the event.

The following options can also be used and serve their usual purpose:

*  Dateformat

*  Numberformat

*  Noprompt

*  Subdir

*  Timeformat

Examples

Task
         The following example displays the verbose and statistics
         output from the set event command set event type=hold
         /home/accounting/ledgers/*05.books, with objects rebound (as
         opposed to archived or some other notation).

         Rebinding--> 274 /home/accounting/ledgers/
           jan05.books
         Rebinding--> 290 /home/accounting/ledgers/
           feb05.books

         Total number of objects archived:         0
         Total number of objects failed:           0
         Total number of objects rebound:          2
         Total number of bytes transferred:        0  B
         Data transfer time:                    0.00 sec
         Network data transfer rate:            0.00 KB/sec
         Aggregate data transfer rate:          0.00 KB/sec
         Objects compressed by:                    0%
         Elapsed processing time:           00:00:02


Task
         The -pick option used with the set event command set event
         type=activate /user/tsm521/common/unix shows the event type
         instead of the command name:

         Scrollable PICK Window - Retention Event :  ACTIVATE

         #    Archive Date/Time       File Size   File
         -----------------------------------------------------
         1. | 08/05/2003 08:47:46        766  B   /user/tsm521
                                                   /common/unix
         2. | 08/01/2003 10:38:11        766  B   /user/tsm521
                                                   /common/unix
         3. | 08/05/2003 08:47:46       5.79 KB   /user/tsm521
                                                   /common/unix
         4. | 08/01/2003 10:38:11       5.79 KB   /user/tsm521
                                                   /common/unix
         5. | 08/05/2003 08:47:46      10.18 KB   /user/tsm521
                                                   /common/unix



2.55 Set Netappsvm


The set netappsvm command associates the logon credentials for a cluster
management server, which are specified on the set password command, with
a NetApp storage virtual machine, and the data storage virtual machine
(SVM) name (data Vserver). You must enter this command before you can
create a snapshot difference incremental backup of a clustered NetApp
volume.

This command is typically entered only once. The parameters are stored
and are reused the next time that you backup a clustered volume that is
managed by the storage virtual machine. If you move an storage virtual
machine to another cluster management server, you must reenter this
command and specify the new cluster management server. If necessary,
change the login credentials by using the set password command.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported clients

This command is valid for Linux backup-archive clients that complete
snapshot difference backups of clustered-data ONTAP-c-mode file-server
volumes.

Syntax

>>-SET NETAPPSVM--+-svm_hostname--cms_hostname-- svm_name-+---><
                  '- -remove--svm_hostname-----------------'



Parameters

svm_hostname
         Specifies the host name or IP address of the storage virtual
         machine that manages the volumes and logical interfaces (LIFs),
         for the volumes that you want to protect.

cms_hostname
         Specifies the host name or IP address of the cluster management
         server. Specify the same host name that you specified for this
         cluster management server when you used the set password
         command to establish the login credentials.

svm_name
         Specifies the name of the data SVM that manages the mounted
         volume. Contact the NetApp SVM administrator to obtain the data
         SVM name that is assigned to the virtual machine.

-remove svm_hostname
         Disassociates the SVM from the cluster management server that
         it was previously associated with. Specify a SVM host-name

         You can specify this parameter if you accidentally associated a
         storage virtual machine with a 7-mode file server. If you
         remove a 7-mode file server and then associate a cluster
         management server, set the logon credentials for the cluster
         management server by using the set password command.

Examples

Configure the credentials and access to a storage virtual machine:

set netappsvm svm_example.com cms_filer1.example.com svm_2
dsmc set password cms_filer1.example.com user_name password

Remove the associations that were created for the storage virtual
machine:

set netappsvm -remove svm_example.com


2.56 Set Password


The set password command changes the IBM Spectrum Protect password for
your workstation, or sets the credentials that are used to access
another server.

If you omit the old and new passwords when you enter the set password
command, you are prompted once for the old password and twice for the
new password.

Passwords can be up to 63 character in length. Password constraints
vary, depending on where the passwords are stored and managed, and
depending on the version of the IBM Spectrum Protect server that your
client connects to.

If your IBM Spectrum Protect server is at version 6.3.3 or later, and if
you use an LDAP directory server to authenticate passwords
         Use any of the following characters to create a password:

         a b c d e f g h i j k l m n o p q r s t u v w x y z
         A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
         0 1 2 3 4 5 6 7 8 9 . ! @ # $ % ^ & * _ - + = ` ( )
         | { } [ ] : ; < > , ? / ~

         Passwords are case-sensitive and are subject to more
         restrictions that can be imposed by LDAP policies.

If your IBM Spectrum Protect server is at version 6.3.3 or later, and if
you do not use an LDAP directory server to authenticate passwords
         Use any of the following characters to create a password:

         a b c d e f g h i j k l m n o p q r s t u v w x y z
         A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
         0 1 2 3 4 5 6 7 8 9 . ! @ # $ % ^ & * _ - + = ` ( )
         | { } [ ] : ; < > , ? / ~

         Passwords are stored in the IBM Spectrum Protect server
         database and are not case-sensitive.

Remember:

On the command line, enclose all parameters that contain one or more
special characters in quotation marks. Without quotation marks, the
special characters can be interpreted as shell escape characters, file
redirection characters, or other characters that have significance to
the operating system.

On AIX, Linux, and Solaris systems:
         Enclose the command parameters in single quotation marks (').

         Command-line example:
                  dsmc set password -type=vmguest 'Win 2012 SQL'
                  'tsml2dag\administrator' '7@#$%^&7'

Quotation marks are not required when you type a password with special
characters in an options file.

Restriction: The set password command does not support the Federal
Information Processing Standard (FIPS) enabled operating system
environment for locally stored passwords.

For more information on FIPS support, see technote 2007756.

Supported Clients

This command is valid for all clients.

The following parameters apply to VMware operations, which are available
only if you are using the client as a data mover for IBM Spectrum
Protect for Virtual Environments: Data Protection for VMware.

*  TYPE=DOMAIN

*  TYPE=VM

*  TYPE=VMGUEST

Syntax

>>-SET Password--+--------------+------------------------------->
                 '-oldpw--newpw-'

>--+-----------------------------------------+------------------>
   '-otherserver--otheruserid--otherpassword-'

   .-TYPE=TSM-----------.
>--+--------------------+--------------------------------------><
   +-TYPE=FASTBack------+
   +-TYPE=FILER---------+
   +-TYPE=VM------------+
   '-TYPE=VMGUEST ALLVM-'



Parameters

oldpw
         Specifies the current password for your workstation.

newpw
         Specifies the new password for your workstation.

other_server other_user_id other_password
         These three parameters specify the attributes that the client
         uses to access another server, such as a filer or an ESXi host.

         other_server
                  Specifies the host name or IP address of the server
                  that the client can access to protect files.

         other_user_id
                  The user ID of an account on the server that the
                  client uses to log on to the other server. The account
                  must have the privileges that are necessary to perform
                  the operations that are run after the user is logged
                  on to the other server.

         other_password
                  The password that is associated with the user ID on
                  the other server.

TYPE
         Specifies whether this password is for the backup-archive
         client or for another type of server.
         Use TYPE=TSM to specify the password for your backup-archive
         client. The default type is TYPE=TSM.
         Use TYPE=FastBack, on Linux and Windows clients, to store the
         Tivoli Storage Manager FastBack credentials that are required
         for mounting and dismounting the FastBack volumes on the
         Windows FastBack Disaster Recovery Hub server.

         The password file on the vStorage backup server must have
         either the Windows administrator ID for the VMware virtual
         center system, or the UNIX user ID for a specific ESX server.
         For a proxy backup for FastBack, the password file must contain
         the FastBack administrator ID and password. Here are some
         examples:

         dsmc set password 192.0.2.24 admin admin 123 -type=fastback

         dsmc set password 192.0.2.24 WORKGROUP:admin admin 123 -type=fastback

         dsmc set password windserv administrator windpass4 -type=fastback

         Important: You must define the user credentials that are
         required to mount and unmount FastBack volumes from a
         repository to the backup-archive client before you enter the
         backup-archive FastBack subcommand. Use the fbserver option to
         define the credentials.

         Here is a brief description of the various configurations and
         credentials that you need:

         *  The backup-archive client is installed on a dedicated
            vStorage backup server. The client on the vStorage backup
            server must connect to multiple network share repositories.

         Follow these steps for each of the network share repositories
         where the client is connected:

         1. Configure the repository for remote network access from
            FastBack Manager. Refer to the Tivoli Storage Manager
            FastBack product documentation on IBM Documentation at
            https://www.ibm.com/docs/en/tsmf.

            This step establishes a domain name, a network share user
            ID, and a network share password to connect remotely to the
            repository.

         2. On the backup-archive client workstation, manually enter the
            following command:

            dsmc set password type=fastback FBServer domain:networkaccessuserid
               networkaccesspassword



            The fbserver option specifies the short host name of the
            FastBack server workstation. For the FastBack DR Hub, the
            fbserver option specifies the short name of the workstation
            where the DR Hub is installed.

            Networkaccessuserid is either the Windows administrator ID
            or the FastBack administration password.

            Domain is the domain name of the user ID.

            Networkaccesspassword is either the Windows administrator ID
            or the FastBack administration password.

         3. These credentials are retrieved based on the short host name
            that you specify with the fbserver option.
         Use TYPE=FILER, on Linux and Windows systems to specify that
         this password is for snapshot difference operations on a file
         server.

         For TYPE=FILER, you must specify a file server name, and the
         user ID and the password that is used to access the file
         server. For example: dsmc set password -type=filer myfiler
         filerid filerpasswd.

         When you specify TYPE=FILER, the password is stored in the
         password (TSM.sth) file without validating that the password is
         valid. Passwords that are stored with TYPE=FILER can be shared
         between client nodes. For example, a password that is stored by
         NODE_A can be used by NODE_B. Only one set of credentials is
         stored per file server.

         Restriction: Snapshot difference incremental backups are not
         supported if you upgrade to NetApp Data ONTAP 9.10.1 or later.
         For more information, see technote 6449354.
         Use TYPE=VM to set the password that is used to log on to an
         ESX or vCenter server.

         dsmc SET PASSWORD -type=VM hostname administrator password

         where:

         hostname
                  Specifies the VMware VirtualCenter or ESX server that
                  you want to back up, restore, or query. This host name
                  must match the host name syntax that is used in the
                  vmchost option. That is, if vmchost uses an IP address
                  instead of a host name, this command must provide the
                  IP address, and not a short host name or a fully
                  qualified host name.

         administrator
                  Specifies the account that is needed to log on to the
                  vCenter or ESXi host.

         password
                  Specifies the password that is associated with the
                  login account that you specified for the vCenter or
                  ESXi administrator.
                  Use the Preferences editor to set the vmchost,
                  vmcuser, and vmcpw options.

                  You can also set the vmchost option in the client
                  options file and then use the set password command to
                  associate that host name with the administrator
                  account and the administrative account password that
                  is used to log on to that host. For example, set
                  password TYPE=VM myvmchost.example.com
                  administrator_name administrator_password.
         Use TYPE=VMGUEST, on Linux and Windows clients, if you use the
         INCLUDE.VMTSMVSS option to protect a virtual machine. Use the
         following format for the set password command:

         set password -type=vmguest guest_VM_name administrator password

         where:

         guest_VM_name
                  Specifies the name of the virtual machine guest that
                  you want to protect.

         administrator
                  Specifies the account that is needed to log on to the
                  guest VM.

         password
                  Specifies the password that is associated with the
                  login account.

         If you use the same credentials to log on to multiple virtual
         machines that are protected by the INCLUDE.VMTSMVSS option, you
         can set the password for the all of the virtual machines by
         specifying the ALLVM parameter. The ALLVM parameter causes the
         same credentials to be used when the client logs on to any
         guest that is included in an INCLUDE.VMTSMVSS option. The
         following command TYPE=TSM is an example of how to use ALLVM.
         In this example, the user name "Administrator" and the password
         "Password" are used to log on to any virtual machine that you
         included on an INCLUDE.VMTSMVSS option:

         set password -type=vmguest ALLVM Administrator Password

         You can also set a combination of shared and individual
         credentials. For example, if most virtual machines in your
         environment use the same credentials, but a few virtual
         machines use different credentials, you can use multiple set
         password commands to specify the credentials. For example,
         assume that most virtual machines use "Administrator1" as the
         login name and "Password1" as the password. Assume also that
         one virtual machine, named VM2, uses "Administrator2" as the
         login name and "Password2" as the password. The following
         commands are used to set the credentials for this scenario:

            set password -type=vmguest ALLVM Administrator1 Password1
            (sets credentials for most of the VMs).
            set password -type=vmguest VM2 Administrator2 Password2
            (sets unique credentials for VM2).

Examples

The following examples use the set password command.

Task
         Change your password from osecret to nsecret.

         set password osecret nsecret

Task
         Set up a user ID and password for the root user on the file
         server myFiler.example.com.

         dsmc set password -type=filer myFiler.example.com root

         Please enter password for user id "root@myFiler.example.com":
         ******** Re-enter the password for verification:********
         ANS0302I Successfully done.

Task
         Set up a user ID and password for the root user on the file
         server myFiler.example.com.

         dsmc set password -type=filer myFiler.example.com root secret

Task
         Set up a user ID and password for the FastBack server
         myFastBackServer. Use the -fbserver option in the archive
         fastback and backup fastback commands for the server name.

         dsmc set password -type=FASTBack myFastBackServer myUserId
         'pa$sword'

         Important:

         1. The dsmc set password -type=fastback command must be
            repeated on a dedicated client proxy workstation once for
            each FastBack repository where the backup-archive client is
            expected to connect.

         2. For network share repositories, issue the dsmc set password
            -type=fastback command in this format: dsmc set password
            -type=fastback myFBServer domainName:userId password.

            The server name that is specified, which is myFBServer in
            this example, must match the name that you specify on the
            -fbserver option on a backup fastback or archive fastback
            command.

         3. For the FastBack server or the FastBack Disaster Recovery
            Hub, the user ID and password that are specified must have
            FastBack administrator privileges.

            You must issue the dsmc set password -type=fastback command
            once for each FastBack Server branch repository on the
            FastBack DR Hub that the backup-archive client is expected
            to connect to.

Task
         The backup-archive client is connecting to the FastBack server
         repository whose short host name is myFBServer. user ID is the
         FastBack network user ID that has read/write access to the
         repository share. DOMAIN is the domain to which the user ID
         belongs. myNetworkPass is the corresponding password for the
         user ID.

         dsmc set password -type=fastback myFbServer DOMAIN:USERID
         myNetworkPass

Task
         The backup-archive client is connecting to a repository on a DR
         Hub machine whose short host name is myFbDrHub. The user ID is
         the Windows administrator ID. DOMAIN is the domain to which the
         DR Hub machine belongs. myNetworkPass is the corresponding
         password for the administrator ID.

         dsmc set password -type=fastback myFbDrHub DOMAIN:administrator
         adminPasswd


2.57 Set Vmtags


The set vmtags command creates data protection tags and categories that
can be added to VMware inventory objects. You can manage IBM Spectrum
Protect backups of virtual machines in these VMware objects by
specifying the tags with tools such as VMware vSphere PowerCLI version
5.5 R2 or later.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

If you are using the IBM Spectrum Protect vSphere Client plug-in to
manage backups, you do not need to run the set vmtags command first. The
tags and categories are created for you.

If you are writing scripts to apply these tags to VMware inventory
objects, you need only to issue the set vmtags command once so that data
protection tags are created before they are added to the VMware
inventory.

You can manage virtual machine backups at the following VMware inventory
object levels:

*  Datacenter

*  Folder (Host and Cluster folders and VM and Template folders)

*  Host

*  Host cluster

*  Resource pool

*  Virtual machine

For the list of supported tags, see "Supported data protection tags."

For tags that are related to schedules, the virtual machines must be in
a protection set that is protected by a schedule. A protection set
consists of the virtual machines in a container that is assigned the
Schedule (IBM Spectrum Protect) tag.

After running the set vmtags command, you can assign the tags to VMware
objects to manage the protection of virtual machines. For example, you
can exclude or include virtual machines in scheduled backup services,
specify the retention policy for backups, set the data consistency of
snapshots, or select the virtual machine disks to protect.

If the data protection tags already exist, running the set vmtags
command does not create the tags again.

If you are upgrading from a previous version of the data mover, running
the set vmtags command again will create any new tags that are available
in the new version of the data mover.

Requirements: Before you run the set vmtags command, ensure that the
following requirements are met:

*  VMware vCenter Server must be at version 6.0 Update 1 or later.

*  The vmchost option must be configured in the dsm.opt file on Windows
   data movers or dsm.sys file on Linux data movers. The user name and
   password that are associated with the vmchost value must also be set.
   If not already set, you can use the dsmc set password command to set
   the user name and password.

Supported clients

This command is valid only on supported Linux x86_64 clients that are
installed on a vStorage backup server that protects VMware assets.

Syntax

>>-SET VMTAGS--------------------------------------------------><



Parameters

No parameters are required for this command.

Examples

Task
         Create data protection tags and categories that can be added to
         VMware inventory objects:

         dsmc set vmtags

Related reference
2.57.1.2 Supported data protection tags
3.4.206 Vmchost
3.4.233 Vmtagdatamover
2.56 Set Password


2.57.1 Data protection tagging overview


To manage data protection of virtual machines, you can assign IBM
Spectrum Protect tags to VMware inventory objects. You can assign tags
to VMware objects by specifying data protection settings in the IBM
Spectrum Protect vSphere Client plug-in of the vSphere Web Client. If
you do not use the IBM Spectrum Protect vSphere Client plug-in, you can
assign tags by using scripting tools such as VMware Power CLI.

If you enable tagging support to manage backups, you can manage the
protection of virtual machines, such as excluding or including virtual
machines in scheduled backup services, or assigning a schedule to
protect virtual machines in a container. For tags that are related to
schedules, the virtual machines must be in a protection set that is
protected by a schedule. A protection set consists of the virtual
machines in a container that is assigned the Schedule (IBM Spectrum
Protect) tag.

You can also specify the retention policy for backups, set the data
consistency of snapshots, specify the virtual machine disks to protect,
or enable application protection with the IBM Spectrum Protect vSphere
Client plug-in.

The following VMware inventory objects are the containers that you can
use to manage virtual machine backups:

*  Datacenter

*  Folder (Host and Cluster folders and VM and Template folders)

*  Host

*  Host cluster

*  Resource pool

*  Virtual machine

When tagging support is enabled, you can assign data protection tags to
VMware containers. If you do not use the IBM Spectrum Protect vSphere
Client plug-in, you must run the set vmtags command to create data
protection categories and tags in the VMware inventory.

When the vmtagdatamover option is set to yes, all tags that are assigned
to a virtual machine are backed up during backup vm operations. The tags
are restored when the restore vm command is run. Tags that are assigned
to other inventory objects are not backed up and cannot be restored.


2.57.1.1 Representation of tags in the IBM Spectrum Protect vSphere
Client plug-in


When you specify data protection settings in the IBM Spectrum Protect
window in the IBM Spectrum Protect vSphere Client plug-in, data
protection tags are assigned to the inventory object.

For example, if you selected Yes in the Exclude from backup field, the
Backup Management (IBM Spectrum Protect) category and Excluded tag are
assigned to the inventory object. The assigned tag and category are
displayed in the Tags portlet in the Summary tab of the inventory
object.


2.57.1.2 Supported data protection tags


IBM Spectrum Protect data protection tags can be assigned to VMware
inventory objects to control how virtual machine backups are managed.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

If you use the IBM Spectrum Protect vSphere Client plug-in to configure
backup policy, you do not need to manually assign the tags and
categories to inventory objects. You can use the IBM Spectrum Protect
window to specify data protection settings for inventory objects in the
vSphere Web Client. This action is equivalent to assigning tags to an
inventory object.

If you use scripting tools for tagging, you can use the set vmtags
command on the data mover command line to create the tags and categories
in the vSphere inventory.

Unless otherwise stated, you can assign data protection tags to the
following types of inventory objects:

*  Datacenter

*  Folder (Host and Cluster folders and VM and Template folders)

*  Host

*  Host cluster

*  Resource pool

*  Virtual machine

The following data protection tags are supported.

+-----------------------+----------------------+----------------------+
| Category              | Tag                  | Tag description      |
+-----------------------+----------------------+----------------------+
| Application           | Enabled              | Application          |
| Protection (IBM       |                      | protection is        |
| Spectrum Protect)     |                      | provided by IBM      |
|                       |                      | Spectrum Protect     |
+-----------------------+----------------------+----------------------+
| Application           | EnabledKeepSqlLog    | Protect Microsoft    |
| Protection (IBM       |                      | SQL Server and keep  |
| Spectrum Protect)     |                      | log files for        |
|                       |                      | in-guest log file    |
|                       |                      | management           |
+-----------------------+----------------------+----------------------+
| Backup Management     | Excluded             | The object is always |
| (IBM Spectrum         |                      | excluded from        |
| Protect)              |                      | backups by IBM       |
|                       |                      | Spectrum Protect     |
+-----------------------+----------------------+----------------------+
| Backup Management     | Included             | The object is always |
| (IBM Spectrum         |                      | included in backups  |
| Protect)              |                      | by IBM Spectrum      |
|                       |                      | Protect              |
+-----------------------+----------------------+----------------------+
| Data Mover (IBM       | Datamover_name       | The data mover used  |
| Spectrum Protect)     |                      | for backups in IBM   |
|                       |                      | Spectrum Protect     |
+-----------------------+----------------------+----------------------+
| Data Mover (IBM       | Default Data Mover   | The default data     |
| Spectrum Protect)     |                      | mover that is        |
|                       |                      | assigned to a        |
|                       |                      | schedule, if any, is |
|                       |                      | used for backups in  |
|                       |                      | IBM Spectrum Protect |
+-----------------------+----------------------+----------------------+
| Disk Backup List (IBM | Include |            | The list of virtual  |
| Spectrum Protect      | Exclude:disk         | disks included or    |
|                       | number,disk          | excluded in backups  |
|                       | number,...           | by IBM Spectrum      |
|                       |                      | Protect              |
+-----------------------+----------------------+----------------------+
| Local Backup          | LocalIncluded        | The object is        |
| Management (IBM       |                      | included in local    |
| Spectrum Protect)1    |                      | backups on the       |
|                       |                      | hardware storage     |
+-----------------------+----------------------+----------------------+
| Local Backup          | LocalExcluded        | The object is        |
| Management (IBM       |                      | excluded from local  |
| Spectrum Protect)1    |                      | backups on the       |
|                       |                      | hardware storage     |
+-----------------------+----------------------+----------------------+
| Local Management      | Management_class_nam | The policy that is   |
| Class (IBM Spectrum   | e                    | used for retention   |
| Protect)1             |                      | settings for local   |
|                       |                      | backups on the       |
|                       |                      | hardware storage     |
+-----------------------+----------------------+----------------------+
| Management Class (IBM | Management_class_nam | The policy used for  |
| Spectrum Protect)     | e                    | retention settings   |
|                       |                      | in IBM Spectrum      |
|                       |                      | Protect              |
+-----------------------+----------------------+----------------------+
| Schedule (IBM         | Schedule_name        | The schedule to use  |
| Spectrum Protect)     |                      | for backups by IBM   |
|                       |                      | Spectrum Protect     |
+-----------------------+----------------------+----------------------+
| Schedule (IBM         | Schedule_group       | The schedule group   |
| Spectrum Protect)     |                      | to use for backups   |
|                       |                      | by IBM Spectrum      |
|                       |                      | Protect              |
+-----------------------+----------------------+----------------------+
| Snapshot Attempts     | quiesce,nonquiesce   | The number of        |
| (IBM Spectrum         |                      | quiesced and         |
| Protect)              |                      | nonquiesced          |
|                       |                      | snapshots to attempt |
|                       |                      | by IBM Spectrum      |
|                       |                      | Protect before the   |
|                       |                      | backup fails         |
+-----------------------+----------------------+----------------------+

1 This category and tag apply only to virtual machines that are stored
in a VVOL datastore.

IBM Spectrum Protect category and tag names are case sensitive. The
category and tag combinations are defined as follows:

Application Protection (IBM Spectrum Protect)
         Enabled
                  Notifies virtual machine applications that a backup is
                  about to occur. This category and tag combination
                  allows an application to truncate logs and commit
                  transactions so that the application can resume from a
                  consistent state when the backup is completed.

                  When a virtual machine is assigned this category and
                  tag, application protection is provided by IBM
                  Spectrum Protect. The data mover freezes and thaws VSS
                  writers and truncates application logs. If a virtual
                  machine is not assigned this tag, application
                  protection is provided by VMware, which freezes and
                  thaws the VSS writers, but does not truncate
                  application logs.

                  You can assign this tag and category only to virtual
                  machines.

                  When you assign this category and tag to a virtual
                  machine, you must complete an additional configuration
                  step. On each data mover that you are using to back up
                  virtual machines, store the guest virtual machine
                  credentials to Data Protection for VMware by running
                  the following command from the data mover command
                  line:

                  dsmc set password -type=vmguest vm_guest_display_name guest_admin_ID
                     guest_admin_pw

                  Where vm_guest_display_name specifies the name of the
                  guest virtual machine as shown in the VMware vSphere
                  Web Client.

                  This command stores the guest virtual machine
                  credentials, which are encrypted on the system that
                  hosts the data mover. The following minimum
                  permissions are required for guest_admin_ID
                  guest_admin_pw:

                     Backup rights: Microsoft Exchange Server 2013 and
                     2016: Organization Management permissions
                     (membership in the management role group,
                     Organization Management)
                     Backup rights: Microsoft SQL Server 2014 and 2016:
                     Organization Management permissions (membership in
                     the management role group, Organization Management)

                  If you use the same credentials to log on to multiple
                  virtual machines that are enabled for application
                  protection, you can set the password for the all of
                  the virtual machines by specifying the allvm parameter
                  in the following command:

                  dsmc set password -type=vmguest allvm guest_admin_ID guest_admin_pw



                  If you do not enable application protection, the
                  setting in the include.vmtsmvss option is used. This
                  setting cannot be inherited.

                  This tag overrides the include.vmtsmvss option.

         EnabledKeepSqlLog
                  Provides application protection and prevents Microsoft
                  SQL Server logs from being truncated when a data mover
                  backs up a virtual machine that is running a Microsoft
                  SQL Server. Specifying this tag enables the SQL server
                  administrator to manually manage the SQL server logs,
                  so that they can be preserved and be used to restore
                  SQL transactions to a specific checkpoint after the
                  virtual machine is restored. The SQL server
                  administrator must manually back up, and possibly
                  truncate the SQL server logs on the guest virtual
                  machine.

                  You can assign this tag and category only to virtual
                  machines. In addition to this tag, you must assign the
                  Enabled tag to the virtual machines.

                  When this tag is specified, the SQL server log is not
                  truncated and the following message is displayed and
                  logged on the IBM Spectrum Protect server:

                  ANS4179I IBM Spectrum Protect application protection
                  did not truncate the Microsoft SQL Server logs on VM 'VM'.

                  If you need to enable truncation of the SQL server
                  logs after a backup is completed, remove the
                  EnabledKeepSqlLog tag and assign the Application
                  Protection (IBM Spectrum Protect) Enabled category and
                  tag to the virtual machine. In this case, the data
                  mover does not back up the SQL log files.

                  If you do not set this tag, Microsoft SQL Server logs
                  are not retained during application protection enabled
                  backup. This tag cannot be inherited.

                  This tag overrides the keepsqllog parameter in the
                  include.vmtsmvss option.

Backup Management (IBM Spectrum Protect)
         Excluded
                  Excludes the virtual machines in an inventory object
                  from scheduled backup services.

         Included
                  Includes the virtual machines in an inventory object
                  in scheduled backup services. This tag is the default
                  for the Backup Management (IBM Spectrum Protect)
                  category and typically does not need to be set.

                  Use this tag when a parent object is assigned the
                  Excluded tag, or if you want to make sure that virtual
                  machines in an object are always included in scheduled
                  backups, regardless of any inheritance settings.

         If you do not assign these tags, and no inherited setting
         exists, virtual machines are included in scheduled backups.

         These tags override the domain.vmfull data mover option.

Data Mover (IBM Spectrum Protect)
         Datamover_name
                  Assigns a data mover to run backups of virtual
                  machines.

                  If you use the IBM Spectrum Protect vSphere Client
                  plug-in, data movers are automatically assigned to
                  virtual machines if you apply the Schedule category
                  and tag to a container. However, you can also manually
                  update data movers for individual virtual machines.

                  If you do not use the IBM Spectrum Protect vSphere
                  Client plug-in to apply the Schedule tag to a
                  container, you must manually assign data mover tags to
                  those virtual machines, or their parent containers,
                  that are in that schedule.

                  If you do not assign a data mover to a virtual
                  machine, the data mover is inherited from the parent
                  object. If no inherited setting exists, or the Default
                  Data Mover tag is set or inherited, the virtual
                  machines are backed up by the default data mover that
                  is assigned to a schedule, if any. Otherwise, the
                  virtual machines are not backed up and are identified
                  in the IBM Spectrum Protect vSphere Client plug-in
                  with the At Risk status until a data mover is assigned
                  to the virtual machines.

                  This tag overrides the nodename data mover option.

         Default Data Mover
                  Assigns the default data mover for a schedule, if any,
                  to run backups of virtual machines. If the schedule
                  does not have a default data mover, the virtual
                  machines are not backed up and are identified in the
                  IBM Spectrum Protect vSphere Client plug-in with the
                  At Risk status until a data mover is assigned to the
                  virtual machines or the schedule is assigned a default
                  data mover.

Disk Backup List (IBM Spectrum Protect)
         Include | Exclude:disk number,disk number,...
                  Includes or excludes a set of virtual machine hard
                  disks in backup operations. Virtual machine hard disks
                  are identified by the disk number in the virtual
                  machine. For example, in most cases, disk 1 is the
                  system disk. If you do not assign this tag to a
                  virtual machine, all hard disks in the virtual machine
                  are backed up.

                  For ease of use, the Disk Backup List (IBM Spectrum
                  Protect) category is prepopulated with several
                  commonly used tags:

                  Include:all
                           Includes all disks in a backup.

                  Include:1
                           Includes only disk 1 in a backup, and
                           explicitly excludes all other disks.

                  Exclude:1
                           Includes all disks except for disk 1 in a
                           backup.

                  You can modify the disk numbers to suit your needs.
                  You can specify a disk number in the range 1 - 999.
                  The disk numbers must be listed as comma-separated
                  values, with no spaces between the commas and numbers.

                  For example, to include only disks 1, 3, and 5 in
                  backups, assign the Disk Backup List (IBM Spectrum
                  Protect) category and Include:1,3,5 tag to a virtual
                  machine.

                  To back up all disks except for 1, 2, and 4, assign
                  the Disk Backup List (IBM Spectrum Protect) category
                  and Exclude:1,2,4 tag to a virtual machine.

                  If you do not specify the disks to include or exclude
                  and no inherited setting exists, all virtual machine
                  disks are backed up.

                  These tags override the include.vmdisk and
                  exclude.vmdisk data mover options.

Local Backup Management (IBM Spectrum Protect)
         LocalExcluded
                  Excludes snapshots for virtual machines in an
                  inventory object from the scheduled backup services.

         LocalIncluded
                  Includes snapshots for virtual machines in an
                  inventory object in the scheduled backup services.
                  This tag is the default for the Local Backup
                  Management (IBM Spectrum Protect) category and
                  typically does not need to be set.
                  Use this tag when a parent object is assigned the
                  LocalExcluded tag, or if you want to make sure that
                  snapshots for virtual machines in an object are always
                  included in scheduled backups, regardless of any
                  inheritance settings.

         If you do not assign these tags, and no inherited setting
         exists, virtual machines are included in scheduled backups.

         These tags override the domain.vmfull data mover option.

Local Management Class (IBM Spectrum Protect)
         Management_class_name
                  Specifies the name of the retention policy that
                  defines how long snapshot versions are kept on the
                  hardware storage or how many snapshot versions can
                  exist on the storage before they are expired.

                  If you do not specify the management class, the
                  retention policy is inherited from a parent object. If
                  no inherited setting exists, the management class that
                  is specified in the vmmc option is used. If the vmmc
                  option is not set, the default retention policy for
                  the datacenter node is used.

                  This tag overrides the include.vmlocalsnapshot option.

Management Class (IBM Spectrum Protect)
         Management_class_name
                  Specifies the name of the retention policy that
                  defines how long backup versions are kept on the IBM
                  Spectrum Protect server or how many backup versions
                  can exist on the server before they are expired.

                  If you do not specify the management class, the
                  retention policy is inherited from a parent object. If
                  no inherited setting exists, the management class that
                  is specified in the vmmc option is used. If the vmmc
                  option is not set, the default retention policy for
                  the datacenter node is used.

                  This tag overrides the include.vm, vmmc, or vmctlmc
                  options.

Schedule (IBM Spectrum Protect)
         Schedule_name
                  Specifies the name of the schedule that is used for
                  virtual machine backups to the IBM Spectrum Protect
                  server. The schedule name must be unique.

                  Schedules are set up by the IBM Spectrum Protect
                  server administrator or VMware administrator to
                  automatically back up virtual machines in your vSphere
                  inventory. For ease of use, administrators can use IBM
                  Spectrum Protect Operations Center 8.1 to create
                  schedules that are compatible with tagging.

                  When you assign this category and tag to a virtual
                  machine, all virtual machines at the inventory object
                  level and any child object levels are backed up
                  according to the schedule.

                  Only schedules with the -domain.vmfull="Schedule-Tag"
                  option (and no other domain-level parameters) in the
                  schedule definitions are compatible with tagging
                  support. Otherwise, the Schedule tag is ignored, and
                  virtual machines in inventory objects that are tagged
                  with non-compatible schedules are not backed up.

                  To be compatible with tagging, the following criteria
                  must be included in the schedule definition:

                  *  The -domain.vmfull="Schedule-Tag" option (and no
                     other domain-level parameters) must be specified in
                     the option string. The option is case insensitive
                     and must contain no spaces. The quotation marks
                     that enclose the Schedule-Tag parameter are
                     optional.

                  *  The schedule must contain the ACTION=BACKUP and
                     SUBACTION=VM parameters.

                  *  The option string must contain the
                     -asnodename=datacenter option, where the value for
                     the datacenter parameter must correspond to the
                     datacenter that is being managed by the IBM
                     Spectrum Protect vSphere Client plug-in.

                  *  If the -vmbackuptype=backuptype option is specified
                     in the option string, the value for the backuptype
                     parameter must be FULLVM (case insensitive).

                  The following sample server command defines a schedule
                  that is compatible with tagging:

                  define schedule domain_name schedule_name
                  description=schedule_description action=backup subaction=VM
                  starttime=NOW+00:10 schedstyle=Classic period=1 perunits=Weeks
                  durunits=minutes duration=10 options='-vmbackuptype=fullvm
                  -asnodename=datacenter_node_name -mode=IFIncremental
                  -domain.vmfull="Schedule-Tag"'

                  The server administrator must also associate a data
                  mover with the schedule by using the following server
                  command:

                  define association domain_name schedule_name data_mover_node_name

                  This category and tag can be assigned to datacenters,
                  folders, hosts, host clusters, resource pools, and
                  virtual machines.

                  Tip: If you assign the Schedule tag to a container
                  without using the IBM Spectrum Protect vSphere Client
                  plug-in, the Data Mover category and tag are not
                  automatically assigned to the virtual machines in the
                  container. You must manually assign the Data Mover tag
                  to each virtual machine. Alternatively, if a schedule
                  is associated with only one data mover, you can assign
                  the data mover directly to the container that is
                  protected by the schedule.

                  If you do not set this tag on an object, the Schedule
                  tag is inherited from the parent object. If no
                  inherited setting exists, virtual machines are not
                  included in any scheduled backups.

                  Any domain-level parameters in the domain.vmfull data
                  mover option are ignored for a schedule that is
                  compatible with tagging.

         Schedule_group
                  Specifies the name of the schedule group that is used
                  for virtual machine backups. A schedule group contains
                  multiple schedules. You can use the IBM Spectrum
                  Protect vSphere Client plug-in to assign the schedule
                  group to an object in the VMware vSphere Web client
                  rather than an individual schedule. An example of the
                  use of this option is to group multiple daily local
                  backup schedules with a single IBM Spectrum Protect
                  server backup schedule.

Snapshot Attempts (IBM Spectrum Protect)
         quiesce,nonquiesce
                  This category and tag combination specifies the total
                  number of snapshot attempts for a virtual machine
                  backup operation that fails due to snapshot failure.
                  The tag value consists of a pair of positional
                  parameters, which describe the number of times to
                  attempt a snapshot and the data consistency to achieve
                  during the attempt.

                  quiesce
                           A positional parameter that specifies the
                           number of times to attempt the snapshot with
                           quiescing, which creates an
                           application-consistent snapshot.

                           *  For Windows virtual machines assigned with
                              the Application Protection tag, the
                              quiesce parameter specifies the number of
                              times to attempt the snapshot with IBM
                              Spectrum Protect VSS quiescing and
                              Microsoft Windows system provider VSS
                              quiescing.

                              Depending on the number that you specify,
                              the first snapshot attempt is always made
                              with IBM Spectrum Protect VSS quiescing.
                              Subsequent snapshot attempts are made with
                              Windows system provider VSS quiescing.

                           *  For Windows virtual machines without the
                              Application Protection tag or for Linux
                              virtual machines, the quiesce parameter
                              specifies the number of times to attempt
                              the snapshot with VMware Tools file system
                              quiescing.

                           You can specify a value in the range 0 - 10.
                           The default value is 2.

                  nonquiesce
                           A positional parameter that specifies the
                           number of times to attempt the snapshot
                           without quiescing, after the snapshot
                           attempts with quiescing (as specified by the
                           quiesce parameter) are completed. Without
                           snapshot quiescing, crash-consistent
                           snapshots are created. With crash-consistent
                           snapshots, operating system, file system, and
                           application consistency are not guaranteed.

                           You can specify a value in the range 0 - 10.
                           The default value is 0.

                  Restriction: The 0,0 entry is not valid. Backup
                  operations require at least one snapshot.

                  The following snapshot attempts are common choices to
                  use for data consistency:

                  2,0 - Always application consistent
                           Attempts two quiesced snapshots before
                           failing the backup. This combination is the
                           default.

                  2,1 - Attempt application consistent
                           Attempts two quiesced snapshots and, as a
                           final attempt, a nonquiesced,
                           crash-consistent snapshot.

                  0,1 - Machine consistent only
                           Attempts only a nonquiesced snapshot for
                           virtual machines that can never complete a
                           quiesced snapshot.

         If you do not specify the snapshot attempts and no inherited
         setting exists, the snapshot attempts that are specified in the
         include.vmsnapshotattempts option are used.

         This tag overrides the include.vmsnapshotattempts option.

Tip: Data protection tags can be inherited from higher-level inventory
objects. For more information, see 2.57.1.3 Inheritance of data
protection settings.

Related reference
3.4.143 Schedgroup
3.4.233 Vmtagdatamover
3.4.234 Vmtagdefaultdatamover
3.4.46 Domain.vmfull
3.4.86.4.2 Include.vmdisk
3.4.86.4.5 INCLUDE.VMSNAPSHOTATTEMPTS
3.4.86.4.6 INCLUDE.VMTSMVSS


2.57.1.3 Inheritance of data protection settings


IBM Spectrum Protect data protection settings, or tags, can be
inherited, or passed down, from a higher-level parent inventory object
in the vSphere Web Client navigator.

When you assign a data protection tag to an inventory object in the
vSphere Web Client, the child objects inherit the same data protection
tag as the parent inventory object that the tag was assigned to.

The following list shows the types of vSphere inventory objects that can
be tagged and can inherit data protection tags:

*  Datacenter

*  Folder (Host and Cluster folders and VM and Template folders)

*  Host

*  Host cluster

*  Resource pool

*  Virtual machine

For example, if you assign the Excluded tag to a host cluster, the child
objects of the host cluster object (host, host folder, and virtual
machine) all inherit the Excluded tag. In this example, all virtual
machines that are within the host cluster are excluded from scheduled
backups.

If a child object is assigned a tag and inherits tags in the same
category, the assigned tag of the child object overrides the inherited
tag. If a child object inherits tags in the same category from multiple
ancestor objects, the tag that is inherited from the nearest ancestor
overrides tags from other ancestors.

If no data protection tags are assigned in the vSphere inventory
hierarchy, the system default tag settings are applied. For information
about the supported tags and any default tag settings, see 2.57.1.2
Supported data protection tags.

Order of precedence for inheritance

Depending on the object (target object) that you are trying to assign a
data protection tag to, a precedence exists for determining the distance
from the target object to its ancestors during processing of tag
inheritance from multiple ancestors. The following table contains target
objects and the possible ancestors of each target object type, based on
the hierarchy of objects that is presented in the vSphere Web Client
Navigator.

Table 36. Order of precedence of vSphere inventory objects

+--------------------+------------------------------------------------+
| Target object      | Order of precedence of tags processed          |
+--------------------+------------------------------------------------+
| Virtual machine    | Target virtual machine > Nested VM folders >   |
|                    | Nested resource pools > Host > Host cluster >  |
|                    | Nested host folders > Datacenter               |
+--------------------+------------------------------------------------+
| VM folder          | Target VM folder > Other nested VM folders >   |
|                    | Datacenter                                     |
+--------------------+------------------------------------------------+
| Host folder        | Target host folder > Other nested host folders |
|                    | > Datacenter                                   |
+--------------------+------------------------------------------------+
| Resource pool      | Target resource pool > Other nested resource   |
|                    | pool > Nested VM folders > Host > Host cluster |
|                    | > Nested host folders > Datacenter             |
+--------------------+------------------------------------------------+
| Host               | Target host > Nested host folders > Cluster >  |
|                    | Datacenter                                     |
+--------------------+------------------------------------------------+
| Cluster            | Target cluster > Nested host folders >         |
|                    | Datacenter                                     |
+--------------------+------------------------------------------------+
| Datacenter         | Target datacenter                              |
+--------------------+------------------------------------------------+

If the target object is a virtual machine, the virtual machine itself,
and any combinations of its ancestors (including VM folders, resource
pools, host, host cluster, host folders, datacenter) can be assigned
tags from the same category. During processing, each object type is
checked in the order of precedence, and processing stops when a tag in
the same category is found or the end of the list is reached.

For example, to determine whether the Excluded or Included tag Backup
Management (IBM Spectrum Protect) is applied to virtual machines, IBM
Spectrum Protect searches for the Excluded and Included tags in the
inventory in a datacenter. According to the order of precedence for the
virtual machine target object, the search for the Excluded and Included
tags starts from the target object (virtual machine) itself, followed by
the list of potential ancestors. If a tag is found before the end of the
list is reached, this tag is applied to the target object. Otherwise, no
tag from the Backup Management (IBM Spectrum Protect) category is
applied to the target virtual machine.

Related concepts
2.57.1.4 Tips for data protection tagging

Related reference
2.57.1.2 Supported data protection tags


2.57.1.4 Tips for data protection tagging


Backup policies are determined by the data protection tag assignments on
vSphere inventory objects. The performance for processing data
protection tags can also be affected by the number of tags that are
applied to the vSphere inventory and where the tags are applied.

Consider taking the following actions when you define the backup policy
for objects in the vSphere inventory:

*  Take advantage of the order of precedence for tagging inventory
   objects. Create a general policy configuration for an organization by
   setting backup policies (or tags) on the highest container in the
   vSphere inventory hierarchy. The policies are inherited by child
   containers and their virtual machines. In general, you do not need to
   set policies on individual virtual machines.

   Then, create exceptions by changing the policy on a child container
   or individual virtual machines to override the inherited policy
   setting.

   Alternatively, if you do not want to configure an overall backup
   policy, do not assign data protection tags to any high-level objects.
   Assign the data protection tags to lower-level objects.

*  For ease of maintenance, performance, and usability, avoid assigning
   tags to too many inventory objects.

*  For ease of maintenance and reduced complexity, avoid assigning tags
   to different object types. For example, assign tags to clusters,
   hosts, host folders and VMs only, or to VM folders and VMs only, but
   not both at the same time.

*  With tagging support, you can assign multiple schedules to multiple
   data movers. However, do not overlap the schedules for a data mover.
   Otherwise, some schedules will be skipped.

*  For ease of use, administrators can use IBM Spectrum Protect
   Operations Center 8.1 to create schedules that are compatible with
   tagging.

Related concepts
2.57.1.3 Inheritance of data protection settings


3.0 Processing options


You can use defaults for processing client options or you can tailor the
processing options to meet your specific needs. Read about an overview
of processing options and explore the options reference that provides
detailed information about each option.




3.1 Server options


Use the servername option in your dsm.sys file to begin a group of
options (stanzas) used to connect to the IBM Spectrum Protect server.

You can set up multiple groups of stanzas in the dsm.sys file to connect
to different servers. Each servername stanza must have listed below it
all client option stanzas required to establish communication with a
server. The stanza list can also contain other options for
backup-archive operations.

If your client system-options file contains only one stanza - Your
client node contacts the server you specify in that stanza for all
services.

If your client system-options file contains more than one stanza - You
can specify a default server with the defaultserver option. If you do
not specify a default server, IBM Spectrum Protect contacts the server
you specify in the first stanza of your dsm.sys file.

Place the defaultserver option at the beginning of your dsm.sys file
before any server stanzas. See 3.4.32 Defaultserver for more
information.

Use the servername option in the client user-options file (dsm.opt) or
on the command line to specify a server to contact for backup-archive
services. This overrides the default server specified in your (dsm.sys)
file.

Note: You cannot override the migration server specified in the client
system-options file.

Table 37 shows a sample dsm.sys file.

Table 37. Sample client system-options file

+----------------------------------------------------------------------+
| Sample dsm.sys file                                                  |
+----------------------------------------------------------------------+
| DEFAULTServer server2                                                |
|                                                                      |
| SErvername server1                                                   |
|  NODename node1                                                      |
|  COMMMethod TCPip                                                    |
|  TCPPort 1500                                                        |
|  TCPServeraddress node.domain.company.com                            |
|  PASSWORDAccess generate                                             |
|  GRoups system adsm                                                  |
|  USERs ashton stewart kaitlin                                        |
|  INCLExcl /adm/adsm/backup1.excl                                     |
|                                                                      |
| SErvername server2                                                   |
|  COMMMethod SHAREdmem                                                |
|  shmport 1520                                                        |
|  PASSWORDAccess prompt                                               |
|  GRoups system adsm                                                  |
|  USERs danielle derek brant                                          |
|  INCLExcl /adm/adsm/backup2.excl                                     |
+----------------------------------------------------------------------+


3.2 Setting options in an options file


This section describes how to set options in your client options file
(dsm.opt), and how to use options with commands.

This section describes how to set options in your dsm.sys file or client
user-options file (dsm.opt), and how to use options with commands.

To view or modify an options file, click Edit -> Client Preferences from
the backup-archive client Java GUI. The Preferences editor updates the
options file.

You can also edit the options file with your favorite text editor.

To set an option in the options file enter the option name and one or
more blank spaces, followed by the option value. For example:

   compression  yes
   nodename     client_a

Some options consist of only the option name, such as verbose and quiet.
You can enter the entire option name or its abbreviation. For example,
you can specify the verbose option as either of the following:

   verbose
   ve

Follow these additional rules when entering options in your dsm.sys file
or client user-options file (dsm.opt):

*  Begin each comment with an asterisk (*) as the first character in a
   line.
*  Do not enter comments on the same line as an option.
*  Indent options with spaces or tabs.
*  Enter each option on a separate line and enter all parameters for an
   option on the same line. For example, to specify a group of five
   different file systems as your default client domain, enter:

      domain /home /mfg /planning /mrkting /mgmt
*  Enter one or more blank spaces between parameters.
*  Use blank lines between options.
*  The maximum number of characters for a file name is 256. The maximum
   combined length of the file name and path name is 1024 characters.
   The Unicode representation of a character can occupy several bytes,
   so the maximum number of characters that a file name might contain
   can vary.

If you update the dsm.sys file or client user-options file (dsm.opt)
while a session is active, you must restart the session to pick up the
changes.

You can use the query options command to display all or part of your
options and their current settings. This command accepts an argument to
specify a subset of options. The default is to display all options.

See the QUERY OPTIONS topic for more information.


3.3 Using options with commands


You can override some of the options in your client options file
(dsm.opt) file by entering them with appropriate backup-archive client
commands.

You can override some of the options in your dsm.sys file or client
user-options file (dsm.opt) by entering them with appropriate
backup-archive client commands.

The client processes options in the following order (precedence):

1. Options defined on the server with server-enforced client options.
   The server overrides client values.
2. Options entered locally on the command line.
3. Options defined on the server for a schedule using the options
   parameters.
4. Options entered locally in the options file.
5. Options received from the server with client option sets not set as
   forced by the server. The server does not override client values if
   not forced.
6. Default option values.


3.3.1 Entering options with a command


You must follow the general rules for entering options with a command.

*  Enter a command, a dash (–), the option name, an equal sign (=), and
   the option value or parameter. Do not include spaces on either side
   of the = sign.

   The following command shows an example of this syntax on an AIX,
   Linux, Solaris, or Mac client.

      dsmc archive -description="year end 1999" /home/



*  For options that do not include parameters, enter a command, a dash
   (–), and the option name. For example,

      dsmc incremental -quiet



   Note: Use a leading dash (-) to indicate that the following text is
   the name of an option. If an object name begins with a dash, you must
   surround it in either single quotation marks (') or quotation marks
   ("). Most operating system command line processors strip the
   quotation marks before the command-line arguments are submitted to
   the IBM Spectrum Protect client application. In such cases, by using
   escape characters or doubling the quotation marks allows the client
   to receive the quoted object name. In loop mode, surround such
   objects in either single quotation marks (') or quotation marks (").

*  Enter either the option name, or an abbreviation for the option name.
   For example, to enter the latest option, enter either -lat or
   -latest. The capital letters in the syntax of each option indicate
   the minimum abbreviation for that option name.

*  Enter options before or after command parameters. For example, you
   can enter the option before or after a file specification:

      dsmc selective -subdir=yes "/home/devel/proj1/*"
      dsmc selective "/home/devel/proj1/*" -subdir=yes



*  When you enter several options on a command, separate them with a
   blank space.

*  Enclose the value in quotation marks (" ") if the option value that
   you enter contains a blank space. For example:

      dsmc archive -description="Project A" "/home/devel/proj1/*"



*  Most options that you enter on the command line override the value
   that is set in the preferences file. However, when you use the domain
   option with the incremental command, it adds to the domain specified
   in your client options file rather than overriding the current value.

*  On AIX, Solaris, Linux on z, and Mac: The maximum number of
   characters for a file name is 255. The maximum combined length of the
   file name and path name is 1024 characters. The Unicode
   representation of a character can occupy several bytes, so the
   maximum number of characters that a file name might contain can vary.

*  On Linux: The maximum length for a file name is 255 bytes. The
   maximum combined length of both the file name and path name is 4096
   bytes. This length matches the PATH_MAX that is supported by the
   operating system. The Unicode representation of a character can
   occupy several bytes, so the maximum number of characters that
   comprises a path and file name can vary. The actual limitation is the
   number of bytes in the path and file components, which might or might
   not correspond to an equal number of characters.

   On Linux: For archive or retrieve operations, the maximum length that
   you can specify for a path and file name (combined) remains at 1024
   bytes.

*  For Mac OS X, the maximum length of a file name is limited to 504
   bytes (not characters). The Unicode representation of a character can
   occupy several bytes, so the maximum number of characters that a file
   name contains can vary.

Table 38 lists client command options that you can enter only on the
command line with specific commands.

Table 38. Client command options

+-----------------+----------------------------------+----------------+
| Command option    Description                        Commands       |
+-----------------+----------------------------------+----------------+
| archmc            Use the archmc option with the     archive        |
|                   archive command to specify the                    |
|                   available management class for                    |
|                   your policy domain to which you                   |
|                   want to bind your archived                        |
|                   files.                                            |
+-----------------+----------------------------------+----------------+
| class             Specifies whether to display a     query backup   |
|                   list of NAS objects or client      delete         |
|                   objects when you use the           filespace      |
|                   following commands.                query          |
|                                                      filespace      |
+-----------------+----------------------------------+----------------+
| console           Use the console option with the    query          |
|                   query systeminfo command to        systeminfo     |
|                   output system information to the                  |
|                   console.                                          |
+-----------------+----------------------------------+----------------+
| deletefiles       Deletes the local copy of files    archive        |
|                   from your workstation after they                  |
|                   are archived on the server.                       |
+-----------------+----------------------------------+----------------+
| deletefiles       Deletes the local copy of files    archive        |
|                   from your workstation after they   restore image  |
|                   are archived on the server. Can                   |
|                   also be used with the restore                     |
|                   image command and the                             |
|                   incremental option to delete                      |
|                   files from the restored image                     |
|                   that are deleted from the file                    |
|                   space after the image is                          |
|                   created.                                          |
+-----------------+----------------------------------+----------------+
| description       Assigns or specifies a             archive        |
|                   description for files when         delete archive |
|                   archive, delete, retrieve, or      query archive  |
|                   query archive operations are       query          |
|                   performed.                         backupset      |
|                                                      retrieve       |
+-----------------+----------------------------------+----------------+
| detail            Displays management class, file    delete         |
|                   space, backup, and archive         filespace      |
|                   information, depending on the      query archive  |
|                   command with which it is used.     query backup   |
|                                                      query          |
|                                                      filespace      |
|                                                      query          |
|                                                      mgmtclass      |
+-----------------+----------------------------------+----------------+
| dirsonly          Backs up, restores, archives,      archive        |
|                   retrieves, or queries              incremental    |
|                   directories only.                  query archive  |
|                                                      query backup   |
|                                                      restore        |
|                                                      restore        |
|                                                      backupset      |
|                                                      retrieve       |
|                                                      selective      |
+-----------------+----------------------------------+----------------+
| dynamicimage      Performs a dynamic image backup.   backup image   |
+-----------------+----------------------------------+----------------+
| filelist          Specifies a list of files to be    archive        |
|                   processed for the command. The     backup group   |
|                   backup-archive client opens the    delete archive |
|                   designated file list and           delete backup  |
|                   processes the files that are       expire         |
|                   listed within according to the     incremental    |
|                   command.                           query archive  |
|                                                      query backup   |
|                                                      restore        |
|                                                      retrieve       |
|                                                      selective      |
+-----------------+----------------------------------+----------------+
| filename          Use the filename option with the   query          |
|                   query systeminfo command to        systeminfo     |
|                   specify a file name in which to                   |
|                   store the system information.                     |
+-----------------+----------------------------------+----------------+
| filesonly         Backs up, restores, retrieves,     archive        |
|                   or queries files only.             incremental    |
|                                                      query archive  |
|                                                      query backup   |
|                                                      restore        |
|                                                      restore        |
|                                                      backupset      |
|                                                      retrieve       |
|                                                      selective      |
+-----------------+----------------------------------+----------------+
| fromdate          Use the fromdate option with the   delete backup  |
|                   fromtime option to specify a       query archive  |
|                   date and time from which you       query backup   |
|                   want to search for backups or      restore        |
|                   archives during a restore,         restore group  |
|                   retrieve, or query operation.      retrieve       |
+-----------------+----------------------------------+----------------+
| fromnode          Permits one node to perform                       |
|                   commands for another node. A       query archive  |
|                   user on another node must use      query backup   |
|                   the set access command to permit   query          |
|                   you to query, restore, or          filespace      |
|                   retrieve files or images for the   query group    |
|                   other node.                        query image    |
|                                                      query          |
|                                                      mgmtclass      |
|                                                      restore        |
|                                                      restore group  |
|                                                      restore image  |
|                                                      retrieve       |
+-----------------+----------------------------------+----------------+
| fromowner         Displays file spaces for another   query archive  |
|                   owner. Also specifies another      query backup   |
|                   owner from which to restore or     query group    |
|                   retrieve files.                    query image    |
|                                                      restore        |
|                                                      restore group  |
|                                                      restore image  |
|                                                      retrieve       |
+-----------------+----------------------------------+----------------+
| fromtime          Specifies a beginning time on      query archive  |
|                   the specified date. Use with the   query backup   |
|                   fromdate option. This option is    restore        |
|                   ignored if the fromdate option     restore group  |
|                   is absent.                         retrieve       |
+-----------------+----------------------------------+----------------+
| groupname         Specifies the fully qualified      backup group   |
|                   name for a group.                                 |
+-----------------+----------------------------------+----------------+
| ifnewer           Replaces existing files with the   restore        |
|                   latest backup version only if      restore        |
|                   the backup version is newer than   backupset      |
|                   the existing version.              restore group  |
|                                                      retrieve       |
+-----------------+----------------------------------+----------------+
| imagetofile       Use the imagetofile option with    restore image  |
|                   the restore image command to                      |
|                   specify that you want to restore                  |
|                   the source image to a file. You                   |
|                   might need to restore the image                   |
|                   to a file in the event of bad                     |
|                   sectors present on the target                     |
|                   volume, or if you want to do                      |
|                   some manipulations with the                       |
|                   image data.                                       |
|                   This option is valid for AIX ,                    |
|                   Linux , and Oracle Solaris                        |
|                   clients.                                          |
|                                                                     |
+-----------------+----------------------------------+----------------+
| inactive          Displays a list of active and                     |
|                   inactive files when used with      delete group   |
|                   the pick option.                   query backup   |
|                                                      query group    |
|                                                      query image    |
|                                                      query nas      |
|                                                      restore        |
|                                                      restore group  |
|                                                      restore image  |
|                                                      restore nas    |
                                                                      |
|                                                                     |
+-----------------+----------------------------------+----------------+
| incrbydate        Requests an incremental backup     incremental    |
|                   by date.                                          |
+-----------------+----------------------------------+----------------+
| incremental       Applies changes to the base        restore image  |
|                   image by using information from                   |
|                   incremental backups that are                      |
|                   made after the original image                     |
|                   backup.                                           |
|                   This option is valid only for                     |
|                   AIX , Linux x86_64, Linux on                      |
|                   POWER , and Oracle Solaris                        |
|                   clients.                                          |
+-----------------+----------------------------------+----------------+
| latest            Restores the most recent backup    restore        |
|                   version of a file whether it is    restore group  |
|                   active or inactive.                               |
+-----------------+----------------------------------+----------------+
| mode              Use the mode option with these     backup group   |
|                   commands, as follows:              backup nas     |
|                   backup image                       backup image   |
|                                                      restore nas    |
|                    To specify whether to perform a                  |
|                   selective or incremental image                    |
|                   backup of client file systems.                    |
|                                                                     |
|                   backup nas                                        |
|                                                                     |
|                    To specify whether to perform a                  |
|                   full or differential image                        |
|                   backup of NAS file systems.                       |
|                                                                     |
|                   backup group                                      |
|                                                                     |
|                    To specify whether to perform a                  |
|                   full or differential group                        |
|                   backup that contains a list of                    |
|                   files from one or more file                       |
|                   space origins.                                    |
|                                                                     |
+-----------------+----------------------------------+----------------+
| monitor           Specifies whether you want to      backup nas     |
|                   monitor an image backup or         restore nas    |
|                   restore of one or more file                       |
|                   systems that belong to a                          |
|                   network-attached storage (NAS)                    |
|                   file server.                                      |
|                                                                     |
|                   Specifies whether you want to                     |
|                   monitor a restore of one or more                  |
|                   file systems that belong to a                     |
|                   network-attached storage (NAS)                    |
|                   file server.                                      |
+-----------------+----------------------------------+----------------+
| nojournal         Use this option with the           incremental    |
|                   incremental command to specify                    |
|                   that you want to perform the                      |
|                   traditional full incremental                      |
|                   backup, instead of the default                    |
|                   journal-based backup.                             |
+-----------------+----------------------------------+----------------+
| noprompt          Suppresses the confirmation        delete archive |
|                   prompt that is presented by the    delete backup  |
|                   delete group , delete archive ,    delete group   |
|                   expire , and set event commands.   expire         |
+-----------------+----------------------------------+----------------+
| noprompt          Suppresses the confirmation        delete archive |
|                   prompt that is presented by the    delete backup  |
|                   delete group , delete archive ,    delete group   |
|                   expire , restore image , and set   expire         |
|                   event commands.                    restore image  |
+-----------------+----------------------------------+----------------+
| optfile           Specifies the client               dsmc           |
|                   user-options file that you want                   |
|                   to use when you start a                           |
|                   backup-archive client session.                    |
+-----------------+----------------------------------+----------------+
| pick              Creates a list of backup           delete archive |
|                   versions, images, or archive       delete group   |
|                   copies that match the file         expire         |
|                   specification you enter. From      query nas      |
|                   the list, you can select the       restore        |
|                   versions to process. Include the   restore group  |
|                   inactive option to view both       restore image  |
|                   active and inactive objects.       restore nas    |
|                                                      retrieve       |
+-----------------+----------------------------------+----------------+
| pitdate           Use the pitdate option with the                   |
|                   pittime option to establish a      query backup   |
|                   point in time for which you want   query group    |
|                   to display or restore the latest   query image    |
|                   version of your backups.           query nas      |
|                                                      restore        |
|                                                      restore group  |
|                                                      restore image  |
|                                                      restore nas    |
                                                                      |
|                                                                     |
+-----------------+----------------------------------+----------------+
| pittime           Use the pittime option with the                   |
|                   pitdate option to establish a      query backup   |
|                   point in time for which you want   query image    |
|                   to display or restore the latest   query nas      |
|                   version of your backups.           restore        |
|                                                      restore image  |
|                                                      restore nas    |
                                                                      |
|                                                                     |
+-----------------+----------------------------------+----------------+
| preservepath      Specifies how much of the source   restore        |
|                   path to reproduce as part of the   restore        |
|                   target directory path when you     backupset      |
|                   restore or retrieve files to a     restore group  |
|                   new location.                      retrieve       |
+-----------------+----------------------------------+----------------+
| removeoperandli   Specifies that IBM Spectrum        incremental    |
| mit               Protect removes the 20-operand     selective      |
|                   limit. If you specify the          archive        |
|                   removeoperandlimit option with     backup image   |
|                   the incremental , selective ,                     |
|                   archive , or backup image                         |
|                   command, the 20-operand limit is                  |
|                   not enforced and is restricted                    |
|                   only by available resources or                    |
|                   other operating system limits.                    |
+-----------------+----------------------------------+----------------+
| showmembers       Displays all members of a group.   query group    |
|                                                      restore group  |
+-----------------+----------------------------------+----------------+
| todate            Use the todate option with the     query archive  |
|                   totime option to specify an        query backup   |
|                   ending date and time to which      restore        |
|                   you want to search for backups     restore group  |
|                   or archives during a restore,      retrieve       |
|                   retrieve, or query operation.                     |
+-----------------+----------------------------------+----------------+
| totime            Use the totime option with the     query archive  |
|                   todate option to specify an        query backup   |
|                   ending date and time to which      restore        |
|                   you want to search for backups     restore group  |
|                   or archives during a restore,      retrieve       |
|                   retrieve, or query operation.                     |
+-----------------+----------------------------------+----------------+
| type              Use the type option with the       query node     |
|                   query node command to specify                     |
|                   the type of node to query.                        |
+-----------------+----------------------------------+----------------+
| v2archive         Use the v2archive option with      archive        |
|                   the archive command to archive                    |
|                   only files to the server. The                     |
|                   client will not process                           |
|                   directories that exist in the                     |
|                   path of the source file                           |
|                   specification.                                    |
+-----------------+----------------------------------+----------------+
| verifyimage       Use the verifyimage option with    restore image  |
|                   the restore image command to                      |
|                   specify that you want to enable                   |
|                   detection of bad sectors on the                   |
|                   destination target volume. If                     |
|                   bad sectors are detected on the                   |
|                   target volume, the client issues                  |
|                   a warning message on the console                  |
|                   and in the error log.                             |
|                   This option is valid for AIX ,                    |
|                   Linux , and Oracle Solaris                        |
|                   clients.                                          |
|                                                                     |
+-----------------+----------------------------------+----------------+
| virtualfsname     Specifies the name of the          backup group   |
|                   virtual file space for the group                  |
|                   on which you want to run the                      |
|                   operation.                                        |
+-----------------+----------------------------------+----------------+


3.3.2 Initial command-line-only options


A subset of client options is valid on the initial command line only.
Many of these options establish the runtime environment, such as the
commmethod and optfile options. Options in this category are not valid
in interactive, macro, or scheduler modes. They generate an error and
cause processing to stop.

Table 39 lists the options that are valid only on the initial command
line.

Table 39. Options that are valid on the initial command line only


  Options valid on the initial
  command line

   * commmethod                       * preschedulecmd/prenschedulecm
   * deduplication                   d (can be included in the
   * diskbuffsize                    schedule definition)
   * editor                           * queryschedperiod
   * enablededupcache                 * resourceutilization
   * enablelanfree                    * retryperiod
   * errorlogmax                      * schedlogmax
   * errorlogname                     * schedlogname
   * errorlogretention                * schedlogretention
   * lanfreecommmethod                * schedmode
   * lanfreeshmport                   * servername
   * lanfreetcpport                   * sessioninitiation
   * maxcmdretries                    * setwindowtitle
   * nfstimeout                       * tcpbuffsize
   * nodename                         * tcpcadaddress
   * optfile                          * tcpclientaddress
   * password                         * tcpclientport
   * postschedulecmd/postnschedule    * tcpwindowsize
  cmd (can be included in the         * txnbytelimit
  schedule definition)                * virtualnodename




3.3.3 Client options that can be set by the IBM Spectrum Protect server


Some client options can be set by the IBM Spectrum Protect server.

Table 40 lists the options that can be set by the server.

Table 40. Options that can be set by the IBM Spectrum Protect server


  Options that can be set by the
  IBM Spectrum Protect server

   * AFMSKIPUNCACHEDFILES             * QUERYSCHEDPERIOD
   * ARCHSYMLINKASFILE                * QUIET
   * CHANGINGRETRIES                  * RESOURCEUTILIZATION
   * COLLOCATEBYFILESPEC              * RETRYPERIOD
   * COMPRESSALWAYS                   * SCHEDMODE
   * COMPRESSION                      * SCROLLLINES
   * Deduplication                    * SCROLLPROMPT
   * DIRMC                            * SNAPSHOTCACHESIZE
   * DISABLENQR                       * SNAPSHOTPROVIDERFS
   * DISKCACHELOCATION                * SNAPSHOTPROVIDERIMAGE
   * DOMAIN                           * STAGINGDIRECTORY
   * DOMAIN.IMAGE                     * SUBDIR
   * DOMAIN.NAS                       * TAPEPROMPT
   * ENCRYPTIONTYPE                   * TXNBYTELIMIT
   * ENCRYPTKEY                       * VERBOSE
   * EXCLUDE.FS.NAS                   * VMCHOST
   * INCLEXCL                         * VMCUSER
   * INCLUDE.FS.NAS                   * VMPROCESSVMWITHINDEPENDENT
   * maxcandprocs                     * VMPROCESSWITHPRDM
   * maxmigrators
   * MEMORYEFFICIENTBACKUP
   * NFSTIMEOUT
   * POSTNSCHEDULECMD/POSTSCHEDULE
  CMD
   * POSTSNAPSHOTCMD
   * PRENSCHEDULECMD/PRESCHEDULECM
  D
   * PRESERVELASTACCESSDATE
   * PRESNAPSHOTCMD


Note:

1. See IBM Spectrum Protect for Space Management product documentation
   on IBM Documentation at https://www.ibm.com/docs/en/spfsm.

2. See IBM Spectrum Protect for Mail: Data Protection for Microsoft
   Exchange Server product documentation on IBM Documentation at
   https://www.ibm.com/docs/en/spfm.

Related information
         For information about creating client options sets on the IBM
         Spectrum Protect server, see the IBM Spectrum Protect server
         documentation for your server platform.


3.4 Client options reference


The following sections contain detailed information about each of the
IBM Spectrum Protect processing options.

Information for each option includes the following information:

*  A description

*  A syntax diagram

*  Detailed descriptions of the parameters

*  Examples of using the option in the client options file (if
   applicable)

*  Examples of using the option on the command line (if applicable)

Options with a command-line example of Does not apply cannot be used
with command line or scheduled commands.

Note:

1. Do not enclose an option value with single or quotation marks, unless
   the value is a file specification that contains spaces or wildcard
   characters. For example, the following option is not valid:

      passwordaccess  "generate"

2. All options in the dsm.sys file, except for the defaultserver option,
   must be placed within a server stanza. A server stanza is a
   collection of options statements in dsm.sys that begins with a
   SERVERName option and ends either at the next SERVERName option or
   the end of the file.


3.4.1 Absolute


Use the absolute option with the incremental command to force a backup
of all files and directories that match the file specification or
domain, even if the objects were not changed since the last incremental
backup.

This option overrides the management class copy group mode parameter for
backup copy groups; it does not affect the frequency parameter or any
other backup copy group parameters. This option does not override
exclude statements, so objects that are excluded from backup are not
eligible for backup even when the absolute option is specified.

Important: Before you use the absolute option, consider the following
effects that this option can have on backup and IBM Spectrum Protect
server operations:

*  Backups consume more server storage and database resources.

*  Backups consume more network bandwidth.

*  Server operations, such as inventory expiration, storage pool backup,
   storage pool migration, reclamation, and node replication, require
   more time to complete. Data deduplication might help mitigate some of
   these effects, but it does not avoid the processing that is required
   to reconstitute the deduplicated data back to its original form when
   the storage pool is migrated or backed up to non-deduplicated
   storage.

This option is valid only as a command-line parameter for the
incremental command when you are performing the following operations:

*  Full or partial progressive incremental backups of file systems or
   disk drives.

*  Snapshot differential backups when createnewbase=yes is also
   specified.

To force a full backup of a file system that uses journal-based backup,
specify both the nojournal and absolute options on the incremental
command.

To use the absolute option on scheduled incremental backups, the IBM
Spectrum Protect server administrator must create a separate backup
schedule that includes the absolute option on the schedule’s options
parameter.



Supported Clients

This option is valid for all clients as a command-line parameter for the
incremental command. This option cannot be added to a client option set
on the IBM Spectrum Protect server.

Syntax

>>-ABSolute----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc incr -absolute "/Users/sparky/source/*.c"


3.4.2 Afmskipuncachedfiles


The afmskipuncachedfiles option specifies whether uncached and dirty
files in General Parallel File System (GPFS) Active File Management file
sets are processed for backup, archive, and migration operations.

GPFS Active File Management and uncached and dirty file states are
explained in IBM Spectrum Scale product information .

Running HSM on GPFS file systems that use Active File Management file
sets is explained in Configuring IBM Spectrum Protect for IBM Spectrum
Scale Active File Management.

If you back up, archive, or migrate files from a file system that
contains Active File Management file sets, set afmskipuncachedfiles=yes.

Restriction: If Active File Management is running in Local Update (LU)
mode, the afmskipuncachedfiles option in the cache file set must be set
to No.

Supported Clients

This option is valid for backup-archive clients that run on AIX and
Linux systems.

Options File

Place this option in the dsm.sys file before any server stanzas.

Syntax

                         .-NO--.
>>-AFMSKIPUNCACHEDFILES--+-----+-------------------------------><
                         '-YES-'



Parameters

NO
         The Active File Management file state is ignored during backup,
         archive, and migration operations. Migration operations on
         uncached or dirty files fail and yield error message ANS9525E.
         Backup and archive operations on uncached files require Active
         File Management fetch operations. The fetch operations can
         cause significant network traffic between the Active File
         Management home and cache. This parameter is the default.

YES
         Uncached or dirty files in Active File Management file sets are
         skipped during backup, archive, and migration processing.


3.4.3 Archmc


Use the archmc option with the archive command to specify the available
management class for your policy domain to which you want to bind your
archived files and directories.

When you archive a file, you can override the assigned management class
using the archmc option on the archive command or by using the web
client. Overriding the management class using the web client is
equivalent to using the archmc option on the archive command.

If you do not use the archmc option, the server binds archived
directories to the default management class. If the default management
class has no archive copy group, the server binds archived directories
to the management class with the shortest retention period.

Supported Clients

This option is valid for all UNIX and Linux clients. The IBM Spectrum
Protect API does not support this option.

Syntax

>>-ARCHMc = --managementclass----------------------------------><



Parameters

managementclass
         Specifies an available management class in the active policy
         set of your policy domain. This management class overrides the
         default management class and any include statements for the
         files and directories you are archiving.

Examples

Command line:
         dsmc archive –archmc=ret2yrs /Users/van/Documents/budget.jan

         dsmc archive –archmc=ret2yrs /home/plan/proj1/budget.jan


3.4.4 Archsymlinkasfile


The archsymlinkasfile option specifies whether the backup-archive client
follows a symbolic link and archives the file or directory to which it
points, or archives the symbolic link only. Use this option with the
archive command.



Supported Clients

This option is valid for all UNIX clients except Mac OS X. The server
can also define this option.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

                      .-Yes-.
>>-ARCHSYMLinkasfile--+-----+----------------------------------><
                      '-No--'



Parameters

Yes
         Specifies that the client follows a symbolic link and archives
         the associated file or directory. This is the default.

No
         Specifies that the client archives the symbolic link and not
         the associated file or directory.

Examples

Options file:
         archsymlinkasfile no

Command line:
         -archsyml=no


3.4.5 Asnodename


Use the asnodename option to allow agent nodes to back up or restore
data on behalf of another node (the target node). This enables
concurrent operations from multiple nodes to store data to the same
target node and file space in parallel.

Your client node must be granted access to the target node by the IBM
Spectrum Protect server administrative client grant proxynode command,
and you must be a root user to use the asnodename option.

When the IBM Spectrum Protect administrator grants a node proxy
authority, and you use the asnodename option to become that node, you
can query and restore all files as if you had root authority.

An agent node is a client node that has been granted authority to
perform client operations on behalf of a target node.

A target node is a client node that grants authority to one or more
agent nodes to perform client operations on its behalf.

A proxy operation uses the settings for the target node (such as
maxnummp and deduplication) and schedules that are defined on the
server. The IBM Spectrum Protect server node settings and schedules for
the agent node are ignored.

For example, you can use the following command to back up shared data
for file space stored under the node name MyCluster:

/cluster1/mydata



dsmc incremental /Users -asnodenodename=MyCluster



You can also use the asnodename option to restore data under another
node name on the server. You can only restore the data that you own.

The asnodename option differs from the nodename option as follows:

*  When using the nodename option, you must enter the password for the
   node name you specify.

*  When using the asnodename option, you must enter the password for
   your client agent node to access the data stored for the client
   target node.

Restriction: You cannot use the asnodename option with -fromnode and you
cannot perform NAS backup using asnodename. Also, asnodename can be used
for clustered systems, although no specific cluster software is
supported.

Limitation: When you use the asnodename option, for example in an IBM
Spectrum Scale cluster environment, the backup-archive client GUI
displays the message "No backups found. Create backups before using this
UI." You must first configure a specific server stanza to be used by the
dsmcad command, for the backup-archive client GUI to use directly with
the asnodename option.

Supported Clients

This option is valid for all UNIX and Linux clients.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the General tab of the Preferences editor.

Syntax

>>-ASNODEname- --targetnode-----------------------------------><



Parameters

targetnode
         Specifies the node name on the IBM Spectrum Protect server
         under which you want to back up or restore data.

Examples

Options file:
         asnodename mycluster

Command line:
         -asnodename=mycluster

This option is not valid in interactive mode, but it can be defined in
the options portion of a schedule definition.


3.4.5.1 Session settings and schedules for a proxy operation


A proxy operation occurs when an agent node uses the asnodename
target_node_name option to complete operations on behalf of the
specified target node.

A proxy operation uses the settings for the target node (such as
maxnummp, cloptset, and deduplication) and schedules that are defined on
the IBM Spectrum Protect server. The server node settings and schedules
for the agent node are ignored.

The following considerations apply to proxy operations.

*  All operations use the policy domain settings and constructs of the
   target node, even if the agent node belongs to a different domain.
   The policy domain settings and constructs of the agent node are
   ignored.

*  The agent node authenticates to the IBM Spectrum Protect server by
   using the agent node's password.

*  In order to run proxy operations, the agent node and target node must
   not be locked on the server.

*  Proxy node relationships are not transitive. If a target node is
   itself defined as a proxy node for some other node, the agent node
   cannot be used to run operations on that other node unless the agent
   is also defined as a proxy node for that other node.

   For example, assume the following proxy definitions among nodes
   TAURUS, SCORPIO, and GEMINI:

   *  TAURUS is a proxy node for SCORPIO.

   *  TAURUS is not a proxy node for GEMINI.

   *  SCORPIO is a proxy node for GEMINI.

   The proxy definitions yield the following results:

   *  TAURUS can run operations on behalf of SCORPIO.

   *  SCORPIO can run operations on behalf of GEMINI.

   *  TAURUS cannot run operations on behalf of GEMINI.


3.4.6 Auditlogging


Use the auditlogging option to generate an audit log that contains an
entry for each file that is processed during an incremental, selective,
archive, restore, or retrieve operation.

The audit log can be configured to capture either a basic level of
information or a more inclusive (full) level of information.

The basic level of the audit logging feature captures the information
that is in the schedule log and it records information that a file has
been backed up, archived, updated, restored, retrieved, expired,
deleted, skipped or failed during an incremental backup, selective
backup, archive, restore or retrieve operation. In addition, the basic
level of audit logging captures the input command for commands run
through the backup-archive command line or scheduler clients.

The full level of audit logging records an action for each file that is
processed by the backup-archive client. In addition to all of the events
recorded by the basic level of audit logging, the full level of audit
logging records information for a file that has been excluded or not
sent during a progressive incremental backup operation because the file
had not changed.

The following is an example of the messages that are issued when the
audit log is configured to capture the basic level of information:

04/21/07 15:25:05 ANS1650I Command:
  sel /home/spike/test/*
04/21/07 15:25:05 ANS1651I Backed Up:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1652I Archived:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1653I Updated:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1654E Failed:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1655I Restored:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1656I Retrieved:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1657I Expired:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1658I Deleted:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1659I Skipped:
  /home/spike/test/file.txt


The following messages can be issued when the audit log is configured to
capture the full level of information (in addition to all messages
issued for the basic level of audit logging):

04/21/07 15:25:05 ANS1660I Excluded:
  /home/spike/test/file.txt
04/21/07 15:25:05 ANS1661I Unchanged:
  /home/spike/test/file.txt


The audit log is not a substitute or a replacement for the standard
error log (dsmerror.log) or for the schedule log (dsmsched.log). If an
error occurs that prevents a file from being processed, a message
indicating that an error has occurred is written to the audit log, but
the message will not indicate the nature of the error. For problem
diagnostics the standard error log must still be used.

The audit log entries only contain a time stamp and object name. There
is no information to distinguish between files and directories or any
information about the size of an object.

The Mac OS X backup-archive client creates the audit log as a Unicode
(UTF-16) file.

By default, the name of the audit log is dsmaudit.log and it is
contained in the same directory as the error log, dsmerror.log. The name
and location of the audit log can be configured using the auditlogname
option. There are no parameters to control the size of the audit log or
to prune the audit log. The auditlogname option cannot be set as an
option in an IBM Spectrum Protect server client options set.

The auditlogging command is supported with backup commands that interact
with file-level objects such as backup groups.

The auditlogging command is not supported with backup commands which
interact with image-level objects such as backup image or restore image.
The auditlogging command is supported with backup commands that interact
with file-level objects such as backup groups.

If you have enabled audit logging for an operation and there is a
failure trying to write to the audit log (for example, the disk on which
the audit log resides is out of space), the audit logging is disabled
for the rest of the operation and the return code for the operation is
set to 12, regardless of the outcome of the operation.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                 .-off---.
>>-AUDITLOGGing--+-------+-------------------------------------><
                 +-basic-+
                 '-full--'



Parameters

off
         Specifies that the audit logging facility is not engaged. This
         is the default.

basic
         Specifies that the audit log captures a basic level of
         information.

full
         Specifies that the audit log captures a more extensive level of
         information.

Examples

Run an incremental backup with audit logging enabled.

Command line:
         dsmc i -auditlogging=basic

         Back up a list of files using the maximum level of auditing,
         which enables a separate application, such as a Perl script, to
         verify the results.


3.4.7 Auditlogname


The auditlogname option specifies the path and file name where you want
to store audit log information. This option applies when audit logging
is enabled.



Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-AUDITLOGName--filespec--------------------------------------><



Parameters

filespec
         Specifies the path and file name where you want the
         backup-archive client to store audit log information.

         If you specify a file name only, the file is stored in your
         current directory. The default is the installation directory
         with a file name of dsmaudit.log. The dsmaudit.log file cannot
         be a symbolic link.

Examples

Run an incremental backup with audit logging enabled.

Sample output
         The following is a sample execution and output file:

         > dsmc inc /SMSVT/mfs1 -auditlogging=full
           -auditlogname=/home/cliv3/audit.log
         IBM Spectrum Protect
         Command Line Backup-Archive Client Interface
           Client Version 8, Release 1, Level 0.0
           Client date/time: 11/16/2016 12:05:35
         (c) Copyright by IBM Corporation and other(s) 1990, 2016.
             All Rights Reserved.

         Node Name: NAXOS_CLUSTER
         Session established with server
           ODINHSMSERV: AIX-RS/6000
           Server Version 8, Release 1, Level 0.0
           Server date/time: 11/16/2016   12:05:35
           Last access: 11/15/2016   12:01:57

         Incremental backup of volume '/SMSVT/mfs1'
         Directory-->               4,096 /SMSVT
           /mfs1/ [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test0 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test1 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test2 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test3 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test4 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test5 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test6 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test7 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test8 [Sent]
         Normal File-->            32,768 /SMSVT
           /mfs1/test9 [Sent]
         Successful incremental backup of '/SMSVT/mfs1'

         Total number of objects inspected:       11
         Total number of objects backed up:       11
         Total number of objects updated:          0
         Total number of objects rebound:          0
         Total number of objects deleted:          0
         Total number of objects expired:          0
         Total number of objects failed:           0
         Total number of bytes transferred:    320.31 KB
         Data transfer time:                    0.01 sec
         Network data transfer rate:        17,141.84 KB/sec
         Aggregate data transfer rate:        297.43 KB/sec
         Objects compressed by:                    0%
         Elapsed processing time:           00:00:01




         The following are the audit log contents:



         07/03/07   12:05:14 ANS1650I Command:
           inc /SMSVT/mfs1
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test0
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test1
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test2
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test3
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test4
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test5
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test6
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test7
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test8
         07/03/07   12:05:15 ANS1651I Backed Up:
           /SMSVT/mfs1/test9


3.4.8 Autodeploy


Use the autodeploy option to enable or disable an automatic deployment
of the client if a restart is required.



Supported Clients

This option is valid for AIX, Linux, Mac, and Solaris clients.

Options File

You can set this option by including it in your client options file. You
can also set in using the Java GUI by clicking Edit -> Client
Preferences and selecting the appropriate option on the General tab.

Syntax

               .-Yes-.
>>-AUTODEPLOY--+-----+-----------------------------------------><
               '-No--'



Parameters

Yes
         Specifies that the client is automatically deployed from the
         server. Yes is the default.

No
         Specifies that the client is not automatically deployed from
         the server.

Examples

Options file:
         autodeploy no

Command line:
         Does not apply.

Important: Use schedmode prompted with the autodeploy option, to enable
the scheduler to process the client deployment schedule immediately.


3.4.9 Autofsrename


The autofsrename option renames an existing file space that is not
Unicode-enabled on the IBM Spectrum Protect server so that a
Unicode-enabled file space with the original name can be created for the
current operation.

When you specify autofsrename yes in your client options file, and the
server value of autofsrename is set to client, the IBM Spectrum Protect
server generates a unique name by appending _OLD to the file space name
you specify in the current operation. For example, the server renames
the file space Jaguar to Jaguar_OLD. If the new file space name is too
long, the suffix replaces the last characters of the file space name.
For example, the mylongfilesystemname file space name is renamed to:

   mylongfilesystem_OLD

If the new file space name already exists on the server, the server
renames the new file space Jaguar_OLDx, where x is a unique number.

The server creates new Unicode-enabled file spaces that contain only the
data specified in the current operation. For example, assume that Jaguar
is the name of your startup disk and you archive all of the .log files
in the /Users/user5/Documents directory. Before the archive takes place,
the server renames the file space to Jaguar_OLD. The archive places the
data specified in the current operation into the Unicode-enabled file
space named Jaguar. The new Unicode-enabled file space now contains only
the /Users/user5/logs directory and the *.log files specified in the
operation. The server stores all subsequent full and partial
incremental, selective backup, and archive data in the new
Unicode-enabled file spaces.

For example, assume that Jaguar is the name of your startup disk and you
archive all of the .log files in the /Users/user5/Documents directory.
Before the archive takes place, the server renames the file space to
Jaguar_OLD. The archive places the data specified in the current
operation into the Unicode-enabled file space named Jaguar. The new
Unicode-enabled file space now contains only the /Users/user5/logs
directory and the *.log files specified in the operation. All subsequent
full and partial incremental, selective backup, and archive data are
stored in the new Unicode-enabled file spaces.

Renamed file spaces remain on the server as stabilized file spaces.
These file spaces contain all the original data, which you can restore
as long as they remain on the server.

Note: When an existing file space is renamed during Unicode conversion,
any access rules defined for the file space remain applicable to the
original file space. New access rules must be defined to apply to the
new Unicode file space.

After installation, perform a full incremental backup and rename all
existing file spaces that are not Unicode-enabled and back up the files
and directories within them under the new Unicode-enabled file spaces.
This operation requires increased processing time and storage on the
server.

File spaces that are not Unicode-enabled can be viewed in the character
set of the locale from which the files were backed up. A workstation
running in a different locale might be unable to view or restore from
these file spaces. Unicode-enabled file spaces that are backed up in one
locale are visible in all other locales, provided that the workstation
has the proper fonts installed.

To restore or retrieve from a file space that is not Unicode-enabled,
specify the source on the server and the destination on the client. See
the RESTORE topic for information on how to restore from file spaces
that are not Unicode-enabled. See the RETRIEVE topic for information on
how to retrieve from file spaces that are not Unicode-enabled.

The server can define the autofsrename option and override the
autofsrename setting on the client.

Supported Clients

This option is valid for Mac OS X only. The server can define the
autofsrename option and override the autofsrename setting on the client.
The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the General tab, Rename
non-Unicode filespaces during backup/archive drop-down list box of the
Preferences editor.

Syntax

                 .-Prompt-.
>>-AUTOFsrename--+--------+------------------------------------><
                 +-Yes----+
                 '-No-----'



Parameters

Yes
         Specifies that the IBM Spectrum Protectserver automatically
         renames all file spaces that are not Unicode-enabled in the
         current backup or archive operation.

No
         Specifies that the server does not rename file spaces that are
         not Unicode-enabled in the current backup or archive operation.

Prompt
         Specifies that you are prompted whether to rename the file
         spaces that are not Unicode-enabled in the current operation.
         This is the default.

Considerations:

*  This option applies only when the server sets the autofsrename option
   to client.

*  When the client scheduler is running, the default behavior is to not
   prompt you. The next interactive session prompts you to rename the
   file space.

*  The client prompts you only one time per file space. If you specify
   no at the prompt, the client cannot rename the file spaces later.
   However, the IBM Spectrum Protect administrator can rename the file
   spaces on the server.

*  When backing up files to a file space that is not Unicode-enabled,
   the Unicode-enabled client skips the files and directories with names
   containing characters from a code page that is different from the
   current locale.

*  If files and directories with names containing characters from a code
   page other than the current locale were previously backed up with a
   client that was not Unicode-enabled, they might be expired. The
   Unicode-enabled client expires these files if you do not migrate the
   file space to a Unicode-enabled file space. You can back up and
   archive these files to a Unicode-enabled file space.

Examples

Options file:
         autofsrename yes


3.4.10 Automount


The automount option adds an automounted file system into the domain by
mounting it. Use this option with the domain option.

Use this option to specify all automounted file systems that the
backup-archive client tries to mount at the following points in time:

*  When the client starts
*  When the backup is started
*  When the the client has reached an automounted file system during
   backup

Mount the file system before the client does a backup of that file
system. If the file system is always mounted before the backup is done,
it is unnecessary to explicitly specify an automounted file system in
the automount option. However, add this file system in the automount
option to ensure that the file system has been mounted at all the points
in time mentioned previously. The automounted file systems are remounted
if they have gone offline in the meantime during a backup.

Supported Clients

This option is valid for all UNIX platforms except Mac OS X. The IBM
Spectrum Protect API does not support this option.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

              .- ----------------.
              V                   |
>>-AUTOMount---- --filespacename-+----------------------------><



Parameters

filespacename
         Specifies one or more fully qualified automounted file systems
         that are mounted and added into the domain.

Examples

Options file:
         automount /home/Fred /home/Sam

Command line:
         Does not apply.


3.4.11 Backmc


The backmc option specifies the management class to apply to the backup
fastback command for retention purposes.

Use the backmc option with the backup fastback command.

If you back up an object more than once and specify a different
management class for each backup, all backup versions of the object are
rebound to the last management class specified.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line or on the
scheduler.

Syntax

>>-BACKMc=--management_class_name------------------------------><



Parameters

management_class_name
         Specifies the management class name.

Examples

Command line:
         dsmc backup fastback -fbpolicyname=policy1 -fbserver=server1
         -backmc=ret2yrs


3.4.12 Backupsetname


The backupsetname option specifies the name of a backup set from the IBM
Spectrum Protect server.

You can use backupsetname option with the following commands:

*  query backup
*  query filespace
*  query image
*  restore image

Note: The following commands take backupsetname as a positional
parameter. The backupsetname positional parameter behaves differently
from the backupsetname option. See the command explanations for a
discussion of how the backupsetname positional parameter affects each of
these commands:

   query backupset
   restore
   restore backupset

Supported Clients

This option is valid for all UNIX and Linux clients. The IBM Spectrum
Protect API does not support this option.

Options File

None. You can specify this option only on the command line.

Syntax

>>-BACKUPSETName--backupsetname--------------------------------><



Parameters

backupsetname
         Specifies the name of a backup set from the IBM Spectrum
         Protect server. You cannot use wildcards.

Examples

Command line:
         dsmc query backup /Volumes/bkSets/file.1
          -backupsetname=YEAR_END_ACCOUNTING.12345678

         dsmc query backup /usr/projects
          -subdir=yes -backupsetname=YEAR_END_ACCOUNTING.12345678

         dsmc restore image /home/proj
          -backupsetname=ACCOUNTING_2007.12345678

         dsmc query image
          -backupsetname=WEEKLY_BSET.21435678


3.4.13 Basesnapshotname


The basesnapshotname option specifies the snapshot to use as the base
snapshot, when you perform a snapshot differential (snapdiff) backup of
a NetApp filer volume. If you specify this option, you must also use the
snapdiff option or an error occurs. If basesnapshotname is not
specified, the useexistingbase option selects the most recent snapshot
on the filer volume as the base snapshot.

If the specified snapshot cannot be found, an error is reported and the
backup operation fails.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option can be used with supported x86_64 Linux clients.

Options File

This option can be specified in the client options file or on the
command line.

Syntax

>>-BASESNAPSHOTName-- --snapshot_name-------------------------><



Parameters

snapshot_name
         Specifies the name of an existing snapshot to use as the base
         snapshot. The name specified can be a snapshot name, such as
         vol1_snap, or it can be the name of a scheduled NetApp backup
         that has a name like nightly.x, where x is the sequence number
         (where nightly.0 is the oldest snapshot).
         You can also use a pattern with wildcard characters to select a
         snapshot. The wildcard characters can be either of the
         following:

         *
                  An asterisk (*) matches any character.

         ?
                  A question mark (?) matches a single character.
         The wildcards are useful if your snapshots follow a pattern,
         such as including the date or data and time as part of the
         snapshot name. For example, a snapshot created on November 12
         2012 at 11:10:00 AM could be saved as
         UserDataVol_121103111000_snapshot. The most recent snapshot
         that matches the pattern is selected as the existing base. For
         example, if there are two saved snapshots
         (UserDataVol_121103111000_snapshot and
         UserDataVol_121103231000_snapshot, the
         UserDataVol_121103231100_snapshot is selected because it is 12
         hours newer than the other snapshot.

         -basesnapshotname="UserDataVol_*_snapshot"
         Question marks work well for scheduled backups that follow a
         consistent name pattern. This syntax selects the latest
         "nightly" backup as the snapshot to use as the existing base.

         -basenameshotname="nightly.?"

Examples

Options file:
         basesnapshotname nightly.?

         basesnapshotname volum_base_snap

Command line:
         dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff
           -useexistingbase -basesnapshotname="nightly.?"


3.4.14 Cadlistenonport


The cadlistenonport option specifies whether to open a listening port
for the client acceptor.

When a listening port is open, it can accept any inbound connections.
However, the port is not used when the client acceptor manages only the
scheduler and the scheduler runs in polling mode. You can use this
option to prevent the acceptor from opening the unused port.

The default setting for this option is yes. Use cadlistenonport no only
when managedservices schedule and schedmode polling are used.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                    .-Yes-.
>>-CADLISTENONPort--+-----+------------------------------------><
                    '-No--'



Parameters

Yes
         Specifies that the client acceptor opens a listening port. This
         parameter is the default.

No
         Specifies that the client acceptor does not open a listening
         port. Use this setting when you use the client acceptor only to
         manage the scheduler in polling mode.

         This setting effectively disables other client features that
         depend on the client acceptor, such as web client backup and
         restore operations, IBM Spectrum Protect for Virtual
         Environments: Data Protection for VMware vSphere GUI
         operations, and IBM Spectrum Protect Snapshot backup and
         restore operations.

Example

Options file:
         cadlistenonport no

Command line:
         Does not apply.

Related reference
3.4.99 Managedservices
3.4.147 Schedmode


3.4.15 Changingretries


The changingretries option specifies how many additional times you want
the client to attempt to back up or archive a file that is in use. Use
this option with the archive, incremental, and selective commands.

This option is applied only when copy serialization, an attribute in a
management class copy group, is shared static or shared dynamic.

With shared static serialization, if a file is open during an operation,
the operation repeats the number of times that you specify. If the file
is open during each attempt, the operation does not complete.

With shared dynamic serialization, if a file is open during an
operation, the operation repeats the number of times that you specify.
The backup or archive occurs during the last attempt whether the file is
open or not.

Supported Clients

This option is valid for all UNIX and Linux clients. The server can also
define this option. The IBM Spectrum Protect API does not support this
option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Backup tab, Number of
retries if file is in use field of the Preferences editor.

Syntax

>>-CHAngingretries- numberretries-----------------------------><



Parameters

numberretries
         Specifies the number of times a backup or archive operation is
         attempted if the file is in use. The range of values is zero
         through 4; the default is 4.

Examples

Options file:
         changingretries 3

Command line:
         -cha=3


3.4.16 Class


The class option specifies whether to display a list of NAS or client
objects when using the delete filespace, query backup, and query
filespace commands.

For example, to display a list of the file spaces belonging to a NAS
node, enter the following command:

  query filespace -class=nas



Supported Clients

This option is valid only for AIX, Linux, and Oracle Solaris clients.
The IBM Spectrum Protect API does not support this option.

Options File

None. You can specify this option only on the command line.

Syntax

             .-client-.
>>-CLASS = --+--------+----------------------------------------><
             '-nas----'



Parameters

client
         Specifies that you want to display a list of file spaces for a
         client node. This is the default.

nas
         Specifies that you want to display a list of file spaces for a
         NAS node.

Examples

None. You can specify this option only on the command line.

Command line:
         q backup -nasnodename=nodename -class=nas




3.4.17 Collocatebyfilespec


Use the collocatebyfilespec option to specify whether the backup-archive
client uses only one server session to send objects generated from one
file specification.

Setting the collocatebyfilespec option to yes attempts to eliminate
interspersing of files from different file specifications, by limiting
the client to one server session per file specification. Therefore, if
you store the data to tape, files for each file specification are stored
together on one tape (unless another tape is required for more
capacity).

Considerations:

*  Use the collocatebyfilespec option only if the storage pool is going
   directly to tape. If you use this option going to a disk storage
   pool, you could affect some load balancing, and therefore,
   performance.

Supported Clients

This option is valid for all UNIX and Linux clients. The server can also
define this option.

Options File

Place this option in the client user-options file (dsm.opt).

Syntax

                        .-No--.
>>-COLlocatebyfilespec--+-----+--------------------------------><
                        '-Yes-'



Parameters

Yes
         Specifies that you want the client to use only one server
         session to send objects generated from one file specification.
         Therefore, if you store the data to tape, files for each file
         specification are stored together on one tape, unless another
         tape is required for more capacity. Restore performance can
         increase as a result.

No
         Specifies that the client can (depending on the execution
         dynamics and on the setting of the resourceutilization option
         of 3 or higher) use more than one server session to send the
         files from one file specification. This is the default.

         Backup performance might increase as a result. If the files are
         backed up to tape, files are stored on multiple tapes.
         Generally, the files specified in the file specification are
         still contiguous.



Examples

Options file:
         collocatebyfilespec yes

Command line:
         -collocatebyfilespec=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.18 Commmethod


The commmethod option specifies the communication method you use to
provide connectivity for client-server communication.



Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab of the
Preferences editor.

Syntax

              .-TCPip-----.
>>-COMMMethod-+-----------+------------------------------------><
              +-SHAREdmem-+
              '-V6TCPIP---'



Parameters

TCPip
         The Transmission Control Protocol/Internet Protocol (TCP/IP)
         communication method. This is the default.

V6Tcpip
         Indicates that either TCP/IP V4 or V6 should be used, depending
         on the system configuration and the results of a domain name
         service lookup. A valid DNS environment must be available.

SHAREdmem
         Use the shared memory communication method when the client and
         server are running on the same system. This provides better
         performance than the TCP/IP protocol.

         This option is valid for AIX, Linux, and Oracle Solaris
         clients.

         When specifying this communication method on AIX, the client
         can be logged in as root or non-root, as long as the server is
         running as root. If the server is not running as root, the user
         ID running the client must match the user ID running the
         server.



         Important: When using commmethod sharedmem on Linux, you might
         receive error message: ANR8294W Shared Memory Session unable to
         initialize on the server or storage agent console. By default,
         Linux is not set up with sufficient system resources to create
         the message queues. You must increase the kernel parameter,
         MSGMNI, to 128 (the default is 16). You can modify this
         parameter by performing the following command:

         echo 128 > /proc/sys/kernel/msgmni



         To enable this parameter to remain persistent after rebooting
         the system, you can instead add the following line to the file
         /etc/sysctl.conf, then reboot the system:

         kernel.msgmni=128



         To view the current ipc settings, run this command:

         ipcs -l



         Now look at the max queues system wide value. The default is
         16.

Examples

Options file:
         Use only TCP/IP V4.

         commmethod tcpip



         Use both TCP/IP V4 and V6, depending on how the system is
         configured, and the results of a domain name service lookup.



         commmethod V6Tcpip



         Note: The dsmc schedule command cannot be used when both
         SCHEDMODe prompt and commmethod V6Tcpip are specified.

Command line:
         -commm=tcpip

         -commm=V6Tcpip

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.19 Commrestartduration


The commrestartduration option specifies the maximum number of minutes
you want the client to try to reconnect to the IBM Spectrum Protect
server after a communication error occurs.

Note: A scheduled event continues if the client reconnects with the
server before the commrestartduration value elapses, even if the startup
window of the event has elapsed.

You can use the commrestartduration option and the commrestartinterval
in busy or unstable network environments to decrease connection
failures.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, Common
Options section of the Preferences editor.

Syntax

>>-COMMRESTARTDuration- minutes-------------------------------><



Parameters

minutes
         The maximum number of minutes you want the client to attempt to
         reconnect with a server after a communication failure occurs.
         The range of values is zero through 9999; the default is 60.

Examples

Options file:
         commrestartduration 90

Command line:
         Does not apply.


3.4.20 Commrestartinterval


The commrestartinterval option specifies the number of seconds you want
the client to wait between attempts to reconnect to the IBM Spectrum
Protect server after a communication error occurs.

Note: Use this option only when commrestartduration is a value greater
than zero.

You can use the commrestartduration option and the commrestartinterval
in busy or unstable network environments to decrease connection
failures.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, Common
Options section of the Preferences editor.

Syntax

>>-COMMRESTARTInterval- seconds-------------------------------><



Parameters

seconds
         The number of seconds you want the client to wait between
         attempts to reconnect with a server after a communication
         failure occurs. The range of values is zero through 65535; the
         default is 15.

Examples

Options file:
         commrestartinterval 30

Command line:
         Does not apply.


3.4.21 Compressalways


The compressalways option specifies whether to continue compressing an
object if it grows during compression.

Use this option with the compression option, and with the archive,
incremental, and selective commands.

The compressalways option is ignored when client-side deduplication is
enabled.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Backup tab, Continue Compressing if Object Grows
check box of the Preferences editor.

Syntax

                   .-Yes-.
>>-COMPRESSAlways--+-----+-------------------------------------><
                   '-No--'



Parameters

Yes
         File compression continues even if the file grows as a result
         of compression. This is the default.

No
         Backup-archive client objects are resent uncompressed if they
         grow during compression. API behavior depends on the
         application. Application backups might fail.

Examples

Options file:
         compressalways yes

Command line:
         -compressa=no

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.22 Compression


The compression option compresses files before you send them to the
server.

Compressing your files reduces data storage for backup versions and
archive copies of your files. It can, however, affect IBM Spectrum
Protect throughput. A fast processor on a slow network connection
benefits from compression, but a slow processor on a fast network
connection does not.

Use the compression option with the archive, incremental, and selective
commands.

The backup image command uses the compression option value specified in
the dsm.sys file. This option is valid on the initial command line and
in interactive mode. The server can also define this option which
overrides the client value.

The backup-archive client backs up a sparse file as a regular file if
client compression is off. Set compression yes to enable file
compression when backing up sparse files to minimize network transaction
time and maximize server storage space.

If you set compressalways yes, compression continues even if the file
size increases. To stop compression if the file size grows, and resend
the file uncompressed, set compressalways no.

If you set compression yes, you can control compression processing in
the following ways:

*  Use the exclude.compression option in your client system-options file
   (dsm.sys) to exclude specific files or groups of files from
   compression processing.

*  Use the exclude.compression option in your dsm.opt file (Windows) or
   your dsm.sys file (UNIX) to exclude specific files or groups of files
   from compression processing. See the EXCLUDE OPTIONS topic for more
   information.

*  Use the include.compression option in your client system-options file
   (dsm.sys) to include files within a broad group of excluded files for
   compression processing.

*  Use the include.compression option in your dsm.opt file (Windows) or
   your dsm.sys file (UNIX) to include files within a broad group of
   excluded files for compression processing. See the INCLUDE OPTIONS
   topic for more information.

This option controls compression only if your administrator specifies
that your client node can compress files before sending them to the
server.

The type of compression that the client uses is determined by the
combination of compression and client-side data deduplication that is
used during backup or archive processing. The following types of
compression are used:

LZ4
         A faster and more efficient compression method that the client
         uses in any of the following situations:

         *  The client-side deduplicated-object is sent to a container
            storage pool on the IBM Spectrum Protect server. The server
            must be at version 7.1.5 or later.

         *  The object does not undergo client-side data deduplication.
            (Does not apply to Data Protection for VMware and Data
            Protection for Microsoft Hyper-V, in which only client-side
            deduplicated-data can be compressed.)

         *  The object undergoes only traditional server-side data
            deduplication. (Does not apply to Data Protection for VMware
            and Data Protection for Microsoft Hyper-V, in which only
            client-side deduplicated-data can be compressed.)

LZW
         A traditional type of compression that the client uses is when
         client-deduplicated objects are sent to traditional
         (non-container) storage pools on the server.

None
         The object is not compressed by the client. The object is not
         compressed because the compression option is set to no, or the
         option is not specified during backup or archive processing.
         Although the object is not compressed by the client, it might
         be compressed by the server.

You do not need to set the compression type. It is determined by the
backup-archive client at the time of backup or archive processing.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Backup tab, Compress objects check box of the
Preferences editor.

Syntax

                .-No--.
>>-COMPRESSIon--+-----+----------------------------------------><
                '-Yes-'



Parameters

No
         Files are not compressed before they are sent to the server.
         This is the default.

Yes
         Files are compressed before they are sent to the server.

Examples

Options file:
         compression yes

Command line:
         -compressi=no

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.31 Deduplication
3.4.59 Exclude options
3.4.86 Include options


3.4.23 Console


Use the console option with the query systeminfo command to output
information to the console.

*  DSMOPTFILE - The contents of the dsm.opt file.

*  DSMSYSFILE - The contents of the dsm.sys file.

*  ENV - Environment variables.

*  ERRORLOG - The IBM Spectrum Protect error log file.

*  FILE - Attributes for the file name that you specify.

*  INCLEXCL - Compiles a list of include-exclude in the order in which
   they are processed during backup and archive operations.

*  OPTIONS - Compiled options.

*  OSINFO - Name and version of the client operating system (includes
   ULIMIT information for UNIX and Linux).

*  POLICY - Policy set dump.

*  SCHEDLOG - The contents of the IBM Spectrum Protect schedule log
   (usually dsmsched.log).

*  CLUSTER - AIX cluster information.

Note: The query systeminfo command is intended primarily as an aid for
IBM support to assist in diagnosing problems, although users who are
familiar with the concepts addressed by this information might also find
it useful. If you use the console option, no special formatting of the
output is performed to accommodate screen height or width. Therefore,
the console output might be difficult to read due to length and
line-wrapping. In this case, use the filename option with the query
systeminfo command to allow the output to be written to a file that can
subsequently be submitted to IBM support. See the FILENAME topic for
more information.

Supported Clients

This option is valid for all clients.

Syntax

>>-CONsole-----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         query systeminfo dsmoptfile errorlog -console


3.4.24 Createnewbase


The createnewbase option creates a base snapshot and uses it as a source
to run a full incremental backup.

Some files might not be backed up when the snapshot difference
incremental backup command is run. If the files are skipped, you can run
a snapshot difference incremental backup with the createnewbase option
to back up these files. See 3.4.158 Snapdiff for a list of reasons why a
file might not be backed up when the snapshot difference command is run.

One reason that a file can be skipped during backup processing is
because the file name is not supported by NetApp Data ONTAP. NetApp Data
ONTAP versions 8.0 and versions lower than 7.3.3 only support file names
that are within the 7 bit ASCII character set. NetApp Data ONTAP version
7.3.3 and versions greater than 8.0.0 support Unicode file names. If you
upgraded NetApp Data ONTAP from a version that does not support Unicode
file names to a version that does support Unicode files names, run a
full incremental backup with the createnewbase=migrate option.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option is valid for the following clients:

*  Linux x86_64 clients

Enter the createnewbase option on the command line. Specify this option
with the snapdiff option.

Syntax

                  .-No------.
>>-Createnewbase--+---------+----------------------------------><
                  +-Yes-----+
                  +-IGNore--+
                  '-MIGRate-'



Parameters

No
         Specifies that a snapshot difference incremental is run. If the
         backup-archive client detects that the NetApp Data ONTAP file
         server has been migrated from a version that does not support
         Unicode file names to a file server that does, a warning
         message is recorded to the error log and the IBM Spectrum
         Protect server activity log. The warning message indicates that
         you must run a full incremental backup and logs a return code
         of 8 even if the operation completed successfully.
         This parameter is the default value.

Yes
         Specifies that a full incremental is run by creating a new base
         snapshot and is using it to run a scan-based incremental
         backup. Use this option to back up any file changes that might
         not have been detected by the snapshot difference API.
         If the operation finished successfully, the command ends with a
         return code of 0.
         Do not set createnewbase=yes for any schedule that runs a daily
         snapshot difference backup. Instead, create a separate, monthly
         schedule that has the createnewbase=yes option.

IGNore
         Specifies that a snapshot difference incremental backup is run
         when the backup-archive client detects that the NetApp Data
         ONTAP file server was upgraded to support Unicode file names.
         The ignore option is different from the no parameter because
         the ignore option suppresses the warning message. Instead, an
         informational message is recorded in the error log and the IBM
         Spectrum Protect activity log that informs you to run a full
         incremental backup.
         If the command finishes successfully, it returns a code of 0.
         Use the ignore option if you have upgraded the NetApp Data
         ONTAP file server to support Unicode but you have not yet run a
         full incremental backup. This option is used only when the
         backup-archive client has detected that the file server was
         migrated and a full incremental has not yet been run. The
         option is ignored for all other times.

MIGRate
         Specifies that if the NetApp Data ONTAP file server was
         upgraded to a version that supports Unicode file names, a base
         snapshot is taken and a scan-based incremental backup is run.
         The migrate option is different from the yes option because the
         migrate option creates a base snapshot only when the client
         detects that the NetApp Data ONTAP file server version was
         updated. The yes option creates a base snapshot every time the
         command is run.
         After the incremental backup finishes, no additional
         migration-related messages are recorded to the error log or the
         IBM Spectrum Protect server activity log. When the operation
         finishes, the command ends with a return code of 0.
         Use the migrate option if you have upgraded the NetApp Data
         ONTAP file server to support Unicode but you have not yet run a
         full incremental backup. The migrate option is ignored if the
         NetApp Data ONTAP file server has not been upgraded.

Examples

Command line:
         dsmc incremental -snapdiff -createnewbase=yes /net/home1


3.4.25 Csv


The csv option enables the client to use a comma-separated values (csv)
file to define and apply different restore settings across a series of
virtual machine restore operations.

In the specified .csv file, you can define column headings with settings
that override equivalent client options. Column names are
case-sensitive.

Using a CSV column overrides the equivalent command line option. The
equivalent option is ignored if used with the restore vm -csv command:

*  "New Virtual Machine Name" overrides the -vmname option on restore.

*  "New Datastore" overrides the -datastore option on restore.

*  "New Datacenter" overrides the -datacenter option on restore.

*  "New Host" overrides the -host option on restore.

*  "PITDATE" overrides the -pitdate option on restore.

*  "PITTIME" overrides the -pittime option on restore.

Supported clients

This option can be used with supported x86_64 Linux clients.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options file

This option is valid in the client system options file (dsm.sys), or on
the command line for Restore VM. It can also be included on the server
in a client options set. It cannot be set in the Preferences Editor.

Syntax

>>-Csv-- --csvfilespec----------------------------------------><



Parameters

csvfilespec
         Using a CSV column overrides the equivalent command line
         option. Any equivalent option is ignored if it is used with the
         restore vm -csv command.

         For example, if you specify the command restore vm
         "restore_vm_list.csv" -csv -datacenter="Mambo 5", and the "New
         Datacenter" column is already specified in the CSV file, the
         -datacenter option is ignored.

The following list shows the CSV columns that override the equivalent
client options:

Table 41. Column heading names

+-----------------------+----------------------+----------------------+
| Heading                 Description            Usage                |
+-----------------------+----------------------+----------------------+
| Virtual Machine Name    The name of the        No wildcard          |
|                         virtual machine to     characters are       |
|                         be restored.           allowed.             |
|                                                Case-sensitive. This |
|                                                column is mandatory. |
+-----------------------+----------------------+----------------------+
| New Virtual Machine     The name of the        This column uses the |
| Name                    virtual machine that   same syntax as the   |
|                         is restored.           -vmname option.      |
|                                                Optional. You can    |
|                                                leave this column    |
|                                                blank if you want to |
|                                                reuse the existing   |
|                                                name.                |
+-----------------------+----------------------+----------------------+
| New Datastore            The new datastore     This column uses the |
|                         to which the virtual   same syntax as the   |
|                         hard disks are         -datastore option.   |
|                         restored.              Optional. You can    |
|                                                leave this column    |
|                                                blank if you want to |
|                                                reuse the existing   |
|                                                datastore.           |
+-----------------------+----------------------+----------------------+
| New Datacenter          The new datacenter      Uses the same       |
|                         with which the         syntax as the        |
|                         virtual machine        -datacenter option.  |
|                         should be              Optional. You can    |
|                         associated.            leave this column    |
|                                                blank if you want to |
|                                                reuse the existing   |
|                                                datacenter.          |
+-----------------------+----------------------+----------------------+
| New Host                The new host to        This column uses the |
|                         which the virtual      same syntax as the   |
|                         machine will be        -host option.        |
|                         restored.              Optional. You can    |
|                                                leave this column    |
|                                                blank if you want to |
|                                                reuse the existing   |
|                                                host.                |
+-----------------------+----------------------+----------------------+
| PITDATE                 The point-in-time      This column uses the |
|                         date from which the    same syntax as the   |
|                         backup is specified.   -pitdate option.     |
|                                                Optional. You can    |
|                                                leave this column    |
|                                                blank to indicate    |
|                                                the active backup    |
|                                                should be restored.  |
|                                                This column is       |
|                                                required if PITTIME  |
|                                                is specified in the  |
|                                                CSV file. PITDATE    |
|                                                dates should use the |
|                                                format set by the    |
|                                                DATEFORMAT option.   |
|                                                The default varies   |
|                                                by locale in         |
|                                                Windows. The default |
|                                                is DATEFORMAT 1 in   |
|                                                Linux.               |
+-----------------------+----------------------+----------------------+
| PITTIME                 The point-in-time      This column uses the |
|                         time of day from       same syntax as the   |
|                         which the backup is    -pittime option.     |
|                         specified.             Optional. You can    |
|                                                leave this column    |
|                                                blank to indicate    |
|                                                you want to use the  |
|                                                active backup or if  |
|                                                only the PITDATE is  |
|                                                specified. PITTIME   |
|                                                times should use the |
|                                                format set by        |
|                                                TIMEFORMAT option.   |
|                                                The default varies   |
|                                                by locale in         |
|                                                Windows. The default |
|                                                is TIMEFORMAT 1 in   |
|                                                Linux.               |
+-----------------------+----------------------+----------------------+

The asterisk, *, denotes reuse of the original VM name as part of a
wild-card construct for the name of a restored VM.

The following command line conventions are also observed:

*  <date> is replaced by the date of the restore.

*  <time> is replaced by the time of the restore.

*  <timestamp> is replaced by a combination of <date> and <time>
   outputs.

Elements can be placed in quotes: for example, VMs with commas and
quotes in their names.

"Poem Repository ""A-F"" 20th Century"

Here, double quotes are used to express a quote (") character.

Examples

The following example shows how a CSV file looks when opened in a
spreadsheet view:

Virtual Machine Name  New Virtual Machine Name  New Host  New Datastore  New Datacenter  NOTES1          NOTES2  PITDATE  PITTIME
VM1                              *-DR_restore             esx4.ibm.com    DS_8          DC_RecoverSite1  group1
VM2                              *-DR_restore             esx4.ibm.com    DS_8          DC_RecoverSite1  group1
VM3                              *-DR_restore             esx4.ibm.com    DS_8          DC_RecoverSite1  group1
VM4                              *-DR_restore             esx5.ibm.com    DS_10         DC_RecoverSite1  group2
VM5                              *-DR_restore             esx5.ibm.com    DS_10         DC_RecoverSite1  group2

The following examples show comma-separated text files that were
exported from CSV files.

Example 1:


Virtual Machine Name,New Virtual Machine Name,New Host,New Datastore,New Datacenter,NOTES1,NOTES2,PITDATE,PITTIME
VM1,*-DR_restore,esx4.ibm.com,DS_8,DC_RecoverSite1,group1
VM2,*-DR_restore,esx4.ibm.com,DS_8,DC_RecoverSite1,group1
VM3,*-DR_restore,esx4.ibm.com,DS_8,DC_RecoverSite1,group1
VM4,*-DR_restore,esx5.ibm.com,DS_10,DC_RecoverSite1,group2
VM5,*-DR_restore,esx5.ibm.com,DS_10,DC_RecoverSite1,group2

Example 2:


Virtual Machine Name,New Virtual Machine Name,New Host,New Datastore,New Datacenter,NOTES1,NOTES2,PITDATE,PITTIME
Tiny Linux VM,Tiny Linux VM -restore,,,,,,,
lucasTestVM10,* -restore,,,,,,10/03/2017,10:35 AM
big-cet-4TB,,devesx06.storage.tucson.ibm.com,,,,10/05/2017,,

Related reference
2.49 Restore VM (VMware)


3.4.26 Datacenter


Specifies the target location of the data center that will contain the
restored machine data.

Use this option on restore vm commands.

If folders are used within virtual center to organize datacenters, then
the folder name needs to be included in the datacenter specification,
separated by a slash.

If you are restoring through a ESX server rather than a virtual center,
the -datacenter=ha-datacenter option should be used.

The default target location is the datacenter which the virtual machine
was stored at the time of backup.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Examples

Restore a virtual machine to USEast datacenter which is organizaed under
a folder named Production in the virtual center.

dsmc restore vm my_vm -datacenter=Production/USEast

Restore a virtual machine backup taken from a virtual center, but using
a ESX server at the time of restore.

restore vm my_vm -datacenter=ha-datacenter

Restore the virtual machine into the USWest datacenter.

restore vm my_vm -datacenter=USWEst




3.4.27 Datastore


Specifies the datastore target to be used during VMware restore
operation.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Example

Restore the virtual machine to a datastore named ds8k_prod1:

restore vm my_vm -datastore=ds8k_prod1




3.4.28 Dateformat


The dateformat option specifies the format you want to use to display or
enter dates.

By default, the backup-archive and administrative clients obtain format
information from the locale definition in effect at the time you start
the client. Consult the documentation on your local system for details
about setting up your locale definition.

Note:

1. The dateformat option does not affect the web client. The web client
   uses the date format for the locale that the browser is running in.
   If the browser is not running in a locale that is supported, the web
   client uses the date format for US English.

2. When you change the date format and use the schedlogretention option
   to prune the schedule log, the client removes all entries in the
   schedule log with a different date format when pruning the log. When
   you change the date format and use the errorlogretention option to
   prune the error log, the client removes all entries in the error log
   with a different date when pruning the log. When changing the date
   format, copy the schedule log and error log if you want to preserve
   log entries that contain a different date format.

You can use the dateformat option with the following commands.

*  delete archive
*  delete backup
*  expire
*  query archive
*  query backup
*  query filespace
*  query image
*  restore
*  restore image
*  restore nas
*  retrieve
*  set event

When you include the dateformat option with a command, it must precede
the fromdate, pitdate, and todate options.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Regional Settings tab, Date Format drop-down list of
the Preferences editor.

Syntax

>>-DATEformat-- --format_number-------------------------------><



Parameters

format_number
         Displays the date using one of the following formats. Select
         the number that corresponds to the date format you want to use:

         0
                  Use the locale-specified date format (does not apply
                  to Mac OS X).

                  For AIX and Solaris: This is the default if the
                  locale-specified date format consists of digits and
                  separator characters.


         1
                  MM/DD/YYYY

                  For AIX and Solaris: This is the default if the
                  locale-specified date format consists of anything but
                  digits and separator characters.



                  This is the default for the following available
                  translations:



                  *  US English
                  *  Chinese (Traditional)
                  *  Korean
         2
                  DD-MM-YYYY

                  This is the default for the following available
                  translations:



                  *  Brazilian Portuguese
                  *  Italian
         3
                  YYYY-MM-DD

                  This is the default for the following available
                  translations:



                  *  Japanese
                  *  Chinese (Simplified)
                  *  Polish
         4
                  DD.MM.YYYY

                  This is the default for the following available
                  translations:



                  *  German
                  *  French
                  *  Spanish
                  *  Czech
                  *  Russian
         5
                  YYYY.MM.DD

                  This is the default for the following available
                  translations:



                  *  Hungarian
         6
                  YYYY/MM/DD
         7
                  DD/MM/YYYY



Examples

Options file:
         dateformat 3

Command line:
         -date=3

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.

Additional considerations for specifying time and date formats

The date or time format you specify with this option must be used when
using options that take date and time as input. Examples are: totime,
fromtime, todate, fromdate, and pittime.

For example, if you specify the timeformat option as TIMEFORMAT 4, the
value that you provide on the fromtime or totime option must be
specified as a time such as 12:24:00pm. Specifying 13:24:00 would not be
valid because TIMEFORMAT 4 requires an hour integer that is 12 or less.
If you want to specify up to 24 hour values on an option, and if you
want to use commas as separators, you must specify TIMEFORMAT 2.

Configuring date and time formats in the system locale configuration
file

You can specify date and time formats by configuring them in your
system’s locale file. If you specify time and date formats in the locale
file, they must be defined by using a subset of number-producing format
specifiers that are supported by the C language strftime() function. You
can use the following specifiers to set date and time formats in
configuration settings for your locale.

Date specifiers
         *  %Y - the year, in four digits. For example, 2011.

         *  %y - the year, last two digits only. For example, 11 not
            2011.

         *  %m - the month, as a decimal number (1-12).

         *  %d - the day of the month (1-31).

         In the date specifiers, you can specify only one year
         specifier. Do not specify both %Y and %y. The E modifier (a
         capital E) can precede the date specifiers to produce the
         locale's alternative form for the year, month, or day. If no
         alternative form exists, the E modifier is ignored. Separate
         the specifiers with a single 7-bit ASCII character. Commonly
         used separators include colons (:), commas (,), periods (.),
         hyphens (-), or forward slash (/) characters. Do not use
         multibyte characters as separators.

Time specifiers
         *  %H - the hour, in 24-hour form (00-23).

         *  %I - the hour, in 12-hour form (00-12).

         *  %M - minutes after the hour (00-59).

         *  %S - seconds after the minute (00-59)

         *  %p - adds the AM (before noon) or PM (after noon) indicator.

         In the time specifiers, you can specify only one hour
         specifier. Do not specify both %I and %H.

         The O modifier (a capital O) can precede the time specifiers to
         produce the locale's alternative form for the hour, minutes, or
         seconds. The O modifier cannot precede the %p specifier.
         Separate the specifiers with a single 7-bit ASCII character.
         Commonly used separators include colons (:), commas (,), or
         periods (.). Do not use multibyte characters as separators. Do
         not specify a separator between the %p specifier and the
         separator that precedes or follows it.

Time format examples, configured in the locale settings
         To set a particular time format, edit the configuration file
         for your locale and modify the t_fmt line to support your
         needs. Whatever time format you select applies both to output
         and to input. After the locale configuration file has been
         edited, the localedef command must be run to create the final
         locale file.

         Table 42. Sample time format settings in the locale
         configuration (t_fmt line)

+-----------------------------+---------------------------------------+
| Example                     | Result                                |
+-----------------------------+---------------------------------------+
| "%H:%M:%S"                  | Displays time in the form hh:mm:ss    |
|                             | with hh ranging from 0 through 23.    |
+-----------------------------+---------------------------------------+
| "%H,%M,%S"                  | Displays time in the form hh,mm,ss    |
|                             | with hh ranging from 0 through 23.    |
+-----------------------------+---------------------------------------+
| "%I,%M,13p"                 | Displays time in the form hh,mm,ssA/P |
|                             | with hh ranging from 1 through 12 and |
|                             | A/P is the local abbreviation for     |
|                             | ante-meridian (AM in English) or      |
|                             | post-meridian (PM in English).        |
+-----------------------------+---------------------------------------+

Date format examples, configured in the locale settings
         To set a particular date format, edit the configuration file
         and modify the d_fmt line as needed to support your needs.
         Whatever date format you select applies both to output and to
         input.

         Table 43. Sample date format settings in the locale
         configuration (d_fmt line)

+-----------------------------+---------------------------------------+
| Example                     | Result                                |
+-----------------------------+---------------------------------------+
| "%m/%d/%y"                  | Displays the date in the form         |
|                             | MM/DD/YY.                             |
+-----------------------------+---------------------------------------+
| "%d.%m.%Y"                  | Displays the date in the form         |
|                             | DD.MM.YYYY.                           |
+-----------------------------+---------------------------------------+


3.4.29 Dedupcachepath


Use the dedupcachepath option to specify the location where the
client-side data deduplication cache database is created.

This option is ignored if the enablededupcache=no option is set during
backup or archive processing.

Supported Clients

This option is valid for all clients. This option is also valid for the
IBM Spectrum Protect API.

Options File

Place this option in the system-options file (dsm.sys). You can set this
option on the Deduplication Cache Location field of the Preferences
editor. The option can be set in the client option set on the IBM
Spectrum Protect server.

Syntax

>>-DEDUPCACHEPath--path----------------------------------------><



Parameters

path
         Specifies the location where the client-side data deduplication
         cache database is created if the enablededupcache option is set
         to yes. The default location is to create the data
         deduplication cache file in the backup-archive client or API
         installation directory.

Examples

Options file:
         dedupcachepath /volumes/temp

Command line:
         Does not apply.

Related reference
3.4.51 Enablededupcache


3.4.30 Dedupcachesize


Use the dedupcachesize option to determine the maximum size of the data
deduplication cache file. When the cache file reaches its maximum size,
the contents of the cache are deleted and new entries are added.



Supported Clients

This option is valid for all clients. This option is also valid for the
IBM Spectrum Protect API.

Options File

Place this option in the system-options file (dsm.sys). You can set this
option on the Deduplication -> Deduplication Cache -> Maximum Size field
of the Preferences editor. The option can be set in the client option
set on the IBM Spectrum Protect server.

Syntax

>>-DEDUPCACHESize--dedupcachesize------------------------------><



Parameters

dedupcachesize
         Specifies the maximum size, in megabytes, of the data
         deduplication cache file. The range of values is 1 - 2048; the
         default is 256.

Examples

Options file:
         dedupcachesize 1024

Command line:
         Does not apply.

Related reference
3.4.31 Deduplication


3.4.31 Deduplication


Use the deduplication option to specify whether to enable redundant
client-side data elimination when data is transferred to the IBM
Spectrum Protect server during backup and archive processing.

Data deduplication is disabled if the enablelanfree option is set.
Backup-archive client encrypted files are excluded from client-side data
deduplication. Files from encrypted file systems are also excluded.

To support client-side data deduplication, the following criteria must
be met:

*  Client-side data deduplication for the node is enabled on the server.

*  The storage pool destination for the data must be a storage pool that
   is enabled for data deduplication. The storage pool must have a
   device type of "file".

*  A file can be excluded from client-side data deduplication processing
   (by default all files are included).

*  The server can limit the maximum transaction size for data
   deduplication by setting the CLIENTDEDUPTXNLIMIT option on the
   server. For more information about the option, refer to the IBM
   Spectrum Protect server documentation.

*  The file size must be larger than 2 KB.

Supported Clients

This option is valid for all clients; it can also be used by the IBM
Spectrum Protect API.

Options File

Place this option in the system-options file (dsm.sys) within a server
stanza. You can set this option by selecting the Deduplication -> Enable
Deduplication check box of the Preferences editor. The option can be set
in the client option set on the IBM Spectrum Protect server.

Syntax

                  .-No--.
>>-DEDUPLication--+-----+--------------------------------------><
                  '-Yes-'



Parameters

No
         Specifies that you do not want to enable client-side data
         deduplication for backup and archive processing. No is the
         default.

Yes
         Specifies that you want to enable client-side data
         deduplication for backup and archive processing.

Examples

Options file:
         deduplication yes

Command line:
         -deduplication=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.86 Include options
3.4.59 Exclude options


3.4.32 Defaultserver


Use the defaultserver option to specify the name of the IBM Spectrum
Protect server to contact for backup-archive services if more than one
server is defined in the dsm.sys file.

By default, the backup-archive contacts the server defined by the first
stanza in the dsm.sys file. This option is only used if the servername
option is not specified in the client user-options file (dsm.opt).

If you have the HSM client installed on your workstation, and you do not
specify a migration server with the migrateserver option, use this
option to specify the server to which you want to migrate files. For
more information, see the IBM Spectrum Protect for Space Management
product documentation on IBM Documentation at
https://www.ibm.com/docs/en/spfsm.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option at the beginning of the dsm.sys file before any server
stanzas.

Syntax

>>-DEFAULTServer-- --servername-------------------------------><



Parameters

servername
         Specifies the name of the default server to which you back up
         or archive files. The server to which files are migrated from
         your local file systems can also be specified with this option.

Examples

Options file:
         defaults server_a

Command line:
         Does not apply.


3.4.33 Deletefiles


Use the deletefiles option with the archive command to delete files from
your workstation after you archive them.

You can also use this option with the restore image command and the
incremental option to delete files from the restored image if they were
deleted after the image was created. Deletion of files is performed
correctly if the backup copy group of the IBM Spectrum Protect server
has enough versions for existing and deleted files.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-DELetefiles-------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc archive "/Users/dgordon/Documents/*.c" –deletefiles

         dsmc archive "/home/foo/*.c" –deletefiles
         dsmc restore image /local/data -incremental -deletefiles


3.4.34 Description


The description option assigns or specifies a description for files when
performing archive, delete archive, retrieve, query archive, or query
backupset.

For example, if you want to archive a file named budget.jan and assign
to it the description "2002 Budget for Proj 1", you would enter:

   dsmc archive –des="2003 Budget for Proj 1" /home/plan/
   proj1/budget.jan



Note:

1. The maximum length of a description is 254 characters.
2. Enclose the value in quotation marks (" ") if the option value that
   you enter contains a blank space.

Use the description option with the following commands:

*  archive
*  delete archive
*  query archive
*  query backupset
*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-DEScription = -- --description-----------------------------><



Parameters

description
         Assigns a description to the file you are archiving. If you do
         not specify a description with the archive command, the default
         is Archive Date:x, where x is the current system date. Note
         that the date is always 10 characters long. If your date format
         uses a two digit year, there are two blank spaces at the end of
         the date. For example, a default description using a four-digit
         year might be "Archive Date: 2002/05/03", and the same default
         with a two-digit year might be "Archive Date: 02/05/03 " (note
         the two spaces at the end). When retrieving files using the
         two-digit year description, you can enter the -description
         option string in either of the following ways:

         -description="ArchiveDate: 02/05/03  "
          or
         -description="ArchiveDate: 02/05/03*"



         If you use the archive command to archive more than one file,
         the description you enter applies to each file. For example, to
         archive a group of files and assign the same description,
         Project X, to each file, you would enter:



         dsmc archive –description="Project X" "/Users/van/Documents/*.x"




            dsmc archive –description="Project X" "/home/allproj/.*"



         You can then use the description to retrieve all of the files.

Examples

Command line:
         dsmc archive "/Users/van/Documents/*.prj" -des="2003 Budget for Proj 1"

         dsmc archive "/home/foo/*.prj" –des="2003 Budget for Proj 1"
         dsmc query backupset –loc=server –descr="My Laptop"


3.4.35 Detail


Use the detail option to display management class, file space, backup,
archive information, and additional information, depending on the
command with which it is used.

Use the detail option with the query mgmtclass command to display
detailed information about each management class in your active policy
set. If you do not use the detail option, only the management class name
and a brief description are displayed on the screen. If you specify the
detail option, information about attributes in each copy group contained
in each management class is displayed on the screen. A management class
can contain a backup copy group, an archive copy group, both, or
neither.

A Unicode-enabled file space might not display correctly if the server
cannot display the Unicode name. In this case, use the file space
identifier (fsID) of the file space to identify these file spaces on the
server. Use the detail option with the delete filespace and query
filespace commands to determine the fsID of a file space. The fsID also
appears in the file information dialog in the backup-archive client GUI.

Use the detail option with the query backup and query archive commands
to display these attributes of the file that you specify:

*  Last modification date

*  Last access date

*  Compression

*  Encryption type

*  Client-side data deduplication

*  Whether the HSM client migrated or premigrated the file

Use the detail with the query vm command to display the following
statistics:

*  The average number of IBM Spectrum Protect objects that are needed to
   describe a single megablock, across all megablocks in a backup.

*  The average number of IBM Spectrum Protect objects that are needed to
   describe a single megablock, for all megablocks in a filespace.

*  The ratio of the amount of data, reported by Change Block Tracking,
   versus the amount of data that was actually backed up, in a specific
   backup.

*  The ratio of the amount of data, reported by Change Block Tracking,
   versus the amount of data that was actually backed up, for all
   backups in this filespace.

*  The number of backups that were created since the last full backup
   was created from the production disks.

The values returned on query vm can help you fine tune the heuristics
(see the Mbobjrefreshthresh and Mbpctrefreshthresh options) to fine tune
the values trigger for megablock refreshes.

Use the detail option with the following commands:

*  delete filespace
*  incremental
*  query archive
*  query backup
*  query filespace
*  query inclexcl
*  query mgmtclass
*  query vm

Supported Clients

This option is valid for all clients. This option is not set in the
client options file; use it by adding it to the command line when you
enter any of the commands that support it. The IBM Spectrum Protect API
does not support this option.

Syntax

>>-DETail------------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc query mgmtclass -detail

         dsmc query filespace -detail

         dsmc query backup file1 -detail

         dsmc query vm -detail


3.4.36 Diffsnapshot


The diffsnapshot option controls whether the backup-archive client
creates the differential snapshot when it runs a snapshot difference
incremental backup.

If the differential snapshot is not created by the client, the latest
snapshot found on the volume is used as the differential snapshot and as
the source for the backup operation.

The default value is to create the differential snapshot. This option is
ignored the first time that the snapdiff option is used. The first time
the snapdiff option is used on a volume, a snapshot must be created and
used as the source for a full incremental backup. Snapshots that are
created by the backup-archive client are deleted by the client after the
next snapshot difference incremental backup is complete.

Snapshots can be created with the Network Appliance FilerView tool. Use
the latest parameter if you want the client to use the most recent
snapshot that was created with this or any other method. Snapshots that
are created by methods outside of IBM Spectrum Protect are never deleted
by the client.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option is valid for Linux x86_64 clients.

Syntax

                 .-create-.
>>-DIFFSNAPSHOT--+--------+------------------------------------><
                 '-latest-'



Parameters

create
         Specifies that you want to create a new, persistent, snapshot
         to use as the source snapshot. This value is the default.

latest
         Specifies that you want to use the latest snapshot that is
         found on the file server as the source snapshot.

Examples

Command line:
         Perform a snapshot difference incremental backup of an NFS
         mounted file system /vol/vol1 hosted on the file server
         homestore.example.com, where /net/home1 is the mount point of
         /vol/vol1.
         incremental -snapdiff -diffsnapshot=latest /net/home1

         The -diffsnapshot option value of latest means that the
         operation uses the latest snapshot (the active snapshot).


3.4.37 Diffsnapshotname


The diffsnapshotname option allows you to specify which differential
snapshot, on the target filer volume, to use during a snapshot
differential backup. This option is only specified if you also specify
diffsnapshot=latest.

If this option is not specified, diffsnapshot=latest selects the most
recent existing snapshot on the filer volume and uses it as the
differential snapshot.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.



Supported Clients

This option can be used with supported x86_64 Linux clients.

Options File

This option can be specified in the client options file or on the
command line.

Syntax

>>-DIFFSNAPSHOTName-- --snapshot_name-------------------------><



Parameters

snapshot_name
         Specifies the name of an existing snapshot to use as the
         differential snapshot.
         You can also use a pattern with wildcard characters to select a
         snapshot. Wildcards can be either of the following characters:

         *
                  An asterisk (*) matches any character.

         ?
                  A question mark (?) matches a single character.
         The most recent snapshot that matches the wildcard pattern is
         selected as the differential snapshot.

Examples

Options file:
         diffsnapshotname volume_base_snap

         diffsnapshotname nightly.?

Command line:
         dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff
           -useexistingbase -basenameshotname="nightly.?"
           -diffsnapshot=latest -diffsnapshotname="nightly.?"


3.4.38 Dirmc


The dirmc option specifies the management class you want to use for
directories.

If you do not specify this option to associate a management class with
directories, the client program uses the management class in the active
policy set of your policy domain with the longest retention period.
Select a management class for individual directories that retains
directories at least as long as it retains the files associated with
them.

If you specify a management class with this option, all directories
specified in a backup operation are bound to that management class.

The dirmc option specifies the management class of directories that you
back up and it does not affect archived directories. Use the archmc
option with the archive command to specify the available management
class for your policy domain to which you want to bind your archived
directories and files. If you do not use the archmc option, the server
binds archived directories to the default management class. If the
default management class has no archive copy group, the server binds
archived directories to the management class with the shortest retention
period.

Important: Only extended attributes and ACLs are stored in storage
pools. The directory information, other than extended attributes and
ACLs, remains in the database. On Windows systems, directories occupy
storage pool space.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Backup tab, Directory Management Class section in
the Preferences editor.

Syntax

>>-DIRMc-- --mgmtclassname------------------------------------><



Parameters

mgmtclassname
         Specifies the name of the management class that you want to
         associate with directories. The client uses the management
         class name that you specify for all of the directories that you
         back up. If you do not specify this option, the client
         associates the management class with the longest retention
         period with directories.

Examples

Options file:
         dirm managdir

Command line
         Does not apply.


3.4.39 Dirsonly


The dirsonly option processes directories only. The client does not
process files.

Use the dirsonly option with the following commands:

*  archive
*  incremental
*  query archive
*  query backup
*  restore
*  restore backupset
*  retrieve
*  selective

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-DIrsonly----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc query backup -dirsonly "/Users/*"

Command line:
         dsmc query backup -dirsonly "*"


3.4.40 Disablenqr


The disablenqr option specifies whether the backup-archive client can
use the no-query restore method for restoring files and directories from
the server.

If you set the disablenqr option to no (the default), the client can use
the no-query restore process.

If you set the disablenqr option to yes, the client can use only the
standard restore process (also known as "classic restore").

Note: There is no option or value to specify that the client can use
only the no-query restore method.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Options File

Place this option in the dsm.opt file.

Syntax

               .-No--.
>>-DISABLENQR--+-----+-----------------------------------------><
               '-Yes-'



Parameters

No
         Specifies that the client can use the no-query restore method.
         This is the default.

Yes
         Specifies that the client uses only the standard restore
         method. The no-query restore method is not allowed.

Examples

Options file:
         disablenqr yes

Command line
         -disablenqr=yes


3.4.41 Diskbuffsize


The diskbuffsize option specifies the maximum disk I/O buffer size (in
kilobytes) that the client can use when reading files. The diskbuffsize
option replaces the largecommbuffers option.

Optimal backup, archive, or HSM migration client performance can usually
be achieved if the value for this option is equal to or smaller than the
amount of file read ahead provided by the client file system. A larger
buffer requires more memory and it might not improve performance.

Important: Use the default setting, unless otherwise directed by IBM
support personnel.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-DISKBuffsize-- --size--------------------------------------><



Parameters

size
         Specifies the maximum disk I/O buffer size (in kilobytes) that
         the client uses when reading files. The range of values is 16
         through 1023; the default is 256. If enablelanfree yes is set,
         the default setting for diskbuffsize is 32.

Examples

Options file:
         diskbuffsize 64

Command line:
         Does not apply.


3.4.42 Diskcachelocation


The diskcachelocation option specifies the location where the disk cache
database is created if the option memoryefficientbackup=diskcachemethod
is set during an incremental backup.

You can specify the diskcachelocation option in your option file, or
with the include.fs option. If the diskcachelocation option appears in
the option file, its value is used for all file systems not represented
by an include.fs option containing the diskcachelocation option.

The disk cache is a temporary file which is deleted after the
incremental command is run. Use this option to select one of the
following:

1. A location that has more free disk space if, when you are using
   memoryefficientbackup=diskcachemethod, you get the message that the
   disk cache file cannot be created because you do not have enough disk
   space.

2. A location on a different physical volume to reduce contention for
   the disk access mechanism, and therefore improve performance.

Important: For performance reasons, do not use a remote drive for
diskcachelocation.

The actual amount of disk space required for the disk cache file created
by disk cache incremental backups depends on the number of files and
directories included in the backup and on the average length of the
files and directories to be backed up. For UNIX and Linux, estimate 1
byte per character in the path name. For Mac OS X, estimate 4 bytes per
character in the path name. For example, if there are 1 000 000 files
and directories to be backed up and the average path length is 200
characters, then the database occupies approximately 200 MB for UNIX and
Linux, and 800 MB for Mac OS X clients. Another way to estimate for
planning purposes is to multiply the number of files and directories by
the length of the longest path to establish a maximum database size.

A second disk cache file is created for the list of migrated files when
backing up an HSM managed file system. The combined disk cache files,
created by disk cache incremental backups and HSM managed file system
backups, can require above 400 MB of disk space for each million files
being backed up. The disk cache file can become very large. Large file
support must be enabled on the file system that is being used for the
disk cache file.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

>>-DISKCACHELocation-- --path---------------------------------><



Parameters

path
         Specifies the location where the disk cache database is created
         if memoryefficientbackup=diskcachemethod. The default location
         is to create the disk cache file in the root of the file space
         being processed.

Examples

Options file:
         diskcachelocation /home
         diskcachelocation /Volumes/hfs2

Command line:
         Does not apply.


3.4.43 Domain


The domain option specifies what you want to include for incremental
backup.

Domain objects are backed up only if you start the incremental command
without a file specification.

The backup-archive client uses the domain value in the following
situations to determine which file systems to process during an
incremental backup:

*  When you run an incremental backup by using the incremental command,
   and you do not specify which file systems to process.

*  When your IBM Spectrum Protect administrator defines a schedule to
   run an incremental backup for you, but does not specify which file
   systems to process.

*  When you select the Backup Domain action from the backup-archive
   client GUI

*  When you run an incremental backup by using the incremental command,
   and you do not specify which drives to process.

*  When your IBM Spectrum Protect administrator defines a schedule to
   run an incremental backup for you, but does not specify which drives
   to process.

*  When you select the Backup Domain action from the backup-archive
   client GUI

You can define the domain option in the following locations:

*  In an options file.

*  On the command line, when entered with a client command.

*  In a client option set, which is defined on the server with the
   define clientopt command.

*  As an option on a scheduled command, which is defined on the server
   with the define schedule command.

If any of these sources contain a domain definition, the client backs up
that domain. If more than one source specifies a domain, the client
backs up all specified domains. The same domain object can be defined
more than once, but the effect is the same as defining it only once. If
you do not specify a domain, the client backs up the default domain, as
described in the all-local parameter.

You can exclude objects from the domain by specifying the exclusion
operator (-) before the object. If any domain definition excludes an
object, that object is excluded from the domain, even if another
definition includes the object. You cannot use the domain exclusion
operator (-) in front of any domain keyword that begins with all-.

If a domain statement excludes one or more objects and no domain
statement includes any objects, the result is an empty domain (nothing
is backed up). You must specify the objects to include in the domain if
any domain statements exclude objects.

Example 1: This example uses one domain statement to back up all local
file systems except for /fs1:

domain all-local -/fs1

Example 2: This example uses multiple domain statements to back up all
local file systems except for /fs1:

domain all-local domain -/fs1

Example 3: This example excludes /fs1 during a backup operation. If no
other domain statement is used, the result is an empty domain. Nothing
is backed up.

domain -/fs1

If you start the incremental command with a file specification, the
client ignores any domain definitions and backs up only the file
specification.

You can include a virtual mount point in your client domain.

Important: If you are running GPFS for AIX or GPFS for Linux x86_64 in a
multinode cluster, and all nodes share a mounted GPFS file system, the
client processes this file system as a local file system. The client
backs up the file system on each node during an incremental backup. To
avoid this situation, you can do one of the following tasks:

*  Explicitly configure the domain statement in the client user options
   file (dsm.opt) to list the file systems you want that node to back
   up.

*  Set the exclude.fs option in the client system-options file to
   exclude the GPFS file system from backup services.

Automounted file systems

When you perform a backup with the domain option set to all-local, files
that are handled by automounter and loopback file systems are not backed
up.

If you back up a file system with the domain option set to all-local,
any subdirectories that are mount points for an automounted file system
(AutoFS) are excluded from a backup operation. Any files that exist on
the server for the automounted subdirectory are expired.

When you perform a backup with the domain option set to all-lofs, all
explicit loopback file systems (LOFS) are backed up and all automounted
file systems are excluded. For loop devices and local file systems that
are handled by automounter, set the domain option to all-auto-lofs.

Use the automount option with the domain parameters, all-auto-nfs, and
all-auto-lofs to specify one or more automounted file systems to be
mounted and added into the domain. If you specify the automount option,
automounted file systems are remounted if they go offline during the
execution of the incremental command.

Virtual mount points cannot be used with automounted file systems.

Important: On some Linux distributions, automounted file system mount
points or maps of file system type (AutoFS) might not be listed in the
current mount table. As a result, the automounted files systems, which
are unmounted during backup or archive processing, might be incorrectly
processed and stored as part of a wrong domain (for example, as part of
domain all-local, all-nfs, or all-lofs, depending on the actual file
system type). Therefore, in such Linux distribution environments, you
must specify the appropriate automount option setting to correctly
process your domain option setting at all points in time.

For Mac OS X, automounted file systems are not supported. If an
automounted file system is part of a domain statement, the backup fails
and no files in the automounted file system are processed. Back up and
restore the automounted file system from the host system. Do not back up
or restore the automounted file system over a network connection.

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the options file, dsm.opt or dsm.sys. In the
dsm.sys file, you must place this option within a server stanza. You can
set this option on the Backup tab, Domain for Backup section of the
Preferences editor.

Syntax

           .- -----------------.
           V .-all-local-----. |
>>-DOMain----+---------------+-+-------------------------------><
             +-domain--------+
             +- -domain-----+
             +-all-lofs------+
             +-all-nfs-------+
             +-all-auto-nfs--+
             '-all-auto-lofs-'



Parameters

all-local
         Backs up all local file systems except LOFS file systems and
         LOFS through automounter. This parameter is the default. The
         /tmp directory is not included.

domain
         Defines the file systems to include in your default client
         domain.

         When you use domain with the incremental command, it processes
         these file systems in addition to those file systems you
         specify in your default client domain.

-domain
         Defines the file systems to exclude in your default client
         domain.

all-lofs
         Backs up all loopback file systems, except those file systems
         that are handled by automounter. This parameter is not
         supported on Mac OS X.

         Note: On Linux, you must configure an appropriate /etc/fstab
         entry to include a bind mount into the all-lofs domain.

all-nfs
         Backs up all network file systems, except those file systems
         that are handled by automounter. This parameter is not
         supported on Mac OS X.

all-auto-nfs
         Backs up all network file systems (but not local file systems)
         which are handled by automounter. This parameter is not
         supported on Mac OS X.

all-auto-lofs
         Backs up all loop devices and local file systems that are
         handled through automounter. This parameter is not supported on
         Mac OS X.

object
         Specifies the domain objects to include in the domain.

         An object name must be enclosed in quotation marks if the name
         includes any spaces.

-object
         Specifies the domain objects to exclude from the domain.

         An object name must be enclosed in quotation marks if the name
         includes any spaces.

Examples

Options file:
         An options file can contain more than one domain statement.
         However, each of the domain statements is an example of a
         single statement in an options file.

         domain all-local
         domain all-local -/Volumes/volume2
         domain all-local '-/Volumes/Macintosh HD'


         domain /tst /datasave /joe
         "domain all-local"
         domain ALL-LOCAL -/home
         domain ALL-NFS -/mount/nfs1

         A single domain statement can list one or more objects for the
         domain. You can use more than one domain statement. The
         following two examples from two options files yield the same
         domain result:

         Example 1
                  ...
                  domain fs1
                  domain all-local
                  domain -fs3
                  ...

         Example 2
                  ...
                  domain all-local fs1 -fs3
                  ...

Command line:
         -domain="/ /Volumes/volume2"
         -domain="all-local -/Volumes/volume2"


         -domain="/fs1 /fs2"
         -domain=/tmp
         -domain="ALL-LOCAL -/home"

Domain definition interaction

Domain can be defined in several sources, and the result is a summation
of all domain definitions. As an example of the interaction of domain
definitions, consider how domain definitions from several sources yield
different backup results. In the table, FS followed by a number (for
example, FS1) is a file system. This table shows only commands that are
entered on the command line. For scheduled commands, the command-line
column is not relevant, and options from the scheduled command must be
considered.

Table 44. Interaction of domain definitions from several sources

+-----------------+-----------------+----------------+----------------+
| Options file    | Command line    | Client option  | Objects backed |
|                 |                 | set            | up using the   |
|                 |                 |                | incremental    |
|                 |                 |                | command        |
+-----------------+-----------------+----------------+----------------+
| domain FS1      | incremental     | domain FS3     | FS1 FS2 FS3    |
|                 | -domain=FS2     |                |                |
+-----------------+-----------------+----------------+----------------+
| domain FS1      | incremental     | domain FS3     | FS1 FS3        |
+-----------------+-----------------+----------------+----------------+
|                 | incremental     |                | FS2            |
|                 | -domain=FS2     |                |                |
+-----------------+-----------------+----------------+----------------+
|                 | incremental     | domain FS3     | FS2 FS3        |
|                 | -domain=FS2     |                |                |
+-----------------+-----------------+----------------+----------------+
|                 | incremental     | domain FS3     | FS3            |
+-----------------+-----------------+----------------+----------------+
|                 | incremental     |                | all-local      |
+-----------------+-----------------+----------------+----------------+
| domain          | incremental     | domain FS3     | all-local +    |
| all-local       |                 |                | FS3            |
+-----------------+-----------------+----------------+----------------+
| domain          | incremental     |                | all-local ,    |
| all-local       |                 |                | but not FS1    |
| domain -FS1     |                 |                |                |
+-----------------+-----------------+----------------+----------------+
| domain -FS1     | incremental     |                | none           |
+-----------------+-----------------+----------------+----------------+
| domain FS1 FS3  | incremental     | domain -FS3    | FS1            |
+-----------------+-----------------+----------------+----------------+
| domain          | incremental     | domain -FS3    | all-local ,    |
| all-local       |                 |                | but not FS3    |
+-----------------+-----------------+----------------+----------------+
|                 | incremental FS1 |                | FS1            |
|                 | -domain=all-loc |                |                |
|                 | al              |                |                |
+-----------------+-----------------+----------------+----------------+
|                 | incremental FS1 | domain         | FS1            |
|                 |                 | all-local      |                |
+-----------------+-----------------+----------------+----------------+
| domain -FS1     | incremental FS1 |                | FS1            |
+-----------------+-----------------+----------------+----------------+


3.4.44 Domain.image


The domain.image option specifies what you want to include in your
client domain for an image backup.

If you do not specify a file system with the backup image command, the
file systems you specify with the domain.image option are backed up.

When you specify a file system with the backup image command, the
domain.image option is ignored.

If you do not use the domain.image option to specify file systems in
your client options file, and you do not specify a file system with the
backup image command, a message is issued and no backup occurs.

Supported Clients

This option is valid for AIX, Linux x86_64, Linux on POWER, and Solaris.
The server can also define this option. The IBM Spectrum Protect API
does not support this option.

This option is valid for all supported Windows clients. The server can
also define this option. The IBM Spectrum Protect API does not support
this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option in the Backup -> Domain for
Backup box in the Preferences editor.

Syntax

                 .- ---------.
                 V            |
>>-DOMAIN.IMage----+--------+-+--------------------------------><
                   '-domain-'



Parameters

domain
         Defines the file systems or raw logical volumes to include in
         your default client image domain.

Examples

Options file:
         domain.image /fs1 /fs2

Command line:
         Does not apply.


3.4.45 Domain.nas


The domain.nas option specifies the volumes to include in your NAS image
backups.

You can specify all-nas to include all the mounted file systems on the
NAS file server, except those you exclude with the exclude.fs.nas
option.

The backup-archive client uses your domain for NAS image backups when
you run a backup nas command and you do not specify which volumes to
process.

When you use this option in your client system options file (dsm.sys),
the domain.nas option defines your default domain for NAS image backups.
When you perform a NAS file system image backup using the backup nas
command, the client adds the volumes that you specify on the command
line to the volumes defined in your dsm.sys file. For example, if you
enter domain.nas nas1/vol/vol0 nas1/vol/vol1 in your dsm.sys file and
you enter dsmc backup nas -nasnodename=nas1 /vol/vol2 on the command
line, the client backs up the vol/vol0, vol/vol1, and vol/vol2 volumes
on node nas1.

If you set the domain.nas option to all-nas in the dsm.opt file, the
client backs up all mounted volumes on the NAS file server. When
performing a backup, if you use a file specification and set the
domain.nas option to all-nas in the dsm.sys file, all-nas takes
precedence.

Supported Clients

This option is only valid for AIX and Solaris clients. The server can
also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

               .- ----------.
               V .-all-nas-. |
>>-DOMAIN.Nas----+---------+-+---------------------------------><
                 '-domain--'



Parameters

domain
         Defines the volumes you want to process. You cannot exclude
         volumes by specifying the dash (-) operator.

all-nas
         Processes all mounted volumes on the NAS file server, except
         those you exclude with the exclude.fs.nas option. This is the
         default. If there is no domain.nas statement in the dsm.opt
         file and no volumes specified on the command line, the client
         backs up all mounted volumes on the NAS server.

Examples

Options file:
         domain.nas nas1/vol/vol0 nas1/vol/vol1
         domain.nas all-nas

Command line:
         Does not apply.


3.4.46 Domain.vmfull


The domain.vmfull option specifies the virtual machines (VMs) to include
in your full virtual machine image backup operations.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

This option applies to both VMware and Microsoft Hyper-V virtual machine
disks.

Domain.vmfull for VMware virtual machines

For VMware virtual machine backups, the domain.vmfull option works with
the vmchost option. The vmchost option identifies the vCenter server or
ESX server that contains the virtual machines that you want to protect.
The domain.vmfull parameters are used to narrow the focus of an
operation to a subset of the virtual machines that are running on the
system that is identified by vmchost.

You can specify which virtual machines are to be processed by using any
of the following techniques:

*  Use the VM= option and specify the name of a virtual machine.

*  Provide a comma-separated list of virtual machine names.

*  Use wildcard syntax to process virtual machines that match the name
   pattern.

*  Use one of the following domain-level parameters:

      all-vm
      all-windows
      schedule-tag
      vmhost
      vmfolder
      vmhostcluster
      vmdatastore
      vmresourcepool
      vmhostfolder
      vmdatacenter

When you use domain-level parameters, virtual machines that are created
in the domain are automatically included when the next backup occurs.
For example, if you use the vmfolder parameter to back up all virtual
machines included in a folder, any new virtual machines that get added
to that folder are included in the next backup. The same is true of
pattern-matched names that are included in a wildcard match.

The virtual machines that are specified on the domain.vmfull option are
processed only when the backup vm command is entered without specifying
a virtual machine or a list of virtual machines on the command line.

Supported Clients

This option can be used with supported x86_64 Linux clients.

The server can also define this option.

Options file

Set this option in the client options, by using the command line, or by
using the VM Backup tab of the Preferences editor.

Restriction: The following parameters cannot be set in the Preferences
Editor. Include this setting in the options file, or on the command line
when you run a backup vm command:

   vmname:vmdk=vmdk_label
   schedule-tag
   vmresourcepool
   vmhostfolder
   vmdatacenter

Syntax for VMware virtual machines

                  .-;----------------------------------------------.
                  V .-vmname1,vmname2----------------------------. |
>>-DOMAIN.VMFUll----+--------------------------------------------+-+-><
                    +-VM=vmname1,vmname2-------------------------+
                    +- -VM=vmname1,vmname2-----------------------+
                    +-ALL-VM-------------------------------------+
                    +-ALL-WINdows--------------------------------+
                    +-SCHEDULE-TAG-------------------------------+
                    +-VMHost=srv1,srv2---------------------------+
                    +-VMFolder=foldername1,foldername2-----------+
                    +-VMHOSTCLUSTER=cluster1,cluster2------------+
                    +-VMDATASTORE=datastore1,datastore2----------+
                    +-VMRESOURCEPOOL=resourcepool1,resourcepool2-+
                    +-VMHOSTFOLDER=hostfolder1,hostfolder2-------+
                    '-VMDATACENTER=datacenter1,datacenter2-------'



Syntax rules: Multiple keywords must be separated by a semicolon. Do not
include any spaces after the semicolons. Multiple virtual machine or
domain names must be separated by commas, with no space characters. For
examples, see vm=vmname. The rule about multiple virtual machine or
domain names does not apply if you are using the "Schedule-Tag" keyword.

Parameters

vmname
         Specifies the virtual machine name that you want to process.
         The name is the virtual machine display name. You can specify a
         list of virtual machine host names by separating the names with
         commas (vm1,vm2,vm5). The names are case-sensitive.

vm=vmname
         The vm= keyword specifies that the next set of values is a list
         of virtual machine names. The vm= keyword is the default and is
         not required.

         In this example, vm= is not specified and commas are used to
         separate the machine names.

         domain.vmfull my_vm1,my_vm2
         If you specify multiple keywords, such as vm= and vmfolder=,
         the values that the keywords refer to must be separated by
         semicolons, with no intervening space characters:

         domain.vmfull vm=my_vm1;vm=my_vm2
         domain.vmfull vm=my_vm1;vmfolder=folder1;vmfolder=folder2

         Wildcard characters can be used to select virtual machine names
         that match a pattern. An asterisk (*) matches any sequence of
         characters. A question mark (?) matches any single character,
         for example:

         *  Exclude all files that have "test" in the host name:
            -vm=*test*

         *  Include all virtual machines with names such as: "test20",
            "test25", "test29", "test2A": vm=test2?
         You can exclude a virtual machine from a backup operation by
         specifying the exclude operator (-) before the vm= keyword. For
         example, -vm is used to exclude a particular machine, or
         machines, from a domain level backup, such as, ALL-Windows,
         ALL-VM, and VMFolder. If "vm1" is the name of a virtual machine
         in a folder that is named "accountingDept", you can back up all
         of the virtual machines in the folder, but prevent the virtual
         machine "vm1" from being backed up. Set the following option:

         domain.vmfull VMFolder=accountingDept;-vm=vm1

         You cannot use the exclude operator (-) to exclude a domain,
         such as ALL-VM, ALL-Windows, or VMFolder. The exclude operator
         works only at the virtual machine name level.

vmname:vmdk=vmdk_label
         The :vmdk= keyword applies only to VMware virtual machines and
         its use requires a license for IBM Spectrum Protect for Virtual
         Environments: Data Protection for VMware.

         This option is typically used to exclude disks (see the :-vmdk
         syntax) from being backed up. You can also include virtual
         machine disks by using the INCLUDE.VMDISK option or exclude
         virtual machine disks by using the EXCLUDE.VMDISK option.

         Detailed guidance for excluding disks when you back up VMware
         virtual machines is provided in the IBM Spectrum Protect for
         Virtual Environments Data Protection for VMware product
         documentation on IBM Documentation at
         https://www.ibm.com/docs/en/spfve.

         The virtual disks within a virtual machine have disk labels
         that uniquely identify each virtual disk. You use the :vmdk=
         keyword to specify the labels of the virtual disks that you
         want to be included in a Backup VM operation. If you do not
         specify :vmdk= and a disk label, all virtual disks in the
         virtual machine are backed up.

         Assume that there is a virtual machine named "my_vm_example".
         This virtual machine has four disks (labeled Hard Disk 1, Hard
         Disk 2, Hard Disk 3, Hard Disk 4). To include only Hard Disk 2
         and Hard Disk 3 in a backup, add the :vmdk= keyword and disk
         label for those disks. Quotation marks are necessary around the
         parameters because the disk labels contain space characters.
         For example:

         domain.vmfull "my_vm_example:vmdk=Hard Disk 2:vmdk=Hard Disk 3"

         This next example backs up Hard Disk 1 and Hard Disk 2 on VM1,
         and Hard Disk 3 and Hard Disk 4 on VM2. A comma is used to
         separate the virtual machine information.

         domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2",
           "vm2:vmdk=Hard Disk 3:vmdk=Hard Disk 4"

         Similar to the -vm= keyword, you can also use the exclusion
         operator (-) with :vmdk= to exclude disks from a backup
         operation.

         To back up a virtual machine (vm1) and exclude disks 3 and 4,
         use the following syntax:

         domain.vmfull "vm1:-vmdk=Hard Disk 3:-vmdk=Hard Disk 4"

         To back up two virtual machines, vm1 and vm2, and exclude the
         first two disks on each machine, use the following syntax:

         domain.vmfull "vm1 :-vmdk=Hard Disk 1:-vmdk=Hard Disk 2",
           "vm2:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2"

         You can include one or more disks on a domain.vmfull statement.
         You can exclude one or more disks on a domain.vmfull statement.
         You can mix include and exclude disks on the same statement.
         For example, the following statement is valid:

         domain.vmfull
           "vm1:vmdk=Hard Disk 1:-vmdk=Hard Disk 2:vmdk=Hard Disk 3:vmdk:Hard Disk 4"

         If an include statement is present, all other disks in the
         virtual machine are excluded from a backup operation, unless
         the other disks are also specified in an include statement. For
         example, the following statement excludes all hard disks on
         vm1, except for Hard Disk 1:

         domain.vmfull "vm1:vmdk=Hard Disk 1"

         Both of the following exclude Hard Disk 4 from a backup of vm1:

         domain.vmfull "vm1:vmdk=Hard Disk 1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"
         domain.vmfull "vm1:-vmdk=Hard Disk 4"

all-vm
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option.

all-windows
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option. The virtual
         machines must also have a guest operating system type of
         Windows.

schedule-tag
         For scheduled backups of VMware virtual machines. This option
         processes all virtual machines that are defined to the Virtual
         Center server that is specified on the vmchost option.

         The IBM Spectrum Protect server administrator can add this
         option to a schedule definition to indicate that the schedule
         is compatible with the Schedule (IBM Spectrum Protect) category
         and tag. Virtual machines in VMware objects that are assigned
         with the Schedule tag are backed up according to the schedule.

         Requirement: To be compatible for tagging, the -domain.vmfull
         option must contain no additional domain-level parameters other
         than the Schedule-Tag parameter in the schedule definition.
         Otherwise, the Schedule (IBM Spectrum Protect) tag is ignored.
         The option is case insensitive and must contain no spaces.
         Quotation marks that enclose the Schedule-Tag parameter are
         optional. Virtual machines in VMware containers that are tagged
         with incompatible schedules are not backed up.

         For more information about the Schedule tag, see "Supported
         data protection tags.".

vmhost=hostname
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option. The host name
         that you specify must match the fully qualified host name or IP
         address, as it is specified in the vCenter server Hosts and
         Clusters view.

         All virtual machines that are added to this host are
         automatically included in backup and restore processing. To be
         included, the virtual machines must also be running on the ESX
         server that is specified by the host name; they cannot be
         powered off.

         This parameter can include multiple ESX servers that are
         separated by commas. When the Virtual Center contains multiple
         ESX servers, this option does not determine the ESX server from
         which a snapshot is taken. The ESX server from which a snapshot
         is taken is determined by the VMware VirtualCenter web service.

         When you connect directly to an ESXi or ESX host, the vmchost
         option applies only if the vmhost is the server that you
         connect to. If it is not, a warning level message is sent to
         the console and is recorded in the dsmerror.log file; it is
         also recorded as a server event message.

         If the vmenabletemplatebackups option is set to yes, and VM
         templates are part of the domain, they are included in the
         backup.

         Restriction: VMware templates for virtual machines cannot be
         backed up when they are in an ESX or ESXi host because ESX and
         ESXi hosts do not support templates.

vmfolder=foldername
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option. The virtual
         machines must also exist in the VMware folder that is specified
         by the folder name. Folder name can include multiple VMware
         folders that are separated by commas.

vmhostcluster=hostclustername
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option. The virtual
         machines must also be running on the ESX host cluster that is
         specified by the host cluster name. To include more than one
         host cluster name, separate the cluster names with commas:
         VMHOSTCLUSTER=cluster1,cluster2.

         If the vmenabletemplatebackups option is set to yes, and VM
         templates are part of the domain, they are included in the
         backup. A VMware host cluster is not available if you connect
         directly to an ESXi or ESX host. If you connect directly to an
         ESXi/ESX host and a domain is processed that includes a host
         cluster, a warning level message is sent to the console and is
         recorded in the dsmerror.log file; it is also recorded as a
         server event message.

vmdatastore=datastorename
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center or to the ESX
         server that is specified on the vmchost option. The configured
         datastore location for a virtual machine must match the
         datastore name that is specified by datastorename. The
         datastore name can include multiple datastores that are
         separated by commas: VMDATASTORE=datastore1,datastore2

         Virtual machines can have their disk (vmdk files) on more than
         one datastore; but there is only one default datastore
         location. This default datastore location is defined in the
         virtual machine configuration and is always where the virtual
         machine configuration file (.vmx file) is located. When a
         machine is selected for backup by using a domain keyword, the
         virtual machine configuration file, and all of the virtual
         machine's disks are included in the backup, including the disks
         that are on a different datastore than the one specified as the
         domain.

vmresourcepool=resourcepoolname
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center server that is
         specified on the vmchost option. The virtual machines must also
         exist in the VMware resource pool that is specified by the
         resource pool name. The resource pool name can include multiple
         resource pools that are separated by commas, for example:
         VMRESOURCEPOOL=resourcepool1,resourcepool2

vmhostfolder=hostfoldername
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center server that is
         specified on the vmchost option. The virtual machines must also
         exist in the VMware host folder that is specified by the host
         folder name. The host folder name can include multiple VMware
         host folders that are separated by commas, for example:
         VMHOSTFOLDER=hostfolder1,hostfolder2

vmdatacenter=datacentername
         For VMware virtual machines. This option processes all virtual
         machines that are defined to the Virtual Center server that is
         specified on the vmchost option. The virtual machines must also
         exist in the VMware datacenter that is specified by the
         datacenter name. The datacenter name can include multiple
         datacenters that are separated by commas, for example:
         VMDATACENTER=datacenter1,datacenter2

Tip: If you specify more than one container type, for example,
vmfolder=folder1 and vmhostcluster=cluster2, all virtual machines that
are contained in folder1 and cluster2 are protected. The virtual
machines do not have to be in both folder1 and cluster2.

You can specify the virtual machines as shown in this example:
domain.vmfull=vmfolder=folder1;vmhostcluster=cluster2

Examples for VMware virtual machines

Options file:
         Include all virtual machines in full VM backup operations.

         domain.vmfull all-vm


         Include all virtual machines in full VM backup operations,
         except for the ones that have a name suffix of _test.

         domain.vmfull all-vm;-vm=*_test


         Include all virtual machines that have Windows as the operating
         system, in full VM backup operations.

         domain.vmfull all-windows
         Include all virtual machines in cluster servers 1, 2, and 3 in
         full VM backup operations.

         domain.vmfull vmhostcluster=cluster1,cluster2,cluster3
         Include all virtual machine data in datastore1 in full VM
         backup operations.

         domain.vmfull vmdatastore=datastore1
         Include all virtual machines in full VM backup operations, but
         exclude virtual machines testvm1 and testmvm2.

         domain.vmfull all-vm;-VM=testvm1,testvm2
         Include the virtual machines that are defined in the VM folders
         that are named lab1 and lab2 in full VM backup operations.

         domain.vmfull vmfolder=lab1,lab2
         Include all virtual machines on the ESX hosts named "brovar",
         "doomzoo", and "kepler" in full VM backup operations.

         domain.vmfull vmhost=brovar.example.com,
           doomzoo.example.com,kepler.example.com
         Include the virtual machines in VMware resource pools
         resourcepool_A and resourcepool_B in full VM backup operations.

         domain.vmfull vmresourcepool=resourcepool_A,resroucepool_B
         Include the virtual machines that are defined in the VMware
         host folders named hostfolder1 and hostfolder2 in full VM
         backup operations.

         domain.vmfull vmhostfolder=hostfolder1,hostfolder2
         Include all virtual machines in VMware datacenter dc1 in full
         VM backup operations.

         domain.vmfull vmdatacenter=dc1


3.4.47 Dontload


x86_64 Linux clients can use the dontload option to suppress specific
plug-in libraries from being loaded when the backup-archive client is
started.

The TIVsm_BAhdw.x86_64 package provided in Linux x86_64 distributions
contains software that is required to support snapshot incremental
backups for NetAPP and N-Series file servers. When this package is
installed on a Linux x86_64 system that is used to perform data mover
operations for a virtual machine, the files in this package cause all
VMware backup operations to fail. When these failures occur, the
following message is displayed:

ANS8811E

VMware operations cannot be run when the hardware plug-in product
TIVsm-BAhdw is installed and loaded. Either uninstall the hardware
product TIVsm-BAhdw, or set the option DONTLOAD PIHDW in the options
file to prevent the hardware plug-in from being loaded.

Use this option to prevent the plug-in library from being loaded into
RAM when the client is started. Alternatively, you can uninstall the
TIVsm_BAhdw package if it is not needed for snapshot operations.

Supported Clients

This option is only valid for Linux x86_64 clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-DONTLoad----PIHDW-------------------------------------------><



Parameters

PIHDW
         Specifies that the hardware plug-in (TIVsm-BAhdw) is not loaded
         into RAM when the client is started. Use this option on
         backup-archive clients that have the hardware plug-in
         installed, to prevent the plug-in from causing failures when
         performing backup-archive operations on VMware virtual
         machines. There is no default for the dontload option.

         To determine whether the plug-in is installed, enter the
         following command and examine the output.

         rpm -q -a | grep TIV

         If the output contains a package starting with "TIVsm-BAhdw"
         (followed by a version string), the hardware plug-in package is
         installed.

Examples

Options file:
         DONTLoad PIHDW

Command line:
         Does not apply. Do not use this option on the command line.


3.4.48 Dynamicimage


Use the dynamicimage option with the backup image command or the
include.image option to specify that you want to perform a dynamic image
backup.



Supported Clients

This option is valid for AIX, Solaris, and all Linux clients. The IBM
Spectrum Protect API does not support this option.

Options File

Place the include.image statement containing the dynamicimage value in
the server stanza in your system-options file, dsm.sys. You can also set
this option using the Preferences editor.

Syntax

>>-DYNAMICImage-- --value-------------------------------------><



Parameters

value
         Specifies one of the following values:

yes
         Use this option only if the volume cannot be unmounted and
         remounted as read-only. The client backs up the volume as is
         without remounting it as read-only. Corruption of the backup
         can occur if applications write to the volume while the backup
         is in progress. In this case, run fsck after a restore and
         manually mount the file system in order to regain access to the
         volume. This option is valid for AIX, Solaris, and all Linux
         clients.

         Note: This option is not allowed for AIX JFS2 file systems.



no
         Use this option if you do not want to perform a dynamic image
         backup. This is the default. The default behavior depends on
         the platform and file system type. For platforms and file
         systems that support snapshot, namely AIX JFS2 file systems and
         LINUX LVM file systems, the default is snapshot-based image
         backup. For all other UNIX platforms and file systems, the
         default is static image backup.

Examples

Options file:
         include.image /kalafs1 dynamicimage=yes

Command line on backup image:
         dynamicimage=yes


3.4.49 Efsdecrypt


The efsdecrypt option allows you to control whether or not files
encrypted by an AIX Encrypted File System (EFS) are read in encrypted or
decrypted format.

The efsdecrypt option default is no, which is to back up the encrypted
or raw data. If you specify yes, the files are backed up as clear text,
which means that they are backed up as normal files, as if the files
existed in unencrypted form on the file system.

Important: Whenever you run a backup that includes any files encrypted
on an EFS, you must ensure that you use the correct specification of the
efsdecrypt option. If the efsdecrypt option value changes between two
incremental backups, all encrypted files on EFS file systems are backed
up again, even if they have not changed since the last backup. For
example, if you are running an incremental backup of encrypted files
that were previously backed up as "raw," then ensure that efsdecrypt is
specified as no. If you change efsdecrypt to yes, all the files are
backed up again in clear text even if they are unchanged, so ensure that
you use this option carefully.

Note: This is a global option that is applied to the complete backup.
Two separate invocations of the client are required to back up some
encrypted files as raw data and others as clear text.

Supported Clients

This option is valid for AIX clients.

Options File

Place this option in the dsm.sys file or the client user-options file
(dsm.opt). In the dsm.sys file, you must place this option within a
server stanza.

Syntax

               .-No--.
>>-EFSDecrypt--+-----+-----------------------------------------><
               '-Yes-'



Parameters

No
         Encrypted files are read in encrypted or raw data format, and
         IBM Spectrum Protect encryption and compression is forced off.
         This is the default.

Yes
         Encrypted files are read in decrypted or clear text format.

Examples

Options file:
         EFSDecrypt yes

Command line:
         -EFSDecrypt=no


3.4.50 Enablearchiveretentionprotection


The enablearchiveretentionprotection option allows the client to connect
to the IBM Spectrum Protect for Data Retention server. This ensures that
archive objects will not be deleted from the server until policy-based
retention requirements for that object have been satisfied.

This option is ignored if the client connects to a server that is not
retention protection enabled. If the option is no (the default) and an
attempt is made to connect to a data retention server, the connection is
refused.

The data retention server is specially configured for this task, so
normal backup or restore processing is rejected by the server. When the
client is connected to a data retention server, the following commands
will not be available. If you attempt to use these commands, a message
is displayed indicating that they are not valid with this server.

*  incremental
*  backup (all subcommands)
*  selective
*  restore (all subcommands except restore backupset -location=file or
   -location=tape)

   Note: restore backupset -location=file or -location=tape do not
   connect to any server (except the virtual one) and thus will not be
   blocked under any circumstances.
*  restart restore
*  delete backup
*  delete group
*  expire
*  All queries except:

   *  query access

   *  query archive

   *  query filespace

   *  query inclexcl

   *  query managementclass

   *  query node

   *  query options

   *  query schedule

   *  query session

   *  query systeminfo

   *  query tracestatus

Supported Clients

This option is valid for all clients.

Options File

This option is valid only in the dsm.sys file within a server stanza and
is not valid in a client option set from the server. It is not valid on
any command line.

Syntax

                                     .-No--.
>>-ENABLEARCHIVERETENTIONProtection--+-----+-------------------><
                                     '-Yes-'



Parameters

No
         The data retention server connection is refused. This is the
         default.

Yes
         The client connects to a data retention server.


3.4.51 Enablededupcache


Use the enablededupcache option to specify whether you want to use a
cache during client-side data deduplication. Using a local cache can
reduce network traffic between the IBM Spectrum Protect server and the
client.

When you perform a backup or archive operation with the data
deduplication cache enabled, the specification of data extents that are
backed up or archived are saved to the cache database. The next time you
run a backup or archive, the client queries the data deduplication cache
and identifies the extents of data that have been previously saved to
the server. Data extents that are identical to data extents on the
server are not resent to the server.

If the server and the cache are not synchronized, the cache is removed
and a new one is created.

Only one process can access the distributed data deduplication cache at
a time. Concurrent backup instances on a workstation, that use the same
server and storage pool, must either use unique node names or unique
cache specifications. In this way, all the instances can use a local
cache and optimize the client-side data deduplication.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API also
supports this option.

Options File

Place this option in the system-options file (dsm.sys) within a server
stanza. You can set this option on the Deduplication -> Enable
Deduplication Cache check box of the Preferences editor. The option can
be set in the client option set on the IBM Spectrum Protect server.

Syntax

                     .-Yes*-.
>>-ENABLEDEDUPCache--+------+----------------------------------><
                     '-No---'



Parameters

Yes
         Specifies that you want to enable data deduplication cache. If
         data deduplication is not enabled, this setting is not valid.
         Yes is the default for the backup-archive client. No is the
         default for the IBM Spectrum Protect API.

No
         Specifies that you do not want to enable data deduplication
         cache.

Examples

Options file:
         enablededupcache no

Command line:
         -enablededupcache=no

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.31 Deduplication
3.4.29 Dedupcachepath
3.4.30 Dedupcachesize


3.4.52 Enableinstrumentation


By default, instrumentation data is automatically collected by the
backup-archive client and IBM Spectrum Protect API to identify
performance bottlenecks during backup and restore processing. To disable
or later enable instrumentation, use the enableinstrumentation option.

With this option enabled, you do not have to wait for a customer service
representative to direct you to collect performance data when a problem
occurs. Instead, the data can be collected whenever you run a backup or
restore operation. This feature can be helpful because you do not have
to re-create the problem just to collect performance data. The
information is already collected by the client.

This option replaces the -TESTFLAG=instrument:detail,
-TESTFLAG=instrument:API, and -TESTFLAG=instrument:detail/API options
that are used in previous versions of the client and API.

For each process, the following types of performance instrumentation
data are collected:

*  The activity names for each thread (such as File I/O, Data Verb,
   Compression, and Transaction), the average elapsed time per activity,
   and the frequency of the activity.

*  The total activity time of each thread.

*  The command that was issued and the options that were used.

*  The summary of the backup, restore, or query command.

By default, the performance data is stored in the instrumentation log
file (dsminstr.log) in the directory that is specified by the DSM_LOG
environment variable (or the DSMI_LOG environment variable for
API-dependent products such as IBM Spectrum Protect for Databases: Data
Protection for Microsoft SQL Server and IBM Spectrum Protect for Mail:
Data Protection for Microsoft Exchange Server). If you did not set the
DSM_LOG environment variable, the instrumentation log file is stored in
the current directory (the directory where you issued the dsmc command).

You can optionally change the name and location of the instrumentation
log file by using the instrlogname option. You can also control the size
of the log file by specifying the instrlogmax option.

Performance data is not collected for the backup-archive client GUI or
web client GUI.

Performance data is collected for the following products when the
enableinstrumentation option is specified in the client options file:

*  Scheduled file-level backup operations with the backup-archive client

*  IBM Spectrum Protect for Virtual Environments: Data Protection for
   VMware backups

*  IBM Spectrum Protect for Virtual Environments: Data Protection for
   Microsoft Hyper-V backups

*  IBM Spectrum Protect for Databases: Data Protection for Microsoft SQL
   Server backups

*  IBM Spectrum Protect for Mail: Data Protection for Microsoft Exchange
   Server backups



Performance data is also collected during archive and retrieve
processing.

Supported Clients

This option is valid for all clients and the IBM Spectrum Protect API.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Tip: This option is enabled by default, so typically, you do not need to
place this option in the client options file unless you need to disable
the option.

Syntax

                          .-Yes-.
>>-ENABLEINSTRUMENTATION--+-----+------------------------------><
                          '-No--'



Parameters

Yes
         Specifies that you want to collect performance data during
         backup and restore operations. The default value is Yes, which
         means that performance data is collected even if you do not
         specify this option.

         By default, the performance data is stored in the
         instrumentation log file (dsminstr.log) in the directory that
         is specified by the DSM_LOG environment variable. If you did
         not set the DSM_LOG environment variable, the instrumentation
         log file is stored in the current directory (the directory
         where you issued the dsmc command). If the file does not exist,
         the client creates the file and adds performance data to the
         file.

No
         Specifies that you do not want to collect performance data
         during backup and restore operations. If the instrumentation
         log exists, no more data is added to the file.

Examples

Options file:
         enableinstrumentation yes

Command line:
         dsmc sel /home/mydir/* -subdir=yes -enableinstrumentation=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.90 Instrlogname
3.4.89 Instrlogmax


3.4.53 Enablelanfree


The enablelanfree option specifies whether to enable an available
LAN-free path to a storage area network (SAN) attached storage device.

A LAN-free path allows backup, restore, archive, and retrieve processing
between the backup-archive client and the SAN-attached storage device.

To support LAN-free data movement you must install and configure the IBM
Spectrum Protect for SAN storage agent on the client workstation.

Notes:

*  If you place the enablelanfree option in the client options file
   (dsm.opt), but zero (0) bytes were transferred through the SAN during
   an operation, ensure that you bind the data to a LAN-free enabled
   management class.

*  To restore backup sets in a SAN environment, see the RESTORE
   BACKUPSET topic for more information.

*  When a LAN-free path is enabled, the SAN Storage Agent settings
   override the client tcpserveraddress, tcpport, and ssl options. This
   override action occurs to ensure that both the client and the Storage
   Agent use the same server communication options.

*  Client encryption with the include.encrypt option is no longer
   supported for LAN-free backup and archive operations to the IBM
   Spectrum Protect server 8.1.1 and later levels, or IBM Spectrum
   Protect7.1.8 and later version 7 levels. LAN-free restore and
   retrieve operations of encrypted backup versions and archive copies
   continue to be supported. If you need to encrypt data by using the
   include.encrypt option, in which data is encrypted before it is sent
   to the server, use LAN-based backup or archive operations.

To specify a communication protocol between the backup-archive client
and storage agent, see the lanfreecommethod option for more information.

Supported Clients

This option is valid for AIX, Linux x86_64, Linux on Power Systems,
Linux on z Systems, and Solaris clients.

Options File

Place this option in the dsm.sys file within a server stanza. You can
also set this option by selecting the Enable Lanfree check box on the
General tab in the Preferences editor.

Syntax

                  .-No--.
>>-ENABLELanfree--+-----+--------------------------------------><
                  '-Yes-'



Parameters

Yes
         Specifies that you want to enable an available LAN-free path to
         a SAN-attached storage device.

No
         Specifies that you do not want to enable a LAN-free path to a
         SAN-attached storage device. This is the default.

Examples

Options file:
         enablelanfree yes

Command line:
         -enablelanfree=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.54 Encryptiontype


Use the encryptiontype option to specify the algorithm for data
encryption.

The encryptiontype affects only backup and archive operations. The data
that you include is stored in encrypted form, and encryption does not
affect the amount of data that is sent or received. During restore and
retrieve operations the encrypted data is decrypted with the proper
encryption algorithm, regardless of the setting for this option.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can also set this option on the Authorization tab of
the Preferences editor. The server can override this.

Syntax

                   .-AES128-.
>>-ENCRYPTIONType--+--------+----------------------------------><
                   '-AES256-'



Parameters

AES128
         AES 128-bit data encryption. AES 128-bit is the default.

AES256
         AES 256-bit data encryption. AES 256-bit data encryption
         provides the highest level of data encryption available in
         backup and archive operations.

Examples

Options file:
         encryptiontype aes128

Command line:
         Does not apply.


3.4.55 Encryptkey


The backup-archive client supports the option to encrypt files that are
being backed up or archived to the IBM Spectrum Protect server. This
option is enabled with the include.encrypt option.

All files matching the pattern on the include.encrypt specification are
encrypted before the data is sent to the server. There are three options
for managing the key used to encrypt the files (prompt, save, and
generate). All three options can be used with either the backup-archive
client or the IBM Spectrum Protect API.

The encryption key password is case-sensitive and can be up to 64
characters in length.

The following characters can be included in the encryption key password:

A-Z
         Any letter, A through Z, uppercase or lowercase. You cannot
         specify national language characters.
0-9
         Any number, 0 through 9
+
         Plus
.
         Period
_
         Underscore
-
         Hyphen
&
         Ampersand

Note:

1. The API has an alternate way of specifying encryptkey=generate; the
   previous enableclientencryptkey=yes option can also be specified to
   request generate encryption processing.

2. The enableclientencryptkey=yes API option is still supported, so it
   is possible when using the API to specify two conflicting options.
   For example, enableclientencryptkey=yes and encryptkey=prompt or
   encryptkey=save.

3. When conflicting values are specified, the API returns an error
   message.

Attention: When using the prompt option, your encryption key is not
saved in the IBM Spectrum Protect password file on UNIX. If you forget
the key, your data cannot be recovered.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Authorization tab,
Encryption Key Password section of the Preferences editor.

Syntax

               .-save-----.
>>-ENCRYPTKey--+----------+------------------------------------><
               +-prompt---+
               '-generate-'



Parameters

save
         The encryption key password is saved in the backup-archive
         client password file. A prompt is issued for an initial
         encryption key password, and after the initial prompt, the
         saved encryption key password in the password file is used for
         the backups and archives of files matching the include.encrypt
         specification. The key is retrieved from the password file on
         restore and retrieve operations.

         The password can be up to 64 bytes in length.

         When the save option is specified for an API application, the
         initial key password must be provided by the application using
         the API in the dsmInitEx function call. The API itself does not
         issue a prompt to the user but relies on the application to
         prompt the user as necessary.

         This parameter is the default.

         Note: The following restrictions apply:

         *  This option can only be used when passwordaccess generate is
            also specified.

         *  The root user or an authorized user must specify the initial
            encryption key password.



prompt
         The management of the encryption key password is provided by
         the user. The user is prompted for the encryption key password
         when the client begins a backup or archive. A prompt for the
         same password is issued when restoring or retrieving the
         encrypted file.

         This password can be up to 64 bytes in length.

         When the prompt option is specified for an API application, the
         key password must be provided by the application using the API
         in the dsmInitEx function call. The API itself does not issue a
         prompt to the user but relies on the application to prompt the
         user as necessary.



generate
         An encryption key password is dynamically generated when the
         client begins a backup or archive. This generated key password
         is used for the backups of files matching the include.encrypt
         specification. The generated key password, in an encrypted
         form, is kept on the IBM Spectrum Protect server. The key
         password is returned to the client to enable the file to be
         decrypted on restore and retrieve operations.

Examples

Options file:
         encryptkey prompt

Command line:
         Does not apply.


3.4.56 Errorlogmax


The errorlogmax option specifies the maximum size of the error log, in
megabytes. The default name for the error log is dsmerror.log.

Log wrapping is controlled by the errorlogmax option. If errorlogmax is
set to zero (0), the size of the log is unlimited; logged entries never
"wrap" and begin overwriting earlier logged entries. If errorlogmax is
not set to zero, the newest log entries overwrite the oldest log entries
after the log file reaches its maximum size.

Log pruning is controlled by the errorlogretention option. Pruned logs
do not wrap. Instead, log entries that are older than the number of days
specified by the errorlogretention option are removed from the log file.

If you change from log wrapping (errorlogmax option) to log pruning
(errorlogretention option), all existing log entries are retained and
the log is pruned using the new errorlogretention criteria. Pruned log
entries are saved in a file called dsmerlog.pru.

If you change from using log pruning (errorlogretention option) to using
log wrapping (errlogmax option), all records in the existing log are
copied to the dsmerlog.pru log file, the existing log is emptied, and
logging begins using the new log wrapping criteria.

If you simply change the value of the errorlogmax option, the existing
log is extended or shortened to accommodate the new size. If the value
is reduced, the oldest entries are deleted to reduce the file to the new
size.

If neither errologmax nor errorlogretention is specified, the error log
can grow without any limit on its size. You must manually manage the log
contents to prevent the log from depleting disk resources. When the log
has been created with neither option specified, if you later issue a
command and specify the errorlogretention option, the log is pruned
using the retention value specified. When the log has been created with
neither option specified, if you later issue a command and specify the
errorlogmax option, the existing log is treated as if it was a pruned
log. That is, the content of the dsmerror.log file is copied to a file
called dsmerlog.pru and new log entries are created in dsmerror.log and
the log is wrapped when it reaches its maximum size.

Note: If you specify a non-zero value for errorlogmax (which enables log
wrapping), you cannot use the errorlogretention option to create pruned
logs. Logs can be pruned or wrapped, but not both.

Logs created with the errorlogmax option contain a log header record
that contains information similar to this example record:

LOGHEADERREC 661  104857600 IBM Spectrum Protect 8.1.0 Fri Dec 9 06:46:53 2011

Note that the dates and time stamps in the LOGHEADERREC text are not
translated or formatted using the settings specified on the dateformat
or timeformat options.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

You can also set this option on the Client preferences tab in the GUI,
by selecting Enable error log file wrapping and by specifying a non-zero
maximum size for the log file. To prevent log file wrapping, set the
maximum size to zero. When the maximum wrapping is set to zero, clearing
or setting the Enable error log file wrapping option has no effect; log
wrapping does not occur if the maximum size is set to zero.

Syntax

>>-ERRORLOGMAX-- --size---------------------------------------><



Parameters

size
         Specifies the maximum size, in megabytes, for the log file. The
         range of values is 0 to 2047; the default is 0, which disables
         log file wrapping and allows the log file to grow indefinitely.

Examples

Options file:
         errorlogmax 2000

Command line:
         -errorlogmax=2000

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.57 Errorlogname


This option specifies the fully qualified path and file name of the file
that contains the error messages.

The value for this option overrides the DSM_LOG environment variable.
The dsmwebcl.log and dsmsched.log files are created in the same
directory as the error log file you specify with the errorlogname
option.

For Mac OS X, the default location is one of the following:

~/Library/Logs/tivoli/tsm/
/Library/Logs/tivoli/tsm/


The dsmerror.log cannot be a symbolic link.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the General tab, Select Error
Log button of the Preferences editor.

Syntax

>>-ERRORLOGName-- --filespec----------------------------------><



Parameters

filespec
         The fully qualified path and file name in which to store error
         log information. If any part of the path you specify does not
         exist, the client attempts to create it.

         The dsmerror.log file cannot be a symbolic link.

Examples

Options file:
         errorlogname /tmp/tsmerror.log

Command line:
         -errorlogname=/tmp/tsmerror.log

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.58 Errorlogretention


The errorlogretention option specifies how many days to maintain error
log entries before pruning, and whether to save the pruned entries in
other files.

The error log is pruned when the first error is written to the log after
a client session is started. If the only session you run is the client
scheduler, and you run it twenty-four hours a day, the error log might
not be pruned according to your expectations. Stop the session and start
it again to allow the scheduler to prune the error log.

If you change from log pruning (errorlogretention option) to log
wrapping (errorlogmax option), all records in the existing log are
copied to the dsmerlog.pru log file, the existing log is emptied, and
logging begins using the new log wrapping criteria.

If you change from log wrapping (errorlogmax option) to log pruning
(errorlogretention option), all existing log entries are retained and
the log is pruned using the new errorlogretention criteria. Pruned log
entries are saved in a file called dsmerlog.pru.

If neither errologmax nor errorlogretention is specified, the error log
can grow without any limit on its size. You must manually manage the log
contents to prevent the log from depleting disk resources. When the log
has been created with neither option specified, if you later issue a
command and specify the errorlogretention option, the log is pruned
using the retention value specified. When the log has been created with
neither option specified, if you later issue a command and specify the
errorlogmax option, the existing log is treated as if it was a pruned
log. That is, the content of the dsmerror.log file is copied to a file
called dsmerlog.pru and new log entries are created in dsmerror.log and
the log is wrapped when it reaches its maximum size.

Note: If you specify errorlogretention option to create pruned logs, you
cannot specify the errorlogmax option. Logs can be pruned or wrapped,
but not both.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

You can also set this option on the Client preferences tab in the GUI,
by selecting Prune old entries and by specifying a value for Prune
entries older than. Selecting the Save pruned entries option saves the
pruned log entries in the dsmerlog.pru log file.

Syntax

                      .-N----.  .-D-.
>>-ERRORLOGRetention--+------+--+---+--------------------------><
                      '-days-'  '-S-'



Parameters

N or days
         Specifies how long to wait before pruning the error log.

         N
                  Do not prune the error log. This permits the error log
                  to grow indefinitely. This is the default.

         days
                  The number of days to keep log file entries before
                  pruning the log. The range of values is zero through
                  9999.

D or S
         Specifies whether to save the pruned entries. Enter a space or
         comma to separate this parameter from the previous one.

         D
                  Discard the error log entries when you prune the log.
                  This is the default.

         S
                  Save the error log entries when you prune the log.

                  The pruned entries are copied from the error log to
                  the dsmerlog.pru file located in the same directory as
                  the dsmerror.log file.



Examples

Options file:
         Prune log entries from the dsmerror.log file that are older
         than 365 days and save the pruned entries in dsmerlog.pru.

         errorlogretention 365 S

Command line:
         -errorlogr=365,S

Options file:
         Prune log entries from the dsmerror.log file that are older
         than 365 days and do not save the pruned entries.

         errorlogretention 365 D

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.59 Exclude options


Use the exclude options to exclude objects from backup, image, or
archive services.

For example, you might want to exclude this type of information:

*  All temporary files

*  Any local caches of network files

*  All files that contain compiled object code that you can easily
   reproduce using other methods

*  Your operating system files

You can exclude specific files from encryption processing during a
backup.

You can exclude remotely accessed files by specifying Universal Naming
Convention (UNC) names in your exclude statement. For examples of
statements using UNC file names, see the Backup-Archive product
documentation on IBM Documentation.

Note:

1. With the exception of exclude.fs, when you exclude a file that was
   previously included, existing backup versions become inactive during
   the next incremental backup.

2. The server can define exclude options with the inclexcl option.

3. As with other include-exclude statements, you can use the inclexcl
   option to specify a file that can be in Unicode format, containing
   exclude statements with file names in Unicode. See the INCLEXCL topic
   for more information.

Exclude any system files or images that could corrupt the operating
system when recovered. Also exclude the directory containing the IBM
Spectrum Protect client files.

Use wildcard characters to exclude a broad range of files. Then, if
necessary, use the include option to make exceptions.

To exclude an entire directory called /any/test, enter the following:

  exclude.dir /any/test

To exclude subdirectories that begin with test under the /any directory,
enter the following:

  exclude.dir /any/test*

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set these options on the Include-Exclude tab,
Define Include-Exclude Options section of the Preferences editor.

Syntax

>>-options-- --pattern----------------------------------------><



exclude, exclude.backup, exclude.file, exclude.file.backup
         Use these options to exclude a file or group of files from
         backup services and space management services (if the HSM
         client is installed). The exclude.backup option only excludes
         files from normal backup, but not from HSM.

exclude.archive
         Excludes a file or a group of files that match the pattern from
         archive services only.

exclude.attribute.symlink
         Excludes a file or a group of files that are symbolic links or
         aliases (aliases apply to Mac OS X) from backup processing
         only.

         Note: For Mac OS X aliases are excluded.

exclude.compression
         Excludes files from compression processing if the compression
         option is set to yes. This option applies to backups and
         archives.

exclude.dedup
         Excludes files from client-side data deduplication. To control
         a client-side data deduplication operation, specify ieobjtype
         as the value of the exclude.dedup option.

         Valid ieobjtype parameters are:

            File
            Image

         The default is File.

exclude.dir
         Excludes a directory, its files, and all its subdirectories and
         their files from backup processing. For example, the statement
         exclude.dir /test/dan/data1 excludes the /test/dan/data1
         directory, its files, and all its subdirectories and their
         files.

         If you exclude a directory that was previously included, the
         server expires existing backup versions of the files and
         directories beneath it during the next incremental backup. Use
         this option to exclude a portion of your data that has no
         underlying files to back up.



         Note: Avoid performing a selective backup, or a partial
         incremental backup, of an individual file within an excluded
         directory. The next time that you perform an incremental
         backup, any files backed up in this manner is expired.

exclude.encrypt
         Excludes the specified files from encryption processing. This
         option does not affect whether files are excluded from backup
         or archive processing, only whether they are excluded from
         encryption processing.

exclude.fs
         Excludes file systems that match the specified pattern from
         backup, incremental image backup, and archive operations. If
         files from the excluded file systems were ever backed up, then
         management class rebinding and deleted file expiration does not
         occur. However, existing backup versions remain on the server
         subject to associated management class settings. The files that
         were previously archived from the excluded file system remain
         on the server as archive copies.

         The exclude.fs option does NOT prevent the backup or archive of
         any virtual mount points that are subdirectories of the
         excluded file system.



         Use exclude.image to exclude file systems from full image
         backup operations.

exclude.fs.nas
         Excludes file systems on the NAS file server from an image
         backup when used with the backup nas command. The NAS node name
         must be prefixed to the file system name, for example:
         netappsj1/vol/vol1. To apply the exclude to all NAS nodes,
         replace the NAS node name with a wildcard, for example:
         */vol/vol1. The backup nas command ignores all other exclude
         statements including exclude.fs and exclude.dir statements.
         This option is valid for AIX and Solaris clients only.

exclude.image
         Excludes mounted file systems and raw logical volumes that
         match the specified pattern from full image backup operations.
         This option is valid for AIX, all Linux clients, and Solaris
         only. Use exclude.fs to exclude file systems from incremental
         image backup operations.

         Restriction: This option does not apply to Mac OS X.

Parameters

pattern
         Specifies the file or group of files that you want to exclude.

         Note: For NAS file systems: You must prefix the NAS node name
         to the file specification to specify the file server to which
         the exclude statement applies. If you do not specify a NAS node
         name, the file system identified refers to the NAS node name
         specified in the client system-options file (dsm.sys) or on the
         command line.



         If the pattern begins with a single or double quote or contains
         any embedded blanks or equal signs, you must surround the value
         in either single (') or double (") quotation marks. The opening
         and closing quotation marks must be the same type of quotation
         marks.



         For the exclude.image option, the pattern is the name of a
         mounted file system or raw logical volume.



Examples

Options file:
         exclude /unix/
         exclude /.../core
         exclude /home/jones/proj1/*
         exclude.archive /.../core
         exclude.backup /home/jones/proj1/devplan/
         exclude.dir /home/jones/tmp
         exclude.backup /users/home1/file1
         exclude.image /usr/*/*
         exclude.encrypt /users/home2/file1
         exclude.compression /home/gordon/proj1/*
         exclude.fs.nas netappsj/vol/vol0
         exclude.attribute.symlink /.../*
         exclude.dedup /Users/Administrator/Documents/Important/.../*

Command line:
         Does not apply.


3.4.59.1 Controlling symbolic link and alias processing


The backup-archive client treats symbolic links and aliases (aliases
apply to Mac OS X only) as actual files and backs them up. However, the
file referenced by the symbolic link is not backed up. In some cases
symbolic links can be easily recreated and need not be backed up.

In addition, backing up these symbolic links can increase backup
processing time and occupy a substantial amount of space on the IBM
Spectrum Protect server. You can use the exclude.attribute.symlink
option to exclude a file or a group of files that are symbolic links
from backup processing. If necessary, you can use the
include.attribute.symlink option to include symbolic links within broad
group of excluded files for backup processing.

For example, to exclude all symbolic links from backup processing,
except those that exist under the /home/spike directory, enter these
statements in your dsm.sys file:

  exclude.attribute.symlink  /.../*
  include.attribute.symlink /home/spike/.../*

See the INCLUDE OPTIONS topic for more information about the
include.attribute.symlink option.

Related reference
3.4.86 Include options


3.4.59.2 Controlling compression processing


This topic lists some items to consider if you want to exclude specific
files or groups of files from compression processing during a backup or
archive operation.

*  Remember that the backup-archive client compares the files it
   processes against the patterns specified in the include-exclude
   statements, reading from the bottom to the top of the options file.

*  You must set the compression option to yes to enable compression
   processing. If you do not specify the compression option or you set
   the compression option to no, the client does not perform compression
   processing. See the COMPRESSION topic for more information.

   If you set the compression option to yes and no exclude.compression
   statements exist, the client considers all files for compression
   processing.

*  The client processes exclude.fs, exclude.dir, and other
   include-exclude statements first. The client then considers any
   exclude.compression statements. For example, consider the following
   include-exclude list:

   exclude /home/jones/proj1/*.*
   exclude.compression /home/jones/proj1/file.txt
   include /home/jones/proj1/file.txt



   The client examines the statements (reading from bottom to top) and
   determines that the /home/jones/proj1/file.txt file is a candidate
   for backup, but is not a candidate for compression processing.

*  Include-exclude compression processing is valid only for backup and
   archive processing. The exclude.compression option does not affect
   whether files are excluded from backup or archive processing, only
   whether they are excluded from compression processing.

Related reference
3.4.22 Compression


3.4.59.3 Processing NAS file systems


Use the exclude.fs.nas option to exclude file systems from NAS image
backup processing.

Note: The exclude.fs.nas option does not apply to a snapshot difference
incremental backup.

A NAS file system specification uses the following conventions:

*  NAS nodes represent a unique node type. The NAS node name uniquely
   identifies a NAS file server and its data to the backup-archive
   client. You can prefix the NAS node name to the file specification to
   specify the file server to which the exclude statement applies. If
   you do not specify a NAS node name, the file system identified
   applies to all NAS file servers.

*  Regardless of the client platform, NAS file system specifications use
   the forward slash (/) separator, as in this example: /vol/vol0.

For example, to exclude /vol/vol1 from backup services on all NAS nodes,
specify the following exclude statement:

exclude.fs.nas */vol/vol1


3.4.59.4 Virtual machine exclude options


Virtual machine include and exclude options influence the behavior of
backup and restore operations for virtual machines. These options are
processed before any command-line options are processed, so that options
on the command line can override options specified on any of the virtual
machine include options or virtual machine exclude options. See the
individual option descriptions for information about the options.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Related reference
3.4.59.4.1 Exclude.vmdisk


3.4.59.4.1 Exclude.vmdisk


The EXCLUDE.VMDISK option excludes a virtual machine disk from backup
operations.

The EXCLUDE.VMDISK option specifies the label of a virtual machine's
disk to be excluded from a backup vm operation. If you exclude a disk on
the backup vm command, the command-line parameters override any
EXCLUDE.VMDISK statements in the options file.

This option is available only if you are using the IBM Spectrum Protect
for Virtual Environments licensed product. For more information about
this option, see the IBM Spectrum Protect for Virtual Environments
product documentation on IBM Documentation at
https://www.ibm.com/docs/en/spfve.

This option applies to both VMware and Microsoft Hyper-V virtual machine
disks.

EXCLUDE.VMDISK for VMware virtual machines

Use the EXCLUDE.VMDISK option to exclude a VMware virtual machine from
backup operations.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

Set this option in the client options file. Command line parameters
override statements in the options file.

Syntax for VMware virtual machines

>>-EXCLUDE.VMDISK--vmname-- --vmdk_label-----------------------><



Parameters

vmname
         Specifies the name of the virtual machine that contains a disk
         that you want to exclude from a Backup VM operation. The name
         is the virtual machine display name. You can specify only one
         virtual machine name on each EXCLUDE.VMDISK statement. Specify
         additional EXCLUDE.VMDISK statements for each virtual machine
         disk to exclude.
         The virtual machine name can contain an asterisk (*), to match
         any character string, and question mark (?) to match any one
         character. Surround the VM name with quotation marks ("") if
         the VM name contains space characters.
         Tip: If the virtual machine name contains special characters,
         such as bracket characters ([) or (]), the virtual machine name
         might not be correctly matched. If a virtual machine name uses
         special characters in the name, you might need to use the
         question mark character (?) to match the special characters in
         the VM name.

         For example, to exclude Hard Disk 1 in the backup of a virtual
         machine named "Windows VM3 [2012R2]", use this syntax in the
         options file: EXCLUDE.VMDISK "Windows VM3 ?2012R2?" "Hard Disk
         1"

vmdk_label
         Specifies the disk label of the disk that you want to exclude.
         Wildcard characters are not allowed. Use the Backup VM command
         with the -preview option to determine the disk labels of disks
         in a given virtual machine. See the "Backup VM" topic for the
         syntax.
         Do not exclude disks on virtual machines that you are
         protecting with the INCLUDE.VMTSMVSS option, if the disks
         contain application data.

Examples

Options file
         Assume that a virtual machine named vm1 contains four disks,
         labeled Hard Disk 1, Hard Disk 2, Hard Disk 3, and Hard Disk 4.
         To exclude disk 2 from Backup VM operations, specify the
         following statement in the options file:

         EXCLUDE.VMDISK "vm1" "Hard Disk 2"
         Exclude disks 2 and 3 from Backup VM operations:

         EXCLUDE.VMDISK "vm1" "Hard Disk 2"
         EXCLUDE.VMDISK "vm1" "Hard Disk 3"

Command line
         The command line examples show the use of the exclusion
         operator (-) before the vmdk= keyword, to indicate that the
         disk is to be excluded.
         Exclude a single disk:

         dsmc backup vm "vm1:-vmdk=Hard Disk 1"
         Exclude disk 2 and disk 3:

         dsmc backup vm "vm1:-vmdk=Hard Disk 2:-vmdk=Hard Disk 3"
         Exclude disk 1 and disk 2 on vm1:

         dsmc backup vm "vm1:-vmdk=Hard Disk 1:-vmdk=Hard Disk 2"


3.4.59.4.2 Exclude.vmlocalsnapshot


This option excludes a VMware virtual machine from local backup
operations.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

You can use this option only for virtual machines that are stored in a
virtual volume (VVOL) datastore.

Supported clients

This option can be used with supported Linux clients that are configured
to back up VMware virtual machines.

Options file

Set this option in the client options file.

Syntax

>>-EXCLUDE.VMLOCALSNAPSHOT-- --vmname-------------------------><



Parameters

vmname
         Specifies the name of a virtual machine that you want to
         exclude from local backup operations. The name is the virtual
         machine display name.
         Only one virtual machine can be specified on each
         EXCLUDE.VMLOCALSNAPSHOT statement. However, you can specify as
         many EXCLUDE.VMLOCALSNAPSHOT statements as needed to exclude
         multiple virtual machines.
         You can include wildcards in the virtual machine name. An
         asterisk (*) matches any character string. A question mark (?)
         matches a single character. If the virtual machine name
         contains a space character, enclose the name in double
         quotation marks (").

         Tip: If the virtual machine name contains special characters,
         type the question mark wildcard in place of the special
         characters when you specify the virtual machine name.

Example

The following EXCLUDE.VMLOCALSNAPSHOT statement in the client options
file excludes a virtual machine that is named VM1 from local backup
operations:

exclude.vmlocalsnapshot VM1


3.4.60 Fbbranch


Use the fbbranch option with the backup fastback or archive fastback
commands.

The fbbranch option specifies the branch ID of the remote FastBack
server to back up or archive. The fbbranch option is only required when
the backup-archive client is installed on the FastBack Disaster Recovery
Hub or when a dedicated proxy is connecting to a replicated FastBack
Disaster Recovery Hub repository. Do not specify the fbbranch option
when the backup-archive client is installed on the FastBack server.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line. The server
can also define or override this option.

Syntax

>>-FBBranch=--branch_ID----------------------------------------><



Parameters

branch_ID
         Specifies the FastBack server branch ID. The value is part of
         the disaster recovery configuration of the FastBack server.

Examples

Command line:
         -FBBranch=oracle
         On a backup-archive client that is installed on the FastBack
         Disaster Recovery Hub:

         dsmc backup fastback -fbpolicyname=policy1 -fbserver=myFbServer
           -fbbranch=oracle


Command line:
         On a backup-archive client that is connecting to a repository
         on a remote FastBack Disaster Recovery Hub:

         dsmc backup fastback -fbpolicyname=policy1 -fbserver=server1
           -Fbreposlocation=\\myDrHub.company.com\REP
           -fbbranch=oracle

If the fbbranch option is specified on a backup-archive client
workstation that is installed on the FastBack server, the fbbranch
option is ignored.


3.4.61 Fbclientname


Use the fbclientname option with the backup fastback or archive fastback
commands.

The fbclientname option is the name of one or more comma-separated
FastBack clients to back up or archive from the backup proxy. The values
for the fbclientname option are invalid if more than one policy is
specified in the fbpolicyname option.

You cannot include spaces in the fbclientname option values.

If you do not specify any values for the fbvolumename option, all the
volumes from all the FastBack clients in the policy that is specified
are backed up. If you specify multiple FastBack clients in the
fbclientname option, you cannot specify values for the fbvolumename
option.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line.

Syntax

                 .-,-----------.
                 V             |
>>-FBClientname----client_name-+-------------------------------><



Parameters

client_name
         Specifies the name of one or more FastBack clients. You can
         specify up to 10 FastBack client names.

Important:

When specifying the archive fastback or backup fastback command:

1. At least one FBpolicyName is always required.

2. You can specify up to 10 values for FBPolicyName, if no values are
   specified for both FBClientName and FBVolumeName.

3. When you specify a FBClientName value, there must be only one value
   for FBPolicyName.

4. You can specify up to 10 values for FBClientName if only one
   PolicyName is specified, and no values for FBVolumeName are
   specified.

5. When you specify the FBVolumeName option, you can have only one
   FBPolicy, and only one FBCLientName specified.

6. You can specify multiple FBVolumeNames if condition 5 is satisfied.

7. You must always specify the FBReposLocation option for Linux.

Examples

Command line:
         dsmc backup fastback -fbpolicyname=Policy1
           -fbclientname=fbclient1,fbclient2
           -fbserver=myFbServer
           -fbreposlocation=/mnt/FBLocation

         Backs up all volumes for FastBack clients fbclient1 and
         fbclient2 that are found in policy Policy1.


3.4.62 Fbpolicyname


Use the fbpolicyname option with the backup fastback or archive fastback
commands.

The fbpolicyname option is the name of one or more comma-separated
FastBack policies that you want to back up or archive from the backup
proxy. You must specify at least one policy name. Specify multiple
policy names using a comma-delimited list of policies. There is no
default value.

If one or more FB policy names contain spaces, you must specify them
within quotation marks. Here is an example: "FB Policy NAME1, FBPolicy
Name 2".

If you do not specify any values for the fbclientname and fbvolumename
options, all the volumes from all the FastBack clients in the policies
that are specified are backed up. If you specify multiple policies in
the fbpolicyname option, you cannot specify values for the fbclientname
and fbvolumename options.

If a policy specification contains both Windows and Linux FastBack
clients, only the Linux volumes will be backed up or archived to the IBM
Spectrum Protect server by the Linux backup-archive client.

At least one snapshot should exist in the FastBack repository for the
FastBack policies being archived or backed up prior to issuing the dsmc
command

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line.

Syntax

                 .-,-----------.
                 V             |
>>-FBPolicyname----policy_name-+-------------------------------><



Parameters

policy_name
         Specifies the name of the FastBack policies. You can specify up
         to 10 FastBack policy names.

Important:

When specifying the archive fastback or backup fastback command:

1. At least one FBpolicyName is always required.

2. You can specify up to 10 values for FBPolicyName, if no values are
   specified for both FBClientName and FBVolumeName.

3. When you specify a FBClientName value, there must be only one value
   for FBPolicyName.

4. You can specify up to 10 values for FBClientName if only one
   PolicyName is specified, and no values for FBVolumeName are
   specified.

5. When you specify the FBVolumeName option, you can have only one
   FBPolicy, and only one FBCLientName specified. You must specify
   exactly one FBClientName. It cannot be omitted.

6. You can specify multiple FBVolumeNames if condition 5 is satisfied.

7. You must always specify the FBReposLocation option for Linux.

Examples

Command line:
         dsmc backup fastback -fbpolicyname=Policy1,Policy2,Policy3
           -fbserver=myFbServer
           -fbreposlocation=\\myFbServer.company.com\REP

         Backs up all volumes for all FastBack clients found in policies
         Policy1, Policy2 and Policy3.

         To specify policies with spaces, enclose them in double
         quotation marks, for example:

         -fbpolicyname="Policy 1,Policy2,Policy3"





3.4.63 Fbreposlocation


Use the fbreposlocation option with the backup fastback or archive
fastback commands.

The fbreposlocation option specifies the location of the Tivoli Storage
Manager FastBack repository for the backup-archive client proxy to
connect to issue Tivoli Storage Manager FastBack shell commands
necessary to mount appropriate snapshots.

This option is required on Linux systems. There is no default location.

It you specify the fbreposlocation option for a snapshot on the FastBack
server, use the server_name@WORKGROUP format.

There are two ways to specify the FastBack repository location on the
FastBack Disaster Recovery Hub:

*  Specify the complete repository location via the option
   -fbreposlocation=\\DR_Hub\rep_server. When using this format, DR_Hub
   is the FastBack Disaster Recovery Hub machine name and rep_server is
   the name of the replicated FastBack server repository on the DR Hub.

*  Specify the repository location using a combination of the
   -fbreposlocation= and -fbbranch options. When using this format,
   specify the DR Hub repository the location via the option
   -fbreposlocation=DR_Hub@WORKGROUP, and specify the name of the
   replicated FastBack server repository on the DR Hub using the
   -fbranch option.

If you use the format -fbr=\\<fbserver>\REP, specify two backslashes
before <fbserver> and one backslash before REP when using the
backup-archive client in interactive mode. If you are using this format
as a Linux command dsmc backup fastback -fbr=\\\\<fbserver>\\REP, you
must specify four backslashes before <fbserver> and two backslashes
before REP. This is because the Linux shell interprets a backslash as an
escape character; the first backslash is treated as an escape character
for the following backslash.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line. The server
can also define or override this option.

Syntax

>>-FBReposlocation--repository_location------------------------><



Parameters

repository_location
         Specifies the Tivoli Storage Manager FastBack repository
         location.

Examples

Command line:
         dsmc backup fastback -fbpolicyname=Policy1
           -fbclientname=fbclient1,fbclient2  -fbserver=myFbDrHub
           -fbreposlocation=\\myFbDrHub\rep_myFbServer

         Note: Because Linux is supported only as a dedicated proxy
         configuration, a repository location is always required on
         Linux.

Command line:
         dsmc backup fastback -fbpolicyname=Policy1
           -fbclientname=fbclient1,fbclient2  -fbserver=myFbDrHub
           -fbreposlocation=myFbDrHub  -fbbranch=rep_myFbServer

         Note: Because Linux is supported only as a dedicated proxy
         configuration, a repository location is always required on
         Linux.


3.4.64 Fbserver


Use the fbserver option with the backup fastback or archive fastback
commands.

The fbserver option specifies the short host name of the Tivoli Storage
Manager FastBack server workstation that owns the repository specified
by the fbreposlocation option. For a DR Hub, the fbserver option
specifies the short name of the FastBack server workstation whose branch
repository the backup-archive client is connecting to.

The fbserver option is a key to retrieving the necessary user
credentials required to connect to the FastBack server repository or the
DR Hub server repository for mount processing.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line.

Syntax

>>- -FBServer-- --server_name---------------------------------><



Parameters

server_name
         Specifies the short hostname of the machine on which the
         FastBack server is installed.

Examples

Command line:
         The backup-archive client is installed on a Linux proxy client
         machine. Use this command to archive all FastBack volumes for
         all Linux FastBack clients that are defined for FastBack
         policy1:

         dsmc archive fastback -fbpolicyname=Policy1
           -fbserver=myfbserver
           -fbreposlocation=myfbserver@WORKGROUP

         The repository location is required. If you do not provide the
         repository location, the command will fail.

         The FastBack server name, -myfbserver, is the short host name
         of the FastBack server where the repository is located.



Command line:
         The repository, rep_server1, is located on the FastBack
         Disaster Recovery Hub, myFbDrHub.

         dsmc archive fastback -fbpolicyname="Policy 1"
           -fbserver=myFbDrHub
           -fbreposlocation=\\myFbDrHub\rep_server1

         The FastBack server name, -myFbDrHub is the short host name of
         the FastBack Disaster Recovery Hub server where the repository
         is located

         The -fbreposlocation specifies the location of the repository.
         The repository location is required. If you do not provide the
         repository location, the command fails.

         -fbserver should point to the short host name of the FastBack
         DR hub in this case.

Command line:
         Archive all volumes protected by FastBack policy named policy1
         from the FastBack server named basil:

         dsmc archive fastback -Fbpolicyname=policy1
           -FBServer=basil -ARCHMC="my_tsm_mgmt_class"
           -fbreposlocation=basil@WORKGROUP


3.4.65 Fbvolumename


Use the fbvolumename option with the backup fastback or archive fastback
commands.

The fbvolumename option is the name of one or more comma-separated
Tivoli Storage Manager FastBack volumes to back up or archive from the
backup proxy. Values for the fbvolumename option are not valid if more
than one FastBack client is specified in the fbclientname option.

If you specify multiple FastBack clients in the fbclientname option, you
cannot specify values for the fbvolumename option.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

None. You can specify this option only on the command line.

Syntax

                 .-,-----------.
                 V             |
>>-FBVolumename----volume_name-+-------------------------------><



Parameters

volume_name
         Specifies the name of the Tivoli Storage Manager FastBack
         volumes. You can specify up to 10 FastBack volume names.

Important:

When specifying the archive fastback or backup fastback command:

1. At least one FBpolicyName is always required.

2. You can specify up to 10 values for FBPolicyName, if no values are
   specified for both FBClientName and FBVolumeName.

3. When you specify a FBClientName value, there must be only one value
   for FBPolicyName.

4. You can specify up to 10 values for FBClientName if only one
   PolicyName is specified, and no values for FBVolumeName are
   specified.

5. When you specify the FBVolumeName option, you can have only one
   FBPolicy, and only one FBCLientName specified. You must specify
   exactly one FBClientName. It cannot be omitted.

6. You can specify multiple FBVolumeNames if condition 5 is satisfied.

7. You must specify the FBReposLocation option.

Examples

Command line:
         dsmc backup fastback -fbpolicyname=Policy1 -fbclientname=client1
           -fbvolumename=data1,data2 -fbserver=myFbDrHub
           -fbreposlocation=\\myFbDrHub\rep_server1

         Backs up volumes data1 and data2 from FastBack client client1
         found in policy Policy1.


3.4.66 Filelist


Use the filelist option to process a list of files.

You can use the filelist option with the following commands:

*  archive
*  backup group
*  delete archive
*  delete backup
*  expire
*  incremental
*  query archive
*  query backup
*  restore
*  retrieve
*  selective

The backup-archive client opens the file you specify with this option
and processes the list of files within according to the specific
command. Except for the restore and retrieve commands, when you use the
filelist option, the client ignores all other file specifications on the
command line.

The files (entries) listed in the filelist must adhere to the following
rules:

*  Each entry must be a fully-qualified or a relative path to a file or
   directory. Note that if you include a directory in a filelist entry,
   the directory is backed up, but the contents of the directory are
   not.

*  Each path must be specified on a single line. A line can contain only
   one path.

*  Paths must not contain control characters, such as 0x18 (CTRL-X),
   0x19 (CTRL-Y) and 0x0A (newline).

*  By default, paths must not contain wildcard characters. Do not
   include asterisk (*) or question marks (?) in a path.

   This restriction can be overridden if you enable the option named
   wildcardsareliteral. For more information about that option, see
   3.4.241 Wildcardsareliteral.

*  The filelist can be an MBCS file or a Unicode file with all Unicode
   entries. For Mac OS X, the filelist can be encoded in the current
   operating system language or UTF-16.

*  If it is set, the client option called quotessareliteral allows
   quotation marks in a file specification to be interpreted literally,
   as quotation marks and not as delimiters. For more information about
   that option, see 3.4.130 Quotesareliteral. If quotesareliteral and
   wildcardsareliteral are not set, normal quotation mark and wildcard
   processing is used.

*  Quotation mark and wildcard processing works as described in the
   following list:

   *  If a path or file name contains a space, enclose the entire path
      in quotation marks (") or single quotation marks ('). For example
      "C:\My Documents\spreadsheet.xls" or
      'C:\My documents\spreadsheet.xls'.

   *  If a path contains one or more single quotation marks ('), enclose
      the entire entry in quotation marks ("). If a path contains one or
      more quotation marks, enclose the entire path in single quotation
      marks. File list processing does not support paths that include a
      mix of quotation marks and single quotation marks.

      The following examples illustrate the correct and incorrect use of
      quotation marks and single quotation marks in paths.

      This path example contains a single quotation mark, so the path
      must be enclosed in quotation marks:

      "/home/gatzby/mydir/gatzby's_report.out"

      This path example contains quotation marks, so it must be enclosed
      in single quotation marks:

      '/home/gatzby/mydir/"top10".out'

      This path example contains a space character, so it must be
      enclosed in either quotation marks or single quotation marks:

      "/home/gatzby/mydir/top 10.out"

      or

      '/home/gatzby/mydir/top 10.out'

      This path example is not supported for filelist processing because
      it contains unmatched delimiters (" and ’):

      /home/gatzby/mydir/andy's_"top 10" report.out

      These paths are not supported for filelist processing because they
      contain wildcard characters:

      /home/gatzby*
      /home/*/20??.txt

*  Any IBM Spectrum Protect filelist entry that does not comply with
   these rules is ignored.

The following are examples of valid paths in a filelist:

   /home/dir/file1
   /usr/tivoli/file2
   /usr/avi/dir1
   /fs1/dir2/file3
   "/fs2/Ha Ha Ha/file.txt"
   "/fs3/file.txt"

To override standard processing of quotation marks and wildcard
characters, see 3.4.130 Quotesareliteral and 3.4.241
Wildcardsareliteral.

You can use the filelist option during an open file support operation.
In this case, the client processes the entries in the filelist from the
virtual volume instead of the real volume.

If an entry in the filelist indicates a directory, only that directory
is processed and not the files within the directory.

If the file name (the filelistspec) you specify with the filelist option
does not exist, the command fails. The client skips any entries in the
filelist that are not valid files or directories. The client logs errors
and processing continues to the next entry.

Use file specifications with the restore and retrieve commands to denote
the destination for the restored filelist entries. For example, in the
following restore command, the file specification /user/record/
represents the restore destination for all entries in the filelist.

restore -filelist=/home/dir/file3 /usr/record/

However, in the following selective command, the file specification
/usr/record/ is ignored.

selective -filelist=/home/dir/file3 /usr/record/

If you specify a directory in a filelist for the delete archive or
delete backup command, the directory is not deleted. filelists that you
use with the delete archive or delete backup command should not include
directories.

The entries in the list are processed in the order they appear in the
filelist. For optimal processing performance, pre-sort the filelist by
file space name and path.

Note: The client might back up a directory twice if the following
conditions exist:

*  The filelist contains an entry for the directory
*  The filelist contains one or more entries for files within that
   directory
*  No backup of the directory exists

For example, your filelist includes the entries /home/dir/file1 and
/home/dir. If the /dir directory does not exist on the server, the
/home/dir directory is sent to the server a second time.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-FILEList = -- --filelistspec-------------------------------><



Parameters

filelistspec
         Specifies the location and name of the file that contains the
         list of files to process with the command.

         Note: When you specify the filelist option on the command line,
         the subdir option is ignored.

Examples

Command line:
         sel -filelist=/home/avi/filelist.txt


3.4.67 Filename


Use the filename option with the query systeminfo command to specify a
file name in which to store information.

You can store information gathered from one or more of the following
items:

*  DSMOPTFILE - The contents of the dsm.opt file.

*  DSMSYSFILE - The contents of the dsm.sys file.

*  ENV - Environment variables.

*  ERRORLOG - The IBM Spectrum Protect error log file.

*  FILE - Attributes for the file name that you specify.

*  INCLEXCL - Compiles a list of include-exclude in the order in which
   they are processed during backup and archive operations.

*  OPTIONS - Compiled options.

*  OSINFO - Name and version of the client operating system (includes
   ULIMIT information for UNIX and Linux).

*  POLICY - Policy set dump.

*  SCHEDLOG - The contents of the schedule log (usually dsmsched.log.

*  CLUSTER - AIX cluster information.

Note: The query systeminfo command is intended primarily as an aid for
IBM support to assist in diagnosing problems, although users who are
familiar with the concepts addressed by this information might also find
it useful. If you use the console option, no special formatting of the
output is performed to accommodate screen height or width. Therefore,
the console output might be difficult to read due to length and
line-wrapping. In this case, use the filename option with the query
systeminfo command to allow the output to be written to a file that can
subsequently be submitted to IBM support.

Supported Clients

This option is valid for all clients.

Syntax

>>-FILEName = -- --outputfilename-----------------------------><



Parameters

outputfilename
         Specifies a file name in which to store the information. If you
         do not specify a file name, by default the information is
         stored in the dsminfo.txt file.

Examples

Command line:
         query systeminfo dsmoptfile errorlog -filename=tsminfo.txt


3.4.68 Filesonly


The filesonly option restricts backup, restore, retrieve, or query
processing to files only.

You cannot restore or retrieve directories from the IBM Spectrum Protect
server when using the filesonly option with the restore or retrieve
commands. However, directories with default attributes are created, if
required, as placeholders for files that you restore or retrieve.

You can also use the filesonly option with the following commands:

*  archive
*  incremental
*  query archive
*  query backup
*  restore
*  restore backupset
*  restore group
*  retrieve
*  selective

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-FILESOnly---------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc incremental -filesonly


3.4.69 Followsymbolic


During a backup operation, the followsymbolic option specifies whether
you want to use a symbolic link as a virtual mount point. During a
restore or retrieve operation, the followsymbolic option specifies how
the backup-archive client restores a directory whose name matches a
symbolic link on the restore target file system.

For backup operations, the followsymbolic option can influence the
virtualmountpoint option setting. If you use the virtualmountpoint
option to specify a symbolic link as a virtual mount point, you must
also set the followsymbolic option.

During restore and retrieve operations, followsymbolic can influence how
the client handles a symbolic link on the file system. Set
followsymbolic only when the client attempts to restore a directory
whose name matches a symbolic link on the restore target file system.

If you specify followsymbolic=no (the default), the client does not
restore the contents of the directory, but returns this error message:

ANS4029E Error processing 'filespace name path-name file-name':
unable to build a directory path; a file exists with the same name
as a directory.

If you specify followsymbolic=yes, the client restores the contents of
the directory to the target of the symbolic link.

For example, assume the client backed up a file with this path:
/fs1/dir1/subdir1/file1. Assume also that a symbolic link /fs1/dir1,
that exists on the restore target file system, links to the directory
/fs88/dir88/subdir88. Restore the file with the command:

restore /fs1/dir1/subdir1/file1

If you specify followsymbolic=no, the client does not restore the file,
but returns the preceding error message. If you specify
followsymbolic=yes, the client restores file1 to the
/fs88/dir88/subdir88/subdir1/file1 directory.

If you restore a symbolic link (not a directory) whose name matches a
symbolic link on the restore target file system, the client restores the
symbolic link.

If a symbolic link is used as a virtual mount point, the path to the
link target must be specified by using an absolute file path.

Use this option with the restore and retrieve commands, or in the client
user-options file (dsm.opt).

Supported Clients

This option is valid for all UNIX clients except Mac OS X.

Options File

Place this option in the client options file (dsm.opt).

Syntax

                   .-No--.
>>-FOLlowsymbolic--+-----+-------------------------------------><
                   '-Yes-'



Parameters

No
         Do not back up a virtual mount point that is a symbolic link.
         Do not restore a directory if the restore target file system
         contains a symbolic link with matching name. This is the
         default.

Yes
         Restore the contents of a directory to the target of a symbolic
         link.

Examples

Options file:
         followsymbolic Yes

Command line:
         -fol=Yes


3.4.70 Forcefailover


The forcefailover option enables the client to be directed immediately
to a failover server.

You can use the forcefailover option to immediately connect to a
failover server, even if the primary server is still online. For
example, you can use this option to verify that the backup-archive
client is redirected to the expected failover server.

Do not edit this option during normal operations.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client-system options file (dsm.sys).

Syntax

                  .-No--.
>>-FORCEFAILOVER--+-----+--------------------------------------><
                  '-Yes-'



Parameters

Yes
         Specifies that the client immediately connects to a failover
         server.

No
         Specifies that the client is directed to a failover server
         during the next logon if the primary server is unavailable.
         This value is the default.

Examples

Options file:
         FORCEFAILOVER yes

Command line:
         -FORCEFAILOVER=yes


3.4.71 Fromdate


Use the fromdate option with the fromtime option to specify a date and
time from which you want to search for backups or archives during a
restore, retrieve, or query operation.

Files that were backed up or archived before this date and time are not
included, although older directories might be included, if necessary, to
restore or retrieve the files.

Use the fromdate option with the following commands:

*  delete backup
*  query archive
*  query backup
*  restore
*  restore group
*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-FROMDate = -- --date---------------------------------------><



Parameters

date
         Specifies the date from which you want to search for backup
         copies or archived files. Enter the date in the format you
         selected with the dateformat option.

         When you include dateformat with a command, it must precede the
         fromdate, pitdate, and todate options.

Examples

Command line:
         dsmc query backup -fromdate=12/11/2003 "/Users/van/Documents/*"

Command line:
         dsmc query backup -fromdate=12/11/2003 /home/dilbert/*


3.4.72 Fromnode


The fromnode option permits one node to perform commands for another
node. A user on another node must use the set access command to permit
you to query, restore, or retrieve files for the other node.

Use the fromnode option with the following commands:

*  query archive
*  query backup
*  query filespace
*  query image
*  query mgmtclass
*  restore
*  restore group
*  restore image
*  retrieve

Supported Clients

This option is valid for all clients.

Syntax

>>-FROMNode = -- --node---------------------------------------><



Parameters

node
         Specifies the node name on a workstation or a file server whose
         backup copies or archived files you want to access.

Examples

Command line:
         dsmc query archive -fromnode=bob -subdir=yes
         "/Users/van/Documents/*"

Command line:
         dsmc query archive -fromnode=bob -subdir=yes "/home/jones/*"


3.4.73 Fromowner


The fromowner option specifies an alternate owner from which to restore
backup versions or archived files or images. The owner must give access
to another to use the files or images.

For example, to restore files from the /home/devel/proja directory
belonging to usermike on system puma, and place the restored files in a
directory you own named /home/id/proja, enter the following command:

   dsmc restore -fromowner=usermike -fromnode=puma /home/devel/proja/
   /home/id/proja/

Note: Archiving image restores does not apply to Mac OS X operating
systems.

Non-root users can specify fromowner=root to access files owned by the
root user if the root user has granted them access.

Note: If you specify the fromowner option without the fromnode option,
the active user must be on the same node as the fromowner user.

Use the fromowner option with the following commands:

*  query archive
*  query backup
*  query group
*  query image
*  restore
*  restore image
*  restore group
*  retrieve

Supported Clients

This option is valid for all UNIX and Linux clients.

Syntax

>>-FROMOwner = -- --owner-------------------------------------><



Parameters

owner
         Name of an alternate owner.

Examples

Command line:
         dsmc query archive "/home/id/proja/*" -fromowner=mark


3.4.74 Fromtime


Use the fromtime option with the fromdate option to specify a beginning
time from which you want to search for backups or archives during a
restore, retrieve, or query operation.

The backup-archive client ignores this option if you do not specify the
fromdate option.

Use the fromtime option with the following commands:

*  delete backup
*  query archive
*  query backup
*  restore
*  restore group
*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-FROMTime = -- --time---------------------------------------><



Parameters

time
         Specifies a beginning time on a specific date from which you
         want to search for backed up or archived files. If you do not
         specify a time, the time defaults to 00:00:00. Specify the time
         in the format you selected with the timeformat option.

         When you include the timeformat option in a command, it must
         precede the fromtime, pittime, and totime options.

Examples

Command line:
         dsmc q b -timeformat=4 -fromt=11:59AM -fromd=06/30/2003
         -tot=11:59PM -tod=06/30/2003 /home/*


3.4.75 Groupname


Use the groupname option with the backup group command to specify the
name for a group. You can only perform operations on new groups or the
current active version of the group.



Supported Clients

This option is valid for all UNIX and Linux clients except Mac OS X.

Syntax

>>-GROUPName = -- --name--------------------------------------><



Parameters

name
         Specifies the name of the group which contains the files backed
         up using the filelist option. Directory delimiters are not
         allowed in the group name since the group name is not a file
         specification, but a name field.

Examples

Command line:
         backup group -filelist=/home/dir1/filelist1 -groupname=group1
         -virtualfsname=/virtfs -mode=full


3.4.76 Groups (deprecated)


This option is deprecated.






3.4.77 Host


The host option specifies the target ESX server location where the new
virtual machine is created during a VMware restore operation.

Use this option on restore vm commands to specify the ESX host server to
restore the data to.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Example

Restore the virtual machine to the ESX server named vmesxbld1.

restore vm -host=vmesxbld1.us.acme.com


3.4.78 Httpport


The httpport option specifies a TCP/IP port address for the web client.



Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Web Client tab, in the
HTTP Port field of the Preferences editor.

Syntax

>>-HTTPport-- --port_address----------------------------------><



Parameters

port_address
         Specifies the TCP/IP port address that is used to communicate
         with the web client. The range of values is 1000 through 32767;
         the default is 1581.

Examples

Options file:
         httpport 1502

Command line:
         Does not apply.


3.4.79 Hsmreparsetag


The hsmreparsetag option specifies a unique reparse tag that is created
by an HSM product installed on your system.

Many HSM products use reparse points to retrieve or recall migrated
files. After a file is migrated, a small stub file, with the same name
as the original file, is left on the file system. The stub file is a
reparse point that triggers a recall of the original file when a user or
application accesses the stub file. The reparse point includes a unique
identifier called a reparse tag to identify which HSM product migrated
the file.

If the IBM Spectrum Protect backup-archive client does not recognize the
reparse tag in a stub file, the Backup-Archive Client causes the HSM
product to recall the original file. You can prevent files from being
recalled if you specify the reparse tag with the hsmreparsetag option.

The backup-archive client recognizes the reparse tag of HSM products
from the following companies:

*  International Business Machines Corp.

*  Wisdata System Co. Ltd.

*  BridgeHead Software Ltd.

*  CommVault Systems, Inc.

*  Data Storage Group, Inc.

*  Enigma Data Solutions, Ltd.

*  Enterprise Data Solutions, Inc.

*  Global 360

*  GRAU DATA AG

*  Hermes Software GmbH

*  Hewlett Packard Company

*  International Communication Products Engineering GmbH

*  KOM Networks

*  Memory-Tech Corporation

*  Moonwalk Universal

*  Pointsoft Australia Pty. Ltd.

*  Symantec Corporation

If the HSM product you use is not in the preceding list, use the
hsmreparsetag option to specify the reparse tag. Ask your HSM product
vendor for the reparse tag used by the product.

Supported clients

This option is valid for all Windows clients.

Option file

Place this option in the client options file (dsm.opt).

Syntax

>>---HSMREPARSETAG----reparse_tag_value------------------------><



Parameters

reparse_tag_value
         A decimal (base 10) or hexadecimal (base 16) value that
         specifies the reparse tag.

Examples

Options file:
         Specify an HSM reparse tag in decimal format:

         hsmreparsetag 22

         Specify an HSM reparse tag in hexadecimal format:

         hsmreparsetag 0x16

Command line:
         Does not apply.


3.4.80 Ieobjtype


Use the ieobjtype option to specify an object type for a client-side
data deduplication operation within include-exclude statements.

The ieobjtype option is an additional parameter to the include.dedup or
exclude.dedup options.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API also
supports this option.

Options File

Place this option in the system-options file (dsm.sys). You can set this
option on the Include/Exclude tab of the Preferences editor. The option
can be set in the client option set on the IBM Spectrum Protect server.

Syntax

              .-File--.
>>-IEObjtype--+-Image-+----------------------------------------><



Parameters

File
         Specifies that you want to include files for, or exclude files
         from, client-side data deduplication processing. File is the
         default.

Image
         Specifies that you want to include images for, or exclude
         images from, client-side data deduplication processing.

Examples

Options file:
         exclude.dedup /home/*/* ieobjtype=image

Command line:
         Does not apply.

Related reference
3.4.59 Exclude options
3.4.86 Include options


3.4.81 Ifnewer


The ifnewer option replaces an existing file with the latest backup
version only if the backup version is newer than the existing file.

Only active backups are considered unless you also use the inactive or
latest options.

Note: Directory entries are replaced with the latest backup version,
whether the backup version is older or newer than the existing version.

Use the ifnewer option with the following commands:

*  restore
*  restore backupset
*  restore group
*  retrieve

Note: This option is ignored if the replace option is set to No.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-IFNewer-----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore "/Users/grover/Documents/*" -sub=y -rep=y -ifnewer
         dsmc restore "/home/grover/*" -sub=y -rep=y -ifnewer


3.4.82 Imagegapsize


Use the imagegapsize option with the backup image command, in the
options file, or with the include.image option to specify the minimum
size of empty regions on a volume that you want to skip during image
backup.

Use this option for LAN-based and LAN-free image backup.

For example, if you specify a gap size of 10, this means that an empty
region on the disk that is larger than 10 KB in size is not backed up.
Gaps that are exactly 10 KB are backed up. Empty regions that are
exactly 10 KB and that are smaller than 10 KB is backed up, even though
they do not contain data. However, an empty region that is smaller than
10 KB is backed up, even though it does not contain data. A smaller
image gap size means less data needs to be transferred, but with
potentially decreased throughput. A larger image gap size results in
more data being transferred, but with potentially better throughput.

Supported Clients

This option is valid for AIX, Linux, and JFS2 clients only. The IBM
Spectrum Protect API does not support this option.

Options File

Place this option in the server stanza of the client systems options
file (dsm.sys), or in the include.image statement in the dsm.sys file.

Syntax

>>-IMAGEGapsize-- --size--------------------------------------><



Parameters

size
         Specifies the minimum size of empty regions in an AIX JFS2 file
         system that should be skipped during an image backup. You can
         specify k (kilobytes) m (megabytes) or g (gigabytes) qualifiers
         with the value. Without a qualifier, the value is interpreted
         in kilobytes. Valid values are 0 through 4294967295 KB. If you
         specify a value of 0, all blocks, including unused blocks at
         the end of the volume, is backed up. If you specify any value
         other than 0, unused blocks at the end of the volume are not
         backed up. For LAN-based and LAN-free image backup the default
         value is 32 KB. This option is applicable to both static and
         snapshot-based image backup.

         Note: This option is valid for AIX JFS2 file systems. If you
         specify an imagegapsize that is greater than 0 for a file
         system other than AIX JFS2, you get a warning message.

Examples

Options file:
         Add the following to the server stanza in the dsm.sys file:
         imagegapsize 1m

         Include-exclude list example: include.image /kalafs1
         imagegapsize=-128k



Command line:
         -imagegapsize=64k


3.4.83 Imagetofile


Use the imagetofile option with the restore image command to specify
that you want to restore the source image to a file.

You might need to restore the image to a file if bad sectors are present
on the target volume, or if you want to manipulate the image data.
Later, you can use a data copy utility of your choice to transfer the
image from the file to a disk volume.

Linux supports mounting an image file as a logical volume, so you can
get access to file data within the image. The following are some
examples:

*  The file system /usr has been backed up by the backup-archive client.
   The following command restores the file system image to the file
   /home/usr.img:

   # dsmc restore image /usr /home/usr.img -imagetofile

*  To mount the image file at the /mnt/usr directory, the following
   mount command can be executed:

   # mount /home/usr.img /mnt/usr -o loop=/dev/loop0

Now the image contents are available from /mnt/usr as if a regular file
system was mounted at that directory.

Supported Clients

This option is valid only for AIX, Oracle Solaris, and all Linux
clients. The IBM Spectrum Protect API does not support this option.

Syntax

>>-IMAGETOfile-------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore image /usr /home/usr.img -imagetofile


3.4.84 Inactive


Use the inactive option to display both active and inactive objects.

You can use the inactive option with the following commands:

*  delete group
*  query backup
*  query group
*  query image
*  query nas
*  restore
*  restore group
*  restore image
*  restore nas

Important: When using the inactive option during a restore operation,
also use the pick or some other filtering option because, unlike the
latest option, all versions are restored in an indeterminate order. This
option is implicit when pitdate is used.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-INActive----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore "/Users/zoe/Documents/*" -inactive -pick

Command line:
         dsmc restore "/home/zoe/*" -inactive -pick


3.4.85 Inclexcl


The inclexcl option specifies the path and file name of an
include-exclude options file.

Multiple inclexcl statements are permitted. However, you must specify
this option for each include-exclude file.

Ensure that you store your include-exclude options file in a directory
to which all users have read access, such as /etc.

When processing occurs, the include-exclude statements within the
include-exclude file are placed in the list position occupied by the
inclexcl option, in the same order, and processed accordingly.

If you have the HSM client installed on your workstation, you can use an
include-exclude options file to exclude files from backup and space
management, from backup only or from space management only.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Include-Exclude tab of the Preferences editor.

Syntax

>>-INCLExcl-- --filespec--------------------------------------><



Parameters

filespec
         Specifies the path and file name of one include-exclude options
         file.

Examples

Options file:
         INCLExcl /Users/user1/Documents/backup.excl

         inclexcl /usr/dsm/backup.excl
         inclexcl /etc/inclexcl.def

Command line:
         Does not apply.


3.4.85.1 Considerations for Unicode-enabled clients


An include-exclude file can be in Unicode or non-Unicode format.

If the codeset used to create an include-exclude list file does not
match the codeset used on the client computer, characters in the file
that cannot be mapped by the client’s codeset to a displayable character
cannot be processed when backups are performed.

Using Unicode encoding for files containing include-exclude lists
eliminates the unmapped character problem, so you no longer need to use
wildcard characters as substitutes for the unrecognized characters.

Mac users: Create an include-exclude file in Unicode format by
performing the following steps:

1. Open TextEdit. Click Format -> Make PlainText .

2. Enter your include and exclude statements.

3. Click File and then click Save As.

4. From PlainText Encoding, select Unicode (UTF-8) or Unicode (UTF-16),
   specify the file and target directory, and then save the file. Do not
   add the .txt extension.

5. Place an inclexcl option specifying the include-exclude file you just
   created in your dsm.sys file.

6. Restart the backup-archive client.


3.4.86 Include options


The include options specify objects that you want to include for backup
and archive services.

The include options specify any of the following:

*  Objects within a broad group of excluded objects that you want to
   include for backup and archive services.

*  Objects within a broad group of excluded objects that you want to
   include for backup, archive, image, and space management services.

*  Files that are included for backup or archive processing that you
   want to include for encryption processing.

*  Files that are included for backup or archive processing that you
   also want to include for compression processing.

*  Objects to which you want to assign a specific management class.

*  A management class to assign to all objects to which you do not
   explicitly assign a management class.

*  File spaces to which you want to assign memory-efficient backup
   processing

*  File spaces where you want to use the diskcachelocation option to
   cause specific file systems to use different, specific locations for
   their disk cache.

If you do not assign a specific management class to objects, the default
management class in the active policy set of your policy domain is used.
Use the query mgmtclass command to display information about the
management classes available in your active policy set.

Remember: The backup-archive client compares the files it processes
against the patterns specified in the include-exclude statements,
reading from the bottom to the top of the options file.

Note:

1. The exclude.fs and exclude.dir statements override all include
   statements that match the pattern.

2. The server can also define these options with the inclexcl option.

Supported Clients

This option is valid for all clients. The server can also define
include.fs.nas.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set these options on the Include-Exclude tab in
the Preferences editor.

Syntax

>>-options-- --pattern-- --+------------------------+--------><
                             '- --optional_parameter-'



include, include.backup, include.file
         Use these options to include files or assign management classes
         for backup processing.

         The include option affects archive and backup processing. If
         you want to assign different management classes for archive and
         backup processing, always specify include.archive and
         include.backup with their own management classes. In this
         example, the archmc management class is assigned when an
         archive operation is performed. The management class is
         assigned when an archive operation is performed because
         include.backup is used only for backup processing, and not for
         archive processing.

         include.archive /home/test/* archmc
         include.backup /home/test/*



include.archive
         Includes files or assigns management classes for archive
         processing.

include.attribute.symlink
         Includes a file or a group of files that are symbolic links or
         aliases, within a broad group of excluded files for backup
         processing only.

         Note: For Mac OS X, aliases are included.

include.compression
         Includes files for compression processing if you set the
         compression option to yes. This option applies to backups and
         archives.

include.dedup
         Includes files for client-side data deduplication. To control a
         client-side data deduplication operation, specify ieobjtype as
         the value of the include.dedup option. By default, all data
         deduplication-eligible objects are included for client-side
         data deduplication.

         Valid ieobjtype parameters are:

            File
            Image

         The default is File.

include.encrypt
         Includes the specified files for encryption processing. By
         default, the client does not perform encryption processing.

         Important: The include.encrypt option is the only way to enable
         encryption on the backup-archive client. If no include.encrypt
         statements are used, encryption does not occur.

         Restrictions:

         *  Encryption is not compatible with client-side deduplication.
            Files that are included for encryption are not deduplicated
            by client-side deduplication.

         *  Client encryption with the include.encrypt option is no
            longer supported for LAN-free backup and archive operations
            to the IBM Spectrum Protect server 8.1.1 and later levels,
            or IBM Spectrum Protect7.1.8 and later version 7 levels.
            LAN-free restore and retrieve operations of encrypted backup
            versions and archive copies continue to be supported. If you
            need to encrypt data by using the include.encrypt option, in
            which data is encrypted before it is sent to the server, use
            LAN-based backup or archive operations.

         *  Encryption is not compatible with VMware virtual machine
            backups that use the incremental forever backup modes
            (MODE=IFIncremental and MODE=IFFull). If the client is
            configured for encryption, you cannot use incremental
            forever backup.

         *  Encryption is not compatible with the IBM Spectrum Protect
            for Virtual Environments Data Protection for VMware Recovery
            Agent. If the client is configured for encryption, you can
            use the client to restore backups that were created with the
            V7.1 client full or incremental backup modes (MODE=Full and
            MODE=Incremental). However, you cannot use the Recover Agent
            to restore the encrypted backups.

include.fs
         For AIX JFS2 file systems: Use the snapshotcachesize option in
         the dsm.sys file or with the include.fs option, to specify an
         appropriate snapshot size so that all old data blocks can be
         stored while the snapshot-based file backup or archive occurs.

         To control how the client processes your file space for
         incremental backup, you can specify these additional options in
         your dsm.sys file, as values of the include.fs option:
         diskcachelocation and memoryefficientbackup.

         Each of the include.fs, memoryefficientbackup and
         diskcachelocation options must be on the same line in the
         options file.

         include.fs /home
              memoryefficientbackup=diskcachemethod
              diskcachelocation=/usr
         include.fs /usr
              memoryefficientbackup=diskcachemethod
              diskcachelocation=/home
         include.fs /Volumes/hfs3
              memoryefficientbackup=diskcachemethod
              diskcachelocation=/Volumes/hfs2
          AIX JFS2 filesystems only: include.fs
              /kalafs1 snapshotproviderfs=JFS2

         If these options appear both in the options file and an
         include.fs option, the include.fs values are used for the
         specified file space in place of any values in an option file
         or on the command line.

include.fs.nas
         Use the include.fs.nas option to bind a management class to
         Network Attached Storage (NAS) file systems. You can also
         specify whether the client saves Table of Contents (TOC)
         information during a NAS file system image backup, using the
         toc option with the include.fs.nas option in your dsm.sys file.
         This option is only valid for AIX and Solaris clients.

include.image
         Includes a file space or logical volume, or assigns a
         management class when used with the backup image command. The
         backup image command ignores all other include options.

         For Linux x86_64 clients: Use the snapshotcachesize option in
         these situations:

         *  With the backup image command

         *  In the dsm.sys file

         *  With the include.image option

         Using the snapshotcachesize option in these situations lets you
         specify an appropriate snapshot size, so that all old data
         blocks can be stored while the image backup occurs.

         A snapshot size of 100 percent ensures a valid snapshot.



         For AIX JFS2 file systems: Use the snapshotcachesize option in
         these situations:

         *  With the backup image command

         *  In the dsm.sys file

         *  With the include.image option

         Using the snapshotcachesize option in these situations lets you
         specify an appropriate snapshot size, so that all old data
         blocks can be stored while the image backup occurs.



         This option is valid for AIX, Linux, and Oracle Solaris
         clients.

Parameters

pattern
         Specifies the objects to include for backup or archive
         processing or to assign a specific management class.

         Note: For NAS file systems: You must prefix the NAS node name
         to the file specification to specify the file server to which
         the include statement applies. If you do not specify a NAS node
         name, the file system identified refers to the NAS node name
         specified in the client system-options file (dsm.sys) or on the
         command line.



         If the pattern begins with a single or double quotation mark,
         or contains any embedded blanks or equal signs, you must
         surround the value in either single (') or double (") quotation
         marks. The opening and closing quotation marks must be the same
         type of quotation marks.



         For the include.image option, the pattern is the name of a
         mounted file system or raw logical volume.



optional_parameter

management_class_name
         Specifies the name of the management class to assign to the
         objects. If a management class is not specified, the default
         management class is used. To associate a management class with
         a backup group on an include statement, use the following
         syntax:

         include virtual_filespace_name\group_name management_class_name

         where:

         virtual_filespace_name
                  Specifies the name of the IBM Spectrum Protect server
                  virtual filespace that you associated with the group,
                  on the Backup Group command.

         group_name
                  Is the name of the group that you created when you ran
                  the Backup Group command.

         management_class_name
                  Is the name of the management class to associate with
                  the files in the group.

                  For example, a group named MyGroup is stored in a
                  virtual file space called MyVirtualFileSpace. To
                  associate a management class, named TEST, with the
                  group, use the following syntax:

                  include MyVirtualFileSpace/MyGroup TEST

Table 45. Other optional parameters

+----------------------------------+----------------------------------+
| optional_parameter               | Use with option                  |
+----------------------------------+----------------------------------+
| ieobjtype                        | include.dedup                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| memoryefficientbackup            | include.fs                       |
| >                                |                                  |
+----------------------------------+----------------------------------+
| diskcachelocation                | include.fs                       |
| >                                |                                  |
+----------------------------------+----------------------------------+
| dynamicimage                     | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| postsnapshotcmd                  | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| presnapshotcmd                   | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| snapshotcachesize                | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| snapshotproviderfs               | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+
| snapshotproviderimage            | include.image                    |
| >                                |                                  |
+----------------------------------+----------------------------------+

Examples

Options file:
         include /home/proj/text/devel.*
         include /home/proj/text/* textfiles
         include * managall
         include /WAS_ND_NDNODE mgmtclass
         include /WAS_APPNODE mgmtclass
         include.image /home
         include.archive /home/proj/text/
           * myarchiveclass
         include.backup /home/proj/text/
           * mybackupclass
         include.compression /home/proj/text/
           devel.*
         include.encrypt /home/proj/gordon/*
         include.fs.nas netappsj/vol/vol0
           homemgmtclass


         include.dedup /Users/Administrator/Documents/Important/.../*

         AIX only:

         include.image /home
           MGMTCLASSNAME
           snapshotproviderimage=JFS2
           snapshotcachesize=40
         include.image /home
           snapshotproviderimage=NONE
         include.fs /kalafs1
           snapshotproviderfs=JFS2

         LINUX only:

         include.image /home
           snapshotproviderimage=LINUX_LVM
         include.image /myfs1 dynamicimage=yes
         include.image /home MGMTCLASSNAME
           snapshotproviderimage=NONE
         include.image /myfs1 dynamicimage=yes
         include.attribute.symlink /home/spike/.../*
         include.fs /usr
           memoryefficientbackup=diskcachemethod

Command line:
         Does not apply.


3.4.86.1 Controlling symbolic link and alias processing


IBM Spectrum Protect treats symbolic links and aliases (aliases apply to
Mac OS X only) as actual files and backs them up. However, the file
referenced by the symbolic link is not backed up.

In some cases symbolic links and aliases can be easily recreated and
need not be backed up. In addition, backing up these symbolic links or
aliases can increase backup processing time and occupy a substantial
amount of space on the IBM Spectrum Protect server.

You can use the exclude.attribute.symlink option to exclude a file or a
group of files that are symbolic links or aliases from backup
processing. If necessary, you can use the include.attribute.symlink
option to include symbolic links or aliases within broad group of
excluded files for backup processing. For example, to exclude all
symbolic links or aliases from backup processing, except those that
exist under the /home/spike directory, enter these statements in your
dsm.sys file:

  exclude.attribute.symlink  /.../*
  include.attribute.symlink /home/spike/.../*

Related reference
3.4.59 Exclude options


3.4.86.2 Compression and encryption backup processing


Consider the following information if you want to include specific files
or groups of files for compression and encryption processing during a
backup or archive operation.

*  You must set the compression option to yes to enable compression
   processing. If you do not specify the compression option or you set
   the compression option to no, the backup-archive client does not
   perform compression processing.

*  The client processes exclude.fs, exclude.dir, and other
   include-exclude statements first. The client then considers any
   include.compression and include.encrypt statements. For example,
   consider the following include-exclude list:

   exclude /home/jones/proj1/file.txt
   include.compression /home/jones/proj1/file.txt
   include.encrypt /home/jones/proj1/file.txt



   The client examines the exclude /home/jones/proj1/file.txt statement
   first and determines that /home/jones/proj1/file.txt is excluded from
   backup processing and is, therefore, not a candidate for compression
   and encryption processing.

*  Include-exclude compression and encryption processing is valid for
   backup and archive processing only.

*  Client encryption with the include.encrypt option is no longer
   supported for LAN-free backup and archive operations to the IBM
   Spectrum Protect server 8.1.1 and later levels, or IBM Spectrum
   Protect7.1.8 and later version 7 levels. LAN-free restore and
   retrieve operations of encrypted backup versions and archive copies
   continue to be supported. If you need to encrypt data by using the
   include.encrypt option, in which data is encrypted before it is sent
   to the server, use LAN-based backup or archive operations.

Related reference
3.4.22 Compression


3.4.86.3 Processing NAS file systems


Use the include.fs.nas option to bind a management class to NAS file
systems and to control whether Table of Contents information is saved
for the file system backup.

A NAS file system specification uses the following conventions:

*  NAS nodes represent a new node type. The NAS node name uniquely
   identifies a NAS file server and its data to the backup-archive
   client. You can prefix the NAS node name to the file specification to
   specify the file server to which the include statement applies. If
   you do not specify a NAS node name, the file system you specify
   applies to all NAS file servers.

*  Regardless of the client operating system, NAS file system
   specifications use the forward slash (/) separator, as in this
   example: /vol/vol0.

Use the following syntax:

>>-pattern-- mgmtclassname- toc=value------------------------><



Where:

pattern
         Specifies the objects to include for backup services, to assign
         a specific management class, or to control TOC creation. You
         can use wildcards in the pattern.

mgmtclassname
         Specifies the name of the management class to assign to the
         objects. If a management class is not specified, the default
         management class is used.

toc=value
         For more information, see 3.4.187 Toc.

Example 1: To assign a management class to the /vol/vol1 file system of
a NAS node that is called netappsj, specify the following include
statement:

include.fs.nas netappsj/vol/vol1 nasMgmtClass toc=yes

Example 2: To assign the same management class to all paths that are
subordinate to the /vol/ file system on a NAS node called netappsj (for
example, /vol/vol1, /vol/vol2, and /vol/vol3), specify the following
include statement:

include.fs.nas netappsj/vol/* nasMgmtClass toc=yes


3.4.86.4 Virtual machine include options


Virtual machine include and exclude options influence the behavior of
backup and restore operations for virtual machines. These options are
processed before any command-line options are processed, so that options
on the command line can override options specified on any of the virtual
machine include options or virtual machine exclude options. See the
individual option descriptions for information about the options.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Related reference
3.4.86.4.2 Include.vmdisk
3.4.86.4.6 INCLUDE.VMTSMVSS
3.4.86.4.5 INCLUDE.VMSNAPSHOTATTEMPTS


3.4.86.4.1 Include.vm


For virtual machine operations, this option overrides the management
class that is specified on the vmmc option.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

The management class specified on the vmmc option applies to all VMware
backups.

The management class specified on the vmmc option applies to all Hyper-V
backups.

You can use the include.vm option to override that management class, for
one or more virtual machines. The include.vm option does not override or
affect the management class that is specified by the vmctlmc option. The
vmctlmc option binds backed-up virtual machine control files to a
specific management class.

Supported Clients

This option can be used with supported Linux clients that are configured
to back up VMware virtual machines.

Options File

Set this option in the client options file.

Syntax

>>-INCLUDE.VM-- --vmname-- --+---------------+---------------><
                               '-mgmtclassname-'



Parameters

vmname
         Required parameter. Specifies the name of a virtual machine
         that you want to bind to the specified management class. The
         name is the virtual machine display name. Only one virtual
         machine can be specified on each include.vm statement. However,
         you can specify as many include.vm statements as needed to bind
         each virtual machine to a specific management class.

         You can include wildcards in the virtual machine name. An
         asterisk (*) matches any character string. A question mark (?)
         matches a single character. If the virtual machine name
         contains a space character, enclose the name in double
         quotation marks (").

         Tip: If the virtual machine name contains special characters,
         type the question mark wildcard in place of the special
         characters when you specify the virtual machine name.

mgmtclassname
         Optional parameter. Specifies the management class to use when
         the specified virtual machine is backed up. If this parameter
         is not specified, the management class defaults to the global
         virtual machine management class that is specified by the vmmc
         option.

Examples

Assume that the following management classes exist and are active on the
IBM Spectrum Protect server:

*  MCFORTESTVMS

*  MCFORPRODVMS

*  MCUNIQUEVM

Example 1
         The following include.vm statement in the client options file
         binds all virtual machines that have names that begin with
         VMTEST to the management class called MCFORTESTVMS:

         include.vm vmtest* MCFORTESTVMS

Example 2
         The following include.vm statement in the client options file
         binds a virtual machine that is named WHOPPER VM1 [PRODUCTION]
         to the management class called MCFORPRODVMS:

         include.vm "WHOPPER VM1 ?PRODUCTION?" MCFORPRODVMS

         The virtual machine name must be enclosed in quotation marks
         because it contains space characters. Also, the question mark
         wildcard is used to match the special characters in the virtual
         machine name.

Example 3
         The following include.vm statement in the client options file
         binds a virtual machine that is named VM1 to a management class
         that is named MCUNIQUEVM:

         include.vm VM1 MCUNIQUEVM


3.4.86.4.2 Include.vmdisk


The INCLUDE.VMDISK option includes a virtual machine (VM) disk in backup
operations. If you do not specify one or more disk labels, all disks in
the VM are backed up.

This option is available only if you are using the IBM Spectrum Protect
for Virtual Environments licensed product. For more information about
this option, see the IBM Spectrum Protect for Virtual Environments
product documentation on IBM Documentation at
https://www.ibm.com/docs/en/spfve.

The INCLUDE.VMDISK option specifies the label of a VM disk to be
included in a backup vm operation. If you include a disk on the backup
vm command, the command-line parameters override any INCLUDE.VMDISK
statements in the options file.

This option applies to both VMware and Microsoft Hyper-V virtual machine
disks.

INCLUDE.VMDISK for VMware virtual machines

Use the INCLUDE.VMDISK option to include a VMware virtual machine in
backup operations.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

Set this option in the client options file. Command line parameters
override statements in the options file.

Syntax for VMware virtual machines

>>-INCLUDE.VMDISK--vmname-- --vmdk_label-----------------------><



Parameters

vmname
         Specifies the name of the virtual machine that contains a disk
         that you want to include in a Backup VM operation. The name is
         the virtual machine display name. You can specify only one
         virtual machine name on each INCLUDE.VMDISK statement. Specify
         additional INCLUDE.VMDISK statements for each virtual machine
         disk to include.
         The virtual machine name can contain an asterisk (*), to match
         any character string, and question mark (?) to match any one
         character. Surround the VM name with quotation marks ("") if
         the VM name contains space characters.
         Tip: If the virtual machine name contains special characters,
         such as bracket characters ([ or ]), the virtual machine name
         might not be correctly matched. If a virtual machine name uses
         special characters in the name, you might need to use the
         question mark character (?) to match the special characters in
         the VM name

         For example, to include Hard Disk 1 in the backup of a virtual
         machine named "Windows VM3 [2012R2]", use this syntax in the
         options file: INCLUDE.VMDISK "Windows VM3 ?2012R2?" "Hard Disk
         1"

vmdk_label
         Specifies the disk label of the disk that you want to include.
         Wildcard characters are not allowed. Use the Backup VM command
         with the -preview option to determine the disk labels of disks
         in a given virtual machine. See "Backup VM" for the syntax.

Examples

Options file
         Assume that a virtual machine named vm1 contains four disks,
         labeled Hard Disk 1, Hard Disk 2, Hard Disk 3, and Hard Disk 4.
         To include only disk 2 in a Backup VM operations, specify the
         following in the options file:

         INCLUDE.VMDISK "vm1" "Hard Disk 2"
         Include disks 2 and 3 in Backup VM operations:

         INCLUDE.VMDISK "vm1" "Hard Disk 2"
         INCLUDE.VMDISK "vm1" "Hard Disk 3"

Command line
         Include a single disk when backing up vm1:

         dsmc backup vm "vm1:vmdk=Hard Disk 1"
         Include disk 2 and disk 3 on vm1:

         dsmc backup vm "vm1:vmdk=Hard Disk 2:vmdk=Hard Disk 3"

Related reference
2.11 Backup VM
2.49 Restore VM (VMware)
3.4.46 Domain.vmfull
3.4.59.4.1 Exclude.vmdisk


3.4.86.4.3 Include.vmlocalsnapshot


This option specifies the management class that is applied to local
backups of a VMware virtual machine. The management class defines the
retention policies for the local backups.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

You can use this option only for virtual machines that are stored in a
virtual volume (VVOL) datastore.

Supported Clients

This option can be used with supported Linux clients that are configured
to back up VMware virtual machines.

Options File

Set this option in the client options file.

Syntax

>>-INCLUDE.VMLOCALSNAPSHOT-- --vmname-- --+---------------+--><
                                            '-mgmtclassname-'



Parameters

vmname
         Specifies the name of a virtual machine that you want to bind
         to the specified management class for local backup operations.
         The name is the virtual machine display name.
         Only one virtual machine can be specified on each
         INCLUDE.VMLOCALSNAPSHOT statement. However, you can specify as
         many INCLUDE.VMLOCALSNAPSHOT statements as needed to bind each
         VM to a specific management class.
         You can include wildcards in the virtual machine name. An
         asterisk (*) matches any character string. A question mark (?)
         matches a single character. If the virtual machine name
         contains a space character, enclose the name in double
         quotation marks (").

         Tip: If the virtual machine name contains special characters,
         type the question mark wildcard in place of the special
         characters when you specify the virtual machine name.

mgmtclassname
         Specifies the management class to use for local backups of the
         virtual machine. If this parameter is not specified, the
         management class defaults to the global virtual machine
         management class that is specified by the vmmc option.

Examples

Assume that the following management classes exist and are active on the
IBM Spectrum Protect server:

*  MCFORTESTVMS

*  MCFORPRODVMS

*  MCUNIQUEVM

Example 1
         The following INCLUDE.VMLOCALSNAPSHOT statement in the client
         options file binds all virtual machines that have names that
         begin with VMTEST to the management class called MCFORTESTVMS:

         include.vmlocalsnapshot vmtest* MCFORTESTVMS

Example 2
         The following INCLUDE.VMLOCALSNAPSHOT statement in the client
         options file binds a virtual machine that is named WHOPPER VM1
         [PRODUCTION] to the management class called MCFORPRODVMS:

         include.vmlocalsnapshot "WHOPPER VM1 ?PRODUCTION?" MCFORPRODVMS

         The virtual machine name must be enclosed in quotation marks
         because it contains space characters. Also, the question mark
         wildcard is used to match the special characters in the virtual
         machine name.

Example 3
         The following INCLUDE.VMLOCALSNAPSHOT statement in the client
         options file binds a virtual machine that is named VM1 to a
         management class that is named MCUNIQUEVM:

         include.vmlocalsnapshot VM1 MCUNIQUEVM


3.4.86.4.4 Include.vmresetcbt


Use the include.vmresetcbt to reset the change block tracking (CBT)
mechanism for a virtual machine (VM) or a group of VMs.

If you need to reset the change block tracking on a VM or set of VMs,
use this option to manage which VMs are reset so that all VMs are not
reset at the same time. Managing which VM's change block tracking is
reset is important because resetting change block tracking for a VM
forces a full backup of that VM.

While there can be different reasons for resetting change block
tracking, one reason is if you suspect that a snapshot existed at the
time change block tracking was initially enabled for a VM. Enabling
change block tracking on Data Protection for VMware means to complete an
incremental-forever backup operation.

Enabling change block tracking when a snapshot exists is a known issue
with VMware change block tracking. This known issue might cause
incomplete or invalid change blocks information to be returned during a
backup operation. To resolve this issue, you must remove all existing
snapshots for a VM, and reset change block tracking for the VM before
you run an incremental-forever backup operation.

Subsequent incremental backups will track the blocks that changed since
the last backup operation.

Specify this option only for one-time use for a VM or group of VMs.
After you reset change block tracking for a VM by running an
incremental-forever backup operation, remove the include.vmresetcbt
option from the options file. Use this option only if change block
tracking needs to be reset for a VM, such as when one or more
third-party or manual snapshots exist on a VM.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported Clients

This option can be used with supported Windows and Linux clients.

Options file

Place this option in the client options file (dsm.opt).

Syntax

>>-INCLUDE.VMResetcbt--vmname----------------------------------><



Parameters

vmname
         Specifies the name of a VM for which you want to reset change
         block tracking. The name is the VM display name. This parameter
         is required.

         Only one VM can be specified on each include.vm statement.
         However, you can specify as many include.vmresetcbt statements
         as needed.

         You can include wildcards in the VM name. An asterisk (*)
         matches any character string. A question mark (?) matches a
         single character. If the VM name contains a space character,
         enclose the name in double quotation marks (").

         Tip: There is no equivalent option that excludes VMs from
         having change block tracking reset. Therefore, you must specify
         more granular VM names when you reset change block tracking for
         a group of VMs. For example, you cannot specify an
         include.vmresetcbt statement to include all VMs that begin with
         "EXEC" and an exclude statement to exclude the VMs that begin
         with "EXECTEST".

Examples

Task 1
         Reset change block tracking on all VMs with names that begin
         with "Prod" followed by any single character:

         INCLUDE.VMRESETCBT Prod?

Task 2
         Reset change block tracking on all VMs with names that begin
         with any two characters, followed by "Prod", followed by zero
         or more characters:

         INCLUDE.VMR ??Prod*

Task 3
         Reset change block tracking on all VMs with names that begin
         with one or more characters, and end with "Prod":

         INCLUDE.VMRESETCBT ?*Prod

         or

         INCLUDE.VMRESETCBT *?Prod

Task 4
         Reset change block tracking on all VMs with names that begin
         with "Corporate Mail", followed by zero or more characters:

         include.vmr "Corporate Mail*"

Task 5
         Reset change block tracking on all VMs:

         include.vmresetcbt *

Related reference
3.4.224 Vmnocbtcontinue


3.4.86.4.5 INCLUDE.VMSNAPSHOTATTEMPTS


Use the INCLUDE.VMSNAPSHOTATTEMPTS option to determine the total number
of snapshot attempts to try for a virtual machine (VM) backup operation
that fails due to snapshot failure.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Supported Clients

This option can be used with supported Linux clients that are configured
to back up VMware virtual machines.

Options File

This option is valid in the client options file (dsm.opt). It can also
be included on the server in a client option set. It is not valid on the
command line.

Syntax

>>-INCLUDE.VMSNAPSHOTATTEMPTS--vmname--num_with_quiescing------->

>--num_without_quiescing---------------------------------------><



Parameters

vmname
         A required positional parameter that specifies the name of the
         virtual machine to attempt the total number of snapshots for,
         if a backup attempt fails due to snapshot failure. The name is
         the virtual machine display name.
         Only one virtual machine can be specified on each
         INCLUDE.VMSNAPSHOTATTEMPTS statement. However, to configure the
         total snapshot attempts for other virtual machines, you can use
         the following methods:

         *  For each virtual machine that you want this option to apply
            to, specify as many INCLUDE.VMSNAPSHOTATTEMPTS statements as
            needed to reattempt snapshots that failed.

         *  Use wildcard characters for the vmname parameter value to
            specify virtual machine names that match the wildcard
            pattern. An asterisk (*) matches any character string. A
            question mark (?) matches a single character. If the virtual
            machine name contains a space character, enclose the name in
            double quotation marks (").
         Tip: If the virtual machine name contains special characters,
         type the question mark wildcard (?) in place of the special
         characters when you specify the virtual machine name.

num_with_quiescing
         A positional parameter that specifies the following action:

         For VMware backup operations:
                  *  For Windows virtual machines with IBM Spectrum
                     Protect application protection enabled,
                     num_with_quiescing specifies the number of times to
                     attempt the snapshot with IBM Spectrum Protect VSS
                     quiescing and Microsoft Windows system provider VSS
                     quiescing. VSS quiescing applies only to Windows
                     virtual machines.

                     Depending on the number that you specify, the first
                     snapshot attempt is always made with IBM Spectrum
                     Protect VSS quiescing. Subsequent snapshot attempts
                     are made with Windows system provider VSS
                     quiescing.

                  *  For Windows virtual machines without IBM Spectrum
                     Protect application protection enabled and for
                     Linux virtual machines, num_with_quiescing
                     specifies the number of times to attempt the
                     snapshot with VMware Tools file system quiescing.

                  The maximum value that you can specify is ten (10).
                  The default value is two (2). The minimum value that
                  you can specify is zero (0).

         For Hyper-V RCT backup operations:
                  The num_with_quiescing parameter specifies the number
                  of times to attempt snapshots with quiescing to create
                  application-consistent backups.

                  You can specify a value in the range 0 - 10. The
                  default value is 2.

num_without_quiescing
         For VMware backup operations:
                  A positional parameter that specifies the number of
                  times to attempt the snapshot with VMware Tools file
                  system quiescing and application (VSS) quiescing
                  disabled after the specified number of attempts with
                  VSS quiescing (num_with_quiescing) completes. For
                  example, you can specify this parameter for a virtual
                  machine that is already protected by an IBM Data
                  Protection agent that is installed in a guest virtual
                  machine.

                  The maximum value that you can specify is ten (10).
                  The minimum value that you can specify is zero (0),
                  which is the default value.

                  Important: When this parameter is applied to a virtual
                  machine backup, the backup is considered
                  crash-consistent. As a result, operating system, file
                  system, and application consistency are not
                  guaranteed. An include.vmsnapshotattempts 0 0 entry is
                  not valid. Backup operations require at least one
                  snapshot.

         For Hyper-V RCT backup operations:
                  The num_without_quiescing option specifies the number
                  of times to attempt snapshots without quiescing after
                  the specified number of attempts in the
                  num_with_quiescing option are completed.

                  You can specify a value in the range 0 - 10. The
                  default value is 0.

                  Important: When this parameter is applied to a VM
                  backup, the backup is considered crash-consistent. As
                  a result, operating system, file system, and
                  application consistency are not guaranteed. An
                  include.vmsnapshotattempts 0 0 entry is not valid.
                  Backup operations require at least one snapshot.

Examples

VMware examples:

Example 1
         The following INCLUDE.VMSNAPSHOTATTEMPTS statement in the
         client options file tries two total snapshot attempts (with VSS
         quiescing) for virtual machine VM_a:

         INCLUDE.VMSNAPSHOTATTEMPTS VM_a 2 0

Example 2
         The following INCLUDE.VMSNAPSHOTATTEMPTS statement in the
         client options file tries three total snapshot attempts for
         Windows virtual machines that match the vmServer_Dept* string:

         *  The first attempt is made with IBM Spectrum Protect VSS
            quiescing.

         *  The second attempt is made with Windows system provider VSS
            quiescing.

         *  The third snapshot attempt is taken without VSS quiescing.

         INCLUDE.VMSNAPSHOTATTEMPTS vmServer_Dept* 2 1

Example 3
         The following INCLUDE.VMSNAPSHOTATTEMPTS statement in the
         client options file tries one total snapshot attempt (with VSS
         quiescing) for virtual machines that match the vmDB_Dept*
         string:

         INCLUDE.VMSNAPSHOTATTEMPTS vmDB_Dept* 1 0

Example 4
         The following INCLUDE.VMSNAPSHOTATTEMPTS statement in the
         client options file tries two total snapshot attempts (with VSS
         quiescing) for all virtual machines:

         *  The first attempt is made with IBM Spectrum Protect VSS
            quiescing.

         *  The second attempt is made with Windows system provider VSS
            quiescing.

         INCLUDE.VMSNAPSHOTATTEMPTS * 2 0

Example 5
         In this example, the virtual machine DB15 has an IBM Data
         Protection agent that is installed in a guest virtual machine
         and does not need an application-consistent snapshot. The
         following INCLUDE.VMSNAPSHOTATTEMPTS statement in the client
         options file tries one total snapshot attempt (without VSS
         quiescing) for virtual machine DB15:

         INCLUDE.VMSNAPSHOTATTEMPTS DB15 0 1



Hyper-V examples:

Example 1
         Specify the following statement in the client options file to
         make two total snapshot attempts at crash-consistent backups
         for all Hyper-V VMs that begin with LinuxVM:

         INCLUDE.VMSNAPSHOTATTEMPTS LinuxVM* 0 2

Example 2
         Specify the following statement in the client options file to
         try three snapshot attempts for virtual machine VM1: two
         application-consistent snapshot attempts, and if they fail, to
         try one crash-consistent snapshot attempt:

         INCLUDE.VMSNAPSHOTATTEMPTS VM1 2 1

Related reference
3.4.86.4.6 INCLUDE.VMTSMVSS


3.4.86.4.6 INCLUDE.VMTSMVSS


The INCLUDE.VMTSMVSS option notifies virtual machine applications that a
backup is about to occur. This option allows the application to truncate
transaction logs and commit transactions so that the application can
resume from a consistent state when the backup completes. An optional
parameter can be specified to suppress truncation of the transaction
logs.

When a virtual machine is included by this option, IBM Spectrum Protect
provides application protection. That is, the client freezes and thaws
the VSS writers and, optionally, truncates the application logs.

If a VMware virtual machine is not protected by this option, application
protection is provided by VMware, and VMware freezes and thaws the VSS
writers, but application logs are not truncated.

If a Hyper-V virtual machine is not protected by this option,
application protection is provided by Hyper-V, which freezes and thaws
the VSS writers, but does not truncate application logs.

Important: Before you begin application protection backups, ensure that
the application database, such as the Microsoft SQL Server database or
Microsoft Exchange Server database, is on a non-boot drive (any drive
other than the boot drive), in case a diskshadow revert operation is
needed during restore.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

Set this option in the client options file. This option cannot be set by
the preferences editor or on the command line.

Syntax

>>-INCLUDE.VMTSMVSS----vmname---- --OPTions=KEEPSqllog--------><



Parameters

vmname
         Specifies the name of the virtual machine that contains the
         applications to quiesce. The name is the virtual machine
         display name. Specify one virtual machine per INCLUDE.VMTSMVSS
         statement. For example, to include a virtual machine named
         Windows VM3 [2012R2], use this syntax in the options file:
         INCLUDE.VMTSMVSS "Windows VM3 [2012R2]".

         To protect all virtual machines with this option, use an
         asterisk as a wildcard (INCLUDE.VMTSMVSS *). You can also use
         question marks to match any single character. For example,
         INCLUDE.VMTSMVSS vm?? protects all virtual machines that have
         names that begin with vm and are followed by any two characters
         (vm10, vm11, vm17, and so on).

         Tip: If the virtual machine name contains special characters,
         such as bracket characters ([ or ]), the virtual machine name
         might not be correctly matched. If a virtual machine name uses
         special characters in the name, you can use the question mark
         character (?) to match the special characters in the virtual
         machine name.

         There is no default value for this parameter. To enable
         application protection, you must include virtual machines to be
         protected on one or more INCLUDE.VMTSMVSS statements. Make sure
         that you do not exclude a disk on a virtual machine (by using
         the EXCLUDE.VMDISK option) if the disk contains application
         data that you want protected.

OPTions=KEEPSqllog
         If the OPTions KEEPSqllog parameter is specified on an
         INCLUDE.VMTSMVSS statement, the parameter prevents SQL server
         logs from being truncated when a backup-archive client that is
         installed on a data mover node backs up a virtual machine that
         is running a SQL server. Specifying this parameter allows the
         SQL server administrator to manually manage (backup, and
         possibly truncate) the SQL server logs, so that they can be
         preserved and be used to restore SQL transactions to a specific
         checkpoint, after the virtual machine is restored.
         When this option is specified, the SQL log is not truncated and
         the following message is displayed and logged on the server:

         ANS4179I IBM Spectrum Protect application protection
         did not truncate the Microsoft SQL Server logs on VM 'VM'.

         You can remove the OPTIONS=KEEPSQLLOG option to enable
         truncation of the SQL logs when a backup completes.

         Note: The client does not back up the SQL log files. The SQL
         administrator must back up the log files so that they can be
         applied after the database is restored.

Examples

Options file
         This feature is available only if the client operates as a data
         mover for IBM Spectrum Protect for Virtual Environments.

         Configure application protection for a virtual machine that is
         named vm_example:

         INCLUDE.VMTSMVSS vm_example
         Configure application protection for vm11, vm12, and vm15:

         INCLUDE.VMTSMVSS vm11
         INCLUDE.VMTSMVSS vm12
         INCLUDE.VMTSMVSS vm15 options=keepsqllog

Command line
         Not applicable; this option cannot be specified on the command
         line.


3.4.87 Incrbydate


Use the incrbydate option with the incremental command to back up new
and changed files with a modification date later than the last
incremental backup stored at the server, unless you exclude the file
from backup.

Important: Files that are modified or created after their respective
directory was processed by the backup-archive client, but before the
incremental-by-date backup completes, are not backed up and will not be
backed up in future incremental-by-date backups, unless the files are
modified again. For this reason, a run a regular incremental backup
periodically, without specifying the incrbydate option.

An incremental-by-date updates the date and time of the last incremental
at the server. If you perform an incremental-by-date on only part of a
file system, the date of the last full incremental is not updated and
the next incremental-by-date backs up these files again.

Important:

The last incremental backup time refers to the server time and the file
modification time refers to the client time. If the client and server
time are not synchronized, or the client and server are in different
time zones, this affects incremental-by-date backup with
mode=incremental.

The last incremental backup time refers to the server time and the file
modification time refers to the client time. If the client and server
time are not synchronized, or the client and server are in different
time zones, this affects incremental-by-date backup and image backup
with mode=incremental.

Both full incremental backups and incrementals-by-date backups backup
new and changed files. An incremental-by-date takes less time to process
than a full incremental and requires less memory. However, unlike a full
incremental backup, an incremental-by-date backup does not maintain
current server storage of all your workstation files for the following
reasons:

*  It does not expire backup versions of files that are deleted from the
   workstation.

*  It does not rebind backup versions to a new management class if the
   management class has changed.

*  It does not back up files with attributes that have changed, such as
   Access control list (ACL) data, unless the modification dates and
   times have also changed.

*  It ignores the copy group frequency attribute of management classes.

Tip: If you have limited time during the week to perform backups, but
extra time on weekends, you can maintain current server storage of your
workstation files by performing an incremental backup with the
incrbydate option on weekdays and a full incremental backup on weekends.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-INCRbydate--------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc incremental -incrbydate


3.4.88 Incremental


Use the incremental option with the restore image command to ensure that
any changes that were made to the base image are also applied to the
restored image.

If you also use the deletefiles option, changes include the deletion of
files and directories that were in the original image but later deleted
from the workstation.

Note: Using the incremental option with the restore image command to
perform a dynamic image backup is not supported.

Supported Clients

This option is valid only for AIX, Linux x86_64, Linux on POWER, and
Solaris. The IBM Spectrum Protect API does not support this option.

Syntax

>>-INCREmental-------------------------------------------------><



Examples

Command line:
         res i "/home/devel/projecta/*" -incremental


3.4.89 Instrlogmax


The instrlogmax option specifies the maximum size of the instrumentation
log (dsminstr.log), in MB. Performance data for the client is collected
in the dsminstr.log file during backup or restore processing when the
enableinstrumentation option is set to yes.

If you change the value of the instrlogmax option, the existing log is
extended or shortened to accommodate the new size. If the value is
reduced, the oldest entries are deleted to reduce the file to the new
size.

Supported Clients

This option is valid for all clients and the IBM Spectrum Protect API.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-INSTRLOGMAX-- --size---------------------------------------><



Parameters

size
         Specifies the maximum size, in MB, for the instrumentation log
         file. The range of values is 0 - 2047. The default value is 25.

         When the size of the dsminstr.log file exceeds the maximum
         size, the log file is renamed to dsminstr.log.bak. Subsequent
         instrumentation data continues to be saved to the dsminstr.log
         file.

         If you specify 0, the log file grows indefinitely.

Examples

Options file:
         instrlogmax 100

Command line:
         dsmc sel /home/mydir/* -subdir=yes -enableinstrumentation=yes
         -instrlogmax=100

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.52 Enableinstrumentation
3.4.90 Instrlogname


3.4.90 Instrlogname


The instrlogname option specifies the path and file name where you want
to store performance information that the backup-archive client
collects.

When you use the enableinstrumentation yes option to collect performance
data during backup and restore operations, the client automatically
stores the information in a log file.

By default, the performance data is stored in the instrumentation log
file (dsminstr.log) in the directory that is specified by the DSM_LOG
environment variable (or the DSMI_LOG environment variable for the
API-dependent products IBM Spectrum Protect for Databases: Data
Protection for Microsoft SQL Server and IBM Spectrum Protect for Mail:
Data Protection for Microsoft Exchange Server). If you did not set the
DSM_LOG environment variable, the instrumentation log file is stored in
the current directory (the directory where you issued the dsmc command).

Use this option only when you want to change the file name and location
of the instrumentation log.

If you want to control the size of the log file, use the instrlogmax
option.

Supported Clients

This option is valid for all clients and the IBM Spectrum Protect API.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Important: Set the DSM_LOG environment variable to name a directory
where the log is to be placed. The directory that is specified must have
permissions that allow write-access from the account under which the
client is run. The root directory is not a valid value for DSM_LOG.

Syntax

>>-INSTRLOGNAME-- --filespec----------------------------------><



Parameters

filespec
         Specifies the path and file name where you want to store
         performance information during backup or restore processing. If
         any part of the path that you specify does not exist, the
         client attempts to create it.

         If you specify a file name only, the file is stored in the
         directory that is specified by the DSM_LOG environment
         variable. If you did not set the DSM_LOG environment variable,
         the instrumentation log file is stored in the current directory
         (the directory where you issued the dsmc command). The
         instrumentation log file cannot be a symbolic link.



         For Mac OS X, if you specify a file name only, the file is
         stored in your default folder. The default directories are:

         ~/Library/Logs/tivoli/tsm
         /Library/Logs/tivoli/tsm



         This instrumentation log file name replaces the previous
         instrumentation log file name dsminstr.report.pXXX that was
         created by the TESTFLAG=instrument:detail or instrument:API
         option.



Examples

Options file:
         For AIX, Linux, and Oracle Solaris clients:

         instrlogname /home/user1/mydir/mydsminstr.log
         For Mac OS X clients:

         instrlogname /Users/user1/Library/Logs/mydsminstr.log


Command line:
         For AIX, Linux, and Oracle Solaris clients:

         dsmc sel /home/user1/mydir/* -subdir=yes -instrlogname=/usr/log/mydsminstr.log
         For Mac OS X clients:

         dsmc sel /Users/user1/mydir/* -subdir=yes -instrlogname=/Users/user1/Library/Logs/mydsminstr.log

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.52 Enableinstrumentation
3.4.89 Instrlogmax


3.4.91 Lanfreecommmethod


The lanfreecommmethod option specifies the communications protocol
between the IBM Spectrum Protect client and Storage Agent. This enables
processing between the client and the SAN-attached storage device.

If you are using LAN failover, you must have lanfreecommmethod in the
dsm.sys file within a server stanza.

For AIX, Linux and Solaris, use the lanfreeshmport option to specify the
shared memory port number where the Storage Agent is listening.

Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

>>-LANFREECommmethod-- --commmethod---------------------------><



Parameters

commmethod
         Specifies the supported protocol for the backup-archive client:

         TCPip
                  The Transmission Control Protocol/Internet Protocol
                  (TCP/IP) communication method.

                  Use the lanfreetcpport option to specify the TCP/IP
                  port number where the Storage Agent is listening. The
                  TCP/IP communication method is the default for
                  non-root users on all supported platforms.



         V6Tcpip
                  Indicates that either TCP/IP v4 or v6 should be used,
                  depending on the system configuration and results of a
                  domain name service lookup. The only time this is not
                  true is when dsmc schedule is used and schedmode is
                  prompt. A valid DNS environment must be available.

         SHAREdmem
                  Use the shared memory communication method when the
                  client and Storage Agent are running on the same
                  system. Shared memory provides better performance than
                  the TCP/IP protocol. This is the default communication
                  method for AIX, Linux, and Solaris root users. When
                  specifying this communication method on AIX, the
                  backup-archive client user can be logged in as root or
                  non-root, as long as the Storage Agent is running as
                  root. If the Storage Agent is not running as root, the
                  user ID running the backup-archive client must match
                  the user ID running the Storage Agent.

Examples

Options file:
         lanfreecommmethod tcp

         Use only TCP/IP v4



         lanfreecommmethod V6Tcpip



         Use both TCP/IP v4 or v6, depending on how the system is
         configured and the results of a domain name service lookup.

Command line:
         -lanfreec=tcp

         -lanfreec=V6Tcpip

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.92 Lanfreeshmport


Use the lanfreeshmport option when lanfreecommmethod=SHAREdmem is
specified for communication between the backup-archive client and the
storage agent. This enables processing between the client and the
SAN-attached storage device.



Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-LANFREEShmport-- --port_address----------------------------><



Parameters

port_address
         Specifies the number that is used to connect to the storage
         agent. The range of values is 1 through 32767.

         For Windows clients, the default is 1.

         For all clients except Windows clients, the default is 1510.

Examples

Options file:
         lanfrees 1520

Command line:
         -lanfrees=1520

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.93 Lanfreetcpport


The lanfreetcpport option specifies the TCP/IP port number where the IBM
Spectrum Protect Storage Agent is listening.

Use this option when you specify lanfreecommmethod=TCPip for
communication between the backup-archive client and Storage Agent. Do
not specify the lanfreetcpport option if you want to use the NAMedpipes
communication method for LAN-free communication.

Supported Clients

This option is valid only for AIX, Linux x86_64, Linux on POWER, and
Oracle Solaris clients.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

>>-LANFREETCPPort-- --port_address----------------------------><



Parameters

port_address
         Specifies the TCP/IP port number where the Storage Agent is
         listening. The range of values is 1 through 32767; the default
         is 1500.

         Note: The client lanfreetcpport value must match Storage Agent
         tcpport value for communications with the Storage Agent
         (virtual server). The client tcpport value must match the
         server tcpport value for communications with the actual server.

Examples

Options file:
         lanfreetcpp 1520

Command line:
         -lanfreetcpp=1520

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.94 Lanfreessl


Use the lanfreessl option to enable Secure Sockets Layer (SSL) to
provide secure client and Storage Agent communications. This option is
deprecated if you are connecting to an IBM Spectrum Protect 8.1.2 and
later levels, and 7.1.8 and later version 7 levels.

To enable SSL for data movement, set SSL YES on the client and the
storage agent. To disable SSL for data movement, set SSL NO on the
client and the storage agent. When the client and storage agent are on
the same system, use of SSL between them is not recommended for
performance reasons. Use shared memory or named pipes instead.

The client SSL option is set in the client options file. For more
information, see 3.4.168 Ssl.

The storage agent SSL option is set when it is defined by the DSMSTA
SETSTORAGESERVER command. For more information, see .

Note: Authentication is always achieved by using SSL, regardless of the
SSL option setting.

Supported Clients

This option is supported on all clients, except for Mac OS X clients.

Options File

Place this option in the client options file. You cannot set this option
in the GUI or on the command line.

Syntax

              .-No--.
>>-LANFREESSL-+-----+------------------------------------------><
              '-Yes-'



Parameters

No
         Specifies that the backup-archive client does not use SSL when
         communicating with the Storage Agent. No is the default.

Yes
         Specifies that the backup-archive client enables SSL when
         communicating with the Storage Agent. To enable SSL, specify
         lanfreessl=yes and change the value of the lanfreetcpport
         option. Changing the value of the lanfreetcpport option is
         necessary because the IBM Spectrum Protect Storage Agent is
         typically set up to listen for SSL connections on a separate
         port.

Examples

Options file:
         lanfreessl yes
         lanfreessl no

Command line:
         Not applicable. You cannot set this option on the command line.


3.4.95 Lanfreetcpserveraddress


The lanfreetcpserveraddress option specifies the TCP/IP address for the
IBM Spectrum Protect Storage Agent.

Use this option when you specify lanfreecommmethod=TCPip or V6Tcpip for
communication between the backup-archive client and Storage Agent.

Overriding the default for this option is useful when configuring
LAN-free in an environment where the client and storage agent are
running on different systems. You can obtain this Storage Agent address
from your administrator.

Supported Clients

This option is valid only for AIX, Linux x86_64, Linux on POWER, and
Oracle Solaris clients.

Options File

Place this option in the client system-options file.

Syntax

>>-LANFREETCPServeraddress-- --stagent_address----------------><



Parameters

stagent_address
         Specifies a 1 to 64 character TCP/IP address for a server.
         Specify a TCP/IP domain name or a numeric IP address. The
         numeric IP address can be either a TCP/IP v4 or TCP/IP v6
         address. The default value is 127.0.0.1 (localhost).

Examples

Options file:
         LANFREETCPServeraddress stagent.example.com

         LANFREETCPServeraddress 192.0.2.1

Command line:
         Does not apply.


3.4.96 Latest


Use the latest option to restore the most recent backup version of a
file, even if the backup is inactive.

You can use the latest option with the following commands:

*  restore
*  restore group

If you are performing a point-in-time restore (using the pitdate
option), it is not necessary to specify latest since this option is
implicit when pitdate is used.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-LATest------------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore "/Users/devel/projecta/*" -latest

Command line:
         dsmc restore "/home/devel/projecta/*" -latest


3.4.97 Localbackupset


The localbackupset option specifies whether the backup-archive client
GUI bypasses initial logon with the IBM Spectrum Protect server to
restore a local backup set on a standalone workstation.

If you set the localbackupset option to yes, the GUI does not attempt
initial logon with the server. In this case, the GUI only enables the
restore functionality.

If you set the localbackupset option to no (the default), the GUI
attempts initial logon with the server and enables all GUI functions.

Note: The restore backupset command supports restore of local backup
sets on a standalone workstation without using the localbackupset
option.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                   .-No--.
>>-LOCALbackupset--+-----+-------------------------------------><
                   '-Yes-'



Parameters

No
         Specifies that the GUI attempts initial logon with the server
         and enables all functions. This is the default.

Yes
         Specifies that the GUI does not attempt initial logon with the
         server and enables only the restore functionality.

Examples

Options file:
         localbackupset yes

This option is not valid with the dsmc command-line client.


3.4.98 Makesparsefile


Use the makesparsefile option with the restore or retrieve commands to
specify how sparse files are recreated.

Sparse files do not have disk space allocated for every block in the
whole address space, leading to holes within the file. The
backup-archive client detects sparse files during a backup operation and
marks them as sparse on the IBM Spectrum Protect server. Holes are
detected by their content, which is always zeros.

If you set the makesparsefile option to yes (default), holes within the
file are not written to disk so no additional disk space is allocated
during a restore.

If you set the makesparsefile option to no, holes are not recreated,
leading to disk blocks allocated for the whole address space. This might
result in a larger amount of used disk space. Ensure that you have
enough disk space to restore all data.

On some UNIX and Linux systems, it might be necessary to back up system
specific files as non-sparse files. Use the makesparsefile option for
files where the existence of physical disk blocks is required, such as
ufsboot on Solaris, which is executed during boot time. The boot file
loader of the operating system accesses physical disk blocks directly
and does not support sparse files.

Supported Clients

This option is valid for all UNIX and Linux clients except Mac OS X.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

                   .-Yes-.
>>-MAKESParsefile--+-----+-------------------------------------><
                   '-No--'



Parameters

Yes
         Specifies that holes within the file are not written so that no
         additional disk space is allocated during a restore. This is
         the default.

No
         Specifies that holes are not recreated leading to disk blocks
         allocated for the whole address space.

Examples

Options file:
         makesparsefile no

Command line:
         -makesparsefile=no

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.99 Managedservices


The managedservices option specifies whether the IBM Spectrum Protect
client acceptor service manages the scheduler, the web client, or both.

Restriction: You cannot use the dsmcad for scheduling when you set the
sessioninitiation option to serveronly.

The client acceptor daemon serves as an external timer for the
scheduler. When the scheduler is started, it queries the server for the
next scheduled event. The event is either executed immediately or the
scheduler exits. The client acceptor daemon restarts the scheduler when
it is time to execute the scheduled event.

Note:

1. If you set the schedmode option to prompt, the server prompts the
   client acceptor daemon when it is time to run the schedule. The
   scheduler connects to and disconnects from the server when the client
   acceptor daemon is first started.

   The dsmc schedule command cannot be used when both schedmode prompt
   and commmethod V6Tcpip are specified.

2. For Mac OS X, if you do not specify the managedservices option, the
   client acceptor daemon manages both the scheduler program and the web
   client, by default.

3. Set the passwordaccess option to generate in your dsm.sys file and
   generate a password, so IBM Spectrum Protect can manage your password
   automatically.



Using the client acceptor daemon to manage the scheduler service can
provide the following benefits:

*  Memory retention problems that can occur when using traditional
   methods of running the scheduler are resolved. Using the client
   acceptor daemon to manage the scheduler requires very little memory
   between scheduled operations.

*  The client acceptor daemon can manage both the scheduler program and
   the web client, reducing the number of background processes on your
   workstation.

*  To use the web client, you must specify this option in the client
   system-options file.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Web Client tab of the
Preferences editor.

Syntax

>>-MANAGEDServices--mode---------------------------------------><



Parameters

mode
         Specifies whether the client acceptor daemon manages the
         scheduler, the web client, or both.

         webclient
                  Specifies that the client acceptor daemon manages the
                  web client. This is the default for UNIX and Linux.
                  Both webclient and schedule are the defaults for Mac
                  OS X.

         schedule
                  Specifies that the client acceptor daemon manages the
                  scheduler. Both webclient and schedule are the
                  defaults for Mac OS X.

         none
                  For Mac OS X, specifies that the client acceptor
                  daemon not manage the web client or schedules. Set
                  managedservices to none to enable the dsmc schedule
                  command.

Examples

Options file:
         The following are examples of how you might specify the
         managedservices option in your client system-options file
         (dsm.sys).

         Task
                  Specify that the client acceptor daemon manages only
                  the web client.

                     managedservices webclient

         Task
                  Specify that the client acceptor daemon manages only
                  the scheduler.

                     managedservices schedule

         Task
                  Specify that the client acceptor daemon manages both
                  the web client and the scheduler.

                     managedservices schedule webclient



                  Note: The order in which these values are specified is
                  not important.

         Task
                  For Mac OS X, to use the dsmc schedule command,
                  specify:

                  managedservices none

Command line:
         Does not apply.


3.4.100 Maxcmdretries


The maxcmdretries option specifies the maximum number of times the
client scheduler (on your workstation) attempts to process a scheduled
command that fails.

The command retry starts only if the client scheduler has not yet backed
up a file, never connected to the server, or failed before backing up a
file. This option is only used when the scheduler is running.

Your IBM Spectrum Protect administrator can also set this option. If
your administrator specifies a value for this option, that value
overrides what you specify in the client options file after your client
node successfully contacts the server.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab, in the
Maximum command retries field of the Preferences editor.

Syntax

>>-MAXCMDRetries-- --maxcmdretries----------------------------><



Parameters

maxcmdretries
         Specifies the number of times the client scheduler can attempt
         to process a scheduled command that fails. The range of values
         is zero through 9999; the default is 2.

Examples

Options file:
         maxcmdr 4

Command line:
         -maxcmdretries=4

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.101 Mbobjrefreshthresh


The mbobjrefreshthresh (megablock object refresh threshold) option is a
number defining a threshold. When the number of IBM Spectrum Protect
objects that are needed to describe any 128 MB megablock exceeds this
value, the entire megablock is refreshed and the objects that were used
to represent this area, in previous backups, are expired.

When you backup a virtual machine, the data is stored on the IBM
Spectrum Protect server in 128 MB units, called megablocks. If an area
on the production disk changes and a new incremental backup is
performed, a new megablock is created to represent the changes that were
made to the previously backed up data. Because a new megablock can be
created with each incremental backup, eventually the megablocks can
adversely affect the performance of the IBM Spectrum Protect database,
and therefore, adversely affect the performance of most IBM Spectrum
Protect operations.

Use this option when estimating IBM Spectrum Protect objects that
represent production data for each virtual machine backup. For example,
when the number of IBM Spectrum Protect objects exceed this value, the
megablock is refreshed. This action means that the entire 128-MB block
is copied to the server and is represented as a single IBM Spectrum
Protect object. The minimum value is 2 and the maximum value is 8192.
The default value is 50.

Supported clients

This option is valid for data movers that protect VMware virtual
machines. To use this option, you must have a license agreement to use
IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options file

This option is valid in the client options file (dsm.opt). It can also
be included on the server in a client options set. It is not valid on
the command line.

Syntax

                        .-50------.
>>-MBOBJREFRESHTHRESH --+---------+----------------------------><
                        '-integer-'



Parameters

The minimum value you can specify is 2 megablocks, the largest value is
8192 megablocks; the default is 50 megablocks.

Examples

Set this option to trigger a megablock refresh when the number of
objects needed to represent an updated megablock exceeds 20 objects:

MBOBJREFRESHTHRESH 20


3.4.102 Mbpctrefreshthresh


The mbpctrefreshthresh (megablock percentage refresh threshold) option
is a number defining a threshold. When the percentage of IBM Spectrum
Protect objects that are needed to describe any 128 MB megablock exceeds
this value, the entire megablock is refreshed and the objects that were
used to represent this area, in previous backups, are expired.

When you backup a virtual machine, data is stored on the IBM Spectrum
Protect server in 128 MB units, called megablocks. If an area on the
production disk changes and a new incremental backup is performed, a new
megablock is created to represent the changes that were made to the
previously backed up data. Because a new megablock can be created with
each incremental backup, eventually the megablocks can adversely affect
the performance of the IBM Spectrum Protect database, and therefore,
adversely affect the performance of most IBM Spectrum Protect
operations.

Use this option when estimating the amount of additional data that is
backed up for each virtual machine. For example, when a 128-MB block of
a production disk changes more than the percentage specified, the entire
128-MB block is copied to the server. The block is represented as a
single IBM Spectrum Protect object.

Supported clients

This option is valid for clients that act as data mover nodes that
protect VMware virtual machines. To use this option, you must have a
license agreement to use IBM Spectrum Protect for Virtual Environments:
Data Protection for VMware.

Options file

This option is valid in the client options file (dsm.opt). It can also
be included on the server in a client options set. It is not valid on
the command line.

Syntax

                        .-50------.
>>-MBPCTREFRESHTHRESH --+---------+----------------------------><
                        '-integer-'



Parameters

The minimum value you can specify is 1 percent, the largest value is 99
percent; the default is 50 percent.

Examples

Set this option to trigger a megablock refresh when 50 percent (or more)
of the objects in a megablock on a production disk have changed:

                MBPCTREFRESHTHRESHOLD 50


3.4.103 Memoryefficientbackup


The memoryefficientbackup option specifies the memory-conserving
algorithm to use for processing full file space backups.

One method backs up one directory at a time, using less memory. The
other method uses much less memory, but requires more disk space.

Use the memoryefficientbackup option with the incremental command when
your workstation is memory constrained. You can also use this option as
a parameter to the include.fs option in order to select the algorithm
that the backup-archive client uses on a per-filespace basis.

Use memoryefficientbackup=diskcachemethod for any file space that has
too many files for the client to complete the incremental backup with
either the default setting, memoryefficientbackup=no, or with
memoryefficientbackup=yes.

The actual amount of disk space required for the disk cache file created
by disk cache incremental backups depends on the number of files and
directories included in the backup and on the average path length of the
files and directories to be backed up. For UNIX and Linux estimate 1
byte per character in the path name. For Mac OS X, estimate 4 bytes per
character in the path name. For example, if there are 1 000 000 files
and directories to be backed up and the average path length is 200
characters, then the database occupies approximately 200 MB for UNIX and
Linux, and 800 MB for Mac OS X clients. Another way to estimate for
planning purposes is to multiply the number of files and directories by
the length of the longest path to establish a maximum database size.

A second disk cache file is created for the list of migrated files when
backing up an HSM managed file system. The combined disk cache files,
created by disk cache incremental backups and HSM managed file system
backups, can require above 400 MB of disk space for each million files
being backed up. The disk cache file can become very large. Large file
support must be enabled on the file system that is being used for the
disk cache file.

Supported Clients

This option is valid for all clients. The server can also define this
option.

Options File

This option is allowed in dsm.opt and within a server stanza in dsm.sys,
but the value in dsm.opt is ignored if it also appears in dsm.sys. You
can also place this option on the initial command line. In interactive
mode, this option can be used with the incremental command. You can also
set this option on the Performance Tuning tab in the Preferences editor,
and selecting the Use memory-saving algorithm check box.

Syntax

                          .-No--------------.
>>-MEMORYEFficientbackup--+-----------------+------------------><
                          +-Yes-------------+
                          '-DISKCACHEMethod-'



Parameters

No
         Your client node uses the faster, more memory-intensive method
         when processing incremental backups. This is the default.

Yes
         Your client node uses the method that requires less memory when
         processing incremental backups.

Diskcachemethod
         Your client node uses the method that requires much less memory
         but more disk space when processing incremental backups for
         full file systems.

Examples

Options file:
         memoryefficientbackup yes
         memoryefficientbackup diskcachem

Command line:
         -memoryef=no


3.4.104 Mode


Use the mode option to specify the backup mode to use when performing
specific backup operations.

The mode option has no effect on a when backing up a raw logical device.

You can use the mode option with the following backup commands:

backup image
         To specify whether to perform a selective or incremental image
         backup of client file systems.

backup nas
         To specify whether to perform a full or differential image
         backup of NAS file systems.

backup group
         To specify whether to perform a full or differential group
         backup containing a list of files from one or more file space
         origins.

backup vm
         For VMware virtual machines, this parameter specifies whether
         to perform an incremental-forever-full or
         incremental-forever-incremental backup of VMware virtual
         machines.
         This feature is available only if the client operates as a data
         mover for IBM Spectrum Protect for Virtual Environments.

Supported Clients

This option is valid on all supported clients, except Mac OS. The IBM
Spectrum Protect API does not support this option.

This option is valid for data movers that protect VMware virtual
machines. To use this option, you must have a license agreement to use
IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Syntax

For image backups of client file systems
                     .-Selective---.
         >>-MODE = --+-------------+------------------------------------><
                     '-Incremental-'



For image backup of NAS file systems
                     .-differential-.
         >>-MODE = --+--------------+-----------------------------------><
                     '-full---------'



For group backups
                     .-full---------.
         >>-MODE = --+--------------+-----------------------------------><
                     '-differential-'



For backing up VMware virtual machines
                    .-IFIncremental-.
         >>-MODE= --+---------------+-----------------------------------><
                    '-IFFull--------'



Parameters

Image backup parameters
         selective
                  Specifies that you want to perform a full (selective)
                  image backup. This is the default mode for image
                  backups of client file systems.

         incremental
                  Specifies that you want to back up only the data that
                  has changed since the most recent image backup. If an
                  image backup has not already been created, then the
                  first backup is a full image backup (mode=selective),
                  regardless of what mode option you specify.

NAS backup parameters
         differential
                  This is the default for NAS objects. Specifies that
                  you want to perform a NAS backup of files that changed
                  since the last full backup. If there is no copy of a
                  full image stored on the IBM Spectrum Protect server,
                  a full backup occurs. If a full image exists, whether
                  it is restorable, or expired and being maintained
                  because of dependent differential images, specifying
                  MODE=differential sends a differential image backup.
                  If a full image is sent during a differential backup,
                  it is reflected as a full image using the QUERY
                  NASBACKUP server command.

                  A full image can be eligible for expiration based on
                  versioning or retention (verexists retextra), but
                  still be maintained on the server to allow for
                  restoring dependent differential images. A full image
                  that is eligible for expiration cannot be selected for
                  restore, so it is not displayed using the QUERY
                  NASBACKUP server command. The differential image
                  backups that depend on an "expired" full image can be
                  restored.

         full
                  Specifies that you want to perform a full backup of
                  NAS file systems.

Group backup parameters
         full
                  Specifies that you want to perform a full backup of
                  group objects. This is the default for group backups.

         differential
                  Specifies that you want to perform a group backup of
                  files that changed since the last full backup. If
                  there is no copy of a full image stored on the IBM
                  Spectrum Protect server, a full backup occurs. If a
                  full image exists, whether it is restorable, or
                  expired and being maintained because of dependent
                  differential images, specifying MODE=differential
                  sends a differential image backup. If a full image is
                  sent during a differential backup, it is reflected as
                  a full image using the QUERY GROUP server command.

                  A full image can be eligible for expiration based on
                  versioning or retention (verexists retextra), but
                  still be maintained on the server to allow for
                  restoring dependent differential images. A full image
                  that is eligible for expiration cannot be selected for
                  restore, so it is not displayed using the QUERY GROUP
                  server command. The differential image backups that
                  depend on an "expired" full image can be restored.

VMware virtual machine parameters
         IFFull
                  Specifies that you want to perform an
                  incremental-forever-full backup of a virtual machine.
                  An incremental-forever-full backup backs up all used
                  blocks on a VMware virtual machine's disks.

                  By default, the first backup of a VMware virtual
                  machine is an incremental-forever-full (mode=iffull)
                  backup, even if you specify mode=ifincremental (or let
                  the mode option default). Subsequent backups default
                  to mode=ifincremental.

                  You cannot use this backup mode to back up a virtual
                  machine if the client is configured to encrypt the
                  backup data.

                  For a description of the incremental-forever backup
                  strategy for VMware virtual machines, see Backup and
                  restore types.

         IFIncremental
                  Specifies that you want to perform an
                  incremental-forever-incremental backup of a virtual
                  machine. An incremental-forever-incremental backup
                  backs up only the disk blocks that have changed since
                  the last backup.

                  This mode is the default backup mode for VMware
                  virtual machine backups.

                  You cannot use this backup mode to back up a virtual
                  machine if the client is configured to encrypt the
                  backup data.

Examples

Task
         Perform a backup of a VMware virtual machine named vm1, using
         the incremental-forever-incremental mode to back up only the
         data that has changed since the last backup.

         dsmc backup vm vm1 -mode=ifincremental
          -vmbackuptype=full

Task
         Perform the NAS image backup of the entire file system.

         dsmc backup nas -mode=full -nasnodename=nas1
          /vol/vol0 /vol/vol1

Task
         Back up the /home/test file space using an image incremental
         backup that backs up only new and changed files after the last
         full image backup.

         dsmc backup image /home/test -mode=incremental -snapshotproviderimage=none

Task
         Perform a full backup of all the files in filelist
         /home/dir1/filelist1 to the virtual file space name /virtfs
         containing the group leader /home/group1 file.

         dscm backup group -filelist=/home/dir1/filelist1
          -groupname=group1 -virtualfsname=/virtfs -mode=full


3.4.105 Monitor


The monitor option specifies whether to monitor an image backup or
restore of file systems belonging to a Network Attached Storage (NAS)
file server.

If you specify monitor=yes, the backup-archive client monitors the
current NAS image backup or restore operation and displays processing
information on your screen. This is the default.

If you specify monitor=no, the client does not monitor the current NAS
image backup or restore operation and is available to process the next
command.

Use this option with the backup nas or restore nas commands.

Supported Clients

This option is valid for AIX, Linux, and Solaris clients only.

Syntax

               .-Yes-.
>>-MONitor = --+-----+-----------------------------------------><
               '-No--'



Parameters

Yes
         Specifies that you want to monitor the current NAS image backup
         or restore operation and display processing information on your
         screen. This is the default.

No
         Specifies that you do not want to monitor the current NAS image
         backup or restore operation.

Examples

Command line:
         backup nas -mode=full -nasnodename=nas1 -monitor=yes
         /vol/vol0 /vol/vol1


3.4.106 Myreplicationserver


The myreplicationserver option specifies which failover server stanza
that the client uses during a failover. Multiple failover server stanzas
can be specified.

A failover server stanza is identified by the replservername option and
contains connection information about a failover server.

This option is set by the IBM Spectrum Protect server administrator for
the client node. During the normal (non-failover) logon process, the
option is sent to the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed within a server stanza in the dsm.sys file.

Syntax

                        .-,-----------------------.
                        V                         |
>>-MYREPLICATIONServer--------repl_servername-----+------------><



Parameters

repl_servername
         Specifies the name of the stanza for each failover server to be
         used during a failover. This value is usually the name of the
         failover server, not the host name of the server. Also, the
         value of the repl_servername parameter is not case-sensitive,
         but the value must match the value that is specified for the
         REPLSERVERName option. You can specify up to two failover
         server stanza names separated by commas.

Examples

Options file:
         MYREPLICATIONServer
         TargetReplicationServer1,TargetReplicationServer2

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.107 Nasnodename


The nasnodename option specifies the node name for the NAS file server
when processing NAS file systems. The client prompts you for an
administrator ID.

The node name identifies the NAS file server to the IBM Spectrum Protect
server. The server must register the NAS file server.

You can specify this option on the command line or in the client
system-options file (dsm.sys).

You can override the default value in the dsm.sys file by entering a
different value on the command line. If you do not specify the
nasnodename option in the dsm.sys file, you must specify this option on
the command line when processing NAS file systems.

You can use the nasnodename option with the following commands:

*  backup nas
*  delete filespace
*  query backup
*  query filespace
*  restore nas

You can use the delete filespace command to interactively delete NAS
file spaces from server storage.

Use the nasnodename option to identify the NAS file server. Place the
nasnodename option in your client system-options file (dsm.sys). The
value in the client system-options file is the default, but this value
can be overridden on the command line. If the nasnodename option is not
specified in the client system-options file, you must specify this
option on the command line when processing NAS file systems.

Use the class option to specify the class of the file space to delete.
To display a list of file spaces belonging to a NAS node so that you can
choose one to delete, use the -class=nas option.

To delete NAS file spaces using the web client, see the topic for
backing up your data.

Supported Clients

This option is only valid for the AIX, Linux, and Solaris clients. The
IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the General tab of the
Preferences editor.

Syntax

>>-NASNodename-- --nodename-----------------------------------><



Parameters

nodename
         Specifies the node name for the NAS file server.

Examples

Options file:
         nasnodename nas2

Command line:
         -nasnodename=nas2


3.4.108 Nfstimeout


The nfstimeout option specifies the number of seconds the client waits
for a status system call on an NFS file system before it times out.

You can use this option to mitigate the default behavior of status calls
on file systems. For example, if an NFS file system is stale, a status
system call is timed out by NFS (soft mounted) or hang the process (hard
mounted).

When the value of this option is changed to a value other than zero, a
new thread is created by a caller thread to issue the status system
call. The new thread is timed out by the caller thread and the operation
can continue.

Note: On Solaris, the nfstimeout option can fail if the NFS mount is
hard. If a hang occurs, deactivate the nfstimeout option and mount the
NFS file system soft mounted, as follows:

mount -o soft,timeo=5,retry=5 machine:/filesystem /mountpoint

The parameters are defined as follows:

soft
         Generates a soft mount of the NFS file system. If an error
         occurs, the stat() function returns with an error. If the
         option hard is used, stat() does not return until the file
         system is available.

timeo=n
         Sets the time out for a soft mount error to n tenths of a
         second.

retry=n
         Set the internal retries and the mount retries to n, the
         default is 10000.

Supported Clients

This option is for all UNIX and Linux clients. The server can also
define this option.

Options File

Place this option in the dsm.sys file within a server stanza or the
client options file (dsm.opt).

Syntax

>>-NFSTIMEout-- --number--------------------------------------><



Parameters

number
         Specifies the number of seconds the client waits for a status
         system call on a file system before timing out. The range of
         values is 0 through 120; the default is 0 seconds.

Examples

Options file:
         nfstimeout 10

Command line:
         -nfstimeout=10

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.109 Nodename


Use the nodename option in your client options file to identify your
workstation to the server. You can use different node names to identify
multiple operating systems on your workstation.

When you use the nodename option, you are prompted for the password that
is assigned to the node that you specify, if a password is required.

If you want to restore or retrieve files from the server while you are
working from a different workstation, use the virtualnodename option.
You can also use the asnodename option, if it is set up by the
administrator.

When connecting to a server, the client must identity itself to the
server. This login identification is determined in the following manner:

*  In the absence of a nodename entry in the dsm.sys file, or a
   virtualnodename entry in the client user-options file (dsm.opt), or a
   virtual node name specified on a command line, the default login ID
   is the name that the hostname command returns.

*  If a nodename entry exists in the dsm.sys file, the nodename entry
   overrides the name that the hostname command returns.

*  If a virtualnodename entry exists in the client system-options file
   (dsm.sys), or a virtual node name is specified on a command line, it
   cannot be the same name as the name returned by the hostname command.
   When the server accepts the virtual node name, a password is required
   (if authentication is on), even if the passwordaccess option is
   generate. When a connection to the server is established, access is
   permitted to any file that is backed up using this login ID.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the General tab, in the Node Name field of the
Preferences editor.

Syntax

>>-NODename-- --nodename--------------------------------------><



Parameters

nodename
         Specifies a 1 to 64 character node name for which you want to
         request IBM Spectrum Protect services. The default is the value
         returned with the hostname command.

         Not specifying a node name permits the node name to default to
         the host name of the workstation

Examples

Options file:
         nodename cougar


3.4.110 Nojournal


Use the nojournal option with the incremental command to specify that
you want to perform a traditional full incremental backup, instead of
the default journal-based backup.

Journal-based incremental backup differs from the traditional full
incremental backup in the following ways:

*  Non-default copy frequencies (other than 0) are not enforced on the
   IBM Spectrum Protect server.

*  UNIX special file changes are not detected by the Journal daemon and
   are not, therefore, backed up.

For these reasons, you want to use the nojournal option periodically to
perform a traditional full incremental backup.

Supported Clients

This option is valid for the AIX and Linux backup-archive client.

Syntax

>>-NOJournal---------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
            dsmc incr /home -nojournal


3.4.111 Noprompt


The noprompt option suppresses the confirmation prompt that is presented
by the delete group, delete archive, expire, restore image, and set
event commands.

Use the noprompt option with the following commands:

*  delete archive
*  delete backup
*  delete group
*  expire
*  restore image

Note: The restore image command does not apply to Mac OS X operating
systems.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-NOPrompt----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc delete archive -noprompt "/Users/van/Documents/*"

Command line:
         dsmc delete archive -noprompt "/home/project/*"


3.4.112 Nrtablepath


The nrtablepath option specifies the location of the node replication
table on the client. The backup-archive client uses this table to store
information about each backup or archive operation to the IBM Spectrum
Protect server.

The server to which you back up your data must be at version 7.1 or
newer and must replicate client node data to a failover server.

When a failover occurs, the information that is on the failover server
might not be the most recent version if replication did not happen
before the failover. The client can compare the information in the node
replication table against the information that is on the failover server
to determine whether the backup on the server is the most recent backup
version.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys).

This option can also be configured in the client option set on the IBM
Spectrum Protect server.

Syntax

>>-NRTABLEPath----path-----------------------------------------><



Parameters

path
         Specifies the location where the node replication table
         database is created. The default location is the backup-archive
         client installation directory.

         For non-root users, you must specify a path that your user ID
         has write access to, such as a temporary directory. Most
         non-root users do not have access to the client installation
         directory.

         Restriction: The node replication table cannot be created in
         the root directory (/). If you choose to specify a location for
         the node replication table, do not specify the root directory.

Example

Options file:
         nrtablepath /Volumes/nrtbl

Command line:
         Does not apply.


3.4.113 Numberformat


The numberformat option specifies the format you want to use to display
numbers.

The AIX and Solaris clients support locales other than English that
describe every user interface that varies with location or language.

By default, the backup-archive and administrative clients obtain format
information from the locale definition in effect at the time the client
is called. Consult the documentation on your local system for details
about setting up your locale definition.

Note: The numberformat option does not affect the web client. The web
client uses the number format for the locale that the browser is running
in. If the browser is not running in a supported locale, the web client
uses the number format for US English.

You can use the numberformat option with the following commands:

*  delete archive
*  delete backup
*  expire
*  query archive
*  query backup
*  query image
*  query nas
*  restore
*  restore image
*  restore nas
*  retrieve
*  set event

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Regional Settings tab, Number Format field of the
Preferences editor.

Syntax

>>-NUMberformat-- --number------------------------------------><



Parameters

number
         Displays numbers using any one of the following formats.
         Specify the number (0–6) that corresponds to the number format
         you want to use.

         0
                  Use the locale-specified date format. This is the
                  default (does not apply to Mac OS X).

         1
                  1,000.00

                  This is the default for the following available
                  translations:



                  *  US English
                  *  Japanese
                  *  Chinese (Traditional)
                  *  Chinese (Simplified)
                  *  Korean

         2
                  1,000,00

         3
                  1 000,00

                  This is the default for the following available
                  translations:



                  *  French

                  *  Czech

                  *  Hungarian

                  *  Polish

                  *  Russian

         4
                  1 000.00

         5
                  1.000,00

                  This is the default for the following available
                  translations:



                  *  Brazilian Portuguese
                  *  German
                  *  Italian
                  *  Spanish

         6
                  1'000,00

For AIX and Solaris: To define number formats, modify the following
lines in the source file of your locale. Whatever format you select
applies both to output and to input.

decimal_point
         The character that separates the whole number from its
         fractional part.
thousands_sep
         The character that separates the hundreds from the thousands
         from the millions.
grouping
         The number of digits in each group that is separated by the
         thousands_sep character.

Examples

Options file:
         num 4

Command line:
         -numberformat=4

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.


3.4.114 Optfile


The optfile option specifies the client options file to use when you
start a backup-archive client session.



Supported Clients

This option is valid for all clients.

Syntax

>>-OPTFILE = -- --file_name-----------------------------------><



Parameters

file_name
         Specifies an alternate client options file, if you use the
         fully qualified path name. If you specify only the file name,
         the client assumes the file name specified is located in the
         current working directory. The default is dsm.opt.

         Restriction: Specify the full path when you use this option
         with the client acceptor daemon (dsmcad), because the client
         acceptor daemon changes its working directory to root ("/")
         after initialization.

Examples

Command line:
            dsmc query session -optfile=myopts.opt

Client acceptor daemon:
         dsmcad -optfile=/usr/tivoli/tsm/client/ba/bin/myopts.opt

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.115 Password


The password option specifies a password for IBM Spectrum Protect.

If you do not specify this option and your administrator has set
authentication to On, you are prompted for a password when you start a
backup-archive client session.

Note:

1. If the server prompts for a password, the password is not displayed
   as you enter it. However, if you use the password option on the
   command line, your password is displayed as you enter it.

2. If the IBM Spectrum Protect server name changes or the backup-archive
   clients are directed to a different server, all clients must
   re-authenticate with the server because the stored encrypted password
   must be regenerated.

The password option is ignored when the passwordaccess option is set to
generate.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt).

Syntax

>>-PASsword-- --password--------------------------------------><



Parameters

password
         Specifies the password you use to log on to the IBM Spectrum
         Protect server.

         Passwords can be up to 63 character in length. Password
         constraints vary, depending on where the passwords are stored
         and managed, and depending on the version of the server that
         your client connects to.

         If your IBM Spectrum Protect server is at version 6.3.3 or
         later, and if you use an LDAP directory server to authenticate
         passwords
                  Use any of the following characters to create a
                  password:

                  a b c d e f g h i j k l m n o p q r s t u v w x y z
                  A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
                  0 1 2 3 4 5 6 7 8 9 . ! @ # $ % ^ & * _ - + = ` ( )
                  | { } [ ] : ; < > , ? / ~

                  Passwords are case-sensitive and are subject to more
                  restrictions that can be imposed by LDAP policies.

         If your IBM Spectrum Protect server is at version 6.3.3 or
         later, and if you do not use an LDAP directory server to
         authenticate passwords
                  Use any of the following characters to create a
                  password:

                  a b c d e f g h i j k l m n o p q r s t u v w x y z
                  A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
                  0 1 2 3 4 5 6 7 8 9 . ! @ # $ % ^ & * _ - + = ` ( )
                  | { } [ ] : ; < > , ? / ~

                  Passwords are stored in the IBM Spectrum Protect
                  server database and are not case-sensitive.

         If your IBM Spectrum Protect server is earlier than version
         6.3.3
                  Use any of the following characters to create a
                  password:

                  a b c d e f g h i j k l m n o p q r s t u v w x y z
                  A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
                  0 1 2 3 4 5 6 7 8 9
                  _ - & + .

                  Passwords are stored in the IBM Spectrum Protect
                  server database and are not case-sensitive.

         Remember:

         On the command line, enclose all parameters that contain one or
         more special characters in quotation marks. Without quotation
         marks, the special characters can be interpreted as shell
         escape characters, file redirection characters, or other
         characters that have significance to the operating system.

         On AIX, Linux, and Solaris systems:
                  Enclose the command parameters in single quotation
                  marks (').

                  Command-line example:
                           dsmc set password -type=vmguest 'Win 2012
                           SQL' 'tsml2dag\administrator' '7@#$%^&7'

         Quotation marks are not required when you type a password with
         special characters in an options file.

Examples

Options file:
         password secretword

Command line:
         -password=secretword
         -password='my>pas$word'

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.116 Passwordaccess


The passwordaccess option specifies whether you want to generate your
password automatically or set as a user prompt.

Your administrator can require a password for your client node by
enabling the authentication feature. Ask your administrator if a
password is required for your client node.

If a password is required, you can choose one of the following methods:

*  Set the password for your client node yourself and have the client
   prompt for it each time you request services.

*  Let the client automatically generate a new password for your client
   node each time it expires, encrypt and store the password in a file,
   and retrieve the password from that file when you request services.
   You are not prompted for the password.

*  If the server is not configured to require a password to log on to
   it, you can still be prompted to enter your node password when the
   backup-archive client establishes a connection with the server. This
   behavior occurs if this option, passwordaccess, is allowed to default
   or if you set it to passwordaccess prompt. The password that you
   supply in response to the prompt is used only to encrypt your login
   information; it is not used to log onto the server. In this
   configuration, you can avoid entering a password by setting this
   option to passwordaccess generate. Setting passwordaccess generate
   causes the client to create, store, and submit the password for you.
   When passwordaccess generate is set, the password option is ignored.

Setting the passwordaccess option to generate is required in the
following situations:

*  When using the HSM client.
*  When using the web client.
*  When performing NAS operations.
*  When using IBM Spectrum Protect for Workstations.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Authorization tab, in the Password Access section
of the Preferences editor.

Syntax

                   .-prompt---.
>>-PASSWORDAccess--+----------+--------------------------------><
                   '-generate-'



Parameters

prompt
         You are prompted for your client node password each time a
         client connects to the server. This is the default.

         To keep your client node password secure, enter commands
         without the password and wait for the client to prompt you for
         the password.



         Each user must know the IBM Spectrum Protect password for your
         client node. Any user who knows the password for your client
         node can gain access to all backups and archives that originate
         from your client node. For example: If the user enters the node
         name and password for your client node from a different client
         node, the user becomes a virtual root user.



         API applications must supply the password when a session is
         initiated. The application is responsible for obtaining the
         password.



generate
         Encrypts and stores your password locally and generates a new
         password when the old password expires. The new password is
         randomly generated by the client. Password constraints vary,
         depending on where the passwords are stored and managed, and
         depending on the version of the server that your client
         connects to. Generated passwords are 63 characters in length
         and contain at least two of the following characters:

         *  upper case letters

         *  lower case letters

         *  numeric characters

         *  special characters

         Additionally, the first and last character of a generated
         password is an alphabetic character, and they can be either
         upper or lower case. Generated passwords do not contain
         repeated characters.

A password prompt is displayed when registering a workstation with a
server using open registration or if your administrator changes your
password manually.

When logging in locally, users do not need to know the password for the
client node. However, by using the nodename option at a remote node,
users can access files they own and files to which another user grants
access.

Examples

Options file:
         passwordaccess generate

Command line:
         Does not apply.


3.4.117 Passworddir


The passworddir option specifies the directory location in which to
store an encrypted password file. This directory location is also used
for the key database to store the server's public certificate in the
dsmcert.kdb file.

The default directory for AIX is /etc/security/adsm and for other UNIX
and Linux platforms it is /etc/adsm. The default directory for Mac is
/Library/Preferences/Tivoli Storage Manager. Regardless of where it is
stored, the password file that is created by the client is always named
TSM.sth. In turn three files comprise a password file. TSM.KDB stores
the encrypted passwords. TSM.sth stores the random encryption key that
is used to encrypt passwords in the TSM.KDB file. This file is protected
by the file system. TSM.IDX is an index file that is used to track the
passwords in the TSM.KDB file.

Supported Clients

This option is valid for all UNIX clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-PASSWORDDIR-- --directoryname------------------------------><



Parameters

directoryname
         Specifies the path in which to store the encrypted password
         file. The name of the password file is TSM.sth. If any part of
         the specified path does not exist, IBM Spectrum Protect
         attempts to create it.

Note: If no passworddir option is specified, the following locations are
checked for the dsmcert.kdb file:

1. The IBM Spectrum Protect application programming interface (API)
   client installation directory (when API is installed as a stand-alone
   product, without the IBM Spectrum Protect backup-archive client).

2. The IBM Spectrum Protect backup-archive client installation
   directory.

3. If HOME environment variable is defined in the user profile, under
   $HOME/IBM/SpectrumProtect/certs/ path.

If the dsmcert.kdb file is not found, then it is created in the first
directory the user has write access to.

Examples

Options file:
         passworddir "/Users/user1/Library/Preferences/Tivoli Storage Manager/"

         passworddir /etc/security/tsm

Command line:
         Does not apply.


3.4.118 Pick


The pick option creates a list of backup versions or archive copies that
match the file specification you enter.

From the list, you can select the versions to process. Include the
inactive option to view both active and inactive objects.

For images, if you do not specify a source file space and destination
file space, the pick list contains all backed up images. In this case,
the images selected from the pick list are restored to their original
location. If you specify the source file space and the destination file
space, you can select only one entry from the pick list.

Use the pick option with the following commands:

*  delete archive

*  delete backup

*  delete group

*  expire

*  restore

*  restore group

*  restore image

*  restore nas

*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-PIck--------------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore "/Users/van/Documents/*" -pick -inactive

Command line:
         dsmc restore "/home/project/*" -pick -inactive


3.4.119 Pitdate


Use the pitdate option with the pittime option to establish a point in
time to display or restore the latest version of your backups.

Files that were backed up on or before the date and time you specify,
and which were not deleted before the date and time you specify, are
processed. Backup versions that you create after this date and time are
ignored.

Use the pitdate option with the following commands:

*  delete backup

*  query backup

*  query group

*  query image

*  restore

*  restore group

*  restore image

*  restore nas

When pitdate is used, the inactive and latest options are implicit.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-PITDate = -- --date----------------------------------------><



Parameters

date
         Specifies the appropriate date. Enter the date in the format
         you selected with the dateformat option.

         When you include dateformat with a command, it must precede the
         fromdate, pitdate, and todate options.

Examples

Command line:
         dsmc restore "/Volumes/proj4/myproj/*" -sub=y
         -pitdate=08/01/2003 -pittime=06:00:00

Command line:
         dsmc restore "/fs1/*" -sub=y -pitdate=08/01/2003
         -pittime=06:00:00


3.4.120 Pittime


Use the pittime option with the pitdate option to establish a point in
time to display or restore the latest version of your backups.

Files that were backed up on or before the date and time you specify,
and which were not deleted before the date and time you specify, are
processed. Backup versions that you create after this date and time are
ignored. This option is ignored if you do not specify pitdate option.

Use the pittime option with the following commands:

*  delete backup
*  query backup
*  query image
*  restore
*  restore image
*  restore nas

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-PITTime = -- --time----------------------------------------><



Parameters

time
         Specifies a time on a specified date. If you do not specify a
         time, the time defaults to 23:59:59. Specify the time in the
         format you selected with the timeformat option.

         When you include the timeformat option in a command, it must
         precede the fromtime, pittime, and tottime options.

Examples

Command line:
         dsmc query backup -pitt=06:00:00 -pitd=08/01/2003
         "/Volumes/proj5/myproj/*"

Command line:
         dsmc q b "/fs1/*" -pitt=06:00:00 -pitd=08/01/2003


3.4.121 Postschedulecmd/Postnschedulecmd


The postschedulecmd/postnschedulecmd option specifies a command that the
client program processes after it runs a schedule.

If you want the client program to wait for the command to complete
before it continues with other processing, use the postschedulecmd
option. If you do not want to wait for the command to complete before
the client continues with other processing, specify the postnschedulecmd
option.

Return code handling and scheduled action behavior depends on both the
option specified, and the type of operation that is scheduled:

*  For scheduled operations where the scheduled action is something
   other than COMMAND:

   If the postschedulecmd command does not complete with return code 0
   (zero), the return code for the scheduled event is either 8, or the
   return code of the scheduled operation, whichever is greater. If you
   do not want the postschedulecmd command to be governed by this rule,
   you can create a script or batch file that starts the command and
   exits with return code 0. Then configure postschedulecmd to start the
   script or batch file.

*  For scheduled operations where the scheduled action is COMMAND:

   The return code from the command specified on the postschedulecmd
   option does not affect the return code that is reported to the server
   when the scheduled event completes. If you want the results of
   postschedulecmd operations to affect the return code of the scheduled
   event, include the postschedulecmd operations in the scheduled action
   command script instead of using the postschedulecmd option.

*  If the scheduler action cannot be started, and the command specified
   on the preschedulecmd option completes with a return code of zero
   (0), the command specified by the postschedulecmd option is run.

*  The return code from an operation specified on the postnschedulecmd
   option is not tracked, and does not influence the return code of the
   scheduled event.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab in the
Schedule Command text box in the Preferences editor. The server can also
define these options.

Syntax

>>-+-POSTSChedulecmd--+-- --cmdstring-------------------------><
   '-POSTNSChedulecmd-'



Parameters

cmdstring
         Specifies the command to process. You can enter a command to be
         run after a schedule with this option. Use only one
         postschedulecmd option.

         If the command string contains blanks, enclose the command
         string in quotation marks. If you placed quotation marks within
         the command string, then enclose the entire command string in
         single quotation marks.



         Use a blank, or null, string for cmdstring if you want to
         prevent any commands from running that the IBM Spectrum Protect
         server administrator uses for postschedulecmd or
         preschedulecmd. If you specify a blank or null string on either
         option, it prevents the administrator from using a command on
         both options.



         If your administrator uses a blank or null string on the
         postschedulecmd option, you cannot run a post-schedule command.



         For Mac OS X, if the postschedulecmd schedule command is an
         AppleScript, you must use the osascript command to run the
         script. For example, if "Database Script" is an AppleScript,
         enter this command:

            postschedulecmd osascript "/Volumes/La Pomme/Scripting/
              Database Script"



Examples

Options file:
         For Mac OS X: postschedulecmd "/Volumes/La
         Pomme/Scripting/postsched.sh"

Options file:
         postschedulecmd "restart database"

         The command string is a valid command for restarting your
         database.

Command line:
         -postschedulecmd="/Volumes/La Pomme/Scripting/postsched.sh"

Command line:
         -postschedulecmd="'restart database'"

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.122 Postsnapshotcmd


The postsnapshotcmd option allows you to run operating system shell
commands or scripts after the backup-archive client starts a snapshot
during a snapshot-based backup operation.

AIX only: This option is only applicable to JFS2 snapshot-based file
backup or archive and snapshot-based image backup. For a snapshot-based
file backup or archive, use this option with the backup command, the
include.fs option, or in the dsm.sys file.

Linux only: This option is only valid if the LVM is installed and
configured on your system, allowing you to perform a snapshot-based
image backup operation.

AIX and Linux only: For a snapshot-based image backup, use this option
with the backup image command, the include.image option, or in the
dsm.sys file.

If the postsnapshotcmd fails the operation continues, but appropriate
warnings are logged.

Supported Clients

This option is valid for AIX clients and Linux x86_64 clients only. The
IBM Spectrum Protect API does not support this option. The server can
also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can also set this option on the Image-Snapshot tab of
the Preferences editor.

Syntax

>>---POSTSNAPshotcmd---- --"cmdstring"------------------------><



Parameters

"cmdstring"
         Specifies a command to process.

         Use the srvprepostsnapdisabled option to prevent the IBM
         Spectrum Protect server administrator from executing operating
         system commands on the client system.



         If the command string contains blanks, enclose the command
         string in quotation marks:

            "resume database myDb"

         If you placed quotation marks within the command string, then
         enclose the entire command string in single quotation marks:

            'resume database "myDb"'

Examples

Options file:
         postsnapshotcmd "any command"

         The command string is a valid command for restarting your
         application.

Command line:
         backup image -postsnapshotcmd="any command"

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.123 Preschedulecmd/Prenschedulecmd


The preschedulecmd option specifies a command that the client program
processes before it runs a schedule.

The client program waits for the command to complete before it starts
the schedule. If you do not want it to wait, specify prenschedulecmd.

Note:

1. Successful completion of the preschedulecmd command is considered to
   be a prerequisite to running the scheduled operation. If the
   preschedulecmd command does not complete with return code 0, the
   scheduled operation and any postschedulecmd and postnschedulecmd
   commands will not run. The client reports that the scheduled event
   failed, and the return code is 12. If you do not want the
   preschedulecmd command to be governed by this rule, you can create a
   script or batch file that invokes the command and exits with return
   code 0. Then configure preschedulecmd to invoke the script or batch
   file. The return code for the prenschedulecmd command is not tracked,
   and does not influence the return code of the scheduled event.

2. The server can also define the preschedulecmd option (and the
   prenschedulecmd option).

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab, in the
Schedule Command dialog box in the Preferences editor.

Syntax

>>-+-PRESChedulecmd--+-- --cmdstring--------------------------><
   '-PRENSChedulecmd-'



Parameters

cmdstring
         Specifies the command to process. Use only one preschedulecmd
         option. You can enter a command to be executed before a
         schedule using this option.

         If the command string contains blanks, enclose the command
         string in quotation marks. If you placed quotation marks within
         the command string, then enclose the entire command string in
         single quotation marks.



         Use a blank or null string for cmdstring if you want to prevent
         any commands from running that the IBM Spectrum Protect server
         administrator uses for postschedulecmd and preschedulecmd. If
         you specify a blank or null string on either option, it
         prevents the administrator from using a command on both
         options.



         If your administrator uses a blank or null string on the
         preschedulecmd option, you cannot run a pre-schedule command.



         For Mac OS X, if the preschedulecmd schedule command is an
         AppleScript, you must use the osascript command to run the
         script. For example, if "Database Script" is an apple script,
         enter this command:

            preschedulecmd osascript "/Volumes/La Pomme/Scripting/
              Database Script"





Examples

Options file:
         preschedulecmd "<the quiesce command of your database product>
         database"

         The command string is a valid command for quiescing your
         database.

Command line:
         -preschedulecmd="'quiesce database'"

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.124 Preservelastaccessdate


Use the preservelastaccessdate option to specify whether a backup or
archive operation changes the last access time.

A backup or archive operation can change the last access time of a file.
After an operation, the backup-archive client can reset the last access
time to the value before the operation. The last access time can be
preserved, rather than modified, by the backup-archive client. Resetting
the last access time requires extra processing for each file that is
backed up or archived.

If you enable open file support, the last access date for files is
always preserved regardless of the setting for preservelastaccessdate.
When open file support is enabled, do not use the preservelastaccessdate
option.

Use this option with the incremental, selective, or archive commands.

Note:

1. This option applies only to files; it does not apply to directories.

2. Resetting the last access date affects backup and archive
   performance.

3. Resetting the last access date can affect applications that rely on
   accurate last-access dates such as a Storage Resource Management
   (SRM) application.

4. On file systems that are not managed by the IBM Spectrum Protect for
   Space Management client or when non-root users back up or archive,
   the ctime attribute is reset. The last changed time and date (ctime)
   attribute is reset to the date and time of the backup or archive
   operation.

5. The updatectime option takes precedence over the
   preservelastaccessdate option. If both options are set to yes, the
   preservelastaccessdate option is ignored

6. On file systems that are not managed by the IBM Spectrum Protect for
   Space Management client, do not use preservelastaccessdate yes and
   the GPFS mmbackup command. The mmbackup command and
   preservelastaccessdate yes selects all files for each backup
   operation.

7. You cannot reset the last access date of read-only files. The
   preservelastaccessdate option ignores read-only files and does not
   change their date.

Supported Clients

This option is valid for all clients.

The server can also define this option.

Options File

Place this option in the client user options file (dsm.opt). You can set
this option on the Backup tab of the Preferences editor.

Syntax

                           .-No--.
>>-PRESERVELAstaccessdate--+-----+-----------------------------><
                           '-Yes-'



Parameters

No
         A backup or archive operation can change the last access date.
         This value is the default.

Yes
         A backup or archive operation does not change the last access
         date.

Examples

Options file:
         preservelastaccessdate yes

Command line:
         Incremental /proj/test/test_file -preservelastaccessdate=yes


3.4.125 Preservepath


The preservepath option specifies how much of the source path to
reproduce as part of the target directory path when you restore or
retrieve files to a new location.

Use the -subdir=yes option to include the entire subtree of the source
directory (directories and files below the lowest-level source
directory) as source to be restored. If a required target directory does
not exist, it is created. If a target file has the same name as a source
file, it is overwritten. Use the -replace=prompt option to have the
client prompt you before files are overwritten.

Use the preservepath option with the following commands:

*  restore
*  restore backupset
*  restore group
*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Syntax

                    .-Subtree--.
>>-PRESERvepath = --+----------+-------------------------------><
                    +-Complete-+
                    +-NOBase---+
                    '-NONe-----'



Parameters

Subtree
         Creates the lowest-level source directory as a subdirectory of
         the target directory. Files from the source directory are
         stored in the new subdirectory. This is the default.

Complete
         Restores the entire path, starting from the root, into the
         specified directory. The entire path includes all the
         directories except the file space name.

NOBase
         Restores the contents of the source directory without the
         lowest level, or base directory, into the specified destination
         directory.

NONe
         Restores all selected source files to the target directory. No
         part of the source path at or above the source directory is
         reproduced at the target.

         If you specify SUBDIR=yes, the client restores all files in the
         source directories to the single target directory.



Examples

Command line:
         Assume that the server file space contains the following backup
         copies:

         /fs/h1/m1/file.a
         /fs/h1/m1/file.b
         /fs/h1/m1/l1/file.x
         /fs/h1/m1/l1/file.y

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -preser=complete

         Restores these directories and files:

         /u/ann/h1/m1/file.a
         /u/ann/h1/m1/file.b

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -preser=nobase

         Restores these directories and files:

         /u/ann/file.a
         /u/ann/file.b

This command:
         dsmc res backupset /fs/h1/m1/ /u/ann/ -su=yes
         -preser=nobase -loc=file

         Restores these directories and files:

         /u/ann/file.a
         /u/ann/file.b
         /u/ann/file.x
         /u/ann/file.y

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -preser=subtree

         Restores these directories and files:

         /u/ann/m1/file.a
         /u/ann/m1/file.b

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -preser=none

         Restores these directories and files:

         /u/ann/file.a
         /u/ann/file.b

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=complete

         Restores these directories and files:

         /u/ann/h1/m1/file.a
         /u/ann/h1/m1/file.b
         /u/ann/h1/m1/l1/file.x
         /u/ann/h1/m1/l1/file.y

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=nobase

         Restores these directories and files:

         /u/ann/file.a
         /u/ann/file.b
         /u/ann/l1/file.x
         /u/ann/l1/file.y

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=subtree

         Restores these directories and files:

         /u/ann/m1/file.a
         /u/ann/m1/file.b
         /u/ann/m1/l1/file.x
         /u/ann/m1/l1/file.y

This command:
         dsmc res /fs/h1/m1/ /u/ann/ -su=yes -preser=none

         Restores these directories and files:

         /u/ann/file.a
         /u/ann/file.b
         /u/ann/file.x
         /u/ann/file.y


3.4.126 Presnapshotcmd


The presnapshotcmd option allows you to run operating system commands
before the backup-archive client starts a snapshot.

This allows you to quiesce an application before the client starts the
snapshot during a snapshot-based backup or archive.

AIX only: This option is only applicable to JFS2 snapshot-based file
backup or archive and snapshot-based image backup. For a snapshot-based
file backup or archive, use this option with the backup command, the
include.fs option, or in the dsm.sys file.

Linux only: This option is only valid if the LVM is installed and
configured on your system, allowing you to perform a snapshot-based
image backup.

AIX and Linux only: For a snapshot-based image backup, use this option
with the backup image command, the include.image option, or in the
dsm.sys file.

If the presnapshotcmd fails it is assumed that the application is not in
a consistent state and the client stops the operation and display the
appropriate error message.

Supported Clients

This option is valid for AIX JFS2 and Linux x86_64 clients only. The IBM
Spectrum Protect API does not support this option. The server can also
define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set also this option on the Image-Snapshot tab of
the Preferences editor.

Syntax

>>---PRESNAPshotcmd---- --"cmdstring"-------------------------><



Parameters

"cmdstring"
         Specifies a command to process.

         Use the srvprepostsnapdisabled option to prevent the IBM
         Spectrum Protect server administrator from running operating
         system commands on the client system.



         If the command string contains blanks, enclose the command
         string in quotation marks:

            "quiesce database myDb"

         If you placed quotation marks within the command string, then
         enclose the entire command string in single quotation marks:

            'resume database "myDb"'

Examples

Options file:
         presnapshotcmd "any shell command or script"

Command line:
         backup image -presnapshotcmd="any shell command or script"

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.127 Queryschedperiod


The queryschedperiod option specifies the number of hours you want the
client scheduler to wait between attempts to contact the server for
scheduled work.

This option applies only when you set the schedmode option to polling.
This option is used only when the scheduler is running.

Your administrator can also set this option. If your administrator
specifies a value for this option, that value overrides the value set in
your client options file after your client node successfully contacts
the server.

Tip: If the period set by the queryschedperiod option is much smaller
than the randomization window of a schedule that is set by the server
administrator, the start of the schedule can be delayed. To avoid such a
delay, adjust the following values:

*  The client action duration (with the SET CLIENTACTDURATION server
   command)

*  The randomization of scheduled start times (with the SET RANDOMIZE
   server command)

*  The value of the queryschedperiod option

Given the settings for the client action duration and the randomization
window of a schedule, the following examples show how to calculate the
query schedule period.

Example 1:

  Client Action Duration: 1 Days
  Schedule Randomization Percentage: 25%
  Query Schedule Period: 6 hours

  Client Action Duration of 1 day = 24 hours
    24 hours x .25 = 6 hours
  Use a query schedule period of 6 hours or higher.

Example 2:

  Client Action Duration: 3 Days
  Schedule Randomization Percentage: 10%
  Query Schedule Period: 8 hours

  Client Action Duration of 3 days = 72 hours
    72 x .10 = 7.2
  Use a query schedule period of 8 hours or higher.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option. The server can also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-QUERYSCHedperiod-- --hours---------------------------------><



Parameters

hours
         Specifies the number of hours the client scheduler waits
         between attempts to contact the server for scheduled work. The
         range of values is 1 - 9999; the default is 4.

Example

Options file:
         querysch 6


3.4.128 Querysummary


The querysummary option provides statistics about files, directories and
objects that are returned by the query backup or query archive commands.

The following statistics are provided by the querysummary option:

*  The aggregate number of files and directories that are returned by
   the query backup or query archive command

*  The aggregate amount of data of the objects that are returned by the
   query backup or query archive command

*  The classic restore memory-utilization estimate to restore objects
   that are returned by the query backup or query archive command

*  The total number of unique server volumes where the objects that are
   returned by the query command reside



Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-QUERYSUMMARY------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc q ba '/usr/fs1/*' -sub=yes -querysummary

[root@kaveri:/home/cpark] $ dsmc q ba '/kalafs1/*' -sub=yes -querysummary
IBM Spectrum Protect
Command Line Backup-Archive Client Interface
  Client Version 8, Release 1, Level 0.0
  Client date/time: 12/09/2016 12:05:35
(c) Copyright by IBM Corporation and other(s) 1990, 2016. All Rights Reserved.

Node Name: KAVERI
Session established with server TEMPLAR: AIX-RS/6000
  Server Version 8, Release 1, Level 0.0
  Server date/time: 12/09/2016   12:05:35  Last access: 12/07/2016   07:48:59

      Size     Backup Date           Mgmt Class      A/I File
      ----     -----------           ----------      --- ----
     4,096  B  08/07/08   12:07:30       BASVT2       A  /kalafs1/
       256  B  08/07/08   12:07:30       BASVT2       A  /kalafs1/dir1
10,485,760  B  08/07/08   12:07:30      DEFAULT       A  /kalafs1/info1
 5,242,880  B  08/07/08   12:07:30      DEFAULT       A  /kalafs1/info2
     1,044  B  08/07/08   12:07:30      DEFAULT       A  /kalafs1/dir1/subfile1
     1,044  B  08/07/08   12:07:30      DEFAULT       A  /kalafs1/dir1/subfile2


Summary Statistics

Total Files Total Dirs  Avg. File Size Total Data  Memory Est.
----------- ----------  -------------- ----------  ----------
         4           2     3.75 MB      15.00 MB     1.07 KB


Estimated Number of Volumes: 2

[root@kaveri:/home/cpark] $


3.4.129 Quiet


The quiet option limits the number of messages that are displayed on
your screen during processing..

For example, when you run the incremental, selective, or archive
commands, information might appear about each file that is backed up.
Use the quiet option if you do not want to display this information

When you use the quiet option, error and processing information appears
on your screen, and messages are written to log files. If you do not
specify quiet, the default option, verbose is used.

Supported Clients

This option is valid for all clients. The server can also define the
quiet option, overriding the client setting. The IBM Spectrum Protect
API does not support this option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Command Line tab, Do not display process information
on screen checkbox of the Preferences editor.

Syntax

>>-QUIET-------------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Options file:
         quiet

Command line:
         -quiet

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.130 Quotesareliteral


The quotesareliteral option specifies whether single quotation marks (')
or double quotation marks (") are interpreted literally, when they are
included in a file list specification on a filelist option.

Ordinarily, the client requires you to use single or double quotation
marks to delimit file specifications that contain space characters. Some
file systems, such as the IBM Spectrum Scale (formerly GPFS) file
system, allow single and double quotation marks in file and directory
names.

To prevent errors that would otherwise occur, when file specifications
are included on a filelist option and they contain single quotation
marks (') or double quotation marks ("), set quotesareliteral yes. When
quotesareliteral is set to yes, quotation marks that are included in a
file list specification on a filelist option are interpreted literally,
as quotation marks, and not as delimiters.

This option applies to any command that accepts a filelist option as
command parameter.

Supported Clients

This option is valid for all supported UNIX and Linux platforms. The
option is applied to any command that takes a file list specification as
a parameter.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

                     .-no------.
>>-QUOTEsareliteral--+-+-----+-+-------------------------------><
                       '-yes-'



Parameters

no
         Specifies that single quotation marks (') and double quotation
         marks (") are interpreted as delimiters for file list
         specifications included on a filelist option. The default
         setting is No.

yes
         Specifies that single quotation marks (') and double quotation
         marks (") are interpreted literally, and not as delimiters, for
         file list specifications that are included on a filelist
         option. Specify this value if you are backing up files from a
         file system that allows quotation marks in file or directory
         names.

Examples

Options file:
         QUOTESARELITERAL YES

Command line:
         Assuming that the file system allows quotation marks in paths,
         the following are examples of files in a file list
         specification that can be successfully processed if
         QUOTESARELITERAL is set to YES
         Assume the command that is issued is dsmc sel
         -filelist=/home/user1/important_files, where
         important_files.txt contains the list of files to process.
         /home/user1/myfiles/"file"1000
         /home/user1/myfiles/'file'
         /home/user1/myfiles/file'ABC
         /home/user1/myfiles/ABC"file"


3.4.131 Removeoperandlimit


The removeoperandlimit option specifies that the client removes the
20-operand limit.

If you specify the removeoperandlimit option with the incremental,
selective, archive, or backup image command, the 20-operand limit is not
enforced and is restricted only by available resources or other
operating system limits.

The removeoperandlimit option can be useful if you generate scripts
which can invoke the command-line client with a large number of
operands. For example, you can prescan a directory tree looking for
files to back up. As each eligible file is discovered, it is added to
the operand list of a selective command. Later, this selective command
is submitted by a controlling script. In this case, specifying the
removeoperandlimit option removes the 20-operand limit.

Note:

1. The removeoperandlimit option must be placed immediately after the
   incremental, selective, archive, or backup image command before any
   file specifications.

2. This option does not accept a value. If this option is specified on a
   command, the 20-operand limit is removed.

3. Because it adversely affects performance to allow the shell to expand
   wild cards, use the removeoperandlimit option in backup or archive
   operations in which wild cards are not used.

4. The removeoperandlimit option is valid only on the incremental,
   selective, archive, and backup image commands in batch mode. It is
   not valid in the client options file (dsm.opt) or dsm.sys file.



Supported Clients

This option is valid for all UNIX and Linux clients.

Syntax

>>-REMOVEOPerandlimit------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         -removeoperandlimit


3.4.132 Replace


The replace option specifies whether to overwrite existing files on your
workstation, or to prompt you for your selection when you restore or
retrieve files.

Important: The replace option does not affect recovery of directory
objects. Directory objects are always recovered, even when specifying
replace=no. To prevent overwriting existing directories, use the
filesonly option.

You can use this option with the following commands:

*  restore
*  restore backupset
*  restore group
*  retrieve

Note: Replace prompting does not occur during a scheduled operation. If
you set the replace option to prompt, the backup-archive client skips
files without prompting you during a scheduled operation.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Restore tab, Action for files that already exist
section of the Preferences editor.

Syntax

            .-Prompt-.
>>-REPlace--+--------+-----------------------------------------><
            +-All----+
            +-Yes----+
            '-No-----'



Parameters

Prompt
         For nonscheduled operations, you specify whether to overwrite
         existing files. For scheduled operations, existing files are
         not overwritten and no prompts are displayed. This is the
         default.

All
         All existing files are overwritten, including read-only files.
         If access to a file is denied, you are prompted to skip or
         overwrite the file. No action is taken on the file until there
         is a response to the prompt.

Yes
         Existing files are overwritten, except read-only files. For
         nonscheduled operations, you specify whether to overwrite
         existing read-only files. For scheduled operations, existing
         read-only files are not overwritten and no prompts are
         displayed. If access to a file is denied, the file is skipped.

No
         Existing files are not overwritten. No prompts are displayed.

Examples

Options file:
         replace all

Command line:
         -replace=no

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.


3.4.133 Replserverguid


The replserverguid option specifies the globally unique identifier
(GUID) that is used when the client connects to a failover server. The
GUID is used to validate the failover server to ensure that it is the
expected server.

The replication GUID is different from the machine GUID of the server.
It is generated one time for a server that is doing the replication and
never changes.

This option must be specified within a replservername stanza in the
client options file. The replservername stanza contains connection
information about a failover server.

This option is set by the IBM Spectrum Protect server administrator for
the client node. During the normal (non-failover) logon process, the
option is sent to the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed in the dsm.sys file within the replservername
stanza.

Syntax

>>-replserverguid----serverguid--------------------------------><



Parameters

serverguid
         Specifies the GUID of a failover server.

Examples

Options file:
         REPLSERVERGUID 91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.134 Replservername


The replservername option specifies the name of a failover server that
the client connects to during a failover.

The replservername option begins a stanza in the client options file
that contains connection information about the failover server.

This option is set by the IBM Spectrum Protect server administrator for
the client node. During the normal (non-failover) logon process, the
option is sent to the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed in the client-system options dsm.sys.

Syntax

>>-replservername----repl_servername---------------------------><



Parameters

repl_servername
         Specifies the name of a failover server to be used during a
         failover. This value is usually the name of the failover
         server, not the host name of the server.

Examples

Options file:
         REPLSERVERName TargetReplicationServer1

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.135 Replsslport


The replsslport option specifies the TCP/IP port on the failover server
that is SSL-enabled. The replsslport option is used when the client
connects to a failover server. This option is deprecated if you are
connecting to an IBM Spectrum Protect server 8.1.2 and later levels, and
version 7.1.8 and later version 7 levels.

The replsslport option is sent to the client by the primary server only
if the failover server is configured for SSL.

This option is applicable only when the client is configured to use SSL
for secure communications between the IBM Spectrum Protect server and
client. If the client is not configured to use SSL, the port that is
specified by the repltcpport option is used. You can determine whether
the client uses SSL by verifying the SSL client option.

This option must be specified within a replservername stanza in the
client options file. The replservername stanza contains connection
information about a failover server.

During the normal (non-failover) logon process, this option is sent to
the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed in the dsm.sys file within the replservername
stanza.

Syntax

>>-replsslport----port_address---------------------------------><



Parameters

port_address
         Specifies the TCP/IP port address that is enabled for SSL and
         that is used to communicate with the failover server.

Examples

Options file:
         REPLSSLPORT 1506

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.136 Repltcpport


The repltcpport option specifies the TCP/IP port on the failover server
to be used when the client is redirected to a failover server.

This option must be specified within a replservername stanza in the
client options file. The replservername stanza contains connection
information about a failover server.

This option is set by the IBM Spectrum Protect server administrator for
the client node. During the normal (non-failover) logon process, the
option is sent to the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed in the dsm.sys file within the replservername
stanza.

Syntax

>>-repltcpport----port_address---------------------------------><



Parameters

port_address
         Specifies the TCP/IP port address that is used to communicate
         with a failover server.

Examples

Options file:
         REPLTCPPort 1500

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.137 Repltcpserveraddress


The repltcpserveraddress option specifies the TCP/IP address of a
failover server to be used when the client is redirected to a failover
server.

This option must be specified within a replservername stanza in the
client options file. The replservername stanza contains connection
information about a failover server.

This option is set by the IBM Spectrum Protect server administrator for
the client node. During the normal (non-failover) logon process, the
option is sent to the client and is saved in the client options file.

Do not edit this option during normal operations.

Edit this option only during situations such as the following ones:

*  The primary server is offline and the information for a failover
   server is not in the options file.

*  The failover server information is out-of-date or incorrect.

Any values that you edit are removed or updated the next time that you
log in to the primary server.

Supported Clients

This option is valid for all clients.

Options File

This option is placed in the dsm.sys file within the replservername
stanza.

Syntax

>>-REPLTCPServeraddress----server_address----------------------><



Parameters

server_address
         Specifies a TCP/IP address for a server that is 1 - 64
         characters in length. Specify a TCP/IP domain name or a numeric
         IP address. The numeric IP address can be either a TCP/IP v4 or
         TCP/IP v6 address. You can use only IPv6 addresses if you
         specified the commmethod V6Tcpip option.

Examples

Options file:
         REPLTCPServeraddress dsmchost.example.com

Command line:
         Does not apply.

Options file:
         The following example demonstrates how to specify options for
         multiple failover servers servers in the dsm.sys file, and how
         to reference the failover servers.
         Connection information for multiple failover servers is
         presented in stanzas. Each stanza is identified by the
         replservername option and the name of a failover server.
         The servername stanza must contain the myreplicationserver
         option, which points to up to two failover servers that are
         specified by replservername stanzas.
           REPLSERVERNAME   TargetReplicationServer1
             REPLTCPSERVERADDRESS TargetReplicationServer1
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.00

           REPLSERVERNAME   TargetReplicationServer2
             REPLTCPSERVERADDRESS TargetReplicationServer2
             REPLTCPPORT          1505
             REPLSSLPORT          1506
             REPLSERVERGUID       91.0f.ef.90.5c.cc.11.e1.ae.34.08.00.00.00.00.02

           SErvername     server_a
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname1.example.com
             PASSWORDAccess            prompt
             MYREPLICATIONServer       TargetReplicationServer1

           SErvername     server_b
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname2.example.com
             PASSWORDAccess            generate
             INCLExcl                  /adm/tsm/archive.excl
             MYREPLICATIONServer       TargetReplicationServer2

           SErvername     server_c
             COMMMethod                TCPip
             TCPPort                   1500
             TCPServeraddress          server_hostname3.example.com
             PASSWORDAccess            generate
             MYREPLICATIONServer       TargetReplicationServer1,TargetReplicationServer2


3.4.138 Resourceutilization


Use the resourceutilization option in your option file to regulate the
level of resources the IBM Spectrum Protect server and client can use
during processing.



Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the General tab, in the Resource Utilization field of
the Preferences editor.

Syntax

>>-RESOURceutilization-- --number-----------------------------><



Parameters

number
         Specifies the level of resources the IBM Spectrum Protect
         server and client can use during processing. The range of
         values that you can specify is 1 - 100. The default value is 2.

Examples

Options file:
         resourceutilization 7

Command line:
         -resourceutilization=7

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.138.1 Regulating backup and archive sessions


When you request a backup or archive, the client can use more than one
session to the server.

The default is to use a maximum of two sessions; one to query the server
and one to send file data. The client can use only one server session if
you set the resourceutilization option to 1.

A client can use more than the default number of sessions when it
connects to the IBM Spectrum Protect server. For example,
resourceutilization 10 permits up to eight sessions with the server.
Multiple sessions can be used for querying the server and sending file
data.

Multiple query sessions are used when you specify multiple file
specifications with a backup or archive command. For example, if you
enter the following commands and you specify resourceutilization 5, the
client might start a second session to query files on file space B.

inc /Volumes/filespaceA /Volumes/filespaceB

Whether the second session starts depends on how long it takes to query
the server about files that are backed up on file space A. The client
might also try to read data from the file system and send it to the
server on multiple sessions.

Note: During a backup operation, if you enter multiple file
specifications, the result might be that files from one file
specification are stored on multiple tapes and interspersed with files
from different file specifications. This can decrease restore
performance. Setting the collocatebyfilespec option to yes eliminates
interspersing of files from different file specifications, by limiting
the client to one server session per file specification. Therefore, if
you store the data to tape, files for each file specification are stored
together on one tape (unless another tape is required for more
capacity).


3.4.138.2 Regulating restore sessions


When you request a restore, the default is to use a maximum of one
session.

Additional restore sessions are based on:

*  resourceutilization value

*  how many tapes on which the requested data is stored

*  how many tape drives are available

*  the maximum number of mount points that are allowed for the node

Note:

1. If all of the files are on disk, only one session is used. There is
   no multi-session for a pure disk storage pool restore. However, if
   you are performing a restore in which the files are on 4 tapes and
   others are on disk, you could use up to 5 sessions during the
   restore.

2. The IBM Spectrum Protect server can set the maximum number of mount
   points a node can use on the server by using the MAXNUMMP parameter.
   If the resourceutilization option value exceeds the value of the
   MAXNUMMP on the server for a node, the backup can fail with an
   Unknown System Error message.

3. You can get a multi-session restore from your single restore command,
   and from a single volume on the server, if that volume is device
   class FILE.

For example, if the data you want to restore is on 5 different tape
volumes, the maximum number of mount points is 5 for your node, and
resourceutilization is set to 3, then 3 sessions are used for the
restore. If you increase the resourceutilization setting to 5, then 5
sessions are used for the restore. There is a 1 to 1 relationship
between the number of restore sessions that are allowed and the
resourceutilization setting. Multiple restore sessions are only allowed
for no-query restore operations.


3.4.138.3 Multiple client session considerations


This topic lists some items to consider when working with multiple
client sessions.

The following factors can affect the throughput of multiple sessions:

*  The ability of the server to handle multiple client sessions. Is
   there sufficient memory, multiple storage volumes, and processor
   cycles to increase backup throughput?

*  The ability of the client to drive multiple sessions (sufficient
   processor cycles, memory, etc.).

*  The configuration of the client storage subsystem. File systems that
   are striped across multiple disks, using either software striping or
   RAID-5 can better handle an increase in random read requests than a
   single drive file system. Additionally, a single drive file system
   might not see performance improvement if it attempts to handle many
   random concurrent read requests.

*  Sufficient bandwidth in the network to support the increased traffic.

Potentially undesirable aspects of running multiple sessions include:

*  The client could produce multiple accounting records.

*  The server might not start enough concurrent sessions. To avoid this,
   the server maxsessions parameter must be reviewed and possibly
   changed.

*  A query node command might not summarize client activity.

*  It is possible that files are restored instead of hard links.

   Restoring files instead of hard links can occur when the following
   criteria are all true:

   *  You restore an entire file system.

   *  During the restore operation, the value of the resourceutilization
      option is greater than 1.

   *  The file system contained hard links when the file system was
      backed up.

   The chance of restoring linked files instead of hard links increases
   as the number of sessions increases. When you restore a file system
   that contained hard links when the file system was backed up, set
   resourceutilization=1 to ensure that hard links are restored.


3.4.139 Retryperiod


The retryperiod option specifies the number of minutes the client
scheduler waits between attempts to process a scheduled command that
fails, or between unsuccessful attempts to report results to the server.
Use this option only when the scheduler is running.

Your administrator can also set this option. If your administrator
specifies a value for this option, that value overrides the value in
your client system options file after your client node successfully
contacts the server.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab, in the
Retry period field of the Preferences editor.

Syntax

>>-RETRYPeriod-- --minutes------------------------------------><



Parameters

minutes
         Specifies the number of minutes the client scheduler waits
         between attempts to contact the server, or to process a
         scheduled command that fails. The range of values is 1 through
         9999; the default is 20.

Examples

Options file:
         retryp 10

Command line:
         -retryperiod=10

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.140 Revokeremoteaccess


The revokeremoteaccess option restricts an administrator with client
access privilege from accessing a client workstation that is running the
web client.

This option does not restrict administrators with client owner, system,
or policy privilege from accessing your workstation through the web
client.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Web Client tab of the
Preferences editor.

Syntax

                       .-None---.
>>-REVOKEremoteaccess--+--------+------------------------------><
                       '-Access-'



Parameters

None
         Does not revoke access to administrators who have client access
         authority for the client. This is the default.

Access
         Revokes access to administrators who have client access
         authority for the client.

Examples

Options file:
         revokeremoteaccess none

Command line:
         Does not apply.


3.4.141 Schedcmddisabled


The schedcmddisabled option specifies whether to disable the scheduling
of commands by the server action=command option on the define schedule
server command.

This option does not disable the preschedulecmd and postschedulecmd
commands. However, you can specify preschedulecmd or postschedulecmd
with a blank or a null string to disable the scheduling of these
commands.

You can disable the scheduling of commands defined by your IBM Spectrum
Protect administrator by setting the schedcmddisabled option to yes.

Use the query schedule command to query the schedules defined by your
administrator.

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

                     .-No--.
>>-SCHEDCMDDisabled--+-----+-----------------------------------><
                     '-Yes-'



Parameters

Yes
         Specifies that the server disables the scheduling of commands
         using the action=command option on the DEFINE SCHEDULE server
         command.

No
         Specifies that the server does not disable the scheduling of
         commands using the action=command option on the DEFINE SCHEDULE
         server command. This is the default.

Examples

Options file:
         schedcmddisabled no

Command line:
         Does not apply.


3.4.142 Schedcmdexception


The schedcmexception option is used in conjunction with the
schedcmddisabled option to disable the scheduling of commands by the
server action=command option on the DEFINE SCHEDULE server command,
except for specific command strings.

You must specify the exact string that matches the "objects" definition
in the schedule for the scheduled server command to be accepted. If the
string does not match exactly (for example, there is an extra space or
the capitalization is different), the scheduled command action is
blocked.

You can provide multiple schedcmexception options in the options file.
This option is not honored if schedcmddisabled is not enabled. The
placement of this option in the options file is independent of the
placement of the schedcmddisabled option.

Supported Clients

This option is valid for all clients. This option is not valid in the
IBM Spectrum Protect server client options set.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

>>-SCHEDCMDException--string-----------------------------------><



Parameters

string
         For commands scheduled by the action=command option on the
         DEFINE SCHEDULE server command, this parameter indicates the
         objects pattern to enable if the schedcmddisabled=yes option is
         specified. This parameter is case sensitive, and must match the
         command string on the IBM Spectrum Protect server schedule
         definition.

Example

Options file:
         schedcmddisabled yes
         schedcmdexception "start echo hello, world!"


3.4.143 Schedgroup


The schedgroup option assigns a schedule to a group.

An example of the use of this option is to group multiple daily local
backup schedules with a single server backup schedule.

Supported Clients

This option is valid for all clients as a command-line option for the
server DEFINE SCHEDULE command. This option cannot be added to a client
option set that is on the IBM Spectrum Protect server.

Syntax

>>-SCHEDGROUP-- --schedule_group_name-------------------------><



Parameters

schedule_group_name
         Specifies the name of the schedule group. You can specify up to
         30 characters for the name.
         For a list of valid characters that you can use in the schedule
         group name, see the Naming IBM Spectrum Protect objects topic
         in the IBM Spectrum Protect product information
         (https://www.ibm.com/support/knowledgecenter/SSEQVQ/landing/welcome_sseqvq.html).

Examples

The following example commands group schedules SCHED_A_1, SCHED_A_2,
SCHED_A_3, and SCHED_A_4 in to schedule group GROUP_A.

Command line:
         This example shows a local backup at 6 AM:

         define schedule standard SCHED_A_1 Type=Client ACTion=Backup
         SUBACTion=VM OPTions='-vmfulltype=vstor -vmbackuptype=fullvm
         -vmbackuplocation=local -domain.vmfull="SCHEDULE-TAG"
         -asnodename=DC_SARTRE_WB -SCHEDGROUP=GROUP_A'
         STARTDate=02/06/2017 STARTTime=06:00:00 SCHEDStyle=Enhanced
         DAYofweek=ANY

         This example shows a local backup at 12 PM:

         define schedule standard SCHED_A_2 Type=Client ACTion=Backup
         SUBACTion=VM OPTions='-vmfulltype=vstor -vmbackuptype=fullvm
         -vmbackuplocation=local -domain.vmfull="SCHEDULE-TAG"
         -asnodename=DC_SARTRE_WB -SCHEDGROUP=GROUP_A'
         STARTDate=02/06/2017 STARTTime=12:00:00 SCHEDStyle=Enhanced
         DAYofweek=ANY

         This example shows a local backup at 6 PM:

         define schedule standard SCHED_A_3 Type=Client ACTion=Backup
         SUBACTion=VM OPTions='-vmfulltype=vstor -vmbackuptype=fullvm
         -vmbackuplocation=local -domain.vmfull="SCHEDULE-TAG"
         -asnodename=DC_SARTRE_WB -SCHEDGROUP=GROUP_A'
         STARTDate=02/06/2017 STARTTime=18:00:00 SCHEDStyle=Enhanced
         DAYofweek=ANY

         This example shows a local and server backup at midnight:

         define schedule standard SCHED_A_4 Type=Client ACTion=Backup
         SUBACTion=VM OPTions='-vmfulltype=vstor -vmbackuptype=fullvm
         -vmbackuplocation=both -domain.vmfull="SCHEDULE-TAG"
         -asnodename=DC_SARTRE_WB -SCHEDGROUP=GROUP_A'
         STARTDate=02/06/2017 STARTTime=00:00:00 SCHEDStyle=Enhanced
         DAYofweek=ANY
         Tip: Ensure that each schedule in the group can complete before
         the next schedule is set to start.
         This option is valid only on the initial command line. It is
         not valid in interactive mode.


3.4.144 Schedlogmax


The schedlogmax option specifies the maximum size of the schedule log
(dsmsched.log) and web client log (dsmwebcl.log), in megabytes.

This option causes the log files that get created for scheduler events
(dsmsched.log) and web client events (dsmwebcl.log) to wrap around when
they reach their maximum size. As scheduler and web client events are
logged, log records are added to the end of the log files until the
maximum specified size is reached. When the maximum specified size is
reached, a log record saying Continued at beginning of file is placed as
the last record in the file. Subsequent logging is resumed at the
beginning of the file. The end of the wrapped log is indicated by a
record saying END OF DATA.

When you set the schedlogmax option, scheduler and web client log
messages are not saved in a prune file. If you want to prune logs and
save the pruned log entries to another file, see the schedlogretention
option.

If you change from log wrapping (schedlogmax option) to log pruning
(schedlogretention option), all existing log entries are retained and
the log is pruned using the new schedlogretention criteria.

If you change from log pruning (schedlogretention option) to log
wrapping (schedlogmax option), all records in the existing logs are
copied to a file containing the pruned entries. For example, log records
pruned from the dsmsched.log file are copied to dsmsched.pru. Log
records pruned from dsmwebcl.log are copied to dsmweblog.pru. The
existing logs (dsmsched.log and dsmwebcl.log) are emptied, and logging
begins using the new log wrapping criteria.

If you simply change the value of the schedlogmax option, the existing
log is extended or shortened to accommodate the new size. If the value
is reduced, the oldest entries are deleted to reduce the file to the new
size.

If neither schedlogmax nor schedlogretention is specified, the error log
can grow without any limit on its size. You must manually manage the log
contents to prevent the log from depleting disk resources. When the log
has been created with neither option specified, if you later issue a
command and specify the schedlogretention option, the log is pruned
using the retention value specified. When the log has been created with
neither option specified, if you later issue a command and specify the
schedlogmax option, the existing log is treated as if it was a pruned
log. That is, the content of the dsmsched.log file is copied to a file
called dsmsched.pru, the content of dsmwebcl.log is copied to a file
called dsmwebcl.pru, and new log entries are created in dsmsched.log and
dsmwebcl.log, and both files wrap when they reach their maximum size.

Note: If you specify a non-zero value for schedlogmax (which enables log
wrapping), you cannot use the schedlogretention option to create pruned
logs. Logs can be pruned or wrapped, but not both.

Logs created with the schedlogmax option contain a log header record
that contains information similar to this example record:

LOGHEADERREC 661  104857600 IBM Spectrum Protect 8.1.0.0 Fri Dec 9 06:46:53 2014

Note that the dates and time stamps in the LOGHEADERREC text are not
translated or formatted using the settings specified on the dateformat
or timeformat options.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

You can also set this option on the Client Preferences -> Scheduler tab
in the GUI, by selecting Enable scheduler log file wrapping and by
specifying a non-zero maximum size for the log file. To prevent log file
wrapping, set the maximum size to zero. When the maximum wrapping is set
to zero, clearing or setting the Enable scheduler log file wrapping
option has no effect; log wrapping does not occur if the maximum size is
set to zero.

Syntax

>>-SCHEDLOGMAX-- --size---------------------------------------><



Parameters

size
         Specifies the maximum size, in megabytes, for the log file. The
         range of values is 0 to 2047; the default is 0, which disables
         log file wrapping and allows the log file to grow indefinitely.

Examples

Options file:
         schedlogmax 100

Command line:
         -schedlogmax=100

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.145 Schedlogname


The schedlogname option specifies the path and file name where you want
to store schedule log information.

Use this option only when you want to store schedule log information.
This option applies only when the scheduler is running.

If this option is not used, the dsmsched.log file is created in the same
directory as the dsmerror.log file.

When you run the schedule command, output from scheduled commands
appears on your screen. Output is also sent to the file you specify with
this option. If any part of the path you specify does not exist, the
client attempts to create it.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab, in the
Schedule Log text box, in the Preferences editor.

Note: Set the DSM_LOG environment variable to name a directory where the
log is to be placed. The directory specified must have permissions which
allow write access from the account under which the client is run. The
root directory is not a valid value for DSM_LOG.

Syntax

>>-SCHEDLOGName-- --filespec----------------------------------><



Parameters

filespec
         Specifies the path and file name where you want to store
         schedule log information when processing scheduled work. If any
         part of the path you specify does not exist, the client
         attempts to create it.

         If you specify a file name only, the file is stored in your
         current directory. The default is the current working directory
         with a file name of dsmsched.log. The dsmsched.log file cannot
         be a symbolic link.



         For Mac OS X, if you specify a file name only, the file is
         stored in your default folder. The default directories are:

         ~/Library/Logs/tivoli/tsm
         /Library/Logs/tivoli/tsm





Examples

Options file:
         SCHEDLOGN /Users/user1/Library/Logs/schedlog.jan


         schedlogname /home/mydir/schedlog.jan

Command line:
         -schedlogname=/Users/user1/Library/Logs/schedlog.jan

Command line:
         -schedlogname=/home/mydir/schedlog.jan

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.146 Schedlogretention


The schedlogretention option specifies the number of days to keep
entries in the schedule log (dsmsched.log) and the web client log
(dsmwebcl.log), and whether to save the pruned entries in another file.

The schedule log (dsmsched.log) is pruned when the scheduler starts and
after a scheduled event completes. Pruned entries are written to a file
called dsmsched.pru.

The web client log (dsmwebcl.log) is pruned during the initial start of
the client acceptor daemon. Pruned entries are written to a file called
dsmwebcl.pru.

If you change from log pruning (schedlogretention option) to log
wrapping (schedlogmax option), all records in the existing log are
copied to the pruned log (dsmsched.pru and dsmwebcl.pru), and the
existing logs (dsmsched.log and dsmwebcl.log) are emptied, and logging
begins using the new log wrapping criteria.

If you change from log wrapping (schedlogmax option) to log pruning
(schedlogretention option), all existing log entries are retained and
the log is pruned using the new schedlogretention criteria. Pruned
entries are saved in their corresponding *.pru files.

If neither schedlogmax nor schedlogretention is specified, the logs can
grow without any limit on their size. You must manually manage the log
contents to prevent the log from depleting disk resources. When the log
has been created with neither option specified, if you later issue a
command and specify the schedlogretention option, the log is pruned
using the retention value specified. When the log has been created with
neither option specified, if you later issue a command and specify the
schedlogmax option, the existing log is treated as if it was a pruned
log. That is, the content of the dsmsched.log file is copied to a file
called dsmsched.pru, the content of dsmwebcl.log is copied to
dsmwebcl.pru, and new log entries are created in both dsmsched.log and
dsmwebcl.log, and both files wrap when they reach their maximum size.

Note: If you specify schedlogretention option to create pruned logs, you
cannot specify the schedlogmax option. Logs can be pruned or wrapped,
but not both.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

You can also set this option on the Client preferences -> Scheduler tab
in the GUI, by selecting Prune old entries and by specifying a value for
Prune entries older than. Selecting the Save pruned entries option saves
the pruned scheduler log entries in the dsmsched.pru log file. Selecting
Save pruned entries also saves web client log entries in the
dsmwebcl.pru log file.

Syntax

                      .-N----.  .-D-.
>>-SCHEDLOGRetention--+------+--+---+--------------------------><
                      '-days-'  '-S-'



Parameters

N or days
         Specifies how long to wait before pruning the log.

         N
                  Do not prune the log. This permits the log to grow
                  indefinitely. This is the default.

         days
                  Specifies the number of days to keep log file entries
                  before pruning. The range of values is zero through
                  9999.

D or S
         Specifies whether to save the pruned entries. Use a space or
         comma to separate this parameter from the previous one.

         D
                  Discards the log entries when pruning the log. This is
                  the default.

         S
                  Saves the log entries when pruning the log.

                  Pruned entries are copied to the file of pruned
                  entries (dsmsched.pru or dsmsched.pru), which is
                  stored in the same directory as the log.

Examples

Options file:
         schedlogretention 30 S

Command line:
         -schedlogretention=30,S

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.147 Schedmode


The schedmode option specifies whether you want to use the polling mode
(your client node periodically queries the server for scheduled work),
or the prompted mode (the server contacts your client node when it is
time to start a scheduled operation).

All communication methods can use the client polling mode, but only
TCP/IP can use the server prompted mode.

This option applies only if you are using the TCP/IP communication
method, and the schedule command is running.

Your administrator can specify that the server support both modes or
just one mode. If your administrator specifies that both modes are
supported, you can select either schedule mode. If your administrator
specifies only one mode, you must specify that mode in your dsm.sys file
or scheduled work is not processed.

If you specify prompted mode, you should consider supplying values for
the tcpclientaddress and tcpclientport options in your dsm.sys file or
on the schedule command; the client can then be contacted at either an
address or a port of your choice (useful for client systems with
multiple network interface cards).

Note:

1. When changing the setting of this option in the dsm.sys file you must
   stop and restart the scheduler service for the setting to take
   effect.

2. The server can also define this option.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Scheduler tab, in the
Schedule Mode section in the Preferences editor.

Syntax

              .-POlling--.
>>-SCHEDMODe--+----------+-------------------------------------><
              '-PRompted-'



Parameters

POlling
         The client scheduler queries the server for scheduled work at
         prescribed time intervals. This is the default. You can set the
         time intervals using the queryschedperiod option.

PRompted
         The client scheduler waits for the server to contact your
         client node when scheduled work needs to be done.

         Note:

         1. If you use the dsmc schedule command and both schedmode
            prompted and commmethod V6Tcpip are specified, the client
            and IBM Spectrum Protect server must be configured for IPv6.
            Additionally, the client host name must be set up for the
            IPv6 address.

Examples

Options file:
         schedmode prompted

Command line:
         -schedmod=po

This option is valid only on the initial command line. It is not valid
in interactive mode.

Related reference
3.4.14 Cadlistenonport
3.4.180 Tcpclientaddress
3.4.181 Tcpclientport


3.4.148 Schedrestretrdisabled


The schedrestretrdisabled option specifies whether to disable the
execution of restore or retrieve schedule operations.



Supported Clients

This option is valid for all clients. The server cannot define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the dsm.sys file within a server stanza for the
scheduler. You can set this option on the Scheduler tab in the Schedule
Command section in the Preferences editor.

Syntax

                          .-No--.
>>-SCHEDRESTRETRDisabled--+-----+------------------------------><
                          '-Yes-'



Parameters

No
         Specifies that the client does not disable the execution of
         restore and retrieve schedule operations. This parameter is the
         default.

Yes
         Specifies that the client disables the execution of restore and
         retrieve schedule operations.

Examples

Options file:
         schedrestretrdisabled yes

Command line:
         Does not apply.


3.4.149 Scrolllines


The scrolllines option specifies the number of lines of information that
are displayed on your screen at one time.

Use this option when you set the scrollprompt option to Yes.

You can use the scrolllines option with the following commands only:

*  delete filespace
*  query archive
*  query backup
*  query backupset
*  query filespace
*  query group
*  query image
*  query nas
*  query node
*  query options

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option in Command Line -> Number of lines to display in the
Preferences editor.

Syntax

>>-SCROLLLines-- --number-------------------------------------><



Parameters

number
         Specifies the number of lines of information that are displayed
         on your screen at one time. The range of values is 1 through
         80; the default is 20.

Examples

Options file:
         scrolllines 25

Command line:
         -scrolll=25

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.


3.4.150 Scrollprompt


The scrollprompt option specifies whether you want the bakup-archive
client to stop and wait after displaying the number of lines of
information you specified with the scrolllines option, or scroll through
and stop at the end of the information list.

You can use the scrollprompt option with the following commands only:

*  delete filespace
*  query archive
*  query backup
*  query backupset
*  query filespace
*  query group
*  query image
*  query nas
*  query node
*  query options

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Command Line tab, Pause after displaying the
following number of lines field of the Preferences editor.

Syntax

                 .-No--.
>>-SCROLLPrompt--+-----+---------------------------------------><
                 '-Yes-'



Parameters

No
         Scrolls to the end of the list and stops. This is the default.

Yes
         Stops and waits after displaying the number of lines you
         specified with the scrolllines option. The following prompt is
         displayed on the screen:

         Press ‘Q' to quit, ‘C' to continuous scroll, or ‘Enter' to
         continue.

Examples

Options file:
         scrollprompt yes

Command line:
         -scrollp=yes

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.


3.4.151 Servername


In your dsm.sys file, the servername option specifies the name you want
to use to identify a server and to begin a stanza containing options for
that server. You can name and specify options for more than one server.

The following example demonstrates how to specify options for two
different servers:

   SErvername     server_a
     COMMMethod                TCPip
     TCPPort                   1500
     TCPServeraddress          server_hostname2.domain.
                                company.com
     PASSWORDAccess            prompt
     GRoups                    tsm
     USERs                     sullivan  mushock  tallan
     INCLExcl                  /adm/tsm/backup.excl

   SErvername     server_b
     COMMMethod                SHAREdmem
     shmport                   1520
     PASSWORDAccess            generate
     GRoups                    system tsm
     INCLExcl                  /adm/tsm/archive.excl

In your client user-options file (dsm.opt), the servername option
specifies which server, of those named in your dsm.sys file, to contact
for backup-archive services. When specified in a client user-options
file (dsm.opt) or on the command line, the servername option overrides
the default server specified in your client system options file.

Note:

1. You cannot use the servername option to override the server that is
   specified for migration in your client system options file.

2. If the IBM Spectrum Protect server name changes or backup-archive
   clients are directed to a different IBM Spectrum Protect server, all
   clients must have a new password initialized for the new server name.

Supported Clients

This option is for all UNIX and Linux clients.

Options File

Place this option in the client user options file (dsm.opt) and in the
client system options file (dsm.sys). In the dsm.sys file, the
servername option is the beginning of a server stanza.

Do not modify this option in dsm.opt when you are running the
Backup-Archive client in a command-line session or when your are running
the Backup-Archive client GUI.

Syntax

>>-SErvername-- --servername----------------------------------><



Parameters

servername
         In your dsm.sys file, specify the name you want to assign to a
         particular server. In your client user-options file (dsm.opt)
         or on the command line, specify the name of the server you want
         to contact for backup-archive services. The value of servername
         in dsm.opt must match a servername value in dsm.sys, or the
         client cannot contact the server.

         A server name is not case sensitive; it can have up to 64
         characters.

Examples

Options file:
         servername server_a

Command line:
         -se=server_b

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.152 Sessioninitiation


Use the sessioninitiation option to control whether the server or client
initiates sessions through a firewall. The default is that the client
initiates sessions. You can use this option with the schedule command.

For the client scheduler, you do not need to open any ports on the
firewall. If you set the sessioninitiation option to serveronly, the
client will not attempt to contact the server. All sessions must be
initiated by server prompted scheduling on the port defined on the
client with the tcpclientport option. The sessioninitiation option only
affects the behavior of the client scheduler running in the prompted
mode. If you set the sessioninitiation option to serveronly, with the
exception of client acceptor daemon-managed schedulers, the command-line
client, and the backup-archive client GUI still attempt to initiate
sessions.

Attention: You cannot use the dsmcad for scheduling when you set the
sessioninitiation option to serveronly

Note: If you set the sessioninitiation option to serveronly, the client
setup wizard and scheduler service are unable to authenticate to the IBM
Spectrum Protect server. In this case, you can execute the scheduler
from the command line (dsmc schedule) and enter the password for your
node when prompted.

A similar problem can occur if an encryption key is required for backup
operations. In this case, you can execute the scheduler from the command
line (dsmc schedule) and enter the encryption key when prompted. After
the password and encryption key are updated, you must restart the
scheduler.

If you set the sessioninitiation option to client, the client initiates
sessions with the server by communicating on the TCP/IP port defined
with the server option tcpport. This is the default. Server prompted
scheduling can be used to prompt the client to connect to the server.

Note:

1. The IBM Spectrum Protect server can specify
   SESSIONINITiation=clientorserver or SESSIONINITiation=serveronly on
   the register node and update node commands. If the server specifies
   SESSIONINITiation=clientorserver, the client can decide which method
   to use. If the server specifies SESSIONINITiation=serveronly, all
   sessions are initiated by the server.

2. If sessioninitiation is set to serveronly, the value for the
   tcpclientaddress client option must be the same as the value for the
   HLAddress option of the update node or register node server command.
   The value for the tcpclientport client option must be the same as the
   value for the LLAddress option of the update node or register node
   server command.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Scheduler tab, Session Initiation field of the
Preferences editor.

Syntax

                      .-Client-----.
>>-SESSIONINITiation--+------------+---------------------------><
                      '-SERVEROnly-'



Parameters

Client
         Specifies that the client initiates sessions with the server by
         communicating on the TCP/IP port defined with the server option
         TCPPORT. This is the default. Server prompted scheduling can be
         used to prompt the client to connect to the server.

SERVEROnly
         Specifies that the server will not accept client requests for
         sessions. All sessions must be initiated by server prompted
         scheduling on the port defined on the client with the
         tcpclientport option. Except for client acceptor daemon-managed
         schedulers, the command-line client, and the backup-archive
         client GUI still attempt to initiate sessions.
         If the server AUTHENTICATION option is set to LDAP, do not set
         the client sessioninitiation option to serveronly; if you do,
         schedules cannot run.

Examples

Options file:
         sessioninitiation serveronly

Command line:
         schedule -sessioninitiation=serveronly

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.153 Setwindowtitle


Use the setwindowtitle option to modify the title of the administrative
client command window during processing.

For example, when you run the administrative client command (dsmadmc) on
the client node and the administrative client connects to the IBM
Spectrum Protect server, the following text is displayed in the title of
the command window:

 CONNECTED TO SERVER: servername(serverhostname)

where servername is the name of the IBM Spectrum Protect server, and
serverhostname is the host name of the IBM Spectrum Protect.

When you use the setwindowtitle option, any user-defined title of the
command window is overwritten. After you disconnect the administrative
client from the IBM Spectrum Protect server, the window title is reset
to the user-defined window title.

On AIX, Linux, and Oracle Solaris operating systems, the terminal window
title is reset to the title "Terminal" after you disconnect from the
server.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt) or the
client system-options file (dsm.sys).

Syntax

                   .-No--.
>>-SETWINDOWTITLE--+-----+-------------------------------------><
                   '-Yes-'



Parameters

No
         The title of the administrative client command window is not
         changed during processing. This parameter is the default.

Yes
         The IBM Spectrum Protect server name and host server name is
         displayed in the title of the administrative client command
         window.

Examples

Options file:
         SETWINDOWTITLE YES

Command line:
         -setwindowtitle=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.154 Shmport


The shmport option specifies the TCP/IP port address of a server when
using shared memory. All shared memory communications start with a
TCP/IP connection.

Note: The value specified for the shmport option in the dsm.sys file
must match the value specified for shmport in the server options file.

Supported Clients

This option is valid for AIX, Linux, and Oracle Solaris clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

>>-SHMPort-- --port_number------------------------------------><



Parameters

port_number
         Specifies the port number. You can specify a value from 1000 to
         32767. The default value is 1510.

Examples

Options file:
         shmport 1580

Command line:
         Does not apply.


3.4.155 Showmembers


Use the showmembers option to display all members of a group.

You can use the showmembers option with the query group, and restore
group commands.

The showmembers option is not valid with the inactive option. If you
want to display members of a group that are not currently active, use
the pitdate and pittime options.

Supported Clients

This option is valid for all UNIX and Linux clients except Mac OS X.

Syntax

>>-SHOWMembers-------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         restore group /virtfs/* -pick -showmembers


3.4.156 Skipacl


The skipacl option allows you to include or exclude access control list
(ACL) data during a backup or archive operation; by default, ACL data is
included.

When this option is set to yes, the backup-archive client does not
include ACL data when it backs up or archives files and directories. The
default is no, which enables the ACL data to be included when objects
are copied to the server. You should only set the skipacl to yes when
ACLs are not defined on the file system, or when you are certain that
you do not need the ACL data when the files are retrieved or restored.

Supported Clients

This option is valid for all UNIX and Linux clients. On Linux and AIX
systems, setting skipacl to yes also omits the extended attributes.

Options File

Place this option in the client user options (dsm.opt) file.

Syntax

            .-No--.
>>-SKIPACL--+-----+--------------------------------------------><
            '-Yes-'



Parameters

No
         If you specify No, the ACL data is backed up. This is the
         default.

Yes
         If you specify Yes, the ACL data is not backed up, and
         consequently, it cannot be restored. skipacl=yes overrides
         skipaclupdatecheck settings.

Examples

Options file:
         skipacl yes


3.4.157 Skipaclupdatecheck


The skipaclupdatecheck option disables checksum and size comparisons of
ACL data.

When set to yes (default is no), the backup-archive client will not
perform checksum and size comparisons before or after backup and during
incremental processing (ACL checksum from previous backup and current
ACL) to detect ACL updates. However, current ACL data is backed up if
the file is selected for backup due to other reasons. If only ACLs are
updated on a file, the next incremental backup will not recognize this
ACL update, and the file is not backed up.

Supported Clients

This option is valid for all UNIX and Linux clients.

Options File

Place this option in the client user options (dsm.opt) file.

Syntax

                       .-No--.
>>-SKIPACLUPdatecheck--+-----+---------------------------------><
                       '-Yes-'



Parameters

No
         If you specify No, the client performs checksum and size
         comparisons of the ACL data, before and after backup and during
         incremental processing. This is the default.

Yes
         If you specify Yes, the client does not perform checksum and
         size comparisons of the ACL data.

Examples

Options file:
         skipaclup yes


3.4.158 Snapdiff


Using the snapdiff (snapshot difference) option with the incremental
command streamlines the incremental backup process. The command runs an
incremental backup of the files that were reported as changed by NetApp
instead of scanning all of the volume for changed files.

The snapdiff option is for backing up NAS/N-Series file server volumes
that are NFS attached.

You must configure a user ID and password on the backup-archive client
to enable snapshot difference processing.

Use this option with an incremental backup of a NAS file server volume,
instead of a simple incremental backup or an incremental backup with the
snapshotroot option, whenever the NAS file server is running ONTAP
7.3.0, or later. Do not use the snapdiff and snapshotroot options
together.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

The first time that you run an incremental backup with the snapshot
difference option, a snapshot is created (the base snapshot) and a
traditional incremental backup is run by using this snapshot as the
source. The name of the snapshot that is created is recorded in the IBM
Spectrum Protect server database. The initial incremental backup must
complete without failure in order for the next backup operation to use
snapshot difference processing.

The second time an incremental backup is run with this option, a newer
snapshot is either created, or an existing one is used (depending on the
value set for the diffsnapshot option) to find the differences between
these two snapshots. The second snapshot is called the diffsnapshot, or
differences snapshot. The client then incrementally backs up the files
that are reported as changed, by NetApp, to the IBM Spectrum Protect
server. The file system that you select for snapshot difference
processing must be mounted to the root of the volume. You cannot use the
snapdiff option for any file system that is not mounted to the root of
the volume. After you backed up the data with the snapdiff option, the
snapshot that was used as the base snapshot is deleted from the snapshot
directory.

On Linux systems, the snapshot directory is in .snapshot.

The client does not delete any snapshots that it did not create.

When a snapshot-differential-incremental backup operation completes, the
client ensures that only the most recently-registered base snapshot
persists on the filer volume. All snapshots that are created by a
snapshot-differential-incremental backup on the backup-archive client
begin with the characters "TSM_". If you use a snapshot tool other than
the backup-archive client to produce snapshots, ensure that you do not
use the string "TSM_" at the beginning of the snapshot name. If the
snapshot names begin with "TSM_", the files are deleted when the client
initiates the next snapshot-differential-incremental backup operation.

To run a snapshot-differential-incremental backup of read-only NetApp
filer volumes, the useexistingbase option must be specified to prevent
an attempt to create a snapshot on the read-only volume. Also, specify
the name of the base snapshot to use (basesnapshotname option) and the
name of the differential snapshot to use (diffsnapshotname option).

For NAS and N-Series file servers that are running ONTAP 7.3.0, or
later, you can use the createnewbase option to back up any files that
were skipped because of one of the following reasons:

*  A file is excluded because the include-exclude file has an exclude
   rule in effect. A file is excluded when you did not change the
   include-exclude file, but you removed the rule that excluded the
   file. The NetApp API detects file changes only between two snapshots,
   not changes to the include-exclude file.

*  If you added an include statement to the option file, that include
   option does not take effect unless NetApp detects that the file
   changes occurred. The client does not inspect each file on the volume
   during backup.

*  You used the dsmc delete backup command to explicitly delete a file
   from the IBM Spectrum Protect server inventory. NetApp does not
   detect that a file was manually deleted from the server. Therefore,
   the file remains unprotected in IBM Spectrum Protect storage until it
   is changed on the volume and the change is detected by NetApp,
   signaling the client to back it up again.

*  Policy changes such as changing the policy from mode=modified to
   mode=absolute are not detected.

*  The entire file space is deleted from the IBM Spectrum Protect
   inventory. This action causes the snapshot difference option to
   create a snapshot to use as the source, and runs a full incremental
   backup.

*  A file is excluded from backup because the file name contains a
   character that is not in the 7 bit-ASCII character set. The
   createnewbase option creates a base snapshot and uses it as a source
   to run a full incremental backup. NetApp controls what constitutes a
   changed object.

Tip: You can use the snapdiffhttps option to run
snapshot-differential-incremental backups of NetApp filers with a secure
HTTPS connection. To successfully run snapshot-differential-incremental
backups, previous releases of the backup-archive client required HTTP
administrative access to be enabled on the NetApp filer. With the
snapdiffhttps option, you can establish a secure administrative session
with the NetApp filer regardless of whether HTTP administrative access
is enabled on the filer.

Snapshot differential backup operations are not supported in the IBM
Spectrum Protect for Virtual Environments environment. You cannot run
snapshot differential backup operations of a file system that resides on
a NetApp filer on a host where the Data Protection for VMware or Data
Protection for Microsoft Hyper-V data mover is also installed.

In the list of options that are used by the traditional incremental
command, the last column shows the interaction of each option with the
snapdiff option. The following information describes the definitions of
valid, not valid, and no effect:

Valid
         Processing runs normally when the option is used.

Not valid
         If the option is used with the snapdiff option, an error
         message is generated.

No effect
         The option can be used, but it is ignored.

Table 46. Incremental command: Related options

+----------------------------------+----------------------+-----------+
| Option                           | Where specified      | With      |
|                                  |                      | snapdiff  |
+----------------------------------+----------------------+-----------+
| asnodename                       | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| automount                        | Client options file  | No effect |
|                                  | (dsm.opt).           |           |
+----------------------------------+----------------------+-----------+
| basesnapshotname                 | Client options file  | Valid     |
|                                  | (dsm.opt) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| changingretries                  | Client system        | No effect |
|                                  | options file         |           |
|                                  | (dsm.sys) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| compressalways                   | Client options file  | Valid     |
|                                  | (dsm.opt) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| compression                      | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys) within a   |           |
|                                  | server stanza, or    |           |
|                                  | command line.        |           |
+----------------------------------+----------------------+-----------+
| createnewbase                    | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| diffsnapshot                     | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| diffsnapshotname                 | Client options file  | Valid     |
|                                  | (dsm.opt) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| dirsonly                         | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| domain                           | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys), client    |           |
|                                  | user-options file    |           |
|                                  | (dsm.opt), or        |           |
|                                  | command line.        |           |
+----------------------------------+----------------------+-----------+
| efsdecrypt                       | Client system        | No effect |
|                                  | options file         |           |
|                                  | (dsm.sys), client    |           |
|                                  | user-options file    |           |
|                                  | (dsm.opt), or        |           |
|                                  | command line.        |           |
+----------------------------------+----------------------+-----------+
| enablelanfree                    | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| encryptiontype                   | system-options file  | Valid     |
|                                  | (dsm.sys) within a   |           |
|                                  | server stanza.       |           |
+----------------------------------+----------------------+-----------+
| encryptkey                       | System-options file  | Valid     |
|                                  | (dsm.sys) within a   |           |
|                                  | server stanza.       |           |
+----------------------------------+----------------------+-----------+
| exclude.fs.nas                   | Client system        | No effect |
|                                  | options file         |           |
|                                  | (dsm.sys).           |           |
+----------------------------------+----------------------+-----------+
| filelist                         | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| filesonly                        | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| followsymboliclink               | Client options file  | No effect |
|                                  | (dsm.opt).           |           |
+----------------------------------+----------------------+-----------+
| include.fs.nas                   | Client system        | No effect |
|                                  | options file         |           |
|                                  | (dsm.sys) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| inclexcl                         | Client system        | Valid,    |
|                                  | options file         | but only  |
|                                  | (dsm.sys).           | when a    |
|                                  |                      | file      |
|                                  |                      | change is |
|                                  |                      | detected  |
|                                  |                      | by        |
|                                  |                      | NetApp.   |
+----------------------------------+----------------------+-----------+
| incrbydate                       | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| memoryefficientbackup            | This option is       | No effect |
|                                  | allowed in both      |           |
|                                  | dsm.sys and dsm.opt, |           |
|                                  | but the value in     |           |
|                                  | dsm.opt is ignored   |           |
|                                  | if it is also in     |           |
|                                  | dsm.sys. You can     |           |
|                                  | also place this      |           |
|                                  | option within a      |           |
|                                  | server stanza, or on |           |
|                                  | the initial command  |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| monitor                          | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| nojournal                        | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| postsnapshotcmd                  | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys) or with    |           |
|                                  | the include.fs       |           |
|                                  | option.              |           |
+----------------------------------+----------------------+-----------+
| preservelastaccessdate           | Client user-options  | Valid     |
|                                  | file (dsm.opt) or    |           |
|                                  | command line.        |           |
+----------------------------------+----------------------+-----------+
| presnapshotcmd                   | Client system        | Valid     |
|                                  | options file         |           |
|                                  | (dsm.sys) or with    |           |
|                                  | the include.fs       |           |
|                                  | option.              |           |
+----------------------------------+----------------------+-----------+
| removeoperandlimit               | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| skipaclupdatecheck               | Client options file  | Valid     |
|                                  | (dsm.opt).           |           |
+----------------------------------+----------------------+-----------+
| snapdiffhttps                    | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| snapshotcachesize                | Client system        | No effect |
|                                  | options file         |           |
|                                  | (dsm.sys) or with    |           |
|                                  | the include.fs       |           |
|                                  | option.              |           |
+----------------------------------+----------------------+-----------+
| snapshotproviderfs               | System-options file  | Not valid |
|                                  | (dsm.sys) within a   |           |
|                                  | server stanza or     |           |
|                                  | with the include.fs  |           |
|                                  | option.              |           |
+----------------------------------+----------------------+-----------+
| snapshotproviderimage            | Client system        | Not valid |
|                                  | options file         |           |
|                                  | (dsm.sys) or with    |           |
|                                  | the include.image    |           |
|                                  | option.              |           |
+----------------------------------+----------------------+-----------+
| snapshotroot                     | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| subdir                           | Client options file  | Not valid |
|                                  | (dsm.opt) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| tapeprompt                       | Client options file  | Valid     |
|                                  | (dsm.opt) or command |           |
|                                  | line.                |           |
+----------------------------------+----------------------+-----------+
| toc                              | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| useexistingbase                  | Command line only.   | Valid     |
+----------------------------------+----------------------+-----------+
| virtualfsname                    | Command line only.   | Not valid |
+----------------------------------+----------------------+-----------+
| virtualmountpoint                | Client system        | Not valid |
|                                  | options file         |           |
|                                  | (dsm.sys).           |           |
+----------------------------------+----------------------+-----------+

Supported Clients

This option is valid for Linux x86_64 clients.

Syntax

>>-SNAPDiff----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         Perform a snapshot-differential-incremental backup of an NFS
         mounted file system /vol/vol1 hosted on the file server
         homestore.example.com, where /net/home1 is the mount point of
         /vol/vol1.
         incremental -snapdiff -diffsnapshot=latest /net/home1

Command line:
         Run a one-time full incremental backup after detecting that the
         NetApp server has migrated to a unicode-enabled file server
         from a server that did not support unicode file names.

         dsmc incremental -snapdiff -createnewbase=migrate /net/home1
         Run a snapshot-differential-incremental backup after detecting
         that the NetApp server has migrated to a unicode-enabled file
         server from a server that did not support unicode file names.
         This command suppresses the warning message.

         dsmc incremental -snapdiff -createnewbase=ign /net/home1
         Perform a full incremental backup because you made some include
         or exclude changes:

         dsmc incremental -snapdiff -createnewbase=yes /net/home1


3.4.159 Snapdiffchangelogdir


The snapdiffchangelogdir option defines the location where the client
stores persistent change logs that are used for snapshot differential
backup operations.

Important: If you previously used snapshot differential backups with a
backup-archive client that is older than version 8.1.2, the first
snapshot differential backup that you run with the version 8.1.2 or
later client will be a full progressive incremental backup. To avoid
this full progressive incremental backup, move the existing change log
files from the old location specified by the stagingdirectory option to
the new location specified by the snapdiffchangelogdir option before you
run the first snapshot differential backup.

For example, run the following copy command:

cp -R /tmp/TSM/TsmSnapDiff /opt/tivoli/tsm/client/ba/TsmSnapDiff

The change log files have the following naming patterns:

.../TSM/TsmSnapDiff/.TsmSnapdiffChangeLogs/NetAppFiler/
SnapdiffChangeLog__VolumeName__.tsmDB
.../TSM/TsmSnapDiff/.TsmSnapdiffChangeLogs/NetAppFiler/
SnapdiffChangeLog__VolumeName__.tsmDB.Lock

where:

*  NetAppFiler is the host name or IP address of the storage virtual
   machine (SVM) from the cluster management server or the 7-mode file
   server.

*  VolumeName is the volume that you want to protect.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option is valid for Linux x86_64 clients. This option can also be
defined on the server.

Options File

Place this option in the client options file (dsm.opt). When
snapdiffchangelogdir is specified on the command line, it overrides the
values that are specified in the options file. You can set this option
on the General tab of the Preferences editor.

Syntax

>>-SNAPDIFFCHANGELOGDir--path----------------------------------><



Parameters

path
         Specifies the directory path where the client stores persistent
         change logs for snapshot differential backup operations. If you
         do not specify the snapdiffchangelogdir option, the client uses
         the directory where the client is installed. The default
         installation directory is:

         /opt/tivoli/tsm/client/ba
         The exact name of the change log file is in the following
         format:

         snapdiff_change_log_dir/TsmSnapDiff/.TsmSnapdiffChangeLogs/NetAppFiler/
         SnapdiffChangeLog__VolumeName__.tsmDB

         where:

         *  snapdiff_change_log_dir is the name of the directory for
            storing the snapshot differential change logs, as specified
            by the snapdiffchangelogdir option.

         *  NetAppFiler is the host name or IP address of the storage
            virtual machine (SVM) from the cluster management server or
            the 7-mode file server.

         *  VolumeName is the volume that you want to protect.
         A lock file is also created to prevent the change log file from
         being updated by different snapshot differential backups that
         are running at the same time.

Examples

Options file:
         snapdiffchangelogdir /tmp/tsmdata

Command line:
         -snapdiffchangelogd=/tmp/tsmdata


3.4.160 Snapdiffhttps


Specify the snapdiffhttps option to use a secure HTTPS connection for
communicating with a NetApp filer during a snapshot differential backup.

When you specify this option, the backup-archive client can establish a
secure administrative session with the NetApp filer regardless of
whether HTTP administrative access is enabled on the NetApp filer.

Important: The default communication protocol that the backup-archive
client uses to establish the administrative session with the NetApp
filer is HTTP. To use a secure HTTPS connection, you must specify the
snapdiffhttps option whenever you run a snapshot differential backup.

Restrictions:

The following restrictions apply to snapshot differential backups with
HTTPS:

*  The HTTPS connection is used only to securely transmit data over the
   administrative session between the backup-archive client and the
   NetApp filer. The administrative session data includes information
   such as filer credentials, snapshot information, and file names and
   attributes that are generated by the snapshot differencing process.
   The HTTPS connection is not used to transmit normal file data that is
   accessed on the filer by the client through file sharing. The HTTPS
   connection also does not apply to normal file data transmitted by the
   client to the IBM Spectrum Protect server through the normal IBM
   Spectrum Protect client/server protocol.

*  The snapdiffhttps option does not apply to vFilers because the HTTPS
   protocol is not supported on the NetApp vFiler.

*  The snapdiffhttps option is available only by using the command-line
   interface. It is not available for use with the backup-archive client
   GUI.

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option is valid for Linux x86_64 clients.

Options File

This option is valid only on the command-line interface. You cannot
enter it in a client options file.

Syntax

>>-SNAPDIFFHTTPS-----------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         Issue the following command on a Linux system, with an NFS
         mounted file system /vol/vol1 hosted on the file server
         homestore.example.com, where /net/home1 is the mount point of
         /vol/vol1.

         dsmc incr /net/home1 -snapdiff -snapdiffhttps


3.4.161 Snapshotcachesize


Use the snapshotcachesize option to specify an appropriate size to
create the snapshot.

The size estimation is needed for storing the original data blocks for
modified and deleted data for the point in time when the snapshot was
taken.

For snapshot-based file backup or archive, use the snapshotcachesize
option with the include.fs option, or in the server stanza in the
dsm.sys file.

For snapshot-based image backups, use the snapshotcachesize option with
the backup image command, the include.image option, or in your dsm.sys
file.

Supported Clients

This option is valid for AIX and Linux clients only. The IBM Spectrum
Protect API does not support this option. The server can also define
this option.

Options File

Place this option in the server stanza in the dsm.sys file. You can set
this option on the Image-Snapshot tab of the Preferences editor.

Syntax

>>-SNAPSHOTCACHESize-- --size---------------------------------><



Parameters

size
         Specifies an appropriate size to create the snapshot for
         storing the original data blocks for modified and deleted data
         for the point in time when the snapshot was taken. The value is
         the percent of the file system size that is changed due to file
         system activity. The range of values is 1 to 100 percent. For
         AIX JFS2 and Linux the default value is 100 percent of the file
         system size. If a sufficient amount of free space is not
         available to create the snapshot, the command fails with an
         error message. You can then either increase the size of the
         volume group or retry the operation. If based on your
         experience with your AIX JFS2 file system activity, you find
         that a snapshot size of 100 percent is not necessary, you can
         fine-tune the value.

Examples

Options file:
         snapshotcachesize 95
         AIX only: include.fs /kalafs1
           snapshotproviderfs=JFS2 snapshotcachesize=95

         AIX only: include.image /kalafs2
           snapshotcachesize=95

         Linux only: include.image /linuxfs1
           snapshotcachesize=100

Command line:
         -snapshotcachesize=95


3.4.162 Snapshotproviderfs


Use the snapshotproviderfs option to enable snapshot-based file backup
and archive operations, and to specify a snapshot provider.

You must be a root user to perform a snapshot-based file backup or
archive operation. If you are not a root user, the operation fails with
an error message.

Supported Clients

This option is valid for AIX clients only. The IBM Spectrum Protect API
does not support this option. The server can also define this option.

Options File

Specify this option in the server stanza of the system-options file,
dsm.sys, to enable snapshots for all JFS2 file systems on the client.
You can override the client-wide option for a specific operation by
specifying this option on the command line for the backup and archive
commands. You can also override the client-wide option for a specific
file system by using the include.fs statement in the dsm.sys file. You
can also set this option using the Preferences editor.

Syntax

>>-SNAPSHOTPROVIDERFs-- --value-------------------------------><



Parameters

value
         Specifies one of the following values:

JFS2
         Specifies that you want to perform a snapshot-based file backup
         or archive while the file system is available to other system
         applications. Valid for JFS2 file systems on AIX clients only.

NONE
         Specifies that no snapshots should be used. A file backup or
         archive operation is performed using the specified file system.
         This is the default.

Examples

Options file:
         snapshotproviderfs JFS2
         include.fs   /kalafs1   snapshotproviderfs=JFS

Command line:
         -SNAPSHOTPROVIDERFs=JFS2


3.4.163 Snapshotproviderimage


Use the snapshotproviderimage option to enable snapshot-based image
backup, and to specify a snapshot provider.

You must be a root user to perform a snapshot-based image backup
operation. If you are not a root user, the operation fails with an error
message.

Supported Clients

This option is valid for AIX and Linux clients only. The IBM Spectrum
Protect API does not support this option. The server can also define
this option.

Options File

Specify this option in the server stanza of the system-options file,
dsm.sys, to enable snapshots for all the file systems on the client. You
can override the client-wide option for a specific operation by
specifying this option on the command line for the backup image command.
You can also override the client-wide option for a specific file system
using the include.image statement in the dsm.sys file. You can also set
this option using the Preferences editor.

Syntax

>>-SNAPSHOTPROVIDERImage-- --value----------------------------><



Parameters

value
         Specifies one of the following values:

JFS2
         Specifies that you want to perform a snapshot-based image
         backup while the file system is available to other system
         applications. This is the default for JFS2 file systems. Valid
         for AIX clients only.

LINUX_LVM
         Specifies that you want to perform a snapshot-based image
         backup while the file system is available to other system
         applications. This is the default for file systems residing on
         logical volumes created by the Linux Logical Volume Manager.
         Valid for Linux clients only.

NONE
         Specifies that you do not want to perform a snapshot-based
         image backup operation. This performs a static image backup
         operation using the specified file system. This is the default
         for file systems other than AIX JFS2 and Linux LVM.

Examples

Options file:
         snapshotprovideri JFS2
         include.image   /kalafs1   snapshotprovideri=JFS2

Command line:
         -SNAPSHOTPROVIDERImage=NONE


3.4.164 Snapshotroot


Use the snapshotroot option with the incremental, selective, or archive
commands with an independent software vendor application that provides a
snapshot of a logical volume, to associate the data on the local
snapshot with the real file space data that is stored on the IBM
Spectrum Protect server.

The snapshotroot option can be used to back up NFS mounted file systems.
Both the backup specification (source) and the snapshotroot value can be
an NFS mounted file specification. For example, the snapshotroot option
can be used to backup an NFS file system that is hosted on a
network-attached storage (NAS) that supports snapshot.

This option should be used with an incremental backup of a NAS file
server volume instead of a simple incremental or incremental with
snapshotroot option whenever the NAS file server is running ONTAP V7.3
for performance reasons. The snapdiff and snapshotroot options should
not be used together.

In the following example, filesystem test495 is NFS-mounted from a NAS
file server philo and /philo/test945/.snapshot/backupsnap represents the
snapshot that is created at the NAS file server.

  dsmc i /philo/test945 -snapshotroot=philo/test945
    /.snapshot/backupsnap

You can also specify a directory with the snapshotroot option when you
backup each file set as a separate file space.

The snapshotroot option does not provide any facilities to take a volume
snapshot, only to manage data that is created by a volume snapshot.

For example, consider an application that takes a snapshot of the /usr
file system and mounts it as /snapshot/day1. If you back up this data by
using the following command, a unique file space that is called
/snapshot/day1 is created on the server.

   dsmc incremental /snapshot/day1

However, you might want to associate the snapshot data with the data
already processed for the /usr file system. Using the snapshotroot
option, you can associate the data with the file space corresponding to
the /usr file system on the IBM Spectrum Protect server:

   dsmc incremental /usr -snapshotroot=/snapshot/day1

On a subsequent day, you can back up a snapshot that was written to an
alternative location, but managed under the same file space on the
server:

   dsmc incremental /usr -snapshotroot=/snapshot/day2



You can perform incremental backups, selective backups, or archives of a
single directory, directory structure, or single file by using the
snapshotroot option. In all instances, the snapshotroot option must
identify the root of the logical volume that was created by the
snapshot. For example:

   dsmc incremental /usr/dir1/* -subdir=yes
     -snapshotroot=/snapshot/day1
   dsmc selective /usr/dir1/sub1/file.txt
     -snapshotroot=/snapshot/day1
   dsmc archive /usr/dir1/sub1/*.txt
     -snapshotroot=/snapshot/day1



If you want to include or exclude specific file specifications, the
include and exclude statements should contain the name of the file
system that was the source of the snapshot (the /usr file system), and
not the name of the target of the snapshot (/snapshot/day1). Doing this
allows you to preserve a set of include and exclude statements
regardless of the name of the logical volume to which the snapshot is
written. The following are examples of include and exclude statements.

  include /usr/dir1/*.txt 1yrmgmtclass
  exclude /usr/mydocs/*.txt

The following include-exclude statements are not valid because they
contain the name of the snapshot:

  include /snapshot/day1/dir1/*.txt 1yrmgmtclass
  exclude /snapshot/day1/mydocs/*.txt



You must use the snapshotroot option with a single file specification
for an incremental, selective, or archive operation. You cannot specify
multiple file specifications or no file specifications. For example,
these commands are valid:

  dsmc incremental /usr -snapshotroot=/snapshot/day1
  dsmc incremental /usr/dir1/* -snapshotroot=/snapshot/day1

The following command is invalid because it contains two file
specifications:

  dsmc incremental /usr/dir1/* /home/dir2/*
    -snapshotroot=/snapshot/day1



The following command is invalid because it contains no file
specification:

  dsmc incremental -snapshotroot=/snapshot/day1



Notes:

1. Ensure that the snapshotroot option references a snapshot of the
   correct volume. Ensure that snapshotroot location refers to the root
   of the snapshot. If these rules are not followed, unintended results,
   such as files that expire incorrectly, can result.

2. If you specify the filelist option and the snapshotroot option, all
   files that are specified in the filelist option are assumed to be in
   the same file system. If there are entries in the filelist in a
   different file system, they are skipped and an error is logged. If
   the filelist contains files that were created in the file system
   after the snapshot was taken, these entries are also skipped, and an
   error is logged.

3. You cannot use the snapshotroot option with the snapdiff option.

4. You can use the snapshotroot option with the preschedulecmd and
   postschedulecmd options, or in an automated script that you run with
   the client scheduler.

Supported Clients

This option is valid for the following clients:

*  UNIX and Linux clients except Mac OS X.



Syntax

>>-SNAPSHOTRoot = -- --snapshot_volume_name-------------------><



Parameters

snapshot_volume_name
         Specifies the root of the logical volume that is created by the
         independent software vendor snapshot application.

Examples

Command line:
         dsmc incremental /usr -SNAPSHOTRoot=/snapshot/day1


3.4.165 Srvoptsetencryptiondisabled


The srvoptsetencryptiondisabled option allows the client to ignore
encryption options in a client options set from the IBM Spectrum Protect
server.

If the option is set to yes in the client options file, the client
ignores the following options in a client options set from the server:

*  encryptkey

   Note: The client ignores only the encryptkey generate option setting.
   Other possible encryptkey option settings, for example, encryptkey
   prompt or encryptkey save are not ignored.

*  encryptiontype

*  exclude.encrypt

*  include.encrypt

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the client options file (dsm.sys) within a server
stanza.

Syntax

                                .-no--.
>>-SRVOPTSETENCryptiondisabled--+-----+------------------------><
                                '-yes-'



Parameters

yes
         The backup-archive client ignores the values of the listed
         encryption options in a client options set from the IBM
         Spectrum Protect server.

no
         The backup-archive client processes the setting of the listed
         encryption options in a client options set from the IBM
         Spectrum Protect server. This is the default.

Examples

Options file:
         srvoptsetencryptiondisabled no

Command line:
         Does not apply.


3.4.166 Srvprepostscheddisabled


The srvprepostscheddisabled option specifies whether to prevent the
pre-schedule and post-schedule commands specified by the IBM Spectrum
Protect administrator from executing on the client system, when
performing scheduled operations.

The srvprepostscheddisabled option can be used in conjunction with the
schedcmddisabled and srvprepostscheddisabled options to disable the
execution of any unwanted operating system command by the IBM Spectrum
Protect administrator on a client node.

Supported Clients

This option is valid for all backup-archive clients that use the IBM
Spectrum Protect client scheduler. The server cannot define this option.

Options File

Place this option in the dsm.sys file within a server stanza for the
scheduler. You can set this option on the Scheduler tab of the
Preferences editor, in the Schedule Command section.

Syntax

                            .-No--.
>>-SRVPREPOSTSCHeddisabled--+-----+----------------------------><
                            '-Yes-'



Parameters

No
         Specifies that the client allows pre-schedule and post-schedule
         commands defined by the IBM Spectrum Protect administrator to
         execute on the client system, when performing scheduled
         operations. If a pre-schedule or a post-schedule command is
         defined by both the client and the IBM Spectrum Protect
         administrator, the command defined by the administrator
         overrides the corresponding command defined in the client
         option file. This is the default.

Yes
         Specifies that the client prevents pre-schedule and
         post-schedule commands defined by the IBM Spectrum Protect
         administrator to execute on the client system, when performing
         scheduled operations. If a pre-schedule or a post-schedule
         command is defined by both the client and the IBM Spectrum
         Protect administrator, the command defined by the administrator
         will not override the corresponding command defined in the
         client option file. This option can be used in conjunction with
         the schedcmddisabled and srvprepostscheddisabled options.

Examples

Options file:
         srvprepostscheddisabled yes

Command line:
         Does not apply.


3.4.167 Srvprepostsnapdisabled


The srvprepostsnapdisabled option specifies whether to prevent the
pre-snapshot and post-snapshot commands specified by the IBM Spectrum
Protect administrator from executing on the client system, when
performing scheduled image snapshot backup operations.

The srvprepostsnapdisabled option can be used in conjunction with the
schedcmddisabled and srvprepostsnapdisabled options to disable the
execution of any unwanted operating system command by the IBM Spectrum
Protect administrator on a client node.

Supported Clients

This option is valid for Linux clients that support the image snapshot
backup command. The server cannot define this option. The IBM Spectrum
Protect API does not support this option.

Options File

Place this option in the dsm.sys file within a server stanza for the
scheduler. You can set this option on the Snapshot tab of the
Preferences editor, in the Snapshot Options section.

Syntax

                           .-No--.
>>-SRVPREPOSTSNApdisabled--+-----+-----------------------------><
                           '-Yes-'



Parameters

No
         Specifies that client allows pre-snapshot and post-snapshot
         commands defined by the IBM Spectrum Protect administrator to
         execute on the client system, when performing scheduled image
         snapshot backup operations. If a pre-snapshot or a
         post-snapshot command is defined by both the client and the IBM
         Spectrum Protect administrator, the command defined by the
         administrator overrides the corresponding command defined in
         the client option file. This is the default.

Yes
         Specifies that the client does not allow pre-snapshot and
         post-snapshot commands defined by the IBM Spectrum Protect
         administrator to execute on the client system, when performing
         scheduled image snapshot backup operations. If a pre-snapshot
         or a post-snapshot command is defined by both the client and
         the IBM Spectrum Protect administrator, the command defined by
         the administrator will not override the corresponding command
         defined in the client option file. This option can be used in
         conjunction with the schedcmddisabled and
         srvprepostsnapdisabled options.

Examples

Options file:
         srvprepostsnapdisabled yes

Command line:
         Does not apply.


3.4.168 Ssl


Use the ssl option to enable Secure Sockets Layer (SSL) to provide
secure client and server communications. When the backup-archive client
communicates with an IBM Spectrum Protect server 8.1.1 and earlier
version 8 levels, and version 7.1.7 and earlier levels, it determines
whether SSL is enabled. When the backup-archive client communicates with
an IBM Spectrum Protect server 8.1.2 and later version levels, and
version 7.1.8 and later version 7 levels, SSL is always used and this
option controls whether object data is encrypted or not. For performance
reasons, it might be desirable to not encrypt the object data.



Supported Clients

This option is valid for all supported clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can also set this option on the Communication tab of
the Preferences editor.

Syntax

        .-No--.
>>-SSL--+-----+------------------------------------------------><
        '-Yes-'



Parameters for communicating with an IBM Spectrum Protect server 8.1.1
and earlier version 8 levels, and version 7.1.7 and earlier levels.

No
         Specifies that the backup-archive client does not use SSL to
         encrypt information. No is the default.

Yes
         Specifies that the backup-archive client uses SSL to encrypt
         information.

         To enable SSL, specify SSL Yes and change the value of the
         TCPPORT option. Changing the value of the TCPPORT option is
         generally necessary because the IBM Spectrum Protect server is
         typically set up to listen for SSL connections on a separate
         port.

Parameters for communicating with an IBM Spectrum Protect server version
8.1.2 and later levels, and version 7.1.8 and later version 7 levels.

No
         Specifies that the backup-archive client does not use SSL to
         encrypt object data when communicating with the server. All
         other information is encrypted. No is the default.

Yes
         Specifies that the backup-archive client uses SSL to encrypt
         all information, including object data, when communicating with
         the server.

         To use SSL for all data, specify SSL Yes.

Examples

Options file:
         ssl yes

Command line:
         Does not apply.


3.4.169 Sslacceptcertfromserv


Use the sslacceptcertfromserv option to control whether the
backup-archive client or the API application accept and trust the IBM
Spectrum Protect server's Secure Sockets Layer (SSL) public certificate
the first time they connect. This option applies only the first time
that the backup-archive client or the API application connects to the
IBM Spectrum Protect server. When the SSL public certificate is
accepted, future changes to the certificate are not automatically
accepted, and must be manually imported to the backup-archive client.
You can use this option to connect only to an IBM Spectrum Protect
server version 8.1.2 and later levels, and version 7.1.8 and later
version 7 levels.



Supported Clients

This option is valid for all supported clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                          .-Yes-.
>>-SSLACCEPTCERTFROMSERV--+-----+------------------------------><
                          '-No--'



Parameters

Yes
         Specifies that the backup-archive client does automatically
         accept the IBM Spectrum Protect server's public certificate.
         Yes is the default.

No
         Specifies that the backup-archive client does not automatically
         accept the IBM Spectrum Protect server's public certificate.

         To disable SSLACCEPTCERTFROMSERV, specify sslacceptcertfromserv
         no.



Examples

Options file:
         sslacceptcertfromserv no

Command line:
         Does not apply.


3.4.170 Ssldisablelegacytls


Use the ssldisablelegacytls option to disallow the use of SSL protocols
that are lower than TLS 1.2.



Supported Clients

This option is valid for all supported clients.

Options File

Place this option in the dsm.sys file. You can also set this option in
the GUI by selecting the Require TLS 1.2 or above check box on the
Communication tab of the Preferences editor. You cannot set this option
on the command line.

Syntax

                        .-No--.
>>-SSLDISABLELEGACYtls--+-----+--------------------------------><
                        '-Yes-'



Parameters

No
         Specifies that the backup-archive client does not require TLS
         1.2 for SSL sessions. It allows connection at TLS 1.1 and lower
         SSL protocols. When the backup-archive client communicates with
         an IBM Spectrum Protect server version 8.1.1 and later levels,
         and version 7.1.7 and later version 7 levels, No is the
         default.

Yes
         Specifies that the backup-archive client requires that all SSL
         sessions use TLS 1.2 (or higher) protocol. When the
         backup-archive client communicates with an IBM Spectrum Protect
         server version 8.1.2 and later levels, and version 7.1.8 and
         later version 7 levels, Yes is the default.

Examples

Options file:
         ssldisablelegacytls yes

Command line:
         Does not apply.


3.4.171 Sslfipsmode


The sslfipsmode option specifies whether the client uses SSL Federal
Information Processing Standards (FIPS) mode for Secure Sockets Layer
(SSL) communications with the server. The default is no.



Supported clients

This option is supported on all clients.

Options File

Set this option in the client options file. You cannot specify it as a
command-line parameter and you cannot set this option in a client
options set.

Syntax

                   .-No--.
>>-SSLFIPSMODE = --+-----+-------------------------------------><
                   '-Yes-'



Parameters

No
         Specifies that the client does not use SSL FIPS mode for secure
         communications with the server. SSL in FIPS mode is supported
         only by version 6.3 and newer versions of the server. Set this
         client option to no if the client uses SSL to connect to a
         server that is not at V6.3, or newer.

Yes
         Specifies that the client uses SSL FIPS mode for secure
         communications with the server. Setting this option to yes
         restricts SSL session negotiation to use only FIPS-approved
         cipher suites. SSL FIPS mode is only supported by the V6.3 (or
         newer) server.

Example

To enable SSL FIPS mode on the client:

SSLFIPSMODE yes


3.4.172 Sslrequired


The sslrequired option specifies the conditions when SSL is or is not
required when the client logs on to the IBM Spectrum Protect server or
storage agents. To actually enable SSL so client-to-server and
client-to-storage-agent communications are secure, you must set the
client ssl option to yes. When communicating with the IBM Spectrum
Protect server 8.1.2 and later levels, and version 7.1.8 and later
version 7 levels, this option no longer applies since SSL is always
used.



Supported Clients

This option is supported on all clients.

Options File

Place this option in the client options file or in the GUI, on the
Communications tab. You cannot set this option on the command line.

Syntax

               .-Default----.
>>-SSLREQuired-+------------+----------------------------------><
               +-Yes--------+
               +-No---------+
               '-SERVERonly-'



Parameters

Default
         This setting indicates that SSL is required to secure
         communications between the client and server, and client and
         storage agents, if AUTHENTICATION=LDAP is set on the server. To
         secure communications by using SSL, you must also set ssl=yes
         on the client.
         If AUTHENTICATION=LOCAL is set on the server, this setting
         indicates that SSL is not required. Even though SSL is not
         required when AUTHENTICATION=LOCAL and sslrequired=default, you
         can still use SSL by setting the client ssl option to yes.

Yes
         Indicates that SSL is always required to secure communications
         between the client and server, and between the client and
         storage agents. sslrequired=yes has no dependency on the server
         AUTHENTICATION option. If you set sslrequired=yes on the
         client, you must also set ssl=yes on the client.

No
         Indicates that you do not require SSL to be used to secure
         communications between the client and server or between the
         client and storage agents. Choose this option only if you use a
         virtual private network or other method to secure your session
         communications. You can still enable SSL by setting ssl=yes on
         the client; but sslrequired=no specifies that SSL is not a
         prerequisite.

SERVERonly
         Indicates that SSL is required for client-to-server
         communications and not for server-to-storage agent
         communications. To use SSL for client to server communications,
         set sslrequired=serveronly and ssl=yes. The server setting for
         the AUTHENTICATION option can be either LOCAL or LDAP.
         For client to storage agent communications, use the client
         lanfreessl option to enable SSL.

The following table describes the situations under which authentication
succeeds or fails, depending on the settings of the SSLREQUIRED option
on the server, and client, and the setting of the ssl option on the
client. The table results assume that valid credentials are supplied.

Table 47. Effects of server and client SSL settings on success or
failure of login attempts



+-------------+-------------+-------------+---------------------------+
| SSLREQUIRED | sslrequired | ssl option  | Authentication success or |
| option      | option      |             | failure                   |
|             |             | (client     |                           |
| (server     | (client     | setting)    |                           |
| setting)    | setting)    |             |                           |
+-------------+-------------+-------------+---------------------------+
| Yes         | Yes         | Yes         | Authentication succeeds   |
+-------------+-------------+-------------+---------------------------+
| Yes         | Yes         |  No         | Authentication fails; the |
|             |             |             | client rejects the        |
|             |             |             | session                   |
+-------------+-------------+-------------+---------------------------+
| Yes         | No          | Yes         | Authentication succeeds   |
+-------------+-------------+-------------+---------------------------+
| Yes         | No          | No          | Authentication fails; the |
|             |             |             | server rejects the        |
|             |             |             | session                   |
+-------------+-------------+-------------+---------------------------+
| No          | Yes         | Yes         | Authentication succeeds   |
+-------------+-------------+-------------+---------------------------+
| No          | Yes         | No          | Authentication fails; the |
|             |             |             | client rejects the        |
|             |             |             | session                   |
+-------------+-------------+-------------+---------------------------+
| No          | No          | Yes         | Authentication succeeds   |
+-------------+-------------+-------------+---------------------------+
| No          | No          | No          | Authentication succeeds   |
+-------------+-------------+-------------+---------------------------+

The following text describes how setting SSLREQUIRED=DEFAULT and
SSLREQUIRED=SERVERONLY on the server affects the ssl option on the
client.

If the server sets SSLREQUIRED=DEFAULT and AUTHENTICATION=LDAP, the
client must set ssl=yes or authentication fails.

If the server sets SSLREQUIRED=DEFAULT and AUTHENTICATION=LOCAL, the
client can set ssl=yes or ssl=no.

If the server sets SSLREQUIRED=SERVERONLY, you must set ssl=yes on the
client. The client lanfreessl option can be set to yes, to secure
communications with a storage agent, or to no if secure communications
with storage agents is not needed.

Examples

Options file:
         sslrequired yes
         sslrequired no
         sslrequired default
         sslrequired serveronly

Command line:
         Not applicable; you cannot set this option on the command line.


3.4.173 Stagingdirectory


The stagingdirectory option defines the location where the client stores
any data that it generates to perform its operations. The data is
deleted when processing is complete.

Important: Starting with version 8.1.2, the snapdiffchangelogdir option
is used to specify the location to store change logs for snapshot
differential backup operations. The stagingdirectory option is no longer
used for this purpose. For more information, see 3.4.159
Snapdiffchangelogdir.

Supported Clients

This option is valid for Linux clients. The server can also define this
option.

Options File

Place this option in the client options file (dsm.opt). When
stagingdirectory is specified on the command line, it overrides the
values that are specified in the options file.

Syntax

>>-STAGINGDIRectory--path--------------------------------------><



Parameters

path
         Specifies the directory path where the client writes staging
         data. If you do not specify a staging directory, the client
         stores temporary data in the temporary file system (typically
         /tmp).

Examples

Options file:
         stagingdirectory /usr/tsmdata
         stagingdirectory /private/tmp

Command line:
         -stagingdir="/tmp/tsmtempdata"


3.4.174 Subdir


The subdir option specifies whether you want to include subdirectories
of named directories for processing.

You can use the subdir option with the following commands:

*  archive
*  delete archive
*  delete backup
*  incremental
*  query archive
*  query backup
*  restore
*  restore backupset
*  restore group
*  retrieve
*  selective

If you set the subdir option to yes when backing up a specific path and
file, the backup-archive client recursively searches all of the
subdirectories under that path, and looks for any instances of the
specified file that exist under any of those subdirectories. For
example, assume that a file called myfile.txt exists on a client in the
following directories:

//myfile.txt
/dir1/myfile.txt
/dir1/dir_a/myfile.txt
/dir1/dir_b/myfile.txt

Performing a selective backup of that file, as follows, backs up all
four instances of myfile.txt:

dsmc sel /myfile.txt -subdir=yes

Similarly, the following command displays all instances of myfile.txt if
you specify subdir=yes in the client options file or in a client options
set.

dsmc restore /myfile.txt -pick

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client user-options file (dsm.opt).

Syntax

           .-No--.
>>-SUbdir--+-----+---------------------------------------------><
           '-Yes-'



Parameters

No
         Subdirectories are not processed. This is the default.

Yes
         Subdirectories are processed. Because the client program
         searches all subdirectories of a directory that is being
         processed, processing can take longer to complete. Specify Yes
         only when necessary.

         If you use the preservepath option in addition to subdir=yes,
         it can affect which subdirectories are processed.



         If a subdirectory is a mounted file system, it is not processed
         even if you specify subdir=yes.

Note:

1. When you run the client in interactive mode, and if you use the
   -subdir=yes option, the setting persists for all commands entered in
   interactive mode, until you end interactive mode, by typing Quit.
2. If subdir=yes is in effect when you restore multiple files, place a
   directory delimeter character at the end of the destination file
   specification. If the delimeter is omitted, the client displays a
   message indicating that the destination file specification is not
   valid.
3. It is a best practice to include only the default value for subdir
   (No) in a client options file or a client options set.

Examples

Options file:
         subdir no

Command line:
         To restore the structure:

         /Users/mike/dir1
         /Users/mike/dir1/file1
         /Users/mike/dir1/dir2
         /Users/mike/dir1/dir2/file1

         enter any of the following commands:

         dsmc rest "/Users/van/dir1/*" /Users/mike/ -su=yes
         dsmc rest "/Users/van/dir1/file*" /Users/mike/ -su=yes
         dsmc rest "/Users/van/dir1/file1*" /Users/mike/ -su=yes

         To restore the structure:

         /path2/dir1
         /path2/dir1/file1
         /path2/dir1/dir2
         /path2/dir1/dir2/file1

         enter any of the following commands:

         dsmc rest "/path/dir1/*" /path2/ -su=yes
         dsmc rest "/path/dir1/file*" /path2/ -su=yes
         dsmc rest "/path/dir1/file1*" /path2/ -su=yes

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.


3.4.175 Tagschedule


Use the -tagschedule option to back up or rebalance VMs.

W you can back up or rebalance VMs that are assigned to, or are
associated with, a schedule and data mover with specified vSphere Web
Client GUI and VMware tags. You can use the -tagschedule option with the
backup VM command in two scenarios:

*  To run an ad hoc backup operation. For example, you can rerun or
   preview a scheduled backup operation.

*  To rebalance the data movers on a tagged schedule. You can use the
   -VMREBALANCESCHEDULEONLY option to rebalance the data movers on an ad
   hoc basis and the -VMREBALANCESCHEDULEPERIOD option to rebalance the
   data movers on a regular basis.

The -tagschedule option works only with tag-based schedule names.

Supported Clients

This option is valid on Windows and Linux data movers.

Options File

Use the -tagschedule option on the command line. You can also use the
options file to schedule periodic rebalancing operations.

Related reference
UPDATE SCHEDULE (Update a client schedule)


3.4.175.1 Using the tagschedule option for ad hoc backup operations


If a scheduled backup operation fails, you can use the -tagschedule
option to run a backup on all VMs that are associated with that
schedule.

When you run a backup operation with the -tagschedule option, the backup
vm command generates a list of VMs to back up. The list includes VMs for
which:

*  The VM Schedule (IBM Spectrum Protect) tag value matches what was
   passed in via the -tagschedule option.

*  The VM Data Mover (IBM Spectrum Protect) tag value matches the data
   mover node name.

If both match, then that VM is selected for backup. You can also see
which VMs are selected by using the -preview option.

If, for example, SCHEDULE1 ran overnight but failed, you can issue a
dsmc backup vm -tagschedule=SCHEDULE1 command for a given data mover.
That data mover then uses the string SCHEDULE1 to filter the VM
inventory and select the VMs that have a Schedule (IBM Spectrum Protect)
tag value of SCHEDULE1.

The selected VMs are also filtered to include only VMs with a Data Mover
(IBM Spectrum Protect) tag value matching the node name of the data
mover in use. The backup also includes any VMs that do not have a data
mover tag assigned if the data mover being used is designated as the
default data mover. A data mover is designated as default either with
the -vmtagdefaultdatamover option specified in the opt file or passed on
the command line.

Run the backup vm command on all data movers associated with a schedule
if you want to include all VMs associated with that schedule. Ensure
that at least one of these data movers is run as the default data mover.
It is not always necessary to use the default data mover option. A
schedule created by the VE GUI always sets a default. But if you run the
backup vm command ad hoc, the default value will not be set unless it is
explicitly specified in the data mover -optfile. By default, the
configuration wizard sets the first added data mover as the default
TAGschedule data mover.

Tip: The query results in the Schedule table in the Monitor Schedule
panel will not reflect that a tagged schedule has run. However, the
individual VM status will indicate that a backup operation occurred.

The entire SCHEDULE1 schedule is not rerun; only the machines with the
Data Mover (IBM Spectrum Protect) tag set to the schedule name passed in
are backed up. You must run a separate command on the other data movers
to back up the VMs that are assigned to those data movers.

Syntax

>>-TAGSCHEDule=--schedule_name--+-----------+------------------->
                                '- -preview-'

>-- -ASNODENAME=--datacenter_name------------------------------->

>-- -OPTFILE=--datamover_option_file_name----------------------><



Parameters

-preview
         Specify this parameter to preview the listing that will be
         obtained when the command is run with the specified filter.

-schedule_name
         Specify the schedule name to run the listing that will be
         obtained when the schedule is run with the specified filter.

-ASNODENAME
         Use this parameter in the options file to specify the name of
         the data center.

-OPTFILE
         Use this parameter to specify the name of the options file.

Examples of backup scenarios

Command line:
         dsmc backup vm -OPTFILE=dsm.MM1_DATACENTER1_DM1.opt
         -ASNODE=MM1_DATACENTER1 -tagschedule=SCHEDULE1

         Backs up all VMs with schedule tag SCHEDULE1.

Command line:
         dsmc backup vm -OPTFILE=dsm.MM1_DATACENTER1_DM1.opt
         -ASNODE=MM1_DATACENTER1 -tagschedule='DAILY_5AM' -preview

         Lists the VMs that qualify for backup operations using the VMs
         that contain DAILY_5AM as their value for the Schedule (IBM
         Spectrum Protect) tag, and targeting the node MM1_DATACENTER1
         for data mover MM1_DATACENTER1_DM1.

Related reference
UPDATE SCHEDULE (Update a client schedule)


3.4.175.2 Using the tagschedule option to rebalance scheduled operations


To optimize a tagged schedule operation, you can balance tagged
schedules according to the size (total storage occupied) of the VMs in
the selected schedule. By rebalancing tagged schedules, you reset which
data mover processes each VM that is backed up by the schedule.

The vSphere Web client plug-in assigns data movers to VMs as they are
added to a schedule. To rebalance tagged schedules by using the GUI, you
must edit the schedule and ensure that the check box for rebalancing the
schedule is selected upon saving. VMs are added to schedules by other
means. For example, new VMs are also assigned data movers after the
first backup by the default data mover. You may want to periodically
issue a full rebalance. The advantage of rebalancing tag schedules is
that backups are distributed evenly across storage resources. This can
be done with the vSphere Web client plug-in or by using the data mover
command-line interface.

Re-balance operations are rarely necessary. VMs are balanced when they
are added to a schedule and new VMs are also assigned balanced data
movers. A full rebalance operation might be required when a significant
number of VMs are deleted or moved. Use the VMREBALANCESCHEDULEONLY
option when you need to rebalance all data movers and VMs associated
with a schedule.

To automate rebalance operations, a VMREBALANCESCHEDULEPERIOD option can
be manually added as a parameter on the schedule option string, or in
the options file. Although you can place the option in the default data
mover's option file, it is preferable to add the option to the OPTion
string of the schedule. In this way, you can avoid ambiguity if one data
mover services multiple schedules.

Specify the VMREBALANCESCHEDULEPERIOD option only if the schedule has
multiple data movers assigned. The option will be used only by the
default data mover. A default data mover is assigned when adding data
movers to a schedule. The schedule is rebalanced after the number of
days specified by the VMREBALANCESCHEDULEPERIOD option and only after
the schedule has completed its current backup operation.

Syntax

>>-TAGSCHEDule=--schedule_name-- -VMREBALANCESCHEDULEONLY------->

>-- -ASNODENAME=--datacenter_name------------------------------->

>-- -OPTFILE=--datamover_option_file_name----------------------><



Parameters

-VMREBALANCESCHEDULEONLY
         Use this parameter to balance data movers in tag schedules
         according to the size of the VM. Data movers are assigned to
         the VMs by size, with the largest VM being assigned to the
         first data mover on the list, the next largest VM assigned to
         the next data mover, and so on. Existing data mover assignments
         are overwritten by reassigning the data mover tag on each VM.

-VMREBALANCESCHEDULEPERIOD
         Use this parameter in the options file to specify the time (in
         days) between rebalancing operations by the client. You can
         specify a value in the range 0 to 365. If you specify 0, which
         is the default, rebalancing never occurs. If you specify 365,
         rebalancing occurs about once a year. The scheduled rebalance
         operation is run on the default data mover.

-ASNODENAME
         Use this parameter to specify the name of the data center.

-OPTFILE
         Use this parameter to specify the name of the options file.

Examples

Command line:
         dsmc backup vm -OPTFILE=dsm.MM1_DATACENTER1_DM1.opt
         -tagschedule=VMWARE01 -vmrebalancescheduleonly
         -asnodename=MY_DATACENTER_NODE

         Rebalances the schedule named VMWARE01, which targets the node
         MY_DATACENTER_NODE. After the rebalance operation, VMs that
         were asymmetrically assigned across data movers are now
         symmetrically assigned. VMs that were unassigned to data movers
         are now assigned.

The following output shows before and after scenarios for a rebalance
operation for schedule named vmware_sxf1_cldev:


dsmc backup vm -tagschedule=vmware_sxf1_cldev -vmrebalancescheduleonly -asnode=sxf1_cldev
Node Name: DEFENDER1
Accessing as node: SXF1_CLDEV
ANS4313I Rebalance Schedule VMWARE_SXF1_CLDEV Type: Full

Before Rebalance
----------------
   Data Mover Name               : DEFENDER1
   Total Bytes Protected         : 432.16 GB
   Virtual Machines Protected    : 10

   Data Mover Name               : SXF1_CLDEV_DM
   Total Bytes Protected         : 116.04 GB
   Virtual Machines Protected    : 3

   Virtual Machines not assigned : 1

After Rebalance
----------------
   Data Mover Name               : DEFENDER1
   Total Bytes Protected         : 332.08 GB
   Virtual Machines Protected    : 7

   Data Mover Name               : SXF1_CLDEV_DM
   Total Bytes Protected         : 316.12 GB
   Virtual Machines Protected    : 7

   Virtual Machines not assigned : 0

The rebalance output information is recorded in the schedule log and
logged to the server activity log.

UPDate SCHedule domain_name schedule_name OPTions="-vmfulltype=vstor
-vmbackuptype=fullvm -asnodename=sxf1_cldev -mode=IFIncremental
-domain.vmfull=SCHEDULE-TAG -vmtagdefaultdatamover=DEFENDER1
-vmrebalancescheduleperiod=1"

Specifies that the default data mover rebalances the schedule every day.

Related reference
UPDATE SCHEDULE (Update a client schedule)


3.4.176 Tapeprompt


The tapeprompt option specifies whether you want the backup-archive
client to wait for a tape mount if it is required for a backup, archive,
restore, or retrieve process, or to be prompted for a choice.

In the backup-archive client GUI, the Media Mount dialog can display the
Information Not Available value in the Device and Volume Label fields if
you perform a standard (also known as classic) restore or retrieve
operation. This value means that this information is only available for
no-query restore or retrieve operations; not a standard restore or
retrieve operation. The Device field displays the name of the device on
which to mount the media needed to process an object. The Volume Label
field displays the name of the volume needed to process an object.

Tape prompting does not occur during a scheduled operation regardless of
the setting for the tapeprompt option.

The tapeprompt option can be used with the following commands:

*  archive
*  delete archive
*  delete backup
*  incremental
*  restore
*  retrieve
*  selective

Note: The server can also define this option.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the General tab, Prompt before mounting tapes check box
of the Preferences editor.

Syntax

               .-No--.
>>-TAPEPrompt--+-----+-----------------------------------------><
               '-Yes-'



Parameters

No
         You are not prompted for your choice. The server waits for the
         appropriate tape to mount. This is the default.

         Note: For API applications, this permits backup directly to
         tape.

Yes
         You are prompted when a tape is required to back up, archive,
         restore, or retrieve data. At the prompt, you can wait for the
         appropriate tape to be mounted, always wait for a tape to be
         mounted, skip a particular object, skip all objects on a single
         tape, skip all objects on all tapes, or cancel the entire
         operation.

Examples

Options file:
         tapeprompt yes

Command line:
         -tapep=yes

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.177 Tcpadminport


Use the tcpadminport option to specify a separate TCP/IP port number on
which the server waits for requests for administrative client sessions,
allowing secure administrative sessions within a private network.

The client tcpadminport setting depends on how the IBM Spectrum Protect
server tcpadminport and adminonclientport options are configured. The
server has a tcpadminport setting that indicates on which port the
server listens for administrative sessions, and the adminonclientport
setting, which can be either yes or no.

If tcpadminport is not set on the server, then administrative sessions
are allowed on the same port as client sessions.

If tcpadminport is set on the server, then administrative sessions are
allowed on the port specified by that setting. In this case, if
adminonclientport yes is in effect, then administrative sessions can
connect on either the regular client port or the port specified by
tcpadminport. If adminonclientport no is in effect, then administrative
sessions can connect only on the port specified by tcpadminport.

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Communication tab, in the Admin Port field in the
Preferences editor.

Syntax

>>-TCPADMINPort--+- -----------------+------------------------><
                 '-admin_port_address-'



Parameters

admin_port_address
         Specifies the port number of the server. The default value is
         the value of the tcpport option.

Examples

Options file:
         tcpadminport 1502


3.4.178 Tcpbuffsize


The tcpbuffsize option specifies the size of the internal TCP/IP
communication buffer used to transfer data between the client node and
server. Although it uses more memory, a larger buffer can improve
communication performance.



Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, in the
Buffer Size field in the Preferences editor.

Syntax

>>-TCPBuffsize-- --size---------------------------------------><



Parameters

size
         Specifies the size, in kilobytes, that you want to use for the
         internal TCP/IP communication buffer. The range of values is 1
         through 512; the default is 32.

         Depending on the operating system communication settings, your
         system might not accept all values in the range of 1 through
         512.

Examples

Options file:
         tcpb 32

Command line:
         -tcpbuffsize=32

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.179 Tcpcadaddress


The tcpcadaddress option specifies a TCP/IP address for dsmcad.
Normally, this option is not needed. Use this option only if your client
node has more than one TCP/IP address, or if TCP/IP is not the default
communication method.



Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the dsm.sys file within a server stanza.

Syntax

>>-TCPCADAddress-- --cad_address------------------------------><



Parameters

cad_address
         Specifies a TCP/IP Internet domain name or a numeric IP
         address. If you specify an IPv6 addresses, you must specify the
         commmethod V6Tcpip option.

Examples

Options file:
         tcpcada dsmclnt.example.com

Command line:
         -tcpcadaddress=192.0.2.0

         -tcpcadaddress=mycompany.example.com

         -tcpcadaddress=2001:0DB8:0:0:0:0:0:0

This option is valid only on the initial command line of the dsmcad
program. It is not valid with other dsm modules.


3.4.180 Tcpclientaddress


The tcpclientaddress option specifies a TCP/IP address if your client
node has more than one address, and you want the server to contact an
address other than the one that was used to make the first server
contact.

The server uses this address when it begins the server prompted
scheduled operation.

Use this option only if you use the prompted parameter with the
schedmode option.

If sessioninitiation is set to serveronly, the value for the
tcpclientaddress client option should be the same as the value for the
HLAddress server setting.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Scheduler tab, Your TCP/IP address field of the
Preferences editor.

Syntax

>>-TCPCLIENTAddress-- --client_address------------------------><



Parameters

client_address
         Specifies the TCP/IP address you want the server to use to
         contact your client node. Specify a TCP/IP Internet domain name
         or a numeric IP address. The numeric IP address can be either a
         TCP/IPv4 or TCP/IPv6 address. You can only use IPv6 addresses
         if you specified the commmethod V6Tcpip option.

Examples

Options file:
         tcpclienta dsmclnt.example.com
         or
         tcplienta 192.0.2.21

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.181 Tcpclientport


The tcpclientport option specifies a TCP/IP port number for the server
to contact the client when the server begins the server prompted
scheduled operation.

Use this option only if you specify the prompted parameter with the
schedmode option.

If sessioninitiation is set to serveronly, the value for the
tcpclientport client option should be the same as the value for the
LLAddress server option.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File

Place this option in the dsm.sys file within a server stanza. You can
set this option on the Scheduler tab, in the Your TCP/IP port field in
the Preferences editor.

Syntax

>>-TCPCLIENTPort-- --client_port_address----------------------><



Parameters

client_port_address
         Specifies the TCP/IP port address you want the server to use to
         contact your client node. The range of values is 1 through
         32767; the default is 1501.

Examples

Options file:
         tcpclientp 1502

Command line:
         -tcpclientport=1492

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.182 Tcpnodelay


The tcpnodelay option specifies whether the client disables the delay of
sending successive small packets on the network, per transaction.

Change the value from the default of yes only under one of the following
conditions:

*  You are directed to change the option by IBM technical support.

*  You fully understand the effects of the TCP Nagle algorithm on
   network transmissions. Setting the option to no enables the Nagle
   algorithm, which delays sending small successive packets.

Supported Clients

This option is valid for all UNIX and Linux clientst.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab in the
Preferences editor. Select Send transaction to the server immediately.

Syntax

               .-Yes-.
>>-TCPNodelay--+-----+-----------------------------------------><
               '-No--'



Parameters

No
         Specifies that the server does not allow successive small
         packets to be sent immediately over the network. Setting this
         option to no can degrade performance.

Yes
         Specifies that the server or client allows successive small
         packets to be sent immediately over the network. The default is
         yes.

Examples

Options file:
         tcpnodelay yes

Command line:
         Does not apply.


3.4.183 Tcpport


The tcpport option specifies a TCP/IP port address for the IBM Spectrum
Protect server. You can obtain this address from your administrator.



Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, in the
Server Port field in the Preferences editor.

Syntax

>>-TCPPort-- --port_address-----------------------------------><



Parameters

port_address
         Specifies the TCP/IP port address that is used to communicate
         with a server. The range of values is 1 through 32767; the
         default is 1500.

Examples

Options file:
         tcpp 1501

Command line:
         Does not apply.


3.4.184 Tcpserveraddress


The tcpserveraddress option specifies the TCP/IP address for the IBM
Spectrum Protect server. You can obtain this server address from your
administrator.



Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, in the
Server Address field in the Preferences editor.

If this option is not specified, the client attempts to contact a server
running on the same computer as the backup-archive client.

Syntax

>>-TCPServeraddress-- --server_address------------------------><



Parameters

server_address
         Specifies a 1 to 64 character TCP/IP address for a server.
         Specify a TCP/IP domain name or a numeric IP address. The
         numeric IP address can be either a TCP/IP v4 or TCP/IP v6
         address. You can only use IPv6 addresses if you specified the
         commmethod V6Tcpip option.

Examples

Options file:
         tcps dsmchost.example.com

Command line:
         Does not apply.


3.4.185 Tcpwindowsize


Use the tcpwindowsize option to specify, in kilobytes, the size you want
to use for the TCP/IP sliding window for your client node.

The sending host cannot send more data until it receives an
acknowledgment and a TCP receive window update. Each TCP packet contains
the advertised TCP receive window on the connection. A larger window
allows the sender to continue sending data and can improve communication
performance.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the Communication tab, Window
Size field of the Preferences editor.

Syntax

>>-TCPWindowsize-- --window_size------------------------------><



Parameters

window_size
         Specifies the size, in kilobytes, to use for your client node
         TCP/IP sliding window. The range of values is 0 through 2048. A
         value of 0 allows the client to use the operating system
         default TCP window size. Values from 1 to 2048 indicate that
         the window size is in the range of 1KB to 2MB. If you specify a
         value less than 1, the TCP window size defaults to 1. If you
         specify a value greater than 2048, the TCP window size defaults
         to 2048.
         For backup-archive clients, the default value for this
         parameter is 63 KB on AIX and Solaris, and 0, the OS default,
         on the other platforms Linux and Mac.
         For IBM Spectrum Protect for Virtual Environments: Data
         Protection for VMware, the default value for this parameter is
         512 KB on Linux.
         Notes:

         *  The TCP window acts as a buffer on the network. It is not
            related to the tcpbuffsize option, or to the send and
            receive buffers allocated in client or server memory.

         *  A window size larger than the buffer space on the network
            adapter might degrade throughput due to resending packets
            that were lost on the adapter.

         *  Depending on the operating system communication settings,
            your system might not accept all values in the range of
            values.

         *  The tcpwindowsize option overrides the operating system's
            default TCP/IP session send and receive window sizes.

Examples

Options file:
         tcpwindowsize 63

Command line:
         -tcpw=63

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.186 Timeformat


The timeformat option specifies the format in which you want to display
and enter system time.

By default, the backup-archive and administrative clients obtain format
information from the locale definition in effect at the time the client
is called. Consult the documentation on your local system for details
about setting up your locale definition.

Note: The timeformat option does not affect the web client. The web
client uses the time format for the locale that the browser is running
in. If the browser is not running in a locale that the client supports,
the web client uses the time format for US English.

You can use the timeformat option with the following commands:

*  delete archive
*  delete backup
*  expire
*  query archive
*  query backup
*  query filespace
*  query image
*  query nas
*  restore
*  restore image
*  restore nas
*  retrieve
*  set event

When you include the timeformat option with a command, it must precede
the fromtime, pittime, and totime options.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Regional Settings tab, Time Format field of the
Preferences editor.

Syntax

>>-TIMEformat-- --format_number-------------------------------><



Parameters

format_number
         Displays time in one of the formats listed here. Select the
         format number that corresponds to the format you want to use.
         When you include the timeformat option in a command, it must
         precede the fromtime, pittime, and totime options.

         0
                  Use the locale-defined time format (does not apply to
                  Mac OS X). This value is the default if the
                  locale-specified format consists of digits, separator
                  characters, and, if applicable, the AM or PM string.

         1
                  23:00:00

                  This is the default if the locale-specified format
                  does not consist of digits, separator characters, and,
                  if applicable, the AM or PM string.

         2
                  23,00,00

         3
                  23.00.00

         4
                  12:00:00 A/P

         5
                  A/P 12:00:00



Examples

Options file:
         timeformat 4

Command line:
         -time=3

This option is valid on the initial command line and in interactive
mode. If you use this option in interactive mode, it affects only the
command with which it is specified. When that command completes, the
value reverts to the value at the beginning of the interactive session.
This is the value from the dsm.opt file unless overridden by the initial
command line or by an option forced by the server.

Additional considerations for specifying time and date formats

The date or time format you specify with this option must be used when
using options that take date and time as input. Examples are: totime,
fromtime, todate, fromdate, and pittime.

For example, if you specify the timeformat option as TIMEFORMAT 4, the
value that you provide on the fromtime or totime option must be
specified as a time such as 12:24:00pm. Specifying 13:24:00 would not be
valid because TIMEFORMAT 4 requires an hour integer that is 12 or less.
If you want to specify up to 24 hour values on an option, and if you
want to use commas as separators, you must specify TIMEFORMAT 2.

Configuring date and time formats in the system locale configuration
file

You can specify date and time formats by configuring them in your
system’s locale file. If you specify time and date formats in the locale
file, they must be defined by using a subset of number-producing format
specifiers that are supported by the C language strftime() function. You
can use the following specifiers to set date and time formats in
configuration settings for your locale.

Date specifiers
         *  %Y - the year, in four digits. For example, 2011.

         *  %y - the year, last two digits only. For example, 11 not
            2011.

         *  %m - the month, as a decimal number (1-12).

         *  %d - the day of the month (1-31).

         In the date specifiers, you can specify only one year
         specifier. Do not specify both %Y and %y. The E modifier (a
         capital E) can precede the date specifiers to produce the
         locale's alternative form for the year, month, or day. If no
         alternative form exists, the E modifier is ignored. Separate
         the specifiers with a single 7-bit ASCII character. Commonly
         used separators include colons (:), commas (,), periods (.),
         hyphens (-), or forward slash (/) characters. Do not use
         multibyte characters as separators.

Time specifiers
         *  %H - the hour, in 24-hour form (00-23).

         *  %I - the hour, in 12-hour form (00-12).

         *  %M - minutes after the hour (00-59).

         *  %S - seconds after the minute (00-59)

         *  %p - adds the AM (before noon) or PM (after noon) indicator.

         In the time specifiers, you can specify only one hour
         specifier. Do not specify both %I and %H.

         The O modifier (a capital O) can precede the time specifiers to
         produce the locale's alternative form for the hour, minutes, or
         seconds. The O modifier cannot precede the %p specifier.
         Separate the specifiers with a single 7-bit ASCII character.
         Commonly used separators include colons (:), commas (,), or
         periods (.). Do not use multibyte characters as separators. Do
         not specify a separator between the %p specifier and the
         separator that precedes or follows it.

Time format examples, configured in the locale settings
         To set a particular time format, edit the configuration file
         for your locale and modify the t_fmt line to support your
         needs. Whatever time format you select applies both to output
         and to input. After the locale configuration file has been
         edited, the localedef command must be run to create the final
         locale file.

         Table 48. Sample time format settings in the locale
         configuration (t_fmt line)

+-----------------------------+---------------------------------------+
| Example                     | Result                                |
+-----------------------------+---------------------------------------+
| "%H:%M:%S"                  | Displays time in the form hh:mm:ss    |
|                             | with hh ranging from 0 through 23.    |
+-----------------------------+---------------------------------------+
| "%H,%M,%S"                  | Displays time in the form hh,mm,ss    |
|                             | with hh ranging from 0 through 23.    |
+-----------------------------+---------------------------------------+
| "%I,%M,13p"                 | Displays time in the form hh,mm,ssA/P |
|                             | with hh ranging from 1 through 12 and |
|                             | A/P is the local abbreviation for     |
|                             | ante-meridian (AM in English) or      |
|                             | post-meridian (PM in English).        |
+-----------------------------+---------------------------------------+

Date format examples, configured in the locale settings
         To set a particular date format, edit the configuration file
         and modify the d_fmt line as needed to support your needs.
         Whatever date format you select applies both to output and to
         input.

         Table 49. Sample date format settings in the locale
         configuration (d_fmt line)

+-----------------------------+---------------------------------------+
| Example                     | Result                                |
+-----------------------------+---------------------------------------+
| "%m/%d/%y"                  | Displays the date in the form         |
|                             | MM/DD/YY.                             |
+-----------------------------+---------------------------------------+
| "%d.%m.%Y"                  | Displays the date in the form         |
|                             | DD.MM.YYYY.                           |
+-----------------------------+---------------------------------------+


3.4.187 Toc


Use the toc option with the backup nas command or the include.fs.nas
option to specify whether the backup-archive client saves table of
contents (TOC) information for each file system backup.

You should consider the following when deciding whether you want to save
TOC information:

*  If you save TOC information, you can use the QUERY TOC server command
   to determine the contents of a file system backup in conjunction with
   the RESTORE NODE server command to restore individual files or
   directory trees.

*  You can also use the Windows backup-archive client GUI to examine the
   entire file system tree and select files and directories to restore.

*  Creation of a TOC requires that you define the TOCDESTINATION
   attribute in the backup copy group for the management class to which
   this backup image is bound. Note that TOC creation requires
   additional processing, network resources, storage pool space, and
   possibly a mount point during the backup operation.

*  If you do not save TOC information, you can still restore individual
   files or directory trees using the RESTORE NODE server command,
   provided that you know the fully qualified name of each file or
   directory and the image in which that object was backed up.

Supported Clients

This option is only valid for AIX and Solaris clients. The IBM Spectrum
Protect API does not support this option.

Options File

Place the include.fs.nas statement containing the toc value in the
dsm.sys file within a server stanza.

Syntax

        .-Preferred-.
>>-TOC--+-----------+------------------------------------------><
        +-Yes-------+
        '-No--------'



Parameters

Yes
         Specifies that the client saves TOC information during a NAS
         file system image backup. However, the backup fails if an error
         occurs during creation of the TOC.

No
         Specifies that the client does not save TOC information during
         a NAS file system image backup.

Preferred
         Specifies that the client saves TOC information during a NAS
         file system image backup. The backup does not fail if an error
         occurs during creation of the TOC. This is the default.

Note: If the mode option is set to differential and you set the toc
option to preferred or yes, but the last full image does not have a TOC,
the client performs a full image backup and creates a TOC.

Examples

Options file:
         include.fs.nas netappsj/vol/vol0 homemgmtclass toc=yes

Command line:
         backup nas -nasnodename=netappsj /vol/vol0 -toc=yes


3.4.188 Todate


Use the todate option with the totime option to specify an ending date
and time to which you want to search for backups or archives during a
restore, retrieve, or query operation

Use the todate and totime options with the fromtime and fromdate options
to request a list of backed up or archived files within a period of
time. For example, you might request a list of files that were backed up
between 6:00 AM on July 1, 2002 and 11:59 PM on July 30, 2002.

Use the todate option with the following commands:

*  delete backup

*  query archive

*  query backup

*  restore

*  restore group

*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-TODate = -- --date-----------------------------------------><



Parameters

date
         Specifies an ending date. Enter the date in the format you
         selected with the dateformat option.

         When you include dateformat with a command, it must precede the
         fromdate, pitdate, and todate options.

Examples

Command line:
         dsmc restore "/Users/agordon/Documents/*" -todate=12/11/2003

Command line:
         dsmc restore "/home/user1/*" -todate=12/11/2003


3.4.189 Totime


Use the totime option with the todate option to specify an ending date
and time to which you want to search for backups or archives during a
restore, retrieve, or query operation. The backup-archive client ignores
this option if you do not specify the todate option.

Use the totime and todate options with the fromtime and fromdate options
to request a list of files that were backed up within a period of time.
For example, you might request a list of files that were backed up
between 6:00 AM on July 1, 2003 and 11:59 PM on July 30, 2003.

Use the totime option with the following commands:

*  delete backup

*  query archive

*  query backup

*  restore

*  restore group

*  retrieve

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-TOTime = -- --time-----------------------------------------><



Parameters

time
         Specifies an ending time. If you do not specify a time, the
         time defaults to 23:59:59. Specify the time in the format you
         selected with the timeformat option.

         When you include the timeformat option in a command, it must
         precede the fromtime, pittime, and totime options.

Examples

Command line:
         dsmc restore "/Users/van/Documents/myfiles/*"
         -todate=09/17/2003 -totime=23:00:00

Command line:
         dsmc restore "/home/user1/*" -todate=09/17/2003
         -totime=23:00:00


3.4.190 Txnbytelimit


The txnbytelimit option specifies the number of kilobytes the client
program buffers before it sends a transaction to the server.

A transaction is the unit of work exchanged between the client and
server. A transaction can contain more than one file or directory,
called a transaction group.

You can control the amount of data sent between the client and server,
before the server commits the data and changes to the server database,
using the txnbytelimit option. Controlling the amount of data sent
changes the speed of the client to perform the transactions. The amount
of data sent applies when files are batched together during backup or
when receiving files from the server during a restore procedure.

After the txngroupmax number is reached, the client sends the files to
the server, even if the transaction byte limit is not reached.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza. You can set this option on the General tab, in the
Transaction Buffer Size field in the Preferences editor.

Syntax

>>-TXNBytelimit-- --number------------------------------------><



Parameters

number
         Specifies the number of kilobytes the client program sends to
         the server before committing the transaction. The range of
         values is 300 through 34359738368 (32 GB). The default is 25600
         KB. The number can be specified as an integer or as an integer
         with one of the following unit qualifiers:

            K or k (kilobytes)
            M or m (megabytes)
            G or g (gigabytes)

         If no unit qualifier is specified, the integer is in kilobytes.

         Restriction: The txnbytelimit option does not support decimal
         numbers, and only one-unit letters are allowed. For example: K,
         M, or G.

Examples

Options file:
         txnb 25600
         txnb 2097152
         txnb 2097152k
         txnb 2048m
         txnb 2g
         txnb 32G

Command line:
         -txnb=25600
         -txnb=16G

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.191 Type


Use the type option with the query node command to specify the type of
node to query. Use this option with the set event command to activate,
hold, or release.

This option is also valid for the set password command with the TSM type
on AIX clients.

Supported Clients

This option is only valid for AIX and Solaris clients. The IBM Spectrum
Protect API does not support this option.

Syntax

            .-any----.
>>-TYpe = --+--------+-----------------------------------------><
            +-nas----+
            +-server-+
            '-client-'



Parameters

nas
         Specifies all NAS nodes registered at the server.

server
         Specifies client nodes that are other IBM Spectrum Protect
         servers.

client
         Specifies client nodes that are backup-archive clients.

Examples

Command line:
         query node -type=nas


3.4.192 Updatectime


Use the updatectime option to check the change time (ctime) attribute
during an incremental backup operation.



Supported Clients

This option is valid for AIX and Linux clients on GPFS file systems
only. The server can also define this option.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

                .-no--.
>>-UPDATECTime--+-----+----------------------------------------><
                '-yes-'



Parameters

no
         The backup-archive client does not check the change time (ctime
         attribute) during a backup operation. This value is the
         default.

yes
         The backup-archive client checks the change time (ctime
         attribute) during a backup operation. If the ctime attribute
         changed since the last backup operation, the ctime attribute is
         updated on the IBM Spectrum Protect server. The object is not
         backed up unless it has either ACLs or extended attributes. The
         client checks files and directories.

Examples

Options file:
         updatect yes

Command line:
         dsmc incr /proj/gpfs/test/ -updatectime=yes


3.4.193 Useexistingbase


The useexistingbase option is used when you back up snapshots that are
on NetApp filer volumes. The useexistingbase option indicates that the
latest snapshot that exists on the volume being backed up, is to be used
as the base snapshot, during a snapshot differential backup operation.

If this option is not specified, a new snapshot is created on the volume
that is being backed up. Because target filer volumes are read only
volumes, useexistingbase must be specified when performing snapshot
differential backups of target filer volumes. If useexistingbase is not
specified, snapshot differential backups of a target filer volume fail
because the new snapshot cannot be created on the read only volume.

When backing up target filer volumes, use both the useexistingbase
option and the diffsnapshot=latest option to ensure that the most recent
base and most recent differential snapshots are used during the volume
backup

Restriction: Snapshot difference incremental backups are not supported
if you upgrade to NetApp Data ONTAP 9.10.1 or later. For more
information, see technote 6449354.

Supported Clients

This option can be used with supported x86_64 Linux clients.

Options File

This option is only valid on the command line.

Syntax

>>-USEEXISTINGBase---------------------------------------------><



Parameters

This option has no parameters

Examples

Options file:
         Does not apply.

Command line:
         dsmc incr \\DRFiler\UserDataVol_Mirror_Share -snapdiff
           -useexistingbase -basenameshotname="nightly.?"


3.4.194 Usereplicationfailover


The usereplicationfailover option specifies whether automated client
failover occurs on a client node.

Use this option to enable a client node for failover or to prevent it
from failing over to the failover server. This option overrides the
configuration that is provided by the IBM Spectrum Protect server
administrator settings on the primary server.

Supported Clients

This option is valid for all clients.

Options File

Place this option within a server stanza in the dsm.sys file.

Syntax

                           .-Yes-.
>>-USEREPLICATIONFailover--+-----+-----------------------------><
                           '-No--'



Parameters

Yes
         Specifies that you want the client to be automatically
         redirected to a failover server if the primary server is
         unavailable. The client uses the configuration that is provided
         by the primary server to connect to a failover server. This
         value is the default.

No
         Specifies that the client is not automatically redirected to a
         failover server.

Examples

Options file:
         USEREPLICATIONFailover no

Command line:
         Does not apply.


3.4.195 Users (deprecated)


This option is deprecated.




3.4.196 V2archive


Use the v2archive option with the archive command to archive only files
to the server.

The backup-archive client will not process directories that exist in the
path of the source file specification.

This option differs from the filesonly option in that the filesonly
option archives the directories that exist in the path of the source
file specification.

The v2archive and dirsonly options are mutually exclusive and an error
message is displayed if you use both options in the same archive
command.

If you use this option, you might want to consider the following:

*  You might experience performance problems when retrieving large
   amounts of data archived with this option.

*  You might want to use this option only if you are concerned about
   expiration performance on a server that already contains extremely
   large amounts of archived data.

*  If there are multiple files with the same name for the v2archive
   option, the files are archived multiple times, with their directory
   structure. The v2archive option archives only the files.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Syntax

>>-V2archive---------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

This command:
         dsmc archive "/Users/user2/Documents/*" -v2archive -su=y.

         Archives these files:

         /Users/user2/Documents/file1
         /Users/user2/Documents/file2
         /Users/user2/Documents/file3
         /Users/user2/Documents/dir2/file4
         /Users/user2/Documents/dir2/file5


         Note: The client does not archive /Users/user2/Documents and
         /Users/user2/Documents/dir2.

This command:
         dsmc archive "/home/relx/dir1/*" -v2archive -su=y.

         Archives these files:

         /home/relx/dir1/file1
         /home/relx/dir1/file2
         /home/relx/dir1/file3
         /home/relx/dir1/dir2/file4
         /home/relx/dir1/dir2/file5


         Note: The client does not archive /home/relx/dir1 and
         /home/relx/dir1/dir2.


3.4.197 Verbose


The verbose option specifies that you want to display detailed
processing information on your screen. This is the default.

When you run the incremental, selective, or archive commands,
information is displayed about each file that is backed up. Use the
quiet option if you do not want to display this information.

The following behavior applies when using the verbose and quiet options:

*  If the server specifies either the quiet or verbose option in the
   server client option set, the server settings override the client
   values, even if force is set to no on the server.

*  If you specify quiet in your dsm.opt file, and you specify -verbose
   on the command line, -verbose prevails.

*  If you specify both -quiet and -verbose on the same command, the last
   option encountered during options processing prevails. If you specify
   -quiet -verbose, -verbose prevails. If you specify -verbose -quiet,
   -quiet prevails.

The information is displayed on your screen in the Scheduler Status
window. This option only applies when you are running the scheduler and
the client is performing scheduled work.

Supported Clients

This option is valid for all clients. The server can also define this
option. The IBM Spectrum Protect API does not support this option.

Options File

Place this option in the client user-options file (dsm.opt). You can set
this option on the Command Line tab, Do not display process information
on screen checkbox of the Preferences editor.

Syntax

>>-VErbose-----------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Options file:
         verbose

Command line:
         -verbose

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.198 Verifyimage


Use the verifyimage option with the restore image command to specify
that you want to enable detection of bad sectors on the destination
target volume.

If bad sectors are detected on the target volume, the backup-archive
client issues a warning message on the console and in the error log.

Supported Clients

This option is valid only for AIX, Oracle Solaris, and all Linux
clients. The IBM Spectrum Protect API does not support this option.

Syntax

>>-VERIFYImage-------------------------------------------------><



Parameters

There are no parameters for this option.

Examples

Command line:
         dsmc restore image /usr -verifyimage


3.4.199 Virtualfsname


Use the virtualfsname option with the backup group command to specify
the name of the virtual file space for the group on which you want to
perform the operation. The virtualfsname cannot be the same as an
existing file space name.



Supported Clients

This option is valid for all UNIX and Linux clients except for Mac OS X.

Syntax

>>-VIRTUALFsname = -- --fsname--------------------------------><



Parameters

fsname
         Specifies the name of the container for the group on which you
         want to perform the operation.

Examples

Command line:
         backup group -filelist=/Users/van/Documents/filelist1 -groupname=group1
         -virtualfsname=/virtfs -mode=full

         backup group -filelist=/home/dir1/filelist1 -groupname=group1
         -virtualfsname=/virtfs -mode=full


3.4.200 Virtualmountpoint


The virtualmountpoint option defines a virtual mount point for a file
system if you want to consider files for backup that begin with a
specific directory within that file system.

Using the virtualmountpoint option to identify a directory within a file
system provides a direct path to the files you want to back up, saving
processing time. It is more efficient to define a virtual mount point
within a file system than it is to define that file system using the
domain option, and then to use the exclude option in your
include-exclude options list to exclude the files that you do not want
to back up.

Use the virtualmountpoint option to define virtual mount points for
multiple file systems, for local and remote file systems, and to define
more than one virtual mount point within the same file system. Virtual
mount points cannot be used in a file system handled by automounter.

You can use the virtualmountpoint option to back up unsupported file
systems, with certain limitations. For information about using
virtualmountpoint with unsupported file systems, see the File system and
ACL support topic.

Note: If the directory that you want to specify as a virtual mount point
is a symbolic link, set the followsymbolic option to Yes. If that option
is set to no (the default), you are not permitted to use a symbolic link
as a virtual mount point. Also, if you back up a file system, then add a
virtual mount point, and then do another incremental on the file system,
the files and directories in the virtual mount point directory are
expired, because they are logically contained within the virtual mount
point directory and not the file system.

After you define a virtual mount point, you can specify the path and
directory name with the domain option in either the default client
options file or on the incremental command to include it for incremental
backup services. When you perform a backup or archive using the
virtualmountpoint option, the query filespace command lists the virtual
mount point in its response along with other file systems. Generally,
directories that you define as virtual mount points are treated as
actual file systems and require that the virtualmountpoint option is
specified in the dsm.sys file to restore or retrieve the data.

Note: When you specify a virtualmountpoint option, the path that it
specifies is added to the default backup domain (domain all-local). The
virtualmountpoint path is always considered a local "mount point"
regardless of the real file system type it points to.

Supported Clients

This option is valid for all UNIX clients except Mac OS X. The IBM
Spectrum Protect API does not support this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

   .- -------------------------------.
   V                                  |
>>---VIRTUALMountpoint-- --directory-+------------------------><



Parameters

directory
         Specifies the path and directory name for the directory you
         want to use as the virtual mount point for a file system. You
         cannot use wildcard characters in either the path or directory
         names.

         Define only one virtual mount point with each virtualmountpoint
         option that you include in your client system-options file. Use
         the virtualmountpoint option as many times as necessary to
         define all of the virtual mount points that you want to use.

Examples

Options file:
         virtualmountpoint /afs/xyzcorp.com/home/ellen
         virtualmountpoint /afs/xyzcorp.com/home/ellen/test/data

Command line:
         Does not apply.


3.4.201 Virtualnodename


The virtualnodename option specifies the node name of your workstation
when you want to restore or retrieve files to a different workstation.

When you use the virtualnodename option in your client options file, or
with a command:

*  You must specify the name you specified with the nodename option in
   your client system-options file (dsm.sys). This name should be
   different from the name returned by the hostname command on your
   workstation.

*  The client prompts for the password assigned to the node that you
   specify, if a password is required (even when the passwordaccess
   option is set to generate). If you enter the correct password, you
   have access to all backups and archives that originated from the
   specified node.

When connecting to a server, the client must identity itself to the
server. This login identification is determined in the following ways:

*  If the nodename and virtualnodename options are not specified, or a
   virtual node name is not specified on the command line, the default
   login ID is the name returned by the hostname command.

*  If the nodename option is specified, the name specified with the
   nodename option overrides the name returned by the hostname command.

*  If the virtualnodename option is specified, or a virtual node name is
   specified on a command line, it cannot be the same name as the name
   returned by the hostname command.

Supported Clients

This option is valid for all clients.

Options File

Place this option in the client user-options file (dsm.opt).

Syntax

>>-VIRTUALNodename-- --nodename-------------------------------><



Parameters

nodename
         Specifies a 1- to 64-character name that identifies the node
         for which you want to request IBM Spectrum Protect services.
         There is no default.

Examples

Options file:
         virtualnodename cougar

Command line:
         -virtualn=banshee

This option is valid only on the initial command line. It is not valid
in interactive mode.


3.4.202 Vmbackdir


The vmbackdir option specifies the temporary disk location where the
client saves control files that are created during full VM backup and
restore operations of virtual machines.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

When a client on a data mover node starts a full VM backup of a virtual
machine, the client creates metadata in files that are associated with
the backed up virtual machine and its data. The files that contain the
metadata are referred to as control files.

During full VM backup operations, the metadata is saved on a disk in the
data mover node until the backup completes and both the virtual machine
data and the control files are saved to server storage. During a full VM
restore operation, the control files are copied from the server and are
temporarily stored on the data mover disk, where they are used to
restore the virtual machine and its data. After a backup or a restore
operation completes, the control files are no longer needed and the
client deletes them from their temporary disk location.

The directory that is specified by this option must be on a drive that
contains sufficient free space to contain the control information from a
full VM backup.

Supported Data Movers

This option is valid for Linux and Windows data movers that are
installed on a vStorage backup server.

Options File

Set this option in the client options file, or specify it on the command
line as an option for the backup vm or restore vm commands.

Syntax

>>-VMBACKDir--directory----------------------------------------><



Parameters

directory
         Specifies the path where the control files are stored on the
         backup server.
         The default is /tmp/tsmvmbackup/fullvm/

Examples

Options file:
         VMBACKD /tmp/tmsvmbackup/

Command line:
         dsmc backup vm -VMBACKUPT=fullvm
         -VMBACKD=/home/vmware/control_files
         dsmc restore vm -VMBACKUPT=fullvm -VMBACKD=/home/mine/bkup_ctrl


3.4.203 Vmbackuplocation


Use the vmbackuplocation option with the backup vm or restore vm
commands to specify the backup location for virtual machine backup and
restore operations.

This option is only valid for VMware virtual machines. To use this
option, you must have a license agreement to use IBM Spectrum Protect
for Virtual Environments: Data Protection for VMware.

For restore operations, this option is ignored if the vmrestoretype
option is set to mountcleanup or mountcleanupall.

Supported Clients

This option can be used with supported x86_64 Linux clients.

Options file

This option must be specified on the command line of a backup vm or
restore vm command. You cannot set this option in the client options
file.

Syntax

                           .-SERVER-.
>>- -VMBACKUPLOCation-- --+-LOCAL--+--------------------------><
                           '-BOTH---'



Parameters

SERVER
         For backup operations, specifies that virtual machines are
         backed up to the IBM Spectrum Protect server.
         For restore operations, specifies that virtual machines are
         restored from the IBM Spectrum Protect server.
         This value is the default.

LOCAL
         For backup operations, specifies that virtual machines are
         backed up on the hardware storage. The backup is a full virtual
         machine image snapshot, even if an incremental backup is
         specified.
         To create a local backup, the virtual machine must be stored in
         a VMware virtual volume (VVOL) datastore. If any virtual disk
         of the virtual machine is not in a VVOL datastore, the local
         backup is not allowed.
         For restore operations, specifies that virtual machines are
         restored from persisted snapshots that are on the hardware
         storage.
         By restoring from a local snapshot, you can only revert an
         existing virtual machine. You cannot restore a deleted virtual
         machine, and you cannot restore a virtual machine to a
         different name or location.
         Local restore is not valid if the following parameters are used
         for the restore vm command:

         *  VMNAME

         *  DATACENTER

         *  HOST

         *  DATASTORE

         *  :vmdk

         This value is also not valid if the vmrestoretype option is set
         to one of the following values. If these values are set, an
         error message is displayed.

         *  instantaccess

         *  instantrestore

         *  mount
         Because no network data movement is needed for local snapshots,
         backup and restore operations can be faster than server backup
         and restore operations.

BOTH
         For backup operations, specifies that virtual machines are
         backed up to the IBM Spectrum Protect server and are also
         backed up locally. The local backup is always a full image
         snapshot of the VMs, even if incremental backups are configured
         for the server.
         For restore operations, specifies that virtual machines are
         restored from the latest active version regardless whether it
         is a local or a server backup. If both active backups have the
         same timestamp, the local backup is used for the restore.
         This value is not valid with the parameters and vmrestoretype
         option values that are listed above for the LOCAL value.

Examples

Command line:
         Perform a full server and local backup for virtual machine vm1:

         dsmc backup vm vm1 -vmbackuplocation=BOTH -vmbackuptype=FUllvm
         Perform a local restore for virtual machine vm1:

         dsmc restore vm vm1 -vmbackuplocation=LOCAL


3.4.204 Vmbackupmailboxhistory


The vmbackupmailboxhistory option specifies whether mailbox history is
automatically uploaded with the virtual machine (VM) backup if IBM
Spectrum Protect for Mail: Data Protection for Microsoft Exchange Server
is detected on a VM.



Supported Clients

This option is valid on clients that act as a data mover for VMware
guest backups.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                           .-Yes-.
>>-VMBACKUPMAILBoxhistory--+-----+-----------------------------><
                           '-No--'



Parameters

Yes
         The mailbox history is automatically uploaded with the VM
         backup if IBM Spectrum Protect for Mail: Data Protection for
         Microsoft Exchange Server is detected on a VM.

No
         The mailbox history is not automatically uploaded with the VM
         backup.

Examples

Options file:
         vmbackupmailboxhistory yes


3.4.205 Vmbackuptype


Use the vmbackuptype option with the backup VM or restore VM command to
specify to specify the type of virtual machine backup or restore to
complete. You can also use this option on query VM commands to filter
the query results to include only virtual machines that were backed up
by a specific backup type. For examples, see the query VM command
description.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

You can specify a VMware full VM backup.

Supported Clients

This option is valid on Linux data movers that are installed on a
vStorage backup server. The server can also define this option.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                 .-FUllvm-.
>>-VMBACKUPType--+--------+------------------------------------><



Parameters

FUllvm
         Specify this value to run a traditional full VM backup of a
         VMware virtual machine. This is the default backup type for
         Linux clients.

Examples

Options file:
         VMBACKUPT full

Command line:
         dsmc backup vm vm1 -VMBACKUPT=full -vmchost=virtctr
         -vmcuser=virctr_admin -vmcpw=xxxxx

         Performs a full virtual-machine backup of vm1.example.com using
         the VMware VirtualCenter machine virtctr.example.com, to the
         IBM Spectrum Protect server, using machine name vm1.


3.4.206 Vmchost


Use the vmchost option with the backup VM, restore VM, or query VM
commands to specify the host name of the VMware VirtualCenter or ESX
server that you want to backup, restore, or query.

Use the VirtualCenter if it is available. If you cannot use a
VirtualCenter server and you need to perform backups of multiple systems
on multiple ESX servers, do not specify this option, but instead specify
the option with the command so that it can be varied for each ESX
server.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported Clients

This command is valid for clients that are configured to perform an
off-host backup of a VMware virtual machine. The server can also define
this option.

Options File

Place this option in the client options file (dsm.opt), the client
system options file (dsm.sys), or on the command line.

Syntax

>>-VMCHost-- --hostname---------------------------------------><



Parameters

hostname
         Specifies the host name of the VMware VirtualCenter or ESX
         server that you want to backup, restore, or query.

Examples

Options file:
         VMCH vcenter.storage.usca.example.com

Command line:
         -VMCH=esx1.storage.usca.example.com


3.4.207 Vmcpw


Use the vmcpw option with the backup VM, restore VM, or query VM
commands to specify the password for the VMware VirtualCenter or the ESX
user ID that is specified with the vmcuser option.

Use the VirtualCenter if it is available. If you cannot use a
VirtualCenter server and you need to perform backups of multiple systems
on multiple ESX servers, do not specify this option, but instead specify
the option with the command so that it can be varied for each ESX
server.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported Clients

This option is valid only on supported Linux clients that are installed
on a vStorage backup server that is used to backup a VMware virtual
machine.

Options File

Place this option in the client system options file (dsm.sys), or on the
command line.

1. Click Edit -> Client Preferences -> VM Backup . In the Password
   field, type the password that you want to have saved.

2. Click OK.

As an alternative to the preferences editor, you can store the password
locally by using the set password command. For example:

dsmc SET PASSWORD -type=vm
vcenter.us.ibm.com Administrator secret

Syntax

>>-VMCPw-- --pwname-------------------------------------------><



Parameters

pwname
         Specifies the password for the VMware VirtualCenter or ESX
         server that you want to backup, restore, or query.

Examples

Options file:
         VMCPw SECRET

Command line:
         -VMCPw=SECRET

Related reference
2.56 Set Password


3.4.208 Vmctlmc


This option specifies the management class to use when backing up
virtual machine control files.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

By default, virtual machine control files are bound to the default
management class. The vmmc option can be used to specify a different
management class to which virtual machine data and virtual machine
control files are bound. The vmctlmc option overrides the default
management class and the vmmc option for the virtual machine control
files.

Under certain conditions, it might be desirable or necessary to bind the
control files to a different management class than the data files.

The vmctlmc option is required if virtual machine data files are backed
up to tape. Virtual machine control files must be backed up to a
disk-based storage pool that does not migrate to tape. The storage pool
can be composed of random access volumes and sequential file volumes;
the storage pool can also be a deduplicated pool. Use the vmctlmc option
to specify a management class that stores data in such a storage pool.

Restriction: The management class that is specified by the vmctlmc
option determines only the destination storage pool for virtual machine
control files. Retention of the control files is determined by the vmmc
option, if specified, or by the default management class. The retention
for the virtual machine control files always matches the retention of
the virtual machine data files.

Supported Clients

This option is valid for clients that act as data mover nodes that
protect VMware virtual machines.

The option can only be used for virtual machine backups that use an
incremental-forever backup mode.

This option is available only if you have a license to use either IBM
Spectrum Protect for Virtual Environments: Data Protection for VMware or
IBM Spectrum Protect for Virtual Environments: Data Protection for
Microsoft Hyper-V.

Options File

Place this option in the system options file dsm.sys.

Syntax

>>-VMCTLmc--class_name-----------------------------------------><



Parameters

class_name
         Specifies a management class that applies to backing up virtual
         machine control files. If you do not set this option, the
         management class that is specified on the vmmc option is used.
         If you do not set this option and the vmmc option is not set,
         the default management class of the node is used.

Examples

Options file:
         vmctlmc diskonlymc

Command line:
         Does not apply.


3.4.209 Vmcuser


Use the vmcuser option with the backup VM, restore VM, or query VM
commands to specify the user name of the VMware VirtualCenter or ESX
server that you want to backup, restore, or query.

Use the VirtualCenter if it is available. If you cannot use a
VirtualCenter server and you need to perform backups of multiple systems
on multiple ESX servers, do not specify this option, but instead specify
the option with the command so that it can be varied for each ESX
server.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported Clients

This option is valid for clients that are configured as to perform an
off-host backup of VMware virtual machines. The server can also define
this option.

Options File

Place this option in the client options file (dsm.opt), the client
system options file (dsm.sys), or on the command line.

Syntax

>>-VMCUser-- --username---------------------------------------><



Parameters

username
         Specifies the user name of the VMware VirtualCenter or ESX
         server that you want to backup, restore, or query.

         When working with a virtual center, a user id with access to
         the Windows system hosting the virtual center is required. This
         user id must either have administrator privileges, or the
         minimum privileges that are identified in technote 1659544.

Examples

Options file:
         VMCUser administrator

Command line:
         backup vm -VMCUser=domainname\administrator

Command line:
         Example of connecting to an ESX server:

         backup vm -VMCUser=root


3.4.210 Vmdatastorethreshold


Use the vmdatastorethreshold option to set the threshold percentage of
space usage for each VMware datastore of a virtual machine.

When you specify this option, space usage is checked before a virtual
machine snapshot is created. If the threshold is exceeded, the virtual
machine is not backed up. By setting this option, you can prevent
out-of-space errors when you back up virtual machines.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported clients

You can use this option with supported x86_64 Linux clients.

Options file

You can specify this option in the client system-options file (dsm.sys)
or on the command line by using the backup vm command. You can also
include this option on the IBM Spectrum Protect 7.1.5 or later server in
a client option set. You cannot set this option in the Preferences
Editor.

Syntax

>>-VMDATASTORETHreshold----percent-----------------------------><



Parameters

percent
         Specifies the threshold percentage of each VMware datastore of
         the virtual machine to be backed up. You can specify an integer
         from 0 - 100. The default value is 100. If you do not set this
         option, the client begins a virtual machine backup without
         first verifying the existing space usage.

         Requirements:

         *  Ensure that the threshold is low enough so that the snapshot
            does not use up all the available space in the VMware
            datastores. Otherwise, you will run out of space on the
            VMware datastores and the snapshot will not be created.

         *  If you use multiple clients that act as data mover nodes,
            you must add this option to the options file for each data
            mover.

         *  The client checks the data usage of the VMware datastore
            that contains the virtual machine disk snapshots. By
            default, the snapshots are created in the same directory as
            that of the parent virtual disk (.vmdk) file.

            If you change the snapshot location to a new directory on
            the same datastore or on another datastore with the
            workingDir option in the VM configuration file, ensure that
            the path of the working directory is correct. If the path is
            incorrect, the client might validate the data usage of the
            wrong datastore.

         If you use the EXCLUDE.VMDISK option to exclude one or more
         disks from a backup, the threshold check is still run on these
         disks. Even though these disks are not backed up, VMware still
         takes a snapshot of these disks.

         Independent disks are not checked during space verification
         processing because a snapshot of these disks does not use any
         VMware datastore space.

Example 1

Virtual machine vm1 spans datastore1 and datastore2. Set the
vmdatastorethreshold option to 90 to ensure that both VMware datastores
are at most 90% full before the virtual machine is backed up.

Options file:
         vmdatastorethreshold 90

Command line:
         dsmc backup vm vm1 -vmdatastorethreshold=90

Example 2

The datastore threshold of datastore2 is set to 85. The datastore
threshold is exceeded during the backup of virtual machine vm5. The
following error message is displayed:

ANS14200E The virtual machine 'vm5' could not be backed up because the
data usage of datastore 'datastore2' exceeded the datastore threshold
of 85%.

Increase the value of the vmdatastorethreshold option to 95 and restart
the backup.

Options file:
         vmdatastorethreshold 95

Command line:
         dsmc backup vm vm5 -vmdatastorethreshold=95


3.4.211 Vmdefaultdvportgroup


Use this option to specify the port group for the NICs to use during
restore vm operations for a virtual machine that was connected to a
distributed virtual port group when it was backed up, but the target
host for the restore operation does not contain a similar distributed
virtual port group.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option does not apply to backup or restore operations for Microsoft
Hyper-V virtual machines.

Supported clients

This option is valid for Linux clients that are installed on a vStorage
backup server.

Options file

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or specify it as a command-line parameter
on the restore vm command.

Syntax

>>-VMDEFAULTDVPORTGROUP--portgroup_name------------------------><



Parameters

portgroup name
         Specifies the name of the port group to use. The port group
         name is case sensitive.

Examples

Option file:

VMDEFAULTDVPORTGROUP dvPortGroup



Command line:

dsmc restore vm vm123 -VMDEFAULTDVPORTGROUP=dvPortGroup


3.4.212 Vmdefaultdvswitch


Use this option to specify the distributed virtual switch (dvSwitch)
that contains the port group that you set on the vmdefaultdvportgroup
option. The option has no effect unless you also specify the
vmdefaultdvportgroup option.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option does not apply to backup or restore operations for Microsoft
Hyper-V virtual machines.

Supported clients

This option is valid for Linux clients that are installed on a vStorage
backup server.

Options file

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or specify it as a command-line parameter
on the restore vm command.

Syntax

>>-VMDEFAULTDVSWITCH--dvSwitch---------------------------------><



Parameters

dvSwitch
         Specifies the name of the virtual switch to use. The virtual
         switch name is case sensitive.

Examples

Option file:

VMDEFAULTDVSWITCH dvSwitch



Command line:

dsmc restore vm vm123 -VMDEFAULTDVSWITCH=dvSwitch -VMDEFAULTDVPORTGROUP=dvPortGroup


3.4.213 Vmdefaultnetwork


Use this option to specify the network for NICs to use during a restore
vm operation, for a virtual machine that had been connected to a
distributed virtual port group when it was backed up, but the target
host for the restore operation does not have any distributed switch port
groups configured.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option does not apply to restore operations for Microsoft Hyper-V
virtual machines.

Supported clients

This option is valid for Linux clients that are installed on a vStorage
backup server.

Options file

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or specify it as a command-line parameter
on the restore vm command.

Syntax

>>-VMDEFAULTNETWORK--vm_network_name---------------------------><



Parameters

vm_network_name
         Specifies the name of the virtual machine network to use. The
         network name is case sensitive. If the name contains space
         characters, enclose it in quotation marks.

Examples

Option file:

VMDEFAULTNETWORK "VM Network"



Command line:

dsmc restore vm vm123 -VMDEFAULTNETWORK="VM Network"


3.4.214 Vmenabletemplatebackups


The vmenabletemplatebackups option specifies whether the client backs up
VMware template virtual machines when it protects virtual machines in a
vCenter server. VMware templates virtual machines cannot be backed up
when they are in an ESXi host because ESXi does not support templates.

When this option is enabled, you can include VMware template machines in
full VM backup operations. You use the existing Backup VM command and
the DOMAIN.VMFULL option to specify the virtual machines to include in
the backup operation.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Incremental backups are not supported and snapshots are not taken, so
you must use MODE=IFFULL. Use MODE=IFFULL to force a new backup of
VMware template virtual machines, even if they were not changed since
the last backup.

When vmenabletemplatebackups is enabled, any backup process that is
initiated by using MODE=IFINCREMENTAL is processed by using MODE=IFFULL.
VMware template VMs are included in a backup only if they were changed
since the last backup occurred.

With this option enabled, make sure that the vmvstortransport options
include NBDSSL or NBD. Using only the SAN or HOTADD transport modes with
this option enabled causes backups of the template machines to fail.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

You can set this option on the command line, in the client system
options file (dsm.sys), client options file (dsm.opt), or on the server
in a client options set.

You can also set it in the preferences editor on the VM Backup tab
(select the Backup virtual machine templates option).

Syntax

                            .-No------.
>>-VMENABLETEMPlatebackups--+-+-----+-+------------------------><
                              '-Yes-'



Parameters

No
         Specifies that template virtual machines are not included in
         full VM backup operations; this is the default setting.

Yes
         Specifies that template VMs are included in full VM backup
         operations.

Examples

Options file
         vmenabletemplatebackups yes

Command line
         Back up a VMware template VM

         dsmc backup vm vmname -VMENABLETEMPLATEBACKUPS=YES

         where vmname is the template machine name.

Command line
         Restore a VMware template VM to the same location and name

         dsmc restore vm vmname -VMENABLETEMPLATEBACKUPS=YES

         where vmname is the template machine name.

Command line
         Restore a template virtual machine to a new location

         dsmc restore vm vmname -vmname=win7x64
           -datastore=datastore22 -host=supersht.labx.com
            -datacenter="Lab Center" -VMENABLETEMPLATEBACKUPS=YES

         where vmname is the template machine name. "win7x64" is the new
         template VM name. The new data center, host, and datastore are
         also included.

Related reference
2.11 Backup VM
2.49 Restore VM (VMware)
3.4.46 Domain.vmfull


3.4.215 Vmlimitperdatastore


The vmlimitperdatastore option specifies the number of virtual machines
(VMs) and virtual disks in a datastore that can be processed in parallel
during an optimized backup operation.

An optimized backup operation is one in which parallel backup capability
is enabled at the VM, virtual disk, or subdisk level.

The vmlimitperdatastore option works with the vmmaxparallel,
vmmaxbackupsessions, and vmlimitperhost options to optimize backup
operations and to help control the amount of resources that the backup
can create on a host in the vSphere infrastructure. Adjust the values of
these options to find the values that provide optimal performance for
the backups that are in your environment.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

This option is valid in the client system options file (dsm.sys), in the
client options file (dsm.opt) or on the command line for Backup VM. It
can also be included on the server in a client options set. It cannot be
set in the Preferences Editor.

Syntax

                            .-0-----------.
>>-VMLIMITPERDatastore-- --+-+---------+-+--------------------><
                              '-integer-'



Parameters

integer
         Specifies the maximum number of VMs in any one datastore that
         are included during an optimized backup operation. The maximum
         that you can specify is 50 VMs. The default is 0 (zero).
         Specifying 0 means that you are not concerned about how many
         VMs can be backed up in parallel from a datastore. Instead, you
         want to limit the maximum number of VMs to include in a backup
         by using the value that you specify on the vmmaxparallel
         option. The vmlimitperdatastore option is enforced even when VM
         data exists in two or more datastores.

Examples

Options file
         VMLIMITPERD 5

Command line:
         dsmc backup vm -VMLIMITPERD=5

Related reference
2.11 Backup VM
3.4.46 Domain.vmfull
3.4.217 Vmmaxbackupsessions
3.4.218 Vmmaxparallel
3.4.216 Vmlimitperhost


3.4.216 Vmlimitperhost


The vmlimitperhost option specifies the number of virtual machines (VMs)
and virtual disks in a host that can be processed in parallel during an
optimized backup operation.

An optimized backup operation is one in which parallel backup capability
is enabled at the VM, virtual disk, or subdisk level.

The vmlimitperhost option works with the vmmaxparallel,
vmmaxbackupsessions, and vmlimitperdatastore options to optimize backup
operations and to help control the amount of resources that the backup
can create on a host in the vSphere infrastructure. Adjust the values of
these options to find the values that provide optimal performance for
the backups that are in your environment.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

This option is valid in the client system options file (dsm.sys), in the
client options file (dsm.opt) or on the command line for Backup VM. It
can also be included on the server in a client options set. It cannot be
set in the Preferences Editor.

Syntax

                       .-0-----------.
>>-VMLIMITPERHost-- --+-+---------+-+-------------------------><
                         '-integer-'



Parameters

integer
         Specifies the maximum number of VMs in any one ESX server that
         can be included in an optimized backup operation. The maximum
         that you can specify is 50 VMs. The default is 0 (zero).
         Specifying 0 means that you are not concerned about how many
         VMs can be backed up in parallel from an ESX server. Instead,
         you want to limit the maximum number of VMs to include in a
         backup by using the limit that you specify on the vmmaxparallel
         option.

Examples

Options file
         VMLIMITPERH 5

Command line:
         dsmc backup vm -VMLIMITPERH=5

Related reference
2.11 Backup VM
3.4.46 Domain.vmfull
3.4.218 Vmmaxparallel
3.4.216 Vmlimitperhost


3.4.217 Vmmaxbackupsessions


The vmmaxbackupsessions option specifies the maximum number IBM Spectrum
Protect server sessions that move virtual machine (VM) data to the
server that can be included in an optimized backup operation.

An optimized backup operation is one in which parallel backup capability
is enabled at the VM, virtual disk, or subdisk level.

For VMware VMs, the vmmaxbackupsessions option works with the
vmmaxparallel, vmlimitperdatastore, and vmlimitperhost options to
optimize backup operations and to help control the amount of resources
that the backup can create on a host in the vSphere infrastructure.
Adjust the values of these options to find the values that provide
optimal performance for the backups that are in your environment.

Supported clients

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

For VMware VMs, this option can be used with supported x86_64 Linux
clients.

Options file

This option is valid in the client system options file (dsm.sys), in the
client options file (dsm.opt), or on the command line for Backup VM. It
can also be included on the server in a client options set. It cannot be
set in the Preferences Editor.

Syntax

                        .-4-----------.
>>-VMMAXBACKUPSEssions--+-+---------+-+------------------------><
                          '-integer-'



Parameters

integer
         Specifies the maximum number of IBM Spectrum Protect server
         sessions that can be created during the backup operation.

         The default is 4. The maximum is 100.

         Review the following information for using the
         vmmaxbackupsessions option along with the vmmaxparallel option
         or the maxnummp server parameter:

         vmmaxparallel
                  The vmmaxparallel option specifies the maximum number
                  of virtual machines that can be backed up to the IBM
                  Spectrum Protect server at any one time. The value of
                  the vmmaxbackupsessions option must be equal to or
                  greater than the value of the vmmaxparallel option.
                  If the value is less than the value of the
                  vmmaxparallel option, the following message is
                  returned and the value is changed to the same value as
                  the vmmaxparallel option:
                  ANS9995W The value of the VMMAXBACKUPSESSIONS option
                  is number_value. This value must be greater than or
                  equal to the value of the VMMAXPARALLEL option, which
                  is number_value. The value will be set to the value of
                  the VMMAXPARALLEL option.

         maxnummp
                  The maxnummp server parameter specifies the maximum
                  number of mount points a node is allowed to use on the
                  server when the copy destination of the storage pool
                  is FILE or TAPE. The maxnummp parameter must be equal
                  to or greater than the vmmaxparallel and
                  vmmaxbackupsessions option settings. When multiple
                  instances of the client are backing up files, or when
                  a single client performs parallel backup operations,
                  more mount points might be required.
                  If the values for vmmaxparallel or vmmaxbackupsessions
                  exceed the value for maxnummp, ANS0266I and other
                  messages are displayed. Depending on the message, the
                  client reduces the value of the vmmaxparallel option
                  to match the number that is specified by maxnummp
                  parameter or prohibits additional sessions from being
                  opened for the specified VM. In either situation, the
                  backup operation continues.
                  If additional ANS0266I errors are detected, the client
                  reduces the vmmaxparallel value by 1 and attempts to
                  continue the backup. If vmmaxparallel is decremented
                  to 1 and the client receives more ANS0266I errors, the
                  client ends the backup and issues the following error:
                  ANS5228E A backup VM operation failed because
                  VMMAXPARALLEL was reduced to 1 and the client still
                  cannot obtain a server mount point.
                  Contact your server administrator if you want the
                  value that is currently set for maxnummp increased so
                  that a node can support additional parallel backup
                  sessions.

         The maximum that you can specify is 100 sessions. The default
         is the value that is set for the vmmaxparallel option.

Examples

Options file
         VMMAXBACKUPS 10

Command line:
         dsmc backup vm -VMMAXBACKUPS=10

Related reference
2.11 Backup VM
3.4.46 Domain.vmfull
3.4.218 Vmmaxparallel
3.4.215 Vmlimitperdatastore
3.4.216 Vmlimitperhost


3.4.218 Vmmaxparallel


The vmmaxparallel option is used to configure optimized backups of
several virtual machines by using a single instance of the
backup-archive client. This option specifies the maximum number of
virtual machines that can be backed up to the IBM Spectrum Protect
server at any one time.

An optimized backup operation is one in which parallel backup capability
is enabled at the VM, virtual disk, or subdisk level.

The vmmaxparallel option works with the vmmaxbackupsessions,
vmlimitperhost, and vmlimitperdatastore options to optimize backup
operations and to help control the amount of resources that the backup
can create on a host in the vSphere infrastructure. Adjust the values of
these options to find the values that provide optimal performance for
the backups that are in your environment.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

This option is valid in the client system options file (dsm.sys) or on
the command line for the Backup VM command. It can also be included on
the server in a client options set. It cannot be set in the Preferences
Editor.

Syntax

                  .-4-----------.
>>-VMMAXParallel--+-+---------+-+------------------------------><
                    '-integer-'



Parameters

integer
         Specifies the maximum number of virtual machines that can be
         backed up at any one time during an optimized backup operation.
         The default is 4. The maximum is 50.

         Tip: When you use client-side data deduplication, a data
         deduplication session is started for each VM. This data
         deduplication session is not counted as one of the
         vmmaxparallel sessions.

         Review the following information for using the vmmaxparallel
         option in conjunction with the vmmaxbackupsessions option or
         the maxnummp server parameter:

         vmmaxbackupsessions
                  For Data Protection for VMware, the
                  vmmaxbackupsessions specifies the maximum number of
                  sessions that move virtual machine data to the server
                  that can be included in an optimized backup operation.
                  The value of the vmmaxbackupsessions option must be
                  equal to or greater than the value of the
                  vmmaxparallel option.

         maxnummp
                  The maxnummp server parameter specifies the maximum
                  number of mount points a node is allowed to use on the
                  server when the copy destination of the storage pool
                  is FILE or TAPE. The maxnummp parameter must be equal
                  to or greater than the vmmaxparallel and
                  vmmaxbackupsessions option settings. When multiple
                  instances of the client are backing up files, or when
                  a single client performs parallel backup operations,
                  more mount points might be required.
                  If the values for vmmaxparallel or vmmaxbackupsessions
                  exceed the value for maxnummp, ANS0266I and other
                  messages are displayed. Depending on the message, the
                  client reduces the value of the vmmaxparallel option
                  to match the number that is specified by maxnummp
                  parameter or prohibits additional sessions from being
                  opened for the specified VM. In either situation, the
                  backup operation continues.
                  If additional ANS0266I errors are detected, the client
                  reduces the vmmaxparallel value by 1 and attempts to
                  continue the backup. If vmmaxparallel is decremented
                  to 1 and the client receives more ANS0266I errors, the
                  client ends the backup and issues the following error:
                  ANS5228E A backup VM operation failed because
                  VMMAXPARALLEL was reduced to 1 and the client still
                  cannot obtain a server mount point.
                  Contact your server administrator if you want the
                  value that is currently set for maxnummp increased so
                  that a node can support additional parallel backup
                  sessions.

Examples

Options file
         VMMAXP 10

Related reference
2.11 Backup VM
3.4.46 Domain.vmfull
3.4.216 Vmlimitperhost
3.4.215 Vmlimitperdatastore


3.4.219 Vmmaxrestoresessions


The vmmaxrestoresessions option defines the aggregate number of sessions
which will be allocated for the IBM Spectrum Protect server optimized
restore operation.

A optimized restore operation is one in which parallel restore
capability is enabled at the subdisk level of a virtual disk.

Note: At least one session must be allocated for each disk that is being
restored.

Note: If the value of vmmaxrestoresessions is less than the value of
vmmaxrestoreparalleldisks multiplied by vmmaxrestoreparallelvms, the
value will automatically be adjusted to the value of
vmmaxrestoreparalleldisks multiplied by vmmaxrestoreparallelvms at
runtime.

Supported clients

This option can be used with supported x86_64 Linux clients.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Options file

This option is valid in the client system options file (dsm.sys), in the
client options file (dsm.opt), or on the command line for Restore VM. It
can also be included on the server in a client options set. It cannot be
set in the Preferences Editor.

For Hyper-V VMs, this option is valid in the data mover options file
(dsm.hostname_HV_DM.opt) or on the command line with the restore vm
command. It can also be included in a client option set on the IBM
Spectrum Protect server.

Syntax

                             .-8-----------.
>>-VMMAXRESTORESessions-- --+-+---------+-+-------------------><
                               '-integer-'



Parameters

integer
         Specifies the number of IBM Spectrum Protect server sessions
         that are created during the restore operation. The default is
         8. The maximum is 100.

Examples

Options file
         VMMAXRESTORES 5

Command line:
         dsmc restore vm webserver1 -VMMAXRESTORES=5

Note: This command line example for this option is valid in both Windows
and Linux supported clients.

Related reference
2.49 Restore VM (VMware)


3.4.220 Vmmaxrestoreparalleldisks (VMware)


The vmmaxrestoreparalleldisks option enables an IBM Spectrum Protect
client to restore specific multiple virtual disks at the same time per
virtual machine.

You can specify the number of disk sessions to be opened, up to a
maximum of 10. Sessions are allocated per disk based on the transport
type from the option vmvstortransport. Available sessions are allocated
across the number of disk sessions specified by
vmmaxrestoreparalleldisks, by rounding down the number of sessions per
disk to the nearest whole number.

Supported clients

This option can be used with supported x86_64 Linux clients.

Note:

You must ensure the total number of restore operations from all sources
to the same ESXi host does not exceed 26. Due to an ESXi host issue,
exceeding this number of parallel restores may cause the operation to
fail. For example, if you have 3 different restore instances to the same
ESXi host, each with VMMAXRESTOREPARALLELDISKS 10, the restores may fail
because the total number of connections is 30

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options file

This option is valid in the client system options file (dsm.sys), or on
the command line for Restore VM. It can also be included on the server
in a client options set. It cannot be set in the Preferences Editor.

Syntax

                                  .-2-----------.
>>-VMMAXRESTOREPARALLELDisks-- --+-+---------+-+--------------><
                                    '-integer-'



Parameters

integer
         Specifies the number of virtual hard disks that can be restored
         simultaneously. The default is 2. The maximum is 10.

Examples

Task
         Set a maximum of 2 simultaneous restore operations for virtual
         disks in the restore operation of the virtual machine vm1:

         dsmc restore vm vm1 -vmmaxrestoreparalleldisks=2 -vmmaxrestoresessions=8
         This will assign 4 simultaneous restore sessions per virtual
         disk.

Related reference
2.49 Restore VM (VMware)


3.4.221 Vmmaxrestoreparallelvms (VMware)


The vmmaxrestoreparallelvms option controls the number of virtual
machines an IBM Spectrum Protect client can restore at the same time.

Use this option to increase restore performance by increasing the number
of virtual machines to restore in parallel.

You can specify the number of virtual machines to be restored
simultaneously, up to a maximum of 10. The default value is 2.

Supported clients

This option can be used with supported x86_64 Linux clients.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options file

This option is valid in the client system options file (dsm.sys), or on
the command line for Restore VM. It can also be included on the server
in a client options set. It cannot be set in the Preferences Editor.

Syntax

                                .-2-----------.
>>-VMMAXRESTOREPARALLELVms-- --+-+---------+-+----------------><
                                  '-integer-'



Parameters

integer
         Specifies the maximum number of virtual machines that can be
         restored simultaneously. The default is 2. The maximum is 10.

Note: If you are using the Vmmaxrestoresessions option to limit the
number of restore sessions, the number of sessions has to be greater
than or equal to the number of virtual machines. This ensures at least
one session is available per VM.

Note: If you are using the option Vmmaxparalleldisks to restore multiple
virtual disks at same time, the number of virtual disks must be less
than or equal to the number of sessions.

Examples

Task
         Set a maximum of 5 simultaneous virtual machine restores for
         machines vm1, vm2, vm3, vm4, and vm5:

         dsmc restore vm1,vm2,vm3,vm4,vm5 -VMMAXRESTOREPARALLELVms=5
         VMMAXRESTORESessions=10 -VMMAXRESTOREPARALLELDisks=2
         This will assign 5 simultaneous virtual machines restores that
         can restore up to 2 virtual disks in parallel per virtual
         machine at a time and assign 2 sessions per virtual machine.

Task
         Set a maximum of 2 simultaneous virtual machine restores for
         machines vm1 and vm2:

         dsmc restore vm1,vm2 -VMMAXRESTOREPARALLELVms=2
         VMMAXRESTORESessions=10 -VMMAXRESTOREPARALLELDisks=1
         This will assign 2 simultaneous virtual machines restores with
         at least one disk per virtual machine at a time and 5 sessions
         per virtual machine.

Task
         Set a maximum of 2 simultaneous virtual machine restores for
         machines vm1, vm2, vm3, and vm4:

         dsmc restore vm1,vm2,vm3,vm4 -VMMAXRESTOREPARALLELVms=2
         VMMAXRESTORESessions=16 -VMMAXRESTOREPARALLELDisks=2
         This will assign 2 simultaneous virtual machines restores with
         2 disks per virtual machines at a time and 8 sessions per
         virtual machine.

Related reference
2.49 Restore VM (VMware)
3.4.219 Vmmaxrestoresessions
3.4.220 Vmmaxrestoreparalleldisks (VMware)


3.4.222 Vmmaxvirtualdisks


The vmmaxvirtualdisks option specifies the maximum size of virtual
machine disks to include in a backup operation.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Use the vmmaxvirtualdisks option with the vmskipmaxvirtualdisks option
to specify how the data mover processes large virtual machine (VM) disks
during a backup operation:

*  Set the vmmaxvirtualdisks option to specify the maximum size of the
   VM disks to include.

*  Set the vmskipmaxvirtualdisks option to back up the VM disks that do
   not exceed the maximum size (and exclude any VM disks that exceed the
   size), or fail the operation.

Supported clients

This option is valid for 64-bit Linux clients that are configured as
data movers that back up VMware virtual machines.

Options file

Set the vmmaxvirtualdisks option in the client system options file
(dsm.sys). You can also specify this option as a command-line parameter
on the backup vm command.

Syntax

                      .-2----------.
>>-VMMAXVIRTUALDisks--+-size -----+---------------------------><
                      '-2...8, 999-'



Parameters

size
         Specifies the maximum size, in terabytes (TB), of the VM disks
         to include in a backup operation. The range is an integer 2 -
         8; the default is 2. The maximum is 8 TB (equivalent to 8192
         GB).
         To ensure that the VM disk size that is included in backup
         operations is always the maximum size, specify 999. Use this
         value as the most effective method to ensure that the maximum
         value is always set. This value prevents the need to
         continuously modify the option files.
         When you also specify the vmskipmaxvirtualdisks yes option, VM
         disks that are the specified maximum size or smaller are backed
         up and VM disks that are larger than the specified maximum size
         are excluded.
         When you also specify the vmskipmaxvirtualdisks no option,
         backup operations fail if a VM disk is larger than the
         specified maximum size.

Examples

Options file:
         vmmaxvirtualdisks 3

Command line:
         Back up VM disks that are 5 TB or smaller and exclude VM disks
         that are larger than 5 TB:

         backup vm VM1 -vmmaxvirtualdisks=5 -vmskipmaxvirtualdisks=yes
         Back up VM disks that are 3 TB or smaller and fail the backup
         operation if a VM disk is larger than 3 TB:

         backup vm VM1 -vmmaxvirtualdisks=3 -vmskipmaxvirtualdisks=no
         Back up VM disks that are 8 TB or smaller and exclude VM disks
         that are larger than 8 TB:

         backup vm VM1 -vmmaxvirtualdisks=8 -vmskipmaxvirtualdisks=yes

         Or:

         backup vm VM1 -vmmaxvirtualdisks=999 -vmskipmaxvirtualdisks=yes


3.4.223 Vmmc


Use the vmmc option to store virtual machine backups by using a
management class other than the default management class. For VMware VM
backups, the vmmc option is valid only if the vmbackuptype=fullvm option
is set.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Supported Clients

This option is valid for clients that are configured to back up VMware
virtual machines. The server can also define this option.

Options File

Place this option in the client options file dsm.opt, in the client
system options file dsm.sys, or on the command line.

Syntax

>>-VMMC--management_class_name---------------------------------><



Parameters

management_class_name
         Specifies a management class that applies to the backed up
         virtual machine data. If you do not set this option, the
         default management class of the node is used.

Examples

Task:
         Run a backup of the virtual machine that is named
         myVirtualMachine and save the backup according to the
         management class that is named myManagmentClass.
         dsmc backup vm "myVirtualMachine" -vmmc=myManagmentClass


3.4.224 Vmnocbtcontinue


Use the vmnocbtcontinue option to specify whether to back up a virtual
machine (VM) without using the change block tracking function when one
or more snapshots already exist on the VM and change block tracking must
be enabled or reset.

If you run an incremental-forever backup on a VM and change block
tracking needs to be enabled or re-enabled, and one or more snapshots
exist on the VM, change block tracking cannot be enabled. VMware does
not support enabling change block tracking when a snapshot exists for
the VM.

Ensure that you remove any existing snapshots before you run an
incremental-forever backup for the first time so that change block
tracking can be enabled. To proceed with the backup operation without
enabling change block tracking, the vmnocbtcontinue yes option can be
specified. However, running a backup operation with this option setting
will cause each backup of the VM to be a full backup, which will include
both used and unused blocks for each disk of the VM. After the backup
operation is completed, when no snapshots exist on the VM, change block
tracking is enabled and an incremental-forever backup is taken.

If you want to reset change block tracking for a VM or group of VMs, use
the include.vmresetcbt vmname option. For more information, see
3.4.86.4.4 Include.vmresetcbt.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported Clients

Options file

Place this option in the client options file (dsm.opt).

Syntax

                    .-No--.
>>-VMNOCBTcontinue--+-----+------------------------------------><
                    '-Yes-'



Parameters

No
         Fail the backup operation because change block tracking cannot
         be enabled. This value is the default.

Yes
         Continue the backup operation without using change block
         tracking.

         Specifying this value causes each backup of the VM to be a full
         backup that includes both used and unused blocks for each disk
         of the VM.


3.4.225 Vmnoprdmdisks


This option enables the client to restore configuration information for
the pRDM volumes that are associated with a VMware virtual machine, even
if the LUNs that were associated with the volumes cannot be found.
Because pRDM volumes are not included in virtual machine snapshot, only
the configuration information can be restored, and not the data that was
on the volumes.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option does not apply to backups of Microsoft Hyper-V virtual
machines.

Supported Clients

This option is valid for Windows and Linux clients that are installed on
a vStorage backup server.

Options File

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or specify it as a command-line parameter
on the restore vm command.

Syntax

                  .-NO--.
>>-VMNOPRDmdisks--+-----+--------------------------------------><
                  '-YES-'



Parameters

YES
         Specify this value if you must restore a virtual machine that
         you backed up with -vmprocesswithprdm=yes, and the original
         LUNs that were mapped by the raw device mappings file cannot be
         located. This setting causes the client to skip attempts to
         locate the missing LUNs used by the pRDM volumes, and restore
         the configuration information (disk labels) that were
         associated with them. The pRDM volumes are restored as
         thin-provisioned VMFS VMDKs. You can then use the vSphere
         client to create the necessary pRDM mappings.

NO
         Setting -vmnoprdmdisk=no causes restore operations for virtual
         machines that were backed up with -processvmwithprdm=yes to
         fail if the original LUNs that were mapped to by the raw device
         mappings file cannot be located. This value is the default
         value.

Examples

Option file:

VMNOPRDMDISKS YES



Command line:

dsmc restore vm vm123 -vmnoprdmdisks=yes


3.4.226 Vmnovrdmdisks


This option enables the client to restore configuration information and
data for vRDM volumes that are associated with a VMware virtual machine,
even if the LUNs that were associated with the volumes cannot be found.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option does not apply to backups of Microsoft Hyper-V virtual
machines.

Supported Clients

This option is valid for Windows and Linux clients that are installed on
a vStorage backup server.

Options File

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or specify it as a command-line parameter
on the restore vm command.

Syntax

                  .-NO--.
>>-VMNOVRDmdisks--+-----+--------------------------------------><
                  '-YES-'



Parameters

YES
         Specify this value if you must restore a virtual machine that
         you backed up, and the original LUNs that were mapped by the
         raw device mappings file cannot be located. This setting causes
         the client to skip attempts to locate the missing LUNs used by
         the vRDM volumes, and restore the configuration information
         (disk labels) and the data that was backed up. The vRDM volumes
         are restored as thin-provisioned VMFS VMDKs.

NO
         Setting -vmnovrdmdisk=no causes restore operations for virtual
         machines that had vRDM volume to fail, if the original LUNs
         that were mapped to by the raw device mappings file cannot be
         located. This value is the default value.

Examples

Option file:

VMNOVRDMDISKS YES



Command line:

dsmc restore vm vm123 -vmnovrdmdisks=yes


3.4.227 Vmpreferdagpassive


The vmpreferdagpassive option specifies whether to back up an active
copy or passive copy of a database that is part of a Microsoft Exchange
Server Database Availability Group (DAG).

This option applies to Microsoft Exchange Server workloads that run
inside virtual machine guests that are protected by IBM Spectrum Protect
for Virtual Environments.

Use the vmpreferdagpassive option with the backup vm command.

Supported Clients

This option is valid on clients that act as a data mover for VMware
guest backups.

Options File

Place this option in the client system-options file (dsm.sys) within a
server stanza.

Syntax

                       .-No--.
>>-VMPREFERDAGPassive--+-----+---------------------------------><
                       '-Yes-'



Parameters

No
         Back up the Microsoft Exchange Server database in a DAG
         regardless of whether it is an active copy or passive copy.
         This value is the default.

Yes
         Skip the backup for an active database copy in a DAG if a valid
         passive copy is available on another server. If no valid
         passive copy is available, the active database copy is backed
         up.

Examples

Options file:
         vmpreferdagpassive yes


3.4.228 Vmprocessvmwithindependent


Use this option to specify whether VMware virtual machines (VMs) that
are provisioned with one or more independent disks are backed up. By
default, VMs with independent disks are not backed up.

Independent disks cannot be backed up because they do not support
snapshots. Therefore, review the following considerations before setting
the vmprocessvmswithindependent option to yes:

*  Only normal disk volumes are backed up. The data on independent disks
   is not backed up.

*  Configuration information for independent disks is not backed up.
   Independent disks must be manually recreated on a restored machine.

*  If a volume is striped across both normal and independent disks, then
   only the portions of the volume data on the normal disks can be
   restored. Therefore, after the VM is restored, the volume is
   corrupted because the stripes on the independent disks are missing.

*  File level restore is supported for VMs that have normal and
   independent disks if no volume is striped across both normal and
   independent disks. Only files on the normal disks can be restored.

*  File level restore is not supported for VMs that have one or more
   volumes striped across both normal and independent disks. Use full VM
   restore for such VMs.

If the virtual machine contains one or more raw device mapping (RDM)
volumes that are provisioned in physical compatibility mode (pRDM), use
the vmprocessvmwithprdm option to specify whether the client backs up
the virtual machine if a pRDM disk is present.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option is only valid for VMware backups and does not pertain to
Microsoft Hyper-V backups.

Supported Clients

This option is valid for Windows and Linux clients that are configured
as a VMware backup data mover. The server can also define this option.

Options File

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or on the command-line.

Syntax

                               .-No--.
>>-VMPROCESSVMWITHINDependent--+-----+-------------------------><
                               '-Yes-'



Parameters

No
         The backup of the VM fails if one or more independent disk
         volumes are detected. No is the default.

Yes
         The backup of the VM continues if one or more independent disk
         volumes are detected. Review the preceding considerations
         before using Yes.

Examples

Option file:

VMPROCESSVMWITHINDEPENDENT Yes



Command line:

dsmc backup vm vmlocal -vmbackuptype=fullvm -vmprocessvmwithindependent=yes


3.4.229 Vmprocessvmwithprdm


Use this option to control whether full VMware virtual machine backups
are processed if the virtual machine has one or more raw device mapping
(RDM) volumes provisioned in physical-compatibility mode (pRDM).

pRDM volumes do not support snapshots. Any pRDM volumes found on a
virtual machine are not processed as part of the backup operation. When
the virtual machine is restored, the backup-archive client recovers the
virtual machine, and only the volumes that participated in snapshot
operations are restored. Configuration information and content of the
pRDM volumes is not preserved in the information stored on the IBM
Spectrum Protect server. Users must re-create the pRDM volumes on the
restored machine.

This option does not apply to virtual machines that have one or more RDM
volumes that are provisioned in virtual-compatibility mode (vRDM).
Because vRDM volumes do support snapshot operations, they are included
in a full VMware virtual machine backup.

If the virtual machine also contains one or more independent disks, use
the vmprocessvmwithindependent option to control whether the client
backs up any files on the virtual machine if an independent disk is
present.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

This option is only valid for VMware backups and does not pertain to
Microsoft Hyper-V backups.

Supported Clients

This option is valid for Windows and Linux clients that are configured
as a VMware backup server. The server can also define this option.

Options File

Place this option in the client options file (dsm.opt), in the client
system options file (dsm.sys), or on the command line.

Syntax

                        .-NO--.
>>-VMPROCESSVMWITHPRDM--+-----+--------------------------------><
                        '-YES-'



Parameters

No
         The backup of the virtual machine fails if one or more pRDM
         volumes are detected. No is the default.

Yes
         Virtual machines that contain one or more raw device mapping
         (RDM) volumes that are provisioned in physical-compatibility
         mode (pRDM) are backed up. However, the pRDM volumes are not
         processed as part of the virtual machine backup operation.
         If the virtual machine also contains one or more independent
         disks, the vmprocessvmwithindependentdisk option must also be
         specified.

Examples

Option file:

VMPROCESSVMWITHPRDM Yes



Command line:

dsmc backup vm vmlocal -vmbackuptype=fullvm -vmprocessvmwithprdm=yes


3.4.230 Vmskipctlcompression


Use the vmskipctlcompression option for VM backups to specify whether
control files (*.ctl) are compressed during VM backup. The option does
not affect the compression of data files (*.dat)

You can compress virtual machine control files and data files only when
the files are stored in a storage pool that is enabled for client-side
deduplication. Use the following options configuration to compress data
files and not compress control files:

compression yes
vmskipctlcompression yes

You must direct the data files to a storage pool that is enabled for
client-side deduplication. You can direct the control files to a storage
pool that is not enabled for client-side deduplication

You must be licensed to use IBM Spectrum Protect for Virtual
Environments to use this option.

Supported Clients

Options file

Place this option in the client options file (dsm.opt), or on the
command line.

Syntax

                         .-Yes-.
>>-VMSKIPCTLCOMPRESSION--+-----+-------------------------------><
                         '-No--'



Parameters

Yes
         Do not compress control files (*.ctl) during VM backup. The
         option does not affect compression of data files (*.dat).

No
         Control files (*.ctl) can be compressed during VM backup.
         Whether control files are compressed depends on the value of
         the compression option.


3.4.231 Vmskipmaxvirtualdisks


The vmskipmaxvirtualdisks option specifies how backup operations process
virtual machine (VM) disks that exceed the maximum disk size.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments.

Use the vmskipmaxvirtualdisks option with the vmmaxvirtualdisks option
to specify how the data mover processes large VM disks during a backup
operation:

*  Set the vmskipmaxvirtualdisks option to back up the VM disks that do
   not exceed the maximum size (and exclude any VM disks that exceed the
   size), or fail the operation.

*  Set the vmmaxvirtualdisks option to specify the maximum size of the
   VM disks to include.

In Data Protection for VMware 7.1.3 and earlier, the
vmskipmaxvirtualdisks option was named vmskipmaxvmdks. In version 7.1.4
and later, vmskipmaxvirtualdisks is the preferred option name. However,
the client still processes backup operations with the vmskipmaxvmdks
name.

Supported clients

This option is valid for 64-bit Linux clients that are configured as
data movers that back up VMware virtual machines.

Options file

Set the vmskipmaxvirtualdisks option in the client system options file
(dsm.sys). You can also specify this option as a command-line parameter
on the backup vm command.

Syntax

                          .-No--.
>>-VMSKIPMAXVIRTUALDISKS--+-----+------------------------------><
                          '-Yes-'



Parameters

No
         Specifies that backup operations fail if a virtual machine has
         one or more VM disks that are larger than the maximum size.
         This setting is the default value.

Yes
         Specifies that backup operations include VM disks that are the
         maximum size (or smaller) and exclude any VM disks that are
         larger than the maximum size.

Examples

Options file:
         vmskipmaxvirtualdisks yes

Command line:
         Fail a backup operation if a VM disk is larger than 2 TB:

         backup vm VM1 -vmskipmaxvirtualdisks=no
         Fail a backup operation if a VM disk is larger than 5 TB:

         backup vm VM1 -vmskipmaxvirtualdisks=no -vmmaxvirtualdisks=5
         Back up VM disks that are 8 TB or smaller and exclude VM disks
         that are larger than 8 TB:

         backup vm VM1 -vmskipvirtualdisks=yes -vmmaxvirtualdisks=8


3.4.232 Vmskipmaxvmdks


The vmskipmaxvmdks option specifies how the backup operation processes
VMware virtual machine disks (VMDKs) that exceed the maximum disk size.

In version 7.1.4 and later, vmskipmaxvmdks is renamed
vmskipmaxvirtualdisks. Although vmskipmaxvirtualdisks is the preferred
name, the client still processes backup operations with the
vmskipmaxvmdks name.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.


3.4.233 Vmtagdatamover


Use the vmtagdatamover option to enable tagging support in the
backup-archive client (data mover). When this option is enabled, the
client manages backups of virtual machines in VMware inventory objects
according to the data protection tags that are set by the IBM Spectrum
Protect vSphere Client plug-in of the vSphere Web Client, or set with
tools such as VMware vSphere PowerCLI version 5.5 R2 or later.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

For more information about data protection tags, see "Data protection
tagging overview" .

The data mover processes data protection tags when the vmtagdatamover
option is set to yes. Ensure that the following requirements are met.

Requirements:

*  For the data mover:

   *  VMware vCenter Server must be at version 6.0 Update 1 or later.

   *  Extra permissions are required for the account that is used for
      backup or restore operations. These new vCenter permissions are
      required to perform category and tagging operations. Ensure that
      the following user permissions are set on the root vCenter Server:

      Inventory Service > vSphere Tagging > Assign or Unassign vSphere Tag
      Inventory Service > vSphere Tagging > Create vSphere Tag
      Inventory Service > vSphere Tagging > Create vSphere Tag Category
      Inventory Service > vSphere Tagging > Delete vSphere Tag
      Inventory Service > vSphere Tagging > Delete vSphere Tag Category
      Inventory Service > vSphere Tagging > Modify UsedBy Field For Tag
      Inventory Service > vSphere Tagging > Modify UsedBy Field For Category
      Inventory Service > vSphere Tagging > Edit vSphere Tag
      Inventory Service > vSphere Tagging > Edit vSphere Tag Category

      For more information about setting vCenter permissions for backup
      and restore operations, see technote 7047438.

*  In order for the Data Protection for VMware vSphere GUI to function
   correctly with tagging support, ensure that the following
   requirements are met during the installation of the GUI:

   *  At least one data mover and the Data Protection for VMware vSphere
      GUI must be installed on the same server. This data mover node
      must be configured so that the vCenter server credentials are
      saved. You can save the credentials by running the configuration
      wizard to save the data mover node password, or by using the dsmc
      set password command in the data mover command line.

      If you use other data movers, running on virtual machines or
      physical machines as additional data movers, you can install them
      on other servers. For tagging support, all these data movers must
      also be configured with the vmtagdatamover=yes option. These
      additional data movers do not require the Data Protection for
      VMware vSphere GUI to be installed on the same server in order for
      them to work correctly as tag-based data movers.

   *  For Linux data movers, ensure that you specify the data mover
      installation directory and the Java(TM) shared library libjvm.so in
      the LD_LIBRARY_PATH environment variable. The path to libjvm.so is
      used for tagging support when you enable the vmtagdatamover option
      on the data mover. For instructions, see "Setting up the data
      mover nodes in a vSphere environment".

   *  On Linux operating systems, the Data Protection for VMware vSphere
      GUI must be installed by using the default user name (tdpvmware).

   *  On Linux data mover nodes, the default password file
      (/etc/adsm/TSM.sth) must be used.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

You can specify this option in the client system-options file (dsm.sys)
or on the command line for the backup vm command. You can also include
this option on the IBM Spectrum Protect server in a client option set.
You cannot set this option in the Preferences Editor.

Syntax

                   .-No--.
>>-VMTAGDATamover--+-----+-------------------------------------><
                   '-Yes-'



Parameters

No
         The client ignores any data protection settings or tags that
         are attributed to the VMware asset. This value is the default.

Yes
         The client manages backups based on the data protection
         settings in the IBM Spectrum Protect vSphere Client plug-in or
         based on the tag values that are attributed to the VMware
         asset.

         When tagging support is enabled, some client options might be
         affected by the data protection settings. For information about
         which options are affected, see "Supported data protection
         tags".

         The following examples show how client options can be affected
         by data protection tags:

         *  When you use data protection settings or tags to control
            which VMware virtual machines are backed up, the tag values
            might overlap the domain.vmfull client option setting. While
            the domain.vmfull option defines what virtual machines the
            client protects, the Excluded and Included tags override
            what is defined by the domain.vmfull option.

            For example, the following options file statement specifies
            what is backed up during full virtual machine backup
            operations:

            DOMAIN.VMFULL VMHOSTCLUSTER=cluster01,cluster02;VM=Dept20*

            If you use data protection settings or tags to exclude
            virtual machine Dept204, the Dept204 virtual machine is not
            backed up.

         *  The retention policy setting in the IBM Spectrum Protect
            vSphere Client plug-in or the tag setting for the Management
            Class (IBM Spectrum Protect) category overrides the
            include.vm and vmmc client options, but does not override
            the vmctlmc option.

Tip: If you want to set up a data mover as the default data mover, use
the Vmtagdefaultdatamover option.

Examples

Options file:
         vmtagdat yes

Command line:
         -vmtagdat=yes

Related concepts
2.57.1 Data protection tagging overview

Related reference
2.57.1.2 Supported data protection tags
3.4.234 Vmtagdefaultdatamover
3.4.46 Domain.vmfull
3.4.86.4.1 Include.vm
3.4.223 Vmmc
3.4.208 Vmctlmc
2.57 Set Vmtags


3.4.234 Vmtagdefaultdatamover


Use the vmtagdefaultdatamover option to protect virtual machines,
defined in a schedule, that do not have an assigned or inherited Data
Mover category and tag.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

When you specify a data mover node with the vmtagdefaultdatamover option
and the vmtagdatamover yes option, the data mover backs up any new
virtual machines that are added to any container in the datacenter, if
the container is already in a protection set. A protection set consists
of the virtual machines in a container that is assigned the Schedule
(IBM Spectrum Protect) category and tag. The default data mover also
backs up any virtual machines in the protection set that are not
assigned the Data Mover tag.

When more than one data mover is associated with a schedule, define one
data mover as the default data mover with the vmtagdefaultdatamover
option. If only one data mover is associated with a schedule, assign
that data mover as the default.

Tip: For each schedule, specify only one data mover in its associated
data mover list as the default. Otherwise, any new virtual machines and
virtual machines that are not assigned the Data Mover tag will be backed
up more than once.

Data protection tags can be assigned to the vSphere inventory to manage
the protection of virtual machines. For the list of supported categories
and tags, see "Supported data protection tags".

Supported clients

This option can be used with supported x86_64 Linux data movers.

Options file

You can specify this option in the client system-options file (dsm.sys)
or on the command line for the backup vm command. You can also include
this option on the IBM Spectrum Protect server in a client option set.
You cannot set this option in the Preferences Editor.

Syntax

                          .-No------.
>>-VMTAGDEFAULTdatamover--+---------+--------------------------><
                          +-Yes-----+
                          '-dm_name-'



Parameters

No
         The local data mover does not function as a default data mover.
         Virtual machines that are not assigned the Data Mover tag are
         not protected by this data mover. This value is the default.

Yes
         Specifies that the local data mover (the data mover where you
         are specifying this option) functions as the default data
         mover.

         You must also enable the data mover for tagging support by
         specifying the vmtagdatamover yes option.

dm_name
         The name of the data mover that you want to use as the default
         data mover. This option is necessary only if you want to set
         this option in the options file for the default data mover.
         This option is ignored for any data mover that is not the
         default data mover.

         It is possible to pass this option down to all data movers on
         the server schedule command or to include it all data mover
         option files. Only the default data mover uses this option.
         Therefore, define only one default data mover.

         You must also specify the vmtagdatamover yes option in the
         options file on the data mover that you want to designate as
         the default data mover.

Example

Your Windows Data Protection for VMware configuration uses two data
movers, VC1_DC1_DM1 and VC1_DC1_DM2. To designate data mover VC1_DC1_DM1
as the default data mover, complete the following steps:

1. In the options file for data mover VC1_DC1_DM1 (dsm.VC1_DC1_DM1.opt),
   add the following statements:

   vmtagdatamover yes
   vmtagdefaultdatamover yes

   or

   vmtagdatamover yes
   vmtagdefaultdatamover VC1_DC1_DM1

2. In the options file for data mover VC1_DC1_DM2 (dsm.VC1_DC1_DM2.opt),
   add the following statements:

   vmtagdatamover yes
   vmtagdefaultdatamover VC1_DC1_DM1

The vmtagdefaultdatamover option can also be passed to a schedule
definition or command to assign the default data mover. If the default
data mover is defined in the schedule definition, all data movers that
are associated with the schedule will be able to identify the default
data mover for the protection set.

For example: dsmc backup vm -vmtagdefaultdatamover=VC1_DC1_DM1

Related reference
3.4.46 Domain.vmfull
3.4.233 Vmtagdatamover
2.57 Set Vmtags


3.4.235 Vmverifyifaction


Use this option to specify the action to perform if the data mover
detects integrity problems with the latest CTL and bitmap files for a
virtual machine.

This option affects backup processing for a VM guest only when all of
the following conditions are true:

*  The previous backup operation for the VM guest was an
   incremental-forever-incremental backup (mode=ifincremental)

*  The current backup operation for the VM guest is an
   incremental-forever-incremental backup

*  The data mover detected an integrity problem with the CTL and bitmap
   data from the previous incremental-forever-incremental backup
   operation

*  The vmverifyiflatest option is set to yes

If all of these conditions are not true for a virtual machine, the
backup occurs as it normally would; the action that is specified by this
option is not initiated.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported clients

This option is valid for Linux clients that act as a data mover for
VMware guest backups.

Options file

Set this option in the client options file (dsm.opt) or the client
system options file (dsm.sys).

This option can also be included in a client options set, as a parameter
on a backup vm command, or on the options parameter in a schedule
definition.

Syntax

                     .-FAILbackup-.
>>-VMVERIFYIFAction--+------------+----------------------------><
                     +-FORCEfull--+
                     '-PREview----'



Parameters

FAILbackup
         This action fails the backup operation. The following messages
         are written to the data mover error log file (dsmerror.log):

         ANS9921E Virtual machine disk, vm_name (disk_label),
         verification check failed (xxx/yyy).


         The xxx/yyy in the message indicate the size of the bitmap
         (xxx) and CTL files (yyy).

         ANS9919E Failed to find the expected control files for vm_name

         Perform a full VM backup (set -mode=IFFull for the affected
         virtual machines at a time of your choosing. An alternative is
         to use the -vmverifyifaction=forcefull on the next scheduled
         incremental-forever-incremental operation to force a full
         backup of those VMs, if you determine that your scheduled
         backup window can contain the full VM backups for these VMs.
         This value is the default action value.

FORCEfull
         This action changes the backup mode from -mode=ifincremental to
         -mode=iffull; the current backup becomes a full VM backup. The
         full VM backup is initiated for you. The following messages are
         written to the data mover error log file (dsmerror.log):

         ANS9921E Virtual machine disk, vm_name (disk_label),
         verification check failed (xxx/yyy)

         The xxx/yyy in the message indicate the size of the bitmap
         (xxx) and CTL files (yyy).

         ANS9919E Failed to find the expected control files for vm_name


         ANS9922I VMVERIFYIFlatest is enabled for vm_name (action: FORCEFULL).


         ANS9920W Forcing a full vm backup for vm_name

         Use this option if your current backup window can contain a
         full VM backup of the affected virtual machines.

PREview
         This action does not perform any backups. Instead, the CTL and
         bitmap data for each VM guest that is processed by the backup
         vm command is restored to a temporary location, where it is
         checked for integrity. If the integrity check fails, the
         following messages are written to the data mover error log file
         (dsmerror.log):

         ANS9921E Virtual machine disk, vm_name (disk_label),
         verification check failed (xxx/yyy)

         The xxx/yyy in the message indicate the size of the bitmap
         (xxx) and CTL files (yyy).

         ANS9919E Failed to find the expected control files for vm_name


         ANS9922I VMVERIFYIFlatest is enabled for vm_name (action: PREVIEW)



         Use this option to validate the integrity of the
         incremental-forever-incremental backups (-mode=ifincremental)
         that you previously created for one or more a virtual machines.

         If the messages indicate that some VMs failed the integrity
         checks, start a full VM backup (-mode=iffull) at a time of your
         choosing. Alternatively, set -vmverifyifaction=forcefull on the
         next scheduled incremental-forever-incremental operation to
         force a full backup of those VMs. The backup window must be
         large enough to accommodate one or more full VM backups.


3.4.236 Vmverifyiflatest


This option applies only to VMware virtual machine (VM) backup
operations that use the incremental-forever-incremental backup mode
(that is, a backup vm command with -mode=IFIncremental specified). If
this vmverifyiflatest option is enabled, the data mover runs an
integrity check on the CTL and bitmap files that were created on the
server during the last backup, if the last backup was an
incremental-forever-incremental backup.

If the files pass the integrity tests, the virtual machine is
restorable. The current backup proceeds and adds another snapshot to the
chain of snapshots for the virtual machine.

If the files fail the integrity tests, the virtual machine is not
restorable. The data mover then performs another action, which you
specified on the vmverifyifaction option. You can set vmverifyifaction
to create a full VM backup immediately, or you can fail the backup
completely, and run a full VM backup at another time. A third parameter
can be set to just verify the CTL and bitmap files for a virtual
machine, without creating a new backup snapshot.

Verification can be performed only if the previous backup operation for
the VM used mode=IFIncr, and if the current backup operation also uses
mode=IFIncr. This option has no effect on the other virtual machine
backup modes.

Important:

If this option is set to no, VM backup processing continues without any
verification tests. The processing resources that are involved in
performing the integrity checks is negligible. To ensure the continued
integrity of your incremental-forever-incremental backup chain, set or
use the default value (vmverifyiflatest yes). Do not set this option to
no, unless you are directed to do so, by IBM support.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Supported clients

This option is valid for Linux clients that act as a data mover for
VMware guest backups.

Options file

Set this option in the client options file (dsm.opt) or the client
system options file (dsm.sys).

This option can also be included in a client options set, as a parameter
on a backup vm command, or on the options parameter in a schedule
definition.

Syntax

                     .-YES-.
>>-VMVERIFYIFlatest--+-----+-----------------------------------><
                     '-NO--'



Parameters

YES
         This setting specifies that validation of the CTL and the
         bitmap data is performed for each VM that is processed by the
         current incremental-forever-incremental (mode=IFIncr) backup
         operation, if the previous backup operation for that VM was
         also an incremental-forever-incremental backup. This value is
         the default value.

NO
         This setting specifies that validation of CTL and bitmap data
         does not occur during incremental-forever-incremental backup
         processing. Do not set this value unless directed to do so by
         IBM support.

Examples

Options file:
         vmverifyiflatest yes

Command line:
         dsmc backup vm vm1 -mode=ifincremental -vmverifyiflatest=yes


3.4.237 Vmvstorcompr


The vmvstorcompr option controls the use of compression by IBM Spectrum
Protect client during backup and restore operations.

Use this option to increase transport performance by using the NBD
(Network Block Device) protocol.

Three types of compression are available: ZLIB, FASTLZ, and SKIPZ. To
use compression, you must set the transport option to NBDSSL with the
Vmvstortransport option.

NBDSSL compression is available with vSphere 6.5 and above.

Supported clients

This option can be used with supported x86_64 Linux clients.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Options file

This option is valid in the client system options file (dsm.sys), or on
the command line for Backup VM. It can also be included on the server in
a client option set. It cannot be set in the Preferences Editor.

Syntax

>>-VMVSTORCOMPR--+--------+------------------------------------><
                 +-ZLIB---+
                 +-FASTLZ-+
                 '-SKIPZ--'



Parameters

ZLIB
         Sets the type of compression to ZLIB with NBDSSL transport.

FASTLZ
         Sets the type of compression to FASTLZ with NBDSSL transport.

SKIPZ
         Sets the type of compression to SKIPZ with NBDSSL transport.

Examples

Command line:
         To set the type of compression and transport mode for VM backup
         and restore operations with NBDSSL transport, issue the
         following command:

         dsmc backup vm myVM -VMVSTORCOMPR=SKIPZ -VMVSTORTRANSPORT=NBDSSL

         This example backs up the VM myVM using the SKIPZ compression
         protocol with the required transport setting of NBDSSL.

Options file:
         VMVSTORCOMPR SKIPZ

Related reference
2.11 Backup VM
3.4.238 Vmvstortransport


3.4.238 Vmvstortransport


The vmvstortransport option specifies the preferred transports order
(hierarchy) to use when backing up or restoring VMware virtual machines.
If you do not include a given transport using this option, that
transport is excluded and is not used to transfer data.

The transport order that you specify determines how the VMware API for
Data Protection (VADP) accesses virtual disk data, but it does not
influence the data path that is used between the backup-archive client
and the IBM Spectrum Protect server. Valid transports include any order
or combination of the following options:

nbd
         Network based data transfer. Access virtual disk data using the
         LAN. This transport path is generally available in all
         configurations.

nbdssl
         Same as nbd, but the data is encrypted before being sent over
         the LAN. Encryption can decrease performance.

san
         Storage Area Network transfer: Access virtual disk data using
         the SAN.

hotadd
         If you use the backup-archive client in a virtual machine, the
         hotadd transport allows the transport of backed up data to
         dynamically added storage.

Separate each transport option from the others with a colon, for
example, san:nbd:nbdssl:hotadd.

If you do not specify a transport hierarchy, the default transport
selection order is san:hotadd:nbdssl:nbd.

The first transport that is available is used to transfer the data. If
you want to prevent data transport over a particular path, do not
include it in the transport list. For example, if it is important to not
disrupt LAN traffic, omit the nbd transports from the hierarchy.

This feature is available only if the client operates as a data mover
for IBM Spectrum Protect for Virtual Environments: Data Protection for
VMware.

Set this option in dsm.sys.

Supported clients

This option is valid for Linux clients that are configured to back up or
restore virtual machine files using VADP.

Syntax

                     .-,----------.
                     V            |
>>-VMVSTORTransport----+- ------+-+----------------------------><
                       +-NBD----+
                       +-NBDSSL-+
                       +-SAN----+
                       '-HOTADD-'



Examples

If the SAN is available, do not transport backups or restores over the
LAN
         VMVSTORTRANSPORT san

The backup-archive client is running in a virtual machine, but do not
use the hotadd transport
         VMVSTORTRANSPORT nbdssl:nbd

Use the LAN transport, even if nbdssl is available, to obtain better
performance
         VMVSTORTRANSPORT nbd

The SAN transport is preferred, but use nbd when the SAN is not
available, and do not use nbdssl or hotadd
         VMVSTORTRANSPORT san:nbd

Related reference
3.4.237 Vmvstorcompr


3.4.239 Vmtimeout


VMTIMEOut specifies the maximum time, in seconds, to wait before
abandoning a backup vm operation, when the INCLUDE.VMTSMVSS option is
used to provide application protection. To use this option, the IBM
Spectrum Protect for Virtual Environments license must be installed.

Each backup vm operation that is performed on a virtual machine that is
protected by a INCLUDE.VMTSMVSS option is subject to a timer. The timer
value determines how many seconds the client should wait for the
application to quiesce activity and truncate its logs so the backup can
be performed. The default time out value is sufficient for most
environments. However, if your application data cannot be backed up
because the application needs additional time to prepare for the
snapshot, you can increase the time out value. This timer applies only
to backup vm operations when the INCLUDE.VMTSMVSS option is set for a
virtual machine.

Supported clients

This option can be used with supported x86_64 Linux clients.

Options file

Place this option in the client options file. It cannot be set on the
command line or in the Preferences editor.

Syntax

              .-180----------.
>>-VMTIMEout--+-+----------+-+---------------------------------><
                '-time_out-'



Parameters

time_out
         Specifies the time to allow, in seconds, for backup operations
         to complete when a virtual machine is protected by the
         application protection option, INCLUDE.VMTSMVSS. The value
         specified must be an integer between 180 and 500. The default
         is 180 seconds.


Examples

Options file
         VMTIMEout 500

Command line
         Not applicable; this option cannot be set on the command line.

Related reference
3.4.86.4.6 INCLUDE.VMTSMVSS


3.4.240 Webports


The webports option enables the use of the web client outside a
firewall.

The webports option enables the use of the web client outside a firewall
by specifying the TCP/IP port number used by the IBM Spectrum Protect
client acceptor service and web client agent service for communications
with the web client.

Values for both the client acceptor and the web client agent service are
required.

If you do not specify this option, the default value, zero (0), is used
for both ports. This causes TCP/IP to randomly assign a free port number
for the client acceptor and the web client agent service.

Supported Clients

This option is valid for all clients. The IBM Spectrum Protect API does
not support this option.

Options File



Place this option in the dsm.sys file within a server stanza. To set
this option in the Client Preferences editor, click Edit -> Client
Preferences -> Web Client , and specify the ports in the Web Agent Port
and Web Client Acceptor Port fields.



Syntax

>>-WEBPorts-- --cadport-- --agentport------------------------><



Parameters

cadport
         Specifies the required client acceptor port number. The range
         of values is 1000 through 32767. If a value is not specified,
         the default, zero (0), causes TCP/IP to randomly assign a free
         port number.

agentport
         Specifies the required web client agent service port number.
         The range of values is 1000 through 32767. If a value is not
         specified, the default, zero (0), causes TCP/IP to randomly
         assign a free port number.

Examples

Options file:
         webports 2123 2124

Command line:
         Does not apply.


3.4.241 Wildcardsareliteral


The wildcardsareliteral option specifies whether question marks (?) and
asterisks (*) are interpreted literally, when they are included in a
file list specification on a filelist option.

Ordinarily, the client does not accept wildcard characters (?) and (*)
in a file list specification that is included on a filelist option. Some
file systems, such as the IBM Spectrum Scale (formerly GPFS) file
system, allow single and double quotation marks in file and directory
names. To prevent errors that would otherwise occur, when file
specifications are included on a filelist option and they contain
wildcard characters, set wildcardsareliteral yes. When
wildcardsareliteral is set to yes, question marks (?) and asterisks (*)
that are included in a file list specification on the filelist option
are interpreted literally, and not as wildcard characters.

This option applies to any command that accepts a filelist option as
command parameter.

Supported Clients

This option is valid for all supported UNIX and Linux platforms. The
option is applied to any command that takes a file list specification as
a parameter.

Options File

Place this option in the client user options file (dsm.opt).

Syntax

                        .-no------.
>>-WILDCARDSareliteral--+-+-----+-+----------------------------><
                          '-yes-'



Parameters

no
         Specifies that question marks and asterisks are interpreted as
         wildcards when used in a file list specification that is
         included on a filelist option. The default section is No. If a
         file list specification on a filelist option includes a
         question mark or asterisk, an error occurs and the file
         specification cannot be processed.

yes
         Specifies that asterisks and question marks in a file list
         specification that is included on a filelist option are
         interpreted literally, and not as wildcard characters. Specify
         this value if you are backing up files from a file system that
         allows wildcard characters in file or directory names.

Examples

Options file:
         WILDCARDSARELITERAL YES

Command line:
         Assuming that the file system allows wildcard characters in
         paths, the following are examples of files in a file list
         specification that can be successfully processed if
         WILDCARDSARELITERAL is set to YES.
         Assume that the command issued is dsmc sel
         -filelist=/home/user1/important_files, where
         important_files.txt contains the list of files to process.
         important_files.txt contains the following list of files:

         /home/user1/myfiles/file?9000
         /home/user1/myfiles/?file
         /home/user1/myfiles/**README**version2
         /home/user1/myfiles/ABC?file*
         If both WILDCARDSARELITERAL and QUOTESARELITERAL are set to
         YES, the following backups can be successfully processed:

         /home/user1/myfiles/"file?
         /home/user1/myfiles/?file'
         /home/user1/myfiles/**"README Tomorrow"**
         /home/user1/myfiles/file*


4.0 Display a message


To display a message, enter the message number. The prefix is optional.



Example

Task
         Display help information on message ANS1416.

         Command: dsmc help 1416

         Command: dsmc help ANS1416


------------------------------------------------------------------------
ANS0101E

Unable to open English message repository file name.



Explanation:

The default English message repository file cannot be opened. Either the
file access permissions prevent reading the file or the file is not
present in the expected location.

System action:

IBM Spectrum Protect is unable to complete the requested operation.
Processing is terminated.

User response:

Make sure the file in your DSM_DIR is set up properly. If the problem
continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0102W

Unable to open the message repository file name. The American English
repository will be used instead.



Explanation:

The default message repository file for the current locale cannot be
opened. Either the file access permissions prevent reading the file, the
file is not present in the expected location, or the language specified
in the option file is not supported on this workstation.

System action:

IBM Spectrum Protect continues processing using the English language
message repository.

User response:

Make sure the file in your DSM_DIR is set up properly. If the problem
continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0103E

Error trying to read header record from message repository file name.



Explanation:

The message repository file header record cannot be obtained.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the file has not been altered from the installation. If the
problem continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0104I

A message repository is not available for your system's configured
language 'language'. The US English message repository is used instead.



Explanation:

IBM Spectrum Protect does not have language support for the specified
language. Therefore, it uses the US English message repository by
default.

System action:

The US English message repository is used.

User response:

No action is necessary if you want to continue to use US English. If you
want to use a different language that is supported by IBM Spectrum
Protect, then: * (Windows) Add the LANGUAGE option to the client option
file and specify a supported language. For example, to configure the
client to use the French language repository, add the option LANGUAGE
FRA to the client option file. Refer to the reference information for
the LANGUAGE option in the backup-archive client product manual. * (UNIX
and Linux) Set the LANG environment variable to a supported language and
region code. For example, to configure the client to use the French
language repository, set LANG to fr_FR. Refer to the backup-archive
client manual for the supported language codes.

------------------------------------------------------------------------
ANS0105E

Error trying to read index for message number from repository file name.



Explanation:

The message text for the specified message number cannot be read.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the file has not been altered from the installation. If the
problem continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0106E

Message index not found for message number.



Explanation:

The message repository file does not contain the message text for the
message number.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the DSM_DIR is set up properly and it does not point to an old
copy. If the problem continues, see your system administrator for
further help.

------------------------------------------------------------------------
ANS0107E

Error trying to read header for message number from repository file
name.



Explanation:

The message header information cannot be obtained for the message number
in the message file.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the file has not been altered from the installation. If the
problem continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0108E

Error trying to read text for message number from repository file name.



Explanation:

The message text cannot be obtained for the message number in the
message file.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the file has not been altered from the installation. If the
problem continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0109E

Insufficient memory for allocation of message structure.



Explanation:

There is not enough memory in your system to allocate the storage needed
for the message text.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Stop IBM Spectrum Protect and restart IBM Spectrum Protect. Then retry
the operation. If unsuccessful, close all unneeded applications and
retry the operation.

------------------------------------------------------------------------
ANS0110E

Unable to open error log file file name for output.



Explanation:

The error log cannot be opened for output.

System action:

IBM Spectrum Protect is unable to complete the requested operation. File
permissions may be set such that writing is not allowed.

User response:

Stop and restart IBM Spectrum Protect. Then retry the operation. If
unsuccessful, make sure the file is not being locked by another
application and that file permissions allow write access.

------------------------------------------------------------------------
ANS0113E

Message repository file name has an invalid control record.



Explanation:

The message repository file contains an incorrect control information.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the message file was not altered from the installation. Check
DSM_DIR to make sure it is set up properly.

------------------------------------------------------------------------
ANS0118E

Unable to open schedule log file 'file name' for output.



Explanation:

The schedule log file cannot be opened for output.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Stop IBM Spectrum Protect and restart IBM Spectrum Protect. Then retry
the operation. If unsuccessful, make sure the file has not been locked
by another application.

------------------------------------------------------------------------
ANS0119E

Error trying to read response string for message number from repository
file name.



Explanation:

The response string information for the message number cannot be
obtained from the message repository file. It is possible the message
repository has been corrupted.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Make sure the message file was not altered from the installation. Check
DSM_DIR to make sure it is set up properly.

------------------------------------------------------------------------
ANS0120E

Message number number contains an invalid multibyte sequence for the
current locale.



Explanation:

An illegal multibyte sequence for the current locale was found in the
message. Either the message repository has been corrupted or is coded in
a language other than that of the current locale.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

If the message repository is not corrupted, process the operation in the
supported locale.

------------------------------------------------------------------------
ANS0121W

Unable to open the iconv converter for the message repository file name.
The American English repository will be used instead.



Explanation:

The iconv converter for the default message repository for the current
locale cannot be opened. The iconv converter used to convert from UTF-8
to the current locale is not installed on this work station.

System action:

IBM Spectrum Protect continues processing using the English language
message repository.

User response:

Make sure the required iconv converter is installed properly. If the
problem continues, see your system administrator for further help.

------------------------------------------------------------------------
ANS0200E

The virtual machine 'VM-name' was backed up with a later version of the
backup-archive client.



Explanation:

The virtual machine was backed up with a later version of the
backup-archive client. The objects of the virtual machine backup that
were retrieved cannnot be correctly displayed.

System action:

The backup information for the virtual machine will not be displayed.

User response:

Query the virtual machine on a later version of the backup-archive
client to view backup details. If a query of all virtual machines does
not display virtual machines that were backed up at the same client
version, issue the Query VM command for individual virtual machines.

------------------------------------------------------------------------
ANS0201E

Invalid parameter was found.



Explanation:

The system encountered an internal program error due to an invalid
parameter.

System action:

The system returns to the calling procedure.

User response:

Ask your service representative to check the error log.

------------------------------------------------------------------------
ANS0202E

Not authorized to restore the other node's data.



Explanation:

The client is not authorized to restore the other node's data.

System action:

The system returns to the calling procedure.

User response:

Get authorization from the other node.

------------------------------------------------------------------------
ANS0203E

The objName field has no leading directory separator.



Explanation:

The objName field does not have a leading directory separator.

System action:

The system returns to the calling procedure.

User response:

Correct the value for the objName.

------------------------------------------------------------------------
ANS0204E

Wildcards are not allowed in the objName directory path.



Explanation:

Wildcards are not allowed in the objName directory path.

System action:

The system returns to the calling procedure.

User response:

Correct the value for the objName.

------------------------------------------------------------------------
ANS0205E

Unable to open error log file.



Explanation:

The system is unable to open the error log file.

System action:

The system returns to the calling procedure.

User response:

Verify the DSMI_LOG value and access permission. On the AS/400 platform,
verify the value specified for ERRORLOGNAME in the API options file.

------------------------------------------------------------------------
ANS0206E

The log file cannot be written to.



Explanation:

There was an error writing to the log file.

System action:

The system returns to the calling procedure.

User response:

Verify the DSMI_LOG value and access permission. on the AS/400 platform,
verify the value specified for ERRORLOGNAME in the API options file.

------------------------------------------------------------------------
ANS0207E

The log file name was not specified.



Explanation:

The system is unable to open the error log file.

System action:

The system returns to the calling procedure.

User response:

Verify the DSMI_LOG value and access permission. On the AS/400 platform,
verify the value specified for ERRORLOGNAME in the API options file.

------------------------------------------------------------------------
ANS0208E

The TCP/IP WINSOCK.DLL file cannot be found.



Explanation:

The TCP/IP WINSOCK.DLL file cannot be found.

System action:

Processing stopped.

User response:

Verify your TCP/IP installation.

------------------------------------------------------------------------
ANS0209E

An error occurred while loading a library.



Explanation:

An error occurred while loading a library. The TCP/IP DLL load failed.

System action:

Processing stopped.

User response:

Verify your TCP/IP installation.

------------------------------------------------------------------------
ANS0210E

The TCP/IP load function failed.



Explanation:

An error occurred while locating a function. The TCP/IP load function
failed.

System action:

Processing stopped.

User response:

Verify your TCP/IP installation.

------------------------------------------------------------------------
ANS0211E

The object name pointer is NULL.



Explanation:

There is no value provided for the object name pointer.

System action:

The system returns to the calling procedure.

User response:

Provide an address for the dsmObjName structure.

------------------------------------------------------------------------
ANS0212E

The data block pointer is NULL.



Explanation:

There is no value provided for the data block pointer.

System action:

The system returns to the calling procedure.

User response:

Provide an address for the DataBlk structure.

------------------------------------------------------------------------
ANS0213E

The object attribute pointer is NULL.



Explanation:

There is no value provided for the object attribute pointer.

System action:

The system returns to the calling procedure.

User response:

Provide an address for the ObjAttr structure.

------------------------------------------------------------------------
ANS0214E

There is no server session information.



Explanation:

The server did not respond with the session information.

System action:

The system returns to the calling procedure.

User response:

Verify the server status.

------------------------------------------------------------------------
ANS0215E

There is no server policy information.



Explanation:

The server did not respond with the policy information.

System action:

The system returns to the calling procedure.

User response:

Verify the server policy definitions.

------------------------------------------------------------------------
ANS0216E

The dataBlk bufferLen value is zero.



Explanation:

The value for the dataBlk bufferLen is zero.

System action:

The system returns to the calling procedure.

User response:

Provide a non-zero value for the bufferLen.

------------------------------------------------------------------------
ANS0217E

The dataBlk bufferPtr is NULL.



Explanation:

There is no value provided for the dataBlk bufferPtr.

System action:

The system returns to the calling procedure.

User response:

Provide an address for the bufferPtr.

------------------------------------------------------------------------
ANS0218E

The objType is invalid.



Explanation:

The value for the objType is invalid.

System action:

The system returns to the calling procedure.

User response:

The value for dsmObjName.objType must be:

   DSM_OBJ_FILE or DSM_OBJ_DIRECTORY for Backup, or
   DSM_OBJ_FILE for Archive.

------------------------------------------------------------------------
ANS0219E

The dsmEndTxn vote is invalid.



Explanation:

The dsmEndTxn vote is invalid.

System action:

The system returns to the calling procedure.

User response:

The vote must be DSM_VOTE_COMMIT or DSM_VOTE_ABORT.

------------------------------------------------------------------------
ANS0220E

An invalid option was found during option parsing.



Explanation:

An invalid option was found.

System action:

The system returns to the calling procedure.

User response:

Verify the options in dsm.opt, dsm.sys, and the options string. Check
the error log for more details about the error. on the AS/400 platform,
verify the options in *LIB/QOPTIBM Spectrum Protect(APIOPT).

------------------------------------------------------------------------
ANS0221E

There was an error in the IBM Spectrum Protect API internals.



Explanation:

The system encountered an error in the API internals.

System action:

The system returns to the calling procedure.

User response:

Shut down the process and retry the operation. Verify that any previous
dsmInit calls were cleaned up and terminated by a dsmTerminate call. If
the problem continues, contact your system administrator or service
representative.

------------------------------------------------------------------------
ANS0222E

The repository type is invalid.



Explanation:

The repository type is invalid.

System action:

The system returns to the calling procedure.

User response:

For dsmDeleteFS the repository must be one of the following:

*  DSM_ARCHIVE_REP

*  DSM_BACKUP_REP

*  DSM_REPOS_ALL.

------------------------------------------------------------------------
ANS0223E

Filespace name should start with the directory delimiter.



Explanation:

The filespace name is invalid.

System action:

The system returns to the calling procedure.

User response:

Filespace name should start with the directory delimiter.

------------------------------------------------------------------------
ANS0224E

The object name is either an empty string or has no leading delimiter.



Explanation:

The object name is invalid because of an empty string or there is no
leading delimiter.

System action:

The system returns to the calling procedure.

User response:

Verify the format of the dsmObjName full path.

------------------------------------------------------------------------
ANS0225E

Low level qualifier of the object name should start with the directory
delimiter.



Explanation:

The low level qualifier for the object name is invalid.

System action:

The system returns to the calling procedure.

User response:

Start the low level qualifier of the object name with the directory
delimiter.

------------------------------------------------------------------------
ANS0226E

The object owner is invalid.



Explanation:

The object owner must be either the root user, or the object owner must
be the same as the session owner.

System action:

The system returns to the calling procedure.

User response:

Verify the session owner and object owner.

------------------------------------------------------------------------
ANS0227E

The dsmBindMC sendType is invalid.



Explanation:

The dsmBindMC sendType is invalid.

System action:

The system returns to the calling procedure.

User response:

The sendType must be one of the following:

   stBackup
   stArchive
   stBackupMountWait
   stArchiveMountWait

------------------------------------------------------------------------
ANS0228E

The dsmSendObj sendType is invalid.



Explanation:

The dsmSendObj sendType is invalid.

System action:

The system returns to the calling procedure.

User response:

The sendType must be one of the following:

   stBackup
   stArchive
   stBackupMountWait
   stArchiveMountWait

------------------------------------------------------------------------
ANS0229E

The dsmDeleteObj delType is invalid.



Explanation:

The dsmDeleteObj delType is invalid.

System action:

The system returns to the calling procedure.

User response:

The delType must be dtBackup or dtArchive.

------------------------------------------------------------------------
ANS0230E

The query Backup objState is invalid.



Explanation:

The query Backup objState is invalid.

System action:

The system returns to the calling procedure.

User response:

The qryBackupData.objState must be one of the following:

   DSM_ACTIVE
   DSM_INACTIVE
   DSM_ANY_MATCH

------------------------------------------------------------------------
ANS0231E

The management class name was not found.



Explanation:

A query or send operation is unable to find the management class name.

System action:

The system returns to the calling procedure.

User response:

Verify the management class name.

------------------------------------------------------------------------
ANS0232E

The drive letter is not an alphabetic character.



Explanation:

The drive letter is not an alphabetic character. This return code is
valid on Microsoft Windows only.

System action:

The system returns to the calling procedure.

User response:

Verify that the drive designation is an alphabetic character. The
referenced field is dsmDosFSAttrib.driveLetter.

------------------------------------------------------------------------
ANS0233E

The Register Filespace name is NULL.



Explanation:

There is no value provided for the Register Filespace name.

System action:

The system returns to the calling procedure.

User response:

Provide a filespace name on dsmRegisterFS.

------------------------------------------------------------------------
ANS0234E

The new password value is NULL or blank.



Explanation:

There is no value provided for new password.

System action:

The system returns to the calling procedure.

User response:

Provide a new password on dsmChangePW.

------------------------------------------------------------------------
ANS0235E

The old password value is NULL or blank.



Explanation:

There is no value provided for old password.

System action:

The system returns to the calling procedure.

User response:

Provide an old password on dsmChangePW.

------------------------------------------------------------------------
ANS0236E

On dsmInit, the owner is not allowed to establish a session when
PASSWORDACCESS=generate.



Explanation:

PASSWORDACCESS=GENERATE establishes a session with the current login
user as the owner. The application should set clientOwnerNameP to NULL
when PASSWORDACCESS=GENERATE is in effect.

System action:

The system returns to the calling procedure. Whether the application can
continue processing depends on how the application handles the error.

User response:

This message applies to applications that utilize the IBM Spectrum
Protect API, and is intended primarily for the vendor of the application
for which the message is issued. Depending on the application, this
could be a configuration issue.

Consult the documentation for the application and verify that the
application is configured correctly. If the problem persists, contact
the application vendor for further assistance.

------------------------------------------------------------------------
ANS0237E

On dsmInit, the node is not allowed when PASSWORDACCESS=generate.



Explanation:

PASSWORDACCESS=generate establishes a session with the current hostname
as the node.

System action:

The system returns to the calling procedure.

User response:

When using PASSWORDACCESS=generate, set clientNodeNameP to NULL.

------------------------------------------------------------------------
ANS0238E

The sequence of calls is invalid.



Explanation:

Then API requires function calls to be made in a specific sequence. The
function calls were not made in the expected sequence. The error can be
triggered by the following issues:

*  An error in the network.

*  A bug in the IBM Spectrum Protect API.

*  A bug in the IBM Spectrum Protect server.

*  A bug in the application (IBM or third party) that uses the IBM
   Spectrum Protect API.

System action:

The system returns to the calling procedure.

User response:

An end user can respond in the following ways:

*  Check the network for errors.

*  Look for clues in the IBM Spectrum Protect server activity log file,
   client side dsierror.log log file, and log files that are specific to
   the problem application.

*  Search the IBM support pages for APARs that match the problem. The
   support site is at IBM Spectrum Protect Support Portal
   (https://www.ibm.com/mysupport/s/topic/0TO50000000IQWvGAO/spectrum-protect)

*  If the API application is developed by a third party (not IBM),
   search that third party's support pages for known issues that match
   the problem.

If none of the above actions resolve the problem, report the problem to
the vendor of the application that uses the IBM Spectrum Protect API.

A developer of an application that uses the IBM Spectrum Protect API
must investigate the reason for the problem, including reviewing the IBM
Spectrum Protect API state diagram. The IBM Spectrum Protect API state
diagram is in the product documentation at IBM Spectrum Protect product
documentation (https://www.ibm.com/docs/en/spectrum-protect/8.1.13)

------------------------------------------------------------------------
ANS0239E

On dsmSendObj, wildcards are not allowed for the objName.



Explanation:

On dsmSendObj, wildcards are not allowed for the objName.

System action:

The system returns to the calling procedure.

User response:

Provide a fs, hl, and ll on the dsmObjName.

------------------------------------------------------------------------
ANS0240E

The filespace to delete/set access cannot be found.



Explanation:

The filespace to delete cannot be found.

System action:

The system returns to the calling procedure.

User response:

Verify the filespace name.

------------------------------------------------------------------------
ANS0241E

On dsmSendObj, dsmDeleteObj, or dsmUpdateFS the filespace is not
registered.



Explanation:

On dsmSendObj, dsmDeleteObj, or dsmUpdateFS, the filespace is not
registered.

System action:

The system returns to the calling procedure.

User response:

Verify the filespace name.

------------------------------------------------------------------------
ANS0242W

On dsmRegisterFS the filespace is already registered.



Explanation:

On dsmRegisterFS the filespace is already registered.

System action:

The system returns to the calling procedure.

User response:

Verify the filespace name.

------------------------------------------------------------------------
ANS0243E

On dsmBeginGetData the objID is NULL.



Explanation:

On dsmBeginGetData, the objID is NULL.

System action:

The system returns to the calling procedure.

User response:

Verify the following:

   The dsmGetList is not NULL.
   Each objID is not NULL.
   The dsmGetList numObjId is not zero.

------------------------------------------------------------------------
ANS0244E

On dsmInit, the caller API version is different than the IBM Spectrum
Protect library version.



Explanation:

On dsmInit, the caller API version is later than the IBM Spectrum
Protect library version.

System action:

The system returns to the calling procedure.

User response:

Install the latest IBM Spectrum Protect API library.

------------------------------------------------------------------------
ANS0245E

The caller's structure version is different than the IBM Spectrum
Protect library version.



Explanation:

The caller's structure version is different than the IBM Spectrum
Protect library version.

System action:

The system returns to the calling procedure.

User response:

Ensure that the stVersion field is set with the value in the header
file. Recompile the application with the latest header files.

------------------------------------------------------------------------
ANS0246E

Issue dsmEndTxn and then begin a new transaction session.



Explanation:

This transaction must be ended and a new one must be started due to one
of the following reasons:

   The destination changed.
   The byte limit is exceeded
   The maximum number of objects is exceeded.

System action:

The system returns to the calling procedure.

User response:

Issue dsmEndTxn and start a new transaction session.

------------------------------------------------------------------------
ANS0247E

The backup or archive object is excluded from processing.



Explanation:

The backup or archive object is excluded from processing.

System action:

The system returns to the calling procedure.

User response:

Verify the objName and Exclude lists.

------------------------------------------------------------------------
ANS0248E

The backup object does not have a copy group.



Explanation:

The backup object does not have a copy group.

System action:

The system returns to the calling procedure.

User response:

Verify server policy definitions.

------------------------------------------------------------------------
ANS0249E

The archive object does not have a copy group.



Explanation:

The archive object does not have a copy group.

System action:

The system returns to the calling procedure.

User response:

Verify server policy definitions.

------------------------------------------------------------------------
ANS0250E

Memory used by the IBM Spectrum Protect API has been corrupted.



Explanation:

Memory used by the IBM Spectrum Protect API has been corrupted.

System action:

The system returns to the calling procedure.

User response:

Retry the operation. If the problem continues, contact your system
administrator or service representative.

------------------------------------------------------------------------
ANS0251E

The sendObj Archive description is too long.



Explanation:

The sendObj Archive description is too long.

System action:

The system returns to the calling procedure.

User response:

The sndArchiveData.descr string must be less than or equal to
DSM_MAX_DESCR_LENGTH.

------------------------------------------------------------------------
ANS0252E

The sendObj ObjAttr.objInfo is too long.



Explanation:

The sendObj ObjAttr.objInfo is too long.

System action:

The system returns to the calling procedure.

User response:

The objInfo field must be less than or equal to DSM_MAX_OBJINFO_LENGTH.

------------------------------------------------------------------------
ANS0253E

The sendObj dsmObjName.hl is too long.



Explanation:

The sendObj dsmObjName.hl is too long.

System action:

The system returns to the calling procedure.

User response:

The hl field must be less than or equal to DSM_MAX_HL_LENGTH.

------------------------------------------------------------------------
ANS0254E

The password, or encryptionPassword string provided is too long.



Explanation:

The value provided for password or encryptionPassword is too long.

System action:

The system returns to the calling procedure.

User response:

The password or encrypionPassword field must be less than
DSM_MAX_VERIFIER_LENGTH.

------------------------------------------------------------------------
ANS0255E

The sendObj dsmObjName.fs is too long.



Explanation:

The sendObj dsmObjName.fs is too long.

System action:

The system returns to the calling procedure.

User response:

The fs field must be less than or equal to DSM_MAX_FS_LENGTH.

------------------------------------------------------------------------
ANS0256E

The sendObj dsmObjName.ll is too long.



Explanation:

The sendObj dsmObjName.ll is too long.

System action:

The system returns to the calling procedure.

User response:

The ll field must be less than or equal to DSM_MAX_LL_LENGTH.

------------------------------------------------------------------------
ANS0257E

On RegisterFS or UpdateFS the fsAttr's fsInfo is too long.



Explanation:

On RegisterFS or UpdateFS the fsAttr's fsInfo is too long.

System action:

The system returns to the calling procedure.

User response:

The fsInfo field must be less than or equal to DSM_MAX_FSINFO_LENGTH.

------------------------------------------------------------------------
ANS0258I

On dsmGetNextQObj or dsmGetData there is more available data.



Explanation:

On dsmGetNextQObj or dsmGetData there is more available data.

System action:

The system returns to the calling procedure.

User response:

Call the function again.

------------------------------------------------------------------------
ANS0259E

The dataBlk buffer is too small for the query response.



Explanation:

The dataBlk buffer is too small for the query response.

System action:

The system returns to the calling procedure.

User response:

On dsmGetNextQObj ensure that the dataBlk buffer is at least as big as
the query response structure.

------------------------------------------------------------------------
ANS0260E

An invalid option keyword was found during option parsing.



Explanation:

An invalid option keyword was found in the dsmInit configuration file,
the option string, dsm.sys, or dsm.opt.

System action:

The system returns to the calling procedure.

User response:

Correct the spelling of the option keywords. Verify that the dsmInit
configuration file only has a subset of the dsm.sys options. Check the
error log for more details about the error.

------------------------------------------------------------------------
ANS0261E

The configuration file specified on dsmInit cannot be opened.



Explanation:

The configuration file specified on dsmInit cannot be opened.

System action:

The system returns to the calling procedure.

User response:

Verify the file name.

------------------------------------------------------------------------
ANS0262E

The Include/Exclude definition file was not found.



Explanation:

The Include/Exclude definition file was not found.

System action:

The system returns to the calling procedure.

User response:

Verify the file name on the Inclexcl option.

------------------------------------------------------------------------
ANS0263E

Either the dsm.sys file was not found, or the Inclexcl file specified in
dsm.sys was not found.



Explanation:

Either the dsm.sys file was not found, or the Inclexcl file specified in
dsm.sys was not found.

System action:

The system returns to the calling procedure.

User response:

The dsm.sys file must be in the directory referenced by the environment
variable DSMI_DIR. Verify the file name on the Inclexcl option in the
dsm.sys file.

------------------------------------------------------------------------
ANS0264E

Only a UNIX root user can execute dsmChangePW or dsmDeleteFS.



Explanation:

Only a UNIX root user can execute dsmChangePW or dsmDeleteFS.

System action:

The system returns to the calling procedure.

User response:

Run this program as a root user.

------------------------------------------------------------------------
ANS0265E

You must issue dsmBindMC before dsmSendObj.



Explanation:

You must issue dsmBindMC before dsmSendObj.

System action:

The system returns to the calling procedure.

User response:

Modify your program.

------------------------------------------------------------------------
ANS0266I

The dsmEndTxn vote is ABORT, so check the reason field.



Explanation:

After a dsmEndTxn call, the transaction is aborted by either the server
or client with a DSM_VOTE_ABORT and the reason is returned.

System action:

The system returns to the calling procedure.

User response:

Check the reason field for the code which explains why the transaction
has been aborted.

------------------------------------------------------------------------
ANS0267E

Invalid command line option/value: 'option'



Explanation:

The option is not valid on this command line.

System action:

Processing stops

User response:

Verify that the option and value are not misspelled and are valid with
the current command.

------------------------------------------------------------------------
ANS0268E

Server problem: Destination not defined.



Explanation:

Server problem: Destination not defined.

System action:

Processing stopped.

User response:

Have your service representative check the error log.

------------------------------------------------------------------------
ANS0270S

The data buffer overflowed.



Explanation:

The data buffer overflowed. This is a programming failure and the client
program ends.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, contact your system
administrator.

------------------------------------------------------------------------
ANS0271E

No more files can be restored or retrieved since the destination
directory is full.



Explanation:

No more files can be restored or retrieved since the destination
directory is full.

System action:

Processing stopped.

User response:

Free up disk space, or restore or retrieve the file to another disk.

------------------------------------------------------------------------
ANS0272I

The operation is finished.



Explanation:

The operation is finished.

System action:

The system returns to the calling procedure.

User response:

Proceed with next function call.

------------------------------------------------------------------------
ANS0273E

The dsmtca execution/owner permissions are invalid.



Explanation:

The dsmtca execution/owner permissions are invalid.

System action:

Processing stopped.

User response:

Have your system administrator check the installation instructions for
the client to ensure that the dsmtca permissions are set correctly.

------------------------------------------------------------------------
ANS0274S

Process killed.



Explanation:

Processing stopped. This is a programming failure and the client program
ends.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, contact your system
administrator.

------------------------------------------------------------------------
ANS0275S

The dsmtca would block the operation.



Explanation:

The dsmtca blocks the operation. This is a programming failure and the
client program ends.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, contact your system
administrator.

------------------------------------------------------------------------
ANS0276S

The area for the include/exclude pattern is too small.



Explanation:

The area for the include/exclude pattern is too small. This is a
programming failure and the client program ends.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, contact your system
administrator.

------------------------------------------------------------------------
ANS0277S

There is no closing bracket in the pattern.



Explanation:

There is no closing bracket in the pattern. This is a programming
failure and the client program ends.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, contact your system
administrator.

------------------------------------------------------------------------
ANS0278S

The transaction will be aborted.



Explanation:

The server encountered an error and will abort the transaction.

System action:

The transaction will be aborted. The reason code is passed on the
dsmEndTxn call.

User response:

Issue the dsmEndTxn with a vote of DSM_VOTE_COMMIT and examine the
reason code.

------------------------------------------------------------------------
ANS0279I

A file was skipped during a restore operation because the file is off
line and the application has chosen not to wait for a tape mount.



Explanation:

A file was skipped during a restore operation because the file is off
line and the application has chosen not to wait for a tape mount.

System action:

File skipped.

User response:

Verify the application sets the mountWait value correctly on
dsmBeginGetData.

------------------------------------------------------------------------
ANS0280E

Unable to find the dsmtca module.



Explanation:

IBM Spectrum Protect was unable to find the dsmtca module in the
specified directory.

System action:

Processing ends.

User response:

Make sure the dsmtca module is in the directory specified by DSMI_DIR.

------------------------------------------------------------------------
ANS0282E

Password file is not available.



Explanation:

The file containing the stored password for the specified server-name is
unavailable.

System action:

Processing ends.

User response:

The root user must set and store a new password.

------------------------------------------------------------------------
ANS0283E

High level qualifier of the object name should start with the directory
delimiter.



Explanation:

The high level qualifier for the object name is invalid.

System action:

The system returns to the calling procedure.

User response:

High level qualifier of the object name should start with the directory
delimiter.

------------------------------------------------------------------------
ANS0284E

The number of objects on dsmBeginGetData exceeds DSM_MAX_GET_OBJ |
DSM_MAX_PARTIAL_GET_OBJ.



Explanation:

The number of objects (numObjId) specified on the dsmBeginGetData call
exceeds DSM_MAX_GET_OBJ | DSM_MAX_PARTIAL_GET_OBJ.

System action:

The system returns to the calling procedure.

User response:

Check the number of objects before calling dsmBeginGetData. If it is
greater than DSM_MAX_GET_OBJ | DSM_MAX_PARTIAL_GET_OBJ, then issue
multiple Get call sequences.

------------------------------------------------------------------------
ANS0285E

The update action is invalid.



Explanation:

The dsmUpdateFS or dsmUpdateObj action is invalid.

System action:

The system returns to the calling procedure.

User response:

Correct the action value. Valid values are defined in dsmapitd.h and
documented in our Using the API book.

------------------------------------------------------------------------
ANS0286E

The key file is missing.



Explanation:

The key file for Data Protection for Oracle cannot be found.

System action:

The system returns to the calling procedure.

User response:

Ensure that you have ordered the Data Protection for Oracle, and install
the key file.

------------------------------------------------------------------------
ANS0287E

The key file content is invalid.



Explanation:

The key file content for Data Protection for Oracle is invalid.

System action:

The system returns to the calling procedure.

User response:

Ensure that you have ordered the Data Protection for Oracle, and install
the key file.

------------------------------------------------------------------------
ANS0296I

Encryption key passwords are not the same. Please try again...



Explanation:

Encryption key passwords do not match.

System action:

You are prompted for the encryption key password.

User response:

Enter the correct encryption key password.

------------------------------------------------------------------------
ANS0297E

Error opening specified file.



Explanation:

The specified file could not be located or opened.

System action:

Attempts to open file failed.

User response:

Make sure the file exists.

------------------------------------------------------------------------
ANS0298E

Session Rejected: The specified user id is currently locked



Explanation:

The user id you specified is currently locked on the server.

System action:

Session was not started.

User response:

Check with your system administrator to find out why your user id is
locked.

------------------------------------------------------------------------
ANS0299E

Scheduler cannot be started manually because the value of
MANAGEDSERVICES option is SCHEDULE.



Explanation:

if MANAGEDSERVICES SCHEDULE is indicated in the option file, the IBM
Spectrum Protect scheduler cannot be started in the traditional manner.

System action:

Scheduler stopped.

User response:

If you are not going to use dsmcad to manage the schedule anymore, stop
dsmcad and remove MANAGEDSERVICES option from the option file.

------------------------------------------------------------------------
ANS0302I

Successfully done.



Explanation:

The operation successfully completed.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS0304E

The password is too short.



Explanation:

The new password does not have enough characters.

System action:

The password is not updated on the server.

User response:

Choose a different password. Contact your IBM Spectrum Protect
administrator to lean the password requirements.

------------------------------------------------------------------------
ANS0305E

It is too soon after the previous update to change the password.



Explanation:

The password cannot be changed since not enough time has elapsed since
the last password update.

System action:

The password is not updated on the server.

User response:

Try to change your password again later.

------------------------------------------------------------------------
ANS0306E

The password was previously used.



Explanation:

The new password that you entered was previously used.

System action:

The password is not updated on the server.

User response:

Choose a different password.

------------------------------------------------------------------------
ANS0307E

The password does not meet the requirements.



Explanation:

The new password that you entered does not meet the requirements, such
as the number of special characters or digits.

System action:

The password is not updated on the server.

User response:

Choose a different password. Contact your IBM Spectrum Protect
administrator to learn the password requirements.

------------------------------------------------------------------------
ANS0308E

Remote operation failed to start on obj-name. Status: status reason:
reason



Explanation:

The request to start a remote operation has failed for the indicated
node and file space. The status and the reason for the failure are
shown.

System action:

Processing ends.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0309E

Remote operation failed to start on obj-name. Status: status



Explanation:

The request to start a remote operation has failed for the indicated
node and file space. The status of the failure is shown.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0311E

The tsmBuffHandle is invalid, or the value of dataPtr is invalid.



Explanation:

An invalid value for a handle or dataPtr has been passed into the API.

System action:

The system returns to the calling procedure.

User response:

There is a problem with the calling application. Verify the values of
the tsmBuffHandle and dataptr passed to the API.

------------------------------------------------------------------------
ANS0312E

The number of bytes copied into the tsmBuffer is larger than the allowed
value.



Explanation:

An invalid number of bytes was copied to a tsmBuffer.

System action:

The system returns to the calling procedure.

User response:

There is a problem with the calling application. Verify the number of
bytes copied into the tsmBuffer.

------------------------------------------------------------------------
ANS0313E

dsmTerminate cannot finish because the application is holding on to 1 or
more tsmBuffers.



Explanation:

An application is trying to terminate a session, but is still holding
some tsmBuffers.

System action:

The system returns to the calling procedure.

User response:

The application must return all buffers for this session by calling
tsmReleaseBuffer, and then issue dsmTerminate.

------------------------------------------------------------------------
ANS0314E

An internal error occurred in the tsmBuffer array.



Explanation:

An internal API buffer array error occurred.

System action:

The system returns to the calling procedure.

User response:

Try the operation again. If the problem continues, contact your system
administrator or service representative.

------------------------------------------------------------------------
ANS0315E

Unable to open message text file.



Explanation:

The system is unable to open the message txt file (dscenu.txt or
dsmclientV3.cat for AIX). On the AS/400 platform this file is
QANSAPI/QAANSENU(TXT).

System action:

The system returns to the calling procedure.

User response:

Verify that the dscenu.txt file is in the directory pointed to by
DSMI_DIR. For AIX, verify that the dsmclientV3.cat file has a symbolic
link to /usr/lib/nls/msg/<locale>/dsmclientV3.cat .

------------------------------------------------------------------------
ANS0316E

Unable to use message text file.



Explanation:

The system is unable to use the message text file (dscenu.txt or
dsmclientV3.cat for AIX) because of an invalid header. On the AS/400
platform this file is QANSAPI/QAANSENU(TXT).

System action:

The system returns to the calling procedure.

User response:

Install the message text file again.

------------------------------------------------------------------------
ANS0317E

Unable to use message text file.



Explanation:

The system is unable to use the message txt file (dscenu.txt or
dsmclientV3.cat for AIX) because of an invalid control record. On the
AS/400 platform this file is QANSAPI/QAANSENU(TXT).

System action:

The system returns to the calling procedure.

User response:

Install the message text file again.

------------------------------------------------------------------------
ANS0318E

Invalid value for DATEFORMAT specified.



Explanation:

An invalid value is specified for DATEFORMAT.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0319E

Invalid value for TIMEFORMAT specified.



Explanation:

An invalid value is specified for TIMEFORMAT.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0320E

Invalid value for NUMBERFORMAT specified.



Explanation:

An invalid value is specified for NUMBERFORMAT.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0321E

msg parameter for dsmRCMsg is a NULL pointer.



Explanation:

The message parameter for dsmRCMsg is a NULL pointer.

System action:

The system returns to the calling procedure.

User response:

Allocate enough space for the message parameter.

------------------------------------------------------------------------
ANS0322E

no text available for this return code.



Explanation:

The dsmRC parameter for dsmRCMsg is an unsupported return code.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0323E

partialObjOffset value for partial object retrieve is invalid.



Explanation:

The partialObjOffset value for partial object retrieve is invalid.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0324E

partialObjLength value for partial object retrieve is invalid.



Explanation:

partialObjLength value for partial object retrieve is invalid.

System action:

The system returns to the calling procedure.

User response:

Specify a valid value.

------------------------------------------------------------------------
ANS0325E

Partial Object Retrieve is not supported on this server.



Explanation:

The IBM Spectrum Protect server specified by the user does not support
partial object retrieve.

System action:

The system returns to the calling procedure.

User response:

Specify a IBM Spectrum Protect server which supports the partial object
retrieve function.

------------------------------------------------------------------------
ANS0326E

This node has exceeded its maximum number of mount points.



Explanation:

Either no tape or sequential disk mount points are permitted for this
operation, or the maximum number of mount points allowed are already in
use. The operation can not be completed. The IBM Spectrum Protect
administrator defines the maximum number of mount points with the
MAXNUMMP property of your node definition.

System action:

The object is skipped

User response:

If you are performing any other operations that might be using mount
points, wait until those operations are complete, then try the failed
operation again. Otherwise contact your IBM Spectrum Protect
administrator for further assistance

------------------------------------------------------------------------
ANS0327E

A duplicate object was found, operation cannot complete.



Explanation:

A duplicate object was found, operation cannot complete.

System action:

The requested operation failed.

User response:

Try the operation with a different file specification.

------------------------------------------------------------------------
ANS0328E

The specified objects failed the merge test.



Explanation:

The specified objects failed the merge test, operation cannot complete.

System action:

The requested operation failed.

User response:

See documentation for the merge test parameters.

------------------------------------------------------------------------
ANS0330E

The dsmSetAccess access Type is invalid.



Explanation:

The dsmSetAccess accessType is invalid.

System action:

The system returns to the calling procedure.

User response:

The accessType must be one of the following:

   atBackup
   atArchive

------------------------------------------------------------------------
ANS0331E

No files have been previously backed up for this filename/filespace.



Explanation:

You tried to set access to files when no files for the specified
filename, drive or file system were previously backed up.

System action:

Processing stopped.

User response:

Ensure that the correct drive or file system was specified and that
files are backed up for you to set access.

------------------------------------------------------------------------
ANS0332E

No files have been previously archived for this filename/filespace.



Explanation:

You tried to set access to files when no files for the specified
filename, drive or file system were previously archived.

System action:

Processing stopped.

User response:

Ensure that the correct drive or file system was specified and that
files are archived for you to set access.

------------------------------------------------------------------------
ANS0333E

Unknown Remote Mover type



Explanation:

The specified Remote Mover type is unknown.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0334E

An Operation for the requested node and file space is already in
progress.



Explanation:

A request has been made to use a data mover to perform an operation for
the indicated node and file space. Since an operation for this node and
file space is already in progress, the new operation cannot be
performed.

System action:

Current operation has ended.

User response:

Retry the operation at a later time.

------------------------------------------------------------------------
ANS0335E

System resource in use



Explanation:

A required resource is in use by another command or process.

System action:

Current operation has ended.

User response:

Retry the operation at a later time.

------------------------------------------------------------------------
ANS0336E

Server plugin communication error



Explanation:

Communication between a server plugin module and a NAS filer failed.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0337E

Server plugin detected unsupported NAS filer operating system.



Explanation:

A plugin module detected that a NAS filer is running an unsupported
operating system or operating system level.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0338E

An invalid operation was attempted on a node



Explanation:

The operation is not valid.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0339E

The specified target storage pool is not defined.



Explanation:

The storage pool is not defined.

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0340E

A target storage pool does not have the correct data format for the
given node type.



Explanation:

none

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0341E

No associated data mover is defined for the given node.



Explanation:

none

System action:

Current operation has ended.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS0342E

The CRC received from the Server does not match the CRC calculated by
the client.



Explanation:

The server sent a CRC for a buffer. The client calculated a CRC for the
same buffer. These did not match. The mismatch indicates a communication
failure.

System action:

In some cases, the client can indicate the failure to the server and
retry the operation.

User response:

Check the trace log for additional information and retry the operation.
If the problem persists, contact your system administrator.

------------------------------------------------------------------------
ANS0343E

An invalid operation was attempted on a group leader or group member.



Explanation:

An invalid operation was attempted on a logical group.

System action:

The current operation stops.

User response:

Retry a valid operation.

------------------------------------------------------------------------
ANS0344E

Cannot Send data with a zero byte sizeEstimate.



Explanation:

You cannot send data for an object with size estimate = 0.

System action:

The system returns to the calling procedure.

User response:

Set size estimate greater than 0 in dsmSendObj.

------------------------------------------------------------------------
ANS0345E

Remote disk not defined.



Explanation:

An operation was attempted on a remote disk that is not defined.

System action:

The current operation stops.

User response:

Define the proper remote disk.

------------------------------------------------------------------------
ANS0346E

Input destination does not match expected destination.



Explanation:

Input destination does not match expected destination.

System action:

The current operation stops.

User response:

Retry operation with proper destination.

------------------------------------------------------------------------
ANS0347E

Data mover is not available.



Explanation:

Data mover is not available.

System action:

The current operation stops.

User response:

Retry operation with a proper Data mover.

------------------------------------------------------------------------
ANS0348E

Operation failed because the copy continue option was set to NO.



Explanation:

Operation failed because the copy continue option was set to NO.

System action:

The current operation stops.

User response:

This abort code indicates that a store operation, like backup or archive
failed because the copy continue option was set to NO. The sysadmin will
need to resolve the problem on the server end.

------------------------------------------------------------------------
ANS0349E

Transaction failed because of a problem during a store operation.



Explanation:

Transaction failed because of a problem during a store operation. This
error is typical when the next storage pool has a different copy storage
pool list and we switch to this pool in the middle of a transaction.

System action:

Transaction is aborted.

User response:

Resend objects in separate transactions.

------------------------------------------------------------------------
ANS0350E

The current client configuration does not comply with the value of the
DATAWRITEPATH or DATAREADPATH server option for this node.



Explanation:

The values of the DATAWRITEPATH and DATAREADPATH server options specify
where the client is allowed to send data, and where data is read from.
The values for the specified node name should correspond with the client
configuration. For example, you will get this error message if
DATAWRITEPATH contains a LAN value and the client is configured to use
LAN-free protocol, or vice versa.

System action:

Processing stopped.

User response:

Check the client, server, and storage agent logs to determine why the
client was not able to send data LAN-free. Make sure the client
configuration and server options are compatible.

------------------------------------------------------------------------
ANS0351E

The node or user does not have proper authority to perform this
operation



Explanation:

The node or user does not have proper authority to perform this
operation.

System action:

The transaction is ended.

User response:

Check the authority for the specified object.

------------------------------------------------------------------------
ANS0352E

The operation is not permitted due to server licenses values.



Explanation:

The node or user is trying to perform an operation that either exceeds
license values, or is not licensed.

System action:

The session is rejected or the transaction is cancelled, ending the
current operation.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS0353E

When using useTsmBuffers, dataBlk must be NULL in calls to dsmSendObj
and dsmGetObj.



Explanation:

The value for dataBlk must be NULL when using useTsmBuffers.

System action:

The system returns to the calling procedure.

User response:

There is a problem with the calling application. Contact your
application provider

------------------------------------------------------------------------
ANS0354E

Encryption is not allowed when using useTsmBuffers.



Explanation:

useTsmBuffers does not support encryption.

System action:

The system returns to the calling procedure.

User response:

Try the operation again, without using useTsmBuffers, or disable
encryption for this operation.

------------------------------------------------------------------------
ANS0355E

This object cannot be restored/retrieved using useTsmBuffers, because it
is compressed.



Explanation:

useTsmBuffers does not support compression.

System action:

The system returns to the calling procedure.

User response:

Try the operation again, without using useTsmBuffers.

------------------------------------------------------------------------
ANS0356E

This object cannot be restored/retrieved using useTsmBuffers, because it
is encrypted.



Explanation:

useTsmBuffers does not support encryption.

System action:

The system returns to the calling procedure.

User response:

Try the operation again, without using useTsmBuffers.

------------------------------------------------------------------------
ANS0357E

When using useTsmBuffers, a restore/retrieve with partial object restore
is not allowed.



Explanation:

useTsmBuffers does not support partial object restore.

System action:

The system returns to the calling procedure.

User response:

Make sure the calling application is either using Partial object restore
or useTsmBuffers.

------------------------------------------------------------------------
ANS0358E

No encryption key was found. If you are using -encryptkey=prompt make
sure there is a value in the encryptionPasswordP field and that
bEncryptKeyEnabled is set to true.



Explanation:

There was no encryption key found in the password file, or no key was
provided by the application.

System action:

The system returns to the calling procedure.

User response:

If you are using -encryptkey=prompt, make sure there is a value in
encryptionPasswordP and that bEncryptKeyEnabled is set to true.

------------------------------------------------------------------------
ANS0359E

Conflicting encryption key options have been specified.



Explanation:

When using the ENABLEENCRYPTKEY option, the parameter bEncryptKeyEnabled
for the IBM Spectrum Protect API dsmInitExIn_t and tsmInitExIn_t
structures cannot be set to bTrue.

System action:

The system returns to the calling procedure.

User response:

Either remove the ENABLEENCRYPTKEY option from the options file, or set
the parameter bEncryptKeyEnabled to bFalse in the program using the IBM
Spectrum Protect API.

------------------------------------------------------------------------
ANS0360E

The client acceptor cannot start because the value of the
MANAGEDSERVICES option is NONE.



Explanation:

The client acceptor will not start if MANAGEDSERVICES NONE is set in the
option file. The client acceptor is designed to manage the web client or
IBM Spectrum Protect schedules. By specifying NONE, the client acceptor
will not manage any services.

System action:

The client acceptor will stop processing.

User response:

Specify either WEBCLIENT or SCHEDULER for the MANAGEDSERVICES option in
the option file then restart the client acceptor.

------------------------------------------------------------------------
ANS0361I

DIAG:



Explanation:

The message text is provided for diagnostic purposes and is meant to
provide information to IBM support in problem determination.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS0362E

There are insufficient Windows system resources to process this command.



Explanation:

This problem can occur during backup of a shared directory. The most
likely reason is the 'IRPStackSize' setting on the computer that hosts
the shared directory is too small.

System action:

The file is skipped.

User response:

Check the Windows event viewer for event ID 2011 on the computer that
hosts the shared directory. This event indicates that the configuration
parameter IRPStackSize is too small. IRPStackSize is a setting of type
DWORD located in Windows registry key
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\LanmanServer\Parameters.
If the IRPStackSize value is less than 20, or IRPStackSize is not
specified, then set the value to 20, restart the system, and try the
operation again. The default IRPStackSize value is 15. Attention:
Consult with your Windows system administrator before making changes to
the Windows registry or the problem persists after changing the
IRPStackSize value to 20.

------------------------------------------------------------------------
ANS0363E

The signature check of the content.spsig file failed. The retrieved
files will be removed.



Explanation:

The IBM Spectrum Protect signature file, content.spsig, was not
retrieved correctly. The file was manipulated or damaged.

System action:

Processing stops.

User response:

The content.spsig file was not found. Make sure that the data in the
Operations Center, such as the client package or Update Manager package,
is correct or download the correct version in the Operations Center.

------------------------------------------------------------------------
ANS0364W

The signature check of the content.spsig file failed.



Explanation:

The IBM Spectrum Protect signature file, content.spsig, was not
retrieved correctly. The file was changed or damaged.

System action:

Processing continues.

User response:

The content.spsig file is damaged or changed. Ensure that the data that
was retrieved is not corrupted. The data was probably damaged or
changed.

------------------------------------------------------------------------
ANS0365E

The signature check of one or more files failed. The retrieved files
will be removed.



Explanation:

One or more files were not retrieved correctly. The files might be
changed or damaged.

System action:

Processing stops.

User response:

One or more files were changed or damaged. Make sure that the data in
the Operations Center, such as the client package or Update Manager
package, is correct or download the correct version in the Operations
Center.

------------------------------------------------------------------------
ANS0366W

The signature check of one or more files failed.



Explanation:

One or more files were not retrieved correctly. The files might be
changed or damaged.

System action:

Processing continues.

User response:

One or more files were changed or damaged. Ensure that the files that
were retrieved are not corrupted.

------------------------------------------------------------------------
ANS0367E

One or more files were not found during the signature check. The
retrieved files will be removed.



Explanation:

One or more files were not retrieved.

System action:

Processing stops.

User response:

One or more files were not retrieved. Make sure that the data in the
Operations Center, such as the client package or Update Manager package,
is correct or download the correct version in the Operations Center.

------------------------------------------------------------------------
ANS0368W

One or more files were not found during the signature check.



Explanation:

One or more files were not retrieved. Important files might be missing.

System action:

Processing continues.

User response:

One or more files were damaged or changed. Ensure that the files that
were retrieved are not corrupted. The missing files could be important
or not retrieved on purpose. For example, a file might not be retrieved
because it was removed on the server.

------------------------------------------------------------------------
ANS0369E

The content.spsig file is not a IBM Spectrum Protect signature file. The
retrieved files will be removed.



Explanation:

A content.spsig file was found, but it is not a IBM Spectrum Protect
signature file. The content of the retrieve could not be verified.

System action:

Processing stops.

User response:

If a content.spsig file is found during retrieve, the client will try to
identify this file as a signature file. If the file is not a IBM
Spectrum Protect signature file, the client is not able to verify the
files. Make sure that the data in the Operations Center, such as the
client package or Update Manager package, is correct or download the
correct version in the Operations Center.

------------------------------------------------------------------------
ANS0370W

The content.spsig file is not a IBM Spectrum Protect signature file.



Explanation:

A content.spsig file was found, but it is not a IBM Spectrum Protect
signature file. The content of the retrieve could not be verified. If a
content.spsig file is found during retrieve the client will try to
identify this file as signature file. If the file is not a IBM Spectrum
Protect signature file, the client is not able to verify the data.

System action:

Processing continues.

User response:

No user action is required.

------------------------------------------------------------------------
ANS0371E

The content.spsig file was not found. A signature check cannot be
completed. All retrieved files will be removed.



Explanation:

The IBM Spectrum Protect signature file, content.spsig, was not found. A
signature check is not possible. It is not possible to check whether the
files that were retrieved are damaged or changed.

System action:

Processing stops.

User response:

The content.spsig file was not found. Make sure that the data in the
Operations Center, such as the client package or Update Manager package,
is correct or download the correct version in the Operations Center.

------------------------------------------------------------------------
ANS0372E

More than one content.spsig file was found. A signature check cannot be
completed. All retrieved files will be removed.



Explanation:

More than one IBM Spectrum Protect signature file, content.spsig, was
found. A signature check is not possible. It is not possible to check
whether the files that were retrieved are damaged or changed.

System action:

Processing stops.

User response:

More than one content.spsig file was found. Make sure that the data in
the Operations Center, such as the client package or Update Manager
package, is correct or download the correct version in the Operations
Center.

------------------------------------------------------------------------
ANS373I

The SAN Policy of the system is set to 'san_policy_value'.



Explanation:

The VMware Virtual Disk Development Kit used to open, close, read, and
write VMware VMDKs requires the specified Windows SAN Policy setting for
the datamover hardware and transport type in use.

System action:

The Windows SAN Policy of the system is configured and the current
operation continues.

User response:

When a system is set to Offline All, you need to manually set new disks
to Online.

------------------------------------------------------------------------
ANS0374E

The CAD service is not running on the local node.



Explanation:

The CAD service is not running.

System action:

The operation cannot continue without a connection to the CAD service.

User response:

Make sure that the CAD service is running and configured correctly.

------------------------------------------------------------------------
ANS0375E

The fileSpace parameter is either not defined or too long.



Explanation:

The fileSpace parameter cannot be empty and cannot be longer than 1024
characters.

System action:

The operation cannot continue.

User response:

Make sure that the fileSpace parameter is used correctly.

------------------------------------------------------------------------
ANS0376E

The value for the codePage parameter is incorrect.



Explanation:

The codePage parameter can only be "MBCS" or "UCS2".

System action:

The operation cannot continue.

User response:

Make sure that the codePage parameter is used correctly.

------------------------------------------------------------------------
ANS0377E

The value for the path parameter is incorrect.



Explanation:

The path parameter cannot be longer than 6000 characters.

System action:

The operation cannot continue.

User response:

Make sure that the path parameter is used correctly.

------------------------------------------------------------------------
ANS0378E

The value for the name parameter is incorrect.



Explanation:

The name parameter cannot be longer than 512 characters and cannot start
with the directory delimiter.

System action:

The operation cannot continue.

User response:

Make sure that the name parameter is used correctly.

------------------------------------------------------------------------
ANS0379E

The value for the status parameter is incorrect.



Explanation:

The status parameter can only be "ALL", "ACTIVE" or "INACTIVE".

System action:

The operation cannot continue.

User response:

Make sure that the status parameter is used correctly.

------------------------------------------------------------------------
ANS0380E

The value for the type parameter is incorrect.



Explanation:

The type parameter can only be "FILE" or "DIR".

System action:

The operation cannot continue.

User response:

Make sure that the type parameter is used correctly.

------------------------------------------------------------------------
ANS0381E

The value for either the startDateTime or endDateTime parameter is
incorrect.



Explanation:

The startDateTime and endDateTime parameters can only be a valid JSON
date time format.

System action:

The operation cannot continue.

User response:

Make sure that the startDateTime and endDateTime parameters are used
correctly.

------------------------------------------------------------------------
ANS0382E

The rest call JSON data is missing values.



Explanation:

The JSON data for the rest call are incorrect and cannot be processed.

System action:

The operation cannot continue.

User response:

Make sure that the JSON for the rest call is correct and has all needed
values.

------------------------------------------------------------------------
ANS0400E

License file could not be opened.



Explanation:

The license file was not found, or could not be opened because of
permissions or the file is corrupted.

System action:

The system returns to the calling procedure.

User response:

Check permissions on file. See if the license file is in the correct
place.

------------------------------------------------------------------------
ANS0401E

Read failure on the license file.



Explanation:

The license file was not found, or could not be opened because of
permissions, or the file is corrupted.

System action:

The system returns to the calling procedure.

User response:

Check permissions on file. See if the license file is in the correct
place.

------------------------------------------------------------------------
ANS0402E

Write failure on the license file.



Explanation:

The license file was not found, or could not be opened because of
permissions or the file is corrupted.

System action:

The system returns to the calling procedure.

User response:

Check permissions on file. See if license file is in the correct place.

------------------------------------------------------------------------
ANS0403E

Data in the license file is not in a valid format.



Explanation:

The license file is not valid.

System action:

The system returns to the calling procedure.

User response:

User needs to obtain a new license.

------------------------------------------------------------------------
ANS0404E

The checksum in the license file does not match the licenseregistration
string.



Explanation:

The registration string is not valid.

System action:

The system returns to the calling procedure.

User response:

User needs to obtain a new license.

------------------------------------------------------------------------
ANS0405E

This is an expired try and buy license.



Explanation:

The registration string is not valid.

System action:

The system returns to the calling procedure.

User response:

User needs to obtain a new license.

------------------------------------------------------------------------
ANS0420W

Warning! Restoring inactive system state objects is not recommended.Do
you wish to continue?



Explanation:

Restoring inactive system state objects may cause system instability.
Examples of possible problems include:

*  Applications that were installed after the time the system state was
   backed up cannot function properly after restoring the inactive
   system state

*  Critical operating system updates installed after the inactive system
   state backup was made can no longer be available, or may not function
   correctly.

Restoring inactive system state objects is not recommended unless you
are certain that this is what you need to do.

System action:

If user responds with yes, the client will restore the object. If user
responds with no, the client will cancel the operation.

User response:

Reply to the prompt. If you are unsure, reply no, and consult your
system administrator or operating system vendor before proceeding
further.

------------------------------------------------------------------------
ANS0421W

Unable to synchronize the node password with the user id password
provided.



Explanation:

The node password was not updated due to the reason described in the
error message preceding this one.

System action:

The node password is not updated on the server. Next time you run the
client you will be prompted for the password again.

User response:

See the preceding error message.

------------------------------------------------------------------------
ANS0422W

The selected journal location is a network drive and might not be
accessible from the journal service. Select a location on a local drive.



Explanation:

It is not recommended to use a network device as the location where
journal databases are stored. Placing journal databases on a network
device can prevent the journal service from running.

System action:

Processing continues.

User response:

Choose a local drive where journal databases will be stored.

------------------------------------------------------------------------
ANS0423E

Directory 'filespace namepath-namefile-name' cannot be created. Path
does not exist.



Explanation:

The operating system returned a "path not found" status when IBM
Spectrum Protect attempted to create the directory needed for Automated
System Recovery (ASR). One possible reason is that a multi disk system
is restored to a single disk system.

System action:

Processing stopped.

User response:

Please verify that you are restoring to identical hardware and try
again.

------------------------------------------------------------------------
ANS0649E

Disk provider for volume volume-name does not support the snap of a snap
feature.



Explanation:

You can use the snap of a snap feature only on SVC, XIV and Storwize
systems.

System action:

Processing ends.

User response:

Reset the USESNAPOFASNAPTOMOUNT option to No in the Data Protection
configuration file and set MOUNTRW=Yes to mount the read/write backup.

------------------------------------------------------------------------
ANS0990W

Options file 'file-name' could not be found. Default option values will
be used.



Explanation:

Common reasons for this warning include:

*  The default options file does not exist, and

*  You did not specify the -OPTFILE option when starting the IBM
   Spectrum Protect client, and

*  the environment variable DSM_CONFIG was not set.

System action:

IBM Spectrum Protect client assumes default values for all client
options and continues processing, using the default server name and
associated options found in the dsm.sys file.

User response:

If the default system action is acceptable, you can eliminate this
message by creating an empty dsm.opt file in the installation directory.

If you have a client user options file (dsm.opt), either place it in the
installation directory or set the DSM_CONFIG environment variable to the
fully-qualified path and file name of your options file.

Review the information on configuring IBM Spectrum Protect in the IBM
Spectrum Protect client manual specific to your operating system. If the
problem persists, ask your IBM Spectrum Protect administrator for
further assistance.

------------------------------------------------------------------------
ANS0991I

IBM Spectrum Protect scheduler is listening for server requests on port
port number



Explanation:

This message indicates the port number on which the clients is listens
for server requests. If the port number in the message differs from the
default value or what you specified with the TCPCLIENTPORT option, it is
because the port was in use by a different process.

System action:

Processing continues.

User response:

Normally no further action is required. If you require the use a
specific port number, you need to configure your system or applications
so the number is avaible. Restart the IBM Spectrum Protect client and
confirm it uses the desired port.

------------------------------------------------------------------------
ANS0992E

The destination filespace or drive letter is unavailable. For more
details please see dsmerror.log.



Explanation:

The system is trying to restore or retrieve to a destination that cannot
be reached. The specified filespace name or drive letter is not valid,
or does not exist, or you are specifying a local share name that cannot
be resolved.

System action:

Objects which are part of this filespace are not processed.

User response:

Try the command again, and specify a different destination for the
object that was not processed.

------------------------------------------------------------------------
ANS0993E

The source specification "source" has invalid format.



Explanation:

The file system must be enclosed in curly braces and wildcards cannot be
used except at the lower level.

System action:

The command processing is terminated.

User response:

Correct the specification and try the command again.

------------------------------------------------------------------------
ANS0994E

Invalid string 'string' for virtual file space name or group name
specification.



Explanation:

You entered a virtual file space name or a group name specification that
contains wildcard characters.

System action:

Processing stopped.

User response:

Enter a correct virtual file space name and a group name and try again.
Use the pick option to display a list of groups from which you can
select one group.

------------------------------------------------------------------------
ANS0995E

Volume 'volume-name' could not be locked.



Explanation:

The system call to lock the volume failed.

System action:

Processing stopped.

User response:

Please verify that no other application is accessing the volume. During
restore of an image IBM Spectrum Protect must have exclusive use of the
volume.

------------------------------------------------------------------------
ANS1000E

An unsupported communications method was specified.



Explanation:

None.

System action:

processing stops.

User response:

Specify a communications interface that is supported by the IBM Spectrum
Protect client on your operating system. See the IBM Spectrum Protect
client manual for your operating system for further information on
configuring IBM Spectrum Protect client communications.

------------------------------------------------------------------------
ANS1001E

Volume being backed up was not a system volume. Skipped.



Explanation:

User specified to back up system volume only. This volume was not backed
up since this volume is not a system volume.

System action:

Volume was not backed up.

User response:

Use All option or use image backup command to backup this volume.

------------------------------------------------------------------------
ANS1002I

MOS image is being created. It may take a while.



Explanation:

Mini Operating System image is being created. It may take a while to
create it.

System action:

Processing Continues.

User response:

None.

------------------------------------------------------------------------
ANS1004W

Node has exceeded max tape mounts allowed. Operation for
'filespace-name' will be tried again later.



Explanation:

Node has exceeded max tape mounts allowed. The operation will be tried
again later.

System action:

The operation will be retried.

User response:

Increase the number of allowed tape mounts for this node on the server
to avoid this situation again.

------------------------------------------------------------------------
ANS1005I

TCP/IP read error on socket = socket-id, errno = error-code, reason :
'error-reason'.



Explanation:

An attempt to receive data using TCP/IP connection failed. If reason :
'Connection reset by peer', it is possible that the server control
connection timed out. This can occur if the file transfer time is
greater than the IDLETIMEOUT value set on the server.

System action:

TCP/IP connection to server fails.

User response:

If the timeout was due to a large file transfer time, you can ignore
this message. The client will reconnect with the server automatically,
finish transferring the data, and send statistics. You can also consider
increasing the IDLETIMEOUT value in the server options file.

------------------------------------------------------------------------
ANS1006I

TCP/IP write error on socket = socket-id, errno = error-code, reason :
error-reason



Explanation:

An attempt to send data using TCP/IP connection failed.

System action:

Connection to server fails.

User response:

Retry the operation. If the problem persists, contact your system
administrator.

------------------------------------------------------------------------
ANS1007E

Sending of object 'object-nameobject-nameobject-name' failed. There is
no backup copy group.



Explanation:

The management class for this file (object-name) does not have a backup
copy group. Either the default management class does not have a backup
copy group, or an INCLUDE statement is attempting to bind the file to a
management class that does not have a backup copy group.

System action:

IBM Spectrum Protect did not back up the file.

User response:

Run DSMC QUERY MGMTCLASS -DETAIL to view information about available
management classes.

*  If the file is being bound to the default management class, make sure
   the management class has a backup copy group.

*  If the file is being bound to a management class specified in an
   INCLUDE statement, make sure that the management class has a backup
   copy group.

*  If you have more than one IBM Spectrum Protect server, make sure you
   are connecting to the correct server.

*  If you are unable to find a suitable management class, contact your
   IBM Spectrum Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1008E

Sending of object 'object-nameobject-nameobject-name' failed: No Archive
Copy Group



Explanation:

The management class for this file (object-name) did not have an archive
copy group specified.

System action:

The file could not be backed up.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1009W

An error occurred processing the operating system include/exclude
statements. The error was detected while processing: subsystemname.



Explanation:

The client encountered an error while obtaining the automatic
include/exclude statements from the operating system. Possible reasons
for this error include:

*  The specified registry key cannot be opened for reading

*  The entry under this key has incorrect data

System action:

Processing continues without the full list of operating system
include/exclude statements.

User response:

Ensure that you have access to the specified registry key and that
entries are a MULTISZ values that contain:

*  Individual files

*  Directories

*  Wild card entries

*  Environment variables

*  /s switch (the /s switch is used on directory and/or wild card
   entries and signifies that all subdirectories of this directory
   should be excluded)

If the cause of this message can not be determined or resolved, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1010E

Error processing 'filespace-name': Unsupported file system operation.



Explanation:

The file system does not support an operation required to process the
file or directory.

System action:

The file or directory is skipped. Depending on the specific error
encountered, processing on Solaris clients might stop.

User response:

Verify that the file system is supported by the IBM Spectrum Protect
client. If a restore or retrieve failed, retry the operation to another
location. If the problem persists, look for other indications of system
problems. It may be necessary to run the operating system utility that
checks and repairs file system inconsistencies. If the problem still
cannot be resolved, contact your IBM Spectrum Protect administrator for
further assistance.

------------------------------------------------------------------------
ANS1015E

The session is rejected. The server does not allow a signon of a client
that is not archive-retention protection enabled.



Explanation:

The client cannot establish a connection to the server because the
server is enabled for archive-retention protection enabled and the
client is not.

System action:

The session is not started.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1016I

No eligible files matching 'pathname' were found.



Explanation:

The backup or archive operation completed, but no files were processed.
Possible reasons for this include:

   The directory that was backed up or archived contains no files
   The files are excluded from backup or archive

System action:

None

User response:

Check the path you entered.

------------------------------------------------------------------------
ANS1017E

Session rejected: TCP/IP connection failure.



Explanation:

An attempt to connect to the server using TCP/IP communications failed.
This can be a result of incorrect TCP/IP option settings in your client
options file. This error can also occur if the LAN connection went down
or if your system administrator canceled a backup operation.

System action:

Session rejected. Processing stopped.

User response:

Retry the operation, or wait until the server comes back up and retry
the operation. If the problem continues, see your system administrator
for further help.

------------------------------------------------------------------------
ANS1018E

Port port number is already in use



Explanation:

The port specified by the TCPCLIENTPORT option is in use by a different
process.

System action:

Processing stopped.

User response:

Contact the server administrator to set up a different port for
server-initiated connections. Update the TCPCLIENTPORT with this new
port number.

------------------------------------------------------------------------
ANS1019E

The volume could not be opened.



Explanation:

An error occurred when IBM Spectrum Protect tried to open the volume for
a backup or restore operation.

System action:

The requested operation does not run.

User response:

Examine the client error log for additional messages related to this
error. Verify that the volume is available, and is not locked by another
process. Try the operation again. If the problem persists, contact IBM
technical support for further assistance.

------------------------------------------------------------------------
ANS1020E

System object backup failed.



Explanation:

An error occurred while backing up Windows system object files. The
backup did not complete.

System action:

Processing stopped.

User response:

Ask your system administrator to check the error log. Restart the
Windows service associated with the system object indicated in the error
log, and retry the backup operation

------------------------------------------------------------------------
ANS1021E

System object restore failed.



Explanation:

An error occurred while restoring Windows system object files. The
restore did not complete.

System action:

Processing stopped.

User response:

Ask your system administrator to check the error log. Restart the
machine, and then restore the system object indicated in the error log
again.

------------------------------------------------------------------------
ANS1022E

Cancel failed for node: node-name filesystem: fs-name operation: op-type
error: error



Explanation:

The request to cancel a remote operation has failed. The node, file
space, operation and reason for the failure are shown.

System action:

Operation not cancelled.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS1023E

Session rejected: Node type mismatch



Explanation:

Your node name is associated with a different type of operating system
and cannot be used on this system.

System action:

Current operation has been cancelled.

User response:

If you need a new node name, see your system administrator to assign a
new one to you. Generally, you have a unique node name for each machine
and operating system pair that requires access to the server.

------------------------------------------------------------------------
ANS1024E

Failed to update backup attributes on server for 'backup_type' backup
for 'file_space_namepath_namefile_name', object id 'object_id:object_id'
return code 'return code'.



Explanation:

Failed to update attributes for the named backup object on the server.
The server may not reflect correct state of the backup.

System action:

Processing continues.

User response:

Check preceding error messages in error log for more information. Retry
the operation. If problem continues, contact your IBM Spectrum Protect
administrator.

------------------------------------------------------------------------
ANS1025E

Session rejected: Authentication failure



Explanation:

Authentication failure. You entered an incorrect user id or password.

System action:

Current operation has been cancelled.

User response:

Enter your correct user id and password. If you cannot remember the
correct user id or password, see your system administrator to have new
credentials assigned for your node name.

------------------------------------------------------------------------
ANS1026E

The session is rejected: There was a communications protocol error.



Explanation:

An unexpected network message was received by the client. This could be
caused by network problems or a programming error.

System action:

The current operation has been cancelled.

User response:

Verify that your communication path is functioning properly and try the
operation again. If the problem persists, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1028S

An internal program error occurred.



Explanation:

An unexpected condition was encountered and the operation can not
continue. This might be a programming error.

System action:

processing stops.

User response:

Try the operation again. If the problem persists, contact your IBM
Spectrum Protect administrator or IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS1029E

Communication with the IBM Spectrum Protect server is lost.



Explanation:

This message is issued after the session with the IBM Spectrum Protect
server is unexpectedly lost. The client error log might contain
additional information regarding this problem.

System action:

processing stops.

User response:

*  Restart the IBM Spectrum Protect client and retry the operation.

*  If the problem persists, review the client error log for other
   messages that might be related to this problem.

*  Verify that network connectivity exists between the IBM Spectrum
   Protect client machine and the IBM Spectrum Protect server machine.

*  Contact your IBM Spectrum Protect administrator for further
   assistance. The IBM Spectrum Protect administrator can review the IBM
   Spectrum Protect server activity log for additional information about
   the problem.

------------------------------------------------------------------------
ANS1030E

The operating system refused a request for memory allocation.



Explanation:

Access to memory is required in order to store information as processing
proceeds. In this case, more memory was requested than the operating
system would allocate. Possible reasons include:

   The system is low on memory.
   The process in which the program runs has exceeded the maximum memory
   that it is allowed to allocate.
   Some other error condition occurred that caused the program to think
   it is out of memory.

System action:

Requested operation cannot be completed.

User response:

Close all unneeded applications and try the operation again. If the
operation still fails, try dividing the task into several smaller units.
For example, if a file specification contains several high level
directories, run the IBM Spectrum Protect task serially for each
directory. If the IBM Spectrum Protect task is an incremental backup,
use the option "-memoryefficientbackup=yes".

For UNIX systems that support resource limits, check to see b if the
memory resource limit is too low by entering the following command:
ulimit -a

Based on the resulting data, you can ask the UNIX system root user to
increase resource limits so that it will override the current default.
The UNIX system root user has the authority to increase resource limits.

------------------------------------------------------------------------
ANS1031E

The attempt to establish a TCP/IP connection timed out before the
connection was made.



Explanation:

The Object of the connection attempt failed to respond within the the
allotted wait time. In the case of the B/A client, this message is
preceded in dsmerror.log by message ANS5216E that gives details of the
connection that failed. The condition may be temporary.

System action:

processing stops.

User response:

*  Restart the IBM Spectrum Protect client and retry the operation.

*  Check the client options file and verify that TCPSERVERADDRESS and
   TCPPORT specify the correct TCP/IP address and port number for your
   IBM Spectrum Protect server.

*  Verify that network connectivity exists between the IBM Spectrum
   Protect client machine and the IBM Spectrum Protect server machine.

*  If the problem persists, see your IBM Spectrum Protect administrator
   for further assistance.

------------------------------------------------------------------------
ANS1032E

An attempt to establish a TCP/IP connection was rejected by the host



Explanation:

An attempt to establish a TCP/IP connection was rejected by the server.

System action:

Processing stopped.

User response:

The server was not fully initialized, is not currently running, was not
enabled for TCP/IP communications, or an incorrect TCP/IP port number
was specified. If the problem continues, see your system administrator.

------------------------------------------------------------------------
ANS1033E

An invalid TCP/IP address was specified.



Explanation:

The TCP/IP address specified by the IBM Spectrum Protect client's
TCPSERVERADDRESS setting could not be found on the network. Common
reasons for this error include:

*  The TCPSERVERADDRESS client option specifies the wrong TCP/IP address
   for the IBM Spectrum Protect server".

*  The machine that hosts the IBM Spectrum Protect server is not on the
   network.

*  A network problem is preventing the IBM Spectrum Protect client from
   reaching the machine that hosts the IBM Spectrum Protect server.

System action:

processing stops.

User response:

Verify that the TCPSERVERADDRESS and TCPPORT settings have the correct
values for your IBM Spectrum Protect server. Use your operating system's
"ping" (or similar) utility to ensure that your machine can locate the
machine that hosts the IBM Spectrum Protect server across the network.
Try the operating again. If the problem persists, ask your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1034E

The specified TCP/IP host name is unreachable



Explanation:

The TCP/IP host name specified in the TCPSERVERADDRESS statement cannot
be reached.

System action:

Processing stopped.

User response:

Check your options file for the correct TCPSERVERADDRESS statement. See
your administrator for the correct name of the server.

------------------------------------------------------------------------
ANS1035S

Options file 'file-name' could not be found, or it cannot be read.



Explanation:

Common reasons for this error include:

*  The default options file does not exist.

*  You specified the -OPTFILE option when starting the IBM Spectrum
   Protect client, but the options file you provided does not exist.

*  The DSM_CONFIG (or DSMI_CONFIG if you are using the IBM Spectrum
   Protect API) environment variable specifies an options file that does
   not exist.

*  You specified the -OPTFILE option when starting the IBM Spectrum
   Protect client, but the options file that you provided is not in the
   standard file encoding of the system. For example, on Windows the
   expected file encoding is ANSI.

*  You specified the -OPTFILE option when starting the IBM Spectrum
   Protect client, but the options file that you provided does not have
   appropriate read permissions for the user that is running the
   operation.

System action:

IBM Spectrum Protect client processing stops.

User response:

Make sure that the options file you want to use exists, it has the read
rights set for the user that is running the operation, and it is in the
standard file encoding of the system. For example, on Windows the
expected file encoding is ANSI. Review the configuration information in
the IBM Spectrum Protect client manual specific to your operating
system. If the problem persists, ask your IBM Spectrum Protect
administrator for further assistance.

------------------------------------------------------------------------
ANS1036S

The option 'option' or the value supplied for it is not valid. It was
found in options file 'file-name' at line number: number The complete
entry: 'entry'



Explanation:

The specified option or option value is not valid. For options that
include a date or time specification, the format of the date or time
might not match the formats specified by the DATEFORMAT or TIMEFORMAT
options.

System action:

Processing stops.

User response:

Correct the option name or value. For options that specify dates or
times, ensure that the specified date or time matches the DATEFORMAT and
TIMEFORMAT settings. If -DATEFORMAT or -TIMEFORMAT are specified on the
command line, they must precede the option that specifies the date or
time. For example, use -DATEFORMAT=3 -FROMDATE=yyyy-mm-dd, instead of
-FROMDATE=yyyy-mm-dd -DATEFORMAT=3.

------------------------------------------------------------------------
ANS1037S

Invalid keyword specified



Explanation:

An incorrect keyword was found in the options file.

System action:

Processing stopped.

User response:

Correct the options file with valid entries.

------------------------------------------------------------------------
ANS1038S

Invalid option specified.



Explanation:

An incorrect option was specified to IBM Spectrum Protect.

System action:

Processing stopped.

User response:

Correct the options used for running IBM Spectrum Protect.

------------------------------------------------------------------------
ANS1039S

The include or exclude pattern cannot be parsed.



Explanation:

The pattern is formatted incorrectly or is too complex to be
interpreted.

System action:

Processing stopped.

User response:

Verify that the include or exclude pattern is specified correctly. If
the pattern is correct, then contact IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS1040S

Include/Exclude pattern is missing a closing bracket



Explanation:

The include or exclude pattern is incorrectly constructed. The closing
bracket is missing.

System action:

Processing stopped.

User response:

Correct the syntax for the pattern.

------------------------------------------------------------------------
ANS1041S

Include/Exclude pattern must start with a directory delimiter



Explanation:

The include or exclude pattern must start with a directory delimiter.

System action:

Processing stopped.

User response:

Correct the syntax for the pattern.

------------------------------------------------------------------------
ANS1042S

A beginning or ending directory delimiter is missing from the
Include/Exclude pattern.



Explanation:

1. The include/exclude pattern has a '...' without a beginning or ending
   directory delimiter.

2. For Windows, the drive seperator is not immediately followed by a
   directory delimiter.

System action:

Processing stopped.

User response:

Correct the syntax for the pattern.

------------------------------------------------------------------------
ANS1043S

Quotes are not matched



Explanation:

The quotes specified in the pattern are not the same and do not make a
set.

System action:

Processing stopped.

User response:

Correct the pattern by using matching quotes in the syntax.

------------------------------------------------------------------------
ANS1044W

Image backup of disk 'option-name' with disk sector size 'block-size' is
not supported. Image backup supports only disks with 512 bytes sector.



Explanation:

The image backup operation supports disks with sector size 512 bytes.
Other sector sizes are not supported.

System action:

Use image backup only for disks with 512 bytes sector.

User response:

None.

------------------------------------------------------------------------
ANS1047E

The destination file system is unavailable. The following object was
skipped: File space:'filespace-name' Pathname:' path-name'
Filename:'file-name'



Explanation:

The client is trying to restore or retrieve the specified object to a
destination that is not valid, does not exist, or cannot be reached.

System action:

The object is not restored or retrieved. Processing continues with the
next object.

User response:

Try the command again using a different destination.

------------------------------------------------------------------------
ANS1048E

Device 'volname' is not local



Explanation:

The selected path is not a local device and therefore is not a valid
object for image operations.

System action:

The requested logical volume operation is not performed.

User response:

Choose another object.

------------------------------------------------------------------------
ANS1049E

'filename' is not a valid destination file for image restore



Explanation:

The filename you specified is not a valid name for a file or it is a
directory.

System action:

Restore processing stopped.

User response:

Specify a correct filename for image restore.

------------------------------------------------------------------------
ANS1050E

Volume 'volume-name' could not be locked for the VSS Instant Restore.



Explanation:

The volume cannot be locked because another application is accessing the
file systems on the volume.

System action:

Processing stops.

User response:

Stop or suspend the applications that have handles open on the volume.
For a file system restore, close applications that are accessing the
file systems that are used for the VSS Instant Restore.

If you cannot close the applications that are accessing the file system,
unmount the file system. After the unmount process is complete, mount
the file system and perform the VSS Instant Restore.

For more information, see the error log file DSMERROR.LOG.

------------------------------------------------------------------------
ANS1051I

Invalid user id or password



Explanation:

You entered an invalid user id or password.

System action:

IBM Spectrum Protect cannot connect to the server without the correct
credentials.

User response:

Contact your system administrator for the correct credentials.

------------------------------------------------------------------------
ANS1052E

Direct connection to the Storage Agent is not allowed.



Explanation:

You cannot connect directly to the Storage Agent.

System action:

Processing stopped.

User response:

To perform Lanfree operations using the Storage Agent, specify the
ENABLELANFREE option in your options file, and restart the process.

------------------------------------------------------------------------
ANS1053I

Existing file space file_space_name has been renamed to file_space_name



Explanation:

If the file space is for Windows system state, this message is issued
when the IBM Spectrum Protect backup-archive client detects multiple
system state file spaces where the names differ only in case. The
existence of multiple system state file spaces can occur if, at some
earlier time, your IBM Spectrum Protect administrator renamed the system
state file space to the same name but with a different case or the
computer's name was changed from all upper case characters to lower case
or mixed case characters. If the file space name represents a drive
volume label, then this file space was created by an older IBM Spectrum
Protect backup-archive client.

System action:

If the file space is for Windows system state, IBM Spectrum Protect will
back up system state to the file space containing the most recent
backup. The older file space is renamed as specified in this message.
Subsequent system state backups will continue to back up system state to
the same (most recently used) file space. If the file space name
represents a drive volume label, it will be renamed to the corresponding
UNC name and continues to back up the drive to this renamed file space.

User response:

No further action is necessary. However, if the file space is for
Windows system state, then at some future time when you have determined
you no longer need the older renamed system state file space, you can
ask your IBM Spectrum Protect administrator to delete the older file
space from IBM Spectrum Protect storage.

------------------------------------------------------------------------
ANS1054E

Existing filespace filespace-name cannot be renamed to new filespace
filespace-name. IBM Spectrum Protect return code = retcode.



Explanation:

The client was unable to migrate a file space name from the volume label
naming convention to the UNC naming convention.

System action:

Processing stopped.

User response:

Check the client error log and the IBM Spectrum Protect server activity
log for any other messages that might help identify the problem. If the
problem cannot be resolved, contact IBM technical support for additional
assistance.

------------------------------------------------------------------------
ANS1055I

Trying to rename existing filespace filespace-name to new filespace
filespace-name, but drive letters do not match, old=drive-letter,
new=drive-letter. Ignore the old filespace and backup to the new
filespace.



Explanation:

Trying to rename the existing filespace name using the volume label to
the UNC format naming convention but the drive letters do not match.
Leave the existing filespace alone and create a new filespace.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1056E

Share/network path share cannot be resolved. Path does not exist.



Explanation:

For backup: Trying to backup share/network, which either does not exist
or does not have the correct privilege to access the share. For restore
: Trying to restore to a share/network path that cannot be resolved. The
directory path does not exist.

System action:

Processing stopped.

User response:

Retry the command and specify a destination, or restore the directory
tree first before trying to restore the share point.

------------------------------------------------------------------------
ANS1057I

File space file_space_name cannot be renamed to new file space
file_space_name, because the new file space already exists.



Explanation:

The client was unable to migrate a file space name from the volume label
naming convention to the UNC naming convention because the new file
space already exists on the IBM Spectrum Protect server.

System action:

The operation proceeds using the new file space. The old file space is
ignored.

User response:

No action is necessary, but if the data in the old file space is no
longer needed, it can be deleted from the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS1058E

The restore destination cannot be reached.



Explanation:

Either the destination file system is invalid or it cannot be reached.

System action:

Processing stopped.

User response:

Try the command again using a different destination.

------------------------------------------------------------------------
ANS1059E

Two inactive objects with the same image name were selected. Process
terminates



Explanation:

You selected more than one inactive version of the same image object
(logical volume). The system has no way to decide which you want to
restore.

System action:

The requested logical volume restore is not performed.

User response:

Retry the operation, selecting an active version or only one inactive
version of the volume you wish to restore.

------------------------------------------------------------------------
ANS1060E

The specified path is not a mounted filesystem



Explanation:

You entered a file system name that does not correspond to a mounted
file system for this system. It is possible the file system name is
misspelled, or simply that the file system is not currently mounted.

System action:

The requested logical volume operation is not performed.

User response:

Retry the operation, using name of a mounted file system.

------------------------------------------------------------------------
ANS1061E

The specified device corresponds to a mounted file system; you must
specify the file system by name.



Explanation:

You entered a logical device name that is mapped to a mounted file
system. This volume must only be referenced by its file system name.

System action:

The requested logical volume operation is not performed.

User response:

Try the operation again, using the file system name instead of the
device name.

------------------------------------------------------------------------
ANS1062E

Only a single image may be selected when a destination is entered.



Explanation:

You selected more than one image object (logical volume) to be restored.
You also specified a destination. The system cannot place more than one
image into a single destination volume. When more than one object is
selected, each must be restored to its original location.

System action:

The requested logical volume restore is not performed.

User response:

Retry the operation, selecting one object to be restored to the given
destination, or retry the operation without entering the destination.

------------------------------------------------------------------------
ANS1063E

The specified path is not a valid file system or logical volume name.



Explanation:

None.

System action:

The logical volume operation is not performed.

User response:

Try the operation again using a valid path.

------------------------------------------------------------------------
ANS1064E

An unexpected error occurred while processing the image operation.



Explanation:

None.

System action:

The requested operation does not run.

User response:

Examine the client error log for any additional messages that may have
been issued before or after this message. Correct any problems, if
possible. If the cause of this message can not be determined or
resolved, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1065E

Library version of the image utility does not match that of the IBM
Spectrum Protect API



Explanation:

The current system has a mix of installed components.

System action:

The requested logical volume operation is not performed.

User response:

Re-install all IBM Spectrum Protect components

------------------------------------------------------------------------
ANS1066E

The restore operation completed successfully, but the file system could
not be remounted.



Explanation:

None.

System action:

The file system is left unmounted.

User response:

Use the mount command to mount the file system. On AIX, run fsck if
requested by the operating system.

------------------------------------------------------------------------
ANS1067E

A call to a system function returned an unexpected error.



Explanation:

If you are performing a JFS2 snapshot based operation, it is possible
that the snapshot was not large enough to contain all the changes made
to the filesystem after the snapshot was created. This could cause the
snapshot to become invalid thereby preventing IBM Spectrum Protect
client from reading the snapshot.

System action:

The requested operation does not run.

User response:

Examine the client error log for additional messages related to this
error. Try the operation again. If the problem persists, contact IBM
technical support for further assistance.

If you are performing a JFS2 snapshot based operation, please use the
default snapshotcachesize of 100% and ensure that the volume group has
sufficient disk space to allocate snapshots at least as large as the
file system and retry the operation.

------------------------------------------------------------------------
ANS1068E

The device is not local.



Explanation:

The selected path is not a valid object for image operations. The
selected path is either a remote device or a partition that resides on a
multipath device.

System action:

The requested logical volume operation is not performed.

User response:

Choose another object.

------------------------------------------------------------------------
ANS1069E

An error occurred while reading data from the device



Explanation:

An error occurred while reading data from the device. Windows Only: This
could be due to bad sectors on the drive.

System action:

The requested logical volume operation is not performed.

User response:

Retry the operation, then check the error log for more information.
Windows Only: Please run chkdsk /r and retry the operation. If the
problem persists, a possible workaround is to back up the entire drive
using a regular (non-image) backup. Please ensure that all your data is
backed up. Then format the drive using a full format (without the /q
quick format option). Then restore the data and retry the image backup
operation.

------------------------------------------------------------------------
ANS1070E

Write error



Explanation:

An error occurred while writing data to the device.

System action:

The requested logical volume operation is not performed.

User response:

Re-try the operation, check error log for more information.

------------------------------------------------------------------------
ANS1071E

Invalid domain name entered: 'domain-name'



Explanation:

You entered an invalid domain name. Verify whether the domain name is a
file system and the file system is mounted. A directory cannot be
specified in the domain option, unless it is a virtual mount point.

System action:

Processing continues if there are other file systems in the domain
option to back up.

User response:

Enter a valid drive or file system name (domain).

------------------------------------------------------------------------
ANS1072E

Unable to continue operation; Drive 'drive-name' has no volume label.



Explanation:

The specified drive-name in the domain list does not have a volume
label.

System action:

Processing stopped.

User response:

Use the system format utility to place a unique volume label on all
drives on which you intend to run IBM Spectrum Protect.

------------------------------------------------------------------------
ANS1073E

The file space for domain 'domain-name' could not be found on the IBM
Spectrum Protect server.



Explanation:

The specified file space was expected to be found on the server, but it
no longer exists. It is possible that a command was issued to delete the
file space from the server while the current operation was in progress.

System action:

IBM Spectrum Protect processing stops.

User response:

Try the operation again. If the problem recurs, check the error log for
any other messages that might indicate a reason for the failure. Try to
correct any indicated problems, then try the operation again. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1074W

The operation was stopped by the user.



Explanation:

The operation was stopped at the request of the user. This usually
occurs when the 'Q' key is pressed two times.

System action:

Processing stopped.

User response:

None.

------------------------------------------------------------------------
ANS1075E

file name(line number)The operating system refused a IBM Spectrum
Protect request for memory allocation.



Explanation:

IBM Spectrum Protect requires access to memory in order to store
information as processing proceeds. In this case, more memory was
requested than the operating system would allocate. Possible reasons
include:

   The system is low on memory.
   The process in which the program runs has exceeded the maximum
   allocated memory.
   Some other error condition occurred. No memory is available.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Close all unneeded applications and try the operation again. If the
operation still fails, try dividing the task into several smaller units.
For example, if a file specification contains several high-level
directories, run the IBM Spectrum Protect task serially for each
directory. If the IBM Spectrum Protect task is an incremental backup,
use the option "-memoryefficientbackup=yes".

For UNIX systems that support resource limits, you can check if the
memory resource limit is too low by entering the following command:
ulimit -a

Based on the resulting data, you can ask the UNIX system root user to
increase the resource limit above the current default limit. The UNIX
system root user has the authority to increase resource limits.

------------------------------------------------------------------------
ANS1076E

The specified directory path 'pathname' could not be found.



Explanation:

An invalid or unreachable directory path was specified.

System action:

Processing stopped.

User response:

Try the operation again using a valid directory path.

------------------------------------------------------------------------
ANS1078S

Unknown system error error-code occurred.



Explanation:

An unknown error error-code occurred within the client program.

System action:

The client stops.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Try to correct any indicated problems, then try the
operation again. If the problem persists, contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS1079E

No file specification entered



Explanation:

You did not enter a file specification as prompted.

System action:

The process did not continue with the requested operation.

User response:

Enter a file specification to continue.

------------------------------------------------------------------------
ANS1081E

Invalid search file specification 'string' entered.



Explanation:

You entered a file specification or search string that contains
incorrect characters or contains wildcard characters in the drive
specification or file system name.

System action:

Processing stopped.

User response:

Enter a correct file specification as described in the appropriate Using
the Backup-Archive Client book for the particular operating system.

------------------------------------------------------------------------
ANS1082E

Invalid destination file specification 'file-name' entered



Explanation:

You entered a destination file-name specification that contains
incorrect characters or has wildcard characters in the specification.

System action:

Processing stopped.

User response:

Enter a correct file specification as described in the appropriate Using
the Backup-Archive Client book for the particular operating system.

------------------------------------------------------------------------
ANS1083E

No files have previously been archived for 'filespace-name'



Explanation:

You tried to retrieve files when no files for the specified drive or
file system (filespace-name) were previously archived.

System action:

Processing stopped.

User response:

Ensure that the correct drive or file system was specified and that
files are archived for you to retrieve.

------------------------------------------------------------------------
ANS1084E

No files have previously been backed up for ' filespace-name' or the
specified file space is invalid for the current operating system.



Explanation:

You cannot restore files. Either the file space or drive is invalid, or
no backup copies exist.

System action:

Processing stops.

User response:

Specify a valid drive or file space. Verify that backup copies exist.

------------------------------------------------------------------------
ANS1085E

The VMware vStorage API reported an invalid snapshot configuration.



Explanation:

A VMware vStorage API error occurred due to an invalid snapshot
configuration.

System action:

A VMware vStorage API error occurred, and the virtual machine backup
failed.

User response:

Check the VMware logs for possible causes of the error, and retry the
operation.

------------------------------------------------------------------------
ANS1086E

File not found during Backup, Archive or Migrate processing



Explanation:

The file being processed for backup, archive or migrate no longer exists
on the client. Another process deleted the file before it could be
backed up, archived or migrated by IBM Spectrum Protect.

System action:

File skipped.

User response:

None.

------------------------------------------------------------------------
ANS1087E

Access to the specified file or directory is denied



Explanation:

Access to the specified file or directory is denied. You tried to read
from or write to a file and you do not have access permission for either
the file or the directory.

System action:

Processing stopped.

User response:

Ensure that you specified the correct file or directory name, correct
the permissions, or specify a new location.

------------------------------------------------------------------------
ANS1088E

File space 'filespace-name' does not exist



Explanation:

The specified file space (domain) is incorrect or does not exist on the
machine.

System action:

Processing stopped.

User response:

Retry the operation specifying an existing domain (drive letter or file
system name).

------------------------------------------------------------------------
ANS1089E

Destination directory path length exceeds system maximum



Explanation:

The path name specified plus the path name in the restored file name
combine to create a name whose length exceeds the system maximum.

System action:

Processing stopped.

User response:

Specify a destination path that, when combined, is less than the system
maximum.

------------------------------------------------------------------------
ANS1090E

The LVM1 device is no longer supported by this client.



Explanation:

The selected path refers to a volume device managed by LVM version 1.
LVM 1 is no longer supported by this version of client and therefore is
not a valid object for image operations.

System action:

The requested logical volume operation is not performed.

User response:

Use earlier versions of the client that support LVM1 to perform the
logical volume operation. Alternatively, you can upgrade to LVM2 and
migrate the volume to LVM2. LVM2 is supported by this client for logical
volume operations.

------------------------------------------------------------------------
ANS1091E

Communications error with server during object query



Explanation:

An unexpected communications error occurred during an object query to
the server.

System action:

Processing stopped.

User response:

Verify that communications are active between the client and server
machines. Server outages, processor outages, and communication
controller outages can cause this error.

------------------------------------------------------------------------
ANS1092W

No files matching search criteria were found



Explanation:

You entered a search pattern or file name that cannot be found in the
server database.

System action:

Processing stopped.

User response:

Ensure that your search pattern is correct, or specify a new search
string.

------------------------------------------------------------------------
ANS1093E

Your IBM Spectrum Protect server does not support point-in-time
processing.



Explanation:

The client has requested a point-in-time query or restore operation, but
the IBM Spectrum Protect server to which the client is connected does
not support point-in-time operations.

System action:

Processing stopped.

User response:

Make sure that you are connected to the correct IBM Spectrum Protect
server. If you are connected to the correct server, then try the command
again without specifying any point-in-time options.

------------------------------------------------------------------------
ANS1094E

An error occured trying to connect to the restore location on the
virtual machine. Verify that the restore location exists on the virtual
machine and that your account has access to it.



Explanation:

During restore processing, the system creates a share to access the
restore location on the virtual machine. In this situation, the system
was unable to create a share. This error typically occurs if the restore
location does not exist or the user account does not have access to the
location.

System action:

The system was unable to create a share.

User response:

Verify that the restore location exists on the virtual machine and that
your account has access to it.

------------------------------------------------------------------------
ANS1096S

Either the node does not exist on the server or there is no active
policy set for the node.



Explanation:

This error occurs when you try to access another node's data. Either the
node is not registered with the IBM Spectrum Protect server, or there is
no active policy set for the node.

System action:

Processing stops.

User response:

Verify that the node whose data you are trying to access is registered
with the IBM Spectrum Protect server. If you have more than one IBM
Spectrum Protect server, make sure you are connecting to the correct
server, then try the operation again. If the problem persists, contact
your IBM Spectrum Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1097E

The client help text cannot be read from the help file.



Explanation:

The help file was opened successfully and its table of contents are
available, but there is a problem reading the text from the help file.

System action:

Processing stopped.

User response:

If the DSM_DIR environment variable is set, verify that it points to the
directory containing the current level of IBM Spectrum Protect program
files, then try the operation again. If the problem recurs, re-install
the client software. If the problem persists, IBM technical support for
further assistance.

------------------------------------------------------------------------
ANS1098E

Process terminated; Program memory exhausted.



Explanation:

The program used all available storage.

System action:

Processing stopped.

User response:

Free any unnecessary programs (TSRs) that are running, and retry the
operation. Reducing the scope of queries and the amount of data returned
can also solve the problem.

------------------------------------------------------------------------
ANS1099E

File 'filename' not previously archived



Explanation:

You tried to give access to a file, which is not stored on the server.

System action:

Processing stopped.

User response:

Ensure that the correct filename is specified.

------------------------------------------------------------------------
ANS1100E

File 'filename' not previously backed up



Explanation:

You tried to give access to a file, which is not stored on the server.

System action:

Processing stopped.

User response:

Ensure that the correct filename is specified.

------------------------------------------------------------------------
ANS1101E

User is not authorized to encrypt file-space
namedirectory_pathfile_name.



Explanation:

The user is not authorized to encrypt the file. Normally, only a IBM
Spectrum Protect authorized user or a root user can use IBM Spectrum
Protect encryption. However, a certain combination of PASSWORDACCESS and
ENCRYPTKEY options may allow encryption operations by a non-authorized
user.

System action:

The file is not backed up or restored.

User response:

Log in as a root or IBM Spectrum Protect authorized user and try the
operation again. See IBM Spectrum Protect Backup-Archive Client
Installation and User's Guide for the correct usage of the ENCRYPTKEY
option.

------------------------------------------------------------------------
ANS1102E

An excessive number of command line arguments are passed to the program.



Explanation:

This command processing routine received more operands than it can use.
The rules are:

*  Query can contain only one file specification.

*  Restore and Retrieve can contain two file specifications.

*  Archive, Incremental, and Selective can contain a maximum of 20 file
   specifications. To bypass the 20-operand limit, use the
   -REMOVEOPERANDLIMIT option on the failing archive, incremental, or
   selective command.

Note: The Client operates much more efficiently if it expands wild cards
internally, rather than accepting the expanded list from the shell.

System action:

Processing stopped.

User response:

Reduce the number of arguments and retry the operation. For UNIX-based
systems, ensure that you have surrounded the specification containing
pattern matching characters with quotes. As an alternative, use the
-REMOVEOPERANDLIMIT option on the failing archive, incremental, or
selective command.

------------------------------------------------------------------------
ANS1103E

Invalid management class entered



Explanation:

You entered an invalid management class.

System action:

Requested operation is not possible.

User response:

Retry the operation using a valid management class.

------------------------------------------------------------------------
ANS1104E

The management class for this file does not have a valid archive copy
group. This file will not be archived.



Explanation:

The management class for this file does not have an archive copy group
specified. This file will not be archived.

System action:

Processing stopped.

User response:

Add a valid archive copy group to the management class, and then retry
the operation.

------------------------------------------------------------------------
ANS1105E

The management class for this file does not have a valid backup copy
group. This file will not be backed up.



Explanation:

The management class for this file does not have a backup copy group
specified. This file will not be backed up.

System action:

Processing stopped.

User response:

Add a valid backup copy group to the management class, and then retry
the operation.

------------------------------------------------------------------------
ANS1106E

ENCRYPTKEY SAVE not configured correctly. Encryption not used.



Explanation:

This message is issued for IBM Spectrum Protect Authorized Users and
root users when ENCRYPTKEY SAVE and PASSWORDACCESS PROMPT options are
set. Please note that these are the default values. These values do not
allow encryption.

System action:

The file is not encrypted.

User response:

To save encryption keys, you must change configuration values. Add
PASSWORDACCESS GENERATE to your system option file.

------------------------------------------------------------------------
ANS1107E

Invalid option/value: 'option'



Explanation:

You specified an incorrect IBM Spectrum Protect option or option value.

System action:

For the command line client: Processing stops.

For the native GUI client: There is a small set of options critical to
the initialization of the client. If an error is found in one of these,
this message is presented and the client terminates without further
processing.

User response:

Specify a correct IBM Spectrum Protect option as defined in the
appropriate Using the Backup-Archive Client book for the particular
operating system.

------------------------------------------------------------------------
ANS1108E

Invalid option (option) for the function command.



Explanation:

There are two possible reasons for this message:

*  The option option was specified for a command or subcommand
   (function) that cannot make use of that option.

*  The option appears on the initial command line and is not valid
   there.

System action:

Processing stopped.

User response:

See the Backup-Archive Client Installation and User's Guide for correct
use of the named option.

------------------------------------------------------------------------
ANS1110E

The client help file file-name could not be opened.



Explanation:

This usually occurs when the help file file-name cannot be found.

System action:

Processing stopped.

User response:

If the DSM_DIR environment variable is set, verify that it points to the
directory containing the current level of IBM Spectrum Protect program
files, then try the operation again. If the problem recurs, re-install
the client software. If the problem persists, IBM technical support for
further assistance.

------------------------------------------------------------------------
ANS1111E

The requested operation is not possible using the management class that
was entered.



Explanation:

The management class is not valid because the Data Version Exists value
is greater than 30. For local backups on a VVOL datastore, this value
must be 1 - 30.

System action:

Processing stopped.

User response:

Retry the operation using a valid management class.

------------------------------------------------------------------------
ANS1113E

The snapshot cache location is not valid.



Explanation:

The snapshot cache location must point to a local volume that is
formatted with NTFS. The default cache location is on the same volume
where the snapshot is being performed. The operation will continue
without snapshot support.

System action:

The client does not execute the snapshot backup operation.

User response:

Specify a different snapshot cache location using the
SNAPSHOTCACHELOCATION option.

------------------------------------------------------------------------
ANS1114I

Waiting for mount of offline media.



Explanation:

The server is waiting for the requested media to become available before
the operation can continue.

System action:

Waiting for requested data.

User response:

None.

------------------------------------------------------------------------
ANS1115W

File 'file-namefile-namefile-name' excluded by Include/Exclude list



Explanation:

You can not back up, archive, or migrate files that are excluded.

System action:

The file can not be processed.

User response:

If the file is intentionally excluded, then this message can be ignored.
Otherwise modify the include/exclude list, restart the client, and try
the operation again. Contact your IBM Spectrum Protect administrator for
further assistance.

------------------------------------------------------------------------
ANS1116E

The process is running in a non-interactive mode, but requires user
input.



Explanation:

This process requires keyboard input, but non-interactive processes are
unable to read input from keyboard.

System action:

processing stops.

User response:

Perform the following actions to resolve this error:

*  Run the product in interactive mode.

*  Ensure your password is set correctly.

------------------------------------------------------------------------
ANS1117E

The PICK and LATEST options are not valid together



Explanation:

During a restore, PICK and LATEST options cannot be used together.

System action:

Processing stopped.

User response:

Try again using either the PICK or the LATEST option.

------------------------------------------------------------------------
ANS1118I

Invalid file space number entered. Try again.



Explanation:

The number that represents a file space was incorrect while you were
using the PICK option.

System action:

The process waits for your specification.

User response:

Enter a correct file space number.

------------------------------------------------------------------------
ANS1119I

Initiating the removal of 'filespace-name' file space.



Explanation:

Indicates that file space deletion has started on the specified
filespace-name.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1120E

Removal of file space 'filespace-name' failed



Explanation:

An attempt was made to delete a filespace (either NAS or normal) and it
was unsuccessful.

*  Your client registration may not be authorized to delete filspaces on
   the server. Look for message ANS1126E.

*  The named filespace does not exist on the server. Look for message
   ANS1122W.

*  Other causes which will be made known in messages following this one

System action:

processing stops.

User response:

Take action as recommended by other messages that accompanies this one.
If so indicated, try to remove the file space again. If the problem
continues, your IBM Spectrum Protect administrator has the authority to
delete the file space for you.

------------------------------------------------------------------------
ANS1121I

A request for removal of file space 'filespace-name' has been
successfully sent to the server.



Explanation:

IBM Spectrum Protect has requested deletion of the specified
filespace-name. The deletion process may not have actually been
completed when this message is displayed. To verify successful deletion,
consult the server logs.

It is possible for errors to occur on the server during the deletion
process, or the file space might contain archive objects in
deletion-hold status. In either case, the file space will not be
deleted.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1122W

File space 'filespace-name' does not exist on the server. The file space
might have been deleted by another client using your client's node name
or an administrator.



Explanation:

The specified filespace-name does not exist on the server. Your system
administrator deleted the file space or another client using your
client's node name might have deleted it.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1123E

The vertical screen dimension is too small to display the Help
directory. Increase your window height.



Explanation:

Execution of the HELP command requires space for both the user prompts
and at least one line of the HELP directory.

System action:

The help directory is not displayed, and the help command cannot
complete.

User response:

Increase the size of your display window to allow more rows of text to
be displayed.

------------------------------------------------------------------------
ANS1125E

Unmatched Quotes: 'string'



Explanation:

The quotes specified in the pattern are not the same and do not make a
set.

System action:

Processing stopped.

User response:

Correct the pattern using matching quotes in the syntax.

------------------------------------------------------------------------
ANS1126E

The file space cannot be deleted because this node does not have
permission to delete archived or backed up data.



Explanation:

You cannot delete the file space data unless your IBM Spectrum Protect
administrator has authorized your node to do so. Authorization permits
you to delete backup data, archive data, or both.

System action:

Delete processing fails.

User response:

Use the DSMC QUERY SESSION command to verify your authorization. Ask
your IBM Spectrum Protect administrator to provide the necessary
authorization or to delete the file space for you.

------------------------------------------------------------------------
ANS1127E

Your node does not have permission to delete archived files.



Explanation:

You cannot delete archived files unless your IBM Spectrum Protect
administrator has authorized your node to do so.

System action:

IBM Spectrum Protect does not delete the archived files.

User response:

Use the DSMC QUERY SESSION command to verify your authorization. Ask
your IBM Spectrum Protect administrator to provide the necessary
authorization.

------------------------------------------------------------------------
ANS1128S

The management class assigned to directories does not exist.



Explanation:

The management class named on the DIRMC option does not exist in your
assigned policy set on the server. The error log contains an entry
showing the invalid management class name.

System action:

processing stops.

User response:

Remove the current DIRMC option from the client options file, then run
DSMC QUERY MGMTCLASS -DETAIL to view information about available
management classes. Make sure the management class you select has a
backup copy group. If you have more than one IBM Spectrum Protect
server, make sure you are connecting to the correct server. If you are
unable to find a suitable management class, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1129S

There is no backup copy group in the management class used for
directories.



Explanation:

The DIRMC option names a management class that contains no backup copy
group.

System action:

processing stops.

User response:

Remove the current DIRMC option from the client options file, then run
DSMC QUERY MGMTCLASS -DETAIL to view information about available
management classes. Make sure the management class you select has a
backup copy group. If you have more than one IBM Spectrum Protect
server, make sure you are connecting to the correct server. If you are
unable to find a suitable management class, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1130E

The drive has no label. The operation cannot continue.



Explanation:

Backup or archive of removable media requires that the media have a
volume label. An attempt was made to back up or archive data on a
removable volume that has no label.

System action:

The requested operation does not run.

User response:

Create a volume label on the removable media, then try the operation
again.

------------------------------------------------------------------------
ANS1131E

A duplicate volume label exists. The operation cannot continue.



Explanation:

For removable media, IBM Spectrum Protect uses the volume label as the
file space name. To prevent data from different volumes being stored in
the same file space on the IBM Spectrum Protect server, backup or
archive of removable media volumes having duplicate volume labels is not
allowed.

System action:

The requested operation does not run.

User response:

Change the volume labels on the removable media volumes so that there
are no duplicate labels. Then restart IBM Spectrum Protect and try the
operation again.

------------------------------------------------------------------------
ANS1132E

'Access rule' Access Rule already defined for node 'node'. Old rule must
be deleted before new one can be defined.



Explanation:

You are trying to define authorization for the specified node, which
already has authorization defined.

System action:

IBM Spectrum Protect did not redefine authorization for the specified
node.

User response:

Update the authorization, or delete the old rule and define a new one,
or use the current authorization.

------------------------------------------------------------------------
ANS1133W

An expression might contain a wildcard not enclosed in quotes.



Explanation:

The command cannot be processed because a UNIX shell expands a wildcard
expression, such as an asterisk (*) or a question mark (?), that has no
quotes.

If the expression contains no wildcard characters and you wish to place
more than the stated limit of operands on the Archive, Selective, or
Incremental command, add the -REMOVEOPERANDLIMIT option to the command,
and try it again.

System action:

Command dependent.

User response:

Enclose the wildcard expression in quotes, or add the
-REMOVEOPERANDLIMIT option and enter the command again.

------------------------------------------------------------------------
ANS1134E

Drive drive-name is an invalid drive specification



Explanation:

The specified drive name is not valid; the drive probably has not been
defined.

System action:

Process skips the invalid drive and continues to the next drive.

User response:

Check the invalid drive.

------------------------------------------------------------------------
ANS1135E

Drive drive-name1 is a virtual drive of drive-name2. It cannot be backed
up or archived.



Explanation:

One drive is a substitute (SUBST) of the other drive. The SUBST drive
cannot be backed up or archived.

System action:

The SUBST drive is skipped. Processing continues with the next drive.

User response:

Do not specify any file specifications for a drive that is a substitute
of another drive. Remove any explicit substitute drives from the DOMAIN
statement or use the -<drive:> notation to remove a substitute drive if
ALL-LOCAL is specified.

------------------------------------------------------------------------
ANS1136E

Not file owner



Explanation:

The file cannot be backed up because the client is not the file owner.

System action:

The file is skipped.

User response:

None.

------------------------------------------------------------------------
ANS1137W

Invalid Index 'number' skipped.



Explanation:

An incorrect number was entered for the Index.

System action:

Processing stopped.

User response:

Correct the Index entry and retry the operation.

------------------------------------------------------------------------
ANS1138E

The 'command-name' command must be followed by a subcommand



Explanation:

You entered an incomplete command-name.

System action:

Processing stopped.

User response:

Enter the correct syntax of the command and continue.

------------------------------------------------------------------------
ANS1139W

'object-nameobject-nameobject-name' was restored as 'temp-name'. A
reboot is required to complete the restore.



Explanation:

The file being restored was in use by another application, so it could
not be immediately replaced. The file will be replaced during the next
reboot of the operating system. It is important to note that until the
reboot occurs, the system or its applications might be unstable. The
degree of instability depends on the criticality of the file to the
operating system or applications.

System action:

The file was restored with a temporary name, and instructed the
operating system to replace the original file with the restored file
during the next boot of the operating system.

User response:

Reboot the machine as soon as possible after the restore operation ends.

------------------------------------------------------------------------
ANS1140E

Invalid format for Set Access command.



Explanation:

The SET ACCESS command must have at least three operands, the first of
which must be either BACKUP or ARCHIVE. A validly formed file
specification must follow.

System action:

Processing stopped, the command is not executed.

User response:

Use the HELP SET ACCESS command for complete details of usage, then
enter the SET ACCESS command using the correct syntax.

------------------------------------------------------------------------
ANS1141W

Unknown command - command-name



Explanation:

You entered an incorrect command-name.

System action:

None.

User response:

Enter the correct command.

------------------------------------------------------------------------
ANS1143E

The DIRSONLY and FILESONLY options are not valid together



Explanation:

The DIRSONLY and FILESONLY options cannot be used together.

System action:

Processing stopped.

User response:

Try again using either the DIRSONLY or the FILESONLY option.

------------------------------------------------------------------------
ANS1144W

Password authentication not active on server



Explanation:

None.

System action:

Processing stopped.

User response:

Because password authentication is turned off on the server, you do not
need to update the password.

------------------------------------------------------------------------
ANS1145E

The maximum macro nesting level has been exceeded. Macros may be nested
up to 10 levels.



Explanation:

IBM Spectrum Protect allows macros to invoke other macros, for example,
macro 'A' invokes macro 'B' which, in turn, invokes macro 'C'. This is
nesting to 3 levels. The limit is 10 levels (the inital macro plus nine
levels of calls within macros currently executng). There is no limit to
the number of different macro calls that may be made within a macro as
long as the calls are not nested.

System action:

The macro is ignored and an error is returned.

User response:

Reduce the level of macro nesting.

------------------------------------------------------------------------
ANS1146E

Macro file 'file spec' cannot be opened.



Explanation:

A macro command has been entered that specifies the macro file name
shown. However, that file cannot be opened for reading.

System action:

The macro is ignored and an error is returned.

User response:

Enter the command with the proper macro name.

------------------------------------------------------------------------
ANS1147E

File is temporarily unavailable.



Explanation:

File is temporarily unavailable.

System action:

File skipped.

User response:

Check and see if file is locked by other process. If not, retry the
command.

------------------------------------------------------------------------
ANS1148I

'Command-name' command successfully completed



Explanation:

The specified command-name was successfully completed.

System action:

Command completed.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS1149E

No domain is available for incremental backup. The domain may be empty
or all file systems in the domain are excluded.



Explanation:

An incremental backup was started, but no domain was selected. Possible
reasons for this message include:

*  An attempt was made to back up a file system that is excluded with
   the EXCLUDE.FS option.

*  The DOMAIN is empty. That is, a DOMAIN statement excludes one or more
   file systems, but no DOMAIN statements include any file systems.

*  DOMAIN ALL-LOCAL is in effect but the system has no local file
   systems.

System action:

processing stops.

User response:

Verify that the DOMAIN statements are properly configured and try the
backup again. DOMAIN statements can be in client option files (dsm.opt,
dsm.sys), client option sets, schedule definitions, and scripted IBM
Spectrum Protect commands. Corrective actions include:

*  Make sure the DOMAIN option settings specify the file systems you
   want to back up.

*  If a file system that should be backed up is excluded by an
   EXCLUDE.FS statement, remove the EXCLUDE.FS statement.

*  If a file system that should not be backed up is listed in a DOMAIN
   statement, remove the file system from the DOMAIN statement.

*  Make sure the DOMAIN is not empty. That is, if any DOMAIN statements
   exclude file systems from backup, make sure the DOMAIN statements
   include the file systems that should be backed up.

------------------------------------------------------------------------
ANS1150E

Unable to restore current user profile because you are running as a
local system account.



Explanation:

The local system account does not have a profile. Therefore you cannot
restore its profile.

System action:

Processing stops.

User response:

Log on to the user whose profile you want to restore.

------------------------------------------------------------------------
ANS1151E

'drive-name1' is not a cluster disk.



Explanation:

The indicated file system is not a cluster disk. Because the CLUSTERNODE
option is set to YES, the file system cannot be backed up or archived.

System action:

Processing stops.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the client
manual for further information about configuring the client to run in a
cluster environment.

------------------------------------------------------------------------
ANS1152E

The VMware vStorage API reported a failure to quiesce the virtual
machine.



Explanation:

A VDDK error occurred while quiescing the virtual machine.

System action:

A VMware vStorage API error occurred, and the virtual machine backup
failed.

User response:

This error can occur if there is a lot of activity on the virtual
machine at the time the snapshot is occurring. Try setting the
INCLUDE.VMSNAPSHOTATTEMPTS option to resolve this issue. Also, check the
VMware logs for possible causes of the error, and try the operation
again.

------------------------------------------------------------------------
ANS1153E

'drive-name1' is a cluster disk.



Explanation:

The indicated file system is a cluster disk. Because the CLUSTERNODE
option is set to NO, the file system cannot be backed up or archived.

System action:

Processing stops.

User response:

If the CLUSTERNODE option is incorrectly set to NO, then change the
option to YES and try the operation again. Otherwise see the client
manual for further information about configuring the client to run in a
cluster environment.

------------------------------------------------------------------------
ANS1154E

Object name 'filespace namepath-namefile-name' contains an invalid
multibyte sequence for the current locale.



Explanation:

An illegal multibyte sequence for the current locale was found in the
object name. Either the path or file name has been corrupted or is coded
in a language other than that of the current locale.

System action:

Object skipped.

User response:

If the file name and path are not corrupted, process the file in the
locale for which it is valid. In case of snapdiff backup, please contact
administrator to check environment and run full incremental backup after
the error is fixed.

------------------------------------------------------------------------
ANS1155E

No domain is available for image backup.



Explanation:

An image backup was started, but no domain was specified.

System action:

Processing stopped.

User response:

Choose a domain and restart the image backup. Set the image domain using
the domain.image option in your dsm.opt file, either manually, or by
using the GUI preferences editor.

------------------------------------------------------------------------
ANS1156E

NODENAME cannot be the local machine name when CLUSTERNODE is set to YES



Explanation:

When IBM Spectrum Protect is running as a cluster node, the node name
cannot be the local machine name.

System action:

Processing stops.

User response:

Change the node name either to the cluster name or to any other name,
and restart IBM Spectrum Protect.

------------------------------------------------------------------------
ANS1157E

The registry cannot be backed up or restored when the client is running
as a cluster node.



Explanation:

When the CLUSTERNODE option is set to YES, the registry cannot be backed
up or restored.

System action:

The registry is not backed up or restored.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the client
manual for further information about configuring the client to run in a
cluster environment.

------------------------------------------------------------------------
ANS1158E

The event logs cannot be backed up or restored when the client is
running as a cluster node.



Explanation:

When the CLUSTERNODE option is set to YES, the event logs cannot be
backed up or restored.

System action:

The event logs are not backed up or restored.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the client
manual for further information about configuring the client to run in a
cluster environment.

------------------------------------------------------------------------
ANS1159E

The specified file is being used by another process



Explanation:

The specified file is being used by another process. You tried to read
from or write to a file that is currently being used by another process.

System action:

Processing stopped.

User response:

Ensure that you specified the correct file or directory name, correct
the permissions, or specify a new location.

------------------------------------------------------------------------
ANS1162E

Filesystem could not be mounted



Explanation:

The system call to mount the file system failed.

System action:

The file system remains unmounted.

User response:

Use the mount command to mount the file system. On AIX, run fsck if
requested by the operating system.

------------------------------------------------------------------------
ANS1163E

Filesystem could not be unmounted.



Explanation:

The system call to unmount the file system failed.

System action:

The logical volume operation is not performed.

User response:

Make sure the device or file system is not being accessed, then retry
the operation.

------------------------------------------------------------------------
ANS1164E

Filesystem is not mounted



Explanation:

The named file system is not currently mounted. It must be mounted for
IBM Spectrum Protect to perform an image backup.

System action:

The logical volume operation is not performed.

User response:

Mount the file system.

------------------------------------------------------------------------
ANS1165E

Destination is smaller than source



Explanation:

The space allocation for the selected destination is smaller than the
source.

System action:

The restore operation is not performed.

User response:

Choose a different, bigger destination or increase the size of the
destination file space.

------------------------------------------------------------------------
ANS1166E

Source and destination are not the same file system type.



Explanation:

The source and destination file system types do not match.

System action:

The requested logical volume operation is not performed.

User response:

Choose a destination that has the same file system type as the source.

------------------------------------------------------------------------
ANS1168E

ERROR: could not create image object.



Explanation:

Creation of the image object failed for one of the following reasons:

*  The image command was executed by a non-root user

*  The image plugin library was not found.

System action:

The requested logical volume function is not performed.

User response:

Retry the operation after correcting the cause for failure.

------------------------------------------------------------------------
ANS1169W

There is no table of contents for image-name.



Explanation:

The image item for which a table of contents was requested is either a
RAW logical volume or it was backed up without the -TOC option.

System action:

No table of contents is displayed.

User response:

Select another image object for TOC display.

------------------------------------------------------------------------
ANS1170I

Invalid selection number entered. Try again.



Explanation:

A number not shown in the list of images was selected. It is either less
than one or greater than the highest item number displayed.

System action:

Client prompts for you to enter a valid selection.

User response:

Enter a number from the list or 'Q' to quit.

------------------------------------------------------------------------
ANS1177E

Must specify a path for this operation.



Explanation:

A path must be specified for this operation to execute successfully.

System action:

Processing stops.

User response:

Specify a valid path and execute the command again.

------------------------------------------------------------------------
ANS1181E

There was a communication failure with the journal service.



Explanation:

An error occurred using named pipe communication with the journal
service.

System action:

Processing stops.

User response:

Restart the journal service, then try the operation again. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1183E

An unknown error occurred while processing system object
'sys-obj-name':MS API function 'func-name' failed with error error
(error)



Explanation:

An unknown error occurred while processing a system object. The error
information captured indicates the reason for the failure. This
information can be used to diagnose the problem.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS1184W

The command subcommand command is not supported on this client.



Explanation:

The command subcommand command is not supported for the client running
on this operating system on this computer.

System action:

The command is not processed.

User response:

None.

------------------------------------------------------------------------
ANS1185E

The help search argument you supplied "string" is either too long or
contains unmatched quotes.



Explanation:

Valid arguments are the names of things like section numbers, command
names, option names and message numbers. All of these search arguments
are short and none requires quoting.

System action:

The help request is not executed and you are given another chance to
enter a valid argument, display the table of contents, or exit help.

User response:

Respond to the subsequent prompt as directed.

------------------------------------------------------------------------
ANS1186I

The named file does not have the content to support the help section.
Requests for message help will all result in topic not found. Enter a
section number, option name, command name, or a command and subcommand.
Otherwise press enter or 't' to display the table of contents or 'q' to
exit help:



Explanation:

Reinstall the product to correct the help file.

System action:

The help command pauses and allows you to make another selection.

User response:

During installation a proper help file was created. Your system
administrator can assist you with retrieving the original help file to
replace the named invalid file.

------------------------------------------------------------------------
ANS1187E

The named helpfile "filename" has invalid content.



Explanation:

Reinstall the product to correct the help file.

System action:

The help command is terminated.

User response:

During installation a proper help file was created. Your system
administrator can assist you with retrieving the original help file to
replace the named invalid file.

------------------------------------------------------------------------
ANS1188E

The selected filesystem is managed by HSM, and therefore is not a valid
object for image operations



Explanation:

Due to the nature of HSM, image backup is not allowed on managed
filesystems.

System action:

The requested logical volume operation is not performed.

User response:

None.

------------------------------------------------------------------------
ANS1189E

The DIRSONLY and V2ARCHIVE options are not valid together



Explanation:

The DIRSONLY and V2ARCHIVE options cannot be used together.

System action:

Processing stopped.

User response:

Try again using either the DIRSONLY or the V2ARCHIVE option.

------------------------------------------------------------------------
ANS1190E

Symbolic link 'linkname' to 'target' was successfully deleted.



Explanation:

Log 'linkname' cannot be a symbolic link.

System action:

The symbolic link 'linkname' is deleted, the log is recreated, and
processing stops.

User response:

Check the location of the new file. To specify the location of log
files, refer to the user's manual for the 'errorlogname' option, the
'schedlogname' option, and the 'DSM_LOG' environmental variable.

------------------------------------------------------------------------
ANS1191E

Unable to delete symbolic link 'link'.



Explanation:

Log 'linkname' cannot be a symbolic link.

System action:

Processing stops.

User response:

Delete the symbolic link 'linkname'.

------------------------------------------------------------------------
ANS1192E

Specifying the error log 'link' as a symbolic link is not allowed.



Explanation:

Error log 'linkname' cannot be a symbolic link.

System action:

The symbolic link 'linkname' is deleted, the error log is recreated, and
processing stops.

User response:

Check the location of the new error log. To specify the location of the
error logs, refer to the user's manual for the 'errorlogname' option and
'DSM_LOG' environmental variable.

------------------------------------------------------------------------
ANS1193E

Specifying the trace file 'link' as a symbolic link is not allowed.



Explanation:

For reasons of security and system integrity, the trace file 'linkname'
cannot be a symbolic link.

System action:

The symbolic link 'linkname' is deleted, the trace file is recreated,
and processing stops.

User response:

Use the TRACEFILE option to specify the actual trace file location
without the use of symbolic links.

------------------------------------------------------------------------
ANS1194E

The VMware vStorage API reported another task was in progress for the
virtual machine.



Explanation:

A VMware vStorage API error occurred due to another task in progress for
the virtual machine.

System action:

A VMware vStorage API error occurred, and the virtual machine backup
failed.

User response:

Wait for the other task to complete and try the operation again.

------------------------------------------------------------------------
ANS1197E

A VMware Virtual Disk Kit (VDDK) API read failure occurred while reading
data for backup.



Explanation:

There was a VMware Virtual Disk Kit (VDDK) API read error while reading
data to backup.

System action:

A VMware Virtual Disk Kit (VDDK) API read error occurred, and the
virtual machine backup failed.

User response:

Check the VMware logs for possible causes of the read error, and try the
operation again.

------------------------------------------------------------------------
ANS1198E

The VMware Virtual Disk Kit (VDDK) API reported an out-of-memory
condition while reading data for backup.



Explanation:

A VMware Virtual Disk Kit (VDDK) API read error occurred due to
out-of-memory condition while reading data to backup.

System action:

A VMware Virtual Disk Kit (VDDK) API read error occurred. The virtual
machine backup failed.

User response:

Check the VMware logs for possible causes of the read error, and try the
operation again.

------------------------------------------------------------------------
ANS1199E

The PRESNAPSHOTCMD command failed. The image snapshot backup will not be
executed.



Explanation:

The command specified by the PRESNAPSHOTCMD option must complete
successfully in order to execute the image snapshot backup. If the
command completed with a return code of 0 (zero), it is considered to
have completed successfully. If the command completed with any other
return code, it is considered to have failed. If the command failed then
the image snapshot backup is not executed.

System action:

The client does not execute the image snapshot backup operation.

User response:

Identify and repair the problem that caused the command to fail. If a
non-zero return code is normal for this command, then consider wrapping
the command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1200W

The POSTSNAPSHOTCMD command completed with a non-zero return code.



Explanation:

If the command specified by the POSTSNAPSHOTCMD option completed with a
non-zero return code, then the image snapshot backup operation will
continue, but with a warning-level result. Note that the result of the
POSTSNAPSHOTCMD command will not supercede a higher result from the
image snapshot backup command. For example, if the image snapshot backup
command completed with a return code of 12, the image snapshot backup
will be considered to have completed with a return code of 12,
regardless of the outcome of the POSTSNAPSHOTCMD command.

System action:

The image snapshot backup continues, but with a warning return code of
at least 8.

User response:

Identify and repair the problem that caused the command to fail. If a
non-zero return code is normal for this command, then consider wrapping
the command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1201E

IBM Spectrum Protect cannot build a directory path because a file exists
with the same name as the directory.



Explanation:

None

System action:

Processing stopped.

User response:

Remove or rename the file that has the same name as the directory.
Alternatively, you can restore the directory to a different location.

------------------------------------------------------------------------
ANS1202E

TOC backup for the image failed. Check log files.



Explanation:

An error occurred during backup of the table of contents. Check the
error log for more information.

System action:

The requested logical volume operation is not performed.

User response:

Check error log.

------------------------------------------------------------------------
ANS1203E

Table of Contents not available for selected backup set. Please contact
server administrator.



Explanation:

There is no TOC for selected backup set

System action:

Expansion of selected backup set will not be possible. Will only be able
to restore the whole backup set.

User response:

Please contact server administrator to regenerate TOC for backup set
before backup set can be expanded.

------------------------------------------------------------------------
ANS1204E

This client is not supported by the IBM Spectrum Protect express server



Explanation:

This client is not supported by the IBM Spectrum Protect express server.
This can occur if:

1. the client is configured as an IBM Spectrum Protect express client
   using the CLIENTVIEW option

2. the client is trying to connect to an IBM Spectrum Protect express
   server.

System action:

Processing stops.

User response:

Log in using a supported IBM Spectrum Protect express client.

------------------------------------------------------------------------
ANS1205E

This is not a supported IBM Spectrum Protect express platform



Explanation:

This is not a supported IBM Spectrum Protect express platform.

System action:

Processing stops.

User response:

Log in using a supported IBM Spectrum Protect express client.

------------------------------------------------------------------------
ANS1206E

TOC backup of a raw device is not supported. But the raw device is
backed up.



Explanation:

TOC backup of a raw device is not supported. But the raw device is
backed up.

System action:

Raw device is backed up with no TOC object.

User response:

NONE.

------------------------------------------------------------------------
ANS1207E

No TOC has been previously backed up for this file system.



Explanation:

The user is trying to query the TOC of a file system. TOC backup for
that file system has not been previously done.

System action:

Query stopped.

User response:

Backup the file system again with -TOC option.

------------------------------------------------------------------------
ANS1209E

The option_name option is not supported with the command_name command
using the -FILELIST option.



Explanation:

The specified option is not supported with the specified command when
the -FILELIST option is also specified.

System action:

The command is not processed.

User response:

>Do not specify the offending option when the -FILELIST option is
specified with this command.

------------------------------------------------------------------------
ANS1212I

Invalid Process number entered. Try again.



Explanation:

A number not shown in the list of processes was selected. It is either
less than one or greater than the highest item number displayed.

System action:

Client prompts for a valid selection.

User response:

Enter a number from the list or 'Q' to quit.

------------------------------------------------------------------------
ANS1213W

Snapshot image backup is not possible for device device-name. starting
static image backup.



Explanation:

On Linux platforms, snapshot image backup is only possible for logical
volumes created by the Linux logical volume manager (LVM). Since the
default image backup type is snapshot, backing up a partition which is
not created using LVM automatically leads to a static image backup.

System action:

Snapshot image backup will failover to static image backup

User response:

To avoid this message, use the imagetype option to specify static or
dynamic image backup.

------------------------------------------------------------------------
ANS1214E

The logical volume group does not have enough free space to contain the
volume snapshot.



Explanation:

The snapshot is created in the volume group that contains the logical
volume being backed up. There is insufficient free space in the volume
group to contain the snapshot.

System action:

The operation ends.

User response:

Decrease the SNAPSHOTCACHESIZE value or make additional space available
in the logical volume group. Then try the operation again.

------------------------------------------------------------------------
ANS1215E

On volumes that are RAW or formatted FAT32 the snapshot cache location
cannot be located on the same volume that is being backed up.



Explanation:

When the snapshot cache location is located on the same volume that is
being backed up the volume must be formatted with NTFS. The default
cache location is on the same volume where the snapshot is being
performed.

System action:

The client does not execute the image snapshot backup operation.

User response:

Specify a different snapshot cache location using the
SNAPSHOTCACHELOCATION option.

------------------------------------------------------------------------
ANS1216E

Not authorized to run IBM Spectrum Protect. See the administrator for
your system.



Explanation:

The system options file for the server that you are attempting to
connect to contains a user entry, a group entry, or both a user and
group entry. Your user ID, or group ID, was not found in any of the
entries. You are currently not authorized to run IBM Spectrum Protect to
this server.

System action:

IBM Spectrum Protect initialization fails and the program ends.

User response:

See the IBM Spectrum Protect administrator for your system, and ask to
be added to the user or group list for this server.

------------------------------------------------------------------------
ANS1217E

Server name not found in System Options File



Explanation:

The system options file does not contain the SERVERNAME option.

System action:

IBM Spectrum Protect initialization fails and the program ends.

User response:

See the IBM Spectrum Protect administrator for your system, and make
sure that the system options file contains the server name.

------------------------------------------------------------------------
ANS1218E

TCPSERVERADDRESS not defined for this server in the System Options File



Explanation:

The TCPSERVERADDRESS for this server is not defined in the server name
stanza in the system options file.

System action:

IBM Spectrum Protect initialization fails and the program ends.

User response:

See the IBM Spectrum Protect administrator for your system, and make
sure that the server to which you are trying to connect, has a valid
TCPSERVERADDRESS defined in the system options file.

------------------------------------------------------------------------
ANS1219E

A virtual node name must not equal either a node name or the system host
name.



Explanation:

A VIRTUALNODENAME option was entered with a name the same as either a
NODENAME option or the system host name.

System action:

Initialization fails and the program ends.

User response:

If the virtual node name entered was the same as the host name, remove
the virtual node name option. If it was the same as the node name
option, you can remove either one, depending upon the intended usage.
Node name is used to assign an alternate name to your system. Virtual
node name is used to access another system's server data.

------------------------------------------------------------------------
ANS1220E

The IBM Spectrum Protect server is out of resources.



Explanation:

A lack of a storage resource or a maximum value condition does not allow
any new activity.

System action:

Current operation has been cancelled.

User response:

Try the operation again at a later time. If the problem continues,
contact your IBM Spectrum Protect administrator to isolate what resource
is unavailable. The IBM Spectrum Protect administrator can check the IBM
Spectrum Protect server activity log for messages that might explain the
problem.

------------------------------------------------------------------------
ANS1221E

Transaction aborted



Explanation:

The current transaction between the server and the client stopped. A
server, client, or communication failure cannot be recovered.

System action:

Current operation has been cancelled.

User response:

Retry the operation. If the problem continues, see your system
administrator to isolate the problem.

------------------------------------------------------------------------
ANS1222E

Disk space limit for this process reached



Explanation:

The disk space allocated for the client owner is full.

System action:

Processing stopped.

User response:

Free up disk space and retry the restore or retrieve operation.

------------------------------------------------------------------------
ANS1223E

File is not compressed; System failure.



Explanation:

A file that was flagged as compressed was not compressed, and the system
failed.

System action:

Processing stopped.

User response:

See your system administrator to report this problem. This error is a
system failure.

------------------------------------------------------------------------
ANS1224E

File compressed on a different client machine that has more memory



Explanation:

You are trying to restore a file that was backed up and compressed on
another client workstation that had more memory than your client
workstation. You cannot restore this file. When the file is restored, it
is expanded and your workstation does not have enough memory.

System action:

Current operation has been cancelled.

User response:

Obtain a machine with more memory and retry the operation.

------------------------------------------------------------------------
ANS1225E

Insufficient memory for file compression/expansion



Explanation:

Not enough memory is available to do data compression or expansion. For
a restore or retrieve, the file cannot be recalled from the server until
more storage is made available. For a backup or archive, try running
without compression if storage cannot be made available.

System action:

Processing stopped.

User response:

Free up extra storage for the operation to continue, or run the backup
or archive process without compression enabled.

------------------------------------------------------------------------
ANS1226E

Destination file or directory is write locked



Explanation:

The file or directory being restored or retrieved from the server cannot
be written to because the destination is write locked. Another operation
might have the file open and will not allow it to be updated.

System action:

File skipped.

User response:

Either determine which operation has the file write locked, or restore
the file to another name or location.

------------------------------------------------------------------------
ANS1227E

Processing stopped; Disk full condition



Explanation:

No more files can be restored or retrieved because the destination disk
is full.

System action:

Processing stopped.

User response:

Free up disk space, or restore or retrieve the file to another disk.

------------------------------------------------------------------------
ANS1228E

Sending of object 'object-nameobject-nameobject-name' failed.



Explanation:

The specified file (object-name) cannot be sent to the server. This
message is accompanied by at least one other message that has more
specific information about why the file could not be processed.

System action:

File skipped.

User response:

Check previous messages pertaining to this file that indicate the reason
for the failure. Where applicable, correct the conditions that prevented
the file from being sent to the server. The specific corrective actions
will depend on the reason for the failure.

------------------------------------------------------------------------
ANS1229E

MODE=INCREMENTAL is not valid on file-space. Image backup not processed.



Explanation:

Because the file space has been the subject of at least one progressive
incremental backup, the MODE=INCREMENTAL option (incremental by image
date) cannot be used with the backup image command.

System action:

File system skipped.

User response:

If an image backup of the named file space is desired, retry the command
without the MODE=INCREMENTAL option. To prevent this behavior in the
future, delete the file space from the server and do only BACKUP IMAGE
-mode=selective and BACKUP IMAGE -mode=incremental from that point on.

------------------------------------------------------------------------
ANS1230E

Stale NFS File Handle



Explanation:

An NFS file system becomes stale.

System action:

File system skipped.

User response:

Check the NFS mounted filesystem.

------------------------------------------------------------------------
ANS1231E

No file handles available



Explanation:

All file handles for your system are currently in use. No more are
available.

System action:

Processing stopped.

User response:

Either free some file handles by ending other processes, or modify your
system setup to allow for more files to be open at the same time.

------------------------------------------------------------------------
ANS1232E

The file exists and cannot be overwritten.



Explanation:

The file being restored or retrieved exists and cannot be overwritten
due to lack of authority or access permissions.

System action:

The file is skipped.

User response:

Verify that you have sufficient access permissions to overwrite the
file, then try the operation again. If the problem persists, contact
your system administrator or IBM Spectrum Protect administrator for
further assistance.

------------------------------------------------------------------------
ANS1233E

An invalid file handle was passed; system error.



Explanation:

An internal system error occurred: A file operation failed because of an
invalid file handle.

System action:

processing stops.

User response:

Try the operation again. If the failure persists, obtain a service trace
that captures the problem and contact IBM technical support for
additional assistance. Your IBM Spectrum Protect administrator can help
you configure the trace.

------------------------------------------------------------------------
ANS1234E

Protocol violation



Explanation:

A communications protocol error occurred. The communication subsystem is
not properly defined or is itself in error.

System action:

Processing Ends.

User response:

Verify that the communication processes are operating properly, and then
retry the operation.

------------------------------------------------------------------------
ANS1235E

An unknown system error has occurred from which IBM Spectrum Protect
cannot recover.



Explanation:

An unknown error occurred. This might be a low-level system or
communication error from which IBM Spectrum Protect cannot recover.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists, review the IBM
Spectrum Protect error log for any related messages. Obtain a service
trace that captures the problem and contact IBM technical support for
additional assistance. Your IBM Spectrum Protect administrator can help
you configure the trace.

------------------------------------------------------------------------
ANS1236E

An unexpected error occurred.



Explanation:

This is usually caused by a low-level system error or communication
error from which IBM Spectrum Protect cannot recover.

System action:

Processing stopped.

User response:

Examine the client error log for any additional messages that might be
related to this problem. Try the operation again. If the problem
persists, contact IBM Spectrum Protect technical support for further
assistance.

------------------------------------------------------------------------
ANS1237E

A problem has occurred on the IBM Spectrum Protect server.



Explanation:

The client error log and the IBM Spectrum Protect server activity log
might contain additional information about this error.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists, examine the client
error log and IBM Spectrum Protect server activity log for additional
information about this error. If the problem cannot be resolved, then
obtain a SERVICE trace that captures the problem and contact IBM
technical support for additional assistance. Your IBM Spectrum Protect
administrator can help you configure the trace.

------------------------------------------------------------------------
ANS1238S

A policy management problem has occurred on the IBM Spectrum Protect
server.



Explanation:

The client error log and IBM Spectrum Protect server activity log may
contain additional information about this error.

System action:

Processing is stops.

User response:

Try the operation again. If the problem persists, examine the client
error log and IBM Spectrum Protect server activity log for additional
information about this error. If the problem cannot be resolved, then
obtain a SERVICE trace that captures the problem and contact IBM
technical support for additional assistance. Your IBM Spectrum Protect
administrator can help you configure the trace.

------------------------------------------------------------------------
ANS1241E

File is in use; Write permission denied.



Explanation:

The current file cannot be opened to write to because it is currently
being run by another operation.

System action:

File skipped.

User response:

Stop the operation that is running the file and retry the operation, or
restore or retrieve the file to a different name or directory.

------------------------------------------------------------------------
ANS1242E

Too many symbolic links were detected while resolving name



Explanation:

While trying to resolve the file name, too many symbolic links were
found.

System action:

File skipped.

User response:

Ensure that you do not have a looping symbolic link for the file.

------------------------------------------------------------------------
ANS1243E

The file name is too long and can not be processed by IBM Spectrum
Protect



Explanation:

The size limit for file names may vary by operating system. The most
common limit is 256 characters. The file name being processed exceeds
the limit supported by IBM Spectrum Protect on this system.

System action:

The file is skipped.

User response:

Enter HELP FILE SPEC or see the client manual for the operating system
on which you are receiving this error. The "File specification syntax"
section of the manual explains file name lengths supported by IBM
Spectrum Protect.

------------------------------------------------------------------------
ANS1244E

File system is locked by system



Explanation:

File system cannot be accessed because it is locked by the system.

System action:

The operation cannot be completed.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1245E

The file has an unknown format.



Explanation:

The process tried to restore or retrieve a file, but it had an unknown
format.

System action:

The file is skipped.

User response:

The file was either backed up by another application, or the data is
invalid. If the file belongs to this system, try the operation again. If
the problem persists, contact IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS1246E

A command-line argument exceeded the maximum length (maximum length) for
a single token.



Explanation:

Command-line arguments may not exceed maximum length characters.

System action:

The command is not processed.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1247I

Waiting for files from the server...



Explanation:

Restore request has been sent to the server. The wait time depends on
how many files you are restoring.

System action:

IBM Spectrum Protect waits for files to restore from the server.

User response:

None.

------------------------------------------------------------------------
ANS1248E

An active restore for the same source file specification exists. Unable
to continue with this request.



Explanation:

Currently, there is an active restore for the same source file
specification. Another restore of the same source file specification
cannot be started.

System action:

The requested restore fails.

User response:

Start another restore with a different source file specification.

------------------------------------------------------------------------
ANS1249W

Server cannot restart the last restore request. Do you want to restore
without restart or abort the request?



Explanation:

The restart restore token has expired. The server cannot restart the
restore from where it last ended.

System action:

Processing stopped; waiting for user intervention.

User response:

Retry the request without restart or abort the request.

------------------------------------------------------------------------
ANS1251E

File system/drive not ready



Explanation:

The file system/drive was not ready for access.

System action:

Processing stopped.

User response:

Ensure that the drive is available , and then retry the operation.

------------------------------------------------------------------------
ANS1252W

The server that you are connected to does not support this function.



Explanation:

You attempted to run a backup-archive client operation when connected to
the virtual server. Backup-archive client operations are not supported
when connected to the virtual server.

System action:

The operation fails.

User response:

Connect to a valid server before attempting this function.

------------------------------------------------------------------------
ANS1253E

File input/output error



Explanation:

An error was found while reading from or writing to the file.

System action:

File or file system is skipped.

User response:

Check your system to ensure that it is operating properly. For OS/2, run
CHKDSK /F for the failing drive which can be found in dsmerror.log.

------------------------------------------------------------------------
ANS1254E

File write error



Explanation:

An error was found while writing to the file.

System action:

File skipped.

User response:

Check your system to ensure that it is operating properly.

------------------------------------------------------------------------
ANS1255E

File exceeds system/user file limits



Explanation:

A file being restored or retrieved exceeds system set limits for this
user.

System action:

File skipped.

User response:

Ensure that the system limits are set properly.

------------------------------------------------------------------------
ANS1256E

Cannot make file/directory



Explanation:

The directory path for files being restored or retrieved cannot be
created.

System action:

File skipped.

User response:

Ensure that you have the proper authorization to create the directory
for file being restored or retrieved. Make sure that you have write
access.

------------------------------------------------------------------------
ANS1257E

An error occurred while preparing the system object for restore.



Explanation:

This message is typically issued when the client is unable to delete the
ADSM.SYS staging directory in preparation for restoring the system
object.

System action:

The system object is not restored.

User response:

Check the error log for any other messages that might indicate a reason
for the failure, correct any indicated problems, then try the operation
again. If the problem occurs again, manually delete the ADSM.SYS
directory, then try the operation again. If the problem cannot be
resolved, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1258E

The image snapshot operation failed.



Explanation:

The process was not able to take a snapshot of the specified volume.

System action:

Processing stopped.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Try to correct any indicated problems, then try the
operation again. If the problem persists, contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS1259E

The image snapshot operation failed. Diagnostic text: diag_text.



Explanation:

An error was encountered during image backup snapshot processing. The
diagnostic text can vary, depending on the error.

System action:

The operation ends.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Take any corrective action suggested by the
messages, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1260E

File is being recalled or has been recalled.



Explanation:

The file is being recalled by another process or has been recalled.

System action:

File skipped.

User response:

None

------------------------------------------------------------------------
ANS1261W

The archive description you specified is the empty string. The process
will use the default description (Archive Date: current date).



Explanation:

The description option on the archive command may not specify a null
string.

System action:

Processing continues, and the description option is ignored.

User response:

None. Specify at least one character in the description

------------------------------------------------------------------------
ANS1262E

The password is not updated. Either an invalid current password was
supplied or the new password does not fulfill the server password
requirements.



Explanation:

The password is not updated because of one of the following reasons:

*  You entered an incorrect current password or

*  You entered a new password that does not fulfill the password length
   requirements. The length requirements are set on the server.

System action:

The password is not updated on the server.

User response:

Enter another password.

------------------------------------------------------------------------
ANS1263E

The active policy set does not contain any backup copy groups. The
backup operation can not continue.



Explanation:

In order to back up files, the policy set must contain at last one
backup copy group.

System action:

IBM Spectrum Protect did not backup the file.

User response:

The IBM Spectrum Protect administrator needs to update or define at
least one management class in your policy set that contains a backup
copy group, or else assign you to a different policy domain that
contains at least one backup copy group. Contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1264E

The active policy set does not contain any archive copy group. The
archive operation cannot continue.



Explanation:

In order to archive files, the policy set must contain at least one
archive copy group.

System action:

IBM Spectrum Protect did not archive the file.

User response:

The IBM Spectrum Protect administrator needs to update or define at
least one management class in your policy set that contains an archive
copy group, or else assign you to a different policy domain that
contains at least one archive copy group. Contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1265E

Encountered bad mount or filesystem, processing stopped.



Explanation:

The getmnt system call returned an error indication. Error was
encountered trying to determine what the mounted file systems are.

System action:

Processing stopped. Cannot recover.

User response:

There is a bad file system or mount point on your system. Look at file
systems and mounts, and correct any errors. If unsuccessful, see your
system administrator for more information.

------------------------------------------------------------------------
ANS1266E

Encountered bad mount or filesystem, processing stopped.



Explanation:

An error was encountered trying to determine what the mounted file
systems are.

System action:

Processing stopped. Cannot recover.

User response:

Please, see your system administrator for more information.

------------------------------------------------------------------------
ANS1267E

The management class for file file-name does not allow migration. This
file will not be migrated.



Explanation:

The management class for this file does not allow migration

System action:

File is skipped.

User response:

Either have the IBM Spectrum Protect administrator change the Space
Management Technique within the management class to a value other than
NONE or change the include/exclude list to specify a management class
with the appropriate Space Management Technique value.

------------------------------------------------------------------------
ANS1268E

This file has been migrated.



Explanation:

The error can result from migrating a file with hard links. After a file
with hard links is migrated, attempts to migrate the alias files yield
an error.

System action:

The file is skipped.

User response:

If this error is not a result of a hard linked file migration, then this
error might be due to the previous cancelled migration or recall
operation. In this case, restart the dsmrecalld daemon and try the
operation again.

------------------------------------------------------------------------
ANS1269I

File is implicitly excluded.



Explanation:

You tried to back up or migrate a file that is implicitly excluded.

System action:

IBM Spectrum Protect will not back up or migrate an implicitly excluded
file.

User response:

None.

------------------------------------------------------------------------
ANS1270E

Running this command requires a valid NetApp Snapshot Differential
c-mode license file.



Explanation:

A NetApp Snapshot Differential c-mode license file either does not exist
or is not valid.

System action:

Processing stops.

User response:

Contact IBM support.

------------------------------------------------------------------------
ANS1271E

The compressed file is corrupted and cannot be expanded correctly.



Explanation:

The compressed file cannot be expanded correctly due to one of the
following reasons:

   There is a problem on the tape.
   There is a communications problem.
   The compressed file was corrupted on the IBM Spectrum Protect Server.

System action:

File skipped.

User response:

1) The compressed file is corrupted because there is a problem on the
tape. To know if this is the problem, please issue the following command
on the IBM Spectrum Protect Server: audit volume <volume_name> fix=no If
there is any problem reported, you could move the data from that volume
to a new one (see command MOVE DATA) and try again the restore. 2) There
are communications problems between the IBM Spectrum Protect Server and
the IBM Spectrum Protect Client and the results is that the file is
corrupted during the transmission. If you use a gigabit Ethernet adapter
on the Server please upgrade the card driver (AIX platform) or add
provided by SUN suggested changes to some system network options which
have resolved this problem (SUN platform). 3) Please verify with your
network support if during the restore there are no any problems between
the IBM Spectrum Protect Client/Server that is originating the file
corruption.

------------------------------------------------------------------------
ANS1272W

Adaptive subfile backup has been configured on the client but the server
doesn't allow this type of backup. Adaptive subfile backup will not be
used for this operation.



Explanation:

Adaptive subfile backup forced off by the server.

System action:

Processing continues.

User response:

Set up the server to allow clients to back up subfiles.

------------------------------------------------------------------------
ANS1273I

Microsoft Windows hotfix 'hotfix-number' is not installed.



Explanation:

This message is issued On Windows 7, Windows Server 2008 R2, Windows
Vista, and Windows Server 2008. This hotfix is known to release new API
enhancements for Windows to help correctly and securely load external
libraries. Visit the Microsoft support page http://support.microsoft.com
for more information about the hotfix.

System action:

Processing continues.

User response:

On Windows 7, Windows Server 2008 R2, Windows Vista, and Windows Server
2008 you must apply the package KB2533623 prior to performing the
Snapshot dirrerential backup. If backup-archive client operations that
use OpenSSL do not complete successfully due to OpenSSL related errors,
install the hotfix, then try the operation again.

------------------------------------------------------------------------
ANS1274E

Error Loading WINSOCK.DLL



Explanation:

Error loading the Windows socket support file into memory. This error
only applies when using TCP/IP communications.

System action:

Connection to server fails.

User response:

Because this error is caused by insufficient memory, shut down running
applications and retry. If the problem persists, see your system
administrator.

------------------------------------------------------------------------
ANS1275E

Error Loading Function(s) from WINSOCK.DLL



Explanation:

Error loading one or more functions from the Windows socket support
file.

System action:

Connection to server fails.

User response:

Since this might possibly be caused by insufficient memory, shut down
running applications and retry. If the problem persists, see your system
administrator.

------------------------------------------------------------------------
ANS1276E

Virtual Machine backup corruption detected. The filespace on the IBM
Spectrum Protect server must be deleted.



Explanation:

Due to APAR IT22660, the backup on the IBM Spectrum Protect server is
corrupt.

System action:

The backup of the virtual machine is skipped.

User response:

Request the IBM Spectrum Protect administrator delete or rename the
virtual machine on the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS1277E

The VMware vStorage API reported that a file was not found for the
virtual machine.



Explanation:

A VMware vStorage API error occurred due to a file not found on the
virtual machine.

System action:

A VMware vStorage API error occurred, and the virtual machine backup
failed.

User response:

Check the VMware logs for possible causes of the error, and try the
operation again.

------------------------------------------------------------------------
ANS1278W

Virtual mount point 'filespace-name' is a file system. It will be backed
up as a file system.



Explanation:

A virtual mount point that is a file system is invalid and should be
deleted.

System action:

The virtual mount point is ignored.

User response:

Delete the virtual mount point.

------------------------------------------------------------------------
ANS1279W

Virtual mount point 'filespace-name' cannot be used in a file system
handled by automounter and is ignored.



Explanation:

Virtual mount points cannot be used in a file system handled by
automounter. If virtual mount points reside in a file system that is
processed from an automounter, the backed up files underneath the
virtual mount points will be expired when the file system is unmounted.

System action:

The virtual mount point is ignored.

User response:

Delete the virtual mount point.

------------------------------------------------------------------------
ANS1286E

-nasnodename option required for this operation.



Explanation:

User issued a NAS related command and NASNodename option is missing.

System action:

Operation aborted.

User response:

Use -nasnodename option with the command or place nasnodename option in
the option file.

------------------------------------------------------------------------
ANS1287E

Volume could not be locked.



Explanation:

The system call to lock the volume failed.

System action:

Processing stopped.

User response:

Please verify that no other application is accessing the volume. If this
volume is being accessed by applications that can not be shutdown during
backup then perform an online image backup (snapshot) instead. During
restore of an image IBM Spectrum Protect must have exclusive use of the
volume.

------------------------------------------------------------------------
ANS1288E

The (-TYPE) option is required with the SET EVENT command.



Explanation:

There is no default value for the -TYPE option. It must be explicitly
entered with the command.

System action:

The current command ends.

User response:

Enter the SET EVENT command again with the TYPE option and a value of
HOLD, RELEASE, or ACTIVATERETENTION.

------------------------------------------------------------------------
ANS1289W

Bad areas on 'volume' between sectors hi:lo and hi:lo



Explanation:

Some bad sectors within the specified range were detected on the volume
during image operation.

System action:

Processing continues.

User response:

Make sure the volume data is not corrupt by using system tools like
chkdsk (Windows) or fsck (UNIX).

------------------------------------------------------------------------
ANS1299E

Unable to generate an encryption key for storing password



Explanation:

You tried to start an operation that led to storing password on the IBM
Spectrum Protect client side but the client was unable to generate an
encryption key very likely due to a configured FIPS-enabled operating
system environment.

System action:

Processing stops.

User response:

The IBM Spectrum Protect client doesn't support the Federal Information
Processing Standard (FIPS) enabled operating system environmnet for
locally stored passwords. See your system administrator for assistance
in reconfiguring the FIPS-enabled operating system environment. For more
details on FIPS support, see the following techdoc:
http://www-01.ibm.com/support/docview.wss?uid=swg22007756

------------------------------------------------------------------------
ANS1300E

File 'file_name' cannot be reconstructed because a necessary component
was not restored.



Explanation:

The subfile backup technique was used to back up this file. During the
restore, a portion of the file was not be obtained from the server.

System action:

The file indicated in the message is not restored. Restore for all other
files continues.

User response:

Try to restore the file again by selecting the file for restore from the
user interface. You can also check the client error log and the server
activity log for any messages related to the file indicated in the
message.

------------------------------------------------------------------------
ANS1301E

This operation cannot continue due to an error on the IBM Spectrum
Protect server. See your IBM Spectrum Protect server administrator for
assistance.



Explanation:

The IBM Spectrum Protect server encountered an error condition that
prevents the IBM Spectrum Protect client operation from continuing. Your
IBM Spectrum Protect server administrator can review the IBM Spectrum
Protect server activity log for more details about the error.

System action:

Processing stopped.

User response:

Contact your IBM Spectrum Protect server administrator for assistance.
The administrator can review the IBM Spectrum Protect server activity
log for further information about the conditions that lead to this
error.

------------------------------------------------------------------------
ANS1302E

No objects on server match query



Explanation:

No objects on the server match the query operation being performed. If
this object is part of a backupset generated on a node, and the node
name is changed on the server, any backup set objects that were
generated prior to the name change will not match the new node name.

System action:

Processing stopped.

User response:

Ensure the names are properly entered. If the object is part of a
backupset generated prior to a node name change, ensure that the node
name is the same as the node for which the backup set was generated.

------------------------------------------------------------------------
ANS1303E

Client ended transaction



Explanation:

The client system ended the operation with the server and ended the
current transaction.

System action:

Processing stopped.

User response:

Restart the session.

------------------------------------------------------------------------
ANS1304W

An active backup version could not be found.



Explanation:

An attempt was made to expire an object, but the IBM Spectrum Protect
server was unable to find an active backup version of the object. This
message is preceded by message ANS1228E which specifies the object name.
For instance, this message could be issued if two separate client
processes are backing up the same file system at the same time. If one
of the processes expires a file, then the IBM Spectrum Protect server
will make that file inactive. If the second process subsequently
attempts to expire that same file, the IBM Spectrum Protect server will
not find an active version of the file, so the second process will issue
this message for that file.

System action:

The object is not expired. Processing continues with the next object.

User response:

*  Review the console output, schedule log, or error log and locate the
   ANS1228E message that immediately precedes this message. ANS1228E
   will identify the object that could not be expired.

*  Examine the conditions under which the problem occurred and assess
   whether those conditions explain the occurrence of this message. For
   example, this message could appear if multiple instances of the
   client were attempting to back up the file system concurrently.

*  If the reason this message occurred can not be determined and the
   message occurs when the operation is tried again, then contact IBM
   support for further assistance. Also try searching for this message
   number on http://www.ibm.com for possible solutions.

------------------------------------------------------------------------
ANS1305E

The IBM Spectrum Protect server has no data for the object.



Explanation:

IBM Spectrum Protect tried to do a restore or retrieve on an object that
has no data associated with it. If a corrective action is possible, it
is with the IBM Spectrum Protect server.

System action:

IBM Spectrum Protect ends the current operation.

User response:

Ask the IBM Spectrum Protect administrator to check the IBM Spectrum
Protect activity log for any messages related to this error that might
help identify the problem.

------------------------------------------------------------------------
ANS1306E

You entered an incorrect password.



Explanation:

You entered an incorrect current password or you entered a new password
that does not fulfill the password length requirements set on the
server.

System action:

Processing stops.

User response:

Retry the session with the correct password. If this fails or you have
forgotten your password, ask the IBM Spectrum Protect administrator to
assign a new password.

------------------------------------------------------------------------
ANS1307E

Node in use



Explanation:

The node you are running on is in use by another operation on the
server. This might be from another client or from some activity on the
server.

System action:

Processing stopped.

User response:

Retry the operation, or see your system administrator to see what other
operations are running for your node.

------------------------------------------------------------------------
ANS1308E

Expiration date must be greater than today's date



Explanation:

Archive expiration date is too low, the date must be greater than
today's date.

System action:

IBM Spectrum Protect canceled the current operation.

User response:

Retry archiving the file with an expiration date that is higher than
today's date.

------------------------------------------------------------------------
ANS1309I

The requested data is offline.



Explanation:

For the restore or retrieve operation, one or more of the requested
files must be recalled from offline storage media (generally tape). The
wait time depends on your site's offline storage management policies.

System action:

IBM Spectrum Protect waits for offline storage media to become available
and then continues.

User response:

None.

------------------------------------------------------------------------
ANS1310E

Object too large for server limits



Explanation:

The object is too large. The configuration of the server does not have
any data storage space that accepts the object.

System action:

File skipped.

User response:

See your system administrator to determine the maximum file (object)
size for which your site's server is configured.

------------------------------------------------------------------------
ANS1311E

Server out of data storage space



Explanation:

The server does not have any space available to store the object.

System action:

Processing Ends.

User response:

You can take any of the following actions:

*  Request the system administrator to add space to the storage pool.

*  For IBM Spectrum Protect client, set COMPRESSALWAYS=NO and
   COMPRESSIon=YES in the options file (DSM.OPT), then the file will be
   resent uncompressed if it grows during compression.

*  For API Applications, consult the application's documentation for
   recommendations regarding compression.

*  Turn off disk caching in the disk storage pool, and issue MOVE DATA
   commands to each disk pool volume to clear out the cached bitfiles.

------------------------------------------------------------------------
ANS1312E

Server media mount not possible



Explanation:

Server media mount not possible. The server timed out waiting for a
mount of an offline volume.

System action:

File skipped.

User response:

Retry later when server volumes can be mounted. Ensure that the MAXNUMMP
(maximum number of mount points) defined on the server for this node is
greater than 0.

------------------------------------------------------------------------
ANS1313E

Size estimate exceeded



Explanation:

The total amount of data for a backup or archive operation exceeds the
estimated size originally sent to the server for allocating data storage
space. This happens when many files are growing by large amounts while
the backup or archive operation is in session.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, check what other
processes are running on the client machine that are generating large
amounts of data. Disable those operations while the backup or archive
operation is taking place.

------------------------------------------------------------------------
ANS1314E

File data currently unavailable on server



Explanation:

The file data is currently unavailable on the server. A retrieve or
restore operation was attempted. Possible causes are:

*  Data was corrupted at the server

*  Server found a read error

*  File is temporarily involved in a reclaim operation at the server

*  Server requested a tape volume that was marked unavailable.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, see your system
administrator to determine the problem from the server console or the
activity log. Check whether any requests were made for a tape volume
that was unavailable. A tape volume may be marked unavailable if prior
read errors were encountered or the volume is checked out of the tape
library.

------------------------------------------------------------------------
ANS1315W

Unexpected retry request. The IBM Spectrum Protect server found an error
while writing the data.



Explanation:

None.

System action:

If the current operation supports another attempt, the client tries the
operation again. Otherwise, processing stops.

User response:

None.

------------------------------------------------------------------------
ANS1316E

The server does not have enough recovery log space to continue the
current operation



Explanation:

The server ran out of recovery log space.

System action:

Processing ends.

User response:

This error is a temporary problem. Retry later or see your system
administrator.

------------------------------------------------------------------------
ANS1317E

The server does not have enough database space to continue the current
operation



Explanation:

The server ran out of database space.

System action:

Processing ends.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1318E

The server does not have enough memory to continue the current
operation.



Explanation:

The server ran out of memory.

System action:

Processing ends.

User response:

This is a temporary problem. Retry later or see your system
administrator.

------------------------------------------------------------------------
ANS1319E

An error occurred on the IBM Spectrum Protect server while trying to
rename file space file_space_name



Explanation:

None.

System action:

Because the file space cannot be renamed, the operation stops.

User response:

Check the client error log and the IBM Spectrum Protect server activity
log for any other messages that might help identify the problem. If the
problem cannot be resolved, contact IBM technical support for additional
assistance.

------------------------------------------------------------------------
ANS1320E

The specified file space does not exist on the server. The file space
might have been deleted by another client or an administrator.



Explanation:

The specified file space does not exist on the server. Your system
administrator deleted the file space or another client using your
client's node name deleted it.

System action:

Current operation has been cancelled.

User response:

Check the file space name to see if it is correct, and retry the
operation.

------------------------------------------------------------------------
ANS1321S

Open Registration failed because the specified node name is defined in
the server



Explanation:

Open registration failed because a node is defined in the server with
the same name.

System action:

Current operation has been cancelled.

User response:

Retry with another node name.

------------------------------------------------------------------------
ANS1322S

Open Registration failed because no default domain exists



Explanation:

Open registration failed because a default policy domain does not exist
for you to place your node.

System action:

Current operation has been cancelled.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1323S

Open Registration failed because an invalid node name was specified



Explanation:

Open registration failed because the specified node name contains
invalid characters.

System action:

Current operation has been cancelled.

User response:

Retry with another node name that does not have any invalid characters.

------------------------------------------------------------------------
ANS1326S

The IBM Spectrum Protect server does not currently have space in the
storage pool for this file. This may be a temporary condition.



Explanation:

This message is typically issued when the storage pool in which the data
is being placed does not have sufficient space to store the data, but
the space will be available soon. For example, a storage pool migration
might free up sufficient space to store the data.

System action:

Current operation has been cancelled.

User response:

Try the operation at a later time. If this fails, contact the IBM
Spectrum Protect administrator and request more storage pool space.

------------------------------------------------------------------------
ANS1327W

The snapshot operation for 'volname' failed with error code: retcode.



Explanation:

A snapshot could not be taken of the specified volume.

System action:

Snapshot processing stopped.

User response:

Check the client error log for any other messages that might help
identify the problem. If the problem cannot be resolved, contact IBM
technical support for additional assistance.

------------------------------------------------------------------------
ANS1328W

An error occurred generating delta file for 'file-name'. The return code
is retcode.



Explanation:

An error occurred that prevented the creation of the delta file.
Possible reasons for this error include:

*  The base file cannot be opened for reading

*  The file being backed up cannot be opened for reading

*  The delta file cannot be opened for writing

*  The file being backed up has grown to a size larger than 2 GB

*  A memory file mapping of the file cannot be created

System action:

A full backup of the file is made, and a new version of the reference
file is stored in the subfile cache.

User response:

If the message indicates return code 4504, check the delta subfile cache
directory for any residual delta files. The delta subfile cache
directory is specified by the client option SUBFILECACHEPATH. Search the
directory for files named \".dXXXXXXXX\" where \"XXXXXXXX"\ is an
eight-digit number. If there are no backup operations in progress, there
should not be any files in the SUBFILECACHEPATH with this name. If there
are no backup operations in progress and these files exist, they can
safely be removed. If you continue to receive this message but there are
no residual delta files in the subfile cache directory and the file has
not grown to a size larger than 2 GB, then contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS1329S

Server out of data storage space



Explanation:

The server does not have space available to store the object.

System action:

Processing Ends.

User response:

Report to your system administrator that a storage pool on the server is
full.

------------------------------------------------------------------------
ANS1330S

This node currently has a pending restartable restore session. The
requested operation cannot complete until this session either completes
or is canceled.



Explanation:

This operation can not be completed because a restartable restore
session is pending. The operation is not allowed because the restartable
session and the current operation affect the same file space.

System action:

Processing Ends.

User response:

Issue a query restore to see the conflict. Issue the cancel restore
command to delete any unneeded restartable restore sessions.

------------------------------------------------------------------------
ANS1331E

Only a IBM Spectrum Protect authorized user can perform this Action.



Explanation:

User must be a IBM Spectrum Protect authorized user to perform this
action. User is not password authorized and this action requires
authorization.

System action:

Processing stopped.

User response:

User must be root user, or user must be the owner of the executable and
the set effective user id bit is set to 'on' ('s' bit).

------------------------------------------------------------------------
ANS1332E

Run the '... for Administrators' version of the application.



Explanation:

The user must be root or a system administrator and use the provided
authorization tools to start IBM Spectrum Protect

System action:

IBM Spectrum Protect terminates.

User response:

The user must login as the root user or be a system administrator and
use one of the following authorization tools to start IBM Spectrum
Protect:

*  "IBM Spectrum Protect Backup for Administrators"

*  "IBM Spectrum Protect Scheduler for Administrators"

*  "IBM Spectrum Protect Scheduler Daemon for Administrators"

------------------------------------------------------------------------
ANS1333E

The remote node is not properly configured on the IBM Spectrum Protect
server.



Explanation:

The remote node is not properly configured on the IBM Spectrum Protect
server.

System action:

Processing stopped.

User response:

Ensure that the remote node is properly configured and connected to the
IBM Spectrum Protect server by using TLS. This validates the remote node
configuration and ensures that the information that is related to the
remote node is sent to the server.

------------------------------------------------------------------------
ANS1334W

Volume mount point 'filespace namepath-namedir-name' was not restored
because the target directory is not empty.



Explanation:

Volume mount points can only be restored if the target directory does
not already exist, or if the target directory exists but is empty. If
the target directory exists and is not empty, or already is a junction
point, then the volume mount point cannot be restored. On Windows Vista,
it is normal to see these warnings during system drive restore as there
are many junction points that point to the '%systemroot%\Users' folder.

System action:

The volume mount point is not restored. Processing continues with the
next object.

User response:

Correct the conflict with the non-empty directory, then try the
operation again. This is especially important when this message is
issued for a volume mount point that resides in the SYSVOL, since an
incomplete SYSVOL restore can result in system stability problems. See
the reference information for the RESTORE command in the client manual
for additional information about restoring volume mount points.

------------------------------------------------------------------------
ANS1335E

The RSM database files could not be restored.



Explanation:

None.

System action:

The RSM database is not restored. Otherwise, processing continues.

User response:

Check the client error log for any other messages that might help
identify the problem. Reboot the system, then try the RSM restore
operation again. If the problem cannot be resolved, contact IBM
technical support for further assistance.

------------------------------------------------------------------------
ANS1336I

RSM service must be restarted for changes to become effective.



Explanation:

RSM database files have been restored from the server and imported. The
RSM service must be restarted for the updates to become effective.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1337I

Restarting the RSM service...



Explanation:

RSM database files have been restored from the server and imported. The
process is about to stop then restart the RSM service.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1338I

Restart of the RSM service is completed.



Explanation:

RSM database files have been restored from the server and imported. The
process has restarted the RSM service on the user's behalf.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1339E

Restart of the RSM service failed. Restart the RSM service manually.



Explanation:

RSM database files have been restored from the IBM Spectrum Protect
server and imported. The process has tried to restart the RSM service on
the user's behalf but has run into a problem.

System action:

Processing stopped.

User response:

Restart the RSM service manually.

------------------------------------------------------------------------
ANS1340E

An error occurred while backing up the RSM database.



Explanation:

An error occurred while backing up the RSM database files. The database
will not be backed up.

System action:

Processing stopped.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1341E

An invalid character appears in the operand: operand.



Explanation:

The operand contains a character that is not valid in the current locale
and code page. It cannot be translated to its internal wide-character
format.

System action:

Processing stops.

User response:

Change the locale of the workstation to match the language in which the
operand is recorded, and try the command again.

------------------------------------------------------------------------
ANS1342E

Client cache is locked; unable to continue with operation.



Explanation:

The client cache is currently locked by another process.

System action:

Processing stopped.

User response:

Report the program error to your service representative.

------------------------------------------------------------------------
ANS1343E

The option 'specified-option' can only be entered when 'other-option'
has been entered.



Explanation:

The command failed because the specified option (specified-option)
option was entered, but the other option (other-option) was not.

System action:

The command is terminated.

User response:

Run the command without the specified option. Alternatively, run the
command with the other option added.

------------------------------------------------------------------------
ANS1344E

Job is running in the background. Cannot prompt for the Key.



Explanation:

When jobs are run in the background, the client cannot prompt for the
key.

System action:

Processing stopped.

User response:

Run the Job in the foreground.

------------------------------------------------------------------------
ANS1345E

No objects on the server match 'object-nameobject-nameobject-name'



Explanation:

The specified file does not have a match on the server.

System action:

The file is skipped.

User response:

Back up the file and try the operation again. If the problem continues,
see your system administrator to isolate the problem through use of the
server console.

------------------------------------------------------------------------
ANS1346E

The image snapshot operation failed. The SNAPSHOTCACHELocation does not
contain enough space for this snapshot image backup.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The SNAPSHOTCACHELocation points to a location which does not
contain the space necessary to manage the snapshot. This could be due to
an unexpected amount of disk activity which is generating more changes
than can be contained in the available space at this particular point in
time, or the SNAPSHOTCACHELocation needs to be changed because the
specified location is not large enough to handle the usual amount of
changes to the volume. Another reason for this failure can be that the
specified SNAPSHOTCACHESize is not set to a large enough value to handle
the usual amount of changes to the volume during snapshot image backup.

System action:

Processing stopped.

User response:

If the problem persists please increase the SNAPSHOTCACHESize and/or
change the value of the SNAPSHOTCACHELocation.

------------------------------------------------------------------------
ANS1347E

The image snapshot operation failed. The percent of space to use,
specified via the SNAPSHOTCACHESize, has been exceeded.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The percent of space allotted via the SNAPSHOTCACHESize option
was not enough to perform this snapshot image backup. This could be due
to an unexpected amount of disk activity which is generating more
changes than can be contained in the allotted space at this particular
point in time. Another reason for this failure can be that the specified
SNAPSHOTCACHESize is not set to a large enough value to handle the usual
amount of changes to the volume during snapshot image backup.

System action:

Processing stopped.

User response:

If the problem persists please increase the SNAPSHOTCACHESize or, for
Windows, change the value of the SNAPSHOTCACHELocation.

------------------------------------------------------------------------
ANS1348E

Unable to satisfy the SNAPSHOTFSIDLEWait and SNAPSHOTFSIDLERetries
options due to volume write activity.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The Logical Volume Snapshot Agent was not able to satisfy the
SNAPSHOTFSIDLEWait and SNAPSHOTFSIDLERetries options before starting the
snapshot of the specified volume.

System action:

Processing stopped.

User response:

If the problem persists please modify the SNAPSHOTFSIDLEWait and
SNAPSHOTFSIDLERetries options to better fit the normal disk write
activity of the volume being backed up.

------------------------------------------------------------------------
ANS1349E

An error occurred during Logical Volume Snapshot Agent snapshot
processing.



Explanation:

An unrecoverable error occurred during snapshot processing. This can be
caused by a variety of errors, so the error and system event logs should
be checked for additional messages.

System action:

Processing stopped.

User response:

Check the client error log and the system event log for any other
messages that might help identify the problem. Try the operation again.
If the problem persists, contact IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS1350E

The logical volume snapshot agent (LVSA) is currently busy performing a
snapshot on this same volume.



Explanation:

Another IBM Spectrum Protect process is already performing a snapshot of
this volume.

System action:

The operation is stopped.

User response:

Please wait until the other IBM Spectrum Protect process finishes with
the volume and then retry the operation.

------------------------------------------------------------------------
ANS1351E

Session rejected: All server sessions are currently in use



Explanation:

IBM Spectrum Protect has all available sessions in use and cannot accept
a new one at this time.

System action:

Current operation has been cancelled.

User response:

Retry the operation. If the problem continues, see your system
administrator to increase the number of concurrently active sessions to
the server.

------------------------------------------------------------------------
ANS1352E

The session is rejected. Your password has expired.



Explanation:

The password for IBM Spectrum Protect user ID has expired. It can be
either IBM Spectrum Protect node name password or administrative user ID
password or both.

System action:

Current operation has been cancelled. You are not allowed to connect to
the server until the password is updated.

User response:

Update your password. It may require updating the node name password or
the corespondent administrative ID password or both. You may use the SET
PASSWORD command, or have the IBM Spectrum Protect administrator update
your node or your administrative ID.

------------------------------------------------------------------------
ANS1353E

Session rejected: User ID is incorrect, does not have admin authority,
or is not known by the server



Explanation:

The user ID, which is either IBM Spectrum Protect node name or
administrative user ID, is not known by the server. Possible reasons for
this include:

   Your node name is not registered with the IBM Spectrum Protect server
   The node name is correct but does not have a corresponding
   administrative ID with the same name and client owner authority
   you are attempting to access a file that was migrated to a different
   node.

System action:

Current operation has been cancelled.

User response:

Do the following checks:

   Check that your IBM Spectrum Protect user ID is entered correctly.
   Check the administrative ID associated with your IBM Spectrum Protect
   node and verify that the IBM Spectrum Protect node name has a
   matching administrative ID with client owner authority for the node.
   If it does not, your IBM Spectrum Protect administrator needs to
   create it.
   Check that the server is using closed registration and that your node
   name is registered with the server.
   If attempting to access a migrated file, your node name must be the
   same node that migrated the file.

------------------------------------------------------------------------
ANS1354E

Session rejected: Duplicate ID entered



Explanation:

Another process using this node name is active with the server.

System action:

IBM Spectrum Protect cannot connect to the server. Current operation has
been cancelled.

User response:

If you are running a UNIX-based system, ensure that another process is
not active with IBM Spectrum Protect under the same name. Also, ensure
that your node name is unique to the server so that it cannot be used by
another person. See your system administrator to identify the owner of
that node name.

------------------------------------------------------------------------
ANS1355E

Session rejected: Server disabled.



Explanation:

The server is in a disabled state and cannot be accessed for normal
activity.

System action:

Current operation has been cancelled.

User response:

On the IBM Spectrum Protect server, run the ENABLE SESSIONS
administrative command. Try the operation again after the server returns
to an enabled state. If the problem continues, see your system
administrator.

------------------------------------------------------------------------
ANS1356E

The server is not configured to allow open registration



Explanation:

No authorization. Registration is required by your system administrator.
The server is not configured to allow open registration.

System action:

Session not started.

User response:

You must obtain a IBM Spectrum Protect node and password from your
system administrator.

------------------------------------------------------------------------
ANS1357S

Session rejected: Downlevel client code version



Explanation:

The server version and your client version do not match. The client code
is downlevel.

System action:

Current operation has been cancelled.

User response:

See your system administrator to see what version of IBM Spectrum
Protect to run for your location.

------------------------------------------------------------------------
ANS1358S

Session rejected: Downlevel server code version



Explanation:

The server version and your client version do not match. The server code
is downlevel.

System action:

Current operation has been cancelled.

User response:

See your system administrator to see what version of IBM Spectrum
Protect to run for your location.

------------------------------------------------------------------------
ANS1359E

Session Rejected: The specified node name is currently in use



Explanation:

The node name you specified is in use on the server.

System action:

Session was not started.

User response:

The server is probably performing a task that prevents your node from
establishing a session. Retry later or check with your system
administrator.

------------------------------------------------------------------------
ANS1360I

Compressed Data Grew



Explanation:

The size of the file after compression is greater than the size of the
file before compressed.

System action:

Even though the size of the file increased, the file is compressed.

User response:

None.

------------------------------------------------------------------------
ANS1361E

Session Rejected: The specified node name is currently locked.



Explanation:

The node name you specified is currently locked on the server.

System action:

Session was not started.

User response:

Check with your system administrator to find out why your node name is
locked.

------------------------------------------------------------------------
ANS1362S

SLM LICENSE EXCEEDED: The client licenses for IBM Spectrum Protect are
exceeded. See your system administrator.



Explanation:

Adding a new enrollment will exceed the product license count for IBM
Spectrum Protect.

System action:

Execution of the client enrollment or connection request ends.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1363E

Session Rejected: The server does not have enough memory to allow a
connection to be established.



Explanation:

The server does not have enough memory to allow your client to establish
a connection with the server.

System action:

Session was not started.

User response:

Retry later or see your system administrator.

------------------------------------------------------------------------
ANS1364E

Session Rejected: The server does not have enough recovery log space to
allow a connection to be established.



Explanation:

The server ran out of recovery log space.

System action:

Session was not started.

User response:

This error is a temporary problem. Retry later or see your system
administrator.

------------------------------------------------------------------------
ANS1365E

Session Rejected: The server does not have enough database space to
allow a connection to be established.



Explanation:

The server ran out of database space.

System action:

Session was not started.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1366E

The session is rejected. The IBM Spectrum Protect server has an internal
error.



Explanation:

The client cannot establish a connection to the IBM Spectrum Protect
server because of an internal server error.

System action:

The session was not started.

User response:

Notify your IBM Spectrum Protect administrator of this error.

------------------------------------------------------------------------
ANS1367E

The client is unable to sign on to the IBM Spectrum Protect server
because the server does not allow sign-on of Unicode clients.



Explanation:

The client is not allowed to connect to the IBM Spectrum Protect server.

System action:

The session does not start.

User response:

Contact your IBM Spectrum Protect administrator for assistance in
configuring a working IBM Spectrum Protect client for your environment.

------------------------------------------------------------------------
ANS1368S

Session Rejected: The server is not licensed for this platform type. See
your system administrator.



Explanation:

The server is not licensed for the requesting client type.

System action:

Execution of the client enrollment or connection request ends.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1369E

Session Rejected: The session was canceled by the server administrator.



Explanation:

The server administrator canceled the current client session.

System action:

Execution of the client connection request ends.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1370E

The user ID entered does not have the correct level of authority to
access the client machine.



Explanation:

The user ID entered cannot access this IBM Spectrum Protect client.

System action:

Operation ends.

User response:

Grant authority to this user ID on the IBM Spectrum Protect server so
that it can access this IBM Spectrum Protect client.

------------------------------------------------------------------------
ANS1371E

File '' cannot be reconstructed from subfile components.



Explanation:

An error occurred while reconstructing this file from its subfile
components.

System action:

The file indicated in the message is not restored. Restore for all other
files continues.

User response:

Try to restore the file again by selecting the file for restore from the
user interface. You can also check the client error log and the server
activity log for any messages related to the file indicated in the
message.

------------------------------------------------------------------------
ANS1372E

An inconsistency was detected between the client node and the node that
is registered to the IBM Spectrum Protect server.



Explanation:

The user has probably coded the node option incorrectly. For instance,
the node that is registered to the IBM Spectrum Protect server might be
a type of NAS, but the node is actually a non-NAS client.

System action:

Operation ends.

User response:

Ensure that the node name is correct in the client options file. Make
sure to use a node of type NAS only with the nasnodename option.

------------------------------------------------------------------------
ANS1373W

The PRESNAPSHOTCMD command for volume filespace completed with a
non-zero return code.



Explanation:

The command specified by the PRESNAPSHOTCMD option must complete
successfully in order to perform the snapshot backup/archive operation.
If the command completed with a return code of 0 (zero), it has
completed successfully. If the command completed with any other return
code, it has failed. If the command failed, then the backup is still
performed, but without the benefit of the snapshot technology.

System action:

The client executes the backup/archive operation, but without using a
snapshot.

User response:

Identify and fix the problem that caused the command to fail. If a
non-zero return code is normal for this command, then consider wrapping
the command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1374W

The POSTSNAPSHOTCMD command for volume filespace completed with a
non-zero return code.



Explanation:

The command specified by the POSTSNAPSHOTCMD option completed with a
non-zero return code. The snapshot-based backup operation yields a
return code of at least 8.

System action:

The snapshot-based backup operation continues.

User response:

Identify and resolve the problem that caused the post-snapshot command
to fail. If a non-zero return code is normal for this command, then
consider wrapping the post-snapshot command in a script that always
exits with a return code of zero.

------------------------------------------------------------------------
ANS1375W

File FilesystemPathFileName skipped by user



Explanation:

You requested that this file be skipped during the current operation.

System action:

The file is skipped during the current operation

User response:

None.

------------------------------------------------------------------------
ANS1376E

Error processing 'filespace name path-namefile-name'; end-to-end digest
validation failed.



Explanation:

Cryptographic digest of the restored or retrieved data did not match the
digest generated during the backup or archive operation. Possible causes
are a transmission error, data corruption, or a hash collision.

System action:

Processing stops

User response:

Try the restore operation again. If the problem persists, contact IBM
technical support for additional assistance.

------------------------------------------------------------------------
ANS1377W

The client was unable to obtain a snapshot of 'volname'. The operation
will continue without snapshot support.



Explanation:

IBM Spectrum Protect client was unable to create a snapshot of the
volume due to some reason. Instead of failing the operation, IBM
Spectrum Protect client will perform a non-snapshot based backup.

System action:

Snapshot processing stops.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1378E

The snapshot operation failed. The SNAPSHOTCACHELocation does not
contain enough space for this snapshot operation.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The SNAPSHOTCACHELocation points to a location which does not
contain the space necessary to manage the snapshot. Reasons for failure
include:

*  An unexpected amount of disk activity which is generating more
   changes than can be contained in the available space at this
   particular point in time.

*  The SNAPSHOTCACHELocation is not large enough to handle the usual
   amount of changes to the volume.

*  The specified SNAPSHOTCACHESize is not set to a large enough value to
   handle the usual amount of changes to the volume during snapshot
   backup or archive operation.

System action:

Processing stopped.

User response:

If the problem persists, increase the SNAPSHOTCACHESize or change the
value of the SNAPSHOTCACHELocation.

------------------------------------------------------------------------
ANS1379E

The snapshot operation failed. The percent of space to use for the
SNAPSHOTCACHELocation, specified via the SNAPSHOTCACHESize, has been
exceeded.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The percent of space allotted via the SNAPSHOTCACHESize option
was not enough to perform this snapshot backup/archive operation.
Reasons for failure include:

*  The SNAPSHOTCACHELocation is not large enough to handle the usual
   amount of changes to the volume.

*  The specified SNAPSHOTCACHESize is not set to a large enough value to
   handle the usual amount of changes to the volume during snapshot
   backup or archive operation.

System action:

Processing stopped.

User response:

If the problem persists, increase the SNAPSHOTCACHESize or change the
value of the SNAPSHOTCACHELocation.

------------------------------------------------------------------------
ANS1380W

The snapshot operation failed. The filesystem write activity prevented
the Logical Volume Snapshot Agent from satisfying the SNAPSHOTFSIDLEWait
and SNAPSHOTFSIDLERetries options.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The Logical Volume Snapshot Agent was not able to satisfy the
SNAPSHOTFSIDLEWait and SNAPSHOTFSIDLERetries options before starting the
snapshot of the specified volume.

System action:

Snapshot processing stops.

User response:

If the problem persists, modify the SNAPSHOTFSIDLEWait and
SNAPSHOTFSIDLERetries options to better fit the normal disk write
activity of the volume being backed up.

------------------------------------------------------------------------
ANS1381W

On volumes that are RAW or formatted FAT32 the snapshot cache location
cannot be located on the same volume that is being backed up.



Explanation:

When the snapshot cache location is located on the same volume that is
being backed up the volume must be formatted with NTFS. The default
cache location is on the same volume where the snapshot is being
performed. The operation will continue without snapshot support.

System action:

The client does not execute the snapshot operation.

User response:

Specify a different snapshot cache location, using the
SNAPSHOTCACHELOCATION option.

------------------------------------------------------------------------
ANS1382E

Server does not allow client-initiated connections for this node.



Explanation:

The node is not allowed to initiate connections due to the configuration
parameters for this node on the server. Server is able to initiate
connections to the client scheduler running in prompted mode.

System action:

The IBM Spectrum Protect operation ends.

User response:

Contact your systems administrator to enable client-initiated sessions
for your node or update the SESSIONINITIATION option and run the client
scheduler.

------------------------------------------------------------------------
ANS1383E

Wrong server port.



Explanation:

You were trying to open a backup/archive client session on the server
port set up for administrative sessions only.

System action:

The IBM Spectrum Protect operation ends.

User response:

Contact your systems administrator and/or use the correct values for TCP
port and TCP Admin Port.

------------------------------------------------------------------------
ANS1384E

An object in the transaction has been bound to an invalid management
class.



Explanation:

One of the objects in the transaction is bound to a management class
that is not part of this node's policy, or the management class type is
not supported for this client level.

System action:

The current operation ends.

User response:

Make sure all objects are bound to a valid management class, or upgrade
the client to the proper level.

------------------------------------------------------------------------
ANS1385E

This server does not support backup operations.



Explanation:

This server only supports archive operations, backup is not allowed.

System action:

The current operation ends.

User response:

Use only archive operations with this server.

------------------------------------------------------------------------
ANS1386E

Deleting this object: "fshlll" is not allowed.



Explanation:

The object is either under a hold and cannot be deleted, or it is on a
retention-protection enabled server and has not expired.

System action:

The object is skipped and processing continues.

User response:

Check the status of the object through a query to see if it is held, or
when it expires.

------------------------------------------------------------------------
ANS1387E

The number of objects in this transaction exceed TXNGROUPMAX values.



Explanation:

There are too many objects in this transaction.

System action:

The current operation ends.

User response:

Try the operation again with fewer objects in the transaction, or
increase the TXNGROUPMAX value on the server.

------------------------------------------------------------------------
ANS1388E

fshlll is already under hold.



Explanation:

The specified object is already under hold, and it cannot be placed
under a new hold.

System action:

This object is skipped and processing continues.

User response:

Issue a query to see the status of the objects, and try the operation
again, without the object that is already held.

------------------------------------------------------------------------
ANS1389W

Invalid option (option) for the scheduled function command



Explanation:

There are two possible reasons for this message:

*  The option option was specified for a scheduled command or subcommand
   (function) that cannot make use of that option.

*  The option appears on a scheduled command but is valid only on the
   client scheduler initial command line, not on commands in a schedule
   from the server.

System action:

The option is ignored.

User response:

See the Backup-Archive Client Installation and User's Guide for correct
use of the named option. The system administrator should remove the
invalid option from the schedule definition on the server.

------------------------------------------------------------------------
ANS1395E

The destination filespace or drive letter is unavailable. The following
object was not processed: Filespace:'filespace-name'



Explanation:

The system is trying to restore or retrieve to a destination that cannot
be reached. The specified filespace name or drive letter is not valid,
or does not exist, or you are specifying a local share name that cannot
be resolved.

System action:

Objects which are part of this filespace are not processed.

User response:

Try the command again, and specify a different destination for the
object that was not processed.

------------------------------------------------------------------------
ANS1396E

Access to the specified log or trace file (filename) is denied.



Explanation:

Access to the specified file is denied. You specified a log or trace
file name that cannot be written by the current user.

System action:

Processing stops.

User response:

Ensure that you specified the correct file or directory name, correct
the permissions, or specify a new location.

------------------------------------------------------------------------
ANS1397W

The snapshot cannot be taken because the SNAPSHOTCACHELocation does not
have enough space for this snapshot operation.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume. The SNAPSHOTCACHELocation points to a location which does not
contain the space necessary to create the snapshot; the disk is probably
full. The operation continues without snapshot support.

System action:

The client does not execute the snapshot operation.

User response:

Change the value of the SNAPSHOTCACHELocation, or clean the disk to
which the SNAPSHOTCACHELocation points.

------------------------------------------------------------------------
ANS1398E

Initialization functions cannot open one of the IBM Spectrum Protect
logs or a related file: log-name. errno = errno-value, reason



Explanation:

The file "log-name" could not be opened during initialization. The
system set the error code errno-value. If the reason given is "access
denied," the current user does not have permission to write to the log
in the directory specified. It is also possible that no space is
available at the given log location.

On Unix systems, the log must not be in the root directory. Attempts to
do so will result in an "access denied" error.

System action:

Processing terminates.

User response:

Set the DSM_LOG (or DSMI_LOG) environment variable to a directory into
which the current user can write. You may also use the ERRORLOGNAME
option to specify a file to which the current user has write permission.

------------------------------------------------------------------------
ANS1399W

The logical volume snapshot agent (LVSA) is currently busy performing a
snapshot on this same volume.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume because another process is already performing a snapshot of this
volume. The operation continues without snapshot support.

System action:

Snapshot processing stops.

User response:

Wait until the other IBM Spectrum Protect process finishes with the
volume and then try the operation again.

------------------------------------------------------------------------
ANS1400W

The snapshot cache location is not valid.



Explanation:

The snapshot cache location must point to a local volume that is
formatted with NTFS. The default cache location is on the same volume
where the snapshot is being performed. The operation will continue
without snapshot support.

System action:

Snapshot processing stops.

User response:

Specify a different snapshot cache location using the
SNAPSHOTCACHELOCATION option.

------------------------------------------------------------------------
ANS1401W

The snapshot virtual volume is not accessible.



Explanation:

The logical volume snapshot agent (LVSA) cannot access the virtual
volume during OFS-enabled backup/archive operation because IBM Spectrum
Protect was probably started via terminal services. The operation
continues without snapshot support.

System action:

Snapshot processing stops.

User response:

Do not use terminal services for the snapshot. Try the operation again
on the local machine.

------------------------------------------------------------------------
ANS1402W

The snapshot is not supported on a remote, removable, or SAN drive.



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume because open file support is only supported on local fixed
volumes, including volume mountpoints. The operation continues without
snapshot support.

System action:

The client does not execute the snapshot operation.

User response:

To take advantage of the open file support, you may try the operation
again on the local machine.

------------------------------------------------------------------------
ANS1403E

Error loading a required filename DLL



Explanation:

An error occurred while loading a dynamic link library. The DLL load
failed.

System action:

Processing stopped.

User response:

Verify that your system software is up to date and that all DLLs
required by the IBM Spectrum Protect client are present.

------------------------------------------------------------------------
ANS1404E

Error loading one or more functions from a required filename DLL



Explanation:

An error occurred while loading a function from a dynamic link library.
The DLL load failed.

System action:

Processing stopped.

User response:

Verify that your system software is up to date.

------------------------------------------------------------------------
ANS1405I

'service-name' service needs to be restarted.



Explanation:

The service must be restarted for the restored changes to take effect.

System action:

Changes are not effected.

User response:

Restart the service.

------------------------------------------------------------------------
ANS1407W

The value of option DiskBuffSize is ignored since Lan-Free is enabled.



Explanation:

Since Lan-Free is enabled the value of option DiskBuffSize will be reset
to the default value

System action:

Processing continues.

User response:

None

------------------------------------------------------------------------
ANS1408W

Previous changes have not been commited. The machine must be restarted
before the snapshot can be taken



Explanation:

IBM Spectrum Protect was not able to take a snapshot of the specified
volume because a previous operation required the machine to be restarted
for the changes to take effect, but the machine has not been restarted.
The operation will continue without snapshot support.

System action:

The client does not execute the snapshot operation.

User response:

Restart the machine and then try the operation again.

------------------------------------------------------------------------
ANS1409I

A full backup for the vm name virtual machine will be performed because
an include.resetcbt option was specified for the virtual machine.



Explanation:

The VM was specified in an include.resetcbt statement. A full backup and
a Changed Block Tracking (CBT) reset will be performed.

System action:

Changed Block Tracking (CBT) will be reset and the a full backup
operation will be performed for this virtual machine.

User response:

No action is required.

------------------------------------------------------------------------
ANS1410E

Unable to access the network path.



Explanation:

The network path cannot be accessed due to a possible network problem.

System action:

The client terminates.

User response:

Ensure that the network is up and the path can be accessed using a
system command, and retry the operation.

------------------------------------------------------------------------
ANS1411E

A communication session was dropped.



Explanation:

A communication session was dropped due to a possible network problem.

System action:

The client terminates.

User response:

Ensure that the network is up and retry the operation.

------------------------------------------------------------------------
ANS1412E

Directory or file has bad EA data or inconsistent data.



Explanation:

Directory or file has bad EA data or inconsistent data.

System action:

The client terminates.

User response:

Check failing directory or file for bad EA data. Copy the directory to a
new location and retry the operation.

------------------------------------------------------------------------
ANS1413W

File 'filespace namepath-namefile-name' is not recognized by the system
as a disk file and cannot be processed. The file is skipped.



Explanation:

The client is unable to process file types that are not 'disk', such as
'character' and 'pipe'. This message is typically, but not always,
issued for file names that are normally reserved for the operating
system. In the Windows environment, reserved names include AUX, CON,
NUL, PRN, COMx or LPTx, where 'x' is any digit from 1 to 9 (for example,
COM1, LPT3, etc.).

System action:

The file is skipped.

User response:

Either delete the file if you do not need it, or else use an EXCLUDE
statement in the client options to prevent the client from trying to
process the file. In the Windows environment, normal delete commands
will most likely not work. You will need to prefix the file name with
the characters '\\.\'. For example, "del c:\mydir\lpt4" will not work,
but "del \\.\c:\mydir\lpt4" will work.

------------------------------------------------------------------------
ANS1414W

Don't have sufficient authority to delete open group on server.



Explanation:

An open image group exists on the IBM Spectrum Protect server and cannot
be deleted due to missing backup delete rights for this node.

System action:

Processing continues.

User response:

Ask your IBM Spectrum Protect administrator to grant backup delete
rights for your node.

------------------------------------------------------------------------
ANS1417W

Protected system state file 'filename' is backed up to the drive file
space, not system state file space.



Explanation:

Files protected by Microsoft Windows File Protection (WFP) or Microsoft
Windows Resource Protection (WRP) are part of the Microsoft Volume
ShadowCopy Services (VSS) System Writer which is part of the system
state. These files are normally backed up as part of the system state,
not the file system on which the files reside. A problem in the
operating system environment prevented the protected file named in the
message text from being enumerated as a system state file and thus
backed up as part of the system state. The conditions that lead to this
message are not normal. In order to ensure that the file is protected,
it is backed up as part of the file system on which it resides.

System action:

The file is backed up as part of the file system on which it resides.

User response:

It is possible to restore the system using the file system and system
state backups. However the conditions that prevent the system state
files from being correctly enumerated should be addressed. On Microsoft
Windows 2008 and Microsoft Windows 2008 R2 you can use the DiskShadow
utility sub-command LIST WRITERS DETAILED to enumerate the system state
files. On other versions of Microsoft Windows you can use the vshadow
utility with the -wm2 option to enumerate the system state files. Verify
that the file indicated in this message is not listed. Note: vshadow is
a utility that you can obtain from Microsoft. After confirming that the
files are not enumerated, contact your operating system technical
support for help to diagnose and resolve the issue that prevents the
file from being correctly enumerated as part of the system state.

------------------------------------------------------------------------
ANS1418E

Authentication error. The Admin and/or Node password for nodename has
expired.



Explanation:

Session authentication failed with the server because either the admin
or node password for the node has expired.

System action:

Processing of the current operation is stopped.

User response:

Update your admin and/or node password for the node identified.

------------------------------------------------------------------------
ANS1420E

Volume map document (tsmvolmap.txt) not found.



Explanation:

An error occurred while performing VSS Automated System Recovery (ASR).
Check dsmerror.log for more information.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log.

------------------------------------------------------------------------
ANS1421E

The image object 'object-type' was not found on server.



Explanation:

The specified image object of type object-type could not be located on
the server. The operation cannot complete without this object.

System action:

The operation ends.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Take any corrective action suggested by the
messages, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1423W

'filesystem' is a virtual mount point. Migration is not supported on
virtual mount points.



Explanation:

IBM Spectrum Protect HSM does not support virtual mount points within
managed file systems. Files in the virtual mount point folder can not be
migrated.

System action:

IBM Spectrum Protect attempts to continue the current operation.

User response:

Do not use virtual mount points within file systems that are managed by
HSM. Use include/exclude rules instead.

------------------------------------------------------------------------
ANS1424W

Retrying failed image operation for volume filespace-name.



Explanation:

The transaction for image operation for volume filespace-name failed due
to reason described by earlier message(s).

System action:

The requested image operation will be retried again.

User response:

None.

------------------------------------------------------------------------
ANS1425E

The image operation for volume filespace-name cannot be retried because
of a severe error.



Explanation:

None.

System action:

The image operation fails for the indicated volume.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1426E

An error occurred creating the Registry backup directory structure



Explanation:

The IBM Spectrum Protect client uses an intermediate directory structure
on the client machine as part of the Windows Registry backup process.
The client was unable to create this intermediate directory structure,
so the Windows Registry could not be backed up. This problem can occur
if you do not have sufficient privileges to perform the backup
operations, if the client is unable to allocate more memory from the
system, or if a component within the directory structure already exists
as a file.

System action:

The Windows Registry is not backed up.

User response:

Check the client error log for any other messages that might have been
logged when this message was written, and take the corrective action (if
any) suggested by those messages. Make sure that account under which the
operation runs has sufficient privileges. Ensure that the system has
sufficient memory to run the process. Remove the ADSM.SYS directory from
the root of your system drive, then try the operation again. If the
problem persists, contact IBM support for further assistance.

------------------------------------------------------------------------
ANS1427I

Registry Backup function completed successfully.



Explanation:

Registry backup was successful.

System action:

None.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS1428E

Backup of the registry failed.



Explanation:

None.

System action:

The registry is not backed up.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1429I

Registry Restore function completed successfully.



Explanation:

Registry Restore was successful.

System action:

None.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS1430W

The machine must be rebooted for the changes to take effect.



Explanation:

The restore operation made changes that will not be in effect until the
machine is rebooted. It is important to note that until the reboot
occurs, the system or its applications might be unstable.

System action:

None

User response:

Reboot the machine as soon as possible after the restore operation ends.

------------------------------------------------------------------------
ANS1431E

Restore of the registry failed.



Explanation:

None.

System action:

The registry is not restored.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1432E

Keyword Expected after keyword 'keyword'.



Explanation:

A registry command was incorrectly entered.

System action:

Registry function is not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1433E

Extraneous argument 'input' after keyword 'keyword'



Explanation:

A registry command was incorrectly entered.

System action:

Registry function not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1434E

Invalid argument 'input' after keyword 'keyword'



Explanation:

A registry command was incorrectly entered.

System action:

Registry function not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1435E

An error occurred saving a registry key.



Explanation:

None.

System action:

The registry is not backed up.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1436E

An error occurred replacing a registry key.



Explanation:

None.

System action:

The registry key is restored from the server, but cannot be activated in
the registry. The current registry key remains active.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1437I

Event Log Backup function completed successfully.



Explanation:

Event Log backup was successful.

System action:

None.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS1438E

Backup of the event logs failed.



Explanation:

None.

System action:

The event logs are not backed up.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1439I

Event Log Restore function completed successfully.



Explanation:

Event Log Restore was successful.

System action:

None.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS1440E

Restore of the event logs failed.



Explanation:

None.

System action:

The event logs are not restored.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1441E

Keyword Expected after keyword 'keyword'.



Explanation:

A event log command was incorrectly entered.

System action:

Event Log function is not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1442E

Extraneous argument 'input' after keyword 'keyword'



Explanation:

A event log command was incorrectly entered.

System action:

Event Log function not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1443E

Invalid argument 'input' after keyword 'keyword'



Explanation:

A event log command was incorrectly entered.

System action:

Event Log function not invoked.

User response:

Refer to the command reference for this command.

------------------------------------------------------------------------
ANS1444E

An error occurred creating the Event Log backup directory structure



Explanation:

The IBM Spectrum Protect client uses an intermediate directory structure
on the client machine as part of the Windows Event Log backup process.
The client was unable to create this intermediate directory structure,
so the Windows Event Logs could not be backed up. This problem can occur
if you do not have sufficient privileges to perform the backup
operations, if the client is unable to allocate more memory from the
system, or if a component within the directory structure already exists
as a file.

System action:

The Windows Event Logs are not backed up.

User response:

Check the client error log for any other messages that might have been
logged when this message was written, and take the corrective action (if
any) suggested by those messages. Make sure that account under which the
operation runs has sufficient privileges. Ensure that the system has
sufficient memory to run IBM Spectrum Protect. Remove the ADSM.SYS
directory from the root of your system drive, then try the operation
again. If the problem persists, contact IBM support for further
assistance.

------------------------------------------------------------------------
ANS1445E

ERROR: could not create NAS image object.



Explanation:

Creation of the NAS image object failed for one of following reasons:

*  An unauthorized user invoked the NAS command

*  NAS operations are not supported on the current platform

*  Cannot find the NAS plugin library.

System action:

The requested NAS operation is not performed.

User response:

Retry the operation after correcting the cause for failure.

------------------------------------------------------------------------
ANS1446E

VSS ASR backup document (ASRBackupDoc.xml) not found.



Explanation:

An error occurred while performing VSS Automated System Recovery (ASR).
Check dsmerror.log for more information. Possible causes for the error
are the following:

*  You are trying to recover a machine running a legacy operating system
   such as windows XP or windows 2003. VSS ASR Restore is not supported
   for legacy operating systems.

*  You are trying to run ASR recovery from a backup created by a client
   earlier than version 6.2.2. Such backups do not have ASRBackupDoc.xml
   file.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log.

------------------------------------------------------------------------
ANS1447W

The file containing the stored password for the specified server-name
stanza cannot be opened due to an internal error.



Explanation:

An internal error occurred in the IBM Spectrum Protect for Space
Management client. The file storing the IBM Spectrum Protect credentials
cannot be opened.

System action:

Processing continues.

User response:

Retry the operation. If the problem continues, contact your system
administrator or service representative.

------------------------------------------------------------------------
ANS1448E

The command command is not supported by the current server.



Explanation:

The server to which the client is connected does not support the
command.

1. If the command is "set event," the server does not support
   event-based policy. This command requires that the server supports
   event-based policy. That support is available only at IBM Spectrum
   Protect Server levels 5.2.2 and above.

2. If the message displays any other command, the server is configured
   to support archive retention protection and cannot process operations
   that are not associated with that facility.

System action:

The command is skipped and other processing continues.

User response:

Log in to an appropriate server and run the command again.

------------------------------------------------------------------------
ANS1449W

A non-critical, unexpected error was encountered. Deletion of a
snapshot(Set/Volume) failed. Probable cause, snapshot does not exists
anymore. Continuing Process... IBM Spectrum Protect snapShot ID :
snapshot-id IBM Spectrum Protect function name : function-name IBM
Spectrum Protect function : function-desc IBM Spectrum Protect return
code : TSM-rc IBM Spectrum Protect file : file-name (line-number)



Explanation:

None.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS1450W

The -FILENAME option was specified without a file name. Output will be
written to filename.



Explanation:

The -FILENAME option was specified, but the file name was omitted.

System action:

The output is written to the default file.

User response:

Reissue the command and specify a valid file name, or use the
information that was written to the default file.

------------------------------------------------------------------------
ANS1453W

The IMAGEGAPSIZE option is not supported for non-NTFS file systems. The
entire volume will be backed up.



Explanation:

None.

System action:

The entire volume is backed up.

User response:

Refer to the client manual for additional information regarding the
IMAGEGAPSIZE option.

------------------------------------------------------------------------
ANS1454W

Used blocks information could not be obtained for name. The entire
volume will be backed up.



Explanation:

None.

System action:

The entire volume is backed up.

User response:

Check the client error log for any other messages that might help
identify the problem. Try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1455E

The value of the -vmname option 'vmname-option-value' would result in
the restoration of multiple virtual machines with the same name. Use the
keywords '*', <time>, or <timestamp> to differentiate the restored
virtual machine names.



Explanation:

The virtual machine restore command specified two or more virtual
machines. The value of the -vmname option would result in the restored
virtual machines having the same name.

System action:

The restore was stopped.

User response:

Use the keywords '*', '<time>', or '<timestamp>' in the -vmname option
so that each virtual machine is restored with a different name. If the
-vmname option is not specified, each virtual machine is restored with
the original name.

------------------------------------------------------------------------
ANS1458I

OBF file for volume name is too small for server-free data transfer.



Explanation:

The OBF file for volume is very small to initiate a server-free data
transfer. Hence this file will not be transferred via a server-free data
path.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1459E

VSS Automated System Recovery (ASR) failed.



Explanation:

An error occurred while performing VSS Automated System Recovery (ASR).
Check dsmerror.log for more information.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log.

------------------------------------------------------------------------
ANS1461E

Error processing 'filespace namepath-namefile-name': unsupported
encryption type.



Explanation:

The files you are trying to restore or retrieve have been backed up or
archived by a later version of the IBM Spectrum Protect client. The file
encryption method is not supported by the current client.

System action:

Object skipped.

User response:

Restore or retrieve the file with the most recent version of the IBM
Spectrum Protect client.

------------------------------------------------------------------------
ANS1463E

Unexpected error in cryptography library.



Explanation:

There was an unexpected error in the cryptography library. See the error
log for more information.

System action:

processing stops.

User response:

Check the error log for ANS1467E to determine the cause of failure.
Verify you IBM Spectrum Protect client is installed properly. If needed,
reinstall client and/or API. If the problem still exists, contact IBM
Spectrum Protect technical support.

------------------------------------------------------------------------
ANS1464S

Cannot load ICC encryption library.



Explanation:

The process is using a cryptography library which is installed
automatically with the client and is being loaded at runtime. The client
cannot proceed if the library is not loaded.

System action:

Client exits.

User response:

Check the error log for ANS1467E to determine the cause of failure.
Verify your IBM Spectrum Protect client is installed properly. If
needed, reinstall the client and/or API. If the problem still exists,
contact IBM Spectrum Protect technical support.

------------------------------------------------------------------------
ANS1465E

Conflicting options ERRORLOGMAX and ERRORLOGRETENTION were specified.



Explanation:

Values were specified for both the ERRORLOGMAX and the ERRORLOGRETENTION
options. These options are mutually exclusive.

System action:

Processing stops.

User response:

Specify a nonzero value for the ERRORLOGMAX option if you want the error
log to wrap when it reaches the specified maximum value. Use the
ERRORLOGRETENTION option if you want the error log limited in size on a
time-based schedule.

------------------------------------------------------------------------
ANS1466E

Conflicting options SCHEDLOGMAX and SCHEDLOGRETENTION were specified.



Explanation:

Values were specified for both the SCHEDLOGMAX and the SCHEDLOGRETENTION
options. These options are mutually exclusive.

System action:

Processing stops.

User response:

Specify a nonzero value for SCHEDLOGMAX if you wish to have the IBM
Spectrum Protect scheduler log wrap when it reaches the specified
maximum value. Use SCHEDLOGRETENTION if you wish you have the scheduler
log limited in size on a time-based schedule.

------------------------------------------------------------------------
ANS1467E

ICC routine icc-routine returned: majRC = majRC, minRC = minRC, desc =
'desc'.



Explanation:

There was an error within an ICC cryptography library. This message
reports return codes and problem description which can be used by IBM
Spectrum Protect technical support personnel to determine the cause of
the error.

System action:

Client exits.

User response:

Verify you IBM Spectrum Protect client is installed properly. If needed,
reinstall client and/or API. If the problem still exists, contact IBM
Spectrum Protect technical support.

------------------------------------------------------------------------
ANS1468E

Backing up Automated System Recovery (ASR) files failed. No files will
be backed up.



Explanation:

An error occurred while backing up the files needed for Automated System
Recovery (ASR). No files were backed up.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log. Verify that the
Windows account from which you are running this command has
administrator authority and try the command again.

------------------------------------------------------------------------
ANS1469E

Error processing 'filespace namepath-namefile-name'; invalid encryption
key.



Explanation:

The key you entered does not match the key that was used to encrypt the
file during backup. The file can not be restored unless the matching key
is entered.

System action:

processing stops.

User response:

Try the restore operation again and provide the correct key.

------------------------------------------------------------------------
ANS1470E

Unable to load GPFS functions needed for ACL and extended attributes
support: skip path_name



Explanation:

The GPFS functions that handle the GPFS ACL and extended attributes were
not loaded.

System action:

The object is skipped. Processing continues with the next object.

User response:

Ensure that the GPFS software is installed on the system and try the
operation again. On Linux, iensure that there has been an appropriate
symbolic link created in /usr/lib/ directory for the GPFS libgpfs.so
shared library.

------------------------------------------------------------------------
ANS1471E

ASR system information file creation failed. ASR backup is unsuccessful.



Explanation:

An error occurred while creating the system information file (asr.sif)
needed for Automated System Recovery (ASR). The ASR backup is
unsuccessful.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log. Verify that the
Windows account from which you are running this command has
administrator authority and that you have access to the system object
staging directory <system drive> :\adsm.sys. Try the command again.

------------------------------------------------------------------------
ANS1472E

Could not add entry to the ASR system information file. ASR backup is
unsuccessful.



Explanation:

An error occurred while adding an entry to the system information file
(asr.sif) needed for Automated System Recovery (ASR). The ASR backup is
unsuccessful.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log. Verify that the
Windows account from which you are running this command has
administrator authority and try the command again.

------------------------------------------------------------------------
ANS1473E

Session rejected: TCP/IP connection failure for Shared Memory



Explanation:

An attempt to connect to the local server using the Shared Memory
protocol has failed during initial TCP/IP communications. This error can
occur if the server is not listening on the correct port, or if the
server is down.

System action:

Session rejected. Processing stopped.

User response:

Retry the operation, or wait until the server comes back up and retry
the operation. If the problem continues, see your system administrator
for further help.

------------------------------------------------------------------------
ANS1474E

An error occurred using the Shared Memory protocol



Explanation:

An error has occurred while reading or writing data through the Shared
Memory communications protocol.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Check the trace log for additional information and retry the operation.
If the problem continues, see your system administrator for further
help.

------------------------------------------------------------------------
ANS1475E

Insufficient authority to connect to the shared memory region



Explanation:

The user issuing the command does not have authority to connect to the
shared memory segment. When the shared memory segment is created by the
server, it will be owned by the effective uid of the server process
(dsmserv). Only processes running under this uid or root will be allowed
to connect to the segment (and thus to the server).

System action:

The session is rejected and processing stops.

User response:

Run the command under the uid of the processing running dsmserv, if
possible. Otherwise contact your system administrator for further help.

------------------------------------------------------------------------
ANS1476E

CLUSTERNODE is set to YES but the Cluster Information Daemon is
notstarted.



Explanation:

The HACMP Cluster Information Daemon must be started in order to specify
the CLUSTERNODE option.

System action:

Processing ends.

User response:

Start the HACMP Cluster Information Dameon.

------------------------------------------------------------------------
ANS1477E

CLUSTERNODE is set to YES but the cluster load library is not valid.



Explanation:

The load library that the operating system provides to obtain the
cluster name is not valid. A possible cause is an out-of-date load
library which does not contain the proper routines this product expects.

System action:

Processing ends.

User response:

Ensure that the latest cluster software is installed on the system.

------------------------------------------------------------------------
ANS1478E

CLUSTERNODE is set to YES but the cluster software is not availableon
this system.



Explanation:

The load library that the operating systems provides to obtain the
cluster name is not available on this system.

System action:

Processing ends.

User response:

Ensure that the cluster software is installed on the system.

------------------------------------------------------------------------
ANS1479E

CLUSTERNODE is set to YES but this machine is not a member of acluster.



Explanation:

This machine is not a member of a cluster node. Possible causes are that
the cluster service has not been configured correctly, or that the
cluster is in the process of initialization.

System action:

Processing ends.

User response:

Ensure that the cluster software is configured properly. If the cluster
is in the process of initialization, retry the operation at a later
time.

------------------------------------------------------------------------
ANS1480E

CLUSTERNODE is set to YES but the cluster service is not enabledon this
system.



Explanation:

The cluster service has not been enabled on this system.

System action:

Processing ends.

User response:

Enable the cluster service on the system.

------------------------------------------------------------------------
ANS1481E

The CLUSTERNODE option is not supported on this system.



Explanation:

This option is not supported on this system.

System action:

Processing ends.

User response:

Disable the CLUSTERNODE option in the local options file.

------------------------------------------------------------------------
ANS1482E

An unexpected error (retcode) occurred while the program was trying to
obtain the cluster name from the system.



Explanation:

An unknown error occurred while the program was trying to obtain the
cluster name from the cluster service. The error code is the reason code
provided directly from the cluster service being used in this operating
system environment.

System action:

Processing ends.

User response:

Consult the documentation for your clustering software for an
explanation of the reason code. Insure that your clustering service is
operational, then try the IBM Spectrum Protect operation again.

------------------------------------------------------------------------
ANS1483I

Schedule log pruning started.



Explanation:

The schedule log pruning function has begun.

System action:

The schedule log is pruned.

User response:

None.

------------------------------------------------------------------------
ANS1484I

Schedule log pruning finished successfully.



Explanation:

The schedule log pruning function completed with no errors.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1487E

An error occurred while backing up the WMI repository. The database will
not be backed up.



Explanation:

The Windows event log and error log might contain additional information
related to this error.

System action:

processing stops.

User response:

Examine the Windows event log and error log for messages related to WMI.
Ensure that the Windows Management Instrumentation service is started.

------------------------------------------------------------------------
ANS1489E

The WMI service failed to stop. No files will be restored.



Explanation:

An error occurred while stopping the Windows Management Instrumentation
(WMI) service. The database will not be restored.

System action:

processing stops.

User response:

Examine the Windows event log and client error log for messages related
to Windows Management Instrumentation (WMI). You might need to quiesce
WMI activity or reboot the machine in order to free resources which are
preventing the WMI service from stopping.

------------------------------------------------------------------------
ANS1490W

File specification 'file-spec' ignored. A file list has already been
specified.



Explanation:

A non-option argument (file specification) was encountered after the
-FILELIST has been processed.

System action:

The argument is ignored.

User response:

You may have either a -FILELIST or explicit file specifications on this
command, but not both.

------------------------------------------------------------------------
ANS1492S

Invalid virtual mountpoint file_space_name: File not found.



Explanation:

The specified VIRTUALMOUNTPOINT option in the system options file is
invalid because it could not be found in the file system.

System action:

The process attempts to continue the current operation.

User response:

Check the virtual mountpoint in the system options file and make sure it
exists in the file system. Retry the operation.

------------------------------------------------------------------------
ANS1493S

Invalid virtual mountpoint file_space_name: Access denied.



Explanation:

The specified VIRTUALMOUNTPOINT option in the system options file is
invalid because access to it is denied.

System action:

The process attempts to continue the current operation.

User response:

Check the valule of the VIRTUALMOUNTPOINT option in the system options
file and make sure that the virtual mount point is accessible. Retry the
operation.

------------------------------------------------------------------------
ANS1494S

Invalid virtual mountpoint file_space_name: Symbolic link.



Explanation:

The specified VIRTUALMOUNTPOINT option in the system options file is
invalid because it is a symbolic link and the FOLLOWSYMBOLIC option is
not set.

System action:

The process attempts to continue the current operation.

User response:

Set the option FOLLOWSYMBOLIC to YES in the user options file. Retry the
operation.

------------------------------------------------------------------------
ANS1495S

Invalid virtual mountpoint file_space_name: Other error, rc =
return_code.



Explanation:

The specified VIRTUALMOUNTPOINT option in the system options file is
invalid.

System action:

The process attempts to continue the current operation.

User response:

Make sure the virtual mountpoint is a directory and accessible from the
shell, and retry the operation.

------------------------------------------------------------------------
ANS1496W

Duplicate include/exclude option 'option file-name' found while
processing the client options file. This might produce unexpected
results.



Explanation:

IBM Spectrum Protect found a duplicate statement while processing the
client options file, which might produce unexpected results.

System action:

Processing continues.

User response:

Verify if you obtained the desired results. If not, you need to correct
the client options file by removing the duplicate option statement.

------------------------------------------------------------------------
ANS1497W

Duplicate include/exclude option 'option file-name' found while
processing the client options passed by the server. This might produce
unexpected results.



Explanation:

IBM Spectrum Protect found a duplicate statement while processing the
client options by the server, which might produce unexpected results.

System action:

Processing continues.

User response:

Verify if you obtained the desired results. If not, you need to correct
either the client options file or the client options passed by the
server.

------------------------------------------------------------------------
ANS1498E

The IIS services failed to stop. No files will be restored.



Explanation:

An error occurred while stopping the Internet Information Services (IIS)
services. The metabase will not be restored.

System action:

processing stops.

User response:

Examine the Windows event log and client error log for messages related
to Internet Information Services (IIS). You might need to quiesce IIS
activity or reboot the machine in order to free resources which are
preventing the IIS service from stopping.

------------------------------------------------------------------------
ANS1499E

Creation of table of contents failed.



Explanation:

A failure occurred on the server during creation of the table of
contents.

System action:

The table of contents was not created.

User response:

This abort code indicates there was a problem creating a table of
contents on the server. The sysadmin will need to consult the activity
log on the server to determine the cause.

------------------------------------------------------------------------
ANS1500E

The dsmtca module is not found in the installation directory.



Explanation:

IBM Spectrum Protect cannot find the dsmtca module in the appropriate
directory.

System action:

Processing ends.

User response:

Reinstall the product.

------------------------------------------------------------------------
ANS1501E

The dsmtca execution/owner permissions are invalid



Explanation:

The dsmtca execution/owner permissions are invalid.

System action:

IBM Spectrum Protect ends.

User response:

Have your system administrator check the installation instructions for
the client to ensure that the dsmtca permissions are set correctly.

------------------------------------------------------------------------
ANS1502E

Access to run the the dsmtca or dsmenc module is denied.



Explanation:

The user of the backup-archive client does not have permission to run
the dsmtca or dsmenc module.

System action:

Processing ends.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1503E

Valid password not available for server 'server-name'. The administrator
for your system must run the backup-archive client and enter the
password to store it locally.



Explanation:

The file containing the stored password for the specified server
server-name is unavailable.

System action:

Processing ends.

User response:

The administrator for your system must set and store a new password.

------------------------------------------------------------------------
ANS1504E

Error starting the dsmtca or dsmenc process.



Explanation:

An error has occurred starting the dsmtca or dsmenc process;
specifically, the fork() function has failed.

System action:

Processing ends.

User response:

Probable system error. If the problem persists, restart the workstation.

------------------------------------------------------------------------
ANS1505W

Performing image backup of the entire volume for volume name. The
IMAGEGAPSIZE option value of image gap size is being ignored as this
level of the operating system does not support used block image backup.
Please upgrade to AIX 5.3 Maintenance Level 7 or later in order to
perform used block image backup.



Explanation:

AIX 5.3 Maintenance Level 7 or later has some necessary fixes that are
required to support used block image backup.

System action:

The entire volume is backed up.

User response:

Please upgrade to AIX 5.3 Maintenance Level 7 or later in order to
perform used block image backup.

------------------------------------------------------------------------
ANS1506E

The IBM Spectrum Protect dsmtca received an invalid request.



Explanation:

The dsmtca or dsmenc process was invoked by the backup-archive client
and received an unknown request argument in the call.

System action:

Processing ends.

User response:

It is possible that the dsmtca or dsmenc process was mistakenly invoked
by a process other than the backup-archive client. If that is not the
case, then this is an internal error. If the problem recurs, contact
your IBM service representative.

------------------------------------------------------------------------
ANS1507E

This action requires IBM Spectrum Protect administrative authority on
this system.



Explanation:

An activity has been attempted that must be performed by the IBM
Spectrum Protect administrator (for example, open registration, file
space delete or password update).

System action:

Processing ends.

User response:

If the activity is required, the administrator for this system must
perform it.

------------------------------------------------------------------------
ANS1508E

Error allocating semaphores.



Explanation:

An error has occurred because the semaphores you are attempting to
allocate have become insufficient.

System action:

Processing ends.

User response:

Ask your system administrator for assistance, and possibly increase the
number of semaphores in your system.

------------------------------------------------------------------------
ANS1509E

Error setting semaphore value or waiting on semaphore.



Explanation:

An error has occurred while attempting to set or wait on a semaphore.

System action:

Processing ends.

User response:

Probable system error. If the problem persists, restart the workstation.

------------------------------------------------------------------------
ANS1510W

The specified backupset either does not exist, or does not contain file
data.



Explanation:

The specified backupset either does not exist, or does not contain file
data for the node name specified. The restore backupset command is
limited to backupsets that contain file data. To restore an image backup
from a backupset, use the restore image command.

System action:

Processing stopped.

User response:

If an incorrect backupset name was specified, try the command again with
the correct backupset name. If you are trying to restore an image from a
backupset, refer to the restore image command for the correct syntax.

------------------------------------------------------------------------
ANS1511I

Invalid Restore session number entered. Try again.



Explanation:

You entered a number not shown in the list of restartable restores. The
number you entered is either less than one or greater than the highest
item number displayed.

System action:

Client prompts for a valid selection.

User response:

Enter a number from the list or 'Q' to quit.

------------------------------------------------------------------------
ANS1512E

Scheduled event 'event' failed. Return code = value.



Explanation:

One or more error conditions were encountered that prevented the
schedule from completing successfully. This message is preceded by other
messages that indicate the specific problems encountered during the
operation.

System action:

Scheduled event failed.

User response:

Check the schedule and error log files for the messages that specify
what problems were encountered during the operation. Correct the
conditions that caused those messages to be issued. The specific
corrective actions will depend on the specific errors encountered.

For more information about return codes, search for "client return
codes" in the product information
(www.ibm.com/support/knowledgecenter/SSGSG7/).

------------------------------------------------------------------------
ANS1513E

The object 'object_name' is skipped from rename. Error_condition.



Explanation:

IBM Spectrum Protect skips the specified object from renaming because
the object with the same long name but with different attributes exists
on the server.

System action:

The backup operation continues. The specified object will expire during
the next incremental backup.

User response:

The object is skipped if one of the following condition occurs:

   The long name object(LN) has a more recent insert date than the short
   name object(SN).
   The management classes for LN and SN do not match.
   The copy groups for LN and SN do not match.
   LN and SN have different owners.
   The creation date for LN and SN do not match.
   The short name attribute for LN does not match SN.

If you are unable to determine what is wrong, report the problem to your
service representative.

------------------------------------------------------------------------
ANS1514W

Encryption key passwords are not the same.



Explanation:

The key passwords are different.

System action:

The process allows you to try again.

User response:

Enter the correct password.

------------------------------------------------------------------------
ANS1515E

Loading a table of contents failed.



Explanation:

A failure occurred on the server during loading of the table of
contents.

System action:

The table of contents was not loaded.

User response:

This abort code indicates there was a problem loading a table of
contents on the server. The sysadmin will need to consult the activity
log on the server to determine the cause.

------------------------------------------------------------------------
ANS1519E

Your node does not have permission to delete backup files



Explanation:

The server does not allow your node to delete backup files.

System action:

The process did not delete the backup files.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS1520E

Failure writing to the IBM Spectrum Protect error log: errno =
errno-value,



Explanation:

A failure was encountered when writing to the dsmerror log or dsierror
log. The system set the error code errno-value. It is possible that no
space is available at the given log location.

System action:

Processing terminates.

User response:

Set the DSM_LOG (or DSMI_LOG) environment variable to a directory with
adequate space to write the log data.

------------------------------------------------------------------------
ANS1521E

Failure writing to a IBM Spectrum Protect log or log-related file:
file-name, errno = errno-value, reason



Explanation:

A failure was encountered when writing to one of the log files or a
related file named file-name. The system set the error code errno-value.
reason is the system explanation of that error code. Among other things,
it is possible that no space is available at the given log location.

System action:

Processing terminates.

User response:

Set the DSM_LOG (or DSMI_LOG) environment variable to a directory with
adequate space to write the log data.

------------------------------------------------------------------------
ANS1522W

The type of filespace file system is too old and only restore can be
performed



Explanation:

The file system is old only restore is supported by backup-archive
client

System action:

Only restore can be performed for this file system.

User response:

This file system is not supported anymore by Apple, so only restore
operation can be performed for this file system.

------------------------------------------------------------------------
ANS1523E

An error occurred while connecting to TSA/SMDR service.



Explanation:

An error was encountered during a call to the TSA/SMDR service. This
message usually follows previous messages that contain more specific
information about the problem.

System action:

Processing stopped.

User response:

Refer to previous messages in dsmerror.log for further information. If
those messages are not helpful in identifying the cause of the problem,
see your system administrator for further assistance.

------------------------------------------------------------------------
ANS1528I

The process is converting the log-file from continuous (pruning) mode to
wrapping mode. This process may take several minutes.



Explanation:

The log-file was previously in continuous mode where the only size
control was through the use of the ERRORLOGRETENTION or
SCHEDLOGRETENTION option. This is the first occasion where the
ERRORLOGMAX or SCHEDLOGMAX option is specified for this log, so its
format must be changed and old data saved.

System action:

Transition processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1529I

The process is converting the log-file from wrapping mode to continuous
(pruning) mode. This process may take several minutes.



Explanation:

The log-file was previously in wrapping mode where the size control was
through the use of the ERRORLOGMAX or SCHEDLOGMAX option. This is the
first occasion where the ERRORLOGMAX or SCHEDLOGMAX option is not
specified for this log, so its format must be changed and old data
saved.

System action:

Transition processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1530I

count log records processed.



Explanation:

This is just a progress report to let you know the process is still
ongoing.

System action:

Transition processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1532E

Proxy Rejected: Proxy authority has not been granted to this node.



Explanation:

The node has not been granted proxy authority to access the node named
by the ASNODENAME option. The IBM Spectrum Protect administrator must
first grant proxy authority.

System action:

The IBM Spectrum Protect operation ends.

User response:

The IBM Spectrum Protect server administrator must grant proxy authority
for this node. See the administrator command "Grant Proxynode".

------------------------------------------------------------------------
ANS1533E

Proxy Rejected: The node name you specified in the ASNODENAME option is
locked.



Explanation:

The IBM Spectrum Protect administrator has locked the node you specified
as the ASNODENAME option.

System action:

The IBM Spectrum Protect operation ends.

User response:

The IBM Spectrum Protect server administrator must unlock the node
before you can access it. Try the operation later, or check with your
IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS1534E

Proxy Rejected: The IBM Spectrum Protect server has run out of memory.



Explanation:

There is not enough memory available to allow this operation to
continue.

System action:

Current operation has been cancelled.

User response:

Try the operation again. If the problem continues, see your system
administrator to increase the amount of memory of the server.

------------------------------------------------------------------------
ANS1535E

Proxy Rejected: The ASNODENAME and NODENAME options have the same value.



Explanation:

The ASNODENAME and NODENAME options cannot have the same value.

System action:

The current operation is cancelled.

User response:

Use the ASNODENAME option only to access another node. It is not
necessary to set the ASNODENAME option to access your own node. Remove
the ASNODENAME option from your option file unless you are actually
trying to access a node that you have been granted authority to access
with the administrative command "Grant Proxynode".

------------------------------------------------------------------------
ANS1536E

Proxy Rejected: The server has an internal error.



Explanation:

The client cannot proxy to the node named by the ASNODENAME option
because of an internal server error.

System action:

Current operation has been cancelled.

User response:

See your system administrator immediately.

------------------------------------------------------------------------
ANS1537E

The ASNODENAME option is not valid with the FROMNODE option.



Explanation:

None.

System action:

Processing stops.

User response:

Remove the ASNODENAME option from the options file or do not use the
FROMNODE option.

------------------------------------------------------------------------
ANS1538E

The operation that is being attempted cannot be invoked using the
ASNODENAME option.



Explanation:

None.

System action:

Processing stops.

User response:

Remove the ASNODENAME option and retry the operation.

------------------------------------------------------------------------
ANS1539E

The ASNODENAME option cannot be used with the CLUSTERNODE option.



Explanation:

None.

System action:

Processing stops.

User response:

Remove the ASNODENAME option and retry the operation.

------------------------------------------------------------------------
ANS1540E

The option 'option-name' requires a tag enabled data mover.



Explanation:

The client option 'VMTAGDATAMOVER' must be set to YES so that IBM
categories and tags can be applied to virtual machines. The active data
mover is not a tag enabled data mover.

System action:

The data mover operation stops.

User response:

Enable tag support on this data mover by setting the 'VMTAGDATAMOVER'
option to 'YES' then retry the operation.

------------------------------------------------------------------------
ANS1541E

The operation requires a tag enabled data mover.



Explanation:

The client option 'VMTAGDATAMOVER' must be set to YES so that IBM
categories and tags can be applied to virtual machines. The active data
mover is not a tag enabled data mover.

System action:

The data mover operation stops.

User response:

Enable tag support on this data mover by setting the 'VMTAGDATAMOVER'
option to 'YES' then retry the operation.

------------------------------------------------------------------------
ANS1544E

An error in WAS processing has occurred.



Explanation:

None.

System action:

None

User response:

Run the following command to see the nodes that can be backed up: dsmc
query was -wastype=local Make sure the results are correct for your
environment, then try the operation again. If the problem persists,
contact IBM Spectrum Protect technical support for further assistance.

------------------------------------------------------------------------
ANS1545W

IT22692: logical file sizes don't match: (migrated) migrated_file_size
!= (local) local_file_size for (file_path)



Explanation:

The dsmreconcile command is run in APAR IT22692 issue detection mode
('testflag HSM_IT22692_DETECTION' specified in the dsm.opt). In this
mode, this warning message is reported for each file that was
potentially affected by APAR IT22692 issue.

System action:

The reconciliation processing proceeds with next object.

User response:

Wait till the reconciliation processing completes, then run the
following corrective actions for each file identified by this warning: -
if there is backup copy, restore the backup copy overwriting the
affected file: root> dsmc restore /affected_file -repl=yes - if there is
no backup copy, unlink the affected file(s) and restore appropriate
stub(s) using the dsmmigundelete command: root> rm /affected_file1
/affected_file2 /affected_file_n root> dsmmigundelete /HSM_fs - to make
sure the rest of the premigrated files won't eventually contain file
data corrupted by IT22692, re-stub all existing premigrated files: root>
dsmmigrate -stubpremigrated -R /HSM_fs

------------------------------------------------------------------------
ANS1546W

IBM Spectrum Protect failed to lock the WebSphere configuration
repository.



Explanation:

None.

System action:

The lock of the WebSphere configuration repository fails.

User response:

Ensure that the WebSphere server is running. If the server is already
running, ensure that the repository is unlocked. Ensure that you are
backing up the correct node. To see a list of available nodes that can
be backed up, enter: 'dsmc q was -wastype=local'.

------------------------------------------------------------------------
ANS1547W

IBM Spectrum Protect failed to unlock the WebSphere Configuration
Repository.



Explanation:

None.

System action:

The unlock of the WebSphere Configuration Repository fails.

User response:

Make sure that the WebSphere server is running. If the repository is
locked, then unlock it and try the operation again. Ensure that the
correct node is being backed up. To see a list of available nodes that
can be backed up, run: 'dsmc q was -wastype=local'.

------------------------------------------------------------------------
ANS1548E

A supported version of WebSphere is not installed on this machine.



Explanation:

A supported version of WebSphere is not installed on this machine. The
only version of WebSphere that is supported is 5.0.x.

System action:

None

User response:

Install WebSphere 5.0 on the machine.

------------------------------------------------------------------------
ANS1549E

No application server instances were found. Unable to perform backup.



Explanation:

The application server is not installed on this machine.

System action:

Backup is not performed.

User response:

Install the application server.

------------------------------------------------------------------------
ANS1550E

No network deployment manager instances were found to back up.



Explanation:

Deployment manager is not installed on this machine.

System action:

Back up is not performed.

User response:

Install the network deployment manager.

------------------------------------------------------------------------
ANS1551E

The maximum number of search responses was exceeded.



Explanation:

The local file system search results exceeded the maximum allowed.

System action:

Processing stops.

User response:

Refine the search criteria to return fewer results or increase the
configured maximum.

------------------------------------------------------------------------
ANS1552E

The local file system search timed out.



Explanation:

The local file system search did not complete in the allotted amount of
time.

System action:

Processing stops.

User response:

Refine the search criteria or increase the configured timeout.

------------------------------------------------------------------------
ANS1553W

The user name and password that have been provided to Data Protection
for WebSphere are invalid.



Explanation:

None.

System action:

Data Protection for WebSphere cannot run.

User response:

Run the dsmc set WASPassword command to set the WebSphere security user
name and password.

------------------------------------------------------------------------
ANS1556E

Setting the WAS user and password failed.



Explanation:

Password validation for the WAS user and password failed.

System action:

WAS password validation fails.

User response:

Rerun the set WASPassword command with the correct values for user and
password.

------------------------------------------------------------------------
ANS1557W

The WAS Server was not running, and the password file was saved without
validation.



Explanation:

If the WAS server is down, then it is not possible to connect to the
server and validate the user-entered password. The password has still
been saved, but no validation has been performed.

System action:

The set WAS password command did not validate the password. The password
has still been saved, but no validation has been performed. The password
may be incorrect.

User response:

There are two options:

*  Try a backup. If the backup performs a failover, and there is a
   incorrect password message in the error log, then the password that
   was entered is incorrect.

*  Start the WAS server and rerun the set password command. Since the
   server is now up, validation will be performed as normal and the user
   notified if a good/bad password was entered.

------------------------------------------------------------------------
ANS1560W

The WebSphere server is not running.



Explanation:

The WebSphere server is not running. The WAS server is running for
backup operations.

System action:

The WebSphere server is not running.

User response:

Start the WAS server and run the backup again.

------------------------------------------------------------------------
ANS1562E

WAS Restore failed during EAR Expansion.



Explanation:

EAR Expansion is performed for a WebSphere Application server after the
files have been restored.

System action:

WAS restore fails.

User response:

Run the restore again.

------------------------------------------------------------------------
ANS1565E

No WebSphere EARExpander was found. Copy the EARExpander tool from the
base WebSphere bin directory to the instance bin directory, then run the
restore operation again.



Explanation:

The EAR files are expanded for an instance of an Application server and
the EARExpander tool does not exist in the instance bin directory.

System action:

No WebSphere EARExpander found.

User response:

Copy the WAS EARExpander tool from the base install's bin directory to
the bin directory of the instance. Then run the WAS restore operation
again, after the EARExpander tool has been copied.

------------------------------------------------------------------------
ANS1566E

The version of WebSphere on the machine does not match the version of
WebSphere that was backed up. These versions must match for a WAS
restore operation.



Explanation:

The version of WebSphere on the machine does not match the version of
WebSphere that was backed up. These versions must match for a WAS
restore operation.

System action:

The WAS restore operation fails.

User response:

Install the correct version of WebSphere on the machine before
performing the restore operation.

------------------------------------------------------------------------
ANS1568E

The client acceptor attempted to register it's tcpport and tcpip address
without using the TCPCADADDRESS option.



Explanation:

The client acceptor sent the port and address information to the server,
however, there was a problem registering the information with the
server. The problem occurred because no default value for the tcpip
address was provided. The server was unable to determine a default value
for the tcpip address because the communication method was not tcpip.

System action:

The server cannot register the information for the client acceptor.
client acceptor processing will continue, but some functions of the
client acceptor may not be working properly.

User response:

Use TCPCADADDRESS in the client option file to indicate the proper
TCP/IP address for this client acceptor.

------------------------------------------------------------------------
ANS1569E

The client acceptor attempted to register it's tcpport and tcpip address
but the TCP/IP address resolved to the loopback address and was rejected
by the server.



Explanation:

The client acceptor sent the port and address information to the server,
however, there was a problem registering the information with the
server. The problem occurred because the server detected that the
address provided resolved to the loopback address.

System action:

The server did not register the information for the client acceptor.
client acceptor processing will continue, but some functions of the
client acceptor may not be working properly.

User response:

Use TCPCADADDRESS in the client option file to indicate the proper
TCP/IP address for this client acceptor. Loopback address is not valid.

------------------------------------------------------------------------
ANS1570E

Registering this instance of the client acceptor with the server failed.
The client acceptor process continues.



Explanation:

The client acceptor failed to register address information to the server
due to an error.The message immediately preceding this message should
indicate the problem more precisely.

System action:

The server did not register the information for the client acceptor.
client acceptor processing continues, but some functions of the client
acceptor might not work properly.

User response:

Review the messages immediately preceding this message to help determine
what error occurred.

------------------------------------------------------------------------
ANS1571E

The time-option option cannot be used without specifying the date-option
option



Explanation:

If the to/from/pit time options is specified then the corresponding
to/from/pit date MUST also be specified.

System action:

Processing stopped.

User response:

Either remove the to/from/pit time option or add the corresponding
to/from/pit date option.

------------------------------------------------------------------------
ANS1572E

An unexpected error was received from the server query, RC=re tcode.



Explanation:

An unexpected error was received by the client. This could be caused by
network problems or a programming error.

System action:

Current operation has been cancelled.

User response:

Verify that your communication path is functioning properly and try the
operation again. If the problem persists, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS1573E

FROMDATE and TODATE cannot be used with PITDATE.



Explanation:

The PITDATE option specifies different and conflicting date selection
criteria from the FROMDATE and TODATE options. Therefore these options
cannot be combined.

System action:

The restore operation is not performed.

User response:

Determine whether you require the functionality of PITDATE or FROMDATE
and TODATE, then try the operation again. If you want to restore files
as of a certain date and time, use PITDATE and PITTIME. If you want to
restore files from a given range of dates, use FROMDATE, TODATE,
FROMTIME, and TOTIME. Refer to the IBM Spectrum Protect client manual
for your operating system for additional information about these
options.

------------------------------------------------------------------------
ANS1574E

Journal Query Failed.



Explanation:

The journal daemon was unable to process the requested journal query.

System action:

Journal backup processing is interrupted.

User response:

Retry the backup, check the journal daemon errorlog for the cause of the
failure. Backup of other file systems in the domain will continue.

------------------------------------------------------------------------
ANS1575E

Journal Daemon Communications Error.



Explanation:

An error occurred communicating with the journal daemon.

System action:

Journal backup processing is interrupted.

User response:

Retry the backup, check the journal daemon and client errorlogs for the
cause of the failure.

------------------------------------------------------------------------
ANS1577I

The Windows console event handler received a 'event' console event.



Explanation:

A console event was received by one of the IBM Spectrum Protect
processes or programs. The following events can be received:

*  Ctrl-C - This indicates either the user entered the ctrl-c sequence
   or that one of the Windows services was stopped.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1578E

The specified path 'path' is not valid for backup or archive.



Explanation:

The specified path is a special file system or part of a special file
system. Special file systems contain dynamic information generated by
the operating system and should not be backed up or archived. Refer to
the IBM Spectrum Protect client manual for a complete list of special
file systems for your operating system.

System action:

Processing continues if there are other file systems to back up.

User response:

Do not specify special file systems for backup or archive.

------------------------------------------------------------------------
ANS1579E

GSKit function func-name failed with error-code: session



Explanation:

A GSKit function has failed with the specified error code.

System action:

Processing stopped

User response:

Make sure you have configured the key database for SSL communication as
described in the documentation. Possible issues could be failure in TLS
handshake due to client and server not agreeing on a protocol. If the
problem persists, contact IBM Spectrum Protect customer support.

------------------------------------------------------------------------
ANS1580W

An Include.Fs statement with performance algorithm set already exists
for the drive specified. Do you want to replace the statement?



Explanation:

The user tried to create a duplicate Include.Fs entry on a drive that
already has a performance algorithm associated with it. This is
applicable to the Preference Editor on the MFC GUI

System action:

The user can replace the statement with the new one or they can cancel
out of this operation

User response:

The user is prompted to replace the statement with the new one or they
can say No to cancel out of this operation.

------------------------------------------------------------------------
ANS1581W

'object-name' was restored as 'temp-name'. A reboot is required to
complete the restore.



Explanation:

This is a system file restored and could not be immediately replaced.
The file will be replaced during the next reboot of the operating
system. It is important to note that until the reboot occurs, the
changes will not be in effect.

System action:

The client restored the file with a temporary name, and instructed the
operating system to replace the original file with the restored file
during the next boot of the operating system.

User response:

Reboot the machine as soon as possible after the restore operation ends.

------------------------------------------------------------------------
ANS1582E

The web client is no longer supported when connecting to IBM Spectrum
Protect V7.1.8 or V8.1.2 and later servers.



Explanation:

The web client functionality is no longer supported and is unavailable
for connecting to IBM Spectrum Protect V7.1.8 or V8.1.2 and later
servers.

System action:

Processing stopped

User response:

Use one of the other supported client interfaces to perform your IBM
Spectrum Protect operations. Refer to IBM Spectrum Protect documentation
for information on the supported client interfaces.

------------------------------------------------------------------------
ANS1583E

The Hardware Utility plug-in module was not found or could not be
loaded.



Explanation:

Processing stops.

System action:

None.

User response:

Run the "dsmc show plugins" command at the command-line client prompt to
see the available plug-ins on the system and verify the path which is
being used to load the plug-ins. If the plug-in path is available and
the Hardware Utility plug-in, libPiHDW.a, is present, ensure that the
LIBPATH variable is set to the Hardware product's library path. For
example, LIBPTH=/usr/opt/db2_08_01/lib.

------------------------------------------------------------------------
ANS1584E

Error loading system library 'libdevmapper.so' required for image
operations for LVM2 volumes.



Explanation:

The system library libdevmapper.so required for LVM2 image operations
could not be loaded. This error can occur when the library does not
exist on the system, or the library is an earlier level than is
required. This error also occurs when the library can not be opened by
the IBM Spectrum Protect clienti process.

System action:

The image operations for LVM2 volumes are not available.

User response:

Check the installed packages and the library versions on the system. If
correct versions are installed, check for access related issues. If the
system does not have these libraries installed, contact your Linux OS
distributer. Also, refer to Technote 1452629:
https://www.ibm.com/support/docview.wss?uid=swg21452629

------------------------------------------------------------------------
ANS1587W

Unable to read extended attributes for object object-full-name due to
errno: errno-value, reason: errno-explanation



Explanation:

The extended attributes of the object could not be read. The system set
the error code errno-value and the reason errno-explanation. If the
reason errno-explanation is either "access denied" or "permission
denied", the current user does not have permission to read the extended
attributes of the object.

System action:

The object is skipped. Processing continues with the next object.

User response:

The error is expected if the operation tries to read extended attributes
of an object that you do not own or do not have access to. If the reason
indicates an input/output error, perform the file system consistency
check procedure and try the operation again. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1588W

I/O error reading file attribute: attr-name for: file-name. errno =
errno-value,



Explanation:

The attribute attr-name of the file file-name could not be retrieved.
The system set the error code errno-value. If the reason given is
"access denied," the current user does not have permission to read the
file attributes.

System action:

Processing continues without backing up the specified file attribute.

User response:

Correct the condition causing the physical error.

------------------------------------------------------------------------
ANS1589W

Unable to write extended attributes for object-full-name due to errno:
errno-value, reason: errno-explanation



Explanation:

The extended attributes of the object could not be written. The system
set the error code errno-value and the reason errno-explanation. If the
reason is either "access denied" or "permission denied", the current
user does not have permission to write the extended attributes of the
object.

System action:

Processing continues without restoring the extended attributes.

User response:

The error is expected if the operation tries to write extended
attributes to an object that you do not own or do not have access to. If
the reason indicates an input/output error, perform the file system
consistency check procedure and retry the operation. If the problem
persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1590W

I/O error writing file attribute: attr-name for: file-name. errno =
errno-value,



Explanation:

The attribute attr-name of the file file-name could not be set. The
system set the error code errno-value. If the reason given is "access
denied," the current user does not have permission to set the file
attributes.

System action:

Processing continues without restoring the specified file attribute.

User response:

Correct the condition causing the physical error.

------------------------------------------------------------------------
ANS1592E

Failed to initialize SSL protocol.



Explanation:

The process was unable to initialize the SSL protocol. This could be
because the node is in a strict 'sessionsecurity' state and the client
certificate key database could not be found.

System action:

Processing stopped

User response:

Check for GSKit related messages in the error log. Make sure you have
configured the key database for SSL communication as described in the
documentation. You must manually import the client certificate by using
the dsmcert utility. If the problem persists, contact IBM Spectrum
Protect customer support.

------------------------------------------------------------------------
ANS1593E

Cannot open the key database.



Explanation:

The process was unable to open the keyfile that is expected to contain
the server certificate for SSL communications.

System action:

Processing stopped

User response:

Make sure you have configured the key database for SSL communication as
described in the documentation. If the problem persists, contact IBM
Spectrum Protect customer support.

------------------------------------------------------------------------
ANS1594E

The key database password is incorrect or unavailable.



Explanation:

The client was unable to open the certificate key database using the
stored password, or the stored password could not be read.

System action:

Processing stops.

User response:

Make sure that you configure the key database for SSL communication as
described in the Client Installation and User's Guide. Also make sure
that the stash file, dsmcert.sth, is readable by the current user.

------------------------------------------------------------------------
ANS1595E

Bad server certificate.



Explanation:

The process was unable to open SSL connection to server because of a bad
certificate. This error usually occurs when the server certificate
cannot be verified by the client.

System action:

Processing stopped

User response:

Make sure you have configured the key database for SSL communication as
described in the documentation. Make sure to import the correct
certificate from the IBM Spectrum Protect server you are trying to
connect to.

------------------------------------------------------------------------
ANS1596E

SSL protocol is not supported.



Explanation:

SSL protocol is not supported on this platform.

System action:

Processing stopped

User response:

Refer to IBM Spectrum Protect documentation for the list of supported
platforms.

------------------------------------------------------------------------
ANS1597E

The -pick and -deltype=all options are not valid together.



Explanation:

-deltype=all is used to delete an entire directory tree. You cannot use
-pick to select individual objects from the tree. -pick is valid only
with -deltype=active or -deltype=inactive.

System action:

Processing stopped.

User response:

Try the operation again with a valid combination of options. If you want
to delete an entire tree, use -deltype=all, but do not use -pick. If you
want to select which backup versions to delete, specify -deltype=active
or -deltype=inactive, and use the -pick option. Also use -subdir=yes if
you want the file selection to include files in subdirectories of the
file specification. See the client manual or command line help for
additional information.

------------------------------------------------------------------------
ANS1598E

-deltype=all is not valid for this file specification.



Explanation:

-deltype=all is used to delete an entire directory tree. You must
specify a fully wildcard directory when using -deltype=all.

System action:

Processing stopped.

User response:

Try the operation again with a valid combination of options. If you want
to delete all backup versions of an entire directory tree, use
-deltype=all and a fully wildcarded file specification. If you want to
delete backup versions of partially qualified file names, use
-deltype=inactive or -deltype=active. Also use -subdir=yes if you want
to delete backup versions in subdirectories of the file specification.
See the client manual or command line help for additional information.

------------------------------------------------------------------------
ANS1599E

Cannot load SSL runtime library.



Explanation:

IBM Spectrum Protect failed to dynamically load SSL runtime library
necessary for SSL protocol

System action:

Processing stopped

User response:

Make sure IBM Spectrum Protect client is properly installed. Try to
reinstall the client software. If the problem persists, contact IBM
Spectrum Protect customer support.

------------------------------------------------------------------------
ANS1600E

Unable to load the Data Protection for Lotus Domino library.



Explanation:

The Datt Protection for Lotus Domino library could not be loaded.

System action:

Processing ends.

User response:

Ensure that Domino plugin is properly configured and check the error log
on the client machine for more information.

------------------------------------------------------------------------
ANS1601E

The Domino plugin operation failed because of an internal error.



Explanation:

A Domino plugin internal error has occurred.

System action:

Processing ends.

User response:

Check the error log on the client machine for more information.

------------------------------------------------------------------------
ANS1602E

The Domino plugin operation failed because the preferences file was not
found.



Explanation:

The Data Protection for Lotus Domino preference file could not be found.

System action:

Processing ends.

User response:

The Data Protection for Lotus for Domino configuration file (default
name domdsm.cfg) could not be found. Check the error log on the client
machine for more information.

------------------------------------------------------------------------
ANS1603E

The Domino plugin operation failed because of an internal TCP/IP error.



Explanation:

A TCP/IP error has occurred.

System action:

Processing ends.

User response:

Check the error log on the client machine for more information.

------------------------------------------------------------------------
ANS1604E

The Domino plugin operation failed trying to start the dsmdomp address
space.



Explanation:

The dsmdomp address space could not be started. This is probably an
installation error.

System action:

Processing ends.

User response:

Ensure that the lotus/bin directory has a symbolic link to the tools
directory for dsmdomp and the lotus/notes directory has a symbolic link
to the dsmdomp executable. If the problem persists, contact your System
Administrator for further assistance.

------------------------------------------------------------------------
ANS1605E

The Domino plugin operation failed while initializing communications
with the dsmdomp address space.



Explanation:

The Domino plugin communication initialization failed.

System action:

Processing ends.

User response:

The dsmdomp address space failed during its initialization. This is
likely to be an installation error. Ensure that the lotus/bin directory
has a symbolic link to the tools directory for dsmdomp and the
lotus/notes directory has a symbolic link to the dsmdomp executable. If
the problem persists, contact your System Administrator for further
assistance.

------------------------------------------------------------------------
ANS1606E

The Domino plugin operation failed while starting up the dsmdomp address
space.



Explanation:

The dsmdomp address space could not be started.

System action:

Data Protection for Domino processing stops.

User response:

The dsmdomp address space failed during its initialization. This is
likely to be an installation error. Ensure that the lotus/bin directory
has a symbolic link to the tools directory for dsmdomp and the
lotus/notes directory has a symbolic link to the dsmdomp executable.
Examine the file /tmp/dsmdomp* for more information. If the problem
persists, contact your System Administrator for further assistance.

------------------------------------------------------------------------
ANS1607E

A plugin found in the plugins library is not supported by the current
level of the IBM Spectrum Protect client.



Explanation:

The plugin is not loaded, and processing continues.

System action:

The plugin is not loaded, and processing continues.

User response:

This probably is an installation error. Ensure that the plugins
directory contains valid plugin libraries, and that the correct level of
the IBM Spectrum Protect client has been installed. If the problem
persists, contact your System Administrator for further assistance.

------------------------------------------------------------------------
ANS1608E

Domino plugin operation failed with the following message: messsage



Explanation:

A Domino plugin operation error occurred.

System action:

Processing ends.

User response:

Correct the error that caused the operation to fail.

------------------------------------------------------------------------
ANS1609E

Domino plugin process failed. The following messages are associated with
the error. messsage.



Explanation:

A Domino plugin operation error occurred.

System action:

Processing ends.

User response:

Correct the error that caused the operation to fail.

------------------------------------------------------------------------
ANS1611E

A plugin operation failed because of an internal error.



Explanation:

A plugin internal error has occurred.

System action:

The plugin operation stops.

User response:

If the error persists, run with tracing enabled and contact your System
Administrator and IBM for further assistance.

------------------------------------------------------------------------
ANS1612E

The Domino plugin operation failed because of a IBM Spectrum Protect API
error.



Explanation:

An IBM Spectrum Protect API error occurred .

System action:

Processing ends.

User response:

Check error log on the client machine for more information.

------------------------------------------------------------------------
ANS1613E

>Could not load the IBM Spectrum Protect API.



Explanation:

The IBM Spectrum Protect API could not be loaded.

System action:

Processing ends.

User response:

Check error log on the client machine for more information.

------------------------------------------------------------------------
ANS1614E

The Domino plugin 'Try and Buy' license has expired.



Explanation:

The 'Try and Buy' license that was detected has expired.

System action:

Processing ends.

User response:

This product is no longer valid for use. A valid license must be
obtained before running the product.

------------------------------------------------------------------------
ANS1615E

The Domino plugin operation failed due to a license error.



Explanation:

Domino plugin license verification failed.

System action:

Processing ends.

User response:

Check the error log for further information.

------------------------------------------------------------------------
ANS1616E

The Domino plugin operation failed because the Lotus Domino API could
not be loaded.



Explanation:

The Lotus Domino API could not be loaded.

System action:

Processing ends.

User response:

Ensure the Lotus Domino Server is installed correctly.

------------------------------------------------------------------------
ANS1617E

The Domino plugin operation failed because of a Data Protection for
Domino API error.



Explanation:

A Data Protection for Domino API error occurred during a Domino plugin
operation.

System action:

Processing ends.

User response:

For more details, view the following IBM Spectrum Protect error logs.

The API error log (dsierror.log) and the log of Data Protection for
Domino activity (domdsm.log). The default location of these logs is the
Data Protection for Domino installation directory.

The backup-archive client error log (dsmerror.log), the web client error
log (dsmwebcl.log), and the log of scheduler activite (dsmsched.log).
The default location of these logs is the backup-archive installation
directory.

------------------------------------------------------------------------
ANS1618E

A Domino plugin operation is already in progress. Please wait for
operation to complete.



Explanation:

A Domino plugin operation is in progress.

System action:

The Domino plugin operation stops.

User response:

Please wait for the Domino plugin operation to complete before starting
a new Domino plugin operation.

------------------------------------------------------------------------
ANS1619E

The IBM Spectrum Protect application client cannot work with the version
of the Domino plugin you have installed.



Explanation:

The version of the Domino plugin currently installed on the system is
older than the version used to build the IBM Spectrum Protect
application client.

System action:

Processing ends.

User response:

Install a version of the Domino plugin at or later than the level of the
IBM Spectrum Protect application client.

------------------------------------------------------------------------
ANS1621E

Failed to update backup attributes on server for local backup for
'file_space_namepath_namefile_name', object id - 'object_id':'object_id'
return code 'return_code'.



Explanation:

The process failed to update attributes for the named backup object on
the server. The server may not reflect correct state of the backup.

System action:

Processing continues.

User response:

Check preceding error messages in error log for more information. Retry
the operation. If problem continues, contact your IBM Spectrum Protect
administrator.

------------------------------------------------------------------------
ANS1622I

Number of backup objects cleaned up on server: 'number' number of local
snapshot resources made available :'number'.



Explanation:

While performing consistency check for server's database and the local
repository maintained on the client system, reported inconsistencies
were found. Inconsistent backups cannot be restored, therefore IBM
Spectrum Protect deletes all inconsistent backup objects and frees the
space occupied in the local repository.

System action:

Processing continues.

User response:

Check error log for further details on which objects on server were
deleted. If numbers look unusually high check your configuration and if
it continues, contact your IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS1623W

Backup of NSF Db2 database was skipped. NSF Db2 databases not supported.



Explanation:

This version of DP for Domino plugin does not support NSF Db2 databases.

System action:

Backup of NSF Db2 databases is skipped.

User response:

Exclude NSF Db2 databases from backup.

------------------------------------------------------------------------
ANS1624E

'value' is an invalid value for option 'option' for 'command' command



Explanation:

The specified option value is not valid in this context.

System action:

The operation was stopped

User response:

Specify a valid value for the option. Consult documentation for valid
values.

------------------------------------------------------------------------
ANS1626E

An unexpected error was encountered when processing a IBM Spectrum
Protect operation using a hardware or snapshot function. IBM Spectrum
Protect function name : function-name IBM Spectrum Protect function :
function-desc IBM Spectrum Protect return code : TSM-rc IBM Spectrum
Protect file : file-name (line-number)



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS1632I

'option name' not specified, defaults to 'deafult value'



Explanation:

A value for the option is not spedified, default value wil be used.

System action:

The operation continues using default value for the option

User response:

To override the default, specify a valid value for the option. Consult
documentation for valid values.

------------------------------------------------------------------------
ANS1647E

'input spec': Invalid input specification format.



Explanation:

The specified input for this commmand is invalid.

System action:

The operation stops.

User response:

Verify that the syntax specified with the parameter is correct.

------------------------------------------------------------------------
ANS1648W

PREViewsize option value is greater than the specified stub size.



Explanation:

The PREViewsize CLI option value specified must not be greater than the
stub size for the file.

System action:

Operation stopped. File skipped.

User response:

Change the value of the PREViewsize accordingly.

------------------------------------------------------------------------
ANS1649E

The option 'specified-option' is inconsistent with the option
'other-option'.



Explanation:

The command failed because the the two options cannot be used at the
same time.

System action:

The command is stopped.

User response:

Run the command and do not specify both options.

------------------------------------------------------------------------
ANS1650I

Command: command-string



Explanation:

The command string listed in the message was issued by the
backup-archive client.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1651I

Backed Up: fshlll



Explanation:

The backup operation for the object was successful.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1652I

Archived: fshlll



Explanation:

The archive operation for the object was successful.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1653I

Updated: fshlll



Explanation:

The update operation for the object was successful.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1654E

Failed: fshlll



Explanation:

The backup, archive, restore or retrieve operation for the object
failed.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only. For information about the
failure refer to the backup-archive Client error log.

------------------------------------------------------------------------
ANS1655I

Restored: fshlll



Explanation:

The restore operation for the object was successful.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1656I

Retrieved: fshlll



Explanation:

The retrieve operation for the object was successful.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1657I

Expired: fshlll



Explanation:

The active version of the object was expired in the IBM Spectrum Protect
database.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1658I

Deleted: fshlll



Explanation:

The object was deleted from the IBM Spectrum Protect database.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1659I

Skipped: fshlll



Explanation:

The object was skipped by the user during backup or archive processing.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1660I

Excluded: fshlll



Explanation:

The object was excluded from backup or archive processing.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1661I

Unchanged: fshlll



Explanation:

The object has not changed since the last incremental backup was
performed and does not need to be resent.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1662I

Agent Node: 'agent_node' Target Node: 'target_node'



Explanation:

Proxy nodes information.

System action:

None

User response:

None

------------------------------------------------------------------------
ANS1663W

The option fractional reserve on volume vol_name was reduced to less
than 100 percent.



Explanation:

Network Appliance strongly recommends that when the fractional reserve
is set to less than 100 percent you actively monitor space consumption
and the rate of change of data in the volume to ensure you do not run
out of space reserved for overwrites. In that case, if you run out of
overwrite reserve space, writes to the active file system fail and the
host application or operating system might crash.

System action:

Process continues.

User response:

Ensure that you monitor the space consumption. Consult Network Appliance
for tools to monitor available space in your volumes.

------------------------------------------------------------------------
ANS1664E

The snap restore for volume volname with snapshot name snapname would
destroy later snapshots that are required for other applications or for
volume clones.



Explanation:

ONTAP will delete newer snapshots of a volume when a specific snapshot
is used for snap restore.

System action:

Process stops.

User response:

Prior to a snap restore, ensure that newer snapshots are not used in
other applications or in volume clones.

------------------------------------------------------------------------
ANS1665W

IBM Spectrum Protect for ACS did not find any snapshots for volume
volname on the N series filer.



Explanation:

No snapshots were found for this volume on the N series filer.

System action:

Process continues.

User response:

None.

------------------------------------------------------------------------
ANS1666W

IBM Spectrum Protect for ACS did not find any information about the N
series volume volname.



Explanation:

The query for information about this volume did not return any data.

System action:

Process continues.

User response:

None.

------------------------------------------------------------------------
ANS1667E

The snapshot name snapname for volume volname was not found in the
snapshot list on the N series filer.



Explanation:

Snapshot identified by this name does not exist.

System action:

Process stops.

User response:

None.

------------------------------------------------------------------------
ANS1668E

The 'drive-name1' is not a local disk.



Explanation:

The specified file system is network disk or network share. Because the
CLUSTERNODE option is set to YES, the file system cannot be backed up or
archived.

System action:

Processing stops.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the client
manual for further information about configuring the IBM Spectrum
Protect client to run in a cluster environment.

------------------------------------------------------------------------
ANS1669W

The command subcommand command can only be run in Windows WinPE mode.



Explanation:

The command subcommand command is not supported on a currently running
operating system. You must reboot to Windows WinPE mode to run this
command.

System action:

The command is not processed.

User response:

None.

------------------------------------------------------------------------
ANS1670E

The file specification is not valid. Specify a valid Network Appliance
or N-Series NFS (AIX, Linux) or CIFS (Windows) volume.



Explanation:

The file specification is not valid. Incremental backup using snapshot
difference using the -SNAPDIFF option can only be performed on Network
Appliance or N-Series NFS volumes on AIX and Linux, and on CIFS volumes
on Windows. Do not specify either Network Appliance or N-Series Qtrees
or a path within the Network Appliance or N-Series volume. Only full
volumes are supported.

System action:

Processing stops.

User response:

Retry the incremental backup operation using the -SNAPDIFF option.
Specify a valid Network Appliance or N-Series NFS volume on AIX or
Linux, or a CIFS volume on Windows.

------------------------------------------------------------------------
ANS1672I

Could not take the cluster resource resource name offline. MS rc
retcode. Error is ignored.



Explanation:

Microsoft recommends taking the cluster resources offline during an
authoritative cluster database restore. However, the restore can still
be done if the resources cannot be taken offline. The error is ignored.

System action:

Processing continues.

User response:

No action.

------------------------------------------------------------------------
ANS1673W

Cluster service on node node name could not be started. You must
manually start the service.



Explanation:

The cluster database has been restored. During the restore, the cluster
service was taken offline. IBM Spectrum Protect failed to restart the
cluster service.

System action:

Processing continues.

User response:

You can manually start the service for this node.

------------------------------------------------------------------------
ANS1674I

The cluster database has been restored but the cluster service on some
nodes could not be started. Use the Failover Cluster Management tool to
manually start the nodes.



Explanation:

The cluster database has been restored. During the restore, the cluster
services were taken offline except for the node being restored. IBM
Spectrum Protect failed to automatically start these cluster services.
You need to start them manually. The nodes whose services failed to
start are logged in the client error log.

System action:

Processing continues.

User response:

You can manually start the cluster services.

------------------------------------------------------------------------
ANS1675W

Unable to obtain a list of cluster nodes to restart after the cluster
database is restored. The call 'cmd' returned with MS rc retcode. You
must restart the cluster service on all the nodes after the restore is
finished.



Explanation:

Due to an error, IBM Spectrum Protect could not retrieve a list of nodes
in the cluster to restart. The cluster services on these nodes need to
be started manually. The client error log might contain additional
information depending on where the failure occured.

System action:

Processing continues.

User response:

Manually start the cluster services on all nodes.

------------------------------------------------------------------------
ANS1676W

You are doing an authoritative cluster database restore. The process may
seem to be hang before and after the file is restored. This is because
it may need to start the cluster service if it is not up and take all
the resources offline. After the cluster database is restored, the
cluster service will be restarted for changes to be in effect. The
cluster service on all other nodes also have been shutdown. They will be
restarted. This may take a few minutes.



Explanation:

The restore will seem to be paused at time because before the restore,
IBM Spectrum Protect ensures the cluster service is up on the restoring
node and all the resources are taken offline. After the cluster database
is restored, the cluster service on the restoring node is in a paused
state. The cluster service on other nodes were shutdown. All services
need to be retarted. If some of the services cannot be started
automatically, you can try to restart them.

System action:

Processing continues.

User response:

No action.

------------------------------------------------------------------------
ANS1677W

IBM Spectrum Protect failed to set the disks for quick formatting
because of an error. See the error log for more details. The disks will
be slow formatted which will cause a slower restore process.



Explanation:

By default, IBM Spectrum Protect tries to set the QuickFormat value of
the HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\ASR\RestoreSession key to perform quick formatted on
all the disks. Due to an error, a slow format will be performed on the
re-creation of the disks. This process will cause a slower restore
process.

System action:

None

User response:

None

------------------------------------------------------------------------
ANS1678E

ASR path 'path': not found.



Explanation:

You have specified a directory that does not exist.

System action:

Processing stops.

User response:

Recheck all spelling and punctuation, particularly the placement of
directory delimiters (for example, "\"). Correct the syntax if it is
incorrect, then retry the operation.

------------------------------------------------------------------------
ANS1679W

Updating the registry to identify which volumes have been restored has
failed. This does not affect the volumes that have already been
restored. See the error log for more details. The error is being ignored
and processing continues.



Explanation:

After restoring the critical volumes, IBM Spectrum Protect tries to
update the RestoredVolumes value of the
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\ASR\RestoreSession key to indicate which volumes have
been restored. Due to an error accessing the registry, the error is
logged but processing continues.

System action:

Processing continues.

User response:

None

------------------------------------------------------------------------
ANS1680E

Snapshot Differential Backup is only available for data protection
(SnapVault or SnapMirror) volumes. Volume 'NetApp-Volume' is not a
SnapVault or SnapMirror volume.



Explanation:

The NetApp License only allows using snapshot differencing for data
protection (SnapVault or SnapMirror) volumes.

System action:

The command is not processed.

User response:

None.

------------------------------------------------------------------------
ANS1681E

DSM_DIR was not set and the ASRFILESPATH option was not specified.



Explanation:

The ASR files can be in put in the DSM_DIR path by default or overriden
with the ASRFILESPATH option. Either one is being set.

System action:

Processing stops.

User response:

Set the DSM_DIR environment variable or specify the ASRFILESPATH option
on the "RESTORE MACHINEASR" command.

------------------------------------------------------------------------
ANS1682E

Volume 'NetApp-Volume' is a read only data protection (SnapMirror or
SnapVault) volume. Snapshot Differential Backup snapshots cannot be
created on a read only volume, the USEEXISTINGBASE and
DIFFSNAPSHOT=latest options must be specified to select existing
snapshots for use by the backup.



Explanation:

The specified NetApp volume is read only which prohibits snapshots used
by Snapshot Differential Backup from being created. The USEEXISTINGBASE
and DIFFSNAPSHOT=latest options specify using existing snapshots and may
be used in conjunction with the BASESNAPSHOTNAME and DIFFSNAPSHOTNAME
options.

System action:

The command is not processed.

User response:

Use appropriate options for specifying existing snapshots.

------------------------------------------------------------------------
ANS1684W

Disk Full Error Accessing Subfile Cache: exception-name



Explanation:

A disk full error occurred attempting to access or write to the
specified subfile cache file during a subfile incremental backup. See
the client error log for more detailed information.

System action:

Processing continues without subfile.

User response:

None.

------------------------------------------------------------------------
ANS1685E

Incremental backup operation using snapshot difference is only available
for N series/NetApp filer volumes, is not a NetApp volume.



Explanation:

Cannot perform NAS NFS/CIFS incremental backup operation using snapshot
difference on the mounted or mapped volume because the volume is not a N
series/NetApp filer volume.

System action:

Processing stops.

User response:

Retry the incremental backup operation by specifying an entire NAS NFS
or CIFS volume.

------------------------------------------------------------------------
ANS1686I

Single Instance Store link 'file-name' will be restored or retrieved as
a normal file.



Explanation:

IBM Spectrum Protect restores Single Instance Store (SIS) links as
normal files. If the restored version is a duplicate of of the copy in
the SIS Common Store, then the SIS Groveler will eventually recreate the
SIS link.

System action:

The process creates normal files instead of the reparse point.

User response:

None

------------------------------------------------------------------------
ANS1687E

VSS Instant Restore operation failed. Please examine the IBM Spectrum
Protect client error log file (DSMERROR.LOG), the Windows Application
Event Log, the Windows System Event Log, and the VSS provider log file
(if applicable) for more details. Consult the VSS provider documentation
for the meaning of the error return code.



Explanation:

VSS hardware provider failed while performing volume-level copy restore
operation.

System action:

Processing stopped.

User response:

Attempt to determine the source of the error by examining the
Application Client log file, the client error log file (DSMERROR.LOG),
the Windows Application Event Log, the Windows System Event Log, and the
VSS provider log file, if applicable. Additional instructions for
Windows VSS operations are located in the IBM Spectrum Protect Problem
Determination Guide. Correct the problem and retry the operation. If
this error persists, contact your service representative.

------------------------------------------------------------------------
ANS1688I

Sparse attributes for 'file-name' cannot be backed up correctly because
the volume from which the file is backed up does not support sparse
files.



Explanation:

If the volume from which a file is backed up does not support sparse
files, then the allocated ranges for the sparse file cannot be backed
up. This is true even if a file has its sparse attribute set. One
example where this can occur is if a sparse file is created on a NAS
volume, but the volume is backed up over CIFS, where CIFS does not
support sparse files.

System action:

The sparse attribute and allocated ranges for the file are not backed
up. If the file is restored, the restored file will not be sparse.

User response:

No action is required if you do not need the sparse attribute and
allocated ranges backed up. If you require backup of the file's sparse
attribute and allocated ranges, then the volume from which IBM Spectrum
Protect backs up the file must support sparse files.

------------------------------------------------------------------------
ANS1689E

The registry was not updated after VSS ASR restore.



Explanation:

An error occurred while updating the registry after VSS Automated System
Recovery (ASR). Check dsmerror.log for more information.

System action:

Processing stops.

User response:

Ask your system administrator to check the error log.

------------------------------------------------------------------------
ANS1690E

Snapshot Differential Backup is only available for data protection
(SnapVault or SnapMirror) volumes. Volume 'NetApp-Volume' is not a
SnapVault or SnapMirror volume.



Explanation:

The NetApp licensing agreement for using snapshot differencing only
allows backing up data protection (SnapVault or SnapMirror) volumes.

System action:

Processing stopped.

User response:

none

------------------------------------------------------------------------
ANS1691I

The option 'option' that was found in the options file 'file-name' at
the line number: number is not supported and will be ignored by the
client.



Explanation:

The specified option is valid but not supported on the current platform
and will be ignored by the client.

System action:

Processing continues.

User response:

You can ignore the message or remove the option from the option file.

------------------------------------------------------------------------
ANS1692E

The certificate is not trusted.



Explanation:

The client was unable to open SSL connection to the server because the
server certificate was not trusted.

System action:

Processing stopped

User response:

Make sure that you have configured the key database for SSL
communication as described in the documentation. If the IBM Spectrum
Protect server is using a self-signed certificate, make sure that you
import the correct certificate from the server you are trying to connect
to. When the server is using a certificate signed by an authority, make
sure that the root certificate of the authority is imported into the
client key database.

------------------------------------------------------------------------
ANS1693E

The certificate validity period is incorrect.



Explanation:

The client was unable to open an SSL connection to the server because
the certificate validity period is incorrect.

System action:

Processing stopped

User response:

Report this to the IBM Spectrum Protect server administrator. The server
must have the correct certificate installed.

------------------------------------------------------------------------
ANS1694E

The certificate identity could not be verified.



Explanation:

The process was unable to open an SSL connection to the server because
the certificate identity could not be verified. This happens when the
certificate ownership information does not match the IBM Spectrum
Protect domain name or IP address.

System action:

Processing stopped

User response:

Make sure that the server domain name or the IP address (the value of
the TCPSERVERADDRESS option) is correct. If the problem persists, report
it to your IBM Spectrum Protect server administrator.

------------------------------------------------------------------------
ANS1695E

The certificate is not valid.



Explanation:

The process was unable to open an SSL connection to the server because
of an invalid certificate. The client was unable to determine the exact
cause of the failure.

System action:

Processing stopped

User response:

Further analysis of the server certificate, the client key database, or
both, is needed. Refer to IBM Spectrum Protect documentation for more
information.

------------------------------------------------------------------------
ANS1696E

Only root can perform this action.



Explanation:

User must be root to perform this action.

System action:

Processing stopped.

User response:

Log in as root and try the operation again.

------------------------------------------------------------------------
ANS1698I

The option 'option_name' that was found in the command is not supported
and will be ignored by the client.



Explanation:

The specified option is valid but not supported on the current platform
and will be ignored by the client.

System action:

Processing continues.

User response:

Remove the specified option from the command line, and try again.

------------------------------------------------------------------------
ANS1700W

Database 'database' (save date=date) was successfully recovered.



Explanation:

The specified database (which was saved on the specified date) was
successfuly recovered.

System action:

The specified database was recovered with the last saved version.

User response:

none.

------------------------------------------------------------------------
ANS1704W

Option 'option-name' can not be supplied by application and is ignored.



Explanation:

An API application supplied option. The option cannot be specified by an
application. The option can be specified only in the dsm.sys options
file.

System action:

The supplied option is ignored. Processing continues.

User response:

Correct the application configuration.

------------------------------------------------------------------------
ANS1705E

System Writers writersname do not exist.



Explanation:

These writers are an essential part of the operating system. When they
are not available the backup will complete successfully but the data for
those writers will not get backed up to the IBM Spectrum Protect server.
This can result in the computer not booting after a restore of the
system state.

System action:

System state backup stopped.

User response:

Verify that these writers exist using 'vssadmin list writers' command.
Try the operation again. If the problem persists, contact your system
administrator or IBM Spectrum Protect administrator for further help.

------------------------------------------------------------------------
ANS1706E

Error creating directory ' directory'.



Explanation:

The system was unable to create the specified directory.

System action:

Processing terminates.

User response:

Verify that the system has the appropriate permissions to create this
directory, and then restart the operation.

------------------------------------------------------------------------
ANS1707E

Hard link 'new-file-name' could not be created for existing file
'exist-file-name'. Microsoft Windows return code: 'windows-return-code'
'windows-error-text'



Explanation:

Some system state files are hard links that point to another file.
During system state restore, IBM Spectrum Protect recreates the hard
links for restored system state files. If a file with the same name as
the hard link already exists at the time of the restore, IBM Spectrum
Protect attempts to replace the file with the hard link. This message is
issued when IBM Spectrum Protect is unable to replace an existing file
with a hard link. The message includes the hard link name, the system
state file name to which the hard link points and the Microsoft Windows
return code information. The return code information indicates why the
file could not be replaced. It is possible for the operating system or
applications to behave erratically if the hard link cannot be recreated.

System action:

The hard link is skipped, system state restore continues.

User response:

Use the Microsoft Windows return code information provided in the
message to determine the underlying cause of the error. Based on the
underlying cause of the error and the reason you are restoring the
system state, you can choose to either correct the underlying cause and
perform the restore again, or you can attempt to manually create the
hard link. Because this error message represents an unusual and
unexpected condition, you should give careful consideration to the
potential consequences of either choice. The hard link can be created
manually as follows: Rename the file that has the same name as the hard
link. Then use the Microsoft Windows utility fsutil.exe as follows:
FSUTIL HARDLINK CREATE hardlinkname originalfilename

------------------------------------------------------------------------
ANS1708E

Backup operation failed. Only a root user can do this operation.



Explanation:

Backups initiated by non-root users are disabled by IBM Spectrum Protect
administrator.

System action:

The operation stops.

User response:

Request the IBM Spectrum Protect administrator to enable non-root
backups.

------------------------------------------------------------------------
ANS1710I

Rebound: fshlll



Explanation:

The active version of the object was rebound to a MC in the IBM Spectrum
Protect database.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS1711E

Unable to access disk 'disk name' of VM 'vmname' during backup.



Explanation:

The client is unable to access the VM disk. In case of an offload
backup, this might happen if an RDM disk exists in the VM and is not
accessible on the auxilary ESX host.

System action:

The virtual machine is not backed up.

User response:

Ensure that the VM disk is accessible on the ESX.

------------------------------------------------------------------------
ANS1712W

Operation on snapshot of a snapshot volume 'uncVolumePath' is not
supported for the disk provider type 'LUN-provider-name'
(LUN-provider-type).



Explanation:

Functionality is not available on this type of LUN.

System action:

Operation continues.

User response:

Delete manually the LUN on the storage device or subsystem.

------------------------------------------------------------------------
ANS1714E

A file space already exists for virtual machine (VM_name), but with a
different virtual machine UUID, than the current virtual machine UUID.



Explanation:

A virtual machine with this name was backed up, and it has a different
virtual machine UUID than the virtual machine that is backed up now.
This can occur if there are two virtual machines with the same name that
are backed up to the same data center node name. In this case, the
backup can not continue because the backup-archive client uses the
virtual machine name to uniquely reference the virtual machine on the
IBM Spectrum Protect server.

This can also occur if the virtual machine UUID changed after a previous
backup operation. This is the case after the following events:

1. Virtual machine VM_1 backed up.

2. Virtual machine VM_1 is restored with a new name: VM_2. A new UUID is
   assigned to VM_2.

3. Virtual machine VM_1 is deleted.

4. Virtual machine VM_2 is renamed to VM_1.

System action:

The backup of this virtual machine fails. The backup process can
continue with other virtual machines.

User response:

If there are two or more virtual machines with the same name in the data
center inventory, you can complete either of the following actions:

*  Rename the virtual machines so that all names in the data center
   inventory are unique.

*  Backup up virtual machines with the same name to different IBM
   Spectrum Protect servers.

If the VM's UUID changed, run a BACKUP VM command with
VMBACKUPUPDATEGUID option. The VMBACKUPUPDATEGUID option updates the
UUID on the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS1715E

A file space already exists for virtual machine (VM_name), but with a
different virtual machine UUID (VM_UUID) than the current virtual
machine UUID (VM_UUID).



Explanation:

A virtual machine with this name was backed up, and it has a different
virtual machine UUID than the virtual machine that is backed up now.
This can occur if there are two virtual machines with the same name that
are backed up to the same data center node name. In this case, the
backup can not continue because the backup-archive client uses the
virtual machine name to uniquely reference the virtual machine on the
IBM Spectrum Protect server.

This can also occur if the virtual machine UUID changed after a previous
backup operation. This is the case after the following events:

1. Virtual machine VM_1 backed up.

2. Virtual machine VM_1 is restored with a new name: VM_2. A new UUID is
   assigned to VM_2.

3. Virtual machine VM_1 is deleted.

4. Virtual machine VM_2 is renamed to VM_1.

System action:

The backup of this virtual machine fails. The backup process can
continue with other virtual machines.

User response:

If there are two or more virtual machines with the same name in the data
center inventory, you can complete either of the following actions:

*  Rename the virtual machines so that all names in the data center
   inventory are unique.

*  Backup up virtual machines with the same name to different IBM
   Spectrum Protect servers.

If the VM's UUID changed, run a BACKUP VM command with
VMBACKUPUPDATEGUID option. The VMBACKUPUPDATEGUID option updates the
UUID on the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS1716E

A VMware vStorage web service task timed-out.



Explanation:

The IBM Spectrum Protect client timed-out waiting for VMware vCenter or
ESX host to complete a requested web service task. Resources could be
low or the system could be busy.

System action:

Processing stopped

User response:

Please check the VMware vCenter or ESX host for errors.

------------------------------------------------------------------------
ANS1717E

A VMware vStorage web service task failed.



Explanation:

A VMware vCenter or ESX host web service task failed.

System action:

Processing stopped

User response:

Please check the VMware vCenter or ESX host for errors.

------------------------------------------------------------------------
ANS1729E

The passed file list 'file-list' is not a valid input file list. Pass
standard file list or collection file list to the dsmrecall command.



Explanation:

User has passed a invalid file list type to the dsmrecall command

System action:

Processing stopped

User response:

pass standard file list or collection file list to dsmrecall command.

------------------------------------------------------------------------
ANS1730E

The IBM Spectrum Protect server query for ordering information failed.



Explanation:

Tape optimized recall was not able to retrieve ordering information from
the IBM Spectrum Protect server.

System action:

Processing stopped

User response:

Check the connection to the IBM Spectrum Protect server to see if the
IBM Spectrum Protect server is available and you have the correct access
rights configured.

------------------------------------------------------------------------
ANS1731E

Tape optimized recall for file list 'file-list' failed with rc = code.



Explanation:

Tape optimized recall was not able to retrieve ordering information from
the IBM Spectrum Protect server.

System action:

Processing stops.

User response:

Check all error messages above this message to get details about the
problem.

------------------------------------------------------------------------
ANS1732W

File 'file' is from a different file system. writing file to list of
unprocessed files: 'file-list'.



Explanation:

The dsmrecall command specifies a file system to process. Files from
other file systems are skipped and written into a unprocessed list.

System action:

File is skipped and information is written to a list of unprocessed
files

User response:

Check that all files in the input file list are from the correct file
system.

------------------------------------------------------------------------
ANS1733I

A collection file was specified 'file-list' The ordering process is
skipped.



Explanation:

A collection file was passed as the input file list. Ordering is not
necessary since it the file is already ordered. Only the recall is
started.

System action:

The ordering processed is not started, only recall started.

User response:

No further action needed.

------------------------------------------------------------------------
ANS1734W

The virtual machine 'VM-name' contains one or more independent disks.
Backups are not supported in this configuration. Specify the
'-vmprocessvmwithindependent=yes' option to exclude these disks from the
backup.



Explanation:

Independent disks are not affected by snapshots so the IBM Spectrum
Protect client does not support backing them up.

System action:

The virtual machine is not backed up.

User response:

Turn off the virtual machine and change the disk independent mode or
remove them from the virtual machine. Or specify the
'-vmprocessvmwithindependent=yes' option to exclude these disks from the
backup.

------------------------------------------------------------------------
ANS1735W

The virtual machine 'VM-name' contains one or more physical Raw Device
Mappings (RDMs). Backups are not supported in this configuration.
Specify the '-vmprocessvmwithprdm=yes' option to exclude these disks
from the backup.



Explanation:

Physical RDMs are not included in snapshots so the IBM Spectrum Protect
client does not support backing them up.

System action:

The virtual machine is not backed up.

User response:

Turn off the virtual machine and change the RDMs to virtual mode or
remove them from the virtual machine. Or specify the
'-vmprocessvmwithprdm=yes' option to exclude these disks from the
backup.

------------------------------------------------------------------------
ANS1736W

The virtual machine 'VM-name' cannot be backed up because it contains
one or more disks of an unsupported type.



Explanation:

IBM Spectrum Protect does not support virtual machines with unsupported
disk types.

System action:

The virtual machine is not backed up.

User response:

Convert unsupported disks to a supported type, or remove the unsupported
disks from the virtual machine, or exclude the virtual machine from
backup.

------------------------------------------------------------------------
ANS1737E

The PRESNAPSHOTCMD command failed.



Explanation:

The command specified by the PRESNAPSHOTCMD option must complete
successfully in order to perform the VSS snapshot backup. If the command
completed with a return code of 0 (zero), it is considered to have
completed successfully. If the command completed with any other return
code, it is considered to have failed. If the command failed then the
VSS snapshot backup is not performed.

System action:

The client does not perform the VSS snapshot backup operation.

User response:

Identify and repair the problem that caused the command to fail. If a
non-zero return code is normal for this command, consider wrapping the
command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1738W

The POSTSNAPSHOTCMD command failed.



Explanation:

If the command specified by the POSTSNAPSHOTCMD option completed with a
non-zero return code, the VSS snapshot backup operation continues. The
operation continues with a warning-level result. The result of the
POSTSNAPSHOTCMD command does not supersede a higher result from the VSS
snapshot backup command. For example, if the VSS snapshot backup command
completed with code 12, a lower return code from the POSTSNAPSHOTCMD
command does not alter the return code.

System action:

The VSS snapshot backup continues, but with a warning return code of at
least 8.

User response:

Identify and repair the problem that caused the command to fail.
Consider wrapping the command in a script that always exits with a
return code of zero.

------------------------------------------------------------------------
ANS1739E

Restore of a system drive is not permitted.



Explanation:

The drive to which you are restoring contains the operating system.

System action:

Processing stops.

User response:

Try the operation again without specifying a system drive.

------------------------------------------------------------------------
ANS1740W

Unable to read ACLs for object: file_system path name. Check
dsmerror.log for more information.



Explanation:

The ACLs of the object are not read.

System action:

The object is skipped. Processing continues with the next object.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Try to follow the suggested corrective
actions (if any) and try the operation again.

------------------------------------------------------------------------
ANS1741W

Unable to read extended attributes for file_system path name. Check
dsmerror.log for more information.



Explanation:

The extended attributes of the object are not read.

System action:

The object is skipped. Processing continues with the next object.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Follow the suggested corrective actions (if
any) and try the operation again.

------------------------------------------------------------------------
ANS1742E

Expose Snapshot failed for backup 'backup-name'.



Explanation:

Expose snapshot failed.

System action:

Processing stops

User response:

See the dsmerror.log file for further details.

------------------------------------------------------------------------
ANS1743E

Unexpose snapshot failed for backup 'backup-name'.



Explanation:

Unexpose snapshot failed.

System action:

Processing stops

User response:

See the dsmerror.log file for further details.

------------------------------------------------------------------------
ANS1744E

One or more of the snapshots(volumes) needed for the restore operation
were not found. See dsmerror.log for further details.



Explanation:

One or more of the snapshots needed for restore were not found on the
system.

System action:

Processing stops

User response:

See the dsmerror.log file for further details.

------------------------------------------------------------------------
ANS1745I

The virtual machine to restore has one or more distributed port groups.
Further configuration might be necessary to select a port number after
the restore is complete.



Explanation:

The virtual machine was saved with one or more NIC cards backed by
distributed port groups. Due to conflicts on restore the port number(s)
were not saved.

System action:

The restore continues.

User response:

Edit the virtual machine settings and select a port if needed.

------------------------------------------------------------------------
ANS1746E

No available LUNs were found. Confirm that the storage adapters are
configured correctly on the host and that the LUNs are not mapped to
another virtual machine.



Explanation:

The virtual machine was stored with a Raw Device Mappings disk backed by
a LUN. The required LUN is missing or still mapped to another virtual
machine.

System action:

The virtual machine cannot be restored.

User response:

Confirm that the Storage Adapters are configured correctly on the host
and that the LUNs are not mapped to another virtual machine.

------------------------------------------------------------------------
ANS1747E

Encryption key password is not available.



Explanation:

The client is not enabled for encrypted backup/restore operations by
non-authorized users or the encryption key password is not stored by the
administrator.

System action:

Objects that cannot be encrypted or decrypted are skipped.

User response:

Contact the administrator for your system to configure encrypted
operations for non-authorized users.

------------------------------------------------------------------------
ANS1748E

The virtual machine was stored with a Raw Device Mappings disk backed by
a LUN. The required LUN is missing or still mapped to another virtual
machine: LUN UUID lun.



Explanation:

The virtual machine was stored with a Raw Device Mappings disk backed by
a LUN. The required LUN is missing or still mapped to another virtual
machine.

System action:

The virtual machine cannot be restored.

User response:

Find the required LUN and make it available to the virtual machine.

------------------------------------------------------------------------
ANS1749W

Object 'filespace-namehl-namell-name' was backed up with invalid file
system type attribute.



Explanation:

File system type is used by the client to determine if an object name is
case sensitive or not. Wrong file system type may result in incorrect
sort order of the server tree for case sensitive file systems. Finally
some unchanged files may expire and then re-backed up during full
incremental backup.

System action:

Processing continues.

User response:

It is recommended to rename the correspondent filespace on IBM Spectrum
Protect server and do the full incremental backup again.

------------------------------------------------------------------------
ANS1750I

Volume mount point 'volumemountpoint' is mounted to volume 'volume'.
Using snapshot volume for 'volume' to backup.



Explanation:

The volume mount point resolved to a volume that has been snapped. The
same snapshot volume will be used.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1751E

Error processing 'filespace name': The file system can not be accessed.



Explanation:

The client is unable to access the file system. Two common reasons for
this are the account under which the client is running does not have
access to the root of the file system, or the file system does not
exist.

System action:

The inaccessible file system is skipped. Processing continues with the
next file system.

User response:

Check the error log for additional messages that might yield additional
information about the problem that prevents access to the file system.
Correct the problem, then retry the operation. If the account does not
have access to the file system, then either the system administrator
needs to grant access, or an account that has access to the file system
must be used. If the file system does not exist, then remove or correct
the file system specification.

------------------------------------------------------------------------
ANS1752E

The file system can not be accessed.



Explanation:

The client is unable to access the file system. Two common reasons for
this are the account under which the client is running does not have
access to the root of the file system, or the file system does not
exist.

System action:

The inaccessible file system is ignored.

User response:

Check the error log for additional messages that might yield additional
information about the problem that prevents access to the file system.
Correct the problem, then retry the operation. If the account does not
have access to the file system, then either the system administrator
needs to grant access, or an account that has access to the file system
must be used. If the file system does not exist, then remove or correct
the file system specification.

------------------------------------------------------------------------
ANS1753E

File space 'filespace name' was backed up by an older client version,
and cannot be restored with this client version. The file space will be
skipped.



Explanation:

The backup set format in earlier client versions for SYSTEM STATE and
SYSTEM SERVICES is incompatible with the current client version. Those
file spaces will be skipped. The restore might appear to pause while the
client skips past the objects in those file spaces. Other remaining file
space data will be restored.

System action:

Objects in this file space are skipped. Other remaining file space data
will be restored.

User response:

Restore this specific file space in the backupset with a prior level
client.

------------------------------------------------------------------------
ANS1754E

File space 'filespace name' cannot be restored when ASNODENAME option is
in affect. The file space will be skipped.



Explanation:

System state data of another node should not be restored to a different
node. Those file spaces will be skipped. The restore might appear to
pause while the client skips past the objects in those file spaces.
Other remaining file space data will be restored.

System action:

Objects in this file space are skipped. Other remaining file space data
will be restored.

User response:

Remove ASNODENAME option before restoring this specific file space in
the backupset or use the node name that was used to backup system state
data to restore.

------------------------------------------------------------------------
ANS1755W

An error communicating with Active Directory has occurred. The
USEDIRECTORY option will be ignored and processing will continue.



Explanation:

The process attempted to query Active Directory for IBM Spectrum Protect
server parameters but an error has occurred. This could be caused by
Active Directory or the IBM Spectrum Protect server configuration.

System action:

IBM Spectrum Protect will ignore the USEDIRECTORY option and continue
with client processing.

User response:

Make sure your computer is properly set up to the domain with Active
Directory. Also, make sure your IBM Spectrum Protect Administrator has
properly configured the IBM Spectrum Protect server for your node.

------------------------------------------------------------------------
ANS1756W

The Journal for 'backup-specification' has been reset: The server
filespace was deleted since the last backup completed.



Explanation:

The client has reset the journal because the corresponding server
filespace was deleted since the last backup completed.

System action:

The journal is reset, the current backup won't use the journal, and the
journal won't be available for backup until a full incremental backup
successfully completes.

User response:

None.

------------------------------------------------------------------------
ANS1757W

The Journal for 'backup-specification' has been reset: The server
filespace was deleted since the last backup completed.



Explanation:

The client has reset the journal because the corresponding server
filespace was deleted since the last backup completed.

System action:

The journal is reset, the current backup won't use the journal, and the
journal won't be available for backup until a full incremental backup
successfully completes.

User response:

None.

------------------------------------------------------------------------
ANS1758W

The Journal for 'backup-specification' has been reset: The server
filespace was deleted since the last backup completed.



Explanation:

The client has reset the journal because the corresponding server
filespace was deleted since the last backup completed.

System action:

The journal is reset, the current backup won't use the journal, and the
journal won't be available for backup until a full incremental backup
successfully completes.

User response:

None.

------------------------------------------------------------------------
ANS1759W

The Journal for 'backup-specification' has been reset: The policy set
was updated since the last backup completed.



Explanation:

The client has reset the journal for the specified file system because
the node policy set was updated since the last backup completed.

System action:

The journal is reset, the current backup won't use the journal, and the
journal won't be available for backup until a full incremental backup
successfully completes.

User response:

None.

------------------------------------------------------------------------
ANS1760I

Journal for 'backup-specification' enabled for node 'nodename' and
server 'servername'



Explanation:

The journal for the specified file system is now valid and will be used
by the next full incremental backup by the specified IBM Spectrum
Protect node and server.

System action:

The next full incremental backup of the file system will use the
journal.

User response:

None.

------------------------------------------------------------------------
ANS1761I

Journal for 'backup-specification' will be enabled upon successful
completion of the backup.



Explanation:

An active but invalid journal is present for the file system being
backed up. Once the backup successfully completes the journal will
available for use by the next full incremental backup of the file system
with the same IBM Spectrum Protect node and server.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS1763W

Unable to unmount snapshot mount point snapshot mountpoint during
cleanup of snapshot 'snapshot' of volume 'volume'.Error is
'error'.Operation will continue. Please manually unmount, remove the
snapshot mount point directory and delete the snapshot after backup is
completed.



Explanation:

During the termination phase of IBM Spectrum Protect client operation,
it was not possible to unmount the snapshot for some reason. However,
IBM Spectrum Protect operation was completed successfully.

System action:

Processing continues, and the unmount error is ignored.

User response:

Please manually cleanup the snapshots as follows: Query the snapshot:
snapshot -q -c: <source FS>. Snapshot name will be of the format:
tsmxxxxxxxxxx. Check if it is mounted: df -k | grep tsmxxxxxxxxxx.
Unmount the snapshot: umount -f tsmxxxxxxxxxx. Remove snapshot mount
point: rmdir tsmxxxxxxxxxx. Delete the snapshot: snapshot -d
/dev/tsmxxxxxxxxxx. If snapshot delete fails with "Device Busy" or some
other error, unmount the snapshot source filesystem: umount -f <source
FS>. Retry snapshot delete: snapshot -d /dev/tsmxxxxxxxxxx. Check if any
logical volumes are remaining: ls -l /dev/tsm*. Remove any remaining
logical volumes: rmlv -f tsmxxxxxxxxxx. Remount source file system, if
previously unmounted: mount <source FS>.

------------------------------------------------------------------------
ANS1764W

Unable to remove the snapshot mount point directory snapshot mountpoint
during cleanup of snapshot 'snapshot' of volume 'volume'.Error is
'error'.Operation will continue. Please manually remove the snapshot
mount directory and delete the snapshot after backup is completed.



Explanation:

During the termination phase of IBM Spectrum Protect client operation,
it was not possible to remove the mount point directory for the snapshot
for some reason. However, IBM Spectrum Protect operation was completed
successfully.

System action:

Processing continues, and the rmdir error is ignored.

User response:

Please manually cleanup the snapshots as follows: Query the snapshot:
snapshot -q -c: <source FS>. Snapshot name will be of the format:
tsmxxxxxxxxxx. Check if it is mounted: df -k | grep tsmxxxxxxxxxx.
Unmount the snapshot: umount -f tsmxxxxxxxxxx. Remove snapshot mount
point: rmdir tsmxxxxxxxxxx. Delete the snapshot: snapshot -d
/dev/tsmxxxxxxxxxx. If snapshot delete fails with "Device Busy" or some
other error, unmount the snapshot source filesystem: umount -f <source
FS>. Retry snapshot delete: snapshot -d /dev/tsmxxxxxxxxxx. Check if any
logical volumes are remaining: ls -l /dev/tsm*. Remove any remaining
logical volumes: rmlv -f tsmxxxxxxxxxx. Remount source file system, if
previously unmounted: mount <source FS>.

------------------------------------------------------------------------
ANS1765W

Unable to delete the snapshot during cleanup of snapshot 'snapshot' of
volume 'volume'.Error is 'error'. Operation will continue. Manually
delete the snapshot after backup is completed.



Explanation:

During a backup-archive client operation, it was not possible to delete
the snapshot for some reason. However, the operation was completed
successfully. The error could be caused by an unexpected order of
snapshot commands. AIX JFS2 expects the snapshot delete requests for a
given filesystem to be issued in the order of oldest snapshot first,
next oldest snapshot second, and so on. If there are other processes
using older snapshots for the same filesystem, it fails the delete
request. Also, the backup-archive client only deletes snapshots that
were created by one of its processes. It will not delete older snapshots
created by other applications or users. In this case, the user will have
to manually delete all the older snapshots so that the next
backup-archive command can complete successfully.

System action:

Processing continues, and the snapshot delete error is ignored.

User response:

Manually clean up the snapshots as follows: Query the snapshot: snapshot
-q -c: <source_FS> The snapshot name will be of the format:
tsmxxxxxxxxxx. Check if the snapshot is mounted: df -k | grep
tsmxxxxxxxxxx Unmount the snapshot: umount -f tsmxxxxxxxxxx Remove the
snapshot mount point: rmdir tsmxxxxxxxxxx Delete the snapshot: snapshot
-d /dev/tsmxxxxxxxxxx If the snapshot delete operation fails with
"Device Busy" or some other error, unmount the snapshot source
filesystem: umount -f <source_FS> Retry snapshot delete: snapshot -d
/dev/tsmxxxxxxxxxx Check if any logical volumes are remaining: ls -l
/dev/tsm* Remove any remaining logical volumes: rmlv -f tsmxxxxxxxxxx
Remount source file system, if previously unmounted: mount <source_FS>

------------------------------------------------------------------------
ANS1766E

Failed to initialize SSH2: rc=error-code.



Explanation:

Problem occurred during SSH2 initialization.

System action:

The operation stops.

User response:

Check network, DNS and connection settings to the target host or if SSH
is working properly.

------------------------------------------------------------------------
ANS1767E

Unable to create a snapshot logical volume using command: 'cmd'.Error is
'error'.Please ensure that the volume group has sufficient free
partitions to fulfill the allocation request.



Explanation:

During the initialization phase of IBM Spectrum Protect client
operation, it was not possible to create a logical volume for the
snapshot.

System action:

Processing continues, and the create snapshot logical volume error is
ignored. IBM Spectrum Protect operation will be performed without the
snapshot.

User response:

Please ensure that the volume group has sufficient free partitions to
fulfill the mklv allocation reuest and retry the operation.

------------------------------------------------------------------------
ANS1768E

IBM Spectrum Protect was unable to find space for a new snapshot. IBM
Spectrum Protect function name : function-name IBM Spectrum Protect
function : function-desc IBM Spectrum Protect return code : TSM-rc IBM
Spectrum Protect file : file-name (line-number)



Explanation:

None.

System action:

Processing stops.

User response:

Previous backups may still be pending. If problem persists contact the
IBM Spectrum Protect administrator with the information provided in this
message.

------------------------------------------------------------------------
ANS1769E

NetApp file server 'server-name' at Data ONTAP version
'version.modification.submodification' is not supported for performing
incremental backups using snapshot difference.



Explanation:

Incremental backup using Snapshot difference requires Data ONTAP V7.3 or
later. However, if you are upgrading from Data ONTAP V7.3.3 or later to
V8.0, you will lose snapshot difference support for unicode file names.
Upgrade to Data ONTAP V8.1 or later.

System action:

Processing stops.

User response:

Upgrade the file server to a supported level of Data ONTAP, then retry
the operation.

------------------------------------------------------------------------
ANS1770E

Unable to resolve address 'tcpip address'. Error = error code, 'error
message'



Explanation:

The system was not able to get the TCP/IP v6 address.

System action:

Processing stopped

User response:

Verify the address shown is a TCP/IP v6 address and can be resolved with
ping or ping6.

------------------------------------------------------------------------
ANS1771W

The system state filespace 'filespace name' cannot be restored to a
different location.



Explanation:

The system state file space cannot be restored to a different location.
This file space is skipped.

System action:

Objects in the system state file space are skipped. Other remaining file
spaces are restored. The restore might appear to pause while the client
skips past the objects in this file space.

User response:

Restore system state to its original location.

------------------------------------------------------------------------
ANS1772E

Error loading the snapshot plugin. The plugin might not be installed.



Explanation:

The snapshot plugin could not be loaded, possibly because the plugin is
not installed.

System action:

The snapshot backup is stopped.

User response:

On Linux 86/86_64 platform, install the TIVsm-BAhdw package if it is not
already installed. Try the operation again. On AIX platform, install the
hdw and snphdw filesets if they are not already installed. Try the
operation again.

------------------------------------------------------------------------
ANS1773I

The virtual machine 'VM-name' contains one or more independent disks and
these disks are excluded from the VM backup.



Explanation:

You cannot perform a shapshot of independent disks. Specify the option
'-vmprocessvmwithindependent=yes' to skip these disks.

System action:

The virtual machine independent disks will not be backed up.

User response:

None.

------------------------------------------------------------------------
ANS1774I

The virtual machine 'VM-name' contains one or more physical Raw Device
Mappings (RDM) disks and these disks are excluded from the VM backup.



Explanation:

You cannot perform a shapshot of physical RDM disks. Specify the option
'-vmprocessvmwithprdm=yes' to skip these disks.

System action:

The virtual machine physical RDM disks are not backed up.

User response:

None.

------------------------------------------------------------------------
ANS1780E

writer-name failed to initialize and subscribe to VSS.



Explanation:

IBM Spectrum Protect encountered an error while creating writer-name
under control of the Windows Volume Shadow Copy Service (VSS). Examine
the IBM Spectrum Protect error log and Applications Event Log for
additional information about this error.

System action:

Processing ends.

User response:

Try the operation again. If the error persists, examine the IBM Spectrum
Protect error log and Windows event log for information related to this
error.

Restart the Windows Volume Shadow Copy Service (VSS), and try the
operation again.

In some cases, it is necessary to restart the machine to clear the VSS
error state.

------------------------------------------------------------------------
ANS1782E

writer-name failed to be stopped.



Explanation:

IBM Spectrum Protect encountered an error while stopping writer-name.
Examine the IBM Spectrum Protect error log and Applications Event Log
for additional information about this error.

System action:

Processing ends.

User response:

Try the operation again. If the error persists, examine the IBM Spectrum
Protect error log and Windows event log for information related to this
error.

Restart the Windows Volume Shadow Copy Service (VSS), then try the
operation again.

In some cases, it is necessary to retart the machine to clear the VSS
error state.

------------------------------------------------------------------------
ANS1784E

Incremental by snapshot difference cannot be performed on 'volume-name'
as it is a vFiler volume.



Explanation:

Snapshot difference incremental backup is not supported on vFiler
volumes.

System action:

Processing stops.

User response:

Perform snapshot difference incremental backup on normal NetApp/N-Series
volumes only.

------------------------------------------------------------------------
ANS1787I

The virtual machine NIC is backed by a distributed virtual port group
but it is missing the portgroupKey attribute, The NIC cannot be
restored.



Explanation:

The virtual machine NIC is missing the required portgroupKey attribute.

System action:

The virtual machine can be restored but the NIC cannot be restored.

User response:

After the virtual machine has been restored a new NIC card can be added.

------------------------------------------------------------------------
ANS1788I

The target ESX host is missing the required distributed virtual port
group, the virtual machine NIC cannot be restored. Use
VMDEFAULTDVPORTGROUP option to set to specify new port group. If target
ESXi server does not have any port groups, use VMDEFAULTNETWORK option.



Explanation:

The virtual machine NIC was backed by a distributed virtual port group
but the target ESX host is missing this port group.

System action:

The virtual machine can be restored but the NIC cannot be restored.

User response:

After the virtual machine has been restored a new NIC card can be added.

------------------------------------------------------------------------
ANS1789I

No Ddistributed virtual port group were found on the target ESX host.
The virtual machine NIC cannot be restored.



Explanation:

The virtual machine NIC was backed by a distributed virtual port group
but the target ESX host has no port group available.

System action:

The virtual machine can be restored but the NIC cannot be restored.

User response:

After the virtual machine has been restored a new NIC card can be added.

------------------------------------------------------------------------
ANS1790E

Volume 'volname' cannot be backed up because 'nosnapdir=on' is set on
the filer.



Explanation:

This message is issued when option 'nosnapdir=on' is in set for the
volume indicated in the message. When this option is set, the volume
snapshots are hidden and thus cannot be backed up.

System action:

The volume indicated in the message is not backed up. Processing
continues with the next volume.

User response:

To back up the volume, change the volume on the filer: Set option
'nosnapdir=off'. Then try the backup operation for this volume again. If
the volume is not backed up, remove it from the backup-archive client
DOMAIN setting.

------------------------------------------------------------------------
ANS1794I

The option 'cifs.enable_share_browsing = off' is set on the filer
'filerName'.



Explanation:

This message is issued when the option 'cifs.enable_share_browsing =
off' is set on the NAS filer indicated in the message.

System action:

Processing continues.

User response:

Set option 'cifs.enable_share_browsing = on'. Then try the snapshot
difference backup operation again.

------------------------------------------------------------------------
ANS1795I

Operation will continue without using snapshot provider, because file
system 'volname' does not have write permissions.



Explanation:

The source file system for a snapshot should be read-write as by
definition a snapshot is a point-in-time snapshot of changing file
system. Snapshot creation updates the file system superblock which
requires the file system to be read-write

System action:

Processing continues without using snapshot provider.

User response:

If the volume needs to be backed up via snapshot provider, change its
permissions to read-write.

------------------------------------------------------------------------
ANS1796I

The short name for 'fullpath-name' could not be set to original short
name 'file-name': Windows function 'func-name' failed with return code
return-code, reason: 'error text'



Explanation:

The client cannot set the short name for the specified object. This is
usually because the short name is already in use by another object
located in the same directory. Another possible reason is that the
account under which the client is running does not have the
SE_RESTORE_NAME privilege.

System action:

The short name for the specified object is not set. The object will
retain the default short name. Otherwise processing continues.

User response:

This message is informational and can be safely ignored. If you require
that the object be restored with its original short name, you will need
to move or delete the conflicting object. From an operating system
command prompt, change to the directory that contains the object you
want to restore. Then use the \"dir /x\" command to identify the
conflicting object. Also make sure that you have the SE_RESTORE_NAME
privilege. If you need assistance, see your system administrator. After
the conflict has been resolved, try to restore the file again.

------------------------------------------------------------------------
ANS1797E

Function function-name received an unexpected error from the Microsoft
API MS-function-name: rc=error while attempting to access the object
'object-name'. Error occurred in file file-name (line-number).



Explanation:

An error occurred while processing the object. The error code indicates
the reason for the failure. This information can be used to diagnose the
problem.

System action:

The IBM Spectrum Protect client may or may not fail the operation,
depending on the code.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS1798W

An error occurred while accessing encrypted data of the object
'object-name', skipping object. Windows system error code error, reason
'error-reason'



Explanation:

An error occurred while processing encrypted data of the object. The
error information captured indicates the reason for the failure. This
information can be used to diagnose the problem.

System action:

Object skipped.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS1799I

The last access date for 'fullpath-name' could not be reset because the
file is read-only.



Explanation:

Option PRESERVELASTACCESSDATE YES is in effect, but the IBM Spectrum
Protect client was unable to reset the last access date for the
specified file because the file's "read only" attribute is enabled. The
client cannot reset the last access date for "read only" files.

System action:

The last access date for the specified file is not reset. Otherwise
processing continues.

User response:

This message is informational and can be safely ignored. You might want
to turn off the "read only" attribute for the file so that subsequent
backups can reset the last access date. Before turning off the
attribute, you should verify that doing so will not impact the integrity
of the file or the applications that use the file. You should also make
sure that turning off the attribute will not conflict with the file
management policies of your organization.

------------------------------------------------------------------------
ANS1800W

The last access date for 'fullpath-name' could not be reset: function
'func-name' failed with return code return-code



Explanation:

Option PRESERVELASTACCESSDATE YES is in effect, but the IBM Spectrum
Protect client was unable to reset the last access date for the
specified file. The message includes the name of the function that
failed and the return code from that function.

System action:

The last access date for the specified file is not reset. Otherwise
processing continues.

User response:

If the problem is reproducible, obtain a SERVICE trace that captures an
instance of this problem. Run the QUERY SYSTEMINFO command and collect
the dsminfo.txt file. Contact IBM support and report the exact text of
this error message. Be sure to provide support with the dsminfo.txt and
dsmerror.log files and (if available) the SERVICE trace.

------------------------------------------------------------------------
ANS1801E

Unable to register the new ID with server.



Explanation:

The reasons of this problem can be lack of client system memory or
server protocol error. The IBM Spectrum Protect activity log might
contain a corresponding error message with further information about the
cause.

System action:

The new ID is not registered with the server.

User response:

Please check your network connection and try again after time. If the
error appears again, please contact your client machine administrator.

------------------------------------------------------------------------
ANS1802E

Incremental backup of 'file-name' finished with failCount failure(s)



Explanation:

This message is issued after completion of an incremental backup
operation for the named file specification when one or more objects in
that file specification could not be backed up.

System action:

Processing continues.

User response:

Examine the client error log for additional messages that indicate the
reasons that each failed object could not be backed up. Take any
corrective action as suggested by the messages.

------------------------------------------------------------------------
ANS1803E

Archive processing of 'file-space name' finished with failures.



Explanation:

This message is issued after completion of an archive operation for the
named file specification when one or more objects in that file
specification could not be archived.

System action:

Processing continues.

User response:

Examine the client error log for additional messages that indicate the
reasons that each failed object could not be archived. Take corrective
action as suggested by the messages.

------------------------------------------------------------------------
ANS1804E

Selective Backup processing of 'file-space name' finished with failures.



Explanation:

This message is issued after completion of a selective backup operation
for the named file specification when one or more objects in that file
specification could not be backed up.

System action:

Processing continues.

User response:

Examine the client error log for additional messages that indicate the
reasons that each failed object could not be backed up. Take any
corrective action suggested by those messages.

------------------------------------------------------------------------
ANS1805E

Unable to restore symbolic link 'file-name'.



Explanation:

The client operating system is not able to create a symbolic link
because the link points to a filename that is not given.

System action:

Processing continues.

User response:

Try the restore on a different operating system.

------------------------------------------------------------------------
ANS1806W

Size exceeded the maximum file size limit on your system for
'file_space_namepath_namefile_name' of 'file_size'.



Explanation:

You tried to restore or retrieve a file that has exceeded the maximum
file size limitation on your system.

System action:

The process cannot restore or retrieve the file.

User response:

Restore or retrieve this file on a system that supports the file size.
See your system administrator.

------------------------------------------------------------------------
ANS1807E

Unable to recall file from server due to error from recall daemon.



Explanation:

Unable to recall file. The recall daemon reported an error while trying
to recall a file. Look in the recall daemon's error log for more
information. This can happen if the server is down, the connection is
broken, or the file is missing on the server. It is also possible that
the migration server in the system option file has been changed to a
different server. The recall daemon does not check the system option
file for changes once it has started.

System action:

File skipped.

User response:

See if the server is up, and retry. If the problem still exists, look in
the error log. Also have the workstation administrator run dsmreconcile
against the file system and see if the file shows up in the
.SpaceMan/orphan.stubs file. If system option file has been changed,
stop all recall daemons and restart the master recall daemon to pick up
the changes.

------------------------------------------------------------------------
ANS1808E

The Logical Volume Snapshot Agent is not at the correct level. It is
possible that the Client was upgraded to a newer level but the LVSA
driver was not updated at the same time. Use the Setup Wizard to
configure either Online Image or Open File support and choose Update the
Logical Volume Snapshot Agent.



Explanation:

The selected operation requires the current level of the Logical Volume
Snapshot Agent. Use the Setup Wizard to update the LVSA.

System action:

The selected operation is not performed.

User response:

Retry the operation after updating the Logical Volume Snapshot Agent.

------------------------------------------------------------------------
ANS1809W

A session with the IBM Spectrum Protect server has been disconnected. An
attempt will be made to reestablish the connection.



Explanation:

This message is issued after the session with the IBM Spectrum Protect
server is unexpectedly lost. Some possible reasons that this message
might be issued: - There is a problem with the network. - The IBM
Spectrum Protect server was shut down. - The IBM Spectrum Protect server
administrator cancelled the client session.

System action:

The client will try to reestablish a connection with the server. If the
IBM Spectrum Protect server administrator cancelled the session, then
the attempt to reestablish the connection will fail and message ANS1369E
will be issued. If the attempt to reestablish the connection is
successful, then processing will continue. If the attempt to reestablish
the connection fails, then the client will continue to try to
reestablish a connection according to the COMMRESTARTDURATION and
COMMRESTARTINTERVAL client option settings.

User response:

If the session was cancelled by the IBM Spectrum Protect server
administrator and you do not know why, or if the client is unable to
reestablish a session with the IBM Spectrum Protect server, then contact
your IBM Spectrum Protect server administrator for further information.
Frequent occurrences of the ANS1809W message can indicate a problem with
the network. If this message is repeatedly found in the dsmerror.log,
investigate possible networking trouble, such as a failing network
interface card or router problem. One common problem is the media speed
of the network adaptors: If the network adaptors are set to
"auto-negotiate", try changing them to "100%% full duplex". If the
problem persists, then as a temporary measure ask your IBM Spectrum
Protect server administrator increase the COMMTIMEOUT and IDLETIMEOUT
option settings on the IBM Spectrum Protect server. This might reduce
the frequency of this message.

------------------------------------------------------------------------
ANS1810I

A session with the IBM Spectrum Protect server has been reestablished.



Explanation:

The session with the server has been reestablished after a connection
failure. This message is usually preceded by message ANS1809W.

System action:

Processing will continue.

User response:

None. This message is informational only.

------------------------------------------------------------------------
ANS1811S

IBM Spectrum Protect session could not be reestablished.



Explanation:

The session with the server has been lost. Attempts to reestablish the
session were unsuccessful. Possible causes include, but are not limited
to the following:

*  The server has been halted.

*  The network connection to the server is down.

*  The communication program that IBM Spectrum Protect is interacting
   with has encountered some problem.

System action:

Processing is stopped.

User response:

Check network connection to the server. Insure that the IBM Spectrum
Protect server is running. Insure that the communication program
underlying IBM Spectrum Protect is working properly.

------------------------------------------------------------------------
ANS1813E

Image Backup processing of 'filespace-name' finished with failures.



Explanation:

The image backup operation failed. This message is usually preceded by
other messages indicating the nature of the failure.

System action:

The failing file space is skipped and processing continues.

User response:

Examine the messages preceding this message and the IBM Spectrum Protect
Client error log for more specific indications about the problem. A
common cause is that a tape could not be mounted on the IBM Spectrum
Protect server, perhaps due to an insufficient number of mount points.
If there is a problem with the server, contact your System Administrator
for further assistance.

------------------------------------------------------------------------
ANS1814E

Unable to start the scheduled event 'event-name'



Explanation:

The scheduled event is no longer valid on the server. Either the window
has elapsed or the schedule has been deleted.

System action:

The client scheduler queries the server to obtain the next scheduled
event.

User response:

If the problem continues, contact your system administrator to correct
the problem on the server.

------------------------------------------------------------------------
ANS1815E

Either the window has elapsed or the schedule has been deleted



Explanation:

Scheduled event was no longer valid on the server.

System action:

The client scheduler queries the server to obtain the next scheduled
event.

User response:

If the problem continues, see your system administrator to correct the
problem on the server.

------------------------------------------------------------------------
ANS1816E

Invalid scheduling mode



Explanation:

The mode entered for the scheduled event was not correct.

System action:

Event does not occur.

User response:

Enter the correct scheduling mode and retry the operation.

------------------------------------------------------------------------
ANS1817E

Schedule function can only be run by a IBM Spectrum Protect authorized
user.



Explanation:

An attempt to use the schedule function failed because of improper
authority.

System action:

Processing stopped.

User response:

See the IBM Spectrum Protect authorized user for schedule function
information.

------------------------------------------------------------------------
ANS1818E

The SCHEDULE command is not allowed in LOOP (interactive) mode.



Explanation:

The SCHEDULE command may only be given on the inital command line. Enter
the HELP SCHED command for a complete description of the SCHEDULE
command.

System action:

The client does not execute any scheduled events.

User response:

Start the scheduler from the OS prompt. For example: dsmc schedule
Windows clients can also use the client scheduler service. Read the
client manual for information on how to use the SCHEDULE command and how
to use the IBM Spectrum Protect client scheduler features.

------------------------------------------------------------------------
ANS1819E

The IBM Spectrum Protect server was unable to register the address for
this node.



Explanation:

This is a rare situation, and is usually an indication of a problem with
the IBM Spectrum Protect server.

System action:

Processing stopped.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Ask your IBM Spectrum Protect server administrator to
check the IBM Spectrum Protect server activity log for any messages that
might indicate a problem on the server. Try to correct any indicated
problems, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1820E

Command line options must be preceded by a '-'



Explanation:

An option was specified without a '-' delimiter.

System action:

Processing stopped.

User response:

Enter the command again with a dash preceding each option.

------------------------------------------------------------------------
ANS1821E

Unable to start POSTSCHEDULECMD/ PRESCHEDULECMD 'command'



Explanation:

The requested action required a new process to be created. Either an
option or a schedule "action" that requested an operating system command
to be executed was entered.

System action:

Request is ignored.

User response:

Remove the request from the options file or the schedule defined on the
server.

------------------------------------------------------------------------
ANS1822E

Too many objects were selected for restore. Please select less than
max_objects objects



Explanation:

The restore cannot be performed, because too many objects were selected.

System action:

The restore is not performed.

User response:

Retry the operation after reducing the number of objects selected.

------------------------------------------------------------------------
ANS1823E

The TESTFLAGS or TRACEFLAGS option specifies unknown flag name 'keyword'
or the value supplied is invalid for the named keyword.



Explanation:

Either the testflag or traceflag name is incorrectly spelled, or the
value supplied for that flag is not valid.

System action:

If the TESTFLAGS or TRACEFLAGS option was specified in the client
options file or on the command line during client initialization, the
the client program does not start. If the option was specified from the
command line client while running in LOOP (interactive) mode, then the
operation does not run.

User response:

Correct the TESTFLAGS or TRACEFLAGS flag name or correct the value
specified for the TESTFLAG keyword shown in the message. These options
are typically used at the direction of IBM technical support or as
specified in the IBM Spectrum Protect Problem Determination Guide. If
you are not sure which flag names to use, review the IBM Spectrum
Protect Problem Determination Guide for additional information or
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1824E

Invalid trace file name (name too long).



Explanation:

A TRACEFILE option in the preferences files used a file name that is too
long.

System action:

Client program did not initialize.

User response:

Change the file name used as the TRACEFILE so that it is equal to or
less than 255 characters in length.

------------------------------------------------------------------------
ANS1827W

Directories cannot be selected with the table of contents currently
loaded on the server.



Explanation:

The table of contents that is currently loaded on the server for this
volume does not contain objects corresponding to the one and only
point-in-time backup. It contains an incomplete point in time or
multiple points in time.

System action:

The directory is not selected for restore.

User response:

To be able to select an entire directory for restore, select "Use
Latest" or "Use Point in Time" from the Point in Time dialog.

------------------------------------------------------------------------
ANS1828E

Screen size is too small for using the PICK option.



Explanation:

You cannot use the PICK option on a workstation that has a screen
smaller than 20 characters across and 10 lines down.

System action:

IBM Spectrum Protect did not complete the operation.

User response:

Retry the operation using a workstation that has a screen with the
minimum size, or do not use the PICK option.

------------------------------------------------------------------------
ANS1831E

Password expired. The administrator for this system must run IBM
Spectrum Protect to update the password.



Explanation:

The password expired.

System action:

IBM Spectrum Protect ends.

User response:

The administrator for this system must update the password.

------------------------------------------------------------------------
ANS1832W

The option 'option' is no longer supported and will be ignored by IBM
Spectrum Protect client in this release.



Explanation:

The specified option is in the process of being made obsolete and will
be ignored by the client in this release. This option will be removed in
the next release and will no longer be valid.

System action:

Processing continues.

User response:

Remove the option from the option file. Also check the documentation to
see if this option has been replaced by a newer option.

------------------------------------------------------------------------
ANS1834S

Unable to write to 'file-name' for storing password



Explanation:

IBM Spectrum Protect cannot write to the specified file-name.

System action:

Processing continues.

User response:

Check access permissions and disk space. If unsuccessful, see your
system administrator.

------------------------------------------------------------------------
ANS1835E

PASSWORDACCESS is GENERATE, but password needed for server
'server-name'. Either the password is not stored locally, or it was
changed at the server.



Explanation:

Either the password is not stored locally, or it was changed at the
server.

System action:

IBM Spectrum Protect prompts you for the password if IBM Spectrum
Protect is running in the foreground.

User response:

If IBM Spectrum Protect was running as a background process, issue any
IBM Spectrum Protect command from the foreground. Enter the password in
answer to the prompt. Then try your background IBM Spectrum Protect
command again.

------------------------------------------------------------------------
ANS1836I

Unable to process Processor Value Unit hardware scan info file 'file
name', errno, cause.



Explanation:

The internal-use data file was not readable.

System action:

Processor Value Unit information is not sent to the IBM Spectrum Protect
server. Processing continues.

User response:

No response is necessary. This does not affect regular processing.
Correct any file access permission issues and try the command again. If
the file exists, delete the file and try the command again.

------------------------------------------------------------------------
ANS1837S

File space file_space_name is ignored. Processing continues.



Explanation:

The specified file space in the system options file is invalid.

System action:

The process attempts to continue the current operation.

User response:

Check the file space in the system options file and use a valid file
space. Retry the operation.

------------------------------------------------------------------------
ANS1838E

An error occurred while opening user-specified options file
'file_space_name'.



Explanation:

The specified options file could not be located or opened.

System action:

The process attempts to open the default options file.

User response:

Ensure that the specified options file exists and is valid.

------------------------------------------------------------------------
ANS1839E

Cannot read password.



Explanation:

An error occurred in setting up the input file (for example, the
terminal) to be read.

System action:

Processing stopped.

User response:

Check the attributes of the terminal.

------------------------------------------------------------------------
ANS1852E

Recall failed: offset 'offset' and read size 'size' are beyond the file
size of 'filesize'.



Explanation:

An attempt was made to read beyond the end of the file.

System action:

Processing stopped.

User response:

You must read within the file size. When determining offset and read
size values, all values are processed as bytes.

------------------------------------------------------------------------
ANS1853E

Server could not load the Table of Contents. Status: status



Explanation:

A failure occurred when the server attempted to load a file-level Table
of contents for an NDMP volume. No file-level queries can be performed
against the volume until the problem is solved.

System action:

The table of contents is not loaded.

User response:

Check the server Activity Log to determine the cause of failure. Retry
the operation after correcting the problem.

------------------------------------------------------------------------
ANS1862W

No table of contents information is available on the server for this
volume.



Explanation:

No objects for the selected volume exist on the server that were backed
up with table of contents information. Consequently no file-level
queries can be performed against the volume.

System action:

none

User response:

If file-level information is desired, use TOC option during backup.

------------------------------------------------------------------------
ANS1865E

Session rejected: Named Pipes connection failure.



Explanation:

An attempt to connect to the server using Named Pipes communications
failed. This might have occurred if an incorrect NAMEDPIPENAME was
specified in the options files or if your system administrator canceled
a backup operation.

System action:

Processing stopped.

User response:

Retry the operation, or wait until the server comes back up and retry
the operation. Ensure that the value specified on the NAMEDPIPENAME
option is the same as the one used by the server. If the problem
continues, contact your system administrator for further help.

------------------------------------------------------------------------
ANS1867E

The server generated a CRC for verb type CRC verb which does not match
the received verb verb received.



Explanation:

A cyclic redundancy check (CRC) failed between IBM Spectrum Protect
client and server communication.

System action:

The current object is skipped. Processing continues with the next
object.

User response:

This is an unusual condition, and could indicate a communications
problem between the IBM Spectrum Protect client and server. Try the
operation again. If the problem persists, contact IBM for further
assistance.

------------------------------------------------------------------------
ANS1871W

The server CRC version is server CRC version which does not match the
client version client CRC version.



Explanation:

This is a rare situation. The server and client are using different
versions of cyclic redundancy check (CRC) algorithms.

System action:

Processing continues without CRC checking.

User response:

Clients can be no more than one version downlevel from the IBM Spectrum
Protect server. Make sure the client and server are at compatible
levels. The command line client displays both client and server versions
when the client starts and connects to the server. The QUERY SESSION
command will also display the server version. From the GUI, use the
\"Help/About\" menu item to identify the client version, and the
\"File/Connection Information\" menu item to identify the server
version. If the client and server versions are incompatible, then the
IBM Spectrum Protect server administrator can turn off CRC checking for
your node.

------------------------------------------------------------------------
ANS1873E

An unknown error occurred while processing system object
'sys-obj-name':utility function 'func-name' failed with error error



Explanation:

An unknown error occurred while processing a system object. The error
information captured indicates the reason for the failure. This
information can be used to diagnose the problem.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS1877E

The parsed string is too long for IBM Spectrum Protect to process and
has been truncated to prevent a buffer overflow.



Explanation:

This is a rare condition. A very long string would have to be entered by
the user in a command line, dsm.opt file, or filelist. This string
exceeds the maximum input string size of 1024 bytes.

System action:

IBM Spectrum Protect truncated the string to the maximum possible length
of 1024, then continued with the operation. The operation may fail later
due to this truncation.

User response:

Check the client error log for other messages that might have been
logged after this message was written, and take any corrective action
suggested by those messages. If the problem persists, contact IBM
support for further assistance.

------------------------------------------------------------------------
ANS1878E

An unknown error occurred while processing system object
'sys-obj-name':Service 'service-name' and its dependent services could
not be stopped.



Explanation:

An unknown error occurred while processing a system object. The service
listed in the message and all of its dependent services could not be
stopped. Processing cannot complete until the service is stopped.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Manually stop the service and retry the operation.

------------------------------------------------------------------------
ANS1882E

Unable to stop service 'service-name'; error error



Explanation:

The service could not be stopped by the program.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Manually stop the service and retry the operation.

------------------------------------------------------------------------
ANS1891W

SUBDIR is not a valid option when using FILELIST, SUBDIR will be
ignored.



Explanation:

When Specifying FILELIST each entry is a single object and so SUBDIR
will not apply.

System action:

The option SUBDIR is ignored.

User response:

You may have either a -FILELIST or SUBDIR on this command, but not both.

------------------------------------------------------------------------
ANS1892W

Expire command is not allowed on the IBM Spectrum Protect journaled
filespace 'filespace'.



Explanation:

You cannot expire files from the server on a IBM Spectrum Protect
journaled filespace.

System action:

The expire command will not work on this filespec

User response:

If you want to expire this filepec remove it from the local filesystem.

------------------------------------------------------------------------
ANS1895I

Highest macro return code was return code value.



Explanation:

This message is issued after all commands in a client macro have
completed. The return code represents the highest return code that was
issued during processing of the macro. In order of increasing severity,
the return code meanings are:

   0 - The command completed successfully
   4 - One or more files were skipped
   8 - One or more warning messages were issued
   12 - One or more error messages (except for skipped files) were
   issued

System action:

None.

User response:

For return codes other than 0, the user may wish to verify the results
of the client operation(s) and take diagnostic and repair actions, as
necessary.

------------------------------------------------------------------------
ANS1898I

***** Processed count files *****



Explanation:

IBM Spectrum Protect has processed the specified number of files.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1899I

***** Examined count files *****



Explanation:

IBM Spectrum Protect has examined the specified number of files.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1900I

Return code is return code value.



Explanation:

The return code has been issued for the preceding client command. In
order of increasing severity, the return code meanings are:

   0 - The command completed successfully
   4 - One or more files were skipped
   8 - One or more warning messages were issued
   12 - One or more error messages (except for skipped files) were
   issued

The return code indicates the highest severity message that was issued
during execution of the client command. For a scheduled event, the event
will be considered successful if the return code is 0, 4, or 8. The
event will be considered to have failed if the return code is 12.

System action:

None.

User response:

For return codes other than 0, the user may wish to verify the results
of the client operation and take diagnostic and repair actions, as
necessary.

------------------------------------------------------------------------
ANS1901I

Highest return code was return code value.



Explanation:

This message indicates the highest return code of all the client
commands that were executed. In order of increasing severity, the return
code meanings are:

   0 - The command completed successfully
   4 - One or more files were skipped
   8 - One or more warning messages were issued
   12 - One or more error messages (except for skipped files) were
   issued

System action:

None.

User response:

For return codes other than 0, the user may wish to verify the results
of the client operation(s) and take diagnostic and repair actions, as
necessary.

------------------------------------------------------------------------
ANS1902E

The PRESCHEDULECMD command failed. The scheduled event will not be
executed.



Explanation:

The command specified by the PRESCHEDULECMD option must complete
successfully in order to execute the scheduled event. If the command
completed with a return code of 0 (zero), it is considered to have
completed successfully. If the command completed with any other return
code, it is considered to have failed. If the command failed then the
scheduled event is not executed.

System action:

The client does not execute the scheduled event, and the result code of
the scheduled event will be 12.

User response:

Identify and repair the problem that caused the command to fail. If it
is not necessary for the command to complete before starting the
scheduled event, then consider using the PRENSCHEDULECMD option, which
does not require that the command complete successfully. If a non-zero
return code is normal for this command, then consider wrapping the
command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1903W

The POSTSCHEDULECMD command failed.



Explanation:

If the command specified by the POSTSCHEDULECMD option completed with a
non-zero return code, then the scheduled event is considered to have
completed successfully, but with a warning-level result. Note that the
result of the POSTSCHEDULECMD command will not supercede a higher result
from the scheduled client command. For example, if the scheduled client
command completed with a return code of 12, the scheduled event will be
considered to have completed with a return code of 12, regardless of the
outcome of the POSTSCHEDULECMD command.

System action:

At a minimum, the result code of the scheduled event is 8.

User response:

Identify and repair the problem that caused the command to fail. If it
is not necessary for the command to complete before posting the result
of the scheduled event, then consider using the POSTNSCHEDULECMD option.
If a non-zero return code is normal for this command, then consider
wrapping the command in a script that always exits with a return code of
zero.

------------------------------------------------------------------------
ANS1904E

The archive description may not contain any wildcard characters like '?'
or '*'.



Explanation:

Descriptions for archive files must not contain wildcard characters.

System action:

Processing stopped.

User response:

Enter an archive description that does not contain wildcard characters.

------------------------------------------------------------------------
ANS1906I

Destination must be specified for this operation when using FROMNODE.



Explanation:

You must specify a destination with a Restore/Retrieve command when
using FROMNODE processing.

System action:

Processing stops.

User response:

Retry the Restore/Retrieve command with a destination specified.

For example, with the Windows backup-archive client:

restore -fromnode=cougar \\cougar\d$\projx\* d:\projx\

Or, with the UNIX and Linux backup-archive clients:

restore -fromn=node1 -fromo=ann "/home/proj/*" /home/gillis/

------------------------------------------------------------------------
ANS1907E

An error occurred while trying to perform an object merge operation on
the server.



Explanation:

For NetWare clients: The IBM Spectrum Protect server is unable to
perform a NetWare long name conversion. For Unix or Windows image
backup: The group used to store associated image components could not be
closed.

System action:

The operation ends.

User response:

For NetWare: It is possible that a more current level of the IBM
Spectrum Protect server can perform the conversion. Contact your IBM
Spectrum Protect server administrator for assistance. For Unix or
Windows: This error indicates an authorization problem. Contact your IBM
Spectrum Protect server administrator for assistance. If the problem
still cannot be resolved, contact IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS1908I

The scheduled command completed successfully.



Explanation:

The scheduled command completed with return code of zero, which is
interpreted as success.

System action:

The scheduled event is successful. The result code for the event is 0.

User response:

None.

------------------------------------------------------------------------
ANS1909E

The scheduled command failed.



Explanation:

The scheduled command completed with a non-zero return code, which is
interpreted as failure.

System action:

The scheduled event is failed. The result code for the event is 12.

User response:

Identify and repair the problem that caused the command to fail. If a
non-zero return code is normal for this command, then consider wrapping
the command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS1912E

An invalid registry hive was specified.



Explanation:

The specified registry hive is invalid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1913E

An invalid registry subkey was specified.



Explanation:

The specified registry subkey is invalid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1914E

The specified subkey isn't valid for the specified hive.



Explanation:

The specified registry subkey is invalid for the specified registry
hive.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1915E

Too many arguments specified for the BACKUP REGISTRY command.



Explanation:

Too many arguments were specified for the BACKUP REGISTRY command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1916E

Too many arguments specified for the RESTORE REGISTRY command.



Explanation:

Too many arguments were specified for the RESTORE REGISTRY command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1917E

Too few arguments specified for the BACKUP REGISTRY command.



Explanation:

Too few arguments were specified for the BACKUP REGISTRY command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1918E

Too few arguments specified for the RESTORE REGISTRY command.



Explanation:

Too few arguments were specified for the RESTORE REGISTRY command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1919E

The specified eventlog is not valid.



Explanation:

The specified eventlog is not valid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1920E

Too many arguments specified for the BACKUP EVENTLOG command.



Explanation:

Too many arguments were specified for the BACKUP EVENTLOG command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1921E

Too many arguments specified for the RESTORE EVENTLOG command.



Explanation:

Too many arguments were specified for the RESTORE EVENTLOG command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1922E

Too few arguments specified for the BACKUP EVENTLOG command.



Explanation:

Too few arguments were specified for the BACKUP EVENTLOG command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1923E

Too few arguments specified for the RESTORE EVENTLOG command.



Explanation:

Too few arguments were specified for the RESTORE EVENTLOG command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1924E

The specified system object is not valid.



Explanation:

The specified system object is not valid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1925E

The specified system object type is not valid.



Explanation:

The specified system object type is not valid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1926E

The specified system object type is only valid on Windows NT.



Explanation:

The specified system object type is only valid on Windows NT.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1928E

Server-initiated sessions are not available in the LAN-free mode.



Explanation:

Conflicting options SESSIONINIT=serveronly and ENABLELANFREE=yes were
specified. This combination is not allowed.

System action:

Processing stops.

User response:

Use client-initiated sessions or disable LAN-free.

------------------------------------------------------------------------
ANS1929E

An error occurred saving the registry key.



Explanation:

The active registry key cannot be copied to the ADSM.SYS staging
directory.

System action:

The registry backup operation stops.

User response:

Check the space available on the Windows boot partition to ensure there
is room to contain a copy of the Windows registry. This might require
several megabytes of free space. Also check the Windows permissions on
the ADSM.SYS staging directory and ensure that the Windows user which
you are using to run IBM Spectrum Protect has full access to that
directory and its contents.

------------------------------------------------------------------------
ANS1930W

IBM Spectrum Protect Express client view not supported with a IBM
Spectrum Protect Enterprise server. CLIENTVIEW option ignored.



Explanation:

The IBM Spectrum Protect Express client view is only supported when
going to a IBM Spectrum Protect Express server. When a IBM Spectrum
Protect Express client connects to a IBM Spectrum Protect Enterprise
server, the CLIENTVIEW option is ignored, and the IBM Spectrum Protect
Standard client view is displayed instead.

System action:

The CLIENTVIEW option is ignored and the IBM Spectrum Protect Enterprise
client view is displayed.

User response:

If you intend to use the IBM Spectrum Protect Enterprise server, then
update your CLIENTVIEW option to a value of STANDARD. Otherwise, update
your TCPSERVERADDRESS option to point to your IBM Spectrum Protect
Express server.

------------------------------------------------------------------------
ANS1931E

An error saving one or more eventlogs.



Explanation:

An error occurred saving one or more eventlogs.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1932E

An error occurred replacing one or more registry keys.



Explanation:

The registry key or keys being replaced are exclusively held by another
process. The registry keys were previously restored but the system was
not restarted.

System action:

processing stops.

User response:

This error occurs because the registry key or keys being replaced are
exclusively held by another process. This can happen if the registry
keys were previously restored but the system was not rebooted. Reboot
the system and attempt the restore operation again.

------------------------------------------------------------------------
ANS1933E

Error accessing file or device 'name'.



Explanation:

An error has occurred while accessing the file or device.

System action:

Backup set operation is not completed.

User response:

Verify that the file or device exists and is accessible.

------------------------------------------------------------------------
ANS1934E

Backup set 'name' not found.



Explanation:

The backup set name was not found on the server.

System action:

The backup set operation is not processed.

User response:

Verify that the backup set name is correct.

------------------------------------------------------------------------
ANS1935E

Too many arguments specified for the BACKUP NTDS command.



Explanation:

Too many arguments were specified for the BACKUP NTDS command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1936E

Not enough arguments specified for the BACKUP NTDS command.



Explanation:

Not enough arguments were specified for the BACKUP NTDS command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1937E

No NTDS server name specified for the BACKUP NTDS command.



Explanation:

No NTDS server name was specified for the BACKUP NTDS command.

System action:

Processing stopped.

User response:

Specify NTDS server name at the command and retry the operation.

------------------------------------------------------------------------
ANS1938E

NT Active Directory is not supported in this OS level.



Explanation:

NT Active Directory is not supported in this OS level.

System action:

Processing stopped.

User response:

Install Active Directory before performing backup operation.

------------------------------------------------------------------------
ANS1939E

File Replication Service backup failed.



Explanation:

IBM Spectrum Protect encountered an error while backing up files under
control of the Windows 2000 File Replication Service

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the File Replication Service is operating properly. Restart the service
and retry the backup operation.

------------------------------------------------------------------------
ANS1940E

File Replication Service restore failed.



Explanation:

IBM Spectrum Protect encountered an error while restoring files under
control of the Windows 2000 File Replication Service

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the File Replication Service is operating properly. Restart the service
and retry the restore operation.

------------------------------------------------------------------------
ANS1941E

System Volume backup failed.



Explanation:

IBM Spectrum Protect encountered an error while backing up files of the
Windows 2000 System Volume

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the system volume was successfully initialized. Restart the service and
retry the backup operation

------------------------------------------------------------------------
ANS1942E

System Volume restore failed.



Explanation:

IBM Spectrum Protect encountered an error while restoring files under
control of the Windows 2000 File Replication Service

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the system volume was successfully initialized. Restart the service and
retry the restore operation.

------------------------------------------------------------------------
ANS1943E

The operation is not supported: Downlevel server version.



Explanation:

The operation cannot be performed because server version is downlevel.

System action:

Processing stopped.

User response:

Use correct server version.

------------------------------------------------------------------------
ANS1944E

Error accessing file or device.



Explanation:

An error has occurred while accessing the file or device.

System action:

Backup set operation is not completed.

User response:

Verify that the file or device exists and is accessible.

------------------------------------------------------------------------
ANS1945E

The long namespace has been removed from the local file space. If you
wish to proceed with the backup/archive operation, rename your file
space on the server.



Explanation:

The process has detected that the server namespace is NTW:LONG, but the
local volume does not have long name support. If you would like to back
up the volume using the short names, rename the file space on the
server. If you would like to back up using long names, add the long
namespace support back to the volume in question.

System action:

Processing stopped.

User response:

Add the long namespace support to the volume or rename(remove) the
corresponding server file space.

------------------------------------------------------------------------
ANS1946W

File exists, skipping



Explanation:

The client tried to restore or retrieve the specified file, but the file
already existed in the target restore location and the user chose not to
replace the existing file.

System action:

The file is skipped, a message is logged in dsmerror.log, and restore or
retrieve processing continues with the next object.

User response:

The file was skipped because either REPLACE NO was in effect, causing
all existing files and directories to be skipped, or REPLACE PROMPT was
in effect, and when prompted, the user chose to skip this file or all
existing directories and files. No additional action is necessary if the
decision to skip the file was deliberate. Otherwise the operation can be
retried using either REPLACE ALL (automatically replace existing
directories and files) or REPLACE PROMPT (prompt the user whether to
replace the file).

------------------------------------------------------------------------
ANS1947W

The following directory exists and is skipped: file-space_name
directory_path directory_name



Explanation:

The client tried to restore or retrieve the specified directory. The
directory exists in the target restore location and the user chose not
to replace the existing directory.

The directory can be skipped because the option REPLACE=NO is set, which
causes all existing files and directories to be skipped. The directory
can be skipped because option REPLACE=PROMPT is set, and the user
chooses to skip this directory when prompted.

System action:

The directory is skipped, a message is logged in the dsmerror.log log
file, and restore or retrieve processing continues with the next object.

User response:

No additional action is necessary.

To replace the files, try the operation again and set option
REPLACE=ALL. You can set REPLACE=PROMPT and when prompted, choose to
replace the directory.

------------------------------------------------------------------------
ANS1948E

The Microsoft volume shadow copy system components could not be queried.



Explanation:

IBM Spectrum Protect encountered an error while querying the system
writers under control of the Windows volume shadow copy service. The
error log and Windows event log might contain additional information
about this error.

System action:

Processing stops.

User response:

Try the operation again. If the error persists, review the error log and
Windows event log for information related to this error. You might need
to restart the volume shadow copy service, then try the operation again.
It might be necessary to reboot the machine to clear the volume shadow
copy error state.

------------------------------------------------------------------------
ANS1949E

Microsoft volume shadow copy snapshot initialization failed.



Explanation:

IBM Spectrum Protect encountered an error while initializing the
Microsoft Volume Shadow Copy Service for backup or restore. The error
log and Windows event log can contain additional information about this
error.

System action:

processing stops.

User response:

Try the operation again. If the error persists, review the error log and
Windows event log for information related to this error. Use the Windows
command 'vssadmin list writers' to determine the status of the Volume
Shadow Copy service. You can reboot the machine to clear the volume
shadow copy error state. If the system is a Domain Controller and the
Active Directory service is stopped, restarting the Active Directory
service will resolve the issue.

------------------------------------------------------------------------
ANS1950E

Backup using Microsoft volume shadow copy failed.



Explanation:

IBM Spectrum Protect encountered an error while performing a backup
operation using the Microsoft volume shadow copy service. The error log
and Windows event log might contain additional information about this
error.

System action:

processing stops.

User response:

Review the error log and Windows event log for information related to
this error. Restart any failing system service indicated in the Windows
event log. Restart the volume shadow copy Service. You can use the
Windows command 'vssadmin list writers' to determine the status of the
volume shadow copy service. It might be necessary to reboot the machine
to clear the Volume Shadow Copy error state.

------------------------------------------------------------------------
ANS1951E

Restore using Microsoft volume shadow copy failed.



Explanation:

IBM Spectrum Protect encountered an error while restoring with the
Microsoft Volume Shadow Copy Service.

System action:

processing stops.

User response:

Review the error log and Windows event log for information related to
this error. Restart any failing system service indicated in the Windows
event log. Restart the volume shadow copy Service. You can use the
Windows command 'vssadmin list writers' to determine the status of the
volume shadow copy service. It might be necessary to reboot the machine
to clear the Volume Shadow Copy error state.

------------------------------------------------------------------------
ANS1952E

Invalid symbolic link destination 'file-name' entered



Explanation:

You entered a restore/retrieve destination file-name specification that
is a symbolic link. To restore to symbolic link, make sure you set the
followsymbolic option to yes. Also, check where this symbolic link
points. You can restore/retrieve to a symbolic link that points to an
existing object.

System action:

Processing stopped.

User response:

Enter a correct file specification.

------------------------------------------------------------------------
ANS1954E

Backup processing of 'file-space name' finished with failures.



Explanation:

This message indicates that the file system backup has completed, but
encountered errors during backup processing.

System action:

Processing continues.

User response:

Examine the client error log for additional messages related to errors
in backing up the file system. Take any corrective action as suggested
by the messages.

------------------------------------------------------------------------
ANS1956E

Too few arguments specified for the BACKUP GROUP command.



Explanation:

Too few arguments were specified for the BACKUP GROUP command.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1957E

Showmembers and inactive are mutually exclusive parameters on a query.



Explanation:

Showmembers and inactive are mutually exclusive parameters on a query.

System action:

Processing terminates.

User response:

Specify one of the mutually exclusive parameters on the query

------------------------------------------------------------------------
ANS1958W

No base group found, attempting a full backup.



Explanation:

A differential backup requires a previous full backup to have been
performed.

System action:

Processing continues, and a full backup is attempted.

User response:

None. Perform a full backup before attempting a differential backup

------------------------------------------------------------------------
ANS1959I

Removing previous incomplete group 'name' Id:hi-lo



Explanation:

A previous group backup failed without cleaning up the temporary groups
correctly.

System action:

The previous incomplete groups are removed and processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1971E

The remote client agent (dsmagent) could not be started.



Explanation:

The remote client agent cannot be started. This error message is usually
preceded or followed by other messages.

System action:

Processing is stopped.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Verify that the web client is installed correctly. Try
to correct any indicated problems, then try the operation again. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1972E

The connection to the remote client agent (dsmagent) failed. Either the
port number could not be read, or the port number is invalid.



Explanation:

An error occurred when trying to read the port number. A connection to
the remote client agent cannot be made.

System action:

Processing stopped.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Verify that the web client is installed correctly. Try
to correct any indicated problems, then try the operation again. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS1973I

VSS writer for system object 'name' does not exist. Restore skipped.



Explanation:

Microsoft Volume Shadow Copy Service does not detect a writer for this
system component. Either the component is not installed or is not
running..

System action:

Object skipped.

User response:

Install or enable the affected system service and retry the operation.

------------------------------------------------------------------------
ANS1974W

Error removing previous incomplete group Id:hi-lo



Explanation:

A previous group backup failed without cleaning up the temporary groups
correctly, and the error still can not be cleaned up.

System action:

The previous incomplete groups remain and processing continues.

User response:

None.

------------------------------------------------------------------------
ANS1975W

IBM Spectrum Protect server error reason occurred closing and renaming
the group



Explanation:

An error was encountered closing and renaming the temporary group.

System action:

The backup is unsuccessful.

User response:

Ensure that the user has the proper authority to update the group and
try the operation again.

------------------------------------------------------------------------
ANS1976E

The specified system service is not valid.



Explanation:

The specified system service is not valid.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS1977E

Dsmcad schedule invocation was unsuccessful. This command will be tried
again in 10 minutes.



Explanation:

Dsmcad was unable to get the valid scheduler information from the dsmc
schedule process. This could be due to some problems during the
scheduler initialization, such as incorrect option usage.

System action:

Dsmcad will try to invoke the scheduler again in 10 minutes in order to
get the valid information.

User response:

Check the console and error logs to determine what kind of error
occurred during the dsmc process and correct the problem.

------------------------------------------------------------------------
ANS1978E

The IBM Spectrum Protect server is downlevel and does not support the
requested function. See error log for version information.



Explanation:

The function being used requires a more current IBM Spectrum Protect
Server.

System action:

The operation fails.

User response:

Upgrade your IBM Spectrum Protect Server to a level that supports this
function. See error log for version information.

------------------------------------------------------------------------
ANS1979E

The IBM Spectrum Protect Storage Agent is downlevel and does not support
the requested function. See error log for version information.



Explanation:

The function being used requires a more current IBM Spectrum Protect
Storage Agent.

System action:

The operation fails.

User response:

Upgrade your IBM Spectrum Protect Storage Agent to a level that supports
this function. See error log for version information.

------------------------------------------------------------------------
ANS1980E

The IBM Spectrum Protect Server and IBM Spectrum Protect Storage agent
are downlevel and do not support the requested function. See error log
for version information.



Explanation:

The function being used requires a more current IBM Spectrum Protect
Server and IBM Spectrum Protect Storage agent

System action:

The operation fails.

User response:

Upgrade your IBM Spectrum Protect Server and IBM Spectrum Protect
Storage agent to a level that supports this function. See error log for
version information.

------------------------------------------------------------------------
ANS1981E

Server :Version ver, Release rel, Level lev.subl Storage Agent:Version
SAver, Release SArel, Level SAlev.SAsubl



Explanation:

This message supplies extra detail to downlevel messages.

System action:

The operation fails.

User response:

This message supplies extra detail to downlevel messages.

------------------------------------------------------------------------
ANS1986E

Initialization functions cannot open the trace file specified.



Explanation:

The file could not be opened during initialization. The specified path
might be incorrect. It is also possible that the current user does not
have permission to write to the tracefile in the directory specified. It
is also possible that no space is available at the tracefile location.

System action:

Processing stops.

User response:

Make sure the tracefile option points to a valid path and that the user
has proper permissions to write to the specified file.

------------------------------------------------------------------------
ANS1987E

A destination file specification is not allowed with this command.



Explanation:

Of all the system object restore commands only RESTORE ASR allows the
entry of a destination file specification.

System action:

Processing stopped.

User response:

Re-issue the command without a destination file specification.

------------------------------------------------------------------------
ANS1989E

Initialization functions cannot open the error log file specified.



Explanation:

The error log file could not be opened during initialization. The
specified path may be incorrect. It is also possible that the current
user does not have permission to write to the logfile in the directory
specified. It is also possible that no space is available at the given
logfile location.

System action:

Processing terminates.

User response:

Make sure the logfile option points to a valid path and that the user
has proper permissions to write to the file specified.

------------------------------------------------------------------------
ANS1990W

The 'filesystem name' volume mount point can not be accessed. The IBM
Spectrum Protect return code is 'rc'.



Explanation:

The client is unable to access volume mount point. The common reasons
for this are that the account under which the client is running does not
have access to the volume mount point, or the volume is mounted onto a
cluster volume which is currently not available.

System action:

The inaccessible mount point is skipped and processing continues. with
the next mount point or volume.

User response:

Check the error log for additional messages that might yield additional
information about the problem that prevents access to the volume mount
point. Ensure that the IBM Spectrum Protect client is running under an
account which as access to the volume mount point. Ensure that the mount
point is not accessing a clustered volume. Please refer to Microsoft KB
Article 280297 for more information about how to configure volume mount
points on a clustered server.

------------------------------------------------------------------------
ANS1991E

An error occurred processing registry key 'key-name', data value
'value-name'. See the client error log for additional information about
this error.



Explanation:

An unexpected error occurred when the client tried to read or update the
Windows registry. Additional information regarding the error is usually
placed in the error log.

System action:

The operation might not execute correctly, depending on the error.

User response:

Check the client error log for any other messages that might have been
logged when this message was written, and take any corrective action
suggested by those messages. If the problem persists, contact IBM
support for further assistance.

------------------------------------------------------------------------
ANS1995W

Objects of different types cannot be deleted at the same time.



Explanation:

Deleting objects of different types is not allowed. For example,
deleting Backup Sets and regular file objects at the same time is not
possible.

System action:

No processing takes place.

User response:

Select objects of the same type to perform delete operation.

------------------------------------------------------------------------
ANS1996W

The volume mount points enumeration on 'filesystem name' volume failed.
Windows system error code: error; reason: 'error-reason'.



Explanation:

The client was unable to scan the specified volume for volume mount
points. The error information captured indicates the reason for the
failure. A common reason is that the account under which the client is
running does not have access to the volume.

System action:

The processing continues with the next volume.

User response:

Ensure that the client is running under an account which has access to
the volume and volume mount points. Correct the condition causing the
error and try the operation again. If the problem persists, contact your
system administrator or IBM Spectrum Protect administrator for further
help.

------------------------------------------------------------------------
ANS1997W

No files have been previously backed up for the VSS component
'component-name'.



Explanation:

You tried to restore the Microsoft Volume Shadow Copy (VSS) System State
component which does not contain file data. This is not necessarily a
problem.

System action:

Processing continues.

User response:

Check the error log for any other messages that occurred during backup.
The logs can indicate a reason for the failure.

------------------------------------------------------------------------
ANS1998W

Transaction byte limit 'name' is not supported by the server. Value
reset to limit



Explanation:

The TXNBYTELIMIT is larger than the server supports. The value will be
reset to a supported limit.

System action:

TXNBYTELIMIT is reset, and processing continues.

User response:

Set the option to a value supported by the server.

------------------------------------------------------------------------
ANS1999E

type of the operation processing of 'filespace-name' stopped.



Explanation:

The client has encountered a condition where it can not continue
processing the specified file space. The IBM Spectrum Protect client
error log or schedule log should contain additional messages related to
this error.

System action:

Processing stops.

User response:

Check the IBM Spectrum Protect client error log and schedule log for any
additional messages related to this error. Take any corrective action
that might be suggested by the related messages, then try the operation
again. If the problem persists, contact your IBM Spectrum Protect
administrator for further assistance.

------------------------------------------------------------------------
ANS2025W

Object 'object-name' has been removed from DB (Fix IT19964).



Explanation:

Fix of the APAR IT19964

System action:

None

User response:

Nothing

------------------------------------------------------------------------
ANS2026W

Bad sectors were detected on the volume 'volname'.



Explanation:

Bad sectors are skipped during image backup/restore operations.

System action:

Processing continues.

User response:

Make sure the volume data is not corrupt by using system tools like
chkdsk (Windows) or fsck (Unix).

------------------------------------------------------------------------
ANS2027E

GSKit function func-name failed with error-code: During the SSL/TLS
handshake, the client could not agree on a supported SSL/TLS protocol
version to use with server. session



Explanation:

A GSKit function has failed with the GSK_ERROR_BAD_MESSAGE.

System action:

Processing stopped

User response:

Make sure you have configured the key database for SSL communication as
described in the documentation. Possible issues could be during the
SSL/TLS handshake, the client could not agree on a supported SSL/TLS
protocol version to use with server If the problem persists, contact IBM
Spectrum Protect customer support.

------------------------------------------------------------------------
ANS2032I

The client VM restore is skipping the unsupported Independent disk :
vmdk



Explanation:

The VMware vStorage APIs do not support snapshoting Independent disks,
no backups were created.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2033W

'symboliclink name': is a symbolic link to a file or directory in a
different file system.



Explanation:

The dsmls file specs operand or the used file list contains a symbolic
link to a file or directory in another file system. Processing may lead
to incorrect status of the object the symbolic link refers to.

System action:

Status of objects are displayed.

User response:

To display the correct status of objects use dsmls with the full
qualifying path to the objects.

------------------------------------------------------------------------
ANS2036W

Pruning functions cannot open one of the IBM Spectrum Protect prune
files: log-name. errno = errno-value,



Explanation:

The file "log-name could not be opened during pruning. The system set
the error code errno-value. If the reason given is "access denied," the
current user does not have permission to write to the file in the
directory specified. It is also possible that no space is available at
the given file location or another IBM Spectrum Protect process started
by different user id is performing pruning at the same time.

System action:

Pruning stops, processing continues.

User response:

Set the DSM_LOG (or DSMI_LOG) environment variable to a directory into
which the current user can write.

------------------------------------------------------------------------
ANS2037W

Schedule log pruning failed.



Explanation:

The schedule log pruning function completed with errors.

System action:

Processing continues.

User response:

Check error log for possible reasons of failure.

------------------------------------------------------------------------
ANS2038W

Invalid option 'option-name' received from the IBM Spectrum Protect
server client options set.



Explanation:

The client received an invalid option from the IBM Spectrum Protect
server's client option set. Although most syntax checking for client
option set options is done by the server, there are still errors that
can only be detected by the client. These errors include:

*  Option value is not correct.

*  Options that have been retired by newer versions of the IBM Spectrum
   Protect client.

*  Missing brackets or directory delimiters.

*  Include and exclude patterns that are too complex.

System action:

The option is ignored by the IBM Spectrum Protect client.

User response:

Contact the IBM Spectrum Protect server administrator to determine if
the option can be removed from the client option set.

------------------------------------------------------------------------
ANS2039E

Invalid destination file specification 'file-name' entered



Explanation:

The destination file specification must end with directory delimiter
when performing a file list restore, or when the restore specification
is for more than one file, or when the option SUBDIR YES is in effect.

System action:

Processing stopped.

User response:

Specify a destination that ends with directory delimiter.

------------------------------------------------------------------------
ANS2040E

While attempting to communicate with the remote client, a version check
reveals that the versions do not match. The version is remoteversion but
the expected version is localversion.



Explanation:

During initialization between the local client and the remote client,
version checking reveals that the versions do not match. This is usually
the result of an upgrade of one client module without upgrading other
client modules that are part of product solution.

System action:

The calling procedure returns and control is passed back the user.

User response:

Check the versions of all IBM Spectrum Protect Client products that
communicate with each other and ensure that they are all at the same
version, release, and level.

------------------------------------------------------------------------
ANS2041E

Snapshot Differencing support is not available on the specified NetApp
filer.



Explanation:

Incremental by snapshot difference backup cannot be performed because
required support on the specified NetApp filer is not availble. .

System action:

Processing terminates.

User response:

None.

------------------------------------------------------------------------
ANS2042W

'symboliclink':is a symbolic link to a file or directory in another
filesytem. ACLs or extended attributes might not be backed up.



Explanation:

The backup or archive operand contains a symbolic link to a file or
directory in another file system. Processing may lead to loss of ACLs or
other extended attributes because they might not be processed.

System action:

The file data is backed up. Processing continues with the next object.

User response:

If you need to ensure that ACLs and other extended attributes are backed
up successfully, do not use symbolic links to back up files on other
file systems of different file system types. Instead use IBM Spectrum
Protect to process the other file system directly.

------------------------------------------------------------------------
ANS2043I

The virtual machine template 'name' has already been backed up.



Explanation:

Virtual machine templates are skipped if no change has occurred since
the last backup.

System action:

Processing skips this virtual machine template.

User response:

To back up this virtual machine template, run an incremental forever
full backup operation.

------------------------------------------------------------------------
ANS2044E

The template virtual machine 'name' cannot be restored when the IBM
Spectrum Protect data mover node on the vStorage Backup Server is
connected directly to an ESX/ESXi host.



Explanation:

The VMware vStorage API do not support template virtaul machine
operations when connected directly to an ESX/ESXi host.

System action:

Processing stops for this template virtual machine

User response:

Virtual machine template operations are supported when the IBM Spectrum
Protect data mover node connects directly to a ESX/ESXi host. Modify the
VMCHOST to connect the IBM Spectrum Protect data mover to a vCenter
Server.

------------------------------------------------------------------------
ANS2045E

The VMENABLETEMPLATEBACKUPS option is not specified. The virtual machine
template 'name' can not be backed up.



Explanation:

The VMENABLETEMPLATEBACKUPS template option must specify YES in order
for a virtual machine template to be included in a backup operation. The
default value is NO.

System action:

Processing stops for this template virtual machine

User response:

Use the option -vmenabletemplatebackups=yes and run the operation again.

------------------------------------------------------------------------
ANS2046S

Error 'errtxt' (errno=errno) occurred trying to write to audit log
'file-name'. The audit log function is disabled.



Explanation:

There was an error encountered writing to the audit log (for example,
there is not enough space on the disk).

System action:

Audit logging is disabled for the rest of the operation. The return code
for the operation is set to 12 to indicate that the contents of the
audit log are incomplete.

User response:

If this is an out of space condition either free up space on the volume
or try to write the audit log to a volume with more space.

------------------------------------------------------------------------
ANS2047E

An unexpected error was encountered processing a system state/services
request. IBM Spectrum Protect function name : function-name IBM Spectrum
Protect function : function-desc IBM Spectrum Protect return code :
TSM-rc IBM Spectrum Protect explanation : TSM-msg IBM Spectrum Protect
file : file-name (line-number)



Explanation:

None.

System action:

Processing the system state stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS2048W

Named stream of object 'object-name path-name file-name' is corrupt.



Explanation:

One or more of the file's named streams are corrupt.

System action:

The named stream is not restored/retrieved.

User response:

The backup copy of the named stream is damaged. The file is restored to
as great an extent as possible, but the file should be examined to
verify that it is usable.

------------------------------------------------------------------------
ANS2049W

Named stream of object 'object-name' may be corrupt.



Explanation:

One or more of the file's named streams may be corrupt.

System action:

The named stream is restored/retrieved to as great an extent as
possible.

User response:

The backup copy of the named stream may be damaged. The file is restored
to as great an extent as possible, but the file should be examined to
verify that it is usable.

------------------------------------------------------------------------
ANS2050E

IBM Spectrum Protect needs to prompt for the password but cannot prompt
because the process is running in the background.



Explanation:

If PASSWORDACCESS=PROMPT or if the password that is stored locally is
incorrect, IBM Spectrum Protect attempts to prompt the user for the
password. The attempt to prompt the user fails because the process is
running in the background. When a process is running in the background,
prompting is not allowed.

System action:

Processing stopped.

User response:

If RUNASSERVICE=YES, do not set PASSWORDACCESS=PROMPT. Use
PASSWORDACCESS=GENERATE.

------------------------------------------------------------------------
ANS2051W

The local snapshot repository was not found on location.



Explanation:

The specified directory for the local snapshot location does not exist.

System action:

Processing continues.

User response:

A new local snapshot repository will be build in the specified
directory.

------------------------------------------------------------------------
ANS2052E

Information about the disk subsystem is missing.



Explanation:

The local snapshot repository could not be initialized due to missing
information about the disk subsystem.

System action:

Processing stops.

User response:

The application ensures that the disk subsystem is initialized properly.
Check for preceding error messages.

------------------------------------------------------------------------
ANS2053E

A memory allocation error has occurred in file filename, line number
linenumber.



Explanation:

Enough memory was not available to continue processing.

System action:

Processing ends.

User response:

Ensure that your system has sufficient real and virtual memory. Close
unnecessary applications.

------------------------------------------------------------------------
ANS2054E

Operating system error errno: messagetext.



Explanation:

The application encountered an unexpected message error during the
execution of a system function. The respective operating system error
and message text will be displayed.

System action:

Processing stops.

User response:

Check the specific error message.

------------------------------------------------------------------------
ANS2055I

The local snapshot manager could not be locked.



Explanation:

The local repository is locked by another application. This process will
proceed when the other application unlock the local repository.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2056I

Waiting maximal timeout seconds until the lock is released by the other
application.



Explanation:

While the local repository is locked by another application, the program
will wait a specific period of time to proceed. For example, in the
mySAP environment, the wait period is 1 hour.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2057E

Local snapshot manager not initialized.



Explanation:

The local snapshot repository was used without previous initialization.

System action:

Processing ends.

User response:

The system normally ensures that the local repository is initialized.
Check for preceding error messages.

------------------------------------------------------------------------
ANS2058E

The data container with ID dcID could not be updated in the local
repository.



Explanation:

During a FlashCopy backup the target set record in the local repository
is updated with the correspondent properties. A failure occurred during
that process.

System action:

Processing ends.

User response:

Check for preceding error messages like memory allocation error or other
system error.

------------------------------------------------------------------------
ANS2059E

Cannot find a target data container that match with the source data
container.



Explanation:

During a snapshot type backup or hardware function, the process tries to
find a target data container that match to the source data container to
satisfy the operation. A matching target data container could not be
found.

System action:

Processing ends.

User response:

See the rules for select one of multiple target data containers. For
example, this message will be displayed if the user is trying to start a
FlashCopy backup of type 'INCR' and all the target sets are being used
for the FlashCopy type 'COPY'. Make sure also that the target volumes
are available to the backup system and the syntax is correct for the
following setup file parameters: 1. shark_target_volume 2.
shark_copy_service_code 3. java_home_directory 4.
primary_copyservices_servername 5. shark_username 6. shark_password

------------------------------------------------------------------------
ANS2060W

Cannot find a volume in the target data container dcID to match with the
source srcvol.



Explanation:

This warning message indicates that for the specific source not any
target volume could be found in this target data container that matches
for a FlashCopy operation. If multiple target data containers are being
used, the processing will continue checking the volumes of the next
target data container.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2061W

The target data container with ID dcid was not found in the local
repository.



Explanation:

An inquire of the data container with the specified ID could not be
satisfied because that target set does not exists in the local
repository.

System action:

Processing may continue.

User response:

The application that is requesting the inquire will decide whether or
not the error should end the program. Check for following messages.

------------------------------------------------------------------------
ANS2062W

Could not find a target data container in the state state to fulfill the
requested criteria.



Explanation:

A data container in the specified state was not found in the local
repository to satisfy specific criteria requested by the application.

System action:

Processing may continue.

User response:

Which criteria have been passed is application specific. Check for
following messages. The application will decide whether or not that
warning should end the program.

------------------------------------------------------------------------
ANS2063W

The local snapshot repository already exists on the directory location.



Explanation:

An application tried to create the local repository in a directory that
already exists.

System action:

Processing may continue.

User response:

The application will decide whether or not that warning should end the
program. Check for following messages.

------------------------------------------------------------------------
ANS2064I

The local snapshot repository will be created on the directory location.



Explanation:

The local snapshot repository containing information about the state of
the data containers is being created.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2065I

The local snapshot repository could not be created on the directory
location.



Explanation:

A failure occurred creating the local snapshot repository.

System action:

Processing ends.

User response:

Look for a operating system error message.

------------------------------------------------------------------------
ANS2066E

Cannot read the .fct file filename.



Explanation:

The .fct file containing the target data containers was not found or is
not accessible.

System action:

Processing ends.

User response:

Check the name, the path and the right of the file.

------------------------------------------------------------------------
ANS2067E

The exception CLsmException was thrown. Reason: txt.



Explanation:

An unexpected error occurred processing a function of the local snapshot
repository.

System action:

Processing ends.

User response:

Check the specific reason.

------------------------------------------------------------------------
ANS2068E

No target LUNs were found for the data container dcID in the .fct file
filename.



Explanation:

The program will search in the .fct file for each specific data
container a list of entries with the label <PREFIX>TARGET_VOLUME where
the prefix depends on the hardware type. Either you have a wrong label
for the target volumes of the specified data container or this data
container in the .fct file does not have any target LUNs.

System action:

Processing ends.

User response:

This error can only occurred if the application does not have a GUI
where the user provides the input of the target data containers and the
format will automatically be checked. If so, please check the format of
the .fct file.

------------------------------------------------------------------------
ANS2069E

Cannot read the file filename of the local snapshot repository.



Explanation:

The system keeps some information about the state of the data containers
locally in a file. This file was not found or is not accessible.

System action:

Processing ends.

User response:

Check the name, the path and the right of the file.

------------------------------------------------------------------------
ANS2070E

The repository state file filename is empty or has a wrong format.



Explanation:

The system keeps some information about the state of the data containers
locally in a file. This file was found but the expected format of the
data in not correct.

System action:

Processing ends.

User response:

Normally the system ensures that the format of this file is correct.
Check for preceding error.

------------------------------------------------------------------------
ANS2071E

The data container dcID could not be inserted in the local snapshot
repository.



Explanation:

The system keeps some information about the state of the data containers
locally in a file. Inserting an entry for a new data container occurred
an error.

System action:

Processing ends.

User response:

This is an unexpected error. Check for preceding error. If not any other
error can be seen, collect the logs and traces and contact the support.

------------------------------------------------------------------------
ANS2072E

An unexpected error was encountered processing a IBM Spectrum Protect
operation using a hardware or snapshot function. IBM Spectrum Protect
function name : function-name IBM Spectrum Protect function :
function-desc IBM Spectrum Protect return code : TSM-rc IBM Spectrum
Protect file : file-name (line-number)



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS2073E

The file filename of the local snapshot repository could not be opened
for writing.



Explanation:

The system keeps some information about the state of the data containers
in the local snapshot repository. Opening a file of this repository
occurred an error.

System action:

Processing ends.

User response:

Check the rights permission of that file.

------------------------------------------------------------------------
ANS2074E

Cannot open user input FlashCopy target file 'fct_file'.



Explanation:

The FlashCopy target file that the user provided cannot be read.

System action:

The operation fails.

User response:

Run the client configuration utility and provide a valid FlashCopy
target user input file.

------------------------------------------------------------------------
ANS2075E

There is no VTOC data available for the volume. The volume cannot be
backed up.



Explanation:

The volume disk label type is not VTOC. It is possible that your disk is
formatted with an EFI label. The IBM Spectrum Protect client on Solaris
currently supports only VTOC disk labels.

System action:

The volume is not backed up.

User response:

Do not attempt to backup volumes formatted with a non-VTOC disk label.

------------------------------------------------------------------------
ANS2076E

program-name: Space Managment can not be added for file system
'filesystem' The length of the file system name exceeds the maximum
length of 'maxlength' which can be stored in a DMAPI attribute.



Explanation:

The DMAPI has a limitation in the size of data that can be stored in a
DMAPI attribute. If the lenght of the file system name exceeds this
limit the IBM Spectrum Protect client can not add space management to
the file system.

System action:

Space management cannot be added to file system.

User response:

Please make sure that the length of the file system name does not exceed
the DMAPI limit.

------------------------------------------------------------------------
ANS2077E

program-name: Reconcile for file system 'filesystem' can not be started
for the selected mode in a non-scout environment. Please use Two Way
Orphan Check Reconcile instead.



Explanation:

The IBM Spectrum Protect client reconciliation program can not be
started in orphan check or stub restore mode when the HSM system is
configured to run without the scout daemon.

System action:

Reconcile can not run in a non scout environment.

User response:

If you have configured a non scout environment you need to use the Two
Way Orphan Check Reconcile.

------------------------------------------------------------------------
ANS2078E

System state backup is not allowed CLUSTERNODE is set to YES.



Explanation:

When the CLUSTERNODE option is set to YES, the backup systemstate
command is not valid.

System action:

System state backup is stopped.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the
backup-archive client manual for further information about configuring
the client to run in a cluster environment.

------------------------------------------------------------------------
ANS2079E

Error processing 'filespace namepath-namefile-name': error scanning
snapshot



Explanation:

This message is issued when the IBM Spectrum Protect client is unable to
read data from a snapshot used for the backup. If you are performing the
Microsoft Volume Shadowcopy Service (VSS) snapshot backup one possible
cause is that the operating system deleted a VSS snapshot because the
shadow copy storage could not grow. If you are performing the snapshot
difference incremental backup on normal NetApp/N-Series volumes one
possible cause is that the base snapshot was accidentally removed from
the NetApp file server.

System action:

Backup processing for the file system stops.

User response:

If you were performing VSS snapshot-based backup, examine the client
error log and the Microsoft Windows system event log for any other
messages that might help identify the problem. If there are no obvious
reasons for the failure, try the operation again,the problem might be
caused by temporary I/O conflicts between VSS and other system disk I/O
activities. If you were performing snapshot difference incremental
backup, contact your IBM Spectrum Protect administrator to verify that
base snapshot was not accidentally deleted.

------------------------------------------------------------------------
ANS2080W

The value 'option' for the option 'option' is no longer supported and
will be ignored by IBM Spectrum Protect client in this release.



Explanation:

The specified option value is in the process of being made obsolete and
will be ignored by the client in this release. This option value will be
removed in the next release and will no longer be valid.

System action:

Processing continues.

User response:

Update the option value or remove the option from the option file. Also
check the documentation to see if this option has been replaced by a
newer option.

------------------------------------------------------------------------
ANS2083W

No vApps that match the input specification were found.



Explanation:

A vApp that matches the specified input or the VAPP value in the
DOMAIN.VCD option was not found.

System action:

The operation is stopped

User response:

Make sure the the VAPP value in the DOMAIN.VCD option is correct.

------------------------------------------------------------------------
ANS2084I

Creating a new vApp



Explanation:

The estore is attempting to create the destination vApp.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS2085E

The virtual machine is configured as a fault tolerant virtual machine.
As a result, it cannot be backed up.



Explanation:

vSphere does not allow for the snapshot or backup of fault tolerant
virtual machines with vStorage API for Data Protection.

System action:

The virtual machine is not backed up.

User response:

To back up a fault tolerant virtual machine with vStorage API for Data
Protection, first disable fault tolerant. Then, after the backup
completes, enable fault tolerant.

------------------------------------------------------------------------
ANS2088E

Session rejected: The client does not use unicode.



Explanation:

The server cannot accept the client session because the client does not
use unicode and the node already contains a unicode filespace. The
server records whether or not the client's data is unicode, and does not
let the node change this attribute.

System action:

Processing stops.

User response:

Logon to the server from a client with a platform that uses unicode
data. For example, the original platform that was used to create the
existing filespaces for this node. Alternatively, if the client node
needs to change to the platform that is currently being attempted,
contact the server administrator to remove the existing filespaces that
contain unicode data and try the node connection again.

------------------------------------------------------------------------
ANS2089E

The string string_text can not be converted to Unicode.



Explanation:

An object contains a multibyte sequence that is invalid for the current
locale.

System action:

The operation stops.

User response:

Verify that the locale is appropriate for the objects that are
processed.

------------------------------------------------------------------------
ANS2090I

The virtual machine folder could not be found in this path: 'name'.



Explanation:

The destination target does not have the original inventory path that
was saved with the virtual machine. As a result, the virtual machine is
restored to the top level of the ESX/ESXi inventory.

System action:

Processing continues

User response:

None

------------------------------------------------------------------------
ANS2091I

The virtual machine resource could not be found in this path: 'name'.



Explanation:

The destination target does not have the original resource path that was
saved with the virtual machine. As a result, the virtual machine is
restored to the top level of the ESX/ESXi inventory.

System action:

Processing continues

User response:

None

------------------------------------------------------------------------
ANS2092I

The restore process will override the original inventory path that was
saved with this virtual machine.



Explanation:

Specifying the -datacenter or -host option will override the original
inventory path that was saved with the virtual machine. As a result, the
virtual machine is restored to the top level of the ESX/ESXi inventory.

System action:

Processing continues

User response:

None

------------------------------------------------------------------------
ANS2093E

The remote file system agent is downlevel and does not support this
operation. NODENAME : node MULTI-NODE NAME : multi-node hostname : host
TCP/IP address : tcpaddr:tcpport version : version.release.level..mod



Explanation:

None.

System action:

The operation fails.

User response:

Upgrade the remote file system agent to a supported level.

------------------------------------------------------------------------
ANS2097E

Unable to establish a session with the IBM Spectrum Protect server as
target node 'target' using agent node 'agent'.



Explanation:

None.

System action:

Processing ends.

User response:

Ensure that the multi-node name exists on the server and that the agent
node has the proper authority to target node listed.

------------------------------------------------------------------------
ANS2100E

Backup of virtual machine 'virtual-machine-name' cannot continue because
an invalid disk area was encountered during backup.



Explanation:

During a backup of the virtual machine, one or more virtual hard disks
indicated an invalid disk area for backup such as a length of zero, a
length greater than the size of the disk, invalid starting position, or
negative values.

System action:

The backup was stopped.

User response:

Check that the virtual machine's storage is configured properly, working
correctly, and all storage hardware is properly connected to the virtual
machine. Try the command again. If the problem persists contact IBM
Spectrum Protect customer support.

------------------------------------------------------------------------
ANS2101E

Compressed data grew.



Explanation:

The size of data is growing after compression

System action:

Processing continues.

User response:

The application must abort the transaction.

Please turn off compression and try to resend the object.

------------------------------------------------------------------------
ANS2102E

File list processing not started



Explanation:

An error occured before the file list processing was started.

System action:

Processing stops.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Try to follow the suggested corrective
actions (if any) and try the operation again.

------------------------------------------------------------------------
ANS2104E

An error occured after processing the file list.



Explanation:

An error occured after the file list processing completed.

System action:

Processing stops.

User response:

Examine the client error log for additional messages that might indicate
the reason for the problem. Try to follow the suggested corrective
actions (if any) and try the operation again.

------------------------------------------------------------------------
ANS2105I

File list entry not Processed: File List Entry



Explanation:

A file list operation encounted an error. This entry from the file list
was not processed.

System action:

This message is for auditing purposes only.

User response:

This message is for auditing purposes only.

------------------------------------------------------------------------
ANS2106I

Connection to primary IBM Spectrum Protect server primary server; failed



Explanation:

A communication error occured while attempting to connect to the primary
server. The node is configured for replication and will attempt to
connect to the failover server.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect server administrator to verify if the
primary server is available. If the primary server is available, check
the error log for communications failures and correct any configuration
issues. If the IBM Spectrum Protect server is not available, allow the
node to fail over to the failover server as configured by the primary
IBM Spectrum Protect server administrator.

------------------------------------------------------------------------
ANS2107I

Attempting to connect to failover server failover server; at failover
server; : TCP/IP Port;



Explanation:

The node is configured for replication and will attempt to connect to
the failover server. The failover server address and port are configured
by the primary IBM Spectrum Protect server administrator and are saved
in the options file.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect server administrator to verify if the
primary server is available. If the primary server is available, check
the IBM Spectrum Protect error log for communications failures and
correct any configuration issues. If the IBM Spectrum Protect server is
not available, allow the node to fail over to the failover server as
configured by the primary IBM Spectrum Protect server administrator.

------------------------------------------------------------------------
ANS2108I

Connected to failover server failover server;.



Explanation:

The node is configured for replication and has successfully connected to
the failover server.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2110I

Connection to failover server IBM Spectrum Protect failover server;
failed



Explanation:

A communications error occured while attempting to connect to the
failover server. The node is configured for replication and an attempt
to connect to the failover server was made but failed.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect server administrator to verify if the
failover server is available. If the failover server is available, check
the error log for communications failures and correct any configuration
issues.

------------------------------------------------------------------------
ANS2111E

The REPLSERVERNAME entry for the specified MYREPLICATIONSERVER option
was not found.



Explanation:

The MYREPLICATIONSERVER option must have a matching REPLSERVERNAME entry
in the options file. The REPLSERVERGUID, REPLTCPPORT, and
REPLTCPSERVERADDRESS must also be specified. These options are normally
set by the IBM Spectrum Protect server administrator and saved to the
options file during logon to the primary server.

System action:

Processing stops.

User response:

Manually edit the options file to either correct or remove the options.

------------------------------------------------------------------------
ANS2112I

failover server is configured as 'read-only'. Backup and Archive
operations are not supported when the failover server is in 'read-only'
mode



Explanation:

The IBM Spectrum Protect client has established a session with a server
that is configured as 'read-only'. The IBM Spectrum Protect server is
configured as a replication server and will not accept data from this
node.

System action:

Processing continues.

User response:

The IBM Spectrum Protect may be used for Restore, Retrieve and Query
operations. Backup and Archive commands will fail. The IBM Spectrum
Protect server administrator can enable Backup and Archive operations
for the node with the 'Update Node' command.

------------------------------------------------------------------------
ANS2113E

The command is not enabled when connected to the failover server in
failover mode.



Explanation:

The IBM Spectrum Protect client has failed over and established a
session with a failover server. The IBM Spectrum Protect server is
configured as a replication server and will not accept data from this
node. Commands that store data on the server are disabled.

System action:

Processing continues.

User response:

You can use the IBM Spectrum Protect client for Restore, Retrieve, and
Query operations. Backup and Archive operations will fail.

------------------------------------------------------------------------
ANS2114W

IBM Spectrum Protect application protection did not copy the VSS
Manifest files from VM 'VM'.



Explanation:

The VSS Manifest files are not found on the guest machine.

System action:

The VSS Manifest files cannot be copied. Verify that the VSS and SQL
Writer services are running on the guest VM

User response:

None

------------------------------------------------------------------------
ANS2115I

Replication server connection information saved: connection information;



Explanation:

This node is configured for replication. The replication server
connection information has been saved to the options file. The
replication server options are set by the IBM Spectrum Protect
Administator, sent to the client during logon, and are saved to the
options file.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2116W

IBM Spectrum Protect application protection did not back up the VSS
Manifest files from VM 'VM'.



Explanation:

A failure occurred while backing up the files that are necessary for
application protection.

System action:

The back up of this VM failed.

User response:

Check the dsmerror.log for additional information. Then try the
operation again.

------------------------------------------------------------------------
ANS2117E

Source volume is of subtype dev-type and destination is of subtype
dev-type. Destination must be larger than source.



Explanation:

Logical volumes from scalable volume groups (subtype DS_LVZ) do not
contain an LVCB. That is, the very first block contains user data. AIX
LVM volumes from original volume groups (subtype LVM) contain a Logical
Volume Control Block (LVCB) on the first block (512 bytes) of the
volume. When restoring to a volume of subtype LVM, the first block must
be skipped in order to preserve the existing LVCB of the destination
volume. That is, the restore operation begins writing at the second
block of the volume. This means that given two volumes of identical
size, one of subtype DS_LVZ and the other is of subtype LVM, the latter
has one less 512-byte block in which to store user data. Thus when you
restore a volume of subtype DS_LVZ to a volume of subtype LVM, it is not
sufficient for the destination volume to be the same size as the source
volume. Instead, the destination volume must be at least one 512-block
larger than the source volume.

System action:

The restore operation is not performed.

User response:

Make sure that both source and destination logical volumes are of the
same type, or choose a larger destination volume, or increase the size
of the destination volume.

------------------------------------------------------------------------
ANS2118I

A write failure occurred while attempting to save node replication
failover values to the options file.



Explanation:

A write failure is often a result of insufficient access permissions to
the options file, but could also be caused by the lack of available disk
space. The replication server connection information can not be saved
and failover will not be possible.

System action:

The operation failed.

User response:

Check the local disk for possible causes of the write error, and check
to see that sufficient access to the options file is configured.

------------------------------------------------------------------------
ANS2119I

An invalid replication server address return code rc value = rc-value
was received from the server.



Explanation:

An invalid replication server address return code indicates that the
server was not able to aquire connection information.

System action:

Possible server problem.

User response:

Check the server log for more information.

------------------------------------------------------------------------
ANS2120W

The last store operation date reported by the server replication server;
of server commit date; UTC does not match the last store operation date
of client commit date; UTC stored by the client for the filespace
filespace;.



Explanation:

The last store operation date reported on the server does not match the
date stored locally on the client. If connected to the replication
server it is likely that the replication was done before the last store
operation from the client to the primary server. Hence, the replication
is out of date. If connected to the primary server it is likely that the
previous backup was done from another machine.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect server administrator. Restoring from an
out of date replica may lead to loss of data. If the primary server
cannot be recovered, a full backup to the replica may be appropriate. If
connected to the primary server, the message can be ignored.

------------------------------------------------------------------------
ANS2122E

The name of virtual machine 'VM-name' ends with a period. The
backup/restore of such machines is not supported.



Explanation:

The specified virtual machine ends with a period character that are not
supported for virtual machine backup and restore operations.

System action:

The backup for the specified virtual machine fails.

User response:

Rename the virtual machine so that it does not ends with period.

------------------------------------------------------------------------
ANS2123W

Issue the dsmc SET PASSWORD -type=VCD 'vCloud Director hostname'
'userid' 'password' command to save an encrypted password.



Explanation:

The VCDPW option was found either in an options file or as a command-
line entry. Although both methods of entry are allowed, they present a
security risk because the password is in plain text and is not
encrypted.

System action:

The option is accepted and the VCD password is used in the current
session.

User response:

To save an encrypted password, issue the following command: dsmc SET
PASSWORD -type=VCD 'VirtualCenter hostname' 'userid' 'password'

------------------------------------------------------------------------
ANS2124W

Client node replication table is locked by another process.



Explanation:

Another process is using the client node replication table. Only one
process may use it at a time.

System action:

This process does not use the client node replication table.

User response:

You can serialize processes using the client node replication table. Or
you can reconfigure the current process to use a different table path to
avoid contention.

------------------------------------------------------------------------
ANS2126E

The Organization VDC node that contains snapshots of Organization VDC
'org vdc name' of organization 'org name' was not found.



Explanation:

The Organization VDC node contains the backup data to be restored. The
specified organization and organization VDC are not mapped to this
Organization VDC node. As a result, the restore operation cannot
proceed.

System action:

The operation stops.

User response:

Verify that the specified organization, organization VDC, and vApp are
correct.

------------------------------------------------------------------------
ANS2127E

The snapshot data that is required to restore 'vapp name' cannot be
retrieved from the IBM Spectrum Protect Server.



Explanation:

The required snapshot data was unable to be retrieved from the IBM
Spectrum Protect Server.

System action:

The operation stopped.

User response:

Check the dsmerror.log file for information about why the data was not
retrieved. Then, try the operation again. If the problem persists, visit
the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2128E

Failed in creating a restored version of vApp 'vapp name'.



Explanation:

The operation to create a restored vApp on the vCloud failed. The data
associated with the vApp snapshot might not be complete.

System action:

The operation stops.

User response:

Check the dsmerror.log file for information about why the operation
failed. Then, try the operation again. If the problem persists, visit
the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2129E

A VM you tried to rename 'rename' did not appear in the list of VMs to
restore 'list'.



Explanation:

The VMNAME option for parallel restores requires pairing the name and
rename fields together. You cannot rename a VM which you are not
attempting to restore.

System action:

The operation will not begin.

User response:

Verify the syntax of the command and spelling of the VMs you are trying
to restore.

------------------------------------------------------------------------
ANS2135E

The node on the IBM Spectrum Protect server is in read only mode.



Explanation:

The server has prevented a store operation on the IBM Spectrum Protect
server. The most likely explaination for this is the node has failed
over to the failover server.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect server administrator to verify if the
primary server is available. If the primary server is available, check
the error log for communications failures and correct any configuration
issues.

------------------------------------------------------------------------
ANS2136E

Operation not permitted. The failover server reports the primary server
is available. Quit and restart the IBM Spectrum Protect client and retry
the command.



Explanation:

The server has prevented a store operation on the failover IBM Spectrum
Protect server. The failover server reports that the primary server is
available. However, the IBM Spectrum Protect client failed over to the
failover server.

System action:

Processing stops.

User response:

Restart the IBM Spectrum Protect client and verify the primary server
connection is made. If the IBM Spectrum Protect client is unable to
connect to the primary server, contact the IBM Spectrum Protect server
administrator to verify if the primary server is available. If the
primary server is available, check the error log for communications
failures and correct any configuration issues.

------------------------------------------------------------------------
ANS2138E

Failed in restoring the vApp properties to vApp: 'vapp name'.



Explanation:

The vApp properties were not restored to the created vApp. This failure
might be caused by a problem in the backed up vApp or in its metadata.

System action:

The operation completes. However, it is possible that the restored
object does not contain all of the expected content.

User response:

Check the backed up vApps on the vCloud. In addition, check the
dsmerror.log file for any additional messages that might be related to
this problem. Try the operation again. If the problem persists, visit
the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2143E

vApp verification failed. Data inconsistency was found.



Explanation:

During the verification of a vApp, an inconsistency was found in the
backup data.

System action:

The restore operation was stopped.

User response:

Examine the client error log for any additional messages that might be
related to this problem and contact IBM Spectrum Protect technical
support for further assistance.

------------------------------------------------------------------------
ANS2145W

Warning - updating an existing virtual machine named 'name'. The restore
operation continues.



Explanation:

The virtual machine exists and will be updated with the disks specified.

System action:

The virtual machine will be updated by the restore operation.

User response:

No user action is necessary.

------------------------------------------------------------------------
ANS2146E

The target vCenter or ESX/ESXi host is no longer supported, for virtual
machine backups, by this version of IBM Spectrum Protect.



Explanation:

The target vCenter or ESX/ESXi host is no longer supported, for virtual
machine backups, by this version of IBM Spectrum Protect.

System action:

Processing stops for this virtual machine.

User response:

Specify another target vCenter or ESX/ESXi host that is supported by
this version of IBM Spectrum Protect.

------------------------------------------------------------------------
ANS2147E

The virtual machine named 'name' already exists on the target system.



Explanation:

The virtual machine cannot be restored because the name already exists
on the target system.

System action:

Processing stops for this virtual machine

User response:

Use the -vmname option to rename the virtual machine.

------------------------------------------------------------------------
ANS2148I

Virtual machine templates cannot be backed up in incremental mode,
switching to full mode.



Explanation:

The backup of virtual machine templates are only supported as full
backups.

System action:

Processing continues in full mode for this template virtual machine.

User response:

To back up this virtual machine template use full mode.

------------------------------------------------------------------------
ANS2149E

The restore operation for this virtual machine to the target ESX/ESXi
host is not supported because virtual machine hardware version is
incompatible.



Explanation:

The target ESX/ESXi host does not support the virtual hardware version
of the virtual machine. As a result, a restore of the specified virtual
machine to this host is not supported.

System action:

Processing stops for this virtual machine.

User response:

Specify another virtual machine to restore or specify another target
ESX/ESXi host that supports virtual hardware version of the virtual
machine.

------------------------------------------------------------------------
ANS2150E

Set HSMDISABLEAUTOMIGDAEMONS YES in the dsm.opt file to use HSM
multi-server functionality.



Explanation:

Set HSMDISABLEAUTOMIGDAEMONS YES in the dsm.opt file to use HSM
multi-server functionality.

System action:

HSM multi-server processing stops.

User response:

Set HSMDISABLEAUTOMIGDAEMONS YES in dsm.opt.

------------------------------------------------------------------------
ANS2155W

Skipping file 'file-name'. File related to 'server-name'.



Explanation:

File is already coupled to another server.

System action:

HSM continues with normal operation.

User response:

Use the correct server to process the file.

------------------------------------------------------------------------
ANS2156E

The server 'server-name' was not added to the environment.



Explanation:

The requested IBM Spectrum Protect server was not added to the
multi-server environment. There are several causes for this error:

*  The file system is not managed by HSM.

*  The HSM management is not active for the file system.

*  The file system is out of space.

*  The default IBM Spectrum Protect server for the file system was not
   yet added to the multi-server environment.

*  The IBM Spectrum Protect server name is not valid.

System action:

HSM multi-server processing stops.

User response:

Eliminate the possible causes for this issue and retry.

------------------------------------------------------------------------
ANS2157E

The server 'server-name' was not removed from the environment.



Explanation:

The requested IBM Spectrum Protect server was not added to the
multi-server environment. There are several causes for this error:

*  The file system is not managed by HSM.

*  The HSM management is not active for the file system.

*  The IBM Spectrum Protect server is the default server for the file
   system and must be removed last.

*  The IBM Spectrum Protect server name is not valid.

System action:

HSM multi-server processing stops.

User response:

Eliminate the possible causes for this issue and retry.

------------------------------------------------------------------------
ANS2158E

The server 'server-name' was not added to the environment. You must
first add the default IBM Spectrum Protect server
('default-server-name') for this file system.



Explanation:

The requested IBM Spectrum Protect server was not added to the
multi-server environment. The requested IBM Spectrum Protect server is
not the default server for the file system.

System action:

HSM multi-server processing stops.

User response:

Add the default IBM Spectrum Protect server first.

------------------------------------------------------------------------
ANS2159I

The server 'server-name' was added to the environment.



Explanation:

The requested IBM Spectrum Protect server was added to the multi-server
environment.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2160I

The server 'server-name' was removed from the environment.



Explanation:

The requested IBM Spectrum Protect server was removed from the
multi-server environment.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2161E

The server 'server-name' is not a valid IBM Spectrum Protect server for
this environment.



Explanation:

The requested IBM Spectrum Protect server was not added to the
multi-server environment.

System action:

HSM multi-server processing stops.

User response:

Check the dsm.sys file for the correct IBM Spectrum Protect server name.

------------------------------------------------------------------------
ANS2162E

HSM cannot be removed from the file system. The IBM Spectrum Protect
multi-server list is not empty.



Explanation:

HSM management was not removed from the file system.

System action:

HSM processing continues.

User response:

Remove all IBM Spectrum Protect servers from the multi-server list
before removing HSM.

------------------------------------------------------------------------
ANS2163E

The default IBM Spectrum Protect server ('server-name') for the file
system will be removed.



Explanation:

The default IBM Spectrum Protect server will be removed. The IBM
Spectrum Protect server list for multi-server will be empty after this
step.

System action:

HSM processing continues without multi-server support.

User response:

nothing.

------------------------------------------------------------------------
ANS2165I

The server 'server-name' is the default server and has been removed
last.



Explanation:

The requested IBM Spectrum Protect server was removed from the
multi-server environment.

System action:

HSM multi-server processing continues.

User response:

None

------------------------------------------------------------------------
ANS2166I

The IBM Spectrum Protect server 'server-name' is not included in the
multi-server environment.



Explanation:

The requested IBM Spectrum Protect server is not part of the
multi-server environment.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2167W

Can not read SERVERNAME attribute.



Explanation:

IBM Spectrum Protect cannot read the SERVERNAME attribute from file.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2168W

Can not write SERVERNAME attribute.



Explanation:

IBM Spectrum Protect cannot write SERVERNAME attribute to file.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2169E

Skipping - Requested server is not included in multi-server environment
for filesystem 'file-system'.



Explanation:

The requested IBM Spectrum Protect server is not part of the
multi-server environment.

System action:

HSM multi-server processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2170W

Skipping - file linked to another server.



Explanation:

The file is already coupled to another IBM Spectrum Protect server.

System action:

HSM continues with normal operation.

User response:

Use the correct server to process the file.

------------------------------------------------------------------------
ANS2171E

The DMAPI version 'dmapi-version' is not supported.



Explanation:

The DMAPI version installed on this node is not supported from the given
IBM Spectrum Protect client.

System action:

Due to this issue the affected HSM process ends.

User response:

Use the documentation to identify the supported DMAPI versions. Install
a supported DMAPI and retry the HSM command or process.

------------------------------------------------------------------------
ANS2172E

Command not supported in HSMBACKENDMODE TSMFREE.



Explanation:

That command is not supported using an external HSM backend.

System action:

Exit programm

User response:

Do not use the command

------------------------------------------------------------------------
ANS2173E

Volume 'volume name' from vFiler 'vFiler name' is mounted using AIX NFS
version 4. This configuration is not supported for snapshot difference
incremental backups.



Explanation:

Snapshot difference incremental backups are not supported for vFiler
volumes mounted using AIX NFS version 4.

System action:

Snapshot difference incremental backup fails.

User response:

This problem is documented by NetApp BURT 630200. Apply the fix for this
once it is available from NetApp. Specify "testflag
snapdiffenablevfilernfs4" in dsm.opt file and retry the snapshot
difference incremental backup.

------------------------------------------------------------------------
ANS2174E

Conflicting options HSMLOGMAX and HSMLOGRETENTION were specified.



Explanation:

Values were specified for both the HSMLOGMAX and the HSMLOGRETENTION
options. These options are mutually exclusive.

System action:

Processing stops.

User response:

Specify a nonzero value for HSMLOGMAX if you wish to have the IBM
Spectrum Protect hsm log wrap when it reaches the specified maximum
value. Use HSMLOGRETENTION if you wish you have the hsm log limited in
size on a time-based schedule.

------------------------------------------------------------------------
ANS2175I

Data from server 'server-name' should be recalled using the script
'dsmMultiServerRemove.pl'.



Explanation:

Migrated files must be recalled before a server can be removed from the
multiserver configuration.

System action:

The server will not be removed.

User response:

Check the documentation for detailed information about the
'dsmMultiServerRemove.pl' script.

------------------------------------------------------------------------
ANS2176E

The sample journal configuration file '' could not be copied to ''.



Explanation:

The IBM Spectrum Protect Journal Engine setup wizard tried to create a
new journal configuration file by copying the sample configuration file.
However the sample configuration file could not be successfully copied.

System action:

The IBM Spectrum Protect Journal Engine setup wizard stops.

User response:

Manually copy the sample journal configuration file
"config\tsmjbbd.ini.smp" to "baclient\tsmjbbd.ini", then try the IBM
Spectrum Protect Journal Engine setup wizard. The "baclient" and
"config" directories can be found in the directory where you installed
the IBM Spectrum Protect Backup-Archive Client. For example, "C:\Program
Files\Tivoli\TSM\baclient" and "C:\Program Files\Tivoli\TSM\config"

------------------------------------------------------------------------
ANS2177E

The vCloud vApp named 'vapp name' already exists on the target system.



Explanation:

The restore vApp command does not support restoring a vApp with an
existing name.

System action:

The restore was not performed.

User response:

Execute the required restore command again, considering that the given
name for the restored vApp is not used.

------------------------------------------------------------------------
ANS2181I

Option primary server; saved.



Explanation:

This node is configured for replication. The primary server name option
is now saved to the options file. The replication server options are set
by the IBM Spectrum Protect Administator, sent to the client during
logon, and are saved to the options file.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2182I

Option failover server; saved.



Explanation:

This node is configured for replication. The replication server option
is now saved to the options file. The replication server options are set
by the IBM Spectrum Protect Administator, sent to the client during
logon, and are saved to the options file.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2183E

Organization 'Org name' not found in the vCloud Director.



Explanation:

The specified Organization is not recognized by the vCloud Director.

System action:

The action requested for the organization is canceled.

User response:

Verify that an organization by the specified name exists in the vCloud.
Organization names are case-sensitive.

------------------------------------------------------------------------
ANS2184E

Organization VDC 'Org vDC name' not found in organization 'Org name'.



Explanation:

The specified organization VDC is not part of the specified
organization.

System action:

The action requested for the organization VDC is canceled.

User response:

Verify that an organization VDC by the specified name exists in the
specified organization. Organization and organization VDC names are
case-sensitive.

------------------------------------------------------------------------
ANS2185E

Failed to log on to the vCloud Director on 'vCD host name' with user
name 'vCD user name': Authentication failed.



Explanation:

The vCloud credentials specified in the VCDUser and VCDPass options were
rejected by the vCloud director.

System action:

vCloud operations cannot be performed.

User response:

Update the VCDUser and VCDPass options with valid credentials for the
vCloud Director.

------------------------------------------------------------------------
ANS2187E

Failed to establish connection to the vCloud Director on 'vCD host
name'.



Explanation:

A connection cannot be established to the vCloud Director on the host
that is specified by the VCDHost and VCDPort options.

System action:

vCloud operations cannot be performed.

User response:

Verify that the values of the VCDHOst and VCDPort options are valid,
network connectivity to the host exists, and that the vCloud Director
service is running.

------------------------------------------------------------------------
ANS2188E

The vCloud protection runtime library is not installed or failed to
load.



Explanation:

The vCloud runtime library is not installed or cannot be loaded.

System action:

vCloud operations cannot be performed.

User response:

Verify that the IBM Spectrum Protect for Virtual Environments vCloud
runtime library is installed. If neccessary, reinstall IBM Spectrum
Protect for Virtual Environments.

------------------------------------------------------------------------
ANS2189E

The vCloud protection runtime library cannot be initialized.



Explanation:

The vCloud protection runtime library failed to initialize. This issue
might be caused by the Java runtime not being installed.

System action:

vCloud operations cannot be performed.

User response:

Verify that Java is installed.

------------------------------------------------------------------------
ANS2190E

The vCloud protection runtime library encountered an internal error.



Explanation:

An internal error had occured in the vCloud runtime library.

System action:

vCloud operations cannot be performed.

User response:

Check the dsmerror.log file for any additional messages that might be
related to this problem. Try the operation again. If the problem
persists, visit the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2191E

An error occurred creating the default VSS staging directory 'path'.



Explanation:

The IBM Spectrum Protect client uses an VSS staging directory to store
files related to to VSS snapshot operations. The IBM Spectrum Protect
client was unable to create this directory structure.

System action:

The IBM Spectrum Protect client stopped.

User response:

If the problem persists, contact IBM technicalsupport for further
assistance.

------------------------------------------------------------------------
ANS2192E

Failed to read the node configuration information from node 'node name'.



Explanation:

Node mapping information is required for this vCloud operation. However,
the mapping information either does not exist or cannot be read from the
specified node.

System action:

The operation is canceled.

User response:

Make sure that you are accessing the correct node. The node mapping
information is stored in the Provider VDC node. If necessary, go to the
Configuration page and click 'Run the Configuration Wizard' to make
corrections to the node mapping.

------------------------------------------------------------------------
ANS2193E

The required filespace for the vApp 'vapp name' backup does not exist.



Explanation:

No filespace exists for the specified vApp backup.

System action:

The restore was not performed.

User response:

Make sure that the specified vApp is correct. Then, try the restore
operation again.

------------------------------------------------------------------------
ANS2194E

The snapshot data is incomplete for vApp 'vapp name'.



Explanation:

Inconsistent data was found in the backed up vApp. It is not possible to
restore the specified vApp.

System action:

The restore was not performed.

User response:

Check the dsmerror.log file for any additional messages that might be
related to this problem. If the problem persists, visit the IBM Support
Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2195E

The number of VMs that are available for restore is different from
expected according to the vApp 'vapp name' metadata.



Explanation:

Inconsistent data was found in the vApp metadata. It is not possible to
restore the specified vApp. More VMs have been backed up than are now
available for restore. This may happen due to incomplete node
replication or if a file space was deleted.

System action:

The restore was not performed.

User response:

Check the dsmerror.log file for any messages that may indicate the
problem. Run a detailed query for this vApp to verify that all VMs
backups exist. If node replication is used, ensure it is working
correctly. If the problem persists, visit the IBM Support Portal for
additional information at http://www.ibm.com/support/entry/portal/.
Contact IBM Spectrum Protect administrator for more information.

------------------------------------------------------------------------
ANS2196W

An incompatible disk configuration is detected for the following disk:
'disk name'. The individual database restore for the following database
is not supported:'database name'.



Explanation:

One or more database files in this operation are located on the dynamic
or GUID Partition Table (GPT) disks. In this configuration, individual
database restore is not supported.

System action:

Backup of the full VM continues.

User response:

To restore the environment to the previous statue, issue a full VM
restore.

------------------------------------------------------------------------
ANS2197E

The verification test of vApp 'vapp name' indicates that VM data is
incomplete in the vApp. The vApp cannot be restored.



Explanation:

Inconsistent data was found in the VM for the specified vApp. It is not
possible to restore the specified vApp. This may happen due to
incomplete node replication or if a file space was deleted.

System action:

Operation continues.

User response:

Check the dsmerror.log file for any additional messages that might be
related to this problem. Run a detailed query for this vApp to verify
that all VMs backups exist. If node replication is used, ensure it is
working correctly. If the problem persists, perform a FULL new backup of
the vApp and visit the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/. Contact IBM Spectrum Protect
administrator for more information.

------------------------------------------------------------------------
ANS2198I

Backup of VMware vCloud Director vApp 'vApp name' in Organization VDC
'Org VDC name' of organization 'Org name' completed successfully. VMs:
number of VM backed up out of number of VMs in vApp VMs backed up
successfully.



Explanation:

The backup operation completed. The number of VMs backed up and the
total number of VMs in the vApp are displayed.

System action:

This message is for informational purposes only.

User response:

If the number of VMs backed up is less than the total in the vApp please
check the error logs for more information.

------------------------------------------------------------------------
ANS2200I

***** Filling Cache count files *****



Explanation:

IBM Spectrum Protect the specified number of files have been added to
the disk cache.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2201I

***** Inspecting Cache count files *****



Explanation:

IBM Spectrum Protect the specified number of files have been examined in
the disk cache.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2202E

Disk Full Error Accessing Disk Cache.



Explanation:

A disk full error occurred attempting to access or write to the
specified disk cache file during a disk cache incremental backup. See
the client error log for more detailed information.

System action:

Processing stops.

User response:

This error can be resolved by freeing up space in the file system
containing the cache file, or specifying a different location for the
cache file. Use the diskcachelocation option to specify the location of
the cache file.

------------------------------------------------------------------------
ANS2203E

Error Accessing Disk Cache.



Explanation:

An error occurred attempting to access the specified disk cache file
during a disk cache incremental backup. See the client error log for
more detailed information. IBM Spectrum Protect.

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS2204E

Disk cache restarted.



Explanation:

The length of an object name exceeded the configured disk cache key
length during a disk cache incremental backup. The backup must be
restarted.. IBM Spectrum Protect.

System action:

Backup is restarted with a larger key length to accommodate the object
name.

User response:

None required. The name of the object that caused the failure can be
found in the dsmerror.log file.

------------------------------------------------------------------------
ANS2206W

The user must have root authority to use the memory efficient backup
disk cache method. The operation will continue using memory efficient
backup method without disk caching.



Explanation:

None.

System action:

The operation continues without using disk caching.

User response:

None.

------------------------------------------------------------------------
ANS2213W

The virtual machine 'vm-name' is configured with an invalid number of
snapshot attempts specified by the tag 'tag' for category 'cat'.



Explanation:

An invalid number of snapshot attempts is specified for the quiescing or
nonquiescing snapshot attempts in the tag value. The maximum value that
you can specify is 10 for either type of snapshot attempts. The minimum
value that you can specify is 0, but both numbers cannot be 0.

System action:

The operation continues with the default number of quiescing and
nonquiescing attempts (2,0).

User response:

Change the pair of numbers in the tag so that the number of quiescing
and nonquiescing attempts is between 0-10, and that both numbers cannot
be 0.

------------------------------------------------------------------------
ANS2218I

The encryption key password for node node name and server server name
has been migrated.



Explanation:

The format of the IBM Spectrum Protect password file has recently
changed. The option MIGRATEENCRYPTKEY is set and the stored encryption
key password was automatically migrated to the new format. This message
confirms that the migration was successful.

System action:

The encryption key password has been migrated.

User response:

No response.

------------------------------------------------------------------------
ANS2219E

Cannot backup or archive files into filespace because it is owned by a
IBM Spectrum Protect API application.



Explanation:

IBM Spectrum Protect Client cannot archive or backup files into a file
space that is used a IBM Spectrum Protect API application.

System action:

Processing stops.

User response:

Use separate node names for IBM Spectrum Protect Client and IBM Spectrum
Protect API application(s).

------------------------------------------------------------------------
ANS2220E

The cluster disk could not be put in maintenance mode.



Explanation:

The system call to put the cluster disk in maintenance mode failed.

System action:

Processing stopped.

User response:

Try the operation again. If the problem continues, check the client
error log for any other messages that might have been logged when this
message was written, and take the corrective action (if any) suggested
by those messages. Examine the Windows event log which may contain
additional information. See your system administrator or IBM Spectrum
Protect administrator for further help.

------------------------------------------------------------------------
ANS2221W

Java was not able to resolve the IP address of your local machine due to
network misconfiguration problems! Please verify your network and DNS
configuration are setup correctly. Note that on UNIX machines the
hostname must be reported correctly (the same) for IPv4 and IPv6
communication methods in the /etc/hosts configuration file. IBM Spectrum
Protect processing continues.



Explanation:

Java was not able to get the local host address due to network
misconfiguration problems.

System action:

Processing continues.

User response:

Please verify your network and DNS configuration are setup correctly.
Note that on UNIX machines the hostname must be reported correctly (the
same) for IPv4 and IPv6 communication methods in the /etc/hosts
configuration file. See your system administrator or IBM Spectrum
Protect administrator for further help.

------------------------------------------------------------------------
ANS2223W

Rejected unauthenticated server-initiated session from peer name.



Explanation:

For security, the client will not accept server-initiated sessions from
servers that have authentication turned off.

System action:

The client-server session is not opened, and the schedule is not
executed. The scheduler continues to wait for contact by a server that
has authentication turned on.

User response:

If the client system is supposed to accept scheduled events from the
prompting IBM Spectrum Protect server, either ask the IBM Spectrum
Protect server administrator to turn authentication on, or do not use
server-initiated sessions. If the client system is not supposed to
accept scheduled events from the prompting server, ask the IBM Spectrum
Protect server administrator to remove the client node name from the
schedule on the prompting server.

------------------------------------------------------------------------
ANS2225W

User has specified 'SNAPSHOTROOT' option. snapshot provider snapshot
backup is not valid in conjunction with this option. "SNAPSHOTROOT
option will take precedence and processing will continue without the use
of a snapshot taken internally by IBM Spectrum Protect.



Explanation:

The (-SNAPSHOTROOT) option is incompatible with IBM Spectrum Protect
snapshot providers such as Logical Volume Snapshot Agent, VSS snapshot
provider, JFS2 snapshot provider etc. which provide a comprehensive
snapshot solution withot having to use the (-SNAPSHOTROOT) option. It is
strongly recommended that the snapshot capabilities provided by the IBM
Spectrum Protect snapshot providers be used instead of using the
(-SNAPSHOTROOT) option. Processing will continue without the use of the
IBM Spectrum Protect snapshot providers.

System action:

Processing continues without the use of the IBM Spectrum Protect
snapshot providers.

User response:

See the appropriate Using the Backup-Archive Client book for your
operating system for correct use of the named option.

------------------------------------------------------------------------
ANS2226W

The virtual machine 'vm-name' is configured with an invalid hard disk
list, specified by the tag 'tag' for category 'cat'.



Explanation:

An invalid hard disk number is specified in the disk backup list tag
value. The minimum hard disk number that you can specify is 1 and the
maximum hard disk number that you can specify is 999. Also, the hard
disk numbers must be comma separated positive integer values.

System action:

Processing stopped.

User response:

Change the hard disk list tag so that the hard disk numbers are between
1-999, and are listed as comma separated values.

------------------------------------------------------------------------
ANS2227W

Server option 'option-name' 'option-value' has not been applied on the
client due to the client option SRVOPTSETENCRYPTIONDISABLED.



Explanation:

When the client option SRVOPTSETENCRYPTIONDISABLED is set to YES on the
client it prevents the IBM Spectrum Protect administrator from setting
one of the following client options ENCRYPTIONTYPE, EXCLUDE.ENCRYPT,
INCLUDE.ENCRYPT. The client option setting ENCRYPTKEY GENERATE is also
prevented, but the client option settings ENCRYPTKEY PROMPT and
ENCRYPTKEY SAVE are not prevented.

System action:

The option is ignored.

User response:

None.

------------------------------------------------------------------------
ANS2228W

Backup of VMware vCloud Director vApp 'vApp name' in Organization VDC
'Org VDC name' of organization 'Org name' completed. Some VMs were not
backed up. VMs: number of VM backed up out of number of VMs in vApp VMs
backed up successfully.



Explanation:

The vApp backup operation completed successfully. However, one or more
VMs for the specified vApp were not backed up. These VMs will not be
created during the restore operation.

System action:

Processing continues to the next vApp.

User response:

Check the log file for this vApp for more information about this
message. Resolve the problem, then try the operation again.

------------------------------------------------------------------------
ANS2229E

Failed to initialize the vCloud protection environment. See the local
client error log for detailed error message information.



Explanation:

The vCloud protection package could not be initialized.

System action:

The operation is stopped

User response:

Make sure all options that are related to the vCloud environment are
specified correctly. Check the dsmerror.log file for detailed
information.

------------------------------------------------------------------------
ANS2230E

Failed to create vApp list according to spec 'vApp specification'



Explanation:

The vApp list was unable to be retrieved from the vCloud Director.

System action:

The operation is stopped

User response:

Make sure the values specified in the VCDHost, VCDUser, VCDPW, and
DOMAIN.VCD options are correct. Make sure the vCloud Director is alive.

------------------------------------------------------------------------
ANS2231I

The IBM category 'cat' was not found.



Explanation:

The IBM Spectrum Protect option 'VMTAGDATAMOVER' is enabled so that IBM
categories and tags can be applied to virtual machines, but the IBM
category was not found.

System action:

The backup operation continues without tagging support.

User response:

Create the required IBM categories in the VMware vSphere web client or
disable the data mover option 'VMTAGDATAMOVER' in the client options
file.

------------------------------------------------------------------------
ANS2232E

Failed to retrieve the list of VMs for vApp 'vApp name' from the vCloud
Director.



Explanation:

The VM information for the specified vApp was not retrieved from the
vCloud Director. This failure might be caused by the vCloud Director not
being alive or accessible.

System action:

The VMs that compose the specified vApp are not backed up. Processing
continues to the next vApp.

User response:

Make sure that the vCloud Director is alive and accessible. Check the
dsmerror.log file for specific errors that are related to this issue.

------------------------------------------------------------------------
ANS2233I

The IBM tag 'tag' for category 'cat' was not found.



Explanation:

The IBM Spectrum Protect option 'VMTAGDATAMOVER' is enabled so that IBM
categories and tags can be applied to virtual machines, but the IBM tag
was not found.

System action:

The operation continues without tagging support.

User response:

Create the required IBM tags in the VMware vSphere web client or disable
the data mover option 'VMTAGDATAMOVER' in the client options file.

------------------------------------------------------------------------
ANS2234W

Restore from virtual machine backup 'vm-name' is not available for
database 'db-name'. reason



Explanation:

Restore from virtual machine backup is not supported for in-guest
application databases for one of the following reasons:

*  Database files are located on the dynamic disks, GUID Partition Table
   (GPT) disks, iSCSI disks or other Network Attached Storage devices.

*  Microsoft Exchange Server databases are in the dismounted state
   during virtual machine backup.

*  Microsoft Exchange Server databases are in the unhealthy state or
   with unhealthy database copies.

*  Microsoft Exchange Server databases are being backed up by a
   different server at the same time.

*  When vmPreferDagPassive option is set to YES, Microsoft Exchange
   Server databases are active copies on the current server and have a
   healthy passive copy on another server.

*  Microsoft Exchange Server Exchange databases are in the unknown state
   because IBM Spectrum Protect is not able to determine the database
   health status during virtual machine backup.



System action:

The backup operation of the full virtual machine continues.

User response:

Take one or more of the following actions to resolve the issue:

*  Move the database files to disks that are supported by in-guest
   application protection.

*  Mount the dismounted Microsoft Exchange Server databases before the
   virtual machine backup.

*  Repair the Microsoft Exchange Server databases in the unhealthy
   states.

*  Use the VMTSMVSS trace flag on the data mover to trace database
   health status processing during virtual machine backup operations.



------------------------------------------------------------------------
ANS2236I

The virtual machine 'VM-name' contains one or more disks that exceed the
maximum size set by the VMMAXVIRTUALDISKS option. These disks will be
excluded from the backup.



Explanation:

The IBM Spectrum Protect client does not back up VMDKs that are larger
than the maximum size.

System action:

The virtual machine is backed up; however, the disks that exceed the
limit are excluded from the backup.

------------------------------------------------------------------------
ANS2238E

VCDHOST option must be set before running this operation.



Explanation:

VCDHOST option is missing.

System action:

Operation cannot continue without this option being set.

User response:

Add the option to the client options file, either via the preferences
editor or by manually editing the file, or specify the option on the
command line.

------------------------------------------------------------------------
ANS2242E

No nodes were found that matched the input specification: node
specification



Explanation:

An invalid node specification was entered.

System action:

The operation was stopped.

User response:

Check documentation how to specify nodes.

------------------------------------------------------------------------
ANS2244W

The virtual machine contains one or more disks that exceed the maximum
size set by the VMMAXVIRTUALDISKS option. You can use the
VMMAXVIRTUALDISKS option to change the maximum size or specify the
'-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from the
backup.



Explanation:

The IBM Spectrum Protect client does not back up VMDKs or VHDXs that are
larger than the maximum size.

System action:

The virtual machine is not backed up.

User response:

Use the VMMAXVIRTUALDISKS option to change the maximum size or specify
the '-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from the
backup.

------------------------------------------------------------------------
ANS2245E

Virtual machine backups and restores are not supported on 32 bit data
movers.



Explanation:

Virtual machine operations such as backups and restores are not
supported on 32 bit Data Movers.

System action:

The operation is not performed.

User response:

Update to a 64 bit Data Mover and retry the operation.

------------------------------------------------------------------------
ANS2246W

Failed to disable maintenance mode for vApp vApp name.



Explanation:

The client has tried to disable the maintenance mode of this vApp. This
operation failed.

System action:

Operation continues.

User response:

Check whether the vApp is still in maintenance mode. If yes, disable it
manually.

------------------------------------------------------------------------
ANS2247E

ASNODENAME option must be specified when running this command.



Explanation:

When running vCloud-related commands, ASNODENAME option must specify the
Provider vDC node.

System action:

Operation cannot continue.

User response:

Specify the Provider vDC node as ASNODENAME to the command.

------------------------------------------------------------------------
ANS2248E

Failed to load or initialize the Java runtime library.



Explanation:

The Java runtime library (libjvm), required by the vCloud Protection
environment, cannot be loaded, or initialization of Java runtime
environment failed

System action:

Operation is stopped

User response:

For Linux operating system, verify that a link named 'jre', referencing
the 'jre' directory under your Java installation path, exists in the
backup-archive client installation directory. If a link does not exist,
create the link (e.g. ln -s /opt/ibm/java-x86_64-70/jre
/opt/tivoli/tsm/client/ba/bin/jre). Alternatively, modify
LD_LIBRARY_PATH to include the path to libjvm.so (e.g. export
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/tivoli/tsm/client/ba/bin:/opt/ibm/java-x86_64-70/jre/bin/classic).
For Windows operating system, verify that the JRE directory exists under
the client installation directory. Reinstall the backup-archive client
if necessary.

------------------------------------------------------------------------
ANS2249W

A virtual machine named 'vmname' exists on this system. Do you want to
replace the existing virtual machine?



Explanation:

Restoring this virtual machine will stop and delete the existing virtual
machine and all of its files. To protect application data, stop any
applications that are running, and then shut down the virtual machine
before you restore it.

System action:

If the user chooses to continue, the system will stop and delete the
existing virtual machine and all of its files.

User response:

Choose whether to replace the existing virtual machine.

------------------------------------------------------------------------
ANS2250W

A IBM Spectrum Protect core file or crash report was found: filename



Explanation:

The presence of a core dump or crash report indicates a process has
abnormally terminated.

System action:

The core file or crash report name is reported in the message.
Processing continues.

User response:

Review the error log for any other error messages that may help diagnose
the cause of the core dump. If possible, correct any issues found. As a
core dump is generally caused by a programming error, save the file
noted in this message and contact IBM technical support.

------------------------------------------------------------------------
ANS2253W

The version of the message catalog, catalogversion, in use by IBM
Spectrum Protect does not match the version of IBM Spectrum Protect,
clientversion



Explanation:

A check of the catalog version indicates the catalog and IBM Spectrum
Protect are not the same version. This may lead to missing or incorrect
messages being used.

System action:

Processing continues.

User response:

Review the installation of IBM Spectrum Protect, verify the message
catalog files match the installed version of IBM Spectrum Protect.
Re-installation of IBM Spectrum Protect may be required, or a system
reboot may be required to complete the installtion.

------------------------------------------------------------------------
ANS2254E

program-name with session id sessid aborted recall for token token.
ERRNO errno : errno-text was set. See message explanation.



Explanation:

A recall was aborted from HSM. The ERRNO set from HSM explains why the
recall was aborted.

System action:

The recall request was aborted from the HSM service.

User response:

Transient errors: Solve problem indicated from the errno. On GPFS
platforms: Use command dsmmigfs q -d -n=all to verify HSM and GPFS are
running properly. Retry the recall operation if failed file can be
identified. Enable HSM Logging if failed failed file cannot be
identified and wait for new occurrence. (HSM Logging allows you to map
between the token displayed from the ANS message and the recalled file)
Static errors: Restore the file from backup.

------------------------------------------------------------------------
ANS2260E

Failed to lock IBM Spectrum Protect password file.



Explanation:

In multi-process environment IBM Spectrum Protect client locks the
password file during authentication to avoid conflicts on updating
password in case the currect password is expired.

System action:

processing stops

User response:

Try to use MAXRETRIESLOCK test flag to increase number of attempts to
lock the file. The default value is 1500.

------------------------------------------------------------------------
ANS2261E

IBM Spectrum Protect client failed to lock options file.



Explanation:

In multi-process environment IBM Spectrum Protect client locks the
options file during initialization to avoid conflicts on reading or
adding an option.

System action:

processing continue

User response:

Try to decrease a number of IBM Spectrum Protect client processes

------------------------------------------------------------------------
ANS2262I

The service is starting.



Explanation:

The file restore service is starting.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2263I

The service started.



Explanation:

The file restore service started.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2264I

The shutdown is in progress.



Explanation:

The shutdown is in progress.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2265I

The service is shutting down.



Explanation:

The file restore service is shutting down.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2266I

The option 'option-name' is set to the default value of 'default-value'.



Explanation:

An error was detected with the option value.

System action:

The default setting is used.

User response:

To use a non-default value, correct the option value in the
frConfig.props file.

------------------------------------------------------------------------
ANS2267W

The 'option-name' option value 'invalid-value' is invalid.



Explanation:

An error was detected with the option value.

System action:

The default setting is used.

User response:

To use a non-default value, correct the option value in the
frConfig.props file. Then, restart the web server that is hosting the
file restore interface.

------------------------------------------------------------------------
ANS2268W

The TCP/IP port address on the mount proxy node cannot be located or is
invalid.



Explanation:

The mount proxy node requires a TCP/IP port address. This address is
used for communication by the client acceptor on the mount proxy node.

*  If a local mount proxy node is used, the TCP/IP port address that was
   specified with the configuration wizard or notebook is invalid.

*  If a remote mount proxy node is used, the default_mp_httpport option
   in the frConfig.props file is either not specified or is invalid.

Communication with the client acceptor cannot start.

System action:

Processing stops.

User response:

If a local mount proxy node is used, use the Mount Proxy Node Pairs page
in the configuration wizard or notebook to remove the mount proxy node.
Then, add the mount proxy node again to resolve this issue.

If a remote mount proxy node is used, ensure that the
default_mp_httpport option is specified in the frConfig.props file with
a valid TCP/IP port address.

------------------------------------------------------------------------
ANS2269E

The maximum number of backups were loaded. If a restore is running, wait
for it to complete and load the backup again. If the backup is loaded in
another browser window, close that browser.



Explanation:

To mount another backup, one of the mounted backups must be dismounted.

System action:

Processing stops.

User response:

Dismount one of the mounted backups and try the operation again.

------------------------------------------------------------------------
ANS2271W

Unsuccessful deletion of archived file fshlll



Explanation:

An attempt to delete the archived file was unsuccessful.

System action:

Processing continues.

User response:

Check the console or schedule log for additional information. Retry the
operation at a later time.

------------------------------------------------------------------------
ANS2272E

The Comma Separated Values (CSV) file specified 'CSV_file' could not be
found or opened.



Explanation:

The CSV option uses a Comma Separated Values (CSV) file as input for
this operation. The specified CSV file could not be found or opened.

System action:

The operation has stopped.

User response:

Check that the file path is correct and that the file permissions allow
read access. Try the operation again.

------------------------------------------------------------------------
ANS2273E

The Comma Separated Values (CSV) file has two or more columns
'column_title' with the same title. Duplicate column names are not
allowed.



Explanation:

The specified operation, started from a Comma Separated Values (CSV)
file, requires unique columns. For example, if you specify the column
"New Host" twice, the operation cannot determine which value to use.

System action:

The operation has stopped.

User response:

Remove any duplicat ecolumns. Try the operation again.

------------------------------------------------------------------------
ANS2274I

The column 'column_title' in the Comma Separated Values (CSV) file is
not recognized for the current operation and will be ignored.



Explanation:

Each operation type recognizes a different set of column names in a
Comma Separated Values (CSV) file. The specified column is not used by
the current operation.

System action:

The column that the operation could not recognize is ignored. The
operation continues.

User response:

Change the name if it the column is misspelled. Otherwise, no action is
needed. You can also simply remove the column.

------------------------------------------------------------------------
ANS2275W

The element 'element_name' in the column labeled 'column_title' in the
Comma Separated Values (CSV) file can not be used in this operation. Row
elements must be unique for each column.



Explanation:

The operation requires that each element in the Comma Separated Values
(CSV) file is unique for that column. For example, if two rows contained
the same value for "Virtual Machine Name", inconsistent instructions
could be applied to that VM.

System action:

The operation has stopped.

User response:

Remove the row that contains the duplicate element. Try the operation
again.

------------------------------------------------------------------------
ANS2276E

The Comma Separated Values (CSV) file 'file_name' has a row count of
row_count. The current operation requires a minimum of
required_row_count to execute.



Explanation:

The current operation requires a certain number of rows in the Comma
Seperated Values (CSV) file in order to execute. The row count in the
CSV file is below this value.

System action:

The operation has been stopped.

User response:

Add the input rows required for this operation to the CSV file. Try the
operation again.

------------------------------------------------------------------------
ANS2277E

The element in the Comma Separated Values (CSV) file on row row under
column 'column_name' with the value of 'element_value' is invalid or
missing.



Explanation:

The current operation encountered an invalid or missing value in the
Comma Separated Values (CSV) file.

System action:

The operation has been stopped.

User response:

Correct the identified element. Try the operation again.

------------------------------------------------------------------------
ANS2278E

The time_option option cannot be used without specifying the date_option
option on row row of the Comma Separated Values (CSV) file.



Explanation:

If the PITTIME option cell exists thens the corresponding PITDATE cell
must exist.

System action:

Processing has stopped.

User response:

Either remove the PITTIME option cell or add the corresponding PITDATE
option cell.

------------------------------------------------------------------------
ANS2279E

The Comma Separated Values (CSV) file is missing the required column
'column_name' for the current operation.



Explanation:

To perform the task, the current operation requires a specific column in
the CSV file. This column is missing from the CSV file.

System action:

Processing has stopped.

User response:

Add the required column and the required elements for that column to the
CSV file.

------------------------------------------------------------------------
ANS2280E

The Comma Separated Values (CSV) file 'csv_file' is invalid. The CSV
file must have the same number of columns per row. The first row of the
CSV file contains first_row_column_count columns.



Explanation:

The CSV file submitted is invalid because the number of columns on each
row is not identical.

System action:

Processing has stopped.

User response:

Edit the CSV file so that the number of columns per row is identical.
Try the command again.

------------------------------------------------------------------------
ANS2281E

The current operation encountered a blank element in the Comma Separated
Values (CSV) file 'csv_file' on row row_number, column column_number.



Explanation:

The current operation found a blank element in the CSV file where a
value is required for the operation to continue. CSV files used for this
operation must contain values in all fields. All required columns must
be present.

System action:

Processing has stopped.

User response:

Edit the CSV file and provide data where a cell is blank or an entire
column is missing. Try the operation again.

------------------------------------------------------------------------
ANS2282E

An element in the Comma Separated Values (CSV) file csv_file is not a
valid element: 'string_value'



Explanation:

The current operation encountered a invalid or missing value that is
required for the operation in the Comma Separated Values (CSV) file.

System action:

The operation is stopped.

User response:

Correct the identified element.

------------------------------------------------------------------------
ANS2284E

The Microsoft Hyper-V backup cannot be deleted.



Explanation:

Deleting the Hyper-V backup will cause data integrity issues because the
next incremental backup operation will not back up all required data.
For this reason, do not delete Hyper-V backups.

System action:

The backup is not deleted, but system operation continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2307I

IBM Spectrum Protect category or tag can not be found on vCeter.
Category: category-name, tags: tag-names



Explanation:

Spectrum Protect category are not present on the vCenter. Setup might be
incomplete. Please run 'dsmc set vmtags' to add the necessary tags. This
message can safely be ignored if the tag-based schedule is not being
used.

System action:

Processing continues.

User response:

Check the vcsplugin.log file for additional information and contact the
IBM Spectrum Protect administrator if you require further assistance.

------------------------------------------------------------------------
ANS2308E

The VMware vCloud Suite API reported the following error message:
'api-message'.



Explanation:

The VMware vCloud Suite API reported an error with the specified
message.

System action:

Processing stops.

User response:

Check the vcsplugin.log file for additional information and contact the
IBM Spectrum Protect administrator if you require further assistance.

------------------------------------------------------------------------
ANS2309I

Single Sign On login to the vSphere Server failed in function function.
API message A credential login is now attempted.



Explanation:

The Single Sign On (SSO) login to the vSphere Server failed. Possible
reasons for this failure include the following situations:

*  A time difference exists between the vSphere Server clock and the
   client clock that exceeds 10 minutes.

*  The SSO server accesses a non-default port. This issue can occur when
   the SSO server is installed on the same system as the VMware vCenter.

System action:

The system attempts a credential login as a result of the SSO login
failure.

User response:

Check the dsmerror.log file for details about why the SSO login attempt
failed. Then, take any corrective action, if needed.

------------------------------------------------------------------------
ANS2310E

The create snapshot task is disabled on the virtual machine 'VM-name'.
As a result, the virtual machine cannot be backed up.



Explanation:

Virtual machines that are managed or replicated by another application
disable the create snapshot task. The vSphere client or another
application disabled the create snapshot task on this virtual machine.
As a result, this virtual machine cannot be backed up.

System action:

The backup operation skips the virtual machine with the disabled create
snapshot task and continues processing the remaining virtual machines.

User response:

None.

------------------------------------------------------------------------
ANS2311E

The create snapshot task is disabled on the virtual machine. As a
result, the virtual machine cannot be backed up.



Explanation:

Virtual machines that are managed or replicated by another application
disable the create snapshot task. The vSphere client or another
application disabled the create snapshot task on this virtual machine.
As a result, this virtual machine cannot be backed up.

System action:

The backup operation skips the virtual machine with the disabled create
snapshot task and continues processing the remaining virtual machines.

User response:

None.

------------------------------------------------------------------------
ANS2312E

-DELTYPE=ALL is not allowed for DELETE BACKUP -OBJTYPE=VM.



Explanation:

DELTYPE=ALL is not a valid option value when deleting VM backup objects.

System action:

The command is not executed.

User response:

If you wish to delete all backups for a VM node, use the DELETE
FILESPACE command.

------------------------------------------------------------------------
ANS2313E

-FILELIST is not allowed for DELETE BACKUP or EXPIRE when -OBJTYPE=VM.



Explanation:

-filelist is not a valid option value when deleting or expiring VM
backup objects.

System action:

The command is not executed.

User response:

If you wish to delete or expire all backups for a VM node, use the
DELETE FILESPACE command.

------------------------------------------------------------------------
ANS2314E

No VM backup exists for VM-Name.



Explanation:

The IBM Spectrum Protect server has no record of a VM backup for the VM
name provided. The backup might have been deleted, or the VM name
spelled incorrectly.

System action:

The command is not executed.

User response:

If spelling is the problem, correct it and resubmit the command.

------------------------------------------------------------------------
ANS2315E

-PICK is not allowed for EXPIRE when -OBJTYPE=VM.



Explanation:

-pick is not a valid option value when expiring VM backup objects.

System action:

The command is not executed.

User response:

If you wish to expire all VM nodes, use the DELETE FILESPACE command.

------------------------------------------------------------------------
ANS2316E

Wildcards are not allowed in the VM name argument.



Explanation:

When expiring or deleting a VM backup, the VM name must be specified
exactly. The EXPIRE -OBJTYPE=VM command processes only one backup on
each invocation. When -INACTIVE is present the DELETE BACKUP -OBJTYPE=VM
command displays all versions of a single VM backup in a list from which
to choose. If -INACTIVE is not present, this command expires the current
active VM backup.

System action:

The command is not executed.

User response:

Specify only one VM name without wild cards. It may be in upper or lower
case.

------------------------------------------------------------------------
ANS2317E

Deletion of VM object VMname failed. Reason:



Explanation:

The transaction which deletes the named VM object failed at the server.
The reason code ....?????

System action:

The deletion is skipped and processing continues with the next
selection, if any.

User response:

Consult the error log for specific reasons for this failure.

------------------------------------------------------------------------
ANS2318E

Command with -OBJTYPE=VM requires exactly one non-option argument



Explanation:

This command accepts only a single VM name as an argument. Either no
arguments were entered or more than one appeared on the command line.

System action:

The command is not executed.

User response:

Specify only one VM name without wild cards. It may be in upper or lower
case.

------------------------------------------------------------------------
ANS2319W

DELETE BACKUP -OBJTYPE=VM finished with failures.



Explanation:

One or more deletions failed.

System action:

The VM backups which failed have been reported in previous messages.
Processing continues with the next selection, if any.

User response:

Consult the previous error messages for the cause of each failure.

------------------------------------------------------------------------
ANS2320I

DELETE BACKUP -OBJTYPE=VM finished without failures.



Explanation:

All VM backups selected for deletion were deleted.

System action:

Control returns to the command line.

User response:

No action is required, this message is informational.

------------------------------------------------------------------------
ANS2321W

EXPIRE with -OBJTYPE=VM finished with failures.



Explanation:

The command did not complete, no objects were expired.

System action:

The VM expire which failed has been reported in previous messages.

User response:

Consult the previous error messages for the cause of the failure.

------------------------------------------------------------------------
ANS2322I

EXPIRE with -OBJTYPE=VM finished without failures.



Explanation:

The EXPIRE command executed successfully.

System action:

Control returns to the command line.

User response:

No action is required, this message is informational.

------------------------------------------------------------------------
ANS2323E

The user ID and password for VMware vCloud Director 'vCD host name' are
not set.



Explanation:

The user ID and password for VMware vCloud Director could not be read
from encrypted password file.

System action:

Processing stops.

User response:

Issue the dsmc SET PASSWORD -type=VCD 'vCloud Director hostname'
'userid' 'password' command to save an encrypted password.

------------------------------------------------------------------------
ANS2324W

WARNING: The VMware vCloud Director user ID <hostuserid> read from the
password file is different from the VCDUser option value <vmcuserid>.
Using stored value.



Explanation:

All user IDs that are specified in the TSM.PWD file and in the VCDUSER
option must be the same.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information that
is provided in this message.

------------------------------------------------------------------------
ANS2325E

Error Accessing Snapshot Differential Change Log for filer '' volume '',
see client error log for more information.



Explanation:

The Snapshot Differential Change Log needed needed to backup the
specified filer volume could not be accessed

System action:

The backup of the specified volume fails.

User response:

Ensure that the client staging directory where change logs are located
is accessible.

------------------------------------------------------------------------
ANS2326W

Corrupt Snapshot Differential Change Log detected, change log will be
reset and a full progressive incremental will be performed.



Explanation:

A corrupt snapshot differential change log for the filer volume being
backed up was detected.

System action:

The change log will be reset and a full progressive incremental with a
new base snapshot will be performed.

User response:

none.

------------------------------------------------------------------------
ANS2327I

Creating Snapshot Differential Change Log.



Explanation:

A new snapshot differential change log was created.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS2328I

Using Snapshot Differential Change Log.



Explanation:

A snapshot differential change log is being used for the backup.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS2329W

Down level Snapshot Differential Change Log detected, Change Log will be
reset and a full progressive incremental will be performed.



Explanation:

none.

System action:

none.

User response:

none.

------------------------------------------------------------------------
ANS2330E

Failed to unfreeze the VSS writers because the snapshot time exceeded
the 10 second timeout limitation.



Explanation:

Microsoft VSS has a 10 second timeout limitation between freeze and thaw
events for VSS writers on a VM. When the snapshot time exceeds the 10
second timeout limit, the VSS writers return to a 'failed' state. This
failed state occurs because the VSS provider did not thaw the VSS
writers within the allowed time.

System action:

Processing stops.

User response:

Check the event log. Ensure that the writers on the guest VM are in
'stable' state before trying an application protection VM backup
operation again. A snapshot operation must be completed within 10
seconds.

------------------------------------------------------------------------
ANS2331W

No match found on the server for the Hyper-V VM name or VMList 'string'
entered



Explanation:

No match found on the server for the Hyper-V VM name or VMList parameter
entered.

System action:

None.

User response:

Specify another Hyper-V VM name or VMList parameter that exists on the
server.

------------------------------------------------------------------------
ANS2332E

Failed to log on to the vCloud Director. Authentication failed.



Explanation:

The vCloud credentials were rejected by the vCloud Director.

System action:

The operation is stopped

User response:

Update username and password for the vCloud Director.

------------------------------------------------------------------------
ANS2333E

Failed to establish connection to the vCloud Director.



Explanation:

A connection cannot be established to the vCloud Director on the host
that is specified by the VCDHost and VCDPort options.

System action:

The operation is stopped

User response:

Verify that the values of the VCDHOst and VCDPort options are valid,
network connectivity to the host exists, and that the vCloud Director
service is running.

------------------------------------------------------------------------
ANS2334E

An operation requiring the Windows Management Instrumentation (WMI)
service has failed with the error 'errorstring'. Unable to connect to
the Hyper-V namespace. Confirm that Hyper-V is installed on the backup
node.



Explanation:

The Windows Management Instrumentation (WMI) namespace
"root\virtualization\v2" for Hyper-V could not be found. This namespace
is installed with Hyper-V. If Hyper-V is installed, Hyper-V is not in a
good state.

System action:

Creating a connection to the Hyper-V WMI provider.

User response:

Check that Hyper-V is installed. If Hyper-V is not installed, install
Hyper-V before attempting this operation again.

------------------------------------------------------------------------
ANS2335E

An operation requiring the Windows Management Instrumentation (WMI)
service has failed with the error 'errorstring'. The WMI service is in
the shutting down or shutdown state. Restart the service and try again.



Explanation:

The Windows Management Instrumentation (WMI) service has received a
request to shutdown or has been shutdown due to an external error. An
internal operation which requires WMI has been attempted and failed. The
requested operation is unavailable while WMI is shutdown.

All Hyper-V operations require the Windows Management Instrumentation
service.

System action:

An internal IBM Spectrum Protect operation involving Windows Management
Instrumentation has occurred.

User response:

Restart the Windows Management Instrumentation service.

------------------------------------------------------------------------
ANS2336W

IBM Spectrum Protect has detected that the following Hyper-V virtual
machine "virtual_machines" has an interrupted incremental backup chain.
Performing a full backup on the specified Hyper-V virtual machine.



Explanation:

The last operation of the virtual machine was a restore; or an unknown
party has performed incremental backup operations on the listed virtual
machine. To prevent backup corruption a full backup will be performed
instead.

System action:

IBM Spectrum Protect has detected that a virtual machine has an
interrupted incremental backup chains.

User response:

A full backup is performed instead of an incremental.

------------------------------------------------------------------------
ANS2337E

The process was unable to take cluster resource 'resourcename' offline.
The current operation requires the resource to be offline. Turning the
cluster resource off failed with rc=rc.



Explanation:

The cluster resource was not taken offline within the time limit or an
attempt was made to take offline a failed cluster resource.

System action:

The current operation stops.

User response:

Check that the cluster resource is not in a failed state. Verify that
the cluster resource can be taken offline.

------------------------------------------------------------------------
ANS2338W

The process has detected a request to backup a virtual machine replica.
The state of the replica 'vmreplicaname', ID='vmid' may differ from the
original virtual machine. If the names of the original virtual machine
and the replica are identical the same file space will be used. The data
may become unrecoverable because the state of the original virtual
machine and the replica may differ.



Explanation:

Backups of an original virtual machine and their replica overwrite each
other as their name and ID are usually identical. Virtual machine
replicas are taken in definite time intervals. Between these intervals
the data on the original and the replica may differ. In some occasions
the difference may cause data corruption if a backup of the original is
followed by a backup of the replica.

System action:

A backup request of a virtual machine replica is being processed.

User response:

Configure IBM Spectrum Protect to back up only the original virtual
machine or the replica. Alternatively, one can change the name of the
replica compared to the original virtual machine; and the replica will
back up to a separate file space.

------------------------------------------------------------------------
ANS2339W

The Hyper-V VM 'vmname' is in a "branch" state compared to the last
backup. Incremental Forever - Incremental backup cannot be performed. An
Incremental Forever - Full backup will be performed instead.



Explanation:

The VM state is in a "branch" compared to the last backup. This causes a
fallback to Incremental Forever - Full as backup consistency in this
state is not guaranteed.

System action:

An Incremental Forever - Full backup will be performed.

User response:

None.

------------------------------------------------------------------------
ANS2340W

The target virtual machine 'VM-name' exists, use the REPLACE option to
overwrite.



Explanation:

The specified target VM exists and the user specified not to allow
restore to replace existing machines.

System action:

The virtual machine is not restored.

User response:

Specify a different virtual machine as a restore target or specify that
existing virtual machines can be replaced.

------------------------------------------------------------------------
ANS2341E

The target virtual machine 'VM-name' cannot be restored: The guid
differs from the backup copy.



Explanation:

The specified target VM exists and has a different guid than the virtual
machine was backed up with..

System action:

The virtual machine is not restored.

User response:

Specify a different virtual machine as a restore target or delete the
specified target virtual machine.

------------------------------------------------------------------------
ANS2342E

The specified restore target 'VM-name' is ambiguous: Multiple virtual
machines with the same name exist.



Explanation:

The specifed restore target is ambiguous, multiple virtual machine with
the same name exist.

System action:

The virtual machine is not restored.

User response:

Specify a different virtual machine as a restore target.

------------------------------------------------------------------------
ANS2343E

A snapshot of Virtual machine 'vmname' cannot be taken because a
physical disk attached.



Explanation:

The Volume Snapshot Service (VSS) is unable to snapshot a virtual
machine with a physical disk.

System action:

The full backup of the the virtual machine finished with failures. The
next virtual machine in the backup will be processed.

User response:

Do not include this virtual machine in domain.vmfull for backup. A
snapshot of this virtual machine cannot be taken.

------------------------------------------------------------------------
ANS2344E

'drive-name1' is a disk witness.



Explanation:

The indicated volume is a disk witness. Because the CLUSTERNODE option
is set to YES, the volume cannot be backed up or archived.

System action:

Processing stops.

User response:

If the CLUSTERNODE option is incorrectly set to YES, then change the
option to NO and try the operation again. Otherwise see the client
manual for further information about configuring the IBM Spectrum
Protect client to run in a cluster environment.

------------------------------------------------------------------------
ANS2345W

The virtual machine named '' was found to have an old snapshot ''. A
command was sent to the vCenter to remove it.



Explanation:

During the snapshot clean-up process the backup-archive client found old
snapshots on the virtual machine. A remove snapshot command was sent to
the VMware vCenter to remove the old snapshots.

System action:

Processing continues

User response:

Confirm that the the virtual machine is free of all snapshots before the
next scheduled backup.

------------------------------------------------------------------------
ANS2346E

Expiration of VM object VMname failed. Reason:



Explanation:

The transaction which expires the named VM object failed at the server.
The reason code ....?????

System action:

The expiration is not completed.

User response:

Consult the error log for specific reasons for this failure.

------------------------------------------------------------------------
ANS2347E

IBM Spectrum Protect application protection cannot be used. The correct
Java Runtime Environment version has not been detected on machine. A
Java Runtime Environment version or higher is required to run this
program. If you have already installed this level of Java version on
this machine, please ensure that the correct Java executable is on your
PATH and start the program again.



Explanation:

IBM Spectrum Protect application protection vm backup cannot be started
because the Java runtime environment does not meet the requirements.

System action:

Processing stops.

User response:

Verify that the correct java executable is on your PATH or install the
required version of Java runtime environment and run the backup again.

------------------------------------------------------------------------
ANS2348E

Mount proxy host 'remoteversion' does not have a supported operating
system.



Explanation:

The mount proxy node needs to be configured on a supported operating
system.

System action:

The calling procedure returns and control is passed back the user.

User response:

Check the documentation for a list of supported operating systems.
Configure the mount proxy node on a supported operating system.

------------------------------------------------------------------------
ANS2349W

The virtual machine named '' was found to need snapshot consolidation. A
command was sent to the VMware vCenter to perform consolidation.



Explanation:

During the virtual machine backup process the backup-archive client
found the virtual machine needed snapshot consolidation. A command was
sent to the VMware vCenter to perform consolidation.

System action:

Processing continues

User response:

Confirm that the virtual machine is clean of all snapshots and snapshot
delta files before the next scheduled backup.

------------------------------------------------------------------------
ANS2350E

Virtual machine 'VM name' will not be backed up because it contains at
least one of the following unsupported special characters \ / : ; , * ?
" ' < > |



Explanation:

The specified virtual machine contains characters that are not supported
for virtual machine backup and restore operations.

System action:

The backup for the specified virtual machine fails.

User response:

Rename the virtual machine so that it does not contain any of the
specified special characters.

------------------------------------------------------------------------
ANS2351E

Duplicate virtual machine name 'vmname' was detected in the same backup
operation. Backups of a virtual machine can not continue without a
unique object name.



Explanation:

The backup of the virtual machine failed because no unique object name
is available.

System action:

The backup for the specified virtual machine fails. The next virtual
machine to back up will be processed.

User response:

Rename the virtual machine so that it is unique among virtual machines
for the node.

------------------------------------------------------------------------
ANS2352E

Validation of virtual machine 'vmname' configuration returned the
following message from Hyper-V: hypervmessage This message indicated
that the virtual machine could not be restored until the message from
Hyper-V is addressed.



Explanation:

When validating the virtual machine with Hyper-V a message was returned
that prevents the virtual machine restore from continuing.

System action:

Cannot continue with restore until the issue is resolved.

User response:

Resolve the issue outlined by the message.

------------------------------------------------------------------------
ANS2353W

The virtual machine to be restored 'vm-name' exceeds the amount of
vCPUs, virtual memory, or both, that are allowed by the host. The
virtual machine was reset to the minimum amount that is allowed by the
host so that the restore operation can continue.



Explanation:

The virtual machine to be restored is configured for more vCPUs, virtual
memory, or both, than are allowed by the host. The amount of vCPUs and
virtual memory can be adjusted after the restore operation completes.

System action:

The vCPUs, virtual memory, or both, are reset to the minimum amount that
are allowed by the host. The restore operation continues.

User response:

Adjust the amount of vCPUs, virtual memory, or both, after the restore
operation completes.

------------------------------------------------------------------------
ANS2373E

The VMware vCloud Suite plug-in library failed to connect to the
Platform Services Controller (PSC) and perform a single sign-on session.



Explanation:

A connection cannot be established with the Platform Services
Controller.

System action:

vCloud Suite API operations cannot be performed.

User response:

Verify that the value of the VMCHOST option is correct, that network
connectivity to the host exists, and that the Platform Services
Controller is running either embedded or external.To receive any
additional messages that might be related to this problem, enable
TRACEFLAGS VCLOUD tracing in the client options file. To determine which
Platform Services Controller the vCenter Server is referencing, examine
the vCenter Server's Advanced Settings key 'config.vpxd.sso.sts.uri'.
Confirm the system time between the PSC, vCenter and the client on the
data mover node are in sync. Also, check the vCloud Suite plug-in error
file vcsplugin.log.

------------------------------------------------------------------------
ANS2374E

The VMware vCloud Suite plug-in library failed to connect to the vCenter
Management Server.



Explanation:

A connection cannot be established with the vCenter Management Server.

System action:

vCloud Suite API operations cannot be performed.

User response:

Verify that the value of the VMCHOST option is correct, and that network
connectivity to the host exists. To receive any additional messages that
might be related to this problem, enable TRACEFLAGS VCLOUD tracing in
the client options file. Also, check the vCloud Suite plug-in log file
vcsplugin.log.

------------------------------------------------------------------------
ANS2375E

The VMware vCloud Suite plug-in library failed to connect to the vCenter
Management Server because the instance name could not be found.



Explanation:

A connection cannot be established with the vCenter Management Server
because the instance name could not be found. This could be a spelling
error in the host name or the Domain Name System (DNS) is not
functioning.

System action:

vCloud Suite API operations cannot be performed.

User response:

Verify that the value of the VMCHOST option is correct and matches the
name used to register the vCenter with the Platform Services Controller
often this is the fully qualified domain name (FQDN). To receive any
additional messages that might be related to this problem, enable
TRACEFLAGS VCLOUD tracing in the client options file.

------------------------------------------------------------------------
ANS2376I

The target vCenter version does not support VMware's vCloud Suite SDK so
tagging operations cannot be performed by the client on the data mover
node.



Explanation:

The client option 'VMTAGDATAMOVER' is enabled so that IBM Spectrum
Protect categories and tags can be applied to virtual machines, but the
vCenter version is below version 6.0.

System action:

The operation continues without the vCloud Suite plug-in library and
vSphere tagging support.

User response:

Use a vCenter that is at or above version 6.0 or disable the
'VMTAGDATAMOVER' option in the client options file.

------------------------------------------------------------------------
ANS2377I

The IBM category data has been created, or already existed, on the
VMware Platform Services Controller.



Explanation:

The categories used for tagging support in the backup-archive client are
available for use on the VMware Platform Services Controller.

System action:

The operation has completed.

User response:

None.

------------------------------------------------------------------------
ANS2378W

The single sign-on session to the Platform Services Controller (PSC)
failed with the following message: apimessage



Explanation:

The single sign-on session to the Platform Services Controller (PSC)
failed. The possible reasons for this failure include the following
situations:

*  This issue might occur when the system clock on the on PSC host,
   vCenter Server host, and client host are out of sync, or the time
   zones settings are incorrect.

*  The PSC single sign-on server accesses a non-default port. This issue
   might occur when the single sign-on server is installed on the same
   system as the VMware vCenter.



System action:

The client on the data mover node will attempt a credential login as a
result of the single sign-on login failure.

User response:

Check the dsmerror.log file for details about why the single sign-on
login attempt failed. Then, take any corrective action, if needed.

------------------------------------------------------------------------
ANS2380E

Connection to the Windows Management Instrumentation (WMI) default
namespace failed with the error 'error'.



Explanation:

The Windows Management Instrumentation (WMI) default namespace
"root\cimv2" could not be found. Possibly because the WMI repository is
corrupted.

System action:

Processing stops.

User response:

Please verify that the WMI repository is consistent using the command
'winmgmt /verifyrepository'.

------------------------------------------------------------------------
ANS2398I

The virtual machine 'VM-name' is configured as a VMware Site Recovery
Manager placeholder virtual machine on the recovery site. As a result,
the virtual machine will be skipped.



Explanation:

VMware Site Recovery Manager creates placeholder virtual machines that
have no virtual disk data. As a result, these virtual machines cannot be
backed up.

System action:

The backup operation skips the placeholder virtual machine and continues
processing the remaining virtual machines.

User response:

None

------------------------------------------------------------------------
ANS2399I

The virtual machine is configured as a VMware Site Recovery Manager
placeholder virtual machine on the recovery site. As a result, the
virtual machine will be skipped.



Explanation:

VMware Site Recovery Manager creates placeholder virtual machines that
have no virtual disk data. As a result, these virtual machines cannot be
backed up.

System action:

The backup operation skips the placeholder virtual machine and continues
processing the remaining virtual machines.

User response:

None

------------------------------------------------------------------------
ANS2408I

The virtual machine named 'VMNAME' is ready for Instant Access



Explanation:

The Instant Access operation for the specified virtual machine
successfully completed.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS2409E

The Instant Restore type was not identified.



Explanation:

The client encountered a connection error when querying the IBM Spectrum
Protect server for Instant Restore and Access information.

System action:

Processing stops.

User response:

Verify that the client is connected to the server. Then run the
operation again. Check with the command QUERY SESSION what is the cause
for the connection issue. Also check the dsmerror.log for additional
information

------------------------------------------------------------------------
ANS2410E

Instant Restore information for the specified virtual machines was not
found.



Explanation:

The IBM Spectrum Protect server does not contain Instant Restore
information for the specified virtual machines. Or, the virtual machines
were specified incorrectly.

System action:

Processing stops.

User response:

Issue the QUERY VM * -VMRESTORETYPE=ALLTYPE command. This command
queries all active Instant Access, Restore, and Disk sessions available
on the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS2411E

Instant Restore/Access of virtual machine 'vmname' failed with rc =
return-code



Explanation:

An error happened during processing of an Instant Restore or Access. See
previous output what happens exactly.

System action:

Processing stops.

User response:

Check the error log for information about how to resolve this error.

------------------------------------------------------------------------
ANS2412E

IBM Spectrum Protect Recovery Agent is not installed.



Explanation:

IBM Spectrum Protect Recovery Agent is not installed.

System action:

Processing stops.

User response:

Ensure that IBM Spectrum Protect Recovery Agent is correctly installed
and configured.

------------------------------------------------------------------------
ANS2413E

Cannot find the Recovery Agent shell command in the expected
installation path. Ensure that IBM Spectrum Protect for VE is correctly
installed and configured.



Explanation:

The Recovery Agent shell command was not found in the expected
installation path.

System action:

Processing stops.

User response:

Ensure that IBM Spectrum Protect for VE is correctly installed and
configured.

------------------------------------------------------------------------
ANS2414E

An error occurred when the hostname for the local machine was called.



Explanation:

The system call gethostname failed.

System action:

Processing stops.

User response:

Verify that the configuration of the network interface is correct.

------------------------------------------------------------------------
ANS2415E

An error occurred when the machine address information was called.



Explanation:

The system call getaddrinfo failed.

System action:

Processing stops.

User response:

Verify that the configuration of the network interface is correct.

------------------------------------------------------------------------
ANS2416E

An error occurred when the machine name information was called.



Explanation:

The system call getnameinfo failed.

System action:

Processing stops.

User response:

Verify that the configuration of the network interface is correct.

------------------------------------------------------------------------
ANS2417E

Unexpected communication method. Only TCP and TCPv6 are accepted.



Explanation:

An unexpected communication method was detected.

System action:

Processing stops.

User response:

Verify that the communication method for IBM Spectrum Protect is
correct. Use either TCP or TCPv6.

------------------------------------------------------------------------
ANS2418E

Unable to read or write to the local instant restore data. filename File
cannot be accessed or is damaged.



Explanation:

Instant access and instant restore operations require read/write access
on the local data mover to store data.

System action:

Processing stops.

User response:

To store the instant restore restore data, the data mover application
requires read and write access to the C:\Documents and
Settings\AllUsers\Application Data\Tivoli\TSM\ or
C:\ProgramData\Tivoli\TSM folder. Set the access rights to this
directory so that your user has the correct rights. If the file was
damaged it can be helpfull to replace the current version with the .bak
file.

------------------------------------------------------------------------
ANS2419E

The datastore does not have enough free space for the instant restore
operation.



Explanation:

The space on the selected datastore is not sufficient for the instant
restore operation.

System action:

Processing stops.

User response:

Increase the datastore space or choose a different datastore.

------------------------------------------------------------------------
ANS2420E

Cannot detect storage device information.



Explanation:

Storage device information cannot be retrieved.

System action:

Processing stops.

User response:

Ensure that the communication with the ESX host is working. Also, review
the log messages on the ESX host.

------------------------------------------------------------------------
ANS2421E

The iSCSI initiator cannot be detected on the hypervisor host.



Explanation:

The iSCSI initiator name of the hypervisor host cannot be detected.

System action:

Processing stops.

User response:

VMware: Review the log file on the ESX host to ensure that the
communication with it is working. Hyper-V: Ensure that the iSCSI
initiator service is running and working properly.

------------------------------------------------------------------------
ANS2422E

Cannot detect the iSCSI Host Bus Adapter.



Explanation:

The iSCSI adapter was not detected.

System action:

Processing stops.

User response:

Ensure that the communication with the ESX host is working. Also, review
the log messages on the ESX host.

------------------------------------------------------------------------
ANS2424E

Cannot find the ESX host 'ESXHOST' in the vCenter.



Explanation:

The specified ESX host cannot be found in the vCenter.

System action:

Processing stops.

User response:

Ensure that the specified ESX host is in the vCenter. Ensure that the
name of the ESX host is correct. Alternatively, specify another ESX
host.

------------------------------------------------------------------------
ANS2425E

Cannot connect to the ESX host 'ESXHOST'



Explanation:

A connection to the specified ESX host cannot be made

System action:

Processing stops.

User response:

Ensure that the specified ESX host is connected to the vCenter and the
network. Alternatively, specify another ESX host.

------------------------------------------------------------------------
ANS2426E

The ESX host 'ESXHOST' is not powered on.



Explanation:

The specified ESX host is not powered on.

System action:

Processing stops.

User response:

Turn on the power to the ESX host. Alternatively, specify another ESX
host.

------------------------------------------------------------------------
ANS2427E

The ESX host 'ESXHOST' is in maintenance mode.



Explanation:

The specified ESX host is in maintenance mode. A connection cannot be
made to this host.

System action:

Processing stops.

User response:

Change the ESX host back to normal mode and try again. Alternatively,
specify another ESX host.

------------------------------------------------------------------------
ANS2428E

The ESX host 'ESXHOST' is not connected.



Explanation:

The specified ESX host is not connected in the vCenter.

System action:

Processing stops.

User response:

Connect the ESX host in the vCenter and try again. Alternatively,
specify another ESX host.

------------------------------------------------------------------------
ANS2430E

Cannot find the datacenter 'DATACENTER'.



Explanation:

The specified Datacenter cannot be found in the vCenter.

System action:

Processing stops.

User response:

Ensure that the specified datacenter is in the vCenter. Alternatively,
specify another datacenter.

------------------------------------------------------------------------
ANS2431E

Cannot find the temporary datastore 'TEMPDATASTORE' on the ESX host
'ESXHOST'.



Explanation:

The specified temporary datastore cannot be found on the specified ESX
host.

System action:

Processing stops.

User response:

Ensure that the specified datastore is on the ESX host. Alternatively,
specify another datastore.

------------------------------------------------------------------------
ANS2432E

The temporary datastore 'TEMPDATASTORE' is the same as the target
datastore 'DATASTORE'.



Explanation:

The specified temporary datastore must be a different datastore than the
one where the machine is restored to. You must specify two different
datastores for Storage vMotion to work.

System action:

Processing stops.

User response:

Specify another datastore as a temporary datastore.

------------------------------------------------------------------------
ANS2433E

The '-vmtempdatastore' option must be specified for an instant restore
operation.



Explanation:

You must specify two different datastores for Storage vMotion to work.
Use the '-vmtempdatastore' option to specify a temporary datastore.

System action:

Processing stops.

User response:

Specify a temporary datastore.

------------------------------------------------------------------------
ANS2434E

The datastore 'DATASTORE' was not found on the host 'ESXHOST'.



Explanation:

The specified datastore cannot be found on the ESX host.

System action:

Processing stops.

User response:

Ensure that the specified datastore is on the ESX host. Alternatively,
specify another datastore.

------------------------------------------------------------------------
ANS2435E

IBM Spectrum Protect Recovery Agent detected the following failure while
attempting to mount a snapshot of VM 'VM' from disc='disk-label':
FBCxxxxE-error-message



Explanation:

The attempt to mount a VM disk as an iSCSI device failed.

System action:

The operation stops.

User response:

Check the Recovery Agent logs and the FBCxxxxE error message, resolve
the problem, and try the operation again.

------------------------------------------------------------------------
ANS2436E

IBM Spectrum Protect Recovery Agent detected the following failure while
trying to dismount a snapshot of VM 'VM' from target 'target':
FBCxxxxE-error-message



Explanation:

The snapshot for the specified VM could not be dismounted from the iSCSI
target.

System action:

The operation stops.

User response:

Check the Recovery Agent logs and the FBCxxxxE error message, resolve
the problem, and try the operation again.

------------------------------------------------------------------------
ANS2442W

The Linux mount proxy node information is not available.



Explanation:

The Windows mount proxy was unable to retrieve its partner Linux mount
proxy node information.

System action:

A connection to the Linux mount proxy is not established.

User response:

Ensure that the Linux mount proxy node is set up and the DSMCAD service
is running on the Linux mount proxy node. Then, try this operation
again.

------------------------------------------------------------------------
ANS2444E

Cannot find the datacenter for host 'ESXHOST'.



Explanation:

Unable to determine the datacenter where the ESX host is located.

System action:

The operation was stopped.

User response:

Check that the vCenter of the ESX host is in a datacenter and that the
user has the proper authority to access this information.

------------------------------------------------------------------------
ANS2445E

Virtual machine 'VM' is running. You cannot delete this VM.



Explanation:

You cannot delete a virtual machine that is running.

System action:

The operation was stopped.

User response:

Ensure that you have the proper authority to power off virtual machines,
then power off and delete the VM.

------------------------------------------------------------------------
ANS2447E

Failed to delete VM 'VM' from the ESX host.



Explanation:

You cannot delete the virtual machine form the ESX host.

System action:

The operation was stopped.

User response:

Ensure that you have the proper authority to delete virtual machines,
then delete the VM.

------------------------------------------------------------------------
ANS2448E

Mount command failed. Command wasCOMMAND Shell command returned:RESULT



Explanation:

The mount command was not successful.

System action:

The operation was stopped.

User response:

Determine the problem from the error details returned for the mount
command. Resolve the problem, then run the command again.

------------------------------------------------------------------------
ANS2452E

num_discovered iSCSI devices were discovered on the ESX host, while
num_mounted were expected.



Explanation:

After the ESX host bus adapter was scanned, the number of devices that
were discovered is different from the number of mounted devices.

System action:

The Instant Restore or Instant Access process is stopped.

User response:

Verify that the IBM Spectrum Protect mount is configured to use the
correct ESX host IP. To clean the environment, you must run the cleanup
process.

------------------------------------------------------------------------
ANS2453E

An error occurred when the host bus adapter was scanned.



Explanation:

An error occurred when the ESX host bus adapter was scanned.

System action:

The Instant Restore, Instant Access, or cleanup process is stopped.

User response:

Run the cleanup process after you fix any problems with the ESX host bus
adapter.

------------------------------------------------------------------------
ANS2454E

An error occurred when the iSCSI target target_name was disconnected
from the ESX host bus adapter.



Explanation:

An error occurred when a specific iSCSI target was disconnected from the
ESX host bus adapter.

System action:

The cleanup operation is stopped.

User response:

Run the cleanup process after you fix any problems with the ESX host bus
adapter.

------------------------------------------------------------------------
ANS2455I

The virtual machine has been started. You can use the machine after it
has booted, or you can connect to it and manage its settings through the
vCenter console.



Explanation:

The virtual machine is being started.

System action:

Processing continues.

User response:

While the boot is in progress, you can connect to the virtual machine
and view or manage BIOS settings, manage the bootloader options, or
perform other tasks. After the boot process completes, you can use the
virtual machine and its applications and resources.

------------------------------------------------------------------------
ANS2462E

Unable to start the vMotion task for virtual machine 'vm_name'.



Explanation:

An instant restore of the specified virtual machine was attempted but
failed. The client could not start a vMotion task to migrate the virtual
machine.

System action:

The Instant Restore operation stops.

User response:

Examine the client dsmerror.log file to see if a log entry indicates why
the vMotion task failed. Additional information about the failure might
also be available in the vCenter server, on the Task and Events tab for
the ESXi host that you were migrating the VM from. If possible, use the
log and event records to determine what caused the vMotion task to fail
and fix it. Then, clean up the virtual machine (use the Restore VM
command with the -VMRESToretype=VMCLeanup option) and restart the
vMotion task. If you cannot restart the task, suspend the virtual
machine and use the vSphere web client to start the virtual machine
migration from one host to another.

------------------------------------------------------------------------
ANS2463W

Instant Restore information cannot be saved on the server.



Explanation:

An error occurred when Instant Restore information was being saved on
the server. The Instant Restore process is still running.

System action:

The operation continues.

User response:

The client dsmerror.log file might contain information to help
troubleshoot the reason for this error. Let the Instant Restore process
complete on its own. You might need to run a clean up operation on the
virtual machine. Use the Restore VM command, and specify the
-VMRESToretype=VMCLeanup option.

------------------------------------------------------------------------
ANS2464E

Unable to delete Instant Restore information from the server.



Explanation:

An error occurred while attempting to delete Instant Restore information
from the server.

System action:

The Instant Restore operation continues.

User response:

The most likely reason for this error is that an ANS2463W warning
previously occurred, and there is no data to delete. If you have not
previously seen an ANS2463W message, the client dsmerror.log file might
contain information to help you troubleshoot this error. Clean up the
virtual machine to remove old information from the server. Use the
Restore VM command, and specify the -VMRESToretype=VMCLeanup option.

------------------------------------------------------------------------
ANS2465E

An error occurred during a storage vMotion operation.



Explanation:

A storage vMotion task failed while trying to migrate a running virtual
machine.

System action:

The Instant Restore operation stops.

User response:

Examine the client dsmerror.log file to see if a log entry indicates why
the vMotion task failed. Additional information about the failure might
also be available in the vCenter server, on the Task and Events tab for
the ESXi host that you were migrating the VM from. If possible, use the
log and event records to determine what caused the vMotion task to fail
and fix it. Then clean up the virtual machine (use the Restore VM
command with the -VMRESToretype=VMCLeanup option) and restart the
vMotion task. If you cannot restart the task, suspend the virtual
machine and use the vSphere web client to start the VM migration from
one host to another.

------------------------------------------------------------------------
ANS2466W

If you continue you will lose all data created on this virtual machine.
The virtual machine will also be removed from the ESXi host. Are you
sure that you want to do this? Press Y the virtual machine data and
remove it from the ESXi host. Press any other key to continue without
deleting data or the VM.



Explanation:

You are performing an operation that, if allowed to continue, will
delete all data that was created after this virtual machine was created.

System action:

If Y is pressed, the Instant Restore operation is stopped, and a cleanup
operation is performed

User response:

Respond to the prompt. Press Y to destroy all data and delete the
virtual machine from the server. Press any other key to continue without
deleting.

------------------------------------------------------------------------
ANS2467W

Unable to delete the snapshot that was created for the virtual machine
named 'vm_name'



Explanation:

When a virtual machine is restored by an instant restore operation, a
snapshot is created to store all data that were written to the virtual
machine disks. When the restore is completed, the ESXi host deletes the
snapshot. The snapshot for the specified virtual machine could not be
deleted.

System action:

Operation continues.

User response:

Examine the vSphere log to determine why is it not possible to delete
the snapshot and resolve the problems that prevent the deletion. Then,
delete the snapshot by using the snapshot manager.

------------------------------------------------------------------------
ANS2468E

The necessary iSCSI targets could not be found on the ESX host.



Explanation:

An instant restore operation was initiated and one or more of the
required iSCSI targets could not be found on the ESXi host.

System action:

Processing stops.

User response:

Verify that the IP address that was specified with the
-VMISCSISERVERADDRESS parameter is correct.

------------------------------------------------------------------------
ANS2469E

Unable to remove the iSCSI target.



Explanation:

An error occurred while trying to remove an iSCSI target.

System action:

Processing stops.

User response:

Check vSphere client log file for the reason this operation failed and
remove the iSCSI target. To remove the failed iSCSI static targets go to
your ESXi host Configuration -> Storage Adapters -> Select the iSCSI
Adapter -> right click on it -> Click Properties -> Static Discovery and
select the failed iSCSI targets and remove them.

------------------------------------------------------------------------
ANS2471E

Unable to stop the vMotion Task 'task'.



Explanation:

The specified vMotion task could not be stopped.

System action:

The instant restore operation is stopped.

User response:

Examine the vSphere log to determine why the migration cannot be
stopped. Resolve the problem and cancel the vMotion task. Then, use the
-VMRESToretype=VMFULLCleanup option on the Restore VM command to remove
any files or other resources that were created by the instant restore
operation.

------------------------------------------------------------------------
ANS2472E

Cannot detect the LUN for the attached RDM devices for virtual machine
named vmname'. The restore operation for this virtual machine cannot be
completed.



Explanation:

The LUNs for the RDM devices use by the specified virtual machine are
either missing, are mapped to an other machine, or the device name and
the LUN do not match.

System action:

The restore operation is stopped.

User response:

For restore operations where vmrestoretype=instantrestore or
vmrestoretype=instantaccess, verify that the iSCSI server address and
the VMkernel port binding match. Verify this information by checking the
following things: 1. Check the Data Protection for VMware configuration
file RecoveryAgent.conf and verify that the iSCSI server address is
bound to the correct network card and segment. 2. Use the vSphere client
to connect to your ESXi host. In vSphere, select Configuration->Storage
Adapters to display a list of the iSCSI adapters. Right click the
adapter that you are verifying. Then, select Properties ->Network
Configuration. In the VMkernel Port Bindings Details output, verify that
the VMkernel Adapter is on the same subnet that the datamover node is
on.

------------------------------------------------------------------------
ANS2473E

Unable to create a Snapshot of the virtual machine named 'vm_name'.



Explanation:

An instant restore operation was attempted for the specified virtual
machine. The snapshot that is used to restore the virtual machine could
not be created.

System action:

The instant restore operation stops.

User response:

Examine the vCenter logs to determine why the snapshot could not be
created and try the instant restore operation again.

------------------------------------------------------------------------
ANS2474E

Unable to cleanup after an instant restore operation for the virtual
machine named 'vm_name', because vMotion task is still running.



Explanation:

An instant restore operation is still running for the specified virtual
machine.

System action:

The cleanuop operation stops.

User response:

Use the query command to check on the status of the instant restore
operation. Examine the vCenter to determine the status of the vMotion
task. If you want to stop the instant restore, cancel the operation in
the DP VMware GUI or stop the vMotion task from the vCenter interface.
Then, start the cleanup operation again.

------------------------------------------------------------------------
ANS2476E

A restore location must be specified via the TARGETPATH option when
restoring to a different virtual machine name.



Explanation:

A restore location must be specifed via the TARGETPATH option when
restoring to a different virtual machine name specified by the VMNAME
option.

System action:

The virtual machine is not restored.

User response:

Specify a restore location with the TARGETPATH option.

------------------------------------------------------------------------
ANS2484I

Virtual Machine 'vm_name' was successfully restored



Explanation:

The Virtual Machine was successfully restored.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS2485E

Cannot query the IBM Spectrum Protect server to get instant access
information



Explanation:

The server did not respond to the query for instant access information.

System action:

The virtual machine cleanup operation is halted.

User response:

Examine the dsmerror.log file and the IBM Spectrum Protect server
activity logs to determine the cause of this error.

------------------------------------------------------------------------
ANS2488E

Error mounting the iSCSI device.



Explanation:

An error occurred while trying to mount the iSCSI device. Check the
dsmerror.log file to determine the cause of this error.

System action:

The operation was stopped.

User response:

No action is required.

------------------------------------------------------------------------
ANS2490E

The VM 'VM' cannot be powered off.



Explanation:

The specified virtual machine cannot be powered off. Attempts to clean
up the resources that were created to restore the virtual machine cannot
be completed.

System action:

The restore operation was stopped.

User response:

Turn off the virtual machine by using your hypervisor management client.

------------------------------------------------------------------------
ANS2513I

The virtual machine has no disks attached



Explanation:

The virtual machine exists, but it does not have any disks attached. The
machine can be cleaned up.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS2514I

Disk status cannot be determined



Explanation:

It is not possible to determine the status of this disk.

System action:

None.

User response:

Examine the vSphere Client log to determine what is wrong with the
machine. If the log entries do not reveal problems with this virtual
machine, inspect the virtual machine in the vSphere Client to determine
why the disk status cannot be determined. See the vSphere documentation
for additional guidance, if necessary.

------------------------------------------------------------------------
ANS2515I

No additional information is available for this virtual machine. The
virtual machine was deleted or it has been renamed



Explanation:

Information about the virtual machine cannot be found on the ESXi host.
The virtual machine might have been previously deleted or renamed.

System action:

None.

User response:

Use the vSphere Client to determine what happened to this virtual
machine. If the virtual machine was renamed, make sure that it is
running without errors before you clean up the temporary resources, by
using the Restore VM command with the -VMRESToretype=VMCLEANUP option.

------------------------------------------------------------------------
ANS2516E

VMware storage vMotion operation failed. Restart the storage vMotion
operation manually, by using the vSphere web client, to finish the
restore operation. Refer to the documentation to get details about the
manual recovery process.



Explanation:

IBM Spectrum Protect Changes to the restored VM might not be permanently
saved.

System action:

IBM Spectrum Protect Automatic cleanup cannot be performed for the
failed vMotion operation.

User response:

Examine the event logs to determine the cause for the failure. Fix any
problems and restart the storage vMotion operation manually, by using
the vSphere web clien, to finish the restore operation. Refer to the
vMotion documentation to get details about the manual recovery process.

------------------------------------------------------------------------
ANS2517E

Cannot query the IBM Spectrum Protect server to get instant restore
information



Explanation:

The server did not respond to the query for instant restore information.

System action:

The virtual machine clean up operation stops.

User response:

Examine the dsmerror.log file and the IBM Spectrum Protect server
activity logs to determine the cause of this error.

------------------------------------------------------------------------
ANS2519E

The disk \"diskname\" is an iSCSI device with an inactive path. Powering
off the virtual machine will cause the ESXi server to hang. The clean up
operation has been stopped to prevent this. Use the Query VM command
with the -detail option to obtain detailed status information about the
virtual machine. Correct the path so that the iSCSI state is active and
then try running the VMFULLCleanup operation again.



Explanation:

A running virtual machine that has an inactive iSCSI device cannot be
cleaned up.

System action:

The virtual machine full clean up (VMRESTORType=VMFULLCLeanup) operation
stops.

User response:

For information about troubleshooting inactive iSCSI resources, search
the VMware support pages by using a search string like "troubleshooting
iSCSI" or "inactive iSCSI".

------------------------------------------------------------------------
ANS2520E

The disk \"diskname\" is not a physical device. An instant restore clean
up was stopped because vMotion could not restore all virtual machine
data.. Use the Query VM command with the -detail option to obtain
information about state of the specified disk. Use vMotion to manually
migrate the virtual machine devices and then try the clean up operation
again.



Explanation:

An instant restore clean up operation (-VMRESToretype=VMCLeanup) cannot
complete because vMotion could not restore all of the virtual machine
resources.

System action:

The virtual machine clean up operation stops.

User response:

Use the VMware documentation to determine how to use vMotion to migrate
the virtual machine. Then, try the clean up operation again by using the
Restore VM command with the -VMRESToretype=VMCLeanup option. If you do
not want to restore this virtual machine, use the Restore VM command
with the -VMRESTORType=VMFULLCLeanup option to remove the virtual
machine and all of its resources.

------------------------------------------------------------------------
ANS2521E

Instant restore operations require valid licenses for both vMotion and
storage vMothion.



Explanation:

Instant restore works only when the ESXi host has a valid license for
both vMotion and storage vMotion

System action:

The instant restore operation is stopped.

User response:

Obtain the necessary license from VMware and assign the license to the
ESXi host.

------------------------------------------------------------------------
ANS2522W

A user canceled the 'operationType' operation .



Explanation:

A user canceled the restore/backup operation .

System action:

The operation is stopped

User response:

No response is required.

------------------------------------------------------------------------
ANS2523E

The virtual machine named vm cannot not be restored to the same
configuration it had when it was backed up. IBM Spectrum Protect will
reconfigure the virtual machine to include only the most essential
configuration information and retry the restore operation.



Explanation:

The restore operation failed to restore the virtual machine to its
original configuration. This error can occur if there is incompatibility
between the hardware that the virtual machine was on when it was backed
up, and the hardware on the physical host where it was restored. IBM
Spectrum Protect will reconfigure the virtual machine to eliminate all
but most necessary configuration information (video and virtual disks)
and retry the restore operation.

System action:

The restore operation continues, using the reconfigured virtual machine
information.

User response:

When the restore completes, reconfigure the restored virtual machine to
your requirements.

------------------------------------------------------------------------
ANS2524E

An attempt to mount a snapshot of VM 'disk' from disk 'vm' failed. The
volume might be mounted from another operation and cannot be remounted.



Explanation:

An attempt to mount a snapshot of VM 'disk' from disk 'vm' failed. The
volume might be mounted from another operation and cannot be remounted..

System action:

The mount operation stops.

User response:

Dismount the volume by running a mount cleanup operation, then run the
mount operation again.

------------------------------------------------------------------------
ANS2525E

The created virtual machine cannot be powered on.



Explanation:

The hypervisor is unable to power on the created virtual machine.

System action:

The operation will be rolled back and stopped.

User response:

Check the dsmerror.log file for more information. Check the hypervisor
log to determine what error occurred during the power-on process of the
virtual machine.

------------------------------------------------------------------------
ANS2526W

The VM_DONT_QUIESCE_ON_SNAPSHOT testflag is deprecated for full VM
backups. Use the INCLUDE.VMSNAPSHOTATTEMPTS option to attempt snapshots
with "VMware Tools file system quiescing and application (VSS) quiescing
disabled".



Explanation:

The VM_DONT_QUIESCE_ON_SNAPSHOT testflag overrides the
INCLUDE.VMSNAPSHOTATTEMPTS option. As a result, all snapshot attempts
are with VMware Tools file system quiescing and application (VSS)
quiescing disabled.

System action:

Use the INCLUDE.VMSNAPSHOTATTEMPTS option to specify snapshot attempts
with VMware Tools file system quiescing and application (VSS) quiescing
disabled.

User response:

See the INCLUDE.VMSNAPSHOTATTEMPTS documentation for information about
how to set this option.

------------------------------------------------------------------------
ANS2527I

The login request started.



Explanation:

The user submitted a request to log in to the file restore interface.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2528I

The login request was completed successfully. VM-OS=os
Data-Center=datacenter



Explanation:

The user successfully logged into the file restore interface.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2529I

The login request failed.



Explanation:

An error occurred while logging into the file restore interface.

System action:

None.

User response:

Review the log for related login and authentication errors.

------------------------------------------------------------------------
ANS2530I

The log out request started.



Explanation:

The user either logged out of the file restore interface or the file
restore interface timed out due to inactivity.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2531I

The log out request was completed successfully.



Explanation:

The user was successfully logged out of the file restore interface.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2532I

The log out request failed.



Explanation:

An error occurred while logging out of the file restore interface.

System action:

Log out processing was completed with errors.

User response:

Review the log for related log out errors.

------------------------------------------------------------------------
ANS2533I

The mount request started. Backup-ID=backupId



Explanation:

The user selected a backup to load.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2534I

The mount request was completed successfully. Backup-Date=backupDate
Mount-ID=mountId



Explanation:

The backup was successfully mounted.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2535I

The mount request failed. Backup-Date=backupDate Mount-ID=mountId



Explanation:

An error occurred while mounting the backup.

System action:

Mount processing stops.

User response:

Review the log for related mount errors.

------------------------------------------------------------------------
ANS2536I

The dismount request started. Backup-ID=backupId Backup-Date=backupDate
Mount-ID=mountId



Explanation:

The user either selected another backup to load or logged out of the
file restore interface.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2537I

The dismount request was completed successfully. Backup-ID=backupId
Backup-Date=backupDate Mount-ID=mountId



Explanation:

The backup was successfully dismounted.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2538I

The dismount request failed. Backup-ID=backupId Backup-Date=backupDate
Mount-ID=mountId



Explanation:

An error occurred while dismounting the backup.

System action:

Dismount processing stops.

User response:

Review the log for related dismount errors.

------------------------------------------------------------------------
ANS2539I

The restore request started. Selection-Size=selectionSize
Alt-Destination=altDestination



Explanation:

The user submitted a request to restore files, directories, or both from
a backup.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2540I

The restore request was completed successfully.



Explanation:

The restore request was successfully submitted.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2541I

The restore request failed.



Explanation:

An error occurred during the restore request.

System action:

Restore processing stops.

User response:

Review the log for related restore errors.

------------------------------------------------------------------------
ANS2542I

The final restore processing statistics are available. Total
Objects=totalObjects Total Restored=totalRestored Total
Failed=totalFailed Total Bytes=totalBytes Completion Code=completionCode



Explanation:

The restore processing statistics contain completion codes that indicate
the state of the restore operation.

*  A completion code of 0 indicates that all items were successfully
   restored.

*  A completion code of 8 indicates that the restore operation was
   completed but some items were not restored.

*  A completion code of 12 indicates that the restore operation was
   unsuccessful.



System action:

None.

User response:

If the completion code is not 0, review the logs for related restore
errors.

------------------------------------------------------------------------
ANS2543E

A status of 'state' is returned because the Microsoft iSCSI Initiator
Service is not running.



Explanation:

The Microsoft iSCSI Initiator Service is not running.

System action:

Operation cannot continue.

User response:

Start the Microsoft iSCSI Initiator Service.

------------------------------------------------------------------------
ANS2544E

A status of 'state' is returned because the Microsoft iSCSI Initiator
Service is not installed.



Explanation:

The Microsoft iSCSI Initiator Service is not installed.

System action:

Operation cannot continue.

User response:

Install the Server Role 'File and iSCSI Services'

------------------------------------------------------------------------
ANS2545I

A crash consistent snapshot is created for the backup of virtual machine
'VM name'.



Explanation:

A crash consistent snapshot is created for the backup of the virtual
machine.

System action:

The virtual machine backup continues.

User response:

If an application consistent backup was requested but failed, check the
dsmerror.log file and the Hyper-V event logs for the reason for the
failure.

------------------------------------------------------------------------
ANS2546W

An incorrect disk location label 'location label' is specified with
option 'option name'



Explanation:

The disk location label must begin with 'SCSI' or 'IDE' followed by the
controller number and device location number.

System action:

The specified disk location label is ignored.

User response:

Verify that the disk location label is correctly specified. Check the
disk location label format. Ensure that the label begins with 'SCSI' or
'IDE', and is followed by the controller number and device location
number, which are expressed as digital numbers. For example, 'SCSI 0 0'
or 'IDE 0 1'.

------------------------------------------------------------------------
ANS2547E

The Hyper-V role is not installed on the specified Windows server host
'host'.



Explanation:

Hyper-V is a feature of the Windows server that needs to be explicitly
enabled by installing the Hyper-V role.

System action:

Processing stops.

User response:

Install the Hyper-V role on the Windows server host. Alternatively,
specify another Hyper-V host.

------------------------------------------------------------------------
ANS2548E

The status query for Hyper-V on the host 'host' failed due to lack of
privileges.



Explanation:

The User ID running this command does not have the necessary privileges
to access Hyper-V information on the host.

System action:

Processing stops.

User response:

Ensure that the current User ID is granted the necessary privileges.
Alternatively, try another user or specify another host.

------------------------------------------------------------------------
ANS2549E

The connection to Hyper-V on host 'host' failed with rc= rc.



Explanation:

The connection to the Hyper-V host failed with a system specific error.

System action:

Processing stops.

User response:

Ensure that the network is configured correctly. Ensure that the Hyper-V
host is connected to the network, is configured correctly, and is
powered on.

------------------------------------------------------------------------
ANS2550W

The virtual machine backup operation will skip physical (pass-through)
disk 'drive name' on drive number 'drive number'



Explanation:

Physical disks cannot be backed up during virtual machine backup
operations using Resilient Change Tracking (RCT).

System action:

The virtual machine backup operation continues without backing up the
physical disks.

User response:

Identify the physical disks and back them up by using another method.

------------------------------------------------------------------------
ANS2551W

Cannot remove recovery checkpoint for virtual machine 'VM-name'.



Explanation:

IBM Spectrum Protect cannot remove the recovery checkpoint that was
created during backup.

System action:

The virtual machine backup continues.

User response:

Remove the recovery checkpoint manually after backup.

------------------------------------------------------------------------
ANS2552E

Backup of a virtual machine that has a shared virtual hard disk is not
supported.



Explanation:

IBM Spectrum Protect does not support backup of a virtual machine that
has a shared virtual hard disk.

System action:

The backup will not occur.

User response:

Use alternative backup method, such as in-guest backup.

------------------------------------------------------------------------
ANS2553W

Resilient Change Tracking (RCT) has been turned off for disk 'drive
name'. Instead of an incremental backup, a full backup is run on this
disk.



Explanation:

RCT has been turned off for the disk. If disk RCT is disabled, no
changes will be tracked after it is disabled, and existing change
tracking data will be lost. Therefore, an incremental backup cannot run.

System action:

Instead of an incremental backup, a full backup will run for this disk.
RCT will be turned on automatically for this disk during the backup.

User response:

No action is required.

------------------------------------------------------------------------
ANS2554W

No previous backups are found for disk 'drive name'. Instead of an
incremental backup, a full backup is run for this disk.



Explanation:

No backups are found for the disk on the IBM Spectrum Protect server.
Therefore, an incremental backup cannot run.

System action:

Instead of an incremental backup, a full backup will run for this disk.

User response:

No action is required.

------------------------------------------------------------------------
ANS2555W

The incremental backup operation was changed to a full backup for
virtual machine 'vmname' because no previous backups are found on the
IBM Spectrum Protect server.



Explanation:

No backups are found for the VM on the IBM Spectrum Protect server, so
an incremental backup cannot be run. A full backup will be run instead.

System action:

A full backup operation will proceed for the VM.

User response:

No user action is required.

------------------------------------------------------------------------
ANS2556E

The cluster operating system is in the process of a rolling upgrade and
working in mixed-OS mode. Virtual machine 'vm_name' cannot be backed up
until the upgrade completes.



Explanation:

The cluster operation system is using rolling upgrade, including working
in mixed-OS mode. The backup cannot run during this upgrade operation.

System action:

The rolling upgrade continues, but the virtual machine is not backed up.

User response:

Wait for the rolling upgrade to complete, then start the virtual machine
backup again.

------------------------------------------------------------------------
ANS2557E

The virtual machine 'VM-name' contains one or more physical
(pass-through) disks. Backups are not supported in this configuration.
Specify the 'vmprocessvmwithphysdisks=yes' option to exclude these disks
from the backup.



Explanation:

Physical disks are not included in Resilient Change Tracking (RCT)
backup operations so they cannot be backed up by the IBM Spectrum
Protect client.

System action:

The virtual machine is not backed up.

User response:

Turn off the virtual machine and change the physical disks to virtual
mode or remove them from the virtual machine. Alternatively, specify the
'vmprocessvmwithphysdisks=yes' option to exclude these disks from backup
operations.

------------------------------------------------------------------------
ANS2558E

The virtual machine 'VM-name' contains one or more physical
(pass-through) disks. However, these physical disks are not all
available during the restore operation and the restore failed. Specify
the 'vmskipphysdisks=yes' option to exclude these disks from the
restore.



Explanation:

Physical disks are not all available during restore operations so the
IBM Spectrum Protect client does not restore the virtual machine
successfully.

System action:

The restore operation failed.

User response:

Check the physical disks and make sure that they are available.
Alternatively, specify the 'vmskipphysdisks=yes' option to exclude these
disks from restore operations.

------------------------------------------------------------------------
ANS2559E

The remote attach operation failed.



Explanation:

An error occurred while trying to attach the IBM Spectrum Protect
virtual volume snapshot to the mount proxy. The restore operation cannot
continue.

System action:

Processing stops.

User response:

Check the mount proxy dsmerror.log file for information about how to
resolve this issue.

------------------------------------------------------------------------
ANS2560W

The remote detach operation failed.



Explanation:

An error occurred while trying to detach the IBM Spectrum Protect
virtual volume snapshot from the mount proxy virtual machine. The
restore operation will continue.

System action:

Processing continues.

User response:

Check the mount proxy dsmerror.log file for information about how to
resolve this issue and manually remove resources that remain after the
failed detach operation.

------------------------------------------------------------------------
ANS2561I

The snapshot for virtual machine 'vmname' failed due to a temporary
condition. The snapshot will be retried.



Explanation:

The snapshot for the virtual machine failed due to a temporary
condition. The snapshot will automatically be retried.

System action:

Processing continues to the next virtual machine.

User response:

No action is required.

------------------------------------------------------------------------
ANS2563I

Starting retry snapshot number retryCount for virtual machine 'vmname'.



Explanation:

The previous snapshot of the virtual machine finished with an error.
Another snapshot for of the virtual machine will be attempted.

System action:

Another snapshot attempt of the virtual machine is started.

User response:

No action is required.

------------------------------------------------------------------------
ANS2564I

Gathering virtual machine information...



Explanation:

The client is beginning the process of gathering information about the
virtual machines to be processed. This length of time needed depends
upon the number of virtual machines in the backup.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2565I

Creating virtual machine snapshot...



Explanation:

The client is beginning the process of creating a snapshot for the
virtual machines in the backup. This length of time needed depends upon
the number of virtual machines in the backup.

System action:

Processing continues.

User response:

No action required.

------------------------------------------------------------------------
ANS2566E

The snapshot of virtual machine 'vmname' failed after the maximum number
of retries (retryCount) was reached.



Explanation:

Several attempts to take a snapshot failed. Because the maximum number
of retries was reached, the operation will not be retried.

System action:

The snapshot of the virtual machine finished with an error. Processing
continues to the next virtual machine..

User response:

Check the Windows event log for the reason for the failure. Resolve the
problem, and run the backup operation again.

------------------------------------------------------------------------
ANS2567E

The backup of vm-name failed because another backup is currently in
progress on the Hyper-V manager host machine.



Explanation:

There is a concurrent backup going on the Hyper-V manager host machine.

System action:

The backup operation stops.

User response:

Try the backup operation again after the current backup ends.
Alternatively, if no other backups are in progress, there might be a
recovery checkpoint created by a previous failed backup. In that case,
remove the checkpoint with the Remove-VMCheckPoint cmdlet, and try the
backup operation again.

------------------------------------------------------------------------
ANS2568I

The backup request for VM 'vmName' started.



Explanation:

The user submitted a request to back up a VM.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2569I

The backup request was completed successfully.



Explanation:

The backup request was successfully submitted.

System action:

None.

User response:

No action is required.

------------------------------------------------------------------------
ANS2570I

The backup request failed.



Explanation:

An error occurred during the backup request.

System action:

Backup processing stops.

User response:

Review the log for related backup errors.

------------------------------------------------------------------------
ANS2572I

The restore request started for vm 'VmName'.



Explanation:

The user submitted a request to restore vm.

System action:

Processing continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2573I

The maximum number of restore sessions specified by the
VMMAXRESTORESESSIONS option may not be sufficient for the restore
operation. Each virtual machine restored in parallel must be allocated
at least one session per disk restored in parallel.



Explanation:

The value of the VMMAXRESTORESESSIONS option must be at least the value
of the VMRESTOREMAXPARALLELVMS option multiplied by the value of the
VMMAXRESTOREPARALLELDISKS option. This ensures that at least one session
may be allocated for each disk being restored.

System action:

The maximum number of sessions available to the restore operations is
set to the value of the VMMAXRESTOREPARALLELDISKS option multiploed by
the VMMAXRESTOREPARALLELVMS option. Orocessing continues.

User response:

None.

------------------------------------------------------------------------
ANS2574I

The maximum number of sessions available to the restore operation has
been adjusted to adjusted_value. At least one session must be allocated
for each disk being restored.



Explanation:

The value of the VMMAXRESTORESESSIONS option is less than value of the
VMMAXRESTOREPARALLELVMS option multiplied by the value of the
VMMAXRESTOREPARALLELDISKS option. This may not be sufficient for the
restore operation.

The value of VMMAXRESTORESESSIONS is adjusted so that each virtual
machine restored in parallel has at least one available session per disk
restored in parallel.

System action:

Maximum session value has been adjusted.

User response:

None.

------------------------------------------------------------------------
ANS2575I

The process to collect the system logs is started in background.
Depending on the size of the log files, this might take some time to
complete. As soon as this process is complete, you will be prompted by
your browser to download the following file: file name



Explanation:

The user requested system log files for problem determination. The logs
will be collected and provided for download.

System action:

The logs are collected and the download will start soon.

User response:

Wait for the download to complete. Locate the file where the browser
stores downloaded files.

------------------------------------------------------------------------
ANS2576I

The process to collect the system logs is still running in background.
Depending on the size of the log files, this might take some time to
complete. As soon as this process is complete, you will be prompted by
your browser to download the following file: file name



Explanation:

The user has already requested system log files for problem
determination, but the process to collect the system logs is still
running. The logs will be provided for download once ready.

System action:

The download of system logs will start soon.

User response:

Wait for the download to complete. Locate the file where the browser
stores downloaded files.

------------------------------------------------------------------------
ANS2577I

The download of system logs is currently disabled. You can ask the
system administrator to enable it by setting the option 'option name and
value' in the 'configuration file name' configuration file. Please note
that you have to sign in again for the option to take effect.



Explanation:

The download of system logs is disabled.

System action:

The request has been canceled.

User response:

In order to download the logs files the system administrator needs to
enable the option by editing the FR API configuration file specified in
the message text. User need to sign out and sign in again for the option
to take effect. A restart of the Liberty server is not required.

------------------------------------------------------------------------
ANS2580E

The query for Hyper-V information on host 'host' failed with rc= rc.



Explanation:

The query for Hyper-V status information failed with a system specific
error.

System action:

Processing stops.

User response:

Verify the health and configuration of the specified host.

------------------------------------------------------------------------
ANS2581E

The Hyper-V host is reporting issues that prevent it from proceeding
with the operation.



Explanation:

Issues have been detected on the specified Hyper-V host. The system
cannot support the intended operation.

System action:

Processing stops.

User response:

Verify that the installation and configuration of the Hyper-V host
system is correct. Check the dsmerror.log file for additional
information, and contact the IBM Spectrum Protect administrator with the
information in the messages that have been sent.

------------------------------------------------------------------------
ANS2582E

The Hyper-V host 'host' is faulty: EnabledState = EnabledState
(expected: 2), HealthState = HealthState (expected: 5),
OperationalStatus = OperationalStatus (expected: 2).



Explanation:

A faulty state has been detected for the specified Hyper-V host.

System action:

Processing stops.

User response:

Verify the health and configuration of the specified host.

------------------------------------------------------------------------
ANS2583E

The restore target path 'state' does not have enough free space for the
restore operation.



Explanation:

The space on the selected restore target path is not sufficient for the
restore operation.

System action:

Processing stops.

User response:

Increase the free space to at least 50 MB in the restore target path, or
choose a different path.

------------------------------------------------------------------------
ANS2584E

The restore target path 'state' could not be found, or the path has not
been created.



Explanation:

The selected restore target path could not be found, or the path could
not be created.

System action:

Processing stops.

User response:

Create the restore target path manually or choose a different path.

------------------------------------------------------------------------
ANS2585E

num_discovered iSCSI devices were discovered on the Hyper-V host
Microsoft iSCSI Initiator, while num_mounted were expected.



Explanation:

The logged in iSCSI targets in the Microsoft iSCSI Initiator do not
match the amount of expected logged in iSCSI targets.

System action:

Operation cannot continue.

User response:

Verify that the IBM Spectrum Protect mount is configured to use the
correct Hyper-V host IP. To clean the environment, you must run the
cleanup process.

------------------------------------------------------------------------
ANS2586E

The application consistent snapshot of virtual machine 'vmname' failed
because the volume shadow copy requestor integration service is not
enabled on the guest virtual machine.



Explanation:

The volume shadow copy requestor integration service must be enabled on
the guest virtual machine in order to take application consistent
snapshots.

System action:

The snapshot of the virtual machine finished with an error. Processing
continues to the next virtual machine.

User response:

Contact the Hyper-V administrator to turn on the volume shadow copy
requestor integration service of the Hyper-V virtual machine. When the
service is enabled, run the VM backup operation again.

------------------------------------------------------------------------
ANS2587E

The application consistent snapshot of virtual machine 'vmname' failed,
possibly because the volume shadow copy requestor integration service is
not installed or is not running on the guest virtual machine.



Explanation:

The volume shadow copy requestor integration service must be installed
and enabled on the guest virtual machine in order to take an application
consistent snapshot.

System action:

The snapshot of the virtual machine finished with an error. Processing
continues to the next virtual machine.

User response:

Contact the Hyper-V administrator to install and configure the volume
shadow copy requestor integration service on the Hyper-V virtual
machine. When the service is installed and enabled, run the VM backup
operation again. Alternatively, perform a crash consistent snapshot of
the virtual machine.

------------------------------------------------------------------------
ANS2600S

Browser trying to establish connection to client; received socket
exception: exception-name



Explanation:

The browser received the exception when trying to connect to the IBM
Spectrum Protect client computer.

System action:

The operation ends.

User response:

Validate that the LAN is up and that you are trying to connect to the
correct port number.

Check the error logs for any additional information: dsmerror.log,
dsmwebcl.log, or dsmj.log. The default location of these logs is the
installation directory of the backup-archive client.

Ensure that the command line client runs without problems. Test the
command line client with a command like "dsmc q sess".

------------------------------------------------------------------------
ANS2601S

The browser tried to connect to the client and received unknown host
exception: exception-name



Explanation:

The browser received the exception when trying to connect to the IBM
Spectrum Protect client machine.

System action:

The operation ends.

User response:

Try the operation again. If it persists, determine what might be causing
this kind of problem. For example, determine if your LAN went down, or
verify if you are trying to connect to the correct IBM Spectrum Protect
client machine.

------------------------------------------------------------------------
ANS2602S

The browser tried to connect to the client and received I/O exception:
exception-name



Explanation:

The browser received the exception when trying to connect to the IBM
Spectrum Protect client machine.

System action:

The IBM Spectrum Protect operation ends.

User response:

Determine what might be causing this kind of exception. Try the
operation again, and check if the LAN is down.

------------------------------------------------------------------------
ANS2603S

The browser tried to connect to the client and received exception:
exception-name



Explanation:

The browser received the exception when trying to connect to the IBM
Spectrum Protect client machine.

System action:

The IBM Spectrum Protect operation ends.

User response:

Determine what might be causing this kind of an exception. Determine if
the LAN is down, or if the IBM Spectrum Protect client acceptor on the
IBM Spectrum Protect machine is up and running.

------------------------------------------------------------------------
ANS2604S

The Web client agent was unable to authenticate with the server.



Explanation:

The Web client agent was unable to authenticate with the IBM Spectrum
Protect server.

System action:

The operation ends.

User response:

One possible solution is to run the command line client so that the
client password can be re-entered. Another approach is to check the
error log on the IBM Spectrum Protect Web client agent system for any
relevant messages.

------------------------------------------------------------------------
ANS2605S

Browser could not re-establish connection to client; received protocol
error.



Explanation:

The browser received a protocol error trying to re-connect to the client
machine.

System action:

The operation ends.

User response:

Determine what might be causing this kind of an error. Determine if the
browser and the IBM Spectrum Protect client code might be out of sync.

------------------------------------------------------------------------
ANS2606S

An invalid password was sent to the server.



Explanation:

The password that was sent to the IBM Spectrum Protect server was
invalid.

System action:

The operation ends.

User response:

Make sure that you have the correct password. Also make sure that it is
valid, for example it is not too short.

------------------------------------------------------------------------
ANS2607S

Browser could not establish connection to client.



Explanation:

The browser could not connect to the IBM Spectrum Protect client
machine.

System action:

The operation ends.

User response:

Determine what might be causing this kind of a problem. Determine if the
LAN is down, or if the IBM Spectrum Protect client acceptor on the IBM
Spectrum Protect machine is up and running.

------------------------------------------------------------------------
ANS2609S

TCP/IP communications failure between the browser and the client
machine.



Explanation:

This error can occur due to any of the following:

*  The LAN connection to the IBM Spectrum Protect client machine went
   down.

*  You are trying to connect to the IBM Spectrum Protect client machine
   using the wrong port number.

*  The client acceptor on the IBM Spectrum Protect client machine is not
   up and running and accepting connections.

System action:

The IBM Spectrum Protect operation ends.

User response:

Retry the operation and make sure the LAN is up. Also check that the
port number is correct, and that the client acceptor is started and
running on the IBM Spectrum Protect client machine, and that it is
listening on the correct port number.

------------------------------------------------------------------------
ANS2610S

TCP/IP communications failure between the client and the server machine.



Explanation:

An attempt to connect to the server using TCP/IP communications failed.
This can be a result of incorrect TCP/IP option settings in your client
options file. This error can also occur if the LAN connection went down
or if your system administrator canceled a backup operation.

System action:

The IBM Spectrum Protect client ends.

User response:

Retry the operation and make sure the LAN is up. Make sure that both the
IBM Spectrum Protect server and the IBM Spectrum Protect client are up
and running.

------------------------------------------------------------------------
ANS2611S

An unknown error occurred in the browser.



Explanation:

An unknown error occurred in the applet running in the browser.

System action:

The IBM Spectrum Protect operation ends.

User response:

Retry the operation. If the problem persists, turn on tracing and see if
the trace to the browser console gives the reason for the error.

------------------------------------------------------------------------
ANS2612S

An unknown error occurred in the client Please check the IBM Spectrum
Protect error eog for any additional information



Explanation:

An unknown error occurred in the IBM Spectrum Protect client.

System action:

The IBM Spectrum Protect client ends.

User response:

Retry the operation. If the problem persists, check the IBM Spectrum
Protect error log for any additional information.

------------------------------------------------------------------------
ANS2613S

A communications protocol error occurred between the web browser and the
client.



Explanation:

None.

System action:

The operation ends.

User response:

Try the operation again. If the problem occurs again, verify that the
IBM Spectrum Protect web client is installed and configured correctly,
and make sure you are using a supported browser. Flush the browser
cache. Then try the operation again. If the problem persists, enable
SERVICE traces on the web client on the target machine and the IBM
Spectrum Protect Java applet, then reproduce the problem. Collect the
traces and contact IBM for further assistance.

------------------------------------------------------------------------
ANS2614S

A protocol error occurred in communications between the client and the
server.



Explanation:

A protocol error happened between the IBM Spectrum Protect client and
the IBM Spectrum Protect server.

System action:

The IBM Spectrum Protect client ends.

User response:

Retry the operation. If the problem persists, check the IBM Spectrum
Protect error log for any additional information. Verify that you are
running the correct applet with the appropriate level of the client.

------------------------------------------------------------------------
ANS2615S

The user ID entered does not match the node name configured on the
client machine.



Explanation:

The user ID that was entered is not the same as the node name on this
IBM Spectrum Protect client.

System action:

The IBM Spectrum Protect operation ends.

User response:

Verify that the node name entered is configured correctly on the IBM
Spectrum Protect client.

------------------------------------------------------------------------
ANS2616I

The machine must be rebooted for the changes to take effect



Explanation:

The machine must be started for the restored registry changes to take
effect.

System action:

None

User response:

Reboot the machine

------------------------------------------------------------------------
ANS2617S

The destination directory specified is invalid.



Explanation:

The user specified a destination target directory for restore or
retrieve which is invalid.

System action:

The IBM Spectrum Protect operation ends.

User response:

Retry the operation specifying a valid directory name.

------------------------------------------------------------------------
ANS2619S

The client acceptor was unable to start the Remote Client Agent.



Explanation:

The IBM Spectrum Protect client acceptor could not start the IBM
Spectrum Protect Remote Client Agent.

System action:

The IBM Spectrum Protect operation ends.

User response:

Check the error log on the IBM Spectrum Protect Web client agent for any
relevant messages. Then correct the problem and retry.

------------------------------------------------------------------------
ANS2620W

The expand entire branch operation may take a long time, and cannot be
canceled once it has started. Are you willing to wait for the operation
to complete?



Explanation:

The expand entire branch operation could take a long time and cannot be
canceled once it is started.

System action:

Processing stopped; waiting for user intervention.

User response:

Answer 'Yes' to start the expand entire branch operation. If you answer
'No', the current operation will be canceled.

------------------------------------------------------------------------
ANS2622S

An invalid ID or password submitted.



Explanation:

Either the ID is not registered on the IBM Spectrum Protect server, or
the password for the ID is incorrect.

System action:

The operation ends.

User response:

Verify that the ID you are using exists on the IBM Spectrum Protect
server to which the remote client node connects. The ID must have
sufficient privileges to access the remote client node's data. Also make
sure that you have the correct password for the ID. If the ID does not
exist or if the password is unknown, contact your IBM Spectrum Protect
administrator. If the ID does not exist, then the IBM Spectrum Protect
administrator can use the REGISTER ADMIN and GRANT AUTHORITY commands to
register an ID that can access the remote client node's data. If the
password is unknown, the IBM Spectrum Protect administrator can use the
UPDATE ADMIN command to reset the password.

------------------------------------------------------------------------
ANS2623S

Web Client applet level is out of sync with Web Client agent.



Explanation:

The Web Client applet and Web Client agents are at incompatible levels.

System action:

The operation ends.

User response:

Verify that you have the correct level of the applet installed with the
client, and that an incorrect level of the applet was not placed in the
install directory.

------------------------------------------------------------------------
ANS2624E

This operation requires client owner authority.



Explanation:

Your user ID has insufficient authority to perform this operation.

System action:

Processing continues, but the user is not allowed to do this operation.

User response:

Do not perform this operation, or get a higher authority level for your
user ID in order to perform this operation.

------------------------------------------------------------------------
ANS2625E

Node does not support this image operation.



Explanation:

Node does not support or is not configured to perform this image
operation.

System action:

Processing continues, but the user is not allowed to do this operation.

User response:

Verify whether this image related operation is supported or configured
on the target platform.

------------------------------------------------------------------------
ANS2626E

The Include-Exclude statement: ieStatement contains invalid characters.



Explanation:

The specified Include-Exclude statement has invalid characters.

System action:

IBM Spectrum Protect will not add the specified Include-Exclude
statement to the list.

User response:

Retry the operation with another statement that has valid characters.

------------------------------------------------------------------------
ANS2627W

The NTFS security attributes for object 'full-name' could not be set.
Windows system error code: error; reason: 'error-reason'. Default NTFS
security attributes have been set.



Explanation:

IBM Spectrum Protect was unable to set the NTFS security attributes of
the file. The error information captured indicates the reason for the
failure. Default NTFS security attributes have been set.

System action:

Processing continues.

User response:

Check the reason field for the code which explains why the NTFS security
attributes have not been set. Correct the condition causing the error
and try the operation again. If the problem persists, contact your
system administrator or IBM Spectrum Protect administrator for further
help.

------------------------------------------------------------------------
ANS2628W

Failed to create named stream of object
'file_space_namepath_namefile_name'.



Explanation:

The process was unable to create named stream.

System action:

The named stream is not restored/retrieved.

User response:

The object is restored without named stream, the object should be
examined to verify that it is usable. Check the client error log for
ANS5250E error message that should have been logged when this message
was written, take the corrective action and try the operation again. If
the problem persists, contact your system administrator or IBM Spectrum
Protect administrator for further help.

------------------------------------------------------------------------
ANS2629I

Migration: The filespace will be migrated to the Incremental Forever
model.



Explanation:

The first time an Incremental Forever Incremental (IFIncr) backup is
performed against a virtual machine that was previously backed up using
the Periodic Full model, and the latest backup is an incremental backup,
then backup chain will be migrated to the Incremental Forever model.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS2630E

The Java runtime library for the vCloud Suite plug-in library failed to
load or initialize.



Explanation:

The Java runtime library (libjvm), required by the vCloud Suite plug-in
library, cannot be loaded, or the initialization of Java runtime
environment failed.

System action:

Operation is stopped

User response:

For Linux operating system, verify that a link named 'jre', referencing
the 'jre' directory under your Java installation path, exists in the
backup-archive client installation directory. If a link does not exist,
create the link (e.g. ln -s /opt/ibm/java-x86_64-70/jre
/opt/tivoli/tsm/client/ba/bin/jre). Alternatively, modify
LD_LIBRARY_PATH to include the path to libjvm.so (e.g. export
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/tivoli/tsm/client/ba/bin:/opt/ibm/java-x86_64-70/jre/bin/classic).
For Windows operating system, verify that the JRE directory exists under
the client installation directory. Reinstall the backup-archive client
if necessary.

------------------------------------------------------------------------
ANS2631E

The vCloud Suite plug-in library cannot be initialized.



Explanation:

The vCloud Suite plug-in library failed to initialize. This issue might
be caused by the Java runtime not being installed.

System action:

vCloud Suite operations cannot be performed.

User response:

Verify that Java is installed.

------------------------------------------------------------------------
ANS2632E

The vCloud Suite plug-in library cannot attach to the Java runtime.



Explanation:

The vCloud Suite plug-in library failed attach to the JVM runtime. This
issue might be caused by the Java runtime being corrupted or an
incomplete installation.

System action:

vCloud Suite operations cannot be performed.

User response:

Verify that Java is installed and functioning properly.

------------------------------------------------------------------------
ANS2633E

The vCloud Suite plug-in runtime library failed to log into the Platform
Services Controller on 'psc-host' with user name 'user-name':
authentication failed.



Explanation:

The vCloud Suite single sign-on credentials specified in the VMCUSER and
VMCPW options were rejected by the Platform Services Controller.

System action:

vCloud Suite operations cannot be performed.

User response:

Update the VMCUSER and VMCPW options with valid credentials for the
targeted Platform Services Controller.

------------------------------------------------------------------------
ANS2634E

The vCloud Suite plug-in runtime library failed to log into the Platform
Services Controller on 'psc-host'.



Explanation:

A connection cannot be established to the Platform Services Controller
using the VMCHOST option.

System action:

vCloud Suite operations cannot be performed.

User response:

Verify that the value of the VMCHOST option is correct, network
connectivity to the host exists, and that the Platform Services
Controller service is running. Enable VCLOUD tracing in the option file
for any additional messages that might be related to this problem.

------------------------------------------------------------------------
ANS2635E

The vCloud Suite plug-in runtime library encountered an internal error.



Explanation:

The vCloud Suite plug-in library encountered an unexpected internal
error that was not caught.

System action:

vCloud Suite operations cannot be performed.

User response:

Check the dsmerror.log file for any additional messages that might be
related to this problem, enable VCLOUD tracing in the option file.

------------------------------------------------------------------------
ANS2636E

The vCloud Suite plug-in library is uninitialized.



Explanation:

The vCloud Suite plug-in library is uninitialized. This issue might be
caused by an error loading or initializing the plug-in library.

System action:

vCloud Suite operations cannot be performed.

User response:

Check the dsmerror.log file for any additional messages that might be
related to this problem, enable VCLOUD tracing in the option file.

------------------------------------------------------------------------
ANS2640I

The virtual machine 'VM-name' is configured with the 'exclude-category'
category and the 'exclude-tag' tag, which excludes the virtual machine
from the backup operation.



Explanation:

The client option 'VMTAGDATAMOVER' is enabled so that IBM categories and
tags can be applied to virtual machines.

System action:

The virtual machine is excluded from the scheduled backup operation.

User response:

Remove the tag if the virtual machine should be included in scheduled
backups, run an on-demand backup of the virtual machine, or set the
'VMTAGDATAMOVER' option to 'No' in the client options file.

------------------------------------------------------------------------
ANS2641E

The client failed to load the VMware vCloud Suite plug-in library
'piVcloudSuiteJNI'.



Explanation:

The VMware vCloud Suite plug-in library 'piVcloudSuiteJNI' could not be
found or could not be loaded. This issue might be caused by the library
being corrupted or an incomplete installation.

System action:

The operation cannot be completed without the VMware vCloud Suite
plug-in library.

User response:

Verify that the VMware vCloud Suite plug-in library 'piVcloudSuiteJNI'
is in the 'plugins' folder in the client installation folder or disable
the clinet option 'VMTAGDATAMOVER'.

------------------------------------------------------------------------
ANS2642E

The VMware vCloud Suite plug-in library could not find a required Java
class or method.



Explanation:

The VMware vCloud Suite plug-in library failed to find a required Java
class or method. This issue might be caused by an incomplete
installation, missing VMware vCloud Suite plug-in JAR
'piVcloudSuiteJwrapper.jar' file or the JAR files are not in the Java
classpath.

System action:

The operation cannot be completed without the VMware vCloud Suite
plug-in library.

User response:

Verify that the VMware vCloud Suite plug-in library JAR
'piVcloudSuiteJwrapper.jar' is in the 'plugins' and the other JAR files
are in 'plugins/sdk' in the client installation folder or disable the
clinet option 'VMTAGDATAMOVER'.

------------------------------------------------------------------------
ANS2643I

An on-demand backup of the virtual machine 'VM-name' is running. The
virtual machine is configured with the 'exclude-category' category and
the 'exclude-tag' tag.



Explanation:

The client option 'VMTAGDATAMOVER' is enabled so that IBM categories and
tags can be applied to virtual machines, but the on-demand backup
overrides the tag setting for exclusion.

System action:

The backup operation continues.

User response:

No action is required.

------------------------------------------------------------------------
ANS2644I

The virtual machine 'VM-name' is not configured with a
'exclude-category' tag and can only be backed up by a default data
mover. The virtual machine will be excluded from the scheduled backup
operation.



Explanation:

The client option 'VMTAGDATAMOVER' is enabled so that IBM categories and
tags can be applied to virtual machines. The active data mover is not
the default data mover so its unable to perform the backup operation.

System action:

The virtual machine is excluded from the scheduled backup operation.

User response:

If you want to include the virtual machine in schedule backups, assign a
data mover tag to the virtual machine or make sure a data mover is set
up as a default data mover by using the VMTAGDEFAULTDATAMOVER option.

------------------------------------------------------------------------
ANS2649E

A Schedule name was not provided.



Explanation:

An error occurred while processing. Either the option TAGSCHEDULE was
missing or the value of the parameter was incorrect.

System action:

The rebalance processing ended.

User response:

Provide a valid schedule with the TAGSCHEDULE option and try the
operation again.

------------------------------------------------------------------------
ANS2650E

The process does not have the VMTAGDATAMOVER option specified.



Explanation:

An error occurred while processing. The option VMTAGDATAMOVER must be
present in the option file.

System action:

The rebalance processing ended.

User response:

To use this feature, employ a datamover configured as a tagged
datamover.

------------------------------------------------------------------------
ANS2651E

The ASNODENAME option must be provided to rebalance a VMware schedule.



Explanation:

An error occurred while processing. There was a problem processing the
ASNODENAME option or it was not provided to the command.

System action:

The rebalance processing ended.

User response:

To use this feature, employ a datamover configured as a proxy agent for
a datacenter.

------------------------------------------------------------------------
ANS2659I

datamover_count data movers are assigned to schedule sched-name.



Explanation:

Since less than two data movers are assigned to this schedule,
assignment of datamover tags was not possible.

System action:

None.

User response:

Use the vCenter GUI to manually assign a data mover to this schedule.

------------------------------------------------------------------------
ANS2666S

Either the ource or target volumes are duplicated. The same volume is
mounted on more volume paths.



Explanation:

This error can occur when a source volume is mapped on more volume
paths, for example, a drive letter and one or more mount point
directories. Because IBM Spectrum Protect uses the volume path to keep
track of backup information in its internal backups database, it cannot
back up the same volume with a duplicate volume path. See addition
information in the error log.

System action:

IBM Spectrum Protect cannot select the volume.

User response:

Delete the last snapshots created as they are not managed by IBM
Spectrum Protect. Unmount the duplicate volume path in order to have a
single mount point to the same source volume. Restart IBM Spectrum
Protect and retry the operation.

------------------------------------------------------------------------
ANS2667I

Scan operation was successful.



Explanation:

The virtual machine was scanned successfully.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2668E

Scan operation failed with an unexpected error.



Explanation:

An unexpected error occurred during guest scan operations.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Check the client error log for additional information.

------------------------------------------------------------------------
ANS2669I

Guest operating system platform is not supported.



Explanation:

The operating system of the virtual machine was not supported by the
scan operation.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2670I

Remote directory in guest is being used by another application.



Explanation:

The scan operation was unable to copy files to the remote directory
because the directory is in use by another application.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Ensure that the remote directory is unlocked. Then, reschedule the scan
operation.

------------------------------------------------------------------------
ANS2671I

Virtual machine name was not found on the VMware server.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2672W

Hostname could not be found for the specified virtual machine name.



Explanation:

This issue might be caused by the virtual machine not running and not
having a static IP address.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Make sure the guest is properly configured. Then, reschedule the scan
operation.

------------------------------------------------------------------------
ANS2673I

Duplicate virtual machine name was detected.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2674I

The virtual machine is not connected to ESX server.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2675E

Proxy Rejected: Proxy authority has not been granted to the specified
data mover node.



Explanation:

The scan of the virtual machine failed.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

The IBM Spectrum Protect server administrator must grant proxy authority
for this node. See the administrator command "Grant Proxynode".

------------------------------------------------------------------------
ANS2676W

The guest operating system credential was not found.



Explanation:

The guest scan operation requires a valid operating system credential.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Ensure the guest operating system credential is set. Then, reschedule
the scan operation.

------------------------------------------------------------------------
ANS2677W

The guest operating system credential is invalid.



Explanation:

The guest scan operation requires a valid operating system credential.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Ensure a valid guest operating system credential is set. Then,
reschedule the scan operation.

------------------------------------------------------------------------
ANS2678I

Guest machine is powered off.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2679I

VMware Tools on the guest machine is not running.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2680I

VMware Tools version on the guest machine is not current.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2681W

ESX host or vCenter version is not supported.



Explanation:

The ESX host or vCenter is a down level version.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Refer to the product documentation for supported ESX and vCenter
versions.

------------------------------------------------------------------------
ANS2682I

The guest credential has insufficient permissions.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2683W

Cannot communicate with the remote host.



Explanation:

This communication issue is caused by network errors or by the host not
responding.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Ensure that the network and host connection are configured correctly.
Then, reschedule the scan operation.

------------------------------------------------------------------------
ANS2684I

The guest operation agent could not be contacted.



Explanation:

None

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2685I

The VM is a template.



Explanation:

VM templates are not supported by the scan operation.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

None

------------------------------------------------------------------------
ANS2686E

VM scan initialization error.



Explanation:

The vm scan operation encountered an error during initialization.

System action:

The scan process stops for the virtual machine. The next virtual machine
in the data center will be processed.

User response:

Check the client error log and trace for additional information.

------------------------------------------------------------------------
ANS2687W

The virtual machine 'VM-name' contains one or more disks that exceed the
maximum size set by the VMMAXVIRTUALDISKS option. You can use the
VMMAXVIRTUALDISKS option to change the maximum size or specify the
'-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from the
backup.



Explanation:

The IBM Spectrum Protect client does not back up VMDKs that are larger
than the maximum size.

System action:

The virtual machine is not backed up.

User response:

Use the VMMAXVIRTUALDISKS option to change the maximum size or specify
the '-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from the
backup.

------------------------------------------------------------------------
ANS2688E

The restore of a Hyper-V virtual machine that was backed up using
incremental forever backup is not allowed on a Windows 2008 or Windows
2008 R2 host. The restore operation must be completed on a Windows 2012
or later Hyper-V host



Explanation:

A Hyper-V virtual machine that was backed up with the incremental
forever backup type can only be restored on a Windows 2012 or later
Hyper-V host.

System action:

The restore operation does not start.

User response:

Try the operation again with a Windows 2012 or later Hyper-V host.

------------------------------------------------------------------------
ANS2689E

A Hyper-V command subcommand command was specified, but the Hyper-V role
is not enabled on the host system



Explanation:

The Hyper-V role must be enabled on the host system where the Hyper-V
operation occurs. The current system does not have the Hyper-V role
enabled.

System action:

The operation does not start.

User response:

Try the operation again from a host that has the Hyper-V role enabled.

------------------------------------------------------------------------
ANS2690E

A Hyper-V BACKUP VM command with mode IFFULL or IFINCR was specified but
the Data Protection for Microsoft Hyper-V license file does not exist or
is not valid



Explanation:

The Data Protection for Microsoft Hyper-V license file is required to
issue Hyper-V BACKUP VM commands with mode IFFULL or IFINCR. Make sure
the Data Protection for Microsoft Hyper-V file is installed.

System action:

The backup does not start.

User response:

Try the operation again from a host that has the Data Protection for
Microsoft Hyper-V license file installed. Or, issue the BACKUP VM
command and specify mode FULL.

------------------------------------------------------------------------
ANS2691E

A Hyper-V BACKUP VM command with mode FULL was specified but the Data
Protection for Microsoft Hyper-V license file exists. Mode IFFULL or
IFINCR must be specified



Explanation:

Hyper-V BACKUP VM commands with mode FULL are not allowed on hosts where
the Data Protection for Microsoft Hyper-V license file is installed.
Instead, issue the BACKUP VM command using mode IFFULL or IFINCR.

If you must issue the BACKUP VM command with mode FULL, you must
uninstall the Data Protection for Microsoft Hyper-V license file.
However, uninstalling the license file invalidates the IFINCR backup
chain. As a result, an IFFULL is performed if the Data Protection for
Microsoft Hyper-V license file is reinstalled.

System action:

The backup does not start.

User response:

Try the operation again and specify mode IFFULL or IFINCR.

------------------------------------------------------------------------
ANS2692E

An error occurred while registering the filespace for virtual machine
(VM_name).



Explanation:

An error occurred while registering the filespace for the specified
virtual machine.

System action:

The backup of this virtual machine fails. The backup process can
continue with other virtual machines.

User response:

Check the error log for information about how to resolve this issue.

------------------------------------------------------------------------
ANS2693E

An error occurred while registering the filespace for virtual machine
(VM_name). There is a filespace with the same name that is currently
being deleted.



Explanation:

An error occurred while registering the filespace for the specified
virtual machine. A filespace with the same name is currently being
deleted on the IBM Spectrum Protect server

System action:

The backup of this virtual machine fails. The backup process can
continue with other virtual machines.

User response:

Wait for the delete filespace to finish and run the backup command
again.

------------------------------------------------------------------------
ANS2694W

Application protection is enabled for virtual machine 'VM-name';
however, this virtual machine contains one or more disks that exceed the
maximum size of 2 TB allowed for application protection operations.
Application protection needs to be disabled in order to backup this
virtual machine.



Explanation:

The IBM Spectrum Protect client does not back up VMDKs that are larger
than 2 TB when application protection is being used.

System action:

The virtual machine is not backed up.

User response:

Application protection must be disabled in order to backup the specified
virtual machine.

------------------------------------------------------------------------
ANS2695W

The periodic full backup mode is being used; however, the virtual
machine 'VM-name' contains one or more disks that exceed the maximum
size of 2 TB allowed for the periodic full backup mode. You can use the
'-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from the
backup, or change to the incremental forever backup mode.



Explanation:

The IBM Spectrum Protect client does not back up VMDKs that are larger
than 2 TB when the periodic full backup mode is being used.

System action:

The virtual machine is not backed up.

User response:

Use the '-VMSKIPMAXVIRTUALDISKS=yes' option to exclude these disks from
the backup, or change to the incremental forever backup mode.

------------------------------------------------------------------------
ANS2696E

Control or data files were found to be compressed but not deduplicated
for vm vm name.



Explanation:

During a verify operation, the data mover detected that one or more
control or data files on the server are compressed, but not
deduplicated. This is an invalid state because data that is compressed,
but not deduplicated, cannot be recovered. An incremental forever full
backup of the VM is needed before incremental forever incremental
backups can resume.

System action:

The backup operation for this VM continues based on the VMVERIFYIFAction
option.

User response:

Perform a full VM backup for this virtual machine or specify the
VMVERIFYAction option to force a full VM backup.

------------------------------------------------------------------------
ANS2697E

The virtual machine cannot be restored because the datastore named
'datastore' does not exist or is inactive.



Explanation:

The datastore referenced by virtual machine when it was backed up does
not exist or is inactive on the ESX/ESXi that you are restoring the
virtual machine to.

System action:

The virtual machine cannot be restored.

User response:

Find the missing datastore or specify the -datastore option on the
Restore VM command to specify an existing datastore to restore the
virtual machine files to.

------------------------------------------------------------------------
ANS2698E

Snapshot operation failed.



Explanation:

If you are performing a VSS or LVSA snapshot based operation, it is
possible that the snapshot was not large enough to contain all the
changes made to the file system after the snapshot was created. This
could cause the snapshot to become invalid thereby preventing the IBM
Spectrum Protect client from reading the snapshot.

System action:

The requested operation stopped.

User response:

Examine the client error log for additional messages related to this
error. Perform corrective actions indicated by the messages, then try
the operation again.

------------------------------------------------------------------------
ANS2699W

Importing VM 'vm name' failed for vApp 'vapp name'.



Explanation:

The import VM from vSphere to a vCloud vApp operation failed.

System action:

Restore processing for the vApp continues.

User response:

Check the dsmerror.log file for information about why the VM was not
imported. Then, try the operation again. If the problem persists, visit
the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2700E

Restoring VM 'vm name' of vApp 'vapp name' is not possible. There is no
VM backup data.



Explanation:

During the vApp restore, a VM that exists in the restored vApp version
could not be restored, because it was not successfully backed up.

System action:

The restore operation will proceed, attempting to restore any available
vApp backup data.

User response:

Examine the client error log for any messages that might be indicate on
the reason for the specified VM's backup failure. Contact IBM Spectrum
Protect technical support if further assistance is required.

------------------------------------------------------------------------
ANS2701E

The attempted database operation was unsuccessful, check the error log
for any additional information.



Explanation:

Processing stops.

System action:

Reserved.

User response:

Check the error log for information regarding failure and take further
action.

------------------------------------------------------------------------
ANS2704E

Error: The vCenter server version is at a lower level than the ESX host
version, or the user ID specified by the VMCUser option does not have
sufficient permission to perform the operation.



Explanation:

The vCenter returned an error indicating there is a problem with the
license. This error can occur when the vCenter server version is at a
lower level than the ESX host version. The vCenter server version must
be at the same (or later) level as the ESX host version. This error can
also occur when the user ID specified by the VMCUser option does not
have sufficient permission to perform the operation or the permissions
are not applied at the vCenter server level.

System action:

Processing stops.

User response:

Verify the vCenter server is at the correct level, and verify that the
user ID specified by the VMCUser option has sufficient permission to
perform the operation.

------------------------------------------------------------------------
ANS2705S

No Db2 UDB partitions are available for restore.



Explanation:

No Db2 UDB partitions are available on the IBM Spectrum Protect server
for restore. This is most likely due to a previous backup that was
aborted before the backup completed. The Db2 UDB database and selected
partitions cannot be restored.

System action:

Processing stops.

User response:

Issue the IBM Spectrum Protect client command QUERY DB2UDB command with
the -DETAIL parameter using the same database, file, and date criteria
to see if any database partitions are available for restore.
Alternatively restore the Db2 UDB database from a different backup.

------------------------------------------------------------------------
ANS2706E

The option VMBACKUPLOCATION=value is not allowed with restore type
operation 'type'.



Explanation:

Operation failed.

System action:

Processing stopped.

User response:

Remove option VMBACKUPLOCATION from the command line and try again.

------------------------------------------------------------------------
ANS2707W

The VMBACKUPLOCATION option value BOTH was specified. The local backup
for virtual machine 'VM-name' failed, but the backup to the server
completed.



Explanation:

The local backup failed. Only the server backup was successful.

System action:

Processing completed.

User response:

Contact your system administrator to resolve issues that cause the local
backup to fail.

------------------------------------------------------------------------
ANS2708E

One or more disks of the virtual machine 'VM-name' are not in a virtual
volumes datastore. Local backup is not allowed. If the VMBACKUPLOCATION
option value BOTH was specified, the backup to the server will continue.



Explanation:

Local backup is only supported for virtual machines that are in a
virtual volumes datastore.

System action:

Processing continues if VMBACKUPLOCATION=BOTH was specified.

User response:

If you want local backup, contact your system administrator to
reconfigure the virtual machine and then try the backup again.

------------------------------------------------------------------------
ANS2709E

The snapshot of virtual machine 'VM-name' was removed after the backup.



Explanation:

The virtual machine snapshot was removed by another application or
process after the backup. This removal corrupted the backup and it
cannot be restored or mounted.

System action:

Processing stopped.

User response:

Delete the local backup from the IBM Spectrum Protect server for this
virtual machine.

------------------------------------------------------------------------
ANS2710E

The virtual machine 'VM-name' was removed from the inventory.



Explanation:

The virtual machine was removed from the inventory. This removal
invalidates all local backups.

System action:

Processing stopped.

User response:

Delete all the local backups from the IBM Spectrum Protect server for
this virtual machine.

------------------------------------------------------------------------
ANS2711E

The snapshot of virtual machine 'VM-name' was removed during the backup.



Explanation:

The virtual machine snapshot was removed by another application or
process during the backup. This removal corrupts the backup and it
becomes unusable.

System action:

The virtual machine is not backed up.

User response:

Ensure that another application or process does not remove or modify the
virtual machine during the backup.

------------------------------------------------------------------------
ANS2712W

The virtual machine 'name' has a VMware Tools running, but VMware Tools
is out of date.



Explanation:

A supported version of VMware Tools must be installed, running and
current to complete a virtual machine backup.

System action:

The backup operation fails.

User response:

Verify that a supported version of VMware Tools is installed, current
and running. Then, try the backup operation again.

------------------------------------------------------------------------
ANS2713E

The virtual machine 'VM-name' is in an invalid connection state 'state'.
As a result, it cannot be backed up.



Explanation:

To back up a virtual machine it must be in the 'connected' state to be
accessed.

System action:

The virtual machine is not backed up.

User response:

Return the virtual machine to the 'connected' state and try the backup
again.

------------------------------------------------------------------------
ANS2714W

The management class 'mc' specified for the 'dest' backup destination is
invalid. The default management class will be used.



Explanation:

None.

System action:

Processing continues.

User response:

Contact the IBM Spectrum Protect administrator to run the configuration
utility for DB2 UDB and specify a valid management class.

------------------------------------------------------------------------
ANS2715E

The virtual machine 'VM-name' is configured as a fault tolerant virtual
machine. As a result, it cannot be backed up.



Explanation:

vSphere does not allow for the snapshot or backup of fault tolerant
virtual machines with vStorage API for Data Protection.

System action:

The virtual machine is not backed up.

User response:

To back up a fault tolerant virtual machine with vStorage API for Data
Protection, first disable fault tolerant. Then, after the backup
completes, enable fault tolerant.

------------------------------------------------------------------------
ANS2716E

A background copy process is still pending on local hardware. A restore
operation cannot be initiated until the background copy process is
completed.



Explanation:

None.

System action:

Processing stops.

User response:

Wait until the background copy process completes and retry the restore
operation.

------------------------------------------------------------------------
ANS2717E

The multi-node definition does not have permission to delete its own
backup files from the server.



Explanation:

All DB2 UDB commands require that the multi-node definition has
permission to delete its own backup files from the server in order to
properly reconcile the local backup repository with the server backup
repository.

System action:

Processing stops.

User response:

Have the IBM Spectrum Protect administrator update the multi-node
definition so that it has permission to delete its own backup files from
the server. For example, on the IBM Spectrum Protect administrative
command-line client:. dsmadmc update node <multi-node name>
backdelete=yes

------------------------------------------------------------------------
ANS2718W

The virtual machine 'VM-name' requires snapshot consolidation.



Explanation:

Snapshot consolidation is required when a snapshot is deleted but its
associated disk is not committed back to the base disk. If consolidation
is not completed, snapshot disks might grow and eventually fill the data
store.

System action:

The virtual machine backup continues.

User response:

Consolidate the virtual machine snapshots according to instructions
provided in the appropriate VMware vSphere documentation.

------------------------------------------------------------------------
ANS2719E

A previous backup started on 'datetime', is using the resources needed
for new backup is still pending.



Explanation:

A new backup can not be done until previous backup completes.

System action:

Processing stops.

User response:

Wait until previous backup completes before starting another local
backup. Alternatively, use different copyType value to perform a local
backup. IBM Spectrum Protect local backup policy only allows one
incremental and one full background copy to be pending at any time,
before local backup resources are reused for a new backup version. A new
local backup would result in a backup with background copy in pending
state.

------------------------------------------------------------------------
ANS2720W

Failed to execute the command 'command'.



Explanation:

IBM Spectrum Protect Failed to execute a command. The possible reason -
the command interpreter cannot be found. Verify the ComSpec and PATH
environment variables that locate the command interpreter. Either
ComSpec or PATH is not defined, or it is not correctly defined.

System action:

The command does not run. Otherwise processing will attempt to continue.

User response:

Correct the ComSpec and PATH environment variable that locate the
command interpreter. Contact your system administrator if you are not
sure how to make this correction.

------------------------------------------------------------------------
ANS2721E

The virtual machine is in an invalid connection state. As a result, it
cannot be backed up.



Explanation:

One or more virtual machine backups failed because of an invalid
connection state. A virtual machine must be in the 'connected' state to
be accessed for backup.

System action:

Processing stops for this virtual machine

User response:

Check the console output and error logs for information about why the
connection state was invalid. Correct any issues and try backing up the
failed virtual machines.

------------------------------------------------------------------------
ANS2722E

There is not enough space in the local repository to complete this
backup.



Explanation:

This space available in the local repository is not enough to perform
snapshot for this backup operation. It could happen if there is more
number of local versions kept by the management class than there is
space allocated in the local repository at configuration time or
application configuration has changed such that previously allocated
space is not enough.

System action:

None.

User response:

Please validate IBM Spectrum Protect configuration by running the
configuration wizard.

------------------------------------------------------------------------
ANS2723E

A value of UNDEF for the REAdstartsrecall option is not valid when the
HSMBACKENDMODE option is set to IBM Spectrum Protect.



Explanation:

A value of UNDEF for the REAdstartsrecall option is valid only when the
HSMBACKENDMODE option is set to TSMFREE.

System action:

The operation stops. The file is skipped.

User response:

If the HSMBACKENDMODE option is set to IBM Spectrum Protect, set the
REAdstartsrecall option to YES or NO.

------------------------------------------------------------------------
ANS2725E

IBM Spectrum Protect application protection could not register the IBM
Spectrum Protect VSS provider on the guest VM 'VM'.



Explanation:

The guest vm credentials speficied on the datamover do not have the
correct required Windows permissions for application protection.

System action:

The application protection vm backup processing stops.

User response:

Make sure that the credentials specified for the guest VM have the
correct required Windows permissions for application protection type vm
backups. The user guide outlines the correct permissions that are
required for backuping and restoring application data for Microsoft
Exchange and Microsoft SQL Servers.

------------------------------------------------------------------------
ANS2729E

Operating system command 'command' failed; rc=rc.



Explanation:

None.

System action:

Process stops.

User response:

Check the return code from the operating system for more information
about the failure. Issue the failing command manually to see if the same
failure occurs.

------------------------------------------------------------------------
ANS2730E

The dsmmigrate command is unable to get a list of IBM Spectrum Scale
nodes.



Explanation:

The dsmmigrate command is unable to get a list of IBM Spectrum Scale
nodes due to an unexpected internal error.

System action:

Processing stopped.

User response:

Contact your system administrator for more information.

------------------------------------------------------------------------
ANS2731E

The BACKUP VM command failed because the Data Protection for VMware
license file does not exist or is not valid.



Explanation:

The Data Protection for VMware license file is required for the BACKUP
VM command.

System action:

The command is not processed.

User response:

Install Data Protection for VMware or the license file for Data
Protection for VMware, and retry the command. Or retry the operation
from a host that has the Data Protection for VMware license file
installed.

------------------------------------------------------------------------
ANS2732E

The BACKUP VM command failed because the Data Protection for Microsoft
Hyper-V license file does not exist or is not valid.



Explanation:

The Data Protection for Microsoft Hyper-V license file is required for
the BACKUP VM command.

System action:

The command is not processed.

User response:

Install Data Protection for Microsoft Hyper-V or the license file for
Data Protection for Microsoft Hyper-V, and retry the command. Or retry
the operation from a host that has the Data Protection for Microsoft
Hyper-V license file installed.

------------------------------------------------------------------------
ANS2733E

An operation requiring the Windows Management Instrumentation (WMI)
service has failed with the error 'errorstring'. IBM Spectrum Protect
has been denied access to a WMI system due to insufficient privileges.



Explanation:

Windows denied access to a Windows Management Instrumentation (WMI)
resource, object, or operation. This program has insufficient
permissions to perform the requested operation.

System action:

Performing an operation requiring the Windows Management Instrumentation
service.

User response:

Raise the permissions assigned to IBM Spectrum Protect and retry the
operation.

------------------------------------------------------------------------
ANS2734E

An operation requiring the Windows Management Instrumentation (WMI)
service has failed with the error 'errorstring'. The application
interface does not exist.



Explanation:

This error occurred because Windows Management Instrumentation (WMI)
classes were not registered or have become unregistered. WMI classes are
registered with Windows features.

System action:

Initialization of a Windows Management Instrumentation object failed.

User response:

Register the Windows Management Instrumentation classes of the
appropriate Windows feature.

------------------------------------------------------------------------
ANS2735W

All selective and transparent recalls are blocked due to the
HSMOPTIMIZEDRECALLONLY option. This message will not be reissued for the
next 24 hours.



Explanation:

If the HSMOPTIMIZEDRECALLONLY option is set to YES, only optimized
recalls are allowed.

System action:

Recall is blocked.

User response:

Disable the HSMOPTIMIZEDRECALLONLY option and restart the HSM daemons.

------------------------------------------------------------------------
ANS2736E

An unexpected response was received from a remote IBM Spectrum Protect
file system agent. verb : verb remote host : host return code : rc
reason code : rs msg. string : msg-string



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS2737W

No disks from VM are mounted because all disks were excluded during the
backup.



Explanation:

No disks from VM can be mounted because all disks were excluded during
backup or the VM did not contain any disks.

System action:

The operation stops.

User response:

If files from the affected file systems or volumes must be recovered,
ensure that at least one disk is included in the backup.

------------------------------------------------------------------------
ANS2738W

'filename' cannot be recovered because it is being used by process.



Explanation:

Another process, dsmmigrate or dsmrecalld, is using the file.

System action:

The file is not included for recovery.

User response:

Wait until the file is closed and retry recovery if necessary.

------------------------------------------------------------------------
ANS2739W

'filename' cannot be recovered because either a migration process or a
recall process on node node-ID is accessing the same file.



Explanation:

The migration process may be run on another node.

System action:

The file is not included for recovery.

User response:

Run the recovery on another node.

------------------------------------------------------------------------
ANS2740E

The vApp restore operation failed.



Explanation:

The vApp restore operation failed. Check the error log for details on
why the operation failed.

System action:

Processing stops

User response:

Review the console output and error logs for the details on the problem.
Fix any issues and restart the operation.

------------------------------------------------------------------------
ANS2741E

Recovery of object 'file-name' failed.



Explanation:

An error occurred when dsmmigrate tried to recover the file.

System action:

The file is not included for recovery.

User response:

Examine the client error log for additional messages related to this
error.

------------------------------------------------------------------------
ANS2742W

File 'file-name' is not included for recovery.



Explanation:

The file is not included for recovery because: 1) It is a resident file.
2) The migration/recall process is currently running and using the file.
3) Crash-recovery information was not found and the file cannot be
recovered. 4) Crash-recovery information was found on different IBM
Spectrum Scale nodes and it is unclear which crash-recovery information
to use.

System action:

The file is not included for recovery.

User response:

None.

------------------------------------------------------------------------
ANS2744I

TESTFLAG Db2 enabled with the value of 'value'.



Explanation:

None.

System action:

This message is informational.

User response:

None.

------------------------------------------------------------------------
ANS2745E

An assigned virtual disk to Hyper-V Virtual Machine 'virtualmachinename'
cannot be found.



Explanation:

The IBM Spectrum Protect client detected that a Virtual Machine has
assigned a disk that is unreachable. The disk may have been moved or
deleted. A snapshot cannot be taken while the disk cannot be found.

System action:

The IBM Spectrum Protect could not find a virtual disk at the assigned
path.

User response:

Check that the virtual disk has not been moved or deleted and update the
virtual machine configuration to match any changes to the file system.

------------------------------------------------------------------------
ANS2746E

An assigned virtual disk to Hyper-V virtual machine 'virtualmachinename'
is a VHD or invalid format. Only virtual disks in VHDX format can be
backed up.



Explanation:

The IBM Spectrum Protect client detected that a virtual machine has
assigned a disk that is in the VHD format or is in an unrecognisable or
unsupported format. If the disk is in VHDX format it may be corrupted.

System action:

The IBM Spectrum Protect found a virtual disk in VHD or unrecognisable
format while preparing for a backup of a virtual machine.

User response:

If the virtual disk is in VHD format there are several options: Remove
the VHD from the virtual machine, convert the virtual disk from VHD
format to VHDX format, or adjust DOMAIN.VMFULL to skip the virtual
machine from backup. If the disk is in VHDX format, check that the disk
has not been corrupted.

------------------------------------------------------------------------
ANS2747E

An assigned AVHDX virtual disk to Hyper-V virtual machine
'virtualmachinename' cannot find the parent disk. Snapshots can be taken
only if the parent can be found.



Explanation:

The AVHDX format specifies an internal field that points to a parent
AVHDX or VHDX file. If the parent cannot be found the disk is invalid
and a snapshot will fail.

System action:

The process discovered an AVHDX attached to a virtual machine and
attempted to find the parent AVHDX or VHDX file.

User response:

Check that the parent AVHDX or VHDX file still exists and has not been
moved or deleted. Return the parent AVHDX and/or VHDX file.

------------------------------------------------------------------------
ANS2748E

An assigned virtual disk to Hyper-V virtual machine 'virtualmachinename'
exceeds the maximum capacity limit. The IBM Spectrum Protect client
cannot backup virtual machines with disks that exceed the limit of two
terabytes.



Explanation:

The IBM Spectrum Protect client detected that a Virtual Machine has
assigned a disk whose capacity exceeds two terabytes. Virtual disks that
exceed 2 terabytes are currently not supported by incremental forever
backups.

System action:

The IBM Spectrum Protect found a virtual disk whose capacity exceeds two
terabytes on a virtual machine scheduled for back up.

User response:

There are several options available: Remove the disk from the virtual
machine, shrink the disk to under two terabytes, copy the data to
virtual disk with a capacity under two terabytes. Even though
incremental backup is not available, the always full backup type is
compatible with disks over two terabytes.

------------------------------------------------------------------------
ANS2749E

See Microsoft Technote KB2771882. An assigned virtual disk to Hyper-V
Virtual Machine 'virtualmachinename' contains files that are on a
Cluster Shared Volume and local volumes. A snapshot of a Virtual Machine
in this configuration cannot be taken.



Explanation:

The IBM Spectrum Protect client detected that a Virtual Machine has
files involved in the snapshot on both local volumes and Cluster Shared
Volumes. Attempting to snapshot a virtual machine in this configuration
always results in failure. This error is documented in Microsoft
Technote KB2771882.

System action:

The IBM Spectrum Protect client discovered the virtual machine has files
on local volumes and cluster shared volumes prior to taking a snapshot.

User response:

Check that all of the disks and the configuration files are all on local
volumes or cluster shared volumes. If necessary, perform a storage
migration to move the disks and/or configuration files.

------------------------------------------------------------------------
ANS2750E

The Hyper-V Virtual Machine 'virtualmachinename' is currently undergoing
one of the following operations: * Creating Local Snapshot * Applying
Local Snapshot * Deleting Local Snapshot * Exporting Virtual Machine *
Migrating Virtual Machine * Volume Snapshot Service (VSS) Snapshot *
Restore * Merging Differencing Disks The above operations prevent a
Hyper-V VSS snapshot from taking place. Wait for the operation to finish
or cancel to perform a backup.



Explanation:

Some virtual machine management tasks interfere with a virtual machine
VSS snapshot. One of these operations was detected during a back up
request.

System action:

The IBM Spectrum Protect client discovered the virtual machine is
currently undergoing an operation that will prevent a Volume Snapshot
Service snapshot from occuring.

User response:

Cancel or wait for the current virtual machine management task to finish
and then retry the back up.

------------------------------------------------------------------------
ANS2751E

The RESTORE VM command failed because the Data Protection for VMware
license file does not exist or is not valid.



Explanation:

The Data Protection for VMware license file is required for the RESTORE
VM command.

System action:

The command is not processed.

User response:

Install Data Protection for VMware or the license file for Data
Protection for VMware, and retry the command. Or retry the operation
from a host that has the Data Protection for VMware license file
installed.

------------------------------------------------------------------------
ANS2752E

The RESTORE VM command failed because the Data Protection for Microsoft
Hyper-V license file does not exist or is not valid.



Explanation:

The Data Protection for Microsoft Hyper-V license file is required for
the BACKUP VM command.

System action:

The command is not processed.

User response:

Install Data Protection for Microsoft Hyper-V or the license file for
Data Protection for Microsoft Hyper-V, and retry the command. Or retry
the operation from a host that has the Data Protection for Microsoft
Hyper-V license file installed.

------------------------------------------------------------------------
ANS2753I

Establishing inter-client communication with node node(s).



Explanation:

None.

System action:

This message is informational.

User response:

None.

------------------------------------------------------------------------
ANS2785I

Gathering current Db2 configuration for 'type' restore.



Explanation:

None.

System action:

This message is informational.

User response:

None.

------------------------------------------------------------------------
ANS2790E

Error Accessing Storage Virtual Machine 'svm_name' on NetApp Filer
'filer_name'.



Explanation:

The specified Storage Virtual Machine could not be accessed on the
specified filer. Make sure that the storage virtual machine exists and
is running on the specified filer and that the storage virtual machine
has been correctly associated with the filer with the SET NETAPPSVM
command.

System action:

Processing stops.

User response:

Make sure that the storage virtual machine is running on the specified
filer and that the association between the filer and the storage virtual
machine has been defined correctly with the dsmc set netappsvm command.

------------------------------------------------------------------------
ANS2798E

Unable to start a session from client node 'nodename' multi-node
'multi-node' to client at address 'ip-address:ip-port'. The return code
is rc.



Explanation:

None.

System action:

This message is informational.

User response:

None.

------------------------------------------------------------------------
ANS2799E

An error was encountered during a session with another client. Check the
error log for any additional information



Explanation:

This message is reserved for DB2 UDB.

System action:

Reserved.

User response:

This message is reserved for DB2 UDB.

------------------------------------------------------------------------
ANS2800W

No IBM Spectrum Protect processes were found.



Explanation:

The QUERY PIDS command was unable to identify any known IBM Spectrum
Protect processes running on the system. If the -FILTER option was used,
no processes matching the filter specification were found.

System action:

None.

User response:

If you need to use dsmtrace to enable or disable tracing for a running
client process, make sure that the client is already running. If you
used the -FILTER option, try the command again with a different filter
specification. You can use -FILTER=* to display all processes running on
the system.

------------------------------------------------------------------------
ANS2801E

The dsmtrace utility was unable to connect to the specified process.



Explanation:

This message typically occurs when the specified process ID is not
active.

System action:

None.

User response:

If you need to use dsmtrace to enable or disable tracing for a running
client process, make sure that the client is already running. Use the
dsmtrace QUERY PIDS command to identify running client processes, then
try the command again.

------------------------------------------------------------------------
ANS2802I

Tracing has been disabled.



Explanation:

None.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS2803E

Tracing could not be disabled.



Explanation:

A problem occurred while trying to disable tracing for the specified
process. This message is usually accompanied by other, more specific
messages immediately preceding or following this message.

System action:

No changes are made to the trace status of the specified process.

User response:

Review the messages that immediately precede or follow this message for
further information about this error.

------------------------------------------------------------------------
ANS2804W

Tracing is already enabled. -TRACEFILE, -TRACEMAX, and -TRACESEGSIZE are
ignored.



Explanation:

When tracing is already enabled for a client process, only the
-TRACEFLAGS option has any effect.

System action:

The -TRACEFLAGS options are set on the client process. -TRACEFILE,
-TRACEMAX, and -TRACESEGSIZE are ignored.

User response:

If you need to modify the -TRACEFILE, -TRACEMAX, or -TRACESEGSIZE
settings, you must first use the dsmtrace DISABLE command to disable
tracing for the client process. Then run the dsmtrace ENABLE command to
configure the desired trace settings. If it is not necessary to modify
these settings, then this message may be ignored.

------------------------------------------------------------------------
ANS2805I

Tracing has been enabled.



Explanation:

None.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS2806E

Tracing could not be enabled.



Explanation:

A problem occurred while trying to enable tracing for the specified
process. This message is usually accompanied by other, more specific
messages immediately preceding or following this message.

System action:

No changes are made to the trace status of the specified process.

User response:

Review the messages that immediately precede or follow this message for
further information about this error.

------------------------------------------------------------------------
ANS2807E

An incorrect number of parameters was specified for the command-name
command.



Explanation:

The specified command was invoked with too few or too many parameters.

System action:

The command is not processed.

User response:

Try the command again with the correct number of parameters. Run
\"dsmtrace help\" for additional information on dsmtrace command syntax.

------------------------------------------------------------------------
ANS2808W

Incremental by snapshot difference backup did not locate the registered
base snapshot 'regbase-name' on NetApp/N-Series filer volume
'volume-name'. Snapshot 'olderbase-name' is used as the base snapshot.



Explanation:

Incremental by snapshot difference backup did not locate the specified
registered base snapshot on the specified NetApp/N-Series filer volume.
The most recent existing snapshot which is older than the registered
base snapshot is used as the current base snapshot.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS2809E

The backupid 'backupid:' in the input file does not match the vmname
'vmname:' being restored.



Explanation:

There is a discrepency between the backupid and vmname specified in the
input file

System action:

The virtual machine cannot be restored.

User response:

Confirm that the backupid specified matches the vmname you are
attempting to restore by re-running the inquire_detail command and make
any necessary corrections before attempting the restore again.

------------------------------------------------------------------------
ANS2810E

The IBM Spectrum Protect for Virtual Environments Input File 'input
file:' appears to be empty.



Explanation:

While processing the Input File no items were found to operate on.

System action:

The operation cannot continue with an empty list.

User response:

Confirm that the input file is not empty and has valid input. If the
file is not empty it may be that an error occurred while reading the
file, please check the error log for any errors found during the reading
of the file. If errors are found make the necessary corrections before
attempting the operation again.

------------------------------------------------------------------------
ANS2811E

The IBM Spectrum Protect for Virtual Environments could not find a
suitable datamover agent for the DataCenter Node 'datacenter nodename'.



Explanation:

While processing Proxy relationships with the DataCenter Node specified,
no appropriate datamover matches detected

System action:

The operation cannot continue without a valid datamover.

User response:

Work with your IBM Spectrum Protect Administrator to ensure that your
DataCenter Nodes have granted proxy authority to your DataMover Nodes.

------------------------------------------------------------------------
ANS2812E

The IBM Spectrum Protect for Virtual Environments could not find
Datamover node named 'datamover nodename' on the IBM Spectrum Protect
Server.



Explanation:

While processing Proxy relationships with the DataCenter node and
DataMover node specified, no appropriate Datamover node name matches
detected.

System action:

The operation cannot continue without a valid Datamover Node name.

User response:

Make sure the Datamover node name specified is a valid IBM Spectrum
Protect node name and that the node has the proper proxy relationships
established.

------------------------------------------------------------------------
ANS2813E

The IBM Spectrum Protect Server returned an empty network address or
port number for 'datamover nodename'.



Explanation:

While querying the IBM Spectrum Protect Server for the Datamover network
address and port number, the Server returned zero for one of the values.

System action:

The operation cannot continue without a valid Datamover network address
and port number.

User response:

This is usually the result of a Datamover Node not being started. Log on
to the Datamover host and start or restart the DSMCAD service and retry
the IBM Spectrum Protect for Virtual Environments command again. If the
problem persists, work with your IBM Spectrum Protect Server
Administrator to inspect the IBM Spectrum Protect Server activity log to
identify the issue.

------------------------------------------------------------------------
ANS2814E

IBM Spectrum Protect for Virtual Environments detected an error while
parsing the Input File 'input file'. The 'specifier' appears to be empty
or invalid.



Explanation:

While parsing the Input File an error occurred.

System action:

The operation cannot continue without valid virtual machine
specifications.

User response:

This is usually the result of an empty virtual machine name or other
identifier. Please check that the syntax of the Input File is correct
for all entries and that virtual machine names are not empty and retry
the operation.

------------------------------------------------------------------------
ANS2815E

IBM Spectrum Protect for Virtual Environments detected an error while
parsing 'read in line' from the Input File 'input file'.



Explanation:

While parsing the Input File an error occurred.

System action:

The operation cannot continue without valid specifications in the Input
File.

User response:

This may be the result of an empty virtual machine name or other
identifier. Please check that the syntax of the Input File is correct
for all entries and that virtual machine names are not empty and retry
the operation.

------------------------------------------------------------------------
ANS2816E

IBM Spectrum Protect for Virtual Environments detected that the IBM
Spectrum Protect Server IP address was not specified.



Explanation:

While parsing the command line options, an empty Server address was
detected.

System action:

The operation cannot continue without a valid network address for the
IBM Spectrum Protect Server.

User response:

This may be a result of the VMCLI profile having an empty
VE_TSM_SERVER_NAME entry. Please check that the VMCLI profile is
configured correctly specifying the IBM Spectrum Protect Server address.

------------------------------------------------------------------------
ANS2817E

IBM Spectrum Protect for Virtual Environments detected that the vCenter
Command-Line interface node name was not specified.



Explanation:

While parsing the command line options, an empty vCenter Command-Line
interface node name was detected.

System action:

The operation cannot continue without a valid vCenter Command-Line
interface node name.

User response:

This may be a result of the VMCLI profile having an empty
VE__TSMCLI_NODE_NAME entry. Please check that the VMCLI profile is
configured correctly specifying the vCenter Command-line interface node
name.

------------------------------------------------------------------------
ANS2818E

IBM Spectrum Protect for Virtual Environments detected that the IBM
Spectrum Protect Server port was not specified.



Explanation:

While parsing the command line options, an empty IBM Spectrum Protect
Server port was detected.

System action:

The operation cannot continue without a valid IBM Spectrum Protect
Server port.

User response:

This may be a result of the VMCLI profile having an empty
VE_TSM_SERVER_PORT entry. Please check that the VMCLI profile is
configured correctly specifying the IBM Spectrum Protect Server port.

------------------------------------------------------------------------
ANS2820E

An interrupt has occurred. The current operation will end and the client
will shut down.



Explanation:

This message is issued when the process is interrupted by a break signal
such as CTRL-BREAK or CTRL-C.

System action:

The operation and process are ended immediately.

User response:

Restart the operation if desired.

------------------------------------------------------------------------
ANS2821E

The CAD service is not running for data mover node named 'datamover
nodename'.



Explanation:

The CAD service is not running for the data mover.

System action:

The operation cannot continue without a connection to the data mover CAD
service.

User response:

Make sure the data mover CAD service is running and that the node has
the proper proxy relationships established.

------------------------------------------------------------------------
ANS2822E

The data mover is unable to connect to the IBM Spectrum Protect server.



Explanation:

There is no connection the specified IBM Spectrum Protect server.

System action:

The operation cannot continue without a connection to the server.

User response:

Possible causes are that the server name is spelled incorrectly in the
dsm.opt or dsm.sys file; an incorrect server is being used; a
communications failure or firewall issue occurred; or the network cable
is unplugged.

------------------------------------------------------------------------
ANS2824E

IBM Spectrum Protect for Virtual Environments detected that the node
name representing the vCenter is not specified.



Explanation:

While parsing the command line options, an empty vCenter node name was
detected.

System action:

The operation cannot continue without a valid vCenter node name.

User response:

This may be a result of the VMCLI profile having an empty
VE_VCENTER_NODE_NAME entry. Please check that the VMCLI profile is
configured correctly specifying the vCenter node name.

------------------------------------------------------------------------
ANS2825E

IBM Spectrum Protect for Virtual Environments detected that the node
name representing the Datacenter is not specified.



Explanation:

While parsing the command line options, an empty datacenter node name
was detected.

System action:

The operation cannot continue without a valid datacenter node name.

User response:

This is a result of the -d DataCenter Node Name not being passed in to
the Command-line. Re-try the operation making sure to pass the -d
Datacenter Node Name to the command-line call.

------------------------------------------------------------------------
ANS2826E

IBM Spectrum Protect for Virtual Environments detected that the node
name representing the vCenter Datamover is not specified.



Explanation:

While parsing the command line options, an empty Datamover node name was
detected.

System action:

The operation cannot continue without a valid Datamover node name.

User response:

This is a result of the -o Datamover Node Name not being passed in to
the Command-line. Re-try the operation making sure to pass the -o
Datamover Node Name to the command-line call.

------------------------------------------------------------------------
ANS2827E

IBM Spectrum Protect for Virtual Environments detected that the input
file is not specified.



Explanation:

While parsing the command line options, an empty or non-existing input
file name was detected.

System action:

The operation cannot continue without a valid input file name.

User response:

This is a result of the -I Inputfile name not being passed in to the
Command-line. Re-try the operation making sure to pass the -I input file
name to the command-line call.

------------------------------------------------------------------------
ANS2828E

Image operations are not supported for the specified file system.



Explanation:

Image backup and restore are not supported for the specified file
system.

System action:

The requested image operation is not performed.

User response:

Choose another object.

------------------------------------------------------------------------
ANS2829E

Image operations are not supported for GPFS.



Explanation:

Image backup and restore are not supported for GPFS volumes.

System action:

The requested image operation is not performed.

User response:

Choose another object.

------------------------------------------------------------------------
ANS2830E

An incorrect number of parameters was specified.



Explanation:

The specified command was invoked with too few or too many parameters.

System action:

Processing stops.

User response:

Try the command again with the correct number of parameters.

------------------------------------------------------------------------
ANS2831E

Incremental by snapshot difference cannot be performed on 'volume-name'
as it is of type 'type' and is not a NetApp/N-Series 'fsType' volume.



Explanation:

The volume specified cannot be used for performing NetApp/N-Series
snapshot difference incremental operation. The volume does not
correspond to the NFS mount point or the CIFS shared drive for a Network
Appliance or N-Series NAS volume. One possible reason for this failure
is that snapshot difference incremental backups can only be performed
against NetApp/N-Series NFS volumes on AIX/Linux platforms, or CIFS
volumes on Windows platforms.

Another possible reason for this failure is that the qtree security
style for the volume was incorrectly selected. If the CIFS volume is
mapped on Windows, ensure that the security style is set to NTFS. If the
volume is mounted as NFS, ensure that the security style is set to UNIX.

System action:

Processing stops.

User response:

Try the command again with a NetApp/N-Series NFS or CIFS volume with the
correct security style.

------------------------------------------------------------------------
ANS2832E

Incremental by snapshot difference failed for filespace name. See the
error log for details.



Explanation:

Failed to perform NAS NFS/CIFS Incremental by snapshot difference
operation.

System action:

Processing stops.

User response:

Take appropriate action based on the information in the error log. If
the problem persists please contact your IBM Spectrum Protect
administrator.

------------------------------------------------------------------------
ANS2834E

You have to be a root user in order to perform incremental backup using
snapshot difference.



Explanation:

Failed to perform NAS NFS/CIFS incremental backup operation using
snapshot difference as the user was non root.

System action:

Processing stops.

User response:

Please retry the operation as root user.

------------------------------------------------------------------------
ANS2835E

Incremental backup using snapshot difference is not supported on this
platform.



Explanation:

NetApp NFS/CIFS incremental backup operation using snapshot difference
is only supported on Linux and Windows platforms.

System action:

Processing stops.

User response:

Retry the incremental operation without the snapdiff option.

------------------------------------------------------------------------
ANS2836E

Incremental backup operation using snapshot difference is only available
for full volumes. is a partial volume or qtree.



Explanation:

Cannot perform NAS NFS/CIFS incremental backup operation using snapshot
difference on the mounted or mapped volume due to one of the following
reasons: 1) The volume is actually a qtree. 2) The volume is not a full
volume, it is not mounted or mapped to the root of the volume.

System action:

Processing stops.

User response:

Retry the incremental backup operation by specifying an entire NAS NFS
or CIFS volume.

------------------------------------------------------------------------
ANS2837E

Unable to access the required stored NetApp filer credentials (user id
and password) for filer ''. Make sure the SET PASSWORD -TYPE=FILER
command was specified correctly to store the credentials.



Explanation:

The user id and password for the specified NetApp Filer have been either
not configured or have been specified incorrectly.

System action:

Processing stops.

User response:

Use the 'set password -type=filer' command to define the user id and
password for the specified NetApp Filer and retry the snapshot
differential backup operation.

------------------------------------------------------------------------
ANS2838W

The file path 'filename' exceeds HSM maximaum path length.



Explanation:

A file that you tried to migrate has a path name that is too long.

System action:

File skipped from migration.

User response:

Place files into a shorter path to make them available for migration.

------------------------------------------------------------------------
ANS2839E

Failed with ONTAPI error 'error_code' while connecting to NetApp Filer
'filer_name' using user id 'id_name'. You might have provided
credentials incorrectly for this Filer.



Explanation:

The user ID and password have been configured incorrectly for the
specified Filer.

If you are using the snapdiffhttps option, ensure that you are not
specifying vFiler volumes as vFiler does not support the HTTPS transport
type.

System action:

Processing stops.

User response:

Make sure that the credentials you have specified for the Filer are the
correct ones. Use the dsmc set password command to specify the correct
credentials for your Filer and try the command again.

------------------------------------------------------------------------
ANS2840E

Incremental backup using snapshot difference is not supported for NetApp
file server 'file-server-name' at Data ONTAP version
'version.modification.submodification'.



Explanation:

The file server specified is not at the Data ONTAP version that supports
snapshot difference API. Current supported versions of Data ONTAP are
7.3 - 9.8.

System action:

Processing stops.

User response:

Upgrade the file server to supported Data ONTAP version and retry the
operation.

------------------------------------------------------------------------
ANS2841E

Incremental by snapshot difference is only supported on AIX 64 bit and
Linux 86 bit clients.



Explanation:

Incremental backup using snapshot difference feature is only available
on IBM Spectrum Protect AIX 64 bit and Linux 86 clients.

System action:

Processing stops.

User response:

Try the command again with an IBM Spectrum Protect AIX 64 bit or Linux
86 client.

------------------------------------------------------------------------
ANS2842E

IBM Spectrum Protect for Virtual Environments detected an error with the
createsnap: keyword. createsnap:yes is specified while also specifying
vmsnapname:VMWare Snapshot Name.



Explanation:

While parsing the Input File for FlashCopy Manager for VMWare offload
backup, an error condition was detected with VM Ware snapshot handling.
Specifying a VMWare Snapshot name while specifying createsnap:yes is not
allowed.

System action:

The operation cannot continue without specifying the correct createsnap:
and vmsnapname: combination.

User response:

This is a result of the -I Inputfile containing conflicting input for
createsnap: and vmsnapname: keywords. If you intend to have IBM Spectrum
Protect for Virtual Environments use a VMWare Snapshot created by
FlashCopy Manager then specify createsnap:no with a valid VMWare
Snapshot for the vmsnapname: keyword.

------------------------------------------------------------------------
ANS2850E

Error Creating Snapshot: Volume NAS volume is a snapmirror destination
volume.



Explanation:

An attempt was made to create a snapshot on a read only snapmirror
destination volume.

System action:

Processing stops.

User response:

Rety the operation using the USEEXISTINGBASE and DIFFSNAPSHOT=latest
options.

------------------------------------------------------------------------
ANS2851E

Snapshot Processing Error: .



Explanation:

An error occurred due to the reason specified in the message

System action:

Processing stops.

User response:

Ensure that the specified volume is online and allows write access.

------------------------------------------------------------------------
ANS2855W

IBM Spectrum Protect for Virtual Environments detected an error while
parsing the Input File 'input file'. The 'specifier' should not be
specified when using 'specifier'. Option will be ignored.



Explanation:

While parsing the Input File an error occurred.

System action:

The operation will continue ignoring this parameter.

User response:

This is usually the result of an identifier used with the wrong option.
Please check that the options in the Input File matches the requested
operation and retry the operation.

------------------------------------------------------------------------
ANS2856E

IBM Spectrum Protect for Virtual Environments detected that the node
name representing the vCloud is not specified.



Explanation:

A node name that represents the vCloud is not specified in the VMCLI
profile.

System action:

The operation cannot continue without a valid vCloud node name.

User response:

Specify the vCloud node name in the VE_VCENTER_NODE_NAME parameter in
the VMCLI profile. Then, try the operation again.

------------------------------------------------------------------------
ANS2857E

IBM Spectrum Protect for Virtual Environments detected while parsing
'read in line' from the input file 'input file' that option 'specifier'
is required for 'operation' operation.



Explanation:

A required option or identifier is missing from the input file.

System action:

The operation stops.

User response:

This may be the result of a missing option or identifier. Verify that
the syntax of the command and the syntax of the values in the input file
are correct. Then, try the operation again.

------------------------------------------------------------------------
ANS2858E

Failed to get the list of available VMs for backup



Explanation:

Failed to get the entire list of VMs in order to choose ones that needed
to be backed up.

System action:

The operation was stopped

User response:

Verify that configuration parameters for connection to vCenter.

------------------------------------------------------------------------
ANS2859E

Failed to locate the Organization VDC node that is used to store the
backed up data.



Explanation:

The Organization VDC node that stores the backed up vApp data was not
located. This node must be mapped to the Provider VDC node. This issue
might be caused by invalid mapping between the Provider VDC node and the
Organization VDC node.

System action:

The operation was stopped

User response:

Go to the Configuration page and click 'Run the Configuration Wizard' to
verify that mapping information for the Provider VDC node is valid.

------------------------------------------------------------------------
ANS2860E

The PRESNAPSHOTCMD command failed. The snapshot differential backup will
not be executed.



Explanation:

The command specified by the PRESNAPSHOTCMD option must complete
successfully in order to execute the snapshot differential backup. If
the command completed with a return code of 0 (zero), it is considered
to have completed successfully. If the command completed with any other
return code, it is considered to have failed. If the command failed then
the snapshot differential backup is not executed.

System action:

The client does not execute the snapshot differential backup operation.

User response:

Identify and repair the problem that caused the command to fail. If a
non-zero return code is normal for this command, then consider wrapping
the command in a script that always exits with a return code of zero.

------------------------------------------------------------------------
ANS2861W

The POSTSNAPSHOTCMD command failed.



Explanation:

If the command specified by the POSTSNAPSHOTCMD option completed with a
non-zero return code, the snapshot differential backup operation
continues. The operation continues with a warning-level result. The
result of the POSTSNAPSHOTCMD command does not supersede a higher result
from the snapshot differential backup command. For example, if the
snapshot differential backup command completed with code 12, a lower
return code from the POSTSNAPSHOTCMD command does not alter the return
code.

System action:

The snapshot differential backup continues, but with a warning return
code of at least 8.

User response:

Identify and repair the problem that caused the command to fail.
Consider wrapping the command in a script that always exits with a
return code of zero.

------------------------------------------------------------------------
ANS2862E

No entry found for the specified Storage Virtual Machine.



Explanation:

The SVM does not exist in the registry or password file.

System action:

No operation is performed.

User response:

The user should register the SVM using the Set NetAppSVM command.

------------------------------------------------------------------------
ANS2863E

The backup-archive client failed to load the vCloud protection runtime
library.



Explanation:

vCloud protection runtime library is not loaded by the backup-archive
client.

System action:

The operation is stopped

User response:

Verify that the vCloud runtime library exist in the 'plugins' folder
under the client installation folder.

------------------------------------------------------------------------
ANS2864E

A Hyper-V operation was attempted, but the Hyper-V role was not detected
on the host system.



Explanation:

The Hyper-V role must be enabled on the host system where the Hyper-V
operation occurs. The current host system either does not have the
Hyper-V role enabled or does not support Hyper-V.

System action:

The operation does not start.

User response:

If the host system supports Hyper-V then enable the Hyper-V role.
Otherwise, try the operation again from a host system that supports
Hyper-V and has the Hyper-V role enabled.

If you want to process VMware virtual machines, go to the IBM Spectrum
Protect window, and click Edit > Client Preferences > VM Backup. Click
VMWare Full VM or VMWare File Level. Then, click OK.

------------------------------------------------------------------------
ANS2865E

An error occurred creating or accessing a virtual disk for virtual
machine 'VM-name'.



Explanation:

An error occurred creating or accessing a virtual disk while restoring a
virtual machine.

System action:

The virtual machine is not restored.

User response:

See the client error log for more detailed information about the error.

------------------------------------------------------------------------
ANS2866E

An error occurred creating virtual machine 'VM-name'.



Explanation:

An error occurred creating the virtual machine during the restore
operation.

System action:

The virtual machine is not restored.

User response:

See the client error log for more detailed information about the error.

------------------------------------------------------------------------
ANS2867E

An error occurred querying virtual machine 'VM-name'.



Explanation:

An error occurred querying the virtual machine during the restore
operation.

System action:

The virtual machine is not restored.

User response:

See the client error log for more detailed information about the error.

------------------------------------------------------------------------
ANS2868E

An error occurred removing virtual machine 'VM-name'.



Explanation:

An error occurred removing the virtual machine during the restore
operation.

System action:

The virtual machine is not restored.

User response:

See the client error log for more detailed information about the error.

------------------------------------------------------------------------
ANS2869E

A virtual machine on the hypervisor has a different name but the same ID
as virtual machine to restore 'VM-name' has. Restore not allowed.



Explanation:

A virtual machine with a different name and the same ID than the virtual
machine being restored exists on the hypervisor.

System action:

The virtual machine is not restored.

User response:

Choose a different virtual machine to restore to or delete the existing
virtuual machine.

------------------------------------------------------------------------
ANS2870W

An incremental backup of virtual machine 'vmname' was requested, but the
virtual machine lacks an existing recovery snapshot. A full backup will
be taken to prevent data loss.



Explanation:

Removal of the recovery snapshot of a virtual machine does not reset the
last successful backup time maintained internally. The lack of a reset
creates an inconsistency between the backup time and the hard disk
configuration of the virtual machine. A full backup fixes the ambiguity
and prevent data loss.

System action:

An inconsistency in the virtual machine configuration was detected.

User response:

Avoid deleting the recovery snapshot between back up operations.

------------------------------------------------------------------------
ANS2872E

The process was unable to restore a virtual disk user metadata entry of
virtual machine 'vmname' to disk 'diskpath'.



Explanation:

An attempt to restore a user metadata entry of a disk failed. The user
metadata of the disk may inaccessible or unreachable.

System action:

A restore of a virtual disk.

User response:

Check the user privileges include access to virtual disk writes or move
the disk to an accessible location.

------------------------------------------------------------------------
ANS2873I

Virtual machine 'vmname' was successfully restored. If this virtual
machine was restored to a cluster, ensure that the cluster settings
enable the restored virtual machine to operate in high availability
mode. High availability settings, and the preferred set of hypervisor
nodes that can operate in high availability mode, might not be set
automatically.



Explanation:

The specified virtual machine has been restored, but the restore process
does not alter Microsoft Failover Clustering High Availability settings.
If you restored a virtual machine that you previously deleted, or if you
restored a virtual machine to a new name and location, the restored
virtual machine might not be enabled as a high availability resource.
Enable high availability for this virtual machine by using Microsoft
Failover Cluster Manager, System Center Virtual Machine Manager, or by
using PowerShell cmdlets.

System action:

Processing continues.

User response:

Use Microsoft Failover Cluster Manager, System Center VM manager, or
PowerShell to configure the cluster to allow this virtual machine to
perform in a high availability configuration.

------------------------------------------------------------------------
ANS2876E

Unable to access the required stored NetApp Management Filer credentials
(user id and password) for filer '' associated with storage virtual
machine '' . Make sure the SET PASSWORD -TYPE=FILER command was
specified correctly to store the credentials.



Explanation:

The user id and password for the specified NetApp management filer
associated with the specified storage virtual machine have been either
not configured or have been specified incorrectly.

A storage virtual machine is associated with management filer using the
SET NETAPPSVM command. Credentials for a management filer are stored
with the SET PASSWORD -TYPE=FILER command.

System action:

Processing stops.

User response:

Use the 'set password -type=filer' command to define the user id and
password for the specified NetApp Management Filer. Use the 'set
netappsvm' command to associated a storage virtual machine with a
management filer. Ensure that both of these commands were specified
correctly and retry the snapshot differential backup operation.

------------------------------------------------------------------------
ANS2877I

Restart action for cluster resource 'resourceName' is changed from
'oldValue' to 'newValue'



Explanation:

The specified virtual machine is configured for high availability, but
must be deleted before it is restored. To prevent the cluster service
from attempting a failover of the virtual machine to another cluster
node, IBM Spectrum Protect sets the RestartAction policy of the
indicated cluster resource to "ClusterResourceDontRestart". After the
restore is finished, IBM Spectrum Protect sets the RestartAction to its
original value.

System action:

Processing continues.

User response:

Usually no further user action is required. However, if the restore
operation is interrupted and subsequently restarted, then after the
restore is finished, the RestartAction policy of the resource must be
manually updated to its original value. In that case, use the
information in this message to update the RestartAction policy to the
original value.

------------------------------------------------------------------------
ANS2878E

Failed to change restart action for cluster resources 'resourceName'
from 'oldValue' to 'newValue'



Explanation:

IBM Spectrum Protect was unable to alter the "RestartAction" policy of
the specified cluster resource. The specified virtual machine is
configured for high availability, but must be deleted before it is
restored. To prevent the cluster service from attempting a failover of
the virtual machine to another cluster node, IBM Spectrum Protect tries
to set the RestartAction policy of the indicated resource to
"ClusterResourceDontRestart". After the restore is finished, IBM
Spectrum Protect tries to set the RestartAction to its original value.
However, an attempt to alter the RestartAction policy was unsuccessful.

System action:

Processing continues.

User response:

After the restore is finished, the RestartAction policy of the resource
must be manually changed to its original value. Use the information in
this message to update the RestartAction policy to its original value.

------------------------------------------------------------------------
ANS2888E

Backup VM Full VM Incremental is unable to run. A valid IBM Spectrum
Protect for Virtual Environments license file (license-file) cannot be
located.



Explanation:

The license file was not found, or cannot be opened because of
permissions, or the file is corrupted.

System action:

The system returns to the calling procedure.

User response:

Check permissions on file. See if the license file is in the correct
place.

------------------------------------------------------------------------
ANS2889I

The vApp 'vapp name' was successfully restored under the name 'new vapp
name'



Explanation:

The restore operation was succesful in restoring the vApp into the
specified name.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS2890E

The file to restore already exist and the number of copies with same
backup date has been reached on the specified target location!



Explanation:

On the specified target location the file to restore already exist, a
copy of the file with appended the backup date exist and the number of
files with same backup date has been reached.

System action:

The file is skipped.

User response:

Check on the target location if copies of the same file can be removed
or restore the file to a different location.

------------------------------------------------------------------------
ANS2891W

The vApp 'vapp name' was successfully restored. However, failed vms num
out of existing vms num VMs were not restored.



Explanation:

Although the vApp restore operation on the vCloud completed
successfully, one or more VMs were not restored.

System action:

The operation completed successfully. However, some VMs were not
restored.

User response:

Check the dsmerror.log file for information about why the VMs were not
restored. Then, try the operation again. If the problem persists, visit
the IBM Support Portal for additional information at
http://www.ibm.com/support/entry/portal/.

------------------------------------------------------------------------
ANS2900E

IBM Spectrum Protect for Virtual Environments detected that the scan
domain was not specified.



Explanation:

While parsing the command line options, no scan domain was detected.
This error occurred because the -domain option was not specified.

System action:

The operation cannot continue without a valid scan domain.

User response:

Run the operation again and specify the -domain option.

------------------------------------------------------------------------
ANS2901E

IBM Spectrum Protect for Virtual Environments detected that the domain
user was not specified.



Explanation:

While parsing the command line options, no domain user was detected.
This error occurred because the -user option was not specified.

System action:

The operation cannot continue without a valid domain user.

User response:

Run the operation again and specify the -user option.

------------------------------------------------------------------------
ANS2902E

Save domain password failed in function func-name with return code
return-code.



Explanation:

An unexpected write access error occurred when the function tried to
save the domain password. Write access does not exist to either the
registry or to the IBM Spectrum Protect for Virtual Environments on
Linux installation folder where the password file is saved.

System action:

The operation ends.

User response:

Grant write access to either the registry or to the IBM Spectrum Protect
for Virtual Environments on Linux installation folder and try the
operation again.

------------------------------------------------------------------------
ANS2903E

Read domain password failed in function func-name with return code
return-code.



Explanation:

An unexpected error occurred when the function tried to read the domain
password.

System action:

The operation ends.

User response:

On Windows, verify that the password exists in the registry. On Linux,
verify that the password exists in the password file. Try the operation
again.

------------------------------------------------------------------------
ANS2998I

The option 'option' that was found in the include/exclude file
'file-name' at the line number: number is not supported and will be
ignored by the client.



Explanation:

The specified option is valid but not supported on the current platform
and will be ignored by the client.

System action:

Processing continues.

User response:

You can ignore the message or remove the option from the include/exclude
file.

------------------------------------------------------------------------
ANS3000I

communication-type communications available on port port-number.



Explanation:

The specified communications are available on the specified port number.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS3001W

The default locale, English (United States), is used because the
selected locale "locale" is not supported. The supported locales are as
follows: supportedLocales



Explanation:

The locale on the user's system or browser is not supported.

System action:

The system defaults to the English (United States) locale.

User response:

Use the default locale or switch to one of the supported locales.

------------------------------------------------------------------------
ANS3002I

Session started for user userid (communication-method address).



Explanation:

A session was started for the specified user.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS3003I

The new password is case sensitive.



Explanation:

Your account has been updated to use case sensitive password.

System action:

None

User response:

Make sure to remember the new password as you enter it, including
character casing. For more details, contact your IBM Spectrum Protect
administrator.

------------------------------------------------------------------------
ANS3004E

Session for user userid terminated - invalid password entered.



Explanation:

A session was terminated for the specified user because an invalid
password was entered.

System action:

The session with the specified user is terminated.

User response:

Re-start the remote client and enter the correct password for the
specified user.

------------------------------------------------------------------------
ANS3005I

Session for user userid terminated - idle for idle-minutes minutes.



Explanation:

A session was terminated for the specified user because there was no
activity on the session for the specified number of minutes.

System action:

The session with the specified user is terminated.

User response:

Re-start the remote client to begin a new session.

------------------------------------------------------------------------
ANS3006I

Processing request for the IBM Spectrum Protect Web Client (ip-address).



Explanation:

A request for the Web Client is being processed.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS3007I

IBM Spectrum Protect client-name terminating - idle for idle-minutes
minutes.



Explanation:

The specified client is terminating because it has been idle for the
specified time. It will be automatically started when it is needed.

System action:

The client program stops.

User response:

None.

------------------------------------------------------------------------
ANS3008E

Too many symbolic links were detected while resolving name 'file_name'



Explanation:

While trying to resolve the file name, too many symbolic links were
found.

System action:

File skipped.

User response:

Ensure that you do not have a looping symbolic link for the file.

------------------------------------------------------------------------
ANS3009E

The Logical Volume Snapshot Agent plugin library was not found.



Explanation:

The Logical Volume Snapshot Agent (LVSA) plugin library should have been
installed when the client was installed, but it cannot be found.

System action:

The selected operation is not performed.

User response:

Try the operation again. If the problem recurs, re-install the IBM
Spectrum Protect client software. If the problem persists, contact IBM
technical support for further assistance.

------------------------------------------------------------------------
ANS3010E

The snapshot wizard operation failed.



Explanation:

The snapshot wizard operation failed with a non-zero return code. Check
the error log for additional information.

System action:

The selected operation is not performed.

User response:

Review the error log for any error messages, and then retry the
operation after correcting the cause for failure.

------------------------------------------------------------------------
ANS3011E

Previous changes have not been commited. The machine must be rebooted
before this operation can be performed



Explanation:

A previous operation required the machine to be rebooted for the changes
to take effect, but the machine has not been rebooted. The machine must
be rebooted before this selected operation can be performed.

System action:

The selected operation is not performed.

User response:

Reboot the machine and then retry the operation.

------------------------------------------------------------------------
ANS3012E

The Logical Volume Snapshot Agent is not installed. Use the Setup Wizard
to configure either Online Image or Open File support and choose the
Logical Volume Snapshot Agent as the snapshot provider.



Explanation:

The selected operation requires the Logical Volume Snapshot Agent, but
it is not installed. Use the Setup Wizard to install the LVSA.

System action:

The selected operation is not performed.

User response:

Retry the operation after installing the Logical Volume Snapshot Agent.

------------------------------------------------------------------------
ANS3013E

The specified snapshot provider is not supported on this version of the
operating system.



Explanation:

The specified snapshot provider is not supported on the version of the
operating system you are currently running. If another snapshot provider
is available, select it and retry the operation.

System action:

The selected operation is not performed.

User response:

If another snapshot provider is available, select it and retry the
operation.

------------------------------------------------------------------------
ANS3014E

Expose snapshot failed for backup document 'xml-backup-doc-file'.



Explanation:

Expose snapshot failed.

System action:

Processing stops

User response:

See the dsmerror.log file for further details.

------------------------------------------------------------------------
ANS3015I

communication-type communications not available on port port-number due
to port being in use. Select the unique port in the options file.



Explanation:

The specified communications not available on the port number being in
use.

System action:

The acceptor service stopped. Define the unique port number. Restart the
Acceptor service.

User response:

Define the unique port numbers for every service.

------------------------------------------------------------------------
ANS3016W

Journaled file system filespace is no longer available to the journal
service. Changes to this file system are not journaled until the file
system is brought online. Check the the system to determine why the file
system is not available.



Explanation:

The journal service periodically checks that the file system is still
available. The frequency of the check is determined by the
DeferRetryInterval setting in the tsmjbbd.ini file. This message is
displayed when the journal service loses the connection to the disk.

System action:

The journal service periodically checks if the disk comes back online.
The frequency of the check is determined by the DeferRetryInterval
setting in the tsmjbbd.ini file.

User response:

Check the system to determine why the file system is unavailable. Next
actions depend why the disk is unavailable. For example, if the disk was
quickly removed and then reinserted, no further action might be
necessary. If the disk was replaced or reformatted, you might need to
restore the disk before resuming backup operations.

------------------------------------------------------------------------
ANS3017W

Attempting to restart the file system monitor for filesystem.



Explanation:

The journal service tries to restart the file system monitor for a file
system that unexpectedly became unavailable.

System action:

The journal service tries to restart the file system monitor for a file
system that unexpectedly became unavailable.

User response:

Check the system to determine why the file system is unavailable. Next
actions depend why the disk is unavailable. For example, if the disk was
quickly removed and then reinserted, no further action might be
necessary. If the disk was replaced or reformatted, you might need to
restore the disk before resuming backup operations.

------------------------------------------------------------------------
ANS3018I

Journaled file system filespace is online.



Explanation:

The journal service periodically checks that the file system is still
unavailable. The frequency of the check is determined by the
DeferRetryInterval setting in the tsmjbbd.ini file. This message is
displayed when the journal service get the connection to the disk again.

System action:

None.

User response:

Check the system to determine why the file system was unavailable. Next
actions depend why the disk was unavailable. For example, if the disk
was quickly removed and then reinserted, no further action might be
necessary. If the disk was replaced or reformatted, you might need to
restore the disk before resuming backup operations.

------------------------------------------------------------------------
ANS3019W

Multiple Snapshots found with same GUID. GUID:guid.



Explanation:

During a VSS Query operation, multiple snapshots with the same GUID were
found. Its likely one is a orpahan

System action:

Operation continues

User response:

Use a tool such as VssAdmin to inspect the snapshots on your server.
Remove any that are invalid.

------------------------------------------------------------------------
ANS3100E

Unable to get the iSCSI initiator name. The Windows error is (error)



Explanation:

The iSCSI initiator name is not configured on the system.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation about how to configure the
iSCSI initiator name.

------------------------------------------------------------------------
ANS3101E

The mount operation for virtual machine 'vmname' failed with rc =
return-code. For more details, check the Recovery Agent logs.



Explanation:

An error occurred during the mount operation. See the output from the
previous operation to identify the cause of the error.

System action:

Processing stops.

User response:

Review the recovery agent logs for information about how to resolve this
issue.

------------------------------------------------------------------------
ANS3102I

'VMNAME' mounted successfully and is ready



Explanation:

The mount operation for the specified virtual machine completed
successfully. As a result, the virtual machine is ready for a file
restore operation.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS3103E

Unable to load the dynamic link library (iscsidsc.dll). The Windows
error is (error)



Explanation:

The iSCSI dynamic link library (iscsidsc.dll) cannot be found on the
system.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation about how to install the
dynamic link library (iscsidsc.dll).

------------------------------------------------------------------------
ANS3104E

A target was not found on the iSCSI portal The missing target is
'target'



Explanation:

The iSCSI portal is unable to discover all of the targets that were
created by the IBM Spectrum Protect Recovery Agent command-line
interface.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation about how to correct this
iSCSI portal issue. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3105E

Unable to connect all targets on the iSCSI Portal The target that is not
connected is 'target'. Windows error is (error)



Explanation:

The iSCSI portal is unable to connect all discovered targets that were
created by the IBM Spectrum Protect Recovery Agent command-line
interface.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation about how to correct this
iSCSI portal issue. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3106E

Windows Configuration Manager is unable to scan for new hardware.
Windows error is (error)



Explanation:

The new iSCSI disk connection cannot be detected by the Windows
Configuration Manager.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation about how to correct this
hardware scan issue.

------------------------------------------------------------------------
ANS3107E

The attempt to retrieve information for disk 'disk' failed with Windows
error (error).



Explanation:

A Windows API call failed to retrieve the disk information.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3108W

The disk with label='label' is not mounted because it was excluded
during the backup (Reason: 'reason').



Explanation:

The disk cannot be mounted because it was excluded during backup. It is
not possible to recover files from any of the file systems or volumes
that use this disk. Possible reasons for the disk exclusion are: - The
disk was explicitly excluded by using the 'exclude.vmdisk' option. - The
disk is an independent disk, which cannot be backed up. The virtual
machine (VM) was backed up by using the 'vmprocessvmwithindependent yes'
option, which backs up normal disks while excluding independent disks. -
The disk contains one or more raw device mapping volumes that are
provisioned in physical compatibility mode (pRDM), which cannot be
backed up. The virtual machine was backed up by using the
'vmprocessvmwithprdm yes' option, which backs up normal disks while
excluding pRDM disks.

System action:

The operation continues.

User response:

- If the data is on a normal disk, then ensure that the disk is included
in the backup. - If the data is on an independent or pRDM disk, recreate
the disk on the restore machine. The data on the disk cannot be restored
because it was not backed up. - If a volume was striped across both
normal and independent disks, use a full virtual machine restore rather
than a file-level restore. Note that the data on the striped volume will
not be intact if all or part of the volume was striped across
independent disks, which are not part of the VMware snapshot. - If files
from the affected file systems or volumes must be recovered, ensure that
the disk is included in the backup.

------------------------------------------------------------------------
ANS3109E

The mount cannot be retrieved because the following mount ID cannot be
found: mountID



Explanation:

An error occurred while retrieving the mount with the mount ID that is
specified.

System action:

Processing stops.

User response:

No response is required.

------------------------------------------------------------------------
ANS3110E

Unable to communicate with Windows device 'device'. The Windows error is
(error)



Explanation:

A Windows API call failed to open a Windows device.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3111E

Unable to mount the same dynamic disks mutliple times. The disk 'disk'
signature is the same as the disk signature of another disk that is
online.



Explanation:

It is not possible to attach a second disk to the system with the same
disk signature.

System action:

The operation stops.

User response:

The other disk with the identical disk signature must be dismounted
before you can attempt the operation again.

------------------------------------------------------------------------
ANS3112E

Windows Virtual Disk Service is not able to detect all new devices.



Explanation:

The Virtual Disk Service VDS is unable to access all iSCSI targets. Some
targets are missing or not working.

System action:

The operation will be rolled back and stopped.

User response:

Determine why the data mover cannot access some iSCSI targets. Determine
that the IBM Spectrum Protect server is working correctly. Determine
that the iSCSI service is running. Search the Windows event log for
problems with the missing devices.

------------------------------------------------------------------------
ANS3113E

The virtual machine 'name' has at least one mirror or RAID5 volume.
Mirror and RAID5 support is disabled!



Explanation:

During the mount operation it was detected that the virtual machine has
a mirror or RAID5 volumes. The support for such volumes were diabled by
the Administrator.

System action:

The operation stops.

User response:

Contact the Administrator for more information.

------------------------------------------------------------------------
ANS3114E

The attempt to retrieve information for volume 'volume' failed with
Windows error (error).



Explanation:

A Windows API call failed to retrieve the volume information.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3115E

The attempt to bring disk 'disk' online failed with Windows error
(error).



Explanation:

A Windows API call failed to bring the disk online.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3116E

The attempt to create directory 'dir' failed with Windows error (error).



Explanation:

A Windows API call failed to create the directory.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3117E

The mount volume attempt at directory 'dir' failed with Windows error
(error).



Explanation:

A Windows API call failed to mount the specified volume.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3118E

Unable to determine the operating system type of the VM to be restored.



Explanation:

The operating system type of the VM to be restored cannot be determined.
This issue can occur when the restore parameter -VMOSType is not
specified or it specifies an incorrect operating system type.

System action:

The operation stops.

User response:

Use the -VMOSType parameter to specify the correct operating system type
of the VM to be restored.

------------------------------------------------------------------------
ANS3119W

Operating system type "name1" is detected but operating system type
"OSname" is specified.



Explanation:

The operating system type of the detected VM does not match the type
specified with the restore parameter -VMOSType. Inconsistent operating
system types might negatively impact the mount operation. The operation
will continue using "OSname" as the operating system type.

System action:

The operation continues.

User response:

If the mount operation fails, try the operation again and use automatic
detection or specify the correct operating system.

------------------------------------------------------------------------
ANS3121I

The TCP/IP V4 is not available for interprocess communication, V6 will
be used.



Explanation:

The commmethod option is V6Tcpip but for interprocess communication IBM
Spectrum Protect uses both methods. Initialization of the TCP/IP V4
failed so the TCP/IP V6 communication method will be used.

System action:

Process continues

User response:

None

------------------------------------------------------------------------
ANS3122E

The Microsoft iSCSI Initiator Service encountered an error. The Windows
error is (error).



Explanation:

The Microsoft iSCSI Initiator Service encountered an error during an
iSCSI operation. This error caused the operation to stop.

System action:

The operation stops.

User response:

See the Microsoft iSCSI Initiator Service error message to determine the
cause of the error. If necessary, see the appropriate Microsoft
Documentation for information about how to resolve this iSCSI Initiator
error.

------------------------------------------------------------------------
ANS3123E

Unable to read or write the local VM file restore data. filename File
cannot be accessed or is damaged.



Explanation:

For VM file restore operations, data must be stored on the local data
mover in a directory that the user running the restore can access. The
data file might also be damaged.

System action:

Processing stops.

User response:

To store the VM file restore data, the data mover application requires
read and write access to the C:\Documents and
Settings\AllUsers\Application Data\Tivoli\TSM\ or
C:\ProgramData\Tivoli\TSM folder. Set the access rights to this
directory so that your user has the correct rights. If the file was
damaged it can be helpful to replace the current version with the .bak
file.

------------------------------------------------------------------------
ANS3124E

The user session cannot be retrieved because the context ID cannot be
found



Explanation:

An error occurred while retrieving the current user session. The error
might be caused by a session that timed out.

System action:

Processing stops.

User response:

If the session timed out, log in again.

------------------------------------------------------------------------
ANS3125E

The local data for file restore mount with the ID: id and virtual
machine name 'name' cannot be found!



Explanation:

The local data set for the specified mount ID or virtual machine name
cannot be found.

System action:

The operation stops.

User response:

Use the query "dsmc q vm <name> -vmrestoretype=mount" command to get the
correct mount ID and virtual machine name for the cleanup.

------------------------------------------------------------------------
ANS3126E

The node name of the mount proxy partner could not be found.



Explanation:

An error occurred while querying the IBM Spectrum Protect server for the
mount proxy partner. The node could not be found. Communication with the
mount proxy partner is required to perform the restore operation.

System action:

Processing stops.

User response:

Check the mount proxy partner node configuration and ensure that the
node is correctly configured and running.

------------------------------------------------------------------------
ANS3127E

The IP address or port of the mount proxy partner could not be found.



Explanation:

An error occurred while querying the IBM Spectrum Protect server for the
mount proxy partner. The IP address or port of that partner could not be
found. The address and port are required to process file restores.

System action:

Processing stops.

User response:

Check the node configuration and ensure that the mount proxy partner is
correctly configured and running. Verify that the client acceptor daemon
on the mount proxy partner is running and able to connect to the IBM
Spectrum Protect server.

------------------------------------------------------------------------
ANS3128E

The node name of the Windows mount proxy does not comply with IBM
Spectrum Protect naming conventions.



Explanation:

An error occurred while querying the IBM Spectrum Protect server for
Linux mount proxy partner. The name of the Windows mount proxy does not
comply the naming convention. A correct name is required for processing
of Linux VMs.

System action:

Processing stops.

User response:

Check the node configuration and ensure that the mount proxy name is
correct. Use the web based configuration wizard to set up the
configuration.

------------------------------------------------------------------------
ANS3129I

The mount cleanup of VM 'VMNAME' completed.



Explanation:

The mount cleanup operation for the specified virtual machine completed.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS3130E

The mount cleanup operation for virtual machine 'vmname' failed with rc
= return-code



Explanation:

An error occurred during the mount cleanup operation. See the output
from the previous operations to identify the cause of the error.

System action:

Processing stops.

User response:

Check the dsmerror.log file for information about how to resolve this
issue.

------------------------------------------------------------------------
ANS3131E

The operation to disconnect the iSCSI targets from the Windows data
mover failed.



Explanation:

An error occurred during the mount cleanup operation while disconnecting
the iSCSI targets. See the output from the previous operations to
identify the cause of the error.

System action:

Processing stops.

User response:

Open the Windows iSCSI Initiator Tool and disconnect the targets and
remove the target portal. Try the operation again. The tool can be found
in "Administrative Tools" -> "iSCSI Initiator"

------------------------------------------------------------------------
ANS3132E

The Windows iSCSI Service is unable to get a list of all currently
running sessions. The Windows error is (error)



Explanation:

The iSCSI Service could not get a list of all connected targets and the
corresponding sessions.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this iSCSI
issue. Try the operation again. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3133E

The target 'target' could not be disconnected by the iSCSI portal. The
Windows error is (error)



Explanation:

The iSCSI portal is unable to disconnect all the connected targets that
were created by the recovery agent command-line interface.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this iSCSI
portal issue. Try the operation again. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3134E

The Windows iSCSI Service is unable to get list of all currently
available portals. The Windows error is (error)



Explanation:

The iSCSI Service has a problem getting a list of all available portals.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this iSCSI
portal issue. Try the operation again. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3135E

The removal of iSCSI Portal 'target' failed with a Windows error of
(error)



Explanation:

The iSCSI Service cannot remove the iSCSI Portal.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this iSCSI
portal issue. Try the operation again. Search
http://technet.microsoft.com/en-US/windowsserver for iSCSI
troubleshooting information.

------------------------------------------------------------------------
ANS3136E

The mount ID was not specified in the cleanup operation.



Explanation:

The -MOUNTID parameter must be specified to perform a 'mountcleanup'
operation.

System action:

The operation stops.

User response:

Use the query "dsmc q vm <name> -vmrestoretype=mount" command to get the
correct mount ID for the cleanup

------------------------------------------------------------------------
ANS3137W

'VMNAME' mount completed with errors.



Explanation:

The mount operation for the specified virtual machine completed with
errors. Only a subset of the virtual machine's disks are ready for a
file restore operation.

System action:

The VM disks that failed were reported in previous messages.

User response:

Review the previous error messages for the cause of each failure.

------------------------------------------------------------------------
ANS3138E

The unmount of the volumes failed during the cleanup operation of mount
ID mountid



Explanation:

An error occurred during the mount cleanup operation while unmounting
the volumes.

System action:

Processing stops.

User response:

See the output from the previous operations to identify the cause of the
error.

------------------------------------------------------------------------
ANS3139E

The attempt to unmount the disk failed with Windows error (error).



Explanation:

The Windows API call failed to unmount the disks.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this issue;
search the documentation for this Windows error.

------------------------------------------------------------------------
ANS3140E

The connection to the following iSCSI targets failed: 'target_list'.



Explanation:

The iscsiadm command-line interface was not able to connect to the
specified iSCSI targets, from the Linux mount proxy machine.

System action:

The operation stops.

User response:

If the target is already connected on the Linux mount proxy machine, log
out from the target, for example: iscsiadm -m node -T targetname
--logout Also, verify that the iSCSI server address is correctly
specified.

------------------------------------------------------------------------
ANS3141W

Mounting the following devices failed: 'device_list'.



Explanation:

It was not possible to mount the specified devices on the Linux mount
proxy machine.

System action:

The operation continues to mount the other devices.

User response:

Perform a cleanup, or try to manually unmount the devices on the Linux
mount proxy machine.

------------------------------------------------------------------------
ANS3142E

The Windows Virtual Disk Service encountered an error. The Windows error
is (error)



Explanation:

The Windows Virtual Disk Service is not working correctly.

System action:

The operation stops.

User response:

See the Microsoft documentation for information to correct this issue.
Search http://technet.microsoft.com/en-US/windowsserver for Virtual Disk
Service troubleshooting information.

------------------------------------------------------------------------
ANS3143W

The ISCSI service is not running. Its state is 'state'.



Explanation:

The ISCSI Service is not running.

System action:

The service maybe suspended, however operations cannot continue.

User response:

Start the ISCSI service.

------------------------------------------------------------------------
ANS3144W

The ISCSI service is not running. File restore mount and instant access
operations will not work.



Explanation:

The ISCSI Service is not running. This service is required on the
Windows and Linux mount proxy for file restore mount operations. This
service is also required for full VM instant access operations.

System action:

Mount operations for file restore cannot continue. Instant access
operations cannot continue.

User response:

Start the ISCSI service if you want to perform a file restore operation
or instant access operation.

------------------------------------------------------------------------
ANS3145E

A Windows API call has failed.



Explanation:

A Windows API call has failed.

System action:

Operations cannot continue.

User response:

See the dsmerror.log for more information.

------------------------------------------------------------------------
ANS3146E

The cleanup operation to unmount the volume volume failed. The mounted
file system is busy.



Explanation:

An error occurred during the mount cleanup operation while unmounting
the volumes on the Linux mount proxy machine.

System action:

Processing stops.

User response:

Ensure the file system is not in use and then try the cleanup operation
again, or manually unmount the volume on the host.

------------------------------------------------------------------------
ANS3147W

The iSCSI Target 'iscsi_target'was disconnected successfully, but the
attempt to delete the target failed.



Explanation:

It was not possible to delete the object after the target was
disconnected.

System action:

The operation continues.

User response:

Try to manually delete the object on the Linux machine. For example:
iscsiadm -m node -T targetname -o delete

------------------------------------------------------------------------
ANS3148W

The iSCSI Target 'iscsi_target' was already connected.



Explanation:

The target was already connected on the Linux mount proxy machine. This
error can occur if a cleanup was not perfomed, or if the cleanup was
only partially successful.

System action:

The operation continues.

User response:

The Linux mount proxy machine tried to reuse the already connected
targets. If the volumes are not correctly mounted, manually disconnect
the targets on the Linux mount proxy machine. For example: iscsiadm -m
node -T targetname --logout; iscsadm -m node -T targetname -o delete

------------------------------------------------------------------------
ANS3149E

The iSCSI target 'target' failed to disconnect from the Linux machine.
The message from the iscsiadm command-line interface is: message_output



Explanation:

The iscsiadm command-line interface was unable to disconnect the
specified iSCSI target from the Linux machine.

System action:

The operation stops.

User response:

See if the target is already disconnected on the Linux machine, or try
to manually disconnect it. For example, iscsadm -m node -T targetname
--logout Verify that the iSCSI server address is correctly specified.

------------------------------------------------------------------------
ANS3150W

The block device 'block_device' of type 'device_type' failed to mount.
The system message is:'system_message'



Explanation:

It was not possible to mount one or more devices on the Linux machine.

System action:

The operation continues to mount the other devices.

User response:

Perform a cleanup, or try to manually unmount the devices on the Linux
machine.

------------------------------------------------------------------------
ANS3151E

The initiator.iscsi file does not exist or cannot be opened.



Explanation:

The file does not exist or cannot be opened.

System action:

Operations cannot continue.

User response:

The ISCSI service may not be installed.

------------------------------------------------------------------------
ANS3152E

The initiator.iscsi file does not have a valid initiator id entry.



Explanation:

No ISCSI Initiator ID exists.

System action:

Operations cannot continue.

User response:

The ISCSI servoce may not be installed.

------------------------------------------------------------------------
ANS3153E

The mount cleanup completed with error for mount ID 'mountid' of virtual
machine 'VMNAME'; Error log 'errlog' is available on 'machinename'.



Explanation:

An error occurred during the mount cleanup operation while unmounting
the volumes. The mounted file systems may be busy. See the error log to
identify the cause of the error.

System action:

Processing stops.

User response:

Ensure the file systems are not in use and the cleanup or manually
unmount the volumes on the host.

------------------------------------------------------------------------
ANS3154E

The ISCSI service is not installed.



Explanation:

The ISCSI Service is not installed.

System action:

Operations cannot continue.

User response:

Install the ISCSI service for your platform.

------------------------------------------------------------------------
ANS3155I

The Windows data mover is 'name' (ip)



Explanation:

The DNS name and the IP of the Windows data mover.

System action:

None.

User response:

This information can be used to determine if hostname and IP of the
Windows data mover are correctly resolved. The information can help if
the iSCSI connection is not working as expected.

------------------------------------------------------------------------
ANS3156I

The iSCSI server address used is 'ip'



Explanation:

This message returns the IP address of the iSCSI server.

System action:

None.

User response:

This information can be used to determine if the IP address of the iSCSI
server address is correctly resolved. The information might help you
troubleshoot problems if the iSCSI connection is not working as
expected.

------------------------------------------------------------------------
ANS3157I

The Linux data mover is 'name' (ip)



Explanation:

The DNS name and the IP address of the Linux data mover.

System action:

None.

User response:

This information can be used to determine if hostname and IP of the
Linux data mover are correctly resolved. The information might help you
troubleshoot problems if the iSCSI connection is not working as
expected.

------------------------------------------------------------------------
ANS3158W

The attempt to create the Windows share failed with Windows error
(error). The share is not created.



Explanation:

The creation of the Windows share failed with the given user/group name.

System action:

The Windows share is not created. The operation continues.

User response:

One common reason for failures is that the specified user/group does not
exist. Ensure that the Windows user or group name exists and is
accessible on the Windows data mover. If this is a domain user or group,
the Windows data mover has to be part of that domain. If this does not
resolve the problem, see the appropriate Microsoft Documentation for
information about this error code.

------------------------------------------------------------------------
ANS3159E

The attempt to remove the Windows Share failed with Windows error
(error).



Explanation:

A Windows API call failed to remove the Windows Share.

System action:

The operation stops.

User response:

See the appropriate Microsoft Documentation for information about how to
resolve this Windows API call issue.

------------------------------------------------------------------------
ANS3160W

The attempt to export Linux file system failed with error: NFS service
is not running.



Explanation:

exportfs command failed to make the directory on the Linux mount proxy
available for NFS clients to mount.

System action:

The operation continues without creating the NFS export.

User response:

Resolve the error on the Linux mount proxy. Manually export the
directory.

------------------------------------------------------------------------
ANS3161E

The attempt to unexport Linux file system failed with error: NFS service
is not running.



Explanation:

exportfs command failed to unexport the directory on the Linux mount
proxy.

System action:

The operation stops.

User response:

Resolve the error on the Linux mount proxy. Manually unexport the
directory.

------------------------------------------------------------------------
ANS3162I

The Mount cleanup of VM 'VMNAME' with mount id 'Id' and snapshot date
'date time' completed.



Explanation:

The mount cleanup operation for the specified virtual machine completed.

System action:

None.

User response:

None

------------------------------------------------------------------------
ANS3163W

The Linux Operating System is not at the minimum level. Mount operations
may not complete successfully.



Explanation:

The Linux Operating System is not at the minimum level.

System action:

Mount operations may not complete successfully.

User response:

Upgrade the Linux operating system to at least the minimum level.

------------------------------------------------------------------------
ANS3164W

The minimum level for 'os' is 'level'. Your current level is 'actual'.



Explanation:

The Linux Operating System is not at the minimum level.

System action:

Mount operations may not complete successfully.

User response:

Upgrade the Linux operating system to at least the minimum level.

------------------------------------------------------------------------
ANS3165W

A Package installed on the Linux Operating System is not at the minimum
level. Mount operations may not complete successfully.



Explanation:

A Package installed on the Linux Operating System is not at the minimum
level.

System action:

Mount operations may not complete successfully.

User response:

Upgrade the package to at least the minimum level.

------------------------------------------------------------------------
ANS3166W

The minimum level for package 'package' is 'level'. Your current level
is 'actual'.



Explanation:

A Package installed on the Linux Operating System is not at the minimum
level.

System action:

Mount operations may not complete successfully.

User response:

Upgrade the package to at least the minimum level.

------------------------------------------------------------------------
ANS3167E

IBM Spectrum Protect Recovery Agent service is not installed.



Explanation:

IBM Spectrum Protect Recovery Agent service is not installed.

System action:

Operations cannot continue.

User response:

Ensure that IBM Spectrum Protect Recovery Agent is correctly installed
and configured.

------------------------------------------------------------------------
ANS3168E

IBM Spectrum Protect Recovery Agent service is not running.



Explanation:

IBM Spectrum Protect Recovery Agent service is not running.

System action:

Operations cannot continue.

User response:

Start IBM Spectrum Protect Recovery Agent service. The Recovery Agent
can be started using "net start RecoveryAgent" or by referencing IBM
Spectrum Protect Recovery Agent in services.msc.

------------------------------------------------------------------------
ANS3169E

The mount proxy's operating system must be Windows Server 2012 or newer
operating system.



Explanation:

The Windows operating system is not at the minimum level.

System action:

Processing stops.

User response:

Upgrade the Windows mount proxy to a supported operating system.

------------------------------------------------------------------------
ANS3170W

The attempt to export Linux file system failed with error: exportfs
command failed.



Explanation:

exportfs command failed to make the directory on the Linux mount proxy
available for NFS clients to mount.

System action:

The operation continues without creating the NFS export.

User response:

Resolve the error on the Linux mount proxy. Manually export the
directory.

------------------------------------------------------------------------
ANS3171E

The attempt to unexport Linux file system failed with error: exportfs
command failed.



Explanation:

exportfs command failed to unexport the directory on the Linux mount
proxy.

System action:

The operation stops.

User response:

Resolve the error on the Linux mount proxy. Manually unexport the
directory.

------------------------------------------------------------------------
ANS3172T

Restoring virtual machine 'source' to new VM with name 'destination'.



Explanation:

The specified virtual machine will be restored as a new vm with a new
name.

System action:

None

User response:

None.

------------------------------------------------------------------------
ANS3173E

The Linux devices failed to mount correctly.



Explanation:

The Linux devices failed to mount correctly.

System action:

Mount operations did not not complete successfully.

User response:

Verify that the Linux mount proxy server can communicate with the IBM
Spectrum Protect server.

------------------------------------------------------------------------
ANS3174E

The virtual machine mount failed.



Explanation:

An error occurred during the mount operation.

System action:

Processing stops.

User response:

Check the command-line output for the messages that specify what
problems were encountered during the operation.

------------------------------------------------------------------------
ANS3175E

The VM mount cleanup failed.



Explanation:

An error occurred during the mount cleanup operation.

System action:

Processing stops.

User response:

Check the command-line output for the messages that specify what
problems were encountered during the operation.

------------------------------------------------------------------------
ANS3176W

Unable to locate the Windows user or group named 'name'. The share is
not created.



Explanation:

IBM Spectrum Protect was unable to map the specified user or group name
to a Windows security identifier.

System action:

The Windows share is not created. The operation continues.

User response:

One common reason for this message is that the specified user or group
does not exist. Ensure that the Windows user or group name exists and is
accessible on the Windows data mover. If this is a domain user or group,
the Windows data mover has to be part of that domain.

This message can also indicate that the Windows data mover is not able
to access the active directory domain server. Ensure that network
problems are not preventing the Windows data mover from communicating
with the active directory domain server.

------------------------------------------------------------------------
ANS3177E

No iSCSI target was connected. Check your iSCSI options for
backup-archive client.



Explanation:

No iSCSI target was found or connected on the Linux mount proxy machine.

System action:

The operation is rolled back.

User response:

Check that iSCSI is setup correctly on your Windows as well as your
Linux mount proxy. One common reason for a failure is that the
VMISCSIServeraddress option is not specified or is set incorrectly in
the options file of the Windows data mover.

------------------------------------------------------------------------
ANS3178E

Volume 'volume' of type 'file_system_type' has not been unmounted.
System message:'system_message'



Explanation:

An error occurred during the mount cleanup operation while unmounting
the volumes on the Linux mount proxy machine.

System action:

Processing stops.

User response:

Ensure the file system is not in use and then try the cleanup operation
again, or manually unmount the volume on the Linux mount proxy.

------------------------------------------------------------------------
ANS3179W

Another folder share with the same name 'name' already exists.



Explanation:

IBM Spectrum Protect was unable to create a folder share with the
specified name because a share with that name already exists.

System action:

The folder share is not created. The operation continues and the VM
disks are mounted for file restore on the mount proxy.

User response:

Use operating system commands to create the share of the folder with a
unique name and delete it before running the dismount operation.

------------------------------------------------------------------------
ANS3180W

The parameter 'name' contains characters that are not allowed and have
been removed. Resulting value is 'new'



Explanation:

Some characters cannot be used on multi platform environments. To solve
compatibly problems only a limited set of characters are allowed on this
specific parameter.

Parameter "-MOUNTPoint" is restricted at [a-z][A-Z][0-9][:][/][\][_]

Parameter "-MOUNTTag" is restricted at [a-z][A-Z][0-9][_]

Parameter "-EXPORTParameter" is restricted on Windows at
[a-z][A-Z][0-9][ ][-][_][\][@]

Parameter "-EXPORTParameter" is restricted on Linux at
[a-z][A-Z][0-9][.][:]

System action:

The operation continues with modified parameter.

User response:

None

------------------------------------------------------------------------
ANS3181E

The registry key
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\partmgr\Parameters\CrPolicy
is set to an other value than 3.



Explanation:

If the registry key
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\partmgr\Parameters\CrPolicy
is set to an other value than 3 it can be that the machine hangs during
a mount operation. Change the value to 3 and reboot the machine.

System action:

The operation stops.

User response:

The registry key
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\partmgr\Parameters\CrPolicy
is not documented by Microsoft. Sometimes this key is set to a value
other than 3 what can lead to problems with the mount operation. Set the
value to 3 and reboot the machine.

------------------------------------------------------------------------
ANS3182E

The mount cleanup operation timed out waiting minutes minutes for
response from Linux Mount Proxy.



Explanation:

The Windows Mount Proxy didn't receive any response from Linux Mount
Proxy within the given timeout. The Linux Mount Proxy is possible in
hanging state.

System action:

Processing stops.

User response:

Check the status of Linux Mount Proxy machine and mount proxy trace file
for more details. In the case of a complete system hang on umount, a
reboot followed by manual mount cleanup of the Linux mount proxy machine
may be required.

------------------------------------------------------------------------
ANS3183E

Failed to revert volume mounted at .



Explanation:

The volume revert operation failed. Try to mount the volume manually.
Find it's snapshot and attempt the revert operation.

System action:

The restore stops.

User response:

Check IBM Spectrum Protect error log, Windows Event logs for more
information.

------------------------------------------------------------------------
ANS3184W

A duplicate device UUID has been found during the LVM activation phase
of mount operation. The 'vgimportclone' system command was not able to
generate a new UUID for the LVM device 'LVMdeviceName' resulting in a
duplicated UUID with the device 'LVMdeviceName2' of the mount proxy
machine. The device 'LVMdeviceName3' has been excluded from the list of
volumes to be mounted on the mount proxy. On some Linux distributions
this device could still be present after the iSCSI disconnect phase and
a manual cleanup could be required e.g. by using the 'dmsetup remove
device_name' command.



Explanation:

The 'vgimportclone' command was not able to generate a new UUID for this
LVM device, resulting in a duplicated UUID.

System action:

The device of the target VM is skipped and not mounted. The operation
continues.

User response:

This problem has been observed on some Linux distributions where the
'vgimportclone' command was not able to generate a new UUID. In such
case the 'iscsiadm -m node -T ... --logout' command may not able to
remove such devices and a manual cleanup could be required e.g. by using
the 'dmsetup remove device_name' command. Note that such situation could
be also a signal that the target VM was cloned from same template as the
mount proxy. To resolve the duplicated devices introduced due to a VM
machine clone, check the block devices of the target VM by using the
'blkid' command and make sure that no duplicate UUIDs are present with
the mount proxy machines. If a duplicate device belongs to the target VM
and it is used, you need to assign it a new UUID or remove such device.

------------------------------------------------------------------------
ANS3185W

A duplicate device UUID is found on the mount proxy after the targets
were connected. The device 'new_device_name' with the UUID
'new_device_uuid' of type 'new_device_type' is excluded from the list of
volumes to be mounted on the mount proxy.



Explanation:

The Linux operating system cannot to mount devices of this type when the
UUID already exists on the system. This situation occurs because the
target virtual machine was cloned from the same template as the mount
proxy.

System action:

The device for the target virtual machine is not mounted. The operation
continues.

User response:

To resolve the duplicated devices that were introduced because of a
virtual machine clone, check the block devices for the target virtual
machine by using the 'blkid' command and make sure that no duplicate
UUIDs are present for the mount proxy machines. If a duplicate device
belongs to the target virtual machine and the device is in use, assign
the device a new UUID or remove the device.

------------------------------------------------------------------------
ANS3186W

Opening and creating the block devices failed.



Explanation:

It was not possible to get the list of block devices on the Linux mount
proxy

System action:

The file restore operation stopped.

User response:

Check that the 'blkid' command is working correctly on the Linux mount
proxy machine.

------------------------------------------------------------------------
ANS3187W

Opening and creating the block devices failed.



Explanation:

It was not possible to open the disk and create the block devices on the
Linux mount proxy machine.

System action:

The file restore operation stopped.

User response:

Check that on the Linux mount proxy machine, the number of loop devices
available are at least equal to the number of virtual machine disks to
mount. The advanced VMware transport mode is not supported on the Linux
mount proxy for file restore operations from local backups. Use the
vmvstortransport ndb option in the server stanza of the mount proxy
options file. If you want to use NBDSSL, remove the
/opt/tivoli/tsm/client/ba/bin/lib64/libdiskLibPlugin.so library and use
the vmvstortransport ndbssl option.

------------------------------------------------------------------------
ANS3188W

A duplicate UUID exists for LVM device 'new_device_name'. The device
cannot be mounted. As a result, files from this device will not be
restored.



Explanation:

The operating system cannot mount the device if its Universally Unique
ID (UUID) already exists on the system. This situation usually occurs
because the target virtual machine was cloned from the same template as
the mount proxy.

System action:

The device for the target virtual machine is not mounted. The operation
continues.

User response:

Use the blkid command to scan the block devices on the target virtual
machine for the existence of duplicate UUIDs. If a duplicate device
belongs to the target virtual machine and that device is in use, you
must assign a new UUID to the duplicate device, or remove that device.

------------------------------------------------------------------------
ANS3189W

Original mount points can not be found for guest system.



Explanation:

.

System action:

The operation continues.

User response:

Check if /etc/fstab file exists and is accessible on guest system.

------------------------------------------------------------------------
ANS3401W

The entity name is invalid.



Explanation:

A volume with this name could not be found or is not suitable for
server-free operations.

System action:

Processing stopped.

User response:

Specify the correct name.

------------------------------------------------------------------------
ANS3402W

name: A system call func failed with code rc.



Explanation:

An error occurred while obtaining information from the operating system.
The volume information could not be obtained.

System action:

Processing can continue if the information being obtained is not
critical for the operation or if it is expected behaviour in the context
of the operation being performed.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Try to correct any indicated problems, then try the
operation again. If the problem persists, contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS3403W

Volume name cannot be opened for reading. System error code is err.



Explanation:

The named volume could not be opened. Examples of why this can occur
include, but are not limited to: the device is not a valid system
device, the device is locked by another application, or the user does
not have correct or permissions. The operating system error code shown
in the message indicates the specific reason for the failure.

System action:

Processing stops.

User response:

Use your operating system's tools to obtain the description of the error
code. Also check the error log for any other messages that might
indicate a reason for the failure. Try to correct any indicated
problems, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS3404W

An error occured reading volume name.



Explanation:

The named volume could not be read. Examples of why this can occur
include, but are not limited to: the data being read is outside the
valid range of the volume, or the device is locked by another
application. The operating system error code shown in the message
indicates the specific reason for the failure.

System action:

If server-free data movement is used, processing continues using
non-server-free data movement. Otherwise processing stops.

User response:

Use your operating system's tools to obtain the description of the error
code. Also check the error log for any other messages that might
indicate a reason for the failure. Try to correct any indicated
problems, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS3405W

File system fs on volume name is unknown.



Explanation:

The file system on the volume is not supported for the operation being
performed.

System action:

If server-free data movement is used, processing continues using
non-server-free data movement. Otherwise processing stops.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Try to correct any indicated problems, then try the
operation again. If the problem persists, contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS3406I

Not enough space is available to update the last backup status for
virtual machine 'vm'.



Explanation:

The virtual machine is backed up successfully, but there is insufficient
space available to write the last backup status in the 'Notes' field for
the virtual machine.

System action:

The backup operation completed.

User response:

Free some space in the 'Notes' field for the virtual machine if the the
last backup status is needed.

------------------------------------------------------------------------
ANS3407W

name is not local.



Explanation:

The drive or filesystem is not local and is not suitable for image
backup.

System action:

Processing stopped.

User response:

Specify a volume that is local.

------------------------------------------------------------------------
ANS3408E

System call 'umount' failed for volume 'volume' with errno='error'.
Please take suitable action based on errno and retry the operation.



Explanation:

Umount failed for the specified volume with the indicated errno. Please
take suitable action based on errno and retry the operation.

System action:

Processing stopped.

User response:

Check errno for umount failure and take corrective action before
retrying the operation.

------------------------------------------------------------------------
ANS3409W

An error occurred writing to volume name.



Explanation:

IBM Spectrum Protect could not write to the named volume. Examples of
why this can occur include, but are not limited to: the data being
written is outside the valid range of the volume, or the device is
locked by another application. The operating system error code shown in
the message indicates the specific reason for the failure.

System action:

Processing stops.

User response:

Use your operating system's tools to obtain the description of the error
code. Also check the error log for any other messages that might
indicate a reason for the failure. Try to correct any indicated
problems, then try the operation again. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS3410E

The operating system refused a request for memory allocation.



Explanation:

The process requires access to memory in order to store information as
processing proceeds. In this case, more memory was requested than the
operating system would allocate. Possible reasons include:

   The system is low on memory.
   The process in which the program runs has exceeded the maximum memory
   that it is allowed to allocate.
   Some other error condition occurred that caused the program to think
   it is out of memory.

System action:

The process cannot complete the requested operation.

User response:

Close all unneeded applications and try the operation again. If the
operation still fails, try dividing the task into serveral smaller
units. For example, if a file specification contains several high level
directories, run the IBM Spectrum Protect task serially for each
directory. If the task is an incremental backup, use the option
"-memoryefficientbackup=yes".

For UNIX systems that support resource limits, check to see b if the
memory resource limit is too low by entering the following command:
ulimit -a

Based on the resulting data, you can ask the UNIX system root user to
increase resource limits so that it will override the current default.
The UNIX system root user has the authority to increase resource limits.

------------------------------------------------------------------------
ANS3411E

Invalid arguments were passed to function name.



Explanation:

The named function did not receive correct arguments to proceed. Please
check error log for additional errors following this one for further
explanation.

System action:

Processing stops.

User response:

Retry the operation. If problem persists contant your IBM Spectrum
Protect administrator.

------------------------------------------------------------------------
ANS3412I

DiskMapper does not support name for entity name.



Explanation:

The requested function is not implemented in DiskMapper at this time.
Please report this error to your IBM Spectrum Protect administrator.

System action:

Processing stops.

User response:

Contact your IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS3413I

DiskMapper object 'name' type 'name' is not valid.



Explanation:

The named object is not valid on the originating client system.

System action:

Processing stops.

User response:

Retry the operation. If the problem persists, review the client error
log for other messages that might be related to this problem. Contact
your IBM Spectrum Protect administrator for additional help.

------------------------------------------------------------------------
ANS3414I

Disk 'name' is not part of any container defined on the system.



Explanation:

None.

System action:

None. This is informational message.

User response:

None.

------------------------------------------------------------------------
ANS3415W

At least one of the disk containing data for 'name' has bad blocks.



Explanation:

One or more physical disks containing data blocks of the above object
has bad blocks and the requested operation can not continue.

System action:

The system may find a work-around to complete the requested operation,
pleasecheck console log and error log for additional information on
corrective actions taken or suggested user action.

User response:

Depending on the operation the process may suggest an alternate way to
complete the operation. Check your error log, sched log, or console log
for additional information.

------------------------------------------------------------------------
ANS3416E

The volume 'name' is currently in use by other process.



Explanation:

The operation requires exclusive access to the volume. The most likely
cause of this failure is that other process on the system has the volume
opened.

System action:

Processing stopped.

User response:

Check applications running on your system to ensure that volume is not
opened by any if the process and then retry the operation.

------------------------------------------------------------------------
ANS3417W

name: A system call func failed with code rc - strerror



Explanation:

An error occurred while obtaining information from the operating system.
The volume information could not be obtained.

System action:

Processing can continue if the information being obtained is not
critical for the operation or if it is expected behaviour in the context
of the operation being performed.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Try to correct any indicated problems, then try the
operation again. If the problem persists, contact IBM technical support
for further assistance.

------------------------------------------------------------------------
ANS3418W

Memory allocation request for image backup operation was refused by the
operating system.



Explanation:

IBM Spectrum Protect requires access to memory in order to store
information about used blocks of a file system. In this case, more
memory was requested than the operating system would allocate.

System action:

If imagegapsize is too small for a dedicated filesystem and the client
faces out-of-memory condition then the client automatically switches to
full volume backup. Operation continues with imagegapsize = 0.

User response:

Some recommendations to avoid the out-of-memory condition:

   check to see if the memory resource limit is too low by entering the
   following command: ulimit -a Then you can ask the UNIX system root
   user to increase memory limit.
   increase the value of the imagegapsize option. The bigger
   imagegapsize is used, the less memory is needed for image backup, but
   more unused data is sent to server. And vice versa: the smaller
   imagegapsize is used, the more memory is needed for backup, but less
   unused data is sent to server. The outcome also depends much on how
   data is spread on the volume.

------------------------------------------------------------------------
ANS3419W

Failed to mount the VSS snapshot for integrity check on virtual machine
'vmname'. Integrity check is skipped and the Microsoft Exchange Server
transaction logs are not truncated.



Explanation:

The virtual machine snapshot must be mounted to verify the integrity of
the Microsoft Exchange Server database files. The snapshot for the
specified virtual machine was unable to be mounted. As a result, the
operation did not verify the integrity of the Microsoft Exchange Server
database files.

System action:

The backup operation continues without an integrity check and the
Microsoft Exchange Server transaction logs are not truncated.

User response:

To prevent this error, configure a connection from the guest virtual
machine to the ESXi host. Then, try the operation again.

------------------------------------------------------------------------
ANS4000E

Error processing 'filespace-name': file space does not exist.



Explanation:

The specified file space (domain) is incorrect or does not exist on the
workstation. If the message results from the BACKUP IMAGE command with
the -MODE=INCREMENTAL option, it means that you have entered the name of
a raw logical volume. The MODE=INCREMENTAL option is not valid for raw
logical volumes.

System action:

Processing stops.

User response:

Try the operation again, specifying an existing domain (drive letter or
file system name). If the message resulted from improper use of the
MODE=INCREMENTAL option, try the command again, omitting that option.

------------------------------------------------------------------------
ANS4001E

The file space for domain 'filespace-name' could not be found on the IBM
Spectrum Protect server.



Explanation:

The specified file space was expected to be found on the server, but it
no longer exists. It is possible that a command was issued to delete the
file space from the server while the current operation was in progress.

System action:

IBM Spectrum Protect processing stops.

User response:

Try the operation again. If the problem recurs, check the error log for
any other messages that might indicate a reason for the failure. Try to
correct any indicated problems, then try the operation again. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS4002E

Error processing 'filespace-name': volume label does not exist



Explanation:

The selected drive does not have a label.

System action:

IBM Spectrum Protect is unable to do the requested operation without a
drive or label entered.

User response:

If the drive is a floppy drive, place a disk with a volume label in it
and retry the operation. If the disk is a hard drive, ensure the drive
has a volume label, and retry the operation.

------------------------------------------------------------------------
ANS4003E

Error processing 'filespace-name': duplicate volume label encountered



Explanation:

The selected drive has a duplicate volume label. Because IBM Spectrum
Protect uses the volume label to keep track of backup/archive
information, it cannot back up or archive files from a drive with a
duplicate volume label.

System action:

IBM Spectrum Protect cannot select the drive.

User response:

If the volume needs to be available to the system, exit IBM Spectrum
Protect, and assign a volume label to the drive. Restart IBM Spectrum
Protect and retry the operation.

------------------------------------------------------------------------
ANS4004E

Error processing 'filespace namepath-namefile-name': destination file or
directory is write locked



Explanation:

The file or directory being restored or retrieved from the server cannot
be written to because the destination is write locked. Another operation
might have the file open and will not allow it to be updated.

System action:

File skipped.

User response:

Either determine which operation has the file write locked, or restore
the file to another name or location.

------------------------------------------------------------------------
ANS4005E

Error processing 'filespace namepath-namefile-name': file not found



Explanation:

The file being processed for backup, archive or migrate no longer exists
on the client. Another process deletes the file before it can be backed
up, archived or migrated by IBM Spectrum Protect.

System action:

File skipped.

User response:

None.

------------------------------------------------------------------------
ANS4006E

Error processing 'filespace namepath-namefile-name': directory path not
found



Explanation:

The operating system returned a "path not found" status when IBM
Spectrum Protect attempted to access the directory. You either have
specified a directory that does not exist, as shown in the message
(path-name), or the directory being processed no longer exists on the
client because another process deleted it before it could be backed up
or archived by IBM Spectrum Protect.

System action:

The directory is skipped, processing continues

User response:

Recheck all spelling and punctuation, particularly the placement of
directory delimiters (for example, "\"). Correct the syntax if it is
incorrect, then retry the operation. Ensure that the path is specified
correctly and that the directory actually exists. Retry the command with
the corrected path and directory name. If you cannot correct the
directory name, use the Exclude option to exclude the directory from the
operation.

------------------------------------------------------------------------
ANS4007E

Error processing 'filespace namepath-namefile-name': access to the
object is denied



Explanation:

Access to the specified file or directory is denied. You tried to read
from or write to a file and you do not have access permission for either
the file or the directory.

System action:

Processing stopped.

User response:

Ensure that you specified the correct file or directory name, correct
the permissions, or specify a new location. If HSMOPTIMIZEDRECALLONLY is
set on the file system owner node, recall this file via optimized recall
prior to the next backup.

------------------------------------------------------------------------
ANS4008E

Error processing 'filespace namepath-namefile-name': file is temporarily
unavailable



Explanation:

File is temporarily unavailable.

System action:

File skipped.

User response:

Check and see if file is locked by other process. If not, retry the
command.

------------------------------------------------------------------------
ANS4009E

Error processing 'filespace namepath-namefile-name': disk full condition



Explanation:

No more files can be restored or retrieved because the destination disk
is full.

System action:

The client prompts you for action:

*  Retry this object

*  Skip this object

*  Abort the action

User response:

Select the appropriate action for this object. Create some free space on
the destination disk before you retry the operation. Another option is
to restore or retrieve the file to another disk.

------------------------------------------------------------------------
ANS4010E

Error processing 'filespace namepath-namefile-name': stale NFS handle



Explanation:

An NFS file system becomes stale.

System action:

File system skipped.

User response:

Verify that the NFS file system is mounted. If the problem persists,
unmount and remount the file system, then try the operation again.

------------------------------------------------------------------------
ANS4011E

Error processing 'filespace namepath-namefile-name': no file handles
available



Explanation:

All file handles for your system are currently in use. No more are
available.

System action:

Processing stopped.

User response:

Either free some file handles by ending other processes, or modify your
system setup to allow for more files to be open at the same time.

------------------------------------------------------------------------
ANS4012E

'filespace namepath-namefile-name' already exists. It will be skipped.



Explanation:

The client tried to restore or retrieve the specified file, but the file
already existed in the target restore location and the user chose not to
replace the existing file.

System action:

The file is skipped, a message is logged in dsmerror.log, and restore or
retrieve processing continues with the next object.

User response:

The file was skipped because either REPLACE NO was in effect, causing
all existing files and directories to be skipped, or REPLACE PROMPT was
in effect, and when prompted, the user chose to skip this file or all
existing directories and files. No additional action is necessary if the
decision to skip the file was deliberate. Otherwise the operation can be
retried using either REPLACE ALL REPLACE PROMPT.

------------------------------------------------------------------------
ANS4013E

Error processing 'filespace namepath-namefile-name': invalid file handle



Explanation:

An internal system error occurred. A file operation failed because an
invalid file handle was passed.

System action:

Processing stopped.

User response:

Report the problem to your system administrator, and then retry the
operation.

------------------------------------------------------------------------
ANS4014E

Error processing 'filespace namepath-namefile-name': unknown system
error (error-code) encountered. Program ending.



Explanation:

An unrecognized and unexpected error-code occurred within the client
program. This is a programming failure and the client program ends.

System action:

processing stops.

User response:

Try the operation again. If the problem continues, report the error to
your IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS4015E

Error processing 'filespace namepath-namefile-name': unexpected IBM
Spectrum Protect error (error-code) encountered



Explanation:

An unexpected error occurred. This might be a low-level system or
communication error that IBM Spectrum Protect cannot handle or recover
from.

System action:

processing stops.

User response:

Try the operation again. If the problem continues, look for other
indications of system problems to determine where the problem exists.
Most systems have error or event logs which may contain additional
information. See your system administrator or IBM Spectrum Protect
administrator for further help.

------------------------------------------------------------------------
ANS4016E

Error processing 'filespace namepath-namefile-name': file is being
executed; write permission denied



Explanation:

The current file cannot be opened to write to because it is currently
being run by another operation.

System action:

File skipped.

User response:

Stop the operation that is running the file and retry the operation, or
restore or retrieve the file to a different name or directory.

------------------------------------------------------------------------
ANS4017E

Error processing 'filespace namepath-namefile-name': too many symbolic
links were detected while resolving name



Explanation:

While trying to resolve the file name, too many symbolic links were
found.

System action:

File skipped.

User response:

Ensure that you do not have a looping symbolic link for the file.

------------------------------------------------------------------------
ANS4018E

Error processing 'filespace namepath-namefile-name': file name too long



Explanation:

The file name specified is too long to be handled by IBM Spectrum
Protect.

System action:

File is skipped.

User response:

See the appropriate Using the Backup-Archive Client book for the
particular operating system, for the file names that are handled by IBM
Spectrum Protect.

------------------------------------------------------------------------
ANS4019E

Error processing 'filespace namepath-namefile-name': file system is
locked by system



Explanation:

File system cannot be accessed because it is locked by the system.

System action:

IBM Spectrum Protect cannot complete the operation.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS4020E

The data format for object 'filespace namepath-namefile-name' is
unknown. The unknown format usually occurs when the file was backed up
or archived by a later version of IBM Spectrum Protect.



Explanation:

When a file is backed up or archived, IBM Spectrum Protect includes some
additional information about the file. This message is issued if IBM
Spectrum Protect cannot recognize the information during a restore or
retrieve operation. The most likely cause is that the file was backed up
or archived with a newer version of IBM Spectrum Protect. If the file
was backed up from a case-preserving but not case-sensitive file system,
the file name might be displayed with incorrect casing. The incorrect
casing does not otherwise affect processing since the file is skipped.

System action:

The file is not restored or retrieved. Processing continues with the
next file.

User response:

Try the restore or retrieve operation again with a current version of
the IBM Spectrum Protect client software. If the problem persists,
contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS4021E

Error processing 'filespace namepath-namefile-name': file system not
ready



Explanation:

The file system/drive was not ready for access.

System action:

Processing stopped.

User response:

Ensure that the drive is available to IBM Spectrum Protect, and then
retry the operation.

------------------------------------------------------------------------
ANS4022E

Error processing 'filespace namepath-namefile-name': file system is
invalid.



Explanation:

The drive was not available for access.

System action:

processing stops.

User response:

Ensure that the drive is operational, and then try the operation again.
If this is unsuccessful, check the error log.

------------------------------------------------------------------------
ANS4023E

Error processing 'filespace namepath-namefile-name': file input/output
error



Explanation:

An error was found while reading from or writing to the file.

System action:

File skipped.

User response:

Check your system to ensure that it is operating properly. For OS/2, run
CHKDSK /F for the failing drive which can be found in dsmerror.log.

------------------------------------------------------------------------
ANS4024E

Error processing 'filespace namepath-namefile-name': file write error



Explanation:

An error was found while writing to the file.

System action:

File skipped.

User response:

Check your system to ensure that it is operating properly.

------------------------------------------------------------------------
ANS4025E

Error processing 'filespace namepath-namefile-name': file exceeds user
or system file limit



Explanation:

A file being backed up/restored or archived/retrieved exceeds system set
limits for this user. Shown below are the filesize limits corresponding
to various platforms.

AIX
         68,589,453,312 (64GB)

HP-UX
         1,099,511,627,775 (1TB-1)

Linux
         2,147,483,647 (2GB)

Mac pre-OS9
         2,147,482,624 (2GB-1K)

Mac OS9
         18,446,744,073,709,551,616 (16EB)

NetWare
         4,294,963,200 (4GB -4KB)

NUMA-Q DYNIX/ptx
         4.5 1,095,216,660,480 (1TB-4GB)

OS/390
         4,294,967,295 (4GB)

SGI
         18,446,744,073,709,551,615 (16EB-1)

Solaris 2.6 or higher
         1,099,511,627,775 (1TB-1)

Tru64 UNIX
         1,099,511,627,776 (1TB)

UnixWare
         2,147,483,647 (2GB)

Windows ME (FAT32)
         4,294,967,295 (4GB)

Windows NT/2000 (NTFS)
         17,592,185,978,880 (16TB-64K)

System action:

File skipped.

User response:

Ensure that the system limits are set properly.

------------------------------------------------------------------------
ANS4026W

Error processing 'filespace namepath-namefile-name': size of 'file-size'
exceeded the maximum file size limit on your system



Explanation:

You tried to restore or retrieve a file that has exceeded the maximum
file size limitation on your system.

System action:

IBM Spectrum Protect cannot restore or retrieve the file.

User response:

Restore or retrieve this file on a system that supports the file size.
See your system administrator.

------------------------------------------------------------------------
ANS4027S

Error processing 'filespace namepath-namefile-name': internal program
message 'value' encountered



Explanation:

An unexpected catastrophic program failure occurred, indicated by value.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, see your system
administrator or service representative.

------------------------------------------------------------------------
ANS4028E

Error processing 'filespace namepath-namefile-name': cannot create
file/directory entry



Explanation:

The directory path for files being restored or retrieved cannot be
created.

System action:

File skipped.

User response:

Ensure that you have the proper authorization to create the directory
for file being restored or retrieved.

------------------------------------------------------------------------
ANS4029E

Error processing 'filespace namepath-namefile-name': unable to build a
directory path; a file exists with the same name as a directory



Explanation:

IBM Spectrum Protect tried to create a directory path, but is unable to
because a file exists that has the same name as a directory.

System action:

Processing stopped.

User response:

Remove the file that has the same name as the directory. Refer to the
last restore/retrieve operation and check all directories along the
path.

------------------------------------------------------------------------
ANS4030E

Error processing 'filespace namepath-namefile-name': disk space limit
for this process reached



Explanation:

The disk space allocated for the client owner is full.

System action:

Processing stopped.

User response:

Free up disk space and retry the restore or retrieve operation.

------------------------------------------------------------------------
ANS4031E

Error processing 'file_space_namepath_namefile_name'. Name exceeds an
internal IBM Spectrum Protect limit.



Explanation:

During a file operation, IBM Spectrum Protect encountered a filename
where at least one component of the file name (file_space_name,
path_name or directory_name or file_name) exceeded an internal IBM
Spectrum Protect maximum. The internal IBM Spectrum Protect limits
should not be confused with the operating system limits for
file_space_name, path_name or directory_name, file_name.

Shown below are the IBM Spectrum Protect internal file name limits for
various platforms.

AIX HP-UX  Solaris
File_space_name               1024
Path_name or directory_name   1023
File_name                      256

Linux
File_space_name               1024
Path_name or directory_name    768
File_name                      256

Windows XP/2000/2003
File_space_name               1024
Path_name or directory_name    248
File_name                      248

System action:

The file is skipped.

User response:

Reduce the size of the filename so that it is smaller that the IBM
Spectrum Protect internal limits.

------------------------------------------------------------------------
ANS4032E

Error processing 'filespace namepath-namefile-name': file is not
compressed.



Explanation:

A file that was flagged as compressed was not compressed, and the system
failed.

System action:

Processing stopped.

User response:

See your system administrator to report this problem. This error is a
system failure.

------------------------------------------------------------------------
ANS4033E

Error processing 'filespace namepath-namefile-name': file compressed on
a different client machine that has more memory



Explanation:

You are trying to restore a file that was backed up and compressed on
another client workstation that had more memory than your client
workstation. You cannot restore this file. When the file is restored, it
is expanded and your workstation does not have enough memory.

System action:

IBM Spectrum Protect canceled the operation.

User response:

Obtain a machine with more memory and retry the operation.

------------------------------------------------------------------------
ANS4034E

Error processing 'filespace namepath-namefile-name': unknown system
error



Explanation:

An unknown error occurred. This might be a low-level system or
communication error that IBM Spectrum Protect cannot handle or recover
from.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, determine where the
problem exists. See your system administrator for further help.

------------------------------------------------------------------------
ANS4035W

File 'filespace namepath-namefile-name' currently unavailable on server.



Explanation:

You tried to restore or retrieve a file that is currently not available
from the IBM Spectrum Protect server.

System action:

IBM Spectrum Protect Cannot restore or retrieve the file.

User response:

Try to restore or retrieve after the file was made available on the
server. See your system administrator.

------------------------------------------------------------------------
ANS4036E

An error occurred saving the registry key.



Explanation:

The active registry key cannot be copied to the ADSM.SYS staging
directory.

System action:

Registry backup operation terminates.

User response:

Check the space available on the Windows boot partition to ensure there
enough space to contain a copy of the Windows registry. This might
require several megabytes of free space. Also check the Windows
permissions on the ADSM.SYS staging directory and ensure that the
Windows user under which you are running IBM Spectrum Protect has full
access to that directory and its contents.

------------------------------------------------------------------------
ANS4037E

Object 'file-namefile-namefile-name' changed during processing. Object
skipped.



Explanation:

The specified file-name was skipped during backup, archive, or migrate
because it was changing during the attempt to process it.

System action:

IBM Spectrum Protect skipped the object.

User response:

If you want the file backed up, archived, or migrated, retry the
operation. If it fails, determine why the object is being changed. For
more information on backing up, archiving, or migrating changing
objects, see your system administrator.

------------------------------------------------------------------------
ANS4038E

An error occurred processing file system 'filespace name'.



Explanation:

File system 'filespace name' is corrupted or contains one or more
corrupted directories and cannot be processed.

System action:

File system is skipped.

User response:

Check your system to ensure that it is operating properly. For the
Windows environment, run CHKDSK utility for the failing drive. More
information about corrupted directories can be found in dsmerror.log.

------------------------------------------------------------------------
ANS4039E

Error processing 'filespace namepath-namefile-name': compressed file is
corrupted and cannot be expanded.



Explanation:

The compressed file cannot be expanded correctly due to one of the
following reasons:

   There is a problem on the tape.
   There is a communications problem.
   The compressed file was corrupted on the IBM Spectrum Protect Server.

System action:

File skipped.

User response:

1) The compressed file is corrupted because there is a problem on the
tape. To know if this is the problem, please issue the following command
on the IBM Spectrum Protect Server: audit volume <volume_name> fix=no If
there is any problem reported, you could move the data from that volume
to a new one (see command MOVE DATA) and try again the restore. 2) There
are communications problems between the IBM Spectrum Protect Server and
the IBM Spectrum Protect Client and the results is that the file is
corrupted during the transmission. If you use a gigabit ethernet adapter
on the Server please upgrade the card driver (AIX platform) or add
provided by SUN suggested changes to some system network options which
have resolved this problem (SUN platform). 3) Please verify with your
network support if during the restore there are no any problems between
the IBM Spectrum Protect Client/Server that is originating the file
corruption.

------------------------------------------------------------------------
ANS4040E

Error processing 'filespace namepath-namefile-name': file system
filespace name has exceeded its space management quota.



Explanation:

IBM Spectrum Protect detects that the file system has exceeded its
quota. No more data can be migrated out of this file system.

System action:

IBM Spectrum Protect will not migrate files from this file system.

User response:

Recall some files, or ask the system administrator to increase the quota
for this file system.

------------------------------------------------------------------------
ANS4041E

A Windows Server 2008 or 2008 R2 VMware guest cannot be restored with a
non-Windows data mover.



Explanation:

A Windows data mover must run certain commands to complete the restore
of the Active Directory. Non-Windows data movers do not have the
necessary tools to complete this operation. Windows VMware guests that
are at Windows Server 2012 or higher are not affected by this
restriction.

System action:

Processing stops.

User response:

Use a Windows data mover to complete this action.

------------------------------------------------------------------------
ANS4042E

Object name 'filespace namepath-namefile-name' contains one or more
unrecognized characters and is not valid.



Explanation:

The file name, directory name, or volume label syntax is incorrect.

System action:

The file is skipped.

User response:

Check the disk for errors.

------------------------------------------------------------------------
ANS4044E

Error processing 'filespace-namepath-namefile-name': Case-sensitive name
conflict exists.



Explanation:

While processing the specified file on the workstation, another file
name was encountered with a similar name which only differed in case.
The Backup-Archive client does not allow names which differ only in case
on this platform and cannot guarantee the integrity of the file, so the
file is skipped.

System action:

This object will be skipped.

User response:

Rename the file in question to a unique name.

------------------------------------------------------------------------
ANS4045E

Error processing 'filespace-namepath-namefile-name': Case-sensitive name
conflict exists. The directory tree will be skipped.



Explanation:

While processing the specified file on the workstation, another object
name was encountered with a similar name which only differed in case.
The Backup-Archive client does not allow names which differ only in case
on this platform and cannot guarantee the integrity of the file, so the
directory and all of the objects contained within it are skipped.

System action:

This object will be skipped.

User response:

Rename the file in question to a unique name.

------------------------------------------------------------------------
ANS4046E

There is an error processing 'filespace-namepath-namefile-name': the
object is corrupted and unreadable.



Explanation:

You tried to read from or write to a file or directory that is
corrupted. The corrupted file is skipped. If this is a directory, the
objects contained in the directory and its subdirectories are skipped.

System action:

This object will be skipped.

User response:

Check your system to ensure that the filespace is not corrupted by using
system tools like chkdsk (Windows) or fsck (UNIX).

------------------------------------------------------------------------
ANS4047E

There is a read error on 'file-namefile-namefile-name'. The file is
skipped.



Explanation:

The specified file-name was skipped during backup archive because the
file could not be read.

If you are performing a JFS2 snapshot based operation, it is possible
that the snapshot was not large enough to contain all the changes made
to the filesystem after the snapshot was created. This could cause the
snapshot to become invalid thereby preventing IBM Spectrum Protect
client from reading the snapshot.

System action:

IBM Spectrum Protect skipped the file.

User response:

Check your system to ensure that it is operating properly.

If you are performing a JFS2 snapshot based operation, please use the
default snapshotcachesize of 100% and ensure that the volume group has
sufficient disk space to allocate snapshots at least as large as the
file system and retry the operation.

------------------------------------------------------------------------
ANS4048W

LAN-Free connection failed.



Explanation:

ENABLELANFREE option is set to YES for this session, but an attempt to
establish LAN-Free connection failed.

System action:

The IBM Spectrum Protect client will failover to non LAN-Free support.

User response:

Review the IBM Spectrum Protect error.log for LAN-Free failures. Check
your LAN-Free setup and verify that all components are working properly.

------------------------------------------------------------------------
ANS4049I

Established LAN-Free connection.



Explanation:

ENABLELANFREE option is set to YES for this session and the IBM Spectrum
Protect client successfully established LAN-Free connection with server,
after the LAN-Free connection was broken.

System action:

The IBM Spectrum Protect client will communicate with the server via
LAN-Free.

User response:

Review the IBM Spectrum Protect error.log for LAN-Free errors. Check
your LAN-Free setup and verify that all components are working properly.

------------------------------------------------------------------------
ANS4050W

Scheduled action 'schedule-action' did not execute for schedule
'schedule-name' as the IBM Spectrum Protect administrator has been
disabled from executing the scheduled action on the client.



Explanation:

One or more of the client options - schedcmddisabled,
srvprepostscheddisabled, srvprepostsnapdisabled, restretrscheddisabled,
have been set to YES on the client thereby preventing the IBM Spectrum
Protect administrator from executing one of the following scheduled
actions on the client - preschedule, postschedule, presnapshot,
postsnapshot or scheduled operating system commands, restore or retrieve
operations.

System action:

The scheduled operation will not be executed and a message will be
logged to IBM Spectrum Protect Server indicating this.

User response:

None required.

------------------------------------------------------------------------
ANS4051E

Error processing 'filespace namepath-namefile-name': The decryption
option is in effect, but the user ID under which back-up or archive is
being run is not authorized to decrypt this encrypted-file-system (EFS)
file.



Explanation:

The file being processed is encrypted by an encrypted file system (EFS).
The option is specified to back-up or archive the file in decrypted
form. The user ID under which the back-up or archive is being run does
not have decryption rights for this file.

System action:

The file is skipped.

User response:

There are three possible ways to make decryption work:

*  Re-encrypt the file under the encryption key of a group to which both
   the owner and the back-up/archive user IDs belong

*  Add the back-up/archive user ID to the list of users authorized to
   decrypt this file

*  Run the back-up or archive under the owner's user ID, if possible

------------------------------------------------------------------------
ANS4052E

Error processing 'filespace namepath-namefile-name':
Encrypted-file-system (EFS) file cannot be restored, because file system
does not support restore from the raw-EFS back-up data, or possibly
because the restore function does not have write access to the
directory.



Explanation:

The file being processed is encrypted by an encrypted file system (EFS).
The file was backed up in the raw encrypted format. Either the target
filesystem does not support the encrypted format, or restore does not
have write access to the directory to which the file is to be restored.

System action:

The restore is terminated.

User response:

*  The file cannot be restored to this location if the file system is
   not the AIX Enhanced Journaled File System (JFS2)

*  If the file is JFS2 but EFS is not enabled, then EFS must be enabled
   before the file can be restored

*  If the user ID under which restore is being run does not have write
   permission for the directory, the permissions must be changed or the
   restore must be run under a different user ID

------------------------------------------------------------------------
ANS4053E

Error processing 'filespace path filename': The file cannot be restored
because the file system or operating system does not support the
Encrypting File System (EFS) data.



Explanation:

The specified object was backed-up as raw Encrypting File System (EFS)
data. The client is trying to restore or retrieve the object to a
destination that does not support the EFS data. The location might not
support the EFS data for one of the following reasons:

*  The operating system does not provide the support, or is a release
   that does not include the support

*  EFS support has not been activated on the operating system

*  The target file system does not support the EFS data

System action:

The object is not restored or retrieved. Processing continues with the
next object.

User response:

If this file must be restored, restore it to an AIX operating system
environment supporting EFS data.

------------------------------------------------------------------------
ANS4054E

Error processing 'filespace namepath-namefile-name': The encryption key
is not loaded.



Explanation:

The file being processed is encrypted by an encrypted file system (EFS).
The option is specified to backup or archive the file in decrypted form.
The encryption key, required to decrypt the file, is not loaded in the
kernel keyring.

System action:

The file is skipped.

User response:

There are three situations in which this problem can occur:

*  You just performed initial activation of EFS on the AIX system, and
   have not logged out. AIX does load the keys for the session running
   at the time of initial activation. Solution: Logout and login again.

*  The login password has been changed recently, and you normally run
   with the EFS password the same as the login password. AIX does not
   automatically change the EFS password when you change the login
   password. Solution: Issue 'efskeymgr -n' to set the EFS password to
   be the same as the login password.

*  You need to run the decrypting backup when the EFS password is
   different from the login password. Solution: Issue 'efskeymgr -o ksh'
   to launch a new shell with the keys loaded. AIX will prompt you for
   the EFS password as you launch the shell. Run the backup from the new
   shell.

------------------------------------------------------------------------
ANS4055E

Cannot update file space 'filespace-name': the file space version on the
IBM Spectrum Protect server is not compatible with this client



Explanation:

The file space on the IBM Spectrum Protect server is not compatible with
this client. This is caused by performing a backup or archive operation
with a client and then using a down-level client and attempting a backup
or archive operation targeting the same file space. This problem occurs
specifically after a Windows or AIX client V6.1 or higher performs a
backup or archive operation and then a subsequent backup or archive
operation is attempted with a client V5.5 or lower.

System action:

Processing stops.

User response:

Use the correct level of the client.

------------------------------------------------------------------------
ANS4056E

Object 'object-name' returned by the IBM Spectrum Protect server has a
high-level name that exceeds the maximum length of 6000 characters. The
file or directory cannot be processed.



Explanation:

The IBM Spectrum Protect server returned information about a backup or
archive version with a high level name that exceeds 6000 characters. The
high-level name is the directory path that contains the object (file or
directory).

This message is displayed when all of the following conditions are true:

*  The object was backed up or archived by a version 6.1 or lower IBM
   Spectrum Protect client.

*  The object was backed up or archived to a version 5.5 or lower IBM
   Spectrum Protect server.

*  IBM Spectrum Protect client version 6.2 or higher is attempting to
   perform an operation that causes the IBM Spectrum Protect server to
   return information about this object to the client. Note: During
   incremental backup, the server returns information to the client
   about active backup versions which is used to determine which files
   have changed.

Beginning with IBM Spectrum Protect server version 6.1, the maximum high
level name length was reduced from 8192 characters to 6000 characters.
Objects with high level names that exceed 6000 characters are not
supported for backup or archive. Beginning with IBM Spectrum Protect
backup-archive client version 6.2, the maximum high level name length
was similarly reduced.

System action:

The file or directory specified in the message is skipped. Processing
will continue with the next object.

User response:

Contact your IBM Spectrum Protect server administrator for further
assistance.

------------------------------------------------------------------------
ANS4057W

Unable to process object 'fs' with nested file system mounted on it
during snapshot based backup.



Explanation:

Snapshot based backup of objects with mounted file systems on them are
not supported.

System action:

The backup operation continues without specified object.

User response:

To prevent this behaviour unmount file system from specified object and
retry the operation.

------------------------------------------------------------------------
ANS4058I

A write failure occurred while attempting to save node replication
failover values to the options file.



Explanation:

A write failure is often a result of insufficient access permissions to
the options file, but could also be caused by the lack of available disk
space. The replication server connection information can not be saved
and failover will not be possible.

System action:

The operation failed.

User response:

Check the local disk for possible causes of the write error, and check
to see that sufficient access to the options file is configured.

------------------------------------------------------------------------
ANS4059I

The option USEREPLICATIONFailover is set to NO. The node will not fail
over to the failover server



Explanation:

This option will prevent the node from connecting to the replication
server in the event of a failure of the primary server.

System action:

The client will not connect to the primary server and processing stops.

User response:

No response is required.

------------------------------------------------------------------------
ANS4061I

Connected to failover server failover server; in fail over mode. Home
server is: home server;



Explanation:

The node is configured for replication and has successfully connected to
the failover server. This message is to notify the server administrator
that a node has connected to the failover server in fail over mode.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS4063W

IBM Spectrum Protect application protection cannot copy the application
metafile 'App-Metadata-File-Name' from the following VM: 'VM-Name'.
Individual database restore from this backup is not supported. Check
health of application writers and databases



Explanation:

The application metafile was not found on the guest machine.

System action:

The operation completes. However, the application metafile was not
copied.

User response:

Make sure that the application VSS writers are running on this guest
machine, and the application database is in the state to allow the
backup. For Exchange check that databases are mounted. For SQL check
databases are online. Then try the operation again.

------------------------------------------------------------------------
ANS4064I

Restoring vCloud Director vApp 'vapp name' from Organization VDC 'org
vdc name' from organization 'org name' Target vApp name is 'restored
vapp name' Restore VAPP command started. Total number of vApps to
process: vapps num to restore



Explanation:

The restore vApp operation completed.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS4065E

Proxy rejected: data mover node 'dm node' has not been granted proxy
authority for target node 'target_node', associated with Organization
vDC 'OVDC name' of Organization 'Org Name'.



Explanation:

The operation requires that a proxy access for the data center node is
granted to the data mover node.

System action:

Operation is canceled for the specified vApp.

User response:

Run configuration wizard or configuration editor to configure proper
nodes relashionship.

------------------------------------------------------------------------
ANS4066I

Snapshot operation attempt x of y for the guest virtual machine 'VM'
failed using "sType" snapshot. Reattempting snapshot with "sType2"
snapshot.



Explanation:

The snapshot operation has failed. A snapshot retry operation has been
scheduled.

System action:

Retrying snapshot.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Correct any problems and try the operation again.

------------------------------------------------------------------------
ANS4067E

Snapshot operation attempt x of y for the guest virtual machine 'VM'
failed using "sType" snapshot. Backup failed.



Explanation:

All snapshot retry attempts of the guest virtual machine failed.

System action:

Processing stops.

User response:

Check the error log for any messages that indicate a reason for the
failure. Correct any problems and try the operation again. If the
problem persists, search the IBM Spectrum Protect Support web site
(http://www.ibm.com/software/sysmgmt/products/support/IBMTivoliStorageManager.html)
for known solutions.

------------------------------------------------------------------------
ANS4068I

Restored virtual machine 'VM' was backed up using a "VMware Tools with
file system quiescing and application quiescing disabled" snapshot. This
is equivalent to a "crash-consistent" backup.



Explanation:

The restored virtual machine was backed up using a "VMware Tools with
file system quiescing and application quiescing disabled" snapshot.
Application Protection feature is not available.

System action:

Restore of the VM continues.

User response:

None

------------------------------------------------------------------------
ANS4069E

The Windows domain credentials cannot be found. Use the Data Protection
for VMware vSphere GUI configuration editor to set the Windows domain
credentials.



Explanation:

The required Windows domain administrator credentials were not set.

System action:

Processing stops.

User response:

Set the Windows domain administrator credentials in the Data Protection
for VMware vSphere GUI configuration editor.

------------------------------------------------------------------------
ANS4070E

Windows domain credentials are incorrect. Verify the credentials and use
dsmc SET PASSWORD -type=DOMAIN 'domain\userid' 'password' to update the
username and password.



Explanation:

The supplied credentials are incorrect. The system failed to
authenticate to the Windows domain using these credentials.

System action:

Processing stops

User response:

Use dsmc SET PASSWORD -type=DOMAIN 'domain\userid' 'password' to update
the username and password. And then retry the operation.

------------------------------------------------------------------------
ANS4071E

'VM-Name' cannot be restored because it was backed up with a newer
version of the client.



Explanation:

The client version that attempted to restore the virtual machine is
earlier than the client version that backed up the virtual machine. The
virtual machine cannot be restored with an earlier client version.

System action:

The virtual machine is not restored. Processing continues with the next
virtual machine.

User response:

Upgrade the client to a version that is compatible with the client
version that backed up the virtual machine.

------------------------------------------------------------------------
ANS4072E

Error processing 'filespace namepath-namefile-name': unable to create
symbolic link; a file or directory exists with the same name as the
symbolic link



Explanation:

IBM Spectrum Protect tried to create a symbolic link, but is unable to
because a file or directory exists that has the same name as the
symbolic link.

System action:

Processing stops.

User response:

Remove the file or the directory that has the same name as the symbolic
link. Refer to the last restore/retrieve operation.

------------------------------------------------------------------------
ANS4073W

Snapshot operation attempt x of y for the guest virtual machine 'VM'
failed using "sType" snapshot. Reattempting snapshot with "sType2"
snapshot.



Explanation:

The snapshot operation has failed. A snapshot retry operation with
different snapshot type has been scheduled.

System action:

Retrying snapshot with different snapshot type.

User response:

Check the error log for any other messages that might indicate a reason
for the failure. Correct any problems and try the operation again.

------------------------------------------------------------------------
ANS4077E

File 'filespace namepath-namefile-name' is encrypted by Microsoft EFS
and contains at least one sparse data stream. The operating system does
not support restore for this file so it is not backed up or restored.



Explanation:

An error in the Microsoft Windows API prevents successful restore of
files that meet the following conditions:

*  The file is encrypted by Microsoft Encrypting File System (EFS) at
   the time it was backed up

*  The file includes at least one data stream (alternate "named" stream
   or unnamed stream) that is sparse

*  The operating system is any edition of Microsoft XP, Microsoft
   Windows Server 2003, or Microsoft Windows Server 2003 R2

Because the file cannot be restored, IBM Spectrum Protect does not back
it up. The problem is documented by Microsoft at
http://support.microsoft.com/kb/2525290.

System action:

The file is not backed up or restored. Processing continues with the
next object or ends if there are no further objects.

User response:

If this message is issued during a backup operation, you can do the
following:

*  Disable EFS encryption for the file so that it can be backed up.

*  If a backup copy of the file is not necessary, you can exclude it
   from backup.

------------------------------------------------------------------------
ANS4078E

Content file content.spsig is missing, is damaged or failed the
signature check.



Explanation:

The file content.spsig is missing. Or the file is damaged or the
signature of the file does not match. See client log file for more
information.

System action:

Processing stops.

User response:

Make sure that the data in the Operations Center, such as the client
package or Update Manager package, is correct or download the correct
version in the Operations Center.

------------------------------------------------------------------------
ANS4079E

One or more files failed the signature check.



Explanation:

The signature of one or more files does not match the contents of
content.spsig. See the client log file for more information.

System action:

Processing stops.

User response:

Make sure that the data in the Operations Center, such as the client
package or Update Manager package, is correct or download the correct
version in the Operations Center.

------------------------------------------------------------------------
ANS4081E

Error processing 'filespace-name': file space type is not supported.



Explanation:

The specified file space type is not currently supported by IBM Spectrum
Protect on this platform.

System action:

The unsupported file system is skipped. Processing continues with the
next file system.

User response:

Refer to the documentation for information on what file space types are
supported.

------------------------------------------------------------------------
ANS4083I

New node password has been generated.



Explanation:

The client logged in using administrative id rather than node name. New
random node password has been generated and recorded.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS4084E

Error processing 'filespace-namepath-namefile-name': cannot get file
status.



Explanation:

While processing the file, the lstat() call set EOVERFLOW error code.

System action:

This file will be skipped.

User response:

The file is skipped. Processing continues with the next file.

------------------------------------------------------------------------
ANS4085I

Assigned 'number' objects from previous systemstate backup to the new
systemstate backup.



Explanation:

Objects in the previous System State backup have not changed and were
assigned to the new System State backup.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS4086W

Failed to assign unchanged objects from previous systemstate backup to
the new systemstate backup. Objects will be backed up.



Explanation:

Objects in the previous System State backup have not changed and should
be assigned to the new systemstate backup. Due to error assign operation
failed and objects will be backed up.

System action:

Processing continues.

User response:

Retry the operation. If the problem persists, contact IBM Spectrum
Protect technical support.

------------------------------------------------------------------------
ANS4087E

An attempt to load data for the wizard failed. For more information,
please see the log file.



Explanation:

An attempt to load data for the wizard failed as the remote agent is
probably unavailable.

System action:

Processing stopped.

User response:

Check the log for reason for the failure.

------------------------------------------------------------------------
ANS4089W

File server file-server-name has been upgraded to Data ONTAP version
'version.modifcation.submodification'. Perform a full incremental backup
by specifying option createnewbase=migrate as soon as possible.



Explanation:

The file server has been upgraded to a version that supports unicode
file names for incremental backup using snapshot difference. Perform a
full incremental in order to backup any files with unicode names that
may have been skipped by the previous version of the IBM Spectrum
Protect client.

System action:

Processing continues.

User response:

Perform a full incremental by specifying the command line option
createnewbase=migrate with the snapdiff option as soon as possible.

------------------------------------------------------------------------
ANS4090I

File server file-server-name has been upgraded to Data ONTAP version
'version.modifcation.submodification'. Perform a full incremental backup
by specifying option createnewbase=migrate as soon as possible.



Explanation:

The file server has been upgraded to a version that supports unicode
file names for incremental backup using snapshot difference. Perform a
full incremental in order to backup any files with unicode names that
may have been skipped by the previous version of the IBM Spectrum
Protect client.

System action:

Processing continues.

User response:

Perform a full incremental backup by specifying the command line option
createnewbase=migrate with the snapdiff option as soon as possible.

------------------------------------------------------------------------
ANS4092E

Data mover platform is not supported for instant access/restore
operations.



Explanation:

The instant access/restore operation failed.

System action:

The instant access/restore operation failed. The reason for the failure
is unsupported platform.

User response:

The instant access/restore operation should be performed from a
supported data mover platform.

------------------------------------------------------------------------
ANS4099E

The system volume cannot be identified. Therefore the system state
cannot be backed up.



Explanation:

The system volume contains the hardware-specific system state files that
are needed to start Windows, such as Ntldr, Boot.ini, Ntdetect.com or
Bootmgr. If the system volume cannot be identified, then these files
cannot be backed up. Therefore it is not possible to back up the system
state.

System action:

Systemstate backup stops.

User response:

Try the operation again. If the problem persists, obtain a service trace
that captures the problem and contact IBM technical support for
additional assistance. Your IBM Spectrum Protect administrator can help
you configure the trace.

------------------------------------------------------------------------
ANS4137E

Error processing 'filespace namepath-namefile-name': exceeded maximum
number of links allowed



Explanation:

Link cannot be restored or retrieved because the destination file system
has exceeded maximum number of links allowed.

System action:

The client prompts you for action:

*  Skip this object

*  Abort the action

User response:

Select the appropriate action for this object. Restore or retrieve the
link to another file system.

------------------------------------------------------------------------
ANS4148E

Full VM backup of Virtual Machine 'vmname' failed with RC rc



Explanation:

The Full VM backup of virtual machine failed.

System action:

The full backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4150E

Incremental backup of Virtual Machine 'vmname' failed with RC rc



Explanation:

The incremental backup of virtual machine volumes failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4151E

Failure mounting Virtual Machine 'vmname'. RC=rc



Explanation:

The VMware failed to mount virtual machine disk.

System action:

The backup of the virtual machine can not continue. The next virtual
machine in the vmlist will be processed. Refer to dsmerror.log for
detailed error message for the reason for the failure.

User response:

Refer to dsmerror.log for detailed error message.

------------------------------------------------------------------------
ANS4152E

Failure initializing VMware virtual machine environment. RC=rc. Refer to
IBM Spectrum Protect error log for detailed error messages.



Explanation:

Failure initializing VMware virtual machine environment. Refer to IBM
Spectrum Protect error log for detailed error messages.

System action:

The backup can not continue.

User response:

Refer to IBM Spectrum Protect error log for detailed messages.

------------------------------------------------------------------------
ANS4153E

Hostname could not be found for Virtual Machine 'vmname'



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4154E

Possible cause Virtual Machine is not running and does not have a static
IP address.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4155E

The virtual machine 'vmname' was not found on the vSphere server.



Explanation:

The backup of the virtual machine failed because the specified virtual
machine name was not found. It is possible that the virtual machine name
was entered incorrectly or contains unsupported characters. Only virtual
machine names that contain 7-bit ASCII characters are supported, and the
operation will fail if the name contains other characters.

System action:

The backup of the virtual machine failed. The next virtual machine in
the vmlist will be processed. Check the client error log for additional
error messages.

User response:

Check the local client error log for reason for the failure.

*  If the virtual machine name was entered incorrectly, try the
   operation again with the correct machine name.

*  If the virtual machine name contains characters other than 7-bit
   ASCII characters, either change the virtual machine name so it
   contains only 7-bit ASCII characters, or do not include the virtual
   machine for backup operations.



------------------------------------------------------------------------
ANS4156E

File level VM backup of virtual machine 'vmname' not supported. File
level VM backup not support on non Windows platform guest OS. Platform
type: 'platform'.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Back up the virtual machine using the VMBACKUPType=FULLvm option.

------------------------------------------------------------------------
ANS4159E

Backup of Virtual Machine 'vmname' failed. rc=rc.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4160E

Proxy Rejected: Proxy authority has not been granted to Agent Node:
'agent_node' for Target Node: 'target_node'.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is the node has not been granted proxy authority to access the
node named by the backup proxy node. The IBM Spectrum Protect
administrator must first grant proxy authority.

User response:

The IBM Spectrum Protect server administrator must grant proxy authority
for this node. See the administrator command "Grant Proxynode".

------------------------------------------------------------------------
ANS4161E

Duplicate virtual machine name 'vmname' was detected in the same backup
operation. Backup of virtual machine 'vmfullname' can not continue
without a unique object name.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Choose a unique name for the virtual machine.

------------------------------------------------------------------------
ANS4162E

The virtual machine 'virtual-machine-name' has not been previously
backed up.



Explanation:

The specified virtual machine has not been previously backed up, so can
not be specified for restore.

System action:

The specified virtual machine is skipped, and the next virtual machine
in the restore list is processed.

User response:

Verify the virtual machine name to be restored, and re-try the
operation.

------------------------------------------------------------------------
ANS4164W

Compression is currently enabled, but the virtual machine backup for
'virtual-machine-name' is not compressed because client-side
deduplication is not being used.



Explanation:

Compression can only be used with virtual machine CTL and Data files
when the files are stored in a storage pool that is enabled for
client-side deduplication. This message is issued when the client is
configured for compression and virtual machine CTL or Data files are
directed to a storage pool that is not enabled for client-side
deduplication.

System action:

Backup continues, and data is not compressed.

User response:

If you intend to compress virtual machine CTL and Data files, then
update your IBM Spectrum Protect configuration so that both types of
files are directed to storage pools that are enabled for client-side
deduplication. If you intend to compress virtual machine Data files but
not CTL files, then update your IBM Spectrum Protect configuration so
that the Data files are directed to a storage pool that is enabled for
client-side deduplication. Set the VMSKIPCTLCOMPRESSION to YES in your
client options file. If you do not intend to use compression, then set
COMPRESSION NO in your client options file.

------------------------------------------------------------------------
ANS4165E

Creating a Virtual Machine, but the hostname 'virtual-machine-name' was
not found.



Explanation:

The Virtual Machine being creating must have a valid hostname to be
created.

System action:

Check the virtual machine hostname specified for correctness.

User response:

Correct the virtual machine hostname specified and retry the restore.

------------------------------------------------------------------------
ANS4166E

Creating a Virtual Machine, but the datacenter 'virtual-machine-name'
was not found. The name may be incorrect or may be located in a VMware
folder and require the folder name such as vmfolder/dcname.



Explanation:

The Virtual Machine being created must have a valid datacenter to be
created.

System action:

Processing stops.

User response:

Check the virtual machine datacenter specified for correctness. If the
datacenter is contained in a folder then the full datacenter name,
complete with the folder path, must be specified, such as
vmfolder/dcname.

------------------------------------------------------------------------
ANS4167E

Creating a Virtual Machine, but the datastore 'virtual-machine-name' was
not found.



Explanation:

The Virtual Machine being creating must have a valid datastore to be
created.

System action:

Check the virtual machine datastore specified for correctness.

User response:

Correct the virtual machine datastore specified and retry the restore.

------------------------------------------------------------------------
ANS4168E

VMware has reported an error via their SOAP interface. On the Detailed
Status Report panel, view the last error message reported. Also check
the error log for more information about the problem that occurred.



Explanation:

The command to VMware failed to complete. The error returned is
displayed on the Restore or Backup summary panel under the Last Error
Message section.

System action:

An error occurred, and the operation failed.

User response:

Check the reported error and correct the problem. Usually the reason for
the error is a user-supplied value which is not valid for the operation.

------------------------------------------------------------------------
ANS4169E

A write failure occurred on the local disk proxy used to temporarily
store the virtual machine virtual disk information. The write failure
can be caused by the lack of available disk space on the drive used to
store this information. The VMBACKDIR option can be used to assign a
different disk location for this purpose. Check the drive being used and
ensure that there is enough space available for this operation.



Explanation:

There was a write error from the local disk used to store the virtual
machine virtual disk information. Usually the write error is due to lack
of disk space, lack of write permissions, or some similar problem with
the local disk. The VMBACKDIR option can be used to assign a different
disk location if the local drive does not have enough free space for the
operation.

System action:

A disk write error occurred, and the operation failed.

User response:

Check the local disk for possible causes of the write error, and use the
VMBACKDIR option to assign another disk if needed.

------------------------------------------------------------------------
ANS4170E

Can not create a Virtual Machine on VMware release
'release-version-target' which was backed up from VMware release
'release-version-source'.



Explanation:

The Virtual Machine being created was backed up from a version of VMware
which is not compatible with the target VMware release version being
used for the restore.

System action:

Processing stops.

User response:

Restore the Virtual Machine to a VMware system which is compatible with
the level from which the Virtual Machine was backed up.

------------------------------------------------------------------------
ANS4174E

Full VM backup of VMware Virtual Machine 'vmname' failed with RC=rc
mode=full_or_incr, target node name='target_node_name', data mover node
name='data_mover_node_name'



Explanation:

The Full VM backup of virtual machine failed. If the virtual machine
(VM) name contains the word AGGREGATE, the statistics that are shown
represent the total value of all VM guests that are backed up per data
mover.

System action:

The full backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4177E

Full restore of VMware virtual machine 'vmname' failed with RC=rc,
mode='restore_or_revert', target node name='target_node_name', data
mover node name='data_mover_node_name'



Explanation:

The full restore of the virtual machine failed.

System action:

The full restore of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4179I

IBM Spectrum Protect application protection did not truncate the
Microsoft SQL Server logs on VM 'VM'.



Explanation:

The SQL server logs were not truncated because the following option was
specified for this virtual machine: INCLUDE.VMTSMVSS vname
OPTIONS=KEEPSQLLOG

System action:

The operation completes.

User response:

Remove the OPTIONS=KEEPSQLLOG option to enable truncation of the SQL
logs when a backup completes.

------------------------------------------------------------------------
ANS4187W

CPU and Memory Resource Allocation configuration settings cannot be
restored when the IBM Spectrum Protect data mover node is connected
directly to a Virtual Center managed ESX/ESXi host. These settings have
been skipped.



Explanation:

The VMware vStorage APIs do not support the restore of CPU and Memory
Resource Allocation configuration settings when connected directly to an
ESX/ESXi host that is managed by a Virtual Center.

System action:

CPU and Memory Resource Allocation configuration settings are skipped.
Processing continues.

User response:

Virtual machine CPU and Memory Resource Allocation configuration
settings will be restored when the IBM Spectrum Protect data mover node
connects directly to a vCenter Server. Modify the VMCHOST to connect the
IBM Spectrum Protect data mover to a vCenter Server.

------------------------------------------------------------------------
ANS4191E

Restore VM operation failed using 'san' transport mode. In some cases
switching from SAN to network-based VM restores can be successful.



Explanation:

Restore VM operations that fail using SAN transport mode can often be
successful over a LAN path. If a restore vm operation fails using the
'SAN' transport mode, set the client option VMVSTORTRANSPORT to
"nbd:nbdssl" and try the restore vm operation again.

System action:

Restore VM operation failed using 'san' transport mode. Restore may be
successful using 'nbd:nbdssl' transport modes.

User response:

Restore VM operation failed using 'san' transport mode. In some cases
network-based VM restores can be successful when using 'nbd' or 'nbdssl'
transport modes. The VMVSTORTRANSPORT option can used to restrict the
IBM Spectrum Protect client to use only the specified transport modes.

------------------------------------------------------------------------
ANS4193E

vApp 'vApp name' cannot be processed because data mover 'dm node' cannot
connect to the target node 'target_node'.



Explanation:

The operation requires that a proxy access for the data center node is
granted to the data mover node.

System action:

Operation is canceled for the specified vApp.

User response:

Look for errors in error log and correct any problems. Run configuration
wizard or configuration editor to ensure proper nodes configuration.

------------------------------------------------------------------------
ANS4194E

Encryption is currently enabled, but is not supported for incremental
forever backups of virtual machines (-MODE=IFFULL or
-MODE=IFINCREMENTAL) .



Explanation:

Client encryption of virtual machine incremental forever backups
(-mode=IFFULL or -mode=IFINCREMENTAL) is not supported. In order to
avoid the unintentional storage of unencrypted data on the server, the
backup operation stops.

System action:

The virtual machine backup stops.

User response:

Remove the encryption options for this operation and run it again. You
can use Secure Sockets Layer (SSL) encryption to encrypt the data over
the network. If the backup data must be encrypted in IBM Spectrum
Protect storage pools, use an alternative backup method such as full and
incremental backups (-mode=FULL and -mode=INCREMENTAL), or in-guest
backups.

------------------------------------------------------------------------
ANS4195E

The target node for Organization VDC 'OrgVDC name' in Organization 'Org
name' was not found. As a result, vApp 'vApp name' cannot be backed up.



Explanation:

Either the IBM Spectrum Protect node for the specified organization VDC
was not found on the IBM Spectrum Protect server, or information about
the Organization VDC node was not found in the Provider VDC node.

System action:

Back up of the specified vApp stops. Processing continues to the next
vApp.

User response:

Go to the Configuration page and click 'Run the Configuration Wizard' to
verify that all required IBM Spectrum Protect nodes are registered on
the IBM Spectrum Protect server. If required, register a new data mover
node. Make sure that the organization VDC belongs to the provider VDC
that this data mover node protects.

------------------------------------------------------------------------
ANS4199W

File 'file name' is not backed up as part of the system state because
cluster disk 'volume name' is not accessible.



Explanation:

The indicated file or directory was returned by VSS as part of the
backup file list of the writer. However, the cluster disk where the file
is located is not accessible. The reasons for this problem can be that
the cluster disk is offline or belongs to another node.

System action:

The file is not backed up. Processing continues.

User response:

This problem is documented in Microsoft knowledge base topic 980794
http://support.microsoft.com/default.aspx?scid=kb;EN-US;980794. The
topic includes a hotfix. With the hotfix, you can specify a registry key
that contains a list of one or more files to be excluded from VSS
enumeration. IBM Spectrum Protect does not back up files that are not
enumerated by VSS. If the volume is brought online to the node
performing the system state backup, then it cannot be backed up. You
must remove the volume from the registry key and restart the system
before you can back up the volume. If you do not want to implement the
hotfix for this problem, IBM Spectrum Protect continues to issue this
message.

------------------------------------------------------------------------
ANS4200E

The virtual machine 'vmname' could not be backed up because the data
usage of datastore 'datastore' exceeded the datastore threshold of
percentused percent.



Explanation:

The data usage of the datastore used by the virtual machine exceeds the
threshold set by the VMDATASTORETHRESHOLD option.

System action:

The virtual machine is not backed up.

User response:

Reduce the data usage of the datastore or increase the threshold in the
VMDATASTORETHRESHOLD option. Then, back up the virtual machine again.

------------------------------------------------------------------------
ANS4202E

The Deployment Manager failed to install language pack: language pack
name. The Microsoft Installer error code was error code.



Explanation:

The previous language pack has been uninstalled, and the installation of
the new language pack failed.

System action:

Processing continues.

User response:

For more information about Windows installer error messages, go to the
Microsoft Developer Network (MSDN) technical library at
http://msdn.microsoft.com/en-us/library and search on "Windows Installer
Error Messages".

Check the install log on the client computer.

------------------------------------------------------------------------
ANS4204E

The Operating System of the client computer: 'os name' is not supported
by the target version: 'target version'



Explanation:

The operating system level of the client computer is no longer supported
by the target level.

System action:

Processing stops.

User response:

Check the release documentation for information on supported operating
system levels.

------------------------------------------------------------------------
ANS4206E

The Deployment Manager received an error while extracting from
installation image: image name.



Explanation:

The installation image might be missing, corrupted, or there might be
insufficient disk space on the client computer.

System action:

Deployment Manager stops.

User response:

Make sure that there is sufficient disk space on the client computer.

Make sure that all of the Windows self extracting client images on the
client computer are valid.

------------------------------------------------------------------------
ANS4207E

The Deployment Manager was unable to initiate the final connection
between the server and the updated backup-archive client.



Explanation:

After the automatic client deployment, the dsmc query session command
from the updated backup-archive client was not successful.

System action:

The Deployment Manager process ends.

User response:

Log on to the client computer and check the backup-archive client error
log.

------------------------------------------------------------------------
ANS4210E

The Deployment Manager failed to install package: 'client package name'.
The Microsoft Installer error code was 'system architecture'



Explanation:

The previous client package has been uninstalled, and the installation
of the new client package failed.

System action:

Processing stops.

User response:

Check the technote for Microsoft Installer error code description:
http://www-01.ibm.com/support/docview.wss?uid=swg21050782&rs=663

Check the install log on the client computer.

------------------------------------------------------------------------
ANS4212E

The Deployment Manager failed to restart service: servicename



Explanation:

After the automatic client deployment, the IBM Spectrum Protect client
services failed to start.

System action:

Processing stops.

User response:

Log on to the client machine and check the backup-archive client error
log.

------------------------------------------------------------------------
ANS4213E

Automatic restart of the client computer was required because reason



Explanation:

The Deployment Manager determined that the deployment requires
restarting the client.

Automatic restart is not enabled. The Deployment Manager process cancels
the deployment.

The current client is not uninstalled or updated.

System action:

Deployment Manager cancels the client deployment and stops

User response:

Reschedule the client deployment.

------------------------------------------------------------------------
ANS4215E

The automatic deployment path from the current client code version
'source version' to the client package version 'target version' is not
supported.



Explanation:

None

System action:

Processing stops.

User response:

Refer to the Backup-Archive Client documentation in the information
center.

Reschedule the client deployment with an appropriate target level.

------------------------------------------------------------------------
ANS4217E

The Deployment Manager received an error while setting up the client
API. The standard API function being invoked is API setup function name.



Explanation:

The Deployment Manager process failed when setting up the client API.

System action:

Processing stops.

User response:

Check the error log on the client computer.

------------------------------------------------------------------------
ANS4218E

The Deployment Manager received an error while initializing the client
API. The standard API function being invoked was API setup function
name.



Explanation:

The Deployment Manager process failed when initializing the client API.

System action:

Processing stops.

User response:

Check the error log on the client computer.

------------------------------------------------------------------------
ANS4219E

The Deployment Manager received an error while creating a pipe for the
standard output of the child process.



Explanation:

The Deployment Manager failed to create a pipe for the standard output
of the child process.

System action:

Processing stops.

User response:

Check the error log on the client computer.

------------------------------------------------------------------------
ANS4220E

The Deployment Manager is unable to determine if IBM Spectrum Protect
processes are still running.



Explanation:

The Deployment Manager could not determine whether all IBM Spectrum
Protect processes were shut down successfully.

System action:

Reschedule with automatic restart (autoreboot) enabled.

User response:

None

------------------------------------------------------------------------
ANS4221E

The architecture of the package: 'package architecture' does not match
the current client: 'system architecture'



Explanation:

The setup script was unable to retrieve the matching package from the
server.

System action:

Processing stops.

User response:

Ensure that the client packages for all architectures are available on
the server.

------------------------------------------------------------------------
ANS4222E

The Deployment Manager is unable to read information in file: file name.



Explanation:

Deployment Manager failed to open a file containing required system
information.

System action:

Processing stops.

User response:

Check the error log on the client computer.

------------------------------------------------------------------------
ANS4227E

The Deployment Manager failed to install package: 'client package name'.
The client computer is out of disk space. The Microsoft Installer error
code was 'error code'



Explanation:

The previous client package has been uninstalled, and the installation
of the new client package failed because the client computer is out of
disk space.

System action:

Processing stops.

User response:

Check the technote for Microsoft Installer error code description:
http://www-01.ibm.com/support/docview.wss?uid=swg21050782&rs=663

Check the install log on the client computer.

------------------------------------------------------------------------
ANS4228E

The Deployment Manager failed to install language pack: 'language pack
name'. The client computer is out of disk space. The Microsoft Installer
error code was 'error code'



Explanation:

The previous language pack has been uninstalled, and the installation of
the new language pack failed because the client computer is out of disk
space.

System action:

Processing continues.

User response:

Check the technote for Microsoft Installer error code description:
http://www-01.ibm.com/support/docview.wss?uid=swg21050782&rs=663

Check the install log on the client computer.

------------------------------------------------------------------------
ANS4229I

The client computer is required to restart to complete the new
Backup-Archive client installation.



Explanation:

The deployment of the new backup-archive client will not be complete
until the client computer is restarted. The restart is scheduled to
happen immediately after all language packs are deployed.

System action:

The Deployment Manager process continues. The client computer will be
shut down and restarted after all language packs are deployed, or
immediately if there are no language pack to install.

User response:

None

------------------------------------------------------------------------
ANS4230I

The client computer will be shut down and restarted immediately.



Explanation:

The Deployment Manager needs to restart the client computer to complete
the client deployment. It is possible the other messages provide details
of the deployment.

System action:

The Deployment Manager process continues. The client computer will be
shut down and restarted immediately after all language packs are
deployed, or immediately if there are no language pack to install.

User response:

None

------------------------------------------------------------------------
ANS4232E

Self-extracting installation image: image name cannot be found.



Explanation:

The Deployment Manager could not find the required installation image.

System action:

Processing stops. Client deployment will be cancelled.

User response:

Check the server's activity log or the scheduler log on the client
computer. Reshcedule the client deployment.

------------------------------------------------------------------------
ANS4234E

The deployment for language packs failed.



Explanation:

The Deployment Manager failed to install one or more language packs. It
is possible the other messages provide details of the installation.

System action:

The Deployment Manager process continues.

User response:

Check the error log and installation on the client computer. Identify
the language packs that failed to install and manually deploy them.

------------------------------------------------------------------------
ANS4235I

The deployment manager cannot log events to the server.



Explanation:

The Deployment Manager is unable to log events to the server. It is
possible the other messages provide details of the communications.

System action:

The Deployment Manager process continues. Events will be logged locally
on the client machine only.

User response:

Check network connection and the error log on the client computer.

------------------------------------------------------------------------
ANS4242E

The setup script encountered a warning or error while retrieving the
client package for the architecture architecture. The error level is
error level error level.



Explanation:

It is possible that the client package is not available on the server.

System action:

Processing stops.

User response:

Ensure that client packages for all architectures are available on the
server. Check the backup-archive client error log for more detailed
error messages.

------------------------------------------------------------------------
ANS4248E

The client is already at the target level: target version.



Explanation:

Processing stopped because the automatic client deployment feature does
not support the installation of a client to a workstation that is
already at its target level.

System action:

Your current backup-archive client is not affected.

User response:

Refer to the Backup-Archive Client documentation in the information
center.

Reschedule the client deployment with an appropriate target level.

------------------------------------------------------------------------
ANS4251W

writername file 'filename': not found.



Explanation:

The indicated VSS writer file or directory was returned by VSS as part
of the backup file list of the writer. However, the object does not
exist on the disk..

System action:

Processing stops if SKIPMISSINGSYSWFILES option is set to NO. Processing
continues if SKIPMISSINGSYSWFILES option is set to YES.

User response:

Verify that this file can be skipped during system state backup.

------------------------------------------------------------------------
ANS4252W

architecture, schedule-name, domain-name : The client deployment was not
completed pending the restart of the client computer. The deployment
manager did not restart the client computer automatically because the
AUTODEPLOY option was set to NOREBOOT.



Explanation:

The previous client has been uninstalled, and the installation of the
new client was not completed pending the restart of the client computer.
The architecture of the client, schedule name, and domain name are
identified at the beginning of the message text.

System action:

The Deployment Manager process completes.

User response:

Manually restart the client computer as soon as possible.

------------------------------------------------------------------------
ANS4253E

There was not enough disk space on the client computer. Required space:
package space bytes; available space: system space bytes.



Explanation:

The deployment manager determined there was insufficient free disk space
for the client deployment.

System action:

Processing stops.

User response:

Free up required disk space and reschedule the client deployment.

------------------------------------------------------------------------
ANS4254E

The deployment manager detected an HSM client on the workstation that it
needs to deploy the Backup-Archive client to.



Explanation:

An attempt was made to deploy the Backup-Archive client to a workstation
that already has the HSM client installed. The Backup-Archive client
cannot be deployed to a workstation that has the HSM client.

System action:

Processing stops.

User response:

Uninstall the HSM client and reschedule the Backup-Archive client
deployment.

------------------------------------------------------------------------
ANS4255E

There is not enough memory for the deployment manager to create the
system information object



Explanation:

The system information object could not be created because there is not
enough available RAM to temporarily write the data into.

System action:

Processing stops.

User response:

Close all unneeded applications on the client workstation and reschedule
the deployment.

------------------------------------------------------------------------
ANS4256E

The DSMI_DIR environment variable is not defined.



Explanation:

The deployment manager cannot initiate a connection to the server
because the DSMI_DIR environment variable is not set. This error can
occur if the deployment manager is started without using the client
scheduler.

System action:

Processing stops.

User response:

Read the available documentation to determine how to use the client
scheduler to create a client deployment task.

------------------------------------------------------------------------
ANS4257E

The deployment manager cannot parse information in file: file name.



Explanation:

The deployment manager could not parse or extract the required
information from the specified file.

System action:

Processing stops.

User response:

Check the error log file on the client workstation.

------------------------------------------------------------------------
ANS4258E

The deployment manager received the Windows "OpenSCManager failed" error
message.



Explanation:

The deployment manager could not connect to the Windows service control
manager to start the client scheduler. In general, this error occurs
because the user who is initiating the task does not have sufficient
authority.

System action:

Processing stops.

User response:

Ensure that the user who starts the client scheduler has administrative
privileges.

------------------------------------------------------------------------
ANS4259E

The client scheduler is not started as a root user.



Explanation:

The client scheduler requires root user privileges to upgrade the client
code.

System action:

Processing stops.

User response:

Log in as root and start the client scheduler.

------------------------------------------------------------------------
ANS4260E

The installation file system is not writeable.



Explanation:

The deployment manager cannot write to the installation file system.

System action:

Processing stops.

User response:

Check the installation file system permissions. It is possible that the
current client node runs in a virtualized environment using the client
code installed in a shared storage of the physical environment.
Reschedule the client deployment with the client node in the physical
environment.

------------------------------------------------------------------------
ANS4261E

The deployment manager cannot upgrade the Backup-Archive Client.



Explanation:

The Backup-Archive Client cannot be upgraded because either the current
location is not the default installation location or the DSM_DIR,
DSMI_DIR, DSM_CONFIG and DSMI_CONFIG environment variables are defined
with a relative path and not an absolute path.

System action:

Processing stops.

User response:

Check the installation directory of the current Backup-Archive Client.
If the Backup-Archive Client is not installed in the default location,
manually upgrade the Backup-Archive Client. If the DSM_DIR, DSMI_DIR,
DSM_CONFIG and DSMI_CONFIG environment variables are defined with a
relative path, define them with an absolute path and try the client
deployment again.

------------------------------------------------------------------------
ANS4262E

The preview of the client installation failed.



Explanation:

The deployment manager did not uninstall the current client. The client
code is unchanged.

System action:

Processing stops.

User response:

Check the deployment manager log and trace files on the client
workstation for specific issues identified during the preview.
Reschedule a deployment after any issues are resolved.

------------------------------------------------------------------------
ANS4263E

The deployment manager failed to uninstall the backup-archive client.



Explanation:

The deployment manager received an error while uninstalling the current
client.

System action:

Processing stops.

User response:

Check the deployment manager log and trace files on the client
workstation for more details on the error. You might have to manually
uninstall the client.

------------------------------------------------------------------------
ANS4264E

The deployment manager failed to install the backup-archive client.



Explanation:

The current client was uninstalled and the deployment manager received
an error while installing the new client code.

System action:

Processing stops.

User response:

Check the deployment manager log and trace files on the client
workstation for more details on the error. Manully install the new
client after the issue is resolved.

------------------------------------------------------------------------
ANS4265I

Client deployment options are not specified in the scheduler command or
from client services.



Explanation:

The default client options file will be used. The deployment manager
might not report the correct server and node information when reporting
status.

System action:

Processing continues.

User response:

Avoid initiating the client deployment directly from the command-line,
instead, always start the client scheduler as a Windows service.

------------------------------------------------------------------------
ANS4266I

The deployment manager failed to install non-English language pack(s).



Explanation:

The previous packages were uninstalled, and the installation of one or
more new language packs were not successful.

System action:

Processing continues.

User response:

Check the deployment trace file on the client workstation for specific
language pack information.

------------------------------------------------------------------------
ANS4267I

The deployment manager failed to install the hardware plugin package.



Explanation:

The previous package was uninstalled. The installation of the new
hardware plugin package failed.

System action:

Processing stops.

User response:

Check the deployment trace file on the client workstation.

------------------------------------------------------------------------
ANS4268I

The deployment manager failed to install the journal-based backup
package.



Explanation:

The previous journal-based backup package was uninstalled. The new
journal based backup package installation failed.

System action:

Processing stops.

User response:

Check the deployment trace file on the client workstation.

------------------------------------------------------------------------
ANS4269W

The deployment manager is stopping the scheduler or the CAD processes.



Explanation:

Before deploying the new client, the deployment manager must stop the
scheduler and CAD processes. After the deployment, the processes must be
restarted.

System action:

Processing continues.

User response:

The client scheduler is interrupted during the deployment.

------------------------------------------------------------------------
ANS4270I

The deployment manager and the new client installation packages were
downloaded to directory: file name.



Explanation:

The download directory contains everything required to complete the new
client deployment. Deployment log and trace files can be found in the
log/ sub-directory.

System action:

Processing continues.

User response:

Obtain log and trace files from the download directory for problem
determination. The files are found within the log/ sub-directory.

------------------------------------------------------------------------
ANS4271E

The deployment package is missing one or more required installation
image files.



Explanation:

The client deployment package might not have been imported correctly to
the server. It is possible that the deployment package is not retrieved
completely to the client computer, due to a lack of disk space.

System action:

Processing stops.

User response:

Ensure that client packages are available on the server and there is
sufficient disk space on the client computer. Check the backup-archive
client error log file for more detailed error messages.

------------------------------------------------------------------------
ANS4272E

The processor type of the package: package processor type does not match
the current client: system processor type..



Explanation:

The processor type supported by the client package that you want to
deploy does not match the processor type of the workstation that you are
trying to deploy the client to. It is not always possible for the
deployment manager to connect to the server and report the error.

System action:

Processing stops.

User response:

Verify that you are using the correct client package for the processor
architecture of the computer that you want to upgrade. Then restart the
deployment.

------------------------------------------------------------------------
ANS4273E

The deployment manager detected a journal based backup (JBB) client on
the workstation where it needs to deploy the Backup-Archive Client.



Explanation:

An attempt was made to deploy the Backup-Archive Client to a workstation
that already has the JBB client installed. On some platforms, the
Backup-Archive Client cannot be deployed to a workstation that has the
JBB client installed.

System action:

Processing stops.

User response:

Uninstall the JBB client and reschedule the Backup-Archive Client
deployment.

------------------------------------------------------------------------
ANS4274E

The deployment manager cannot stop the scheduler or the CAD processes.



Explanation:

The deployment manager tried to shut down the Backup-Archive Client
scheduler or CAD processes but the Backup-Archive Client might be busy
with other tasks.

System action:

Processing stops.

User response:

Reschedule the Backup-Archive Client deployment.

------------------------------------------------------------------------
ANS4275E

The deployment manager cannot restart the scheduler or the CAD
processes.



Explanation:

Before exiting, the deployment manager could not restart the
Backup-Archive Client scheduler or CAD processes. The deployment manager
stopped the processes prior to the client upgrade.

System action:

Processing continues.

User response:

Log on to the Backup-Archive Client workstation and check the error log
file. If you have set environment variables make sure they are not
defined using relative path.

------------------------------------------------------------------------
ANS4276E

The deployment manager cannot obtain information about the scheduler or
the CAD processes.



Explanation:

The deployment manager needs process information in order to stop and
restart the Backup-Archive Client scheduler or CAD processes.

System action:

Processing stops.

User response:

Log on to the Backup-Archive Client workstation and check the error log
file and the deployment manager error log file.

------------------------------------------------------------------------
ANS4277E

The target operating system version target operating system does not
meet the minimum required version minimum required version



Explanation:

The operating system version is earlier than the version required by the
automatic deployment package.

System action:

The deployment is canceled.

User response:

Ensure that the version being deployed is supported by the target
operating system.

------------------------------------------------------------------------
ANS4278E

The deployment manager cannot obtain information about the Logical
Volume Snapshot Agent (LVSA).



Explanation:

The deployment manager needs to determine whether an LVSA is installed
on the client workstation.

System action:

Processing stops.

User response:

Log on to the Backup-Archive Client workstation and check the error log
file and the deployment manager error log file.

------------------------------------------------------------------------
ANS4280E

Automatic client deployment is not allowed on the client workstation.



Explanation:

One or more of the running client services include AUTODEPLOY = NO in
the option file.

System action:

Processing stops.

User response:

Change the AUTODEPLOY option on the client and reschedule the client
deployment.

------------------------------------------------------------------------
ANS4281E

The update manager cannot remove the TIVsmCapi package from non-global
zone(s): zone name.



Explanation:

APAR IC57433 prevents the removal of the TIVsmCapi package on Solaris on
a sparse-root, non-global zone if uninstalling is done from the global
zone.

System action:

Processing stops.

User response:

Manually uninstall the IBM Spectrum Protect client directly from the
non-global zones and reschedule the deployment.

------------------------------------------------------------------------
ANS4282E

Sparse-root non-global zone(s) were found with IBM Spectrum Protect
Backup-Archive Client that was installed from the non-global zone: zone
names.



Explanation:

One or more non-global zones are sharing the /usr file system with the
global zone. The IBM Spectrum Protect Backup-Archive Client is installed
in the global zone with the -G parameter and also installed manually in
the non-global zone(s). You cannot update the IBM Spectrum Protect
Backup-Archive Client in the global zone because it will update the
version of GSKit that is shared with the sparse-root non-global zones
that are not part of the automatic deployment.

System action:

Processing stops.

User response:

Manually upgrade the Backup-Archive Client or install it from the global
zone without using the -G parameter. This ensures that you have the same
version between the global zone and the sparse-root non-global zones,
and you can then deploy the client automatically on all such zones.

------------------------------------------------------------------------
ANS4283E

There is not enough disk space on path to uncompress GSKit packages.
Required space: req_space bytes; available space: avail_space bytes.



Explanation:

The deployment manager determined that there is not enough free disk
space to uncompress GSKit packages.

System action:

Processing stops.

User response:

Free up the required amount of disk space and reschedule the automatic
client deployment.

------------------------------------------------------------------------
ANS4284E

The deployment is cancelled because an automatic client deployment task
was scheduled for a sparse-root, non-global zone that shares the /usr
file system with the global zone.



Explanation:

The automatic client deployment task that was attempted is not supported
and will be cancelled.

System action:

Processing stops.

User response:

Install the Backup-Archive Client from the global zone or manually
upgrade the Backup-Archive Client.

------------------------------------------------------------------------
ANS4285E

The update restore operation to an existing virtual machine 'VmName'
failed. The virtual machine is not in power off state.



Explanation:

The update restore operation to an existing virtual machine is not
supported for a running machine and will be aborted.

System action:

Restore aborted.

User response:

Turn off the virtual machine and re-run the update restore command.

------------------------------------------------------------------------
ANS4290E

Only one virtual machine can be selected for restore.



Explanation:

Restoring multiple virtual machines is not allowed. Only one virtual
machine can be selected for restore.

System action:

No processing occurs.

User response:

Select only one virtual machine for restore.

------------------------------------------------------------------------
ANS4291E

Virtual Machine could not be found on VMware server.



Explanation:

The backup of virtual machine failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4292E

No virtual machine found.



Explanation:

No virtual machine found with name or specified in domain option.

System action:

Processing stopped.

User response:

Specify a correct VM name or domain option.

------------------------------------------------------------------------
ANS4293E

Backup of VMware vApp 'vApp name' in Organization VDC 'Org VDC name' of
organization 'Org name' failed.



Explanation:

The vApp backup operation failed. This error message is a summary
message and does not contain detailed information.

System action:

The configuration information and VMs for the specified vApps are not
backed up. Processing continues to the next vApp.

User response:

Check the previous messages in the dsmerror.log file for more details
about this vApp .

------------------------------------------------------------------------
ANS4295W

The virtual machine 'vmname' was backed up using the Windows VSS system
provider. You must manually revert or delete the shadow copy on the
restored volumes or you may experience degraded performance and an
out-of-space condition.



Explanation:

At backup time, application protection was not able to back up the VM
within the 10-second VSS limit. Therefore, the Windows VSS system
provider was used. If you are restoring the application, the volume will
be automatically reverted. However, if you are restoring the entire VM,
you must manually revert or delete the shadow copy.

System action:

The virtual machine is restored, including the system provider shadow
copy.

User response:

Verify that the restore was successful, and the data is not corrupt. If
the data is not corrupt, you can delete the shadow copy. However, if the
data is corrupt, revert the shadow copy to restore data integrity. You
can figure out which shadow copy to delete or revert by looking for the
dsmShadowCopyID.txt file in the root directory of each restored volume.
Then, use the diskshadow delete or revert command.

------------------------------------------------------------------------
ANS4296I

architecture, schedule-name, domain-name: The Deployment Manager process
was started successfully. Deployment Manager Version Information:
version



Explanation:

The Deployment Manager process was started as a post schedule command.
This is the first message from the Deployment Manager. The architecture
of the client, schedule name, and domain name are identified at the
beginning of the message text.

System action:

Deployment Manager continues to process.

User response:

None

------------------------------------------------------------------------
ANS4297W

architecture, schedule-name, domain-name: Client deployment was
completed with warnings:



Explanation:

This is a generic warning message. It is possible the other messages
provide details of the deployment. The architecture of the client,
schedule name, and domain name are identified at the beginning of the
message text.

System action:

The Deployment Manager process completes.

User response:

Check the warning messages from the server administration center, the
server activity log, or error log on the client computer for more
information.

------------------------------------------------------------------------
ANS4298E

architecture, schedule, new_device_type: The client deployment was
cancelled. The previous event causing the cancellation is:



Explanation:

This is a generic message that the client deployment was cancelled. The
Deployment Manager does not uninstall or update the current client. It
is possible the other messages provide details of the deployment. The
architecture of the client, schedule name, and domain name are
identified at the beginning of the message text.

System action:

Processing stops.

User response:

Check the warning messages from the server administration center, the
server activity log, or error log on the client computer for more
information.

------------------------------------------------------------------------
ANS4299E

architecture, schedule-name, domain-name: The client deployment failed.
The previous event causing the failure is: event



Explanation:

This is a generic message that the client deployment failed. It is
possible that other messages provide details of the failure. The
architecture of the client, schedule name, and domain name are
identified at the beginning of the message text.

System action:

Processing stops.

User response:

Check the warning messages from the server administration center, the
server activity log, or error log on the client computer for more
information.

------------------------------------------------------------------------
ANS4300I

architecture, schedule-name, domain-name: Client deployment was
completed successfully.



Explanation:

The Deployment Manager process completes.

System action:

Processing stops.

User response:

None

------------------------------------------------------------------------
ANS4301I

IBM Spectrum Protect detected Microsoft Active Directory Domain
Controller on virtual machine 'VM'.



Explanation:

The virtual machine contains Microsoft Active Directory Domain
Controller.

System action:

IBM Spectrum Protect saved additional information about this virtual
machine.

User response:

None

------------------------------------------------------------------------
ANS4302W

IBM Spectrum Protect failed to detect if Microsoft Active Directory
Domain Controller on virtual machine 'VM'.



Explanation:

There was an error while checking if the virtual machine contains
Microsoft Active Directory Domain Controller.

System action:

IBM Spectrum Protect continues backing up this virtual machine.

User response:

Check IBM Spectrum Protect error log for additional information.

------------------------------------------------------------------------
ANS4303E

The vCloud Director vApp 'vapp-name' has not been previously backed up.



Explanation:

The specified vCloud Director vApp has not been previously backed up, so
can not be specified for restore.

System action:

The specified vCloud Director vApp is skipped, and the next vApp in the
restore list is processed.

User response:

Verify the vCloud Director vApp name to be restored, and re-try the
operation.

------------------------------------------------------------------------
ANS4304I

IBM Spectrum Protect could not detect the IBM Spectrum Protect for
Virtual Environments license. Active Directory Domain Controller will
not be protected on VM 'VM'.



Explanation:

The virtual machine contains Microsoft Active Directory Domain
Controller, but a IBM Spectrum Protect for Virtual Environments license
is not detected. The Domain Controller will not be protected.

System action:

Install IBM Spectrum Protect for Virtual Environments 7.1 or later to
protect Active Directory.

User response:

None

------------------------------------------------------------------------
ANS4305W

Backup of VMware vApp 'vApp name' in Organization VDC 'Org VDC name' of
organization 'Org name' completed. Some VMs were not backed up. mode:
'Incremental Forever - full_or_incr' target node name:
'target_node_name' data mover node name: 'data_mover_node_name' VMs
backup status: number of VM backed up out of number of VMs in vApp VMs
backed up successfully.



Explanation:

The vApp backup operation completed successfully. However, one or more
VMs for the specified vApp were not backed up. These VMs will not be
created during the restore operation.

System action:

Processing continues to the next vApp.

User response:

Check the dsmerror.log file for this vApp for more information about
this message. Resolve the problem, then try the operation again.

------------------------------------------------------------------------
ANS4308E

Full VM backup of 'hypervisor' Virtual Machine 'vmname' failed with
RC=rc mode=full_or_incr, target node name='target_node_name', data mover
node name='data_mover_node_name'



Explanation:

The Full VM backup of virtual machine failed.

System action:

The full backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4311E

Full VM restore of 'hypervisor' Virtual Machine 'vmname' failed with
RC=rc target node name='target_node_name', data mover node
name='data_mover_node_name'



Explanation:

The Full VM restore of the virtual machine failed.

System action:

The full restore of the the virtual machine finished with failures. The
next virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4313I

Rebalance Schedule sched-name Type: balance-type



Explanation:

A rebalance operation was requested for the named schedule. A rebalance
can be complete or minimal. A Minimal rebalance is performed
automatically at the end of each schedule. You can configure a complete
rebalance by using the option settings, VMREBALANCESCHEDULEPERIOD and
VMREBALANCESCHEDULEONLY.

System action:

The rebalance operation begins.

User response:

No action is required.

------------------------------------------------------------------------
ANS4319E

Rebalance schedule error occurred while processing the timestamp file.



Explanation:

An error occurred while a tagged schedule was processing a local
timestamp file. The timestamp file will be recreated after the next
schedule is run.

System action:

The schedule completed.

User response:

The timestamp file name is based on the schedule name. It has the format
"rebalance_timestamp_schedulename.file" Deleting the file may help. The
timestamp file will be recreated after the next schedule is run.

------------------------------------------------------------------------
ANS4441E

'fs' is a 'fstype' file system, which is not a supported file system
type for file backup, image backup or archive.



Explanation:

The specified file system is not supported for any type of backup. IBM
Spectrum Protect does not support backup and archive or image backup for
this type of volume.

System action:

The file system is skipped. Processing continues with the next file
system.

User response:

Refer to the IBM Spectrum Protect client manual for a complete list of
supported file systems.

------------------------------------------------------------------------
ANS4442E

'VM-Name' a backup cannot be created because the virtual machine has
assigned disk with duplicate disk identifiers.



Explanation:

The client detected that the virtual machine has assigned disk with
duplicate disk identifiers. The disk may have been copied. A backup
cannot be created on a virtual machine that have duplicate disk
identifiers.

System action:

The virtual machine is not backuped. Processing continues with the next
virtual machine.

User response:

Check that the virtual disks has diffrent disk identifiers and update
the virtual machine configuration to match any changes to the file
system. If the problem persists, contact an administrator of the Hyper-V
server.

------------------------------------------------------------------------
ANS4443E

'fs' is a CSVFS file system, which is not a supported file system type
for file backup, image backup or archive.



Explanation:

Microsoft Cluster Shared Volumes File Systems (CSVFS) are NTFS or ReFS
volumes that are added to Cluster Shared Volumes. These volumes are
intended for Hyper-V and expanded support for SQL, not for regular file
data. IBM Spectrum Protect does not support file level backup and
archive or image backup for CSVFS volumes.

System action:

The file system is skipped. Processing continues with the next file
system.

User response:

Refer to the IBM Spectrum Protect client manual for a complete list of
supported file systems.

------------------------------------------------------------------------
ANS4446E

A file restore mount operation for hypervisor type Virtual Machine
'vmname' failed. The data center node name is 'data center node name',
the mount proxy node name is 'mount proxy node name'.



Explanation:

The file restore mount operation of the virtual machine failed.

System action:

The mount of the virtual machine finished with failures.

User response:

Review the local client error log for the reason for the failure.

------------------------------------------------------------------------
ANS4449E

A cleanup of the file restore mount of hypervisor type Virtual Machine
'vmname' failed. The data center node name is 'data center node name',
the mount proxy node name is 'mount proxy node name'.



Explanation:

The cleanup of file restore mount operation of the virtual machine
failed.

System action:

The cleanup of mount of the virtual machine finished with failures.

User response:

Review the local client error log for the reason for the failure.

------------------------------------------------------------------------
ANS4450E

The mount proxy platform is not supported for file restore mount
operations.



Explanation:

The file restore mount operation failed. The mount proxy platform is
unsupported or the IBM Spectrum Protect Recovery Agent is not correctly
installed and configured.

System action:

The file restore mount operation failed.

User response:

Ensure that the IBM Spectrum Protect Recovery Agent is installed and
configured correctly and run the file restore mount operation from a
supported mount proxy platform.

------------------------------------------------------------------------
ANS4451E

The Windows iSCSI service is not available.



Explanation:

The Windows iSCSI service is not available on the mount proxy machine.
It is either not started or is not installed or configured correctly.

System action:

Processing stops. The file restore mount operation fails.

User response:

Ensure that the iSCSI service is up and running on the mount proxy
machine.

------------------------------------------------------------------------
ANS4900W

Schedule 'schedule-name' has opened a new session with the server.



Explanation:

A scheduled event endsbecause of a connection failure. The scheduled
event had to be restarted outside its normal startup window to continue
the operation.

System action:

The scheduled event is completed using more than one session.

User response:

None required. If this is a recurrent condition, you may want to check
for network problems.

------------------------------------------------------------------------
ANS4901E

The following object contains one or more unmatched quotation marks and
cannot be processed: 'filespace path filename'.



Explanation:

The file name in the file list contains unmatched quotes. If a line in
the file list begins with a single or double quotation mark this
quotation mark is considered to be an opening quotation mark. The
corresponding closing quotation mark of the same type must be at the end
of the line. If there is no closing quotation mark or the closing
quotation mark has been encountered in the middle of the line, it is an
invalid input.

System action:

The object is skipped.

User response:

Correct the specification of the object.

------------------------------------------------------------------------
ANS4904E

The instant access operation for the 'vmname' virtual machine failed.
The target node is 'target_node_name and the data mover node is
'data_mover_node_name'.



Explanation:

The instant access operation for the virtual machine failed.

System action:

Errors occurred and the instant access operation did not complete.

User response:

See the client error log to determine the cause of the failure.

------------------------------------------------------------------------
ANS4907E

Instant restore of VMware Virtual Machine 'vmname' failed. target node
name='target_node_name', data mover node name='data_mover_node_name'



Explanation:

The instant restore of the virtual machine failed.

System action:

The instant restore of the the virtual machine finished with failures.
The reason for the failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS4910E

The cleanup operation for the 'vmname' virtual machine failed. The
target node is 'target_node_name' and the data mover node is
'data_mover_node_name'.



Explanation:

The cleanup operation for the virtual machine failed.

System action:

Errors occurred and the cleanup operation did not complete.

User response:

See the client error log to determine the cause of the failure.

------------------------------------------------------------------------
ANS4915I

Object increased in size during compression: filespace pathfilename



Explanation:

The file increased in size during compression.

System action:

Processing contiues.

User response:

None.

------------------------------------------------------------------------
ANS4917E

A failure occurred while accessing the VMware libraries. The required
files for the virtual machine backup were not found. The files are
installed only if the client is defined as a data mover in IBM Spectrum
Protect for Virtual Environments.



Explanation:

A failure occurred while accessing the VMware libraries for the virtual
machine environment.

System action:

The backup operation cannot continue.

User response:

Install the IBM Spectrum Protect for Virtual Environments package to use
the client to back up virtual machines.

------------------------------------------------------------------------
ANS4936E

The snapshot of virtual machine 'vmname' failed and a snapshot cannot be
attempted again.



Explanation:

The snapshot of the virtual machine failed with a permanent error. Such
as the Hyper-V writer is not responding. Another snapshot attempt will
not be made.

System action:

The snapshot of the virtual machine finished with an error. Processing
continues to the next virtual machine.

User response:

Check the Windows event log for the reason for the failure.

------------------------------------------------------------------------
ANS4937I

Resending file file in a new transaction session to recover from the
transmission error.



Explanation:

None.

System action:

The file is resent.

User response:

None.

------------------------------------------------------------------------
ANS4938I

Virtual machine: 'vm-name' disk: 'disk-name' is excluded by size.



Explanation:

The option file or command given excluded the disk from backup
processing.

System action:

The disk is not processed.

User response:

If the disk is intentionally excluded, then this message is expected
behavior. Otherwise modify the command or option file to include the
disk.

------------------------------------------------------------------------
ANS4942E

The file specification 'string' is invalid.



Explanation:

The operating system indicated that the file specification is invalid.
One possible reason is that the file specification contains unrecognized
characters. Another possible cause is incorrect use of quotation marks
in the file specification.

System action:

Processing stopped.

User response:

Enter a correct file specification as described in the Using the
Backup-Archive Client book for the particular operating system. Ensure
that the file specification contains valid characters. Verify correct
use of quotation marks for specifications that contain blanks spaces. If
multiple file specifications are used, make sure that any use of
quotation marks does not cause the file specifications to be treated as
a single file specification.

------------------------------------------------------------------------
ANS4944I

Virtual machine: 'vm-name' disk: 'disk-name' is excluded by user.



Explanation:

The option file or command given excluded the disk from backup
processing.

System action:

The disk is not processed.

User response:

If the disk is intentionally excluded, then this message is expected
behavior. Otherwise modify the command or option file to include the
disk.

------------------------------------------------------------------------
ANS4946W

Warning: virtual machine: 'vm-name' disk: 'disk-name' excluded by user,
was not found.



Explanation:

The specified virtual disk does not exist on the virtual machine.

System action:

Processing continues.

User response:

Use the "dsmc backup vm ..." command with the -preview option to display
a listing of the disk labels which exist on the virtual machine. Since
the disk was specified to be excluded from the backup, the backup will
continue. However it is possible that a disk will included in the backup
which was not desired, check the spelling of the disk label, and correct
the disk label if an undesired disk is now included in the backup
operation.

------------------------------------------------------------------------
ANS4947E

Error: virtual machine: 'vm-name' disk: 'disk-name' included by user,
was not found.



Explanation:

The specified virtual disk does not exist on the virtual machine.

System action:

Processing stops.

User response:

Use the "dsmc backup vm ..." command with the -preview option to display
a listing of the disk labels which exist on the virtual machine. Check
the spelling of the disk label and correct the disk label and then retry
the 'backup vm' operation.

------------------------------------------------------------------------
ANS4948E

A specified virtual disk was not found on the virtual machine.



Explanation:

You must specify a virtual disk label name which exists on the virtual
machine.

System action:

Processing stops.

User response:

For a backup operation, use the "dsmc backup vm ..." command with the
-preview option to display a listing of the disk labels which exist on
the virtual machine. For a restore operation, use the "dsmc query vm
..." command with the -detail option to display a listing of the disk
labels which exist on the virtual machine backup. Check the spelling of
the disk label and correct the disk label and then retry the operation.

------------------------------------------------------------------------
ANS4972W

File server file-server-name has been upgraded to Data ONTAP version
'version.modifcation.submodification'. This version does not support
unicode file names for snapshot difference incremental backup. Upgrade
to a version that supports unicode file names as soon as possible.



Explanation:

The file server has been upgraded from a version that supports unicode
file names for incremental backup using snapshot difference to a version
that does not. If you have upgraded from Data ONTAP version 7.3.3 (or
later) to 8.0, you lose the ability to back up files with unicode file
names when performing snapshot difference incremental backup.

System action:

Processing continues. However, files with unicode names are not backed
up.

User response:

Upgrade to a version that supports unicode file names as soon as
possible. If you have upgraded from Data ONTAP version 7.3.3 (or later)
to 8.0, upgrade to 8.1 (or later). If it is not possible to upgrade at
this time, you can suppress this warning message by renaming the file
space on the IBM Spectrum Protect server and performing a snapshot
difference incremental backup.

------------------------------------------------------------------------
ANS4973E

An error occurred accessing NTFS security information for file
'filespace namepath-namefile-name'



Explanation:

An access denied error occurred while attempting to access NTFS security
info rmation.

System action:

The object is skipped.

User response:

See your system administrator or bypass the failing check by using
SkipNTSecu rity option.

------------------------------------------------------------------------
ANS4974E

Error processing 'filespace namepath-namefile-name': a required NT
privilege is not held.



Explanation:

The user account running IBM Spectrum Protect does not possess a
required NT user right/pr ivilege for performing the current operation.

System action:

The object is skipped.

User response:

Your system administrator has the authority to grant the needed
privilege.

------------------------------------------------------------------------
ANS4987E

Error processing 'filespace namepath-namefile-name': the object is in
use by another process



Explanation:

The specified file is being used by another process. You tried to read
from or write to a file that is currently being used by another process.

System action:

File skipped.

User response:

Ensure that the file is not locked by another process. If the file is
not locked, retry the command.

------------------------------------------------------------------------
ANS4988W

File 'filespace namepath-namefile-name' is currently unavailable on
server and has been skipped.



Explanation:

You tried to restore or retrieve a file that is currently not available
from the IBM Spectrum Protect server. This is most likely a temporary
condition.

System action:

IBM Spectrum Protect cannot restore or retrieve the file.

User response:

Try to restore or retrieve the file again after the file becomes
available on the server. If the problem persists, see your IBM Spectrum
Protect administrator for assistance.

------------------------------------------------------------------------
ANS4989E

Error processing 'filespace namepath-namefile-name': the directory is in
use by another process. All objects in the directory and any of its
subdirectories are skipped.



Explanation:

The specified directory is being used by another process. You tried to
read from or write to a directory that is currently being used by
another process. The objects contained in the directory and its
subdirectories are not backed up.

System action:

Processing stopped for that directory. If other files and directories
were also specified in this backup, they are processed

User response:

Ensure that you specified the correct directory name, correct the
permissions, or specify a new location.If the directory name is correct,
retry the backup when no process has exclusive use of the directory.

------------------------------------------------------------------------
ANS4991I

Application Type Application Message Id Application Message



Explanation:

This is a message sent by the application you are currently running with
IBM Spectrum Protect.

System action:

IBM Spectrum Protect logs the application message.

User response:

Refer to the documentation for the application that you are using.

------------------------------------------------------------------------
ANS4992W

Application Type Application Message Id Application Message



Explanation:

This is a message sent by the application you are currently running with
IBM Spectrum Protect.

System action:

IBM Spectrum Protect logs the application message.

User response:

Refer to the documentation for the application that you are using.

------------------------------------------------------------------------
ANS4993E

Application Type Application Message Id Application Message



Explanation:

This is a message sent by the application you are currently running with
IBM Spectrum Protect.

System action:

IBM Spectrum Protect logs the application message.

User response:

Refer to the documentation for the application that you are using.

------------------------------------------------------------------------
ANS4994S

Application Type Application Message Id Application Message



Explanation:

This is a message sent by the application you are currently running with
IBM Spectrum Protect.

System action:

IBM Spectrum Protect logs the application message.

User response:

Refer to the documentation for the application that you are using.

------------------------------------------------------------------------
ANS4997E

Error processing 'filespace namepath-namefile-name': file system quota
reached condition - no space left.



Explanation:

No more files can be restored or retrieved because the quota of the
destination file system has been reached.

System action:

The client prompts you for action:

*  Retry this object

*  Skip this object

*  Abort the action

User response:

Select the appropriate action for this object. Create some free space or
increase the quota on the destination file system before you retry the
operation. Another option is to restore or retrieve the file to another
file system.

------------------------------------------------------------------------
ANS4998E

Link information for file 'filename' could not be obtained: access to
the object is denied.



Explanation:

Access to the specified file link is denied. You tried to read
information for file link and you do not have access permission for this
object.

System action:

Processing of System State stops.

User response:

Try the operation again. If the problem persists, contact IBM technical
support for additional assistance.

------------------------------------------------------------------------
ANS4999I

The following message was too long to log to the server: 'shortened
message with message number'



Explanation:

The message text and inserts are too large to send to the server in the
available internal buffer.

System action:

The message number message is written to the local client error log,
then shortened and sent to the server as a part of this message. The
message is reduced in length by substituting '...' in the middle of the
original message.

User response:

The message referred to has been shortened, but describes the error that
occurred. See the documentation for that message for more information.

------------------------------------------------------------------------
ANS5003S

The management class assigned to directories does not exist.



Explanation:

The management class named on the DIRMC option does not exist in your
assigned policy set on the server. The error log contains an entry
showing the invalid management class name.

System action:

processing stops.

User response:

Remove the current DIRMC option from the client options file, then run
DSMC QUERY MGMTCLASS -DETAIL to view information about available
management classes. Make sure the management class you select has a
backup copy group. If you have more than one IBM Spectrum Protect
server, make sure you are connecting to the correct server. If you are
unable to find a suitable management class, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS5004S

There is no backup copy group in the management class used for
directories. See the error log.



Explanation:

The DIRMC option names a management class that contains no backup copy
group.

System action:

processing stops.

User response:

Remove the current DIRMC option from the client options file, then run
DSMC QUERY MGMTCLASS -DETAIL to view information about available
management classes. Make sure the management class you select has a
backup copy group. If you have more than one IBM Spectrum Protect
server, make sure you are connecting to the correct server. If you are
unable to find a suitable management class, contact your IBM Spectrum
Protect administrator for further assistance.

------------------------------------------------------------------------
ANS5006W

The policy set does not contain any backup copy groups. The process is
unable to continue the backup.



Explanation:

You tried to back up the files using a policy set that contained no
backup management information.

System action:

The process did not back up the files.

User response:

See your IBM Spectrum Protect administrator for assistance in
associating your node with a policy set containing a management class
that has a backup copy group. Then try the operation again.

------------------------------------------------------------------------
ANS5007W

The policy set does not contain any archive copy groups. IBM Spectrum
Protect is unable to continue the archive.



Explanation:

You tried to archive the files using a policy set that contains no
archive management information.

System action:

IBM Spectrum Protect did not archive the files.

User response:

See your IBM Spectrum Protect administrator for assistance in
associating your node with a policy set containing a management class
that has an archive copy group. Then try the operation again.

------------------------------------------------------------------------
ANS5008W

Incorrect password entered



Explanation:

You entered a password that was incorrect.

System action:

IBM Spectrum Protect cannot connect to the server without the correct
password.

User response:

Reenter the password, or ask your system administrator for the current
password.

------------------------------------------------------------------------
ANS5009W

New password entries are not the same



Explanation:

During the change password, update password, or open registration
dialog, the two entries for the new password were not the same.

System action:

The password was not changed on the server.

User response:

Backspace over both of the new passwords and reenter them, ensuring that
they match.

------------------------------------------------------------------------
ANS5011I

Backup stopped by user



Explanation:

You requested to stop the backup operation.

System action:

Backup stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5012E

Server out of backup data storage space



Explanation:

The server ran out of space in its backup data storage.

System action:

IBM Spectrum Protect cannot complete the requested backup operation. Any
files displayed on the lower half of the backup activity panel were
successfully backed up.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS5013E

Not enough memory for backup operation



Explanation:

IBM Spectrum Protect cannot allocate memory for the specified backup
operation.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Close all unneeded applications and retry the operation. Reducing the
scope of queries and the amount of data returned might also help, or see
your system administrator.

------------------------------------------------------------------------
ANS5014I

Backup completed



Explanation:

The backup was completed.

System action:

IBM Spectrum Protect backed up the files.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5015I

Restore stopped by user



Explanation:

You requested to stop the restore operation.

Attention: If you were restoring files with "overwrite" option
specified, the file you restored last can be damaged (partially
overwritten).

System action:

Restore stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5016E

Not enough memory for the requested restore operation.



Explanation:

Not enough memory is available for the requested restore operation.

System action:

Processing stops.

User response:

Close all unneeded applications and retry the operation. Reducing the
scope of queries and the amount of data returned can also help, or see
your system administrator.

------------------------------------------------------------------------
ANS5017I

Restore completed



Explanation:

A restore was completed.

System action:

IBM Spectrum Protect restored the files.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5018E

Not enough memory for archive operation



Explanation:

The client cannot allocate memory for the requested archive operation.

System action:

Processing stops.

User response:

Close all unneeded applications and retry the operation. Reducing the
scope of queries and the amount of data returned might also help, or see
your system administrator.

------------------------------------------------------------------------
ANS5019I

Archive stopped by user



Explanation:

You requested to stop the archive operation.

System action:

Archive stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5020E

The IBM Spectrum Protect server is out of archive data storage space.



Explanation:

The server ran out of space in its archive data storage.

System action:

Client cannot complete the requested archive operation.

User response:

Report the problem to your IBM Spectrum Protect system administrator,
who can allocate more resources to archive storage.

------------------------------------------------------------------------
ANS5021I

Archive completed



Explanation:

An archive was completed.

System action:

IBM Spectrum Protect archived the files.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5022I

Retrieve stopped by user



Explanation:

You requested to stop the retrieve operation.

Attention: If you were retrieving files with "overwrite" option
specified, the file you retrieved last can be damaged (partially
overwritten).

System action:

Retrieve stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5023E

Not enough memory for retrieve operation



Explanation:

The process in which the program runs has exceeded the maximum allocated
memory.

System action:

Processing ends.

User response:

Close all unneeded applications and retry the operation. Reducing the
scope of queries and the amount of data returned might also help, or see
your system administrator.

------------------------------------------------------------------------
ANS5024I

Retrieve completed



Explanation:

A retrieve was completed.

System action:

IBM Spectrum Protect retrieved the files.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5025E

The node name contains invalid characters.



Explanation:

The specified node name has invalid characters.

System action:

Current operation has been cancelled.

User response:

Retry with another node name that has valid characters.

------------------------------------------------------------------------
ANS5026W

MatchAllChar and MatchOneChar options MUST precede Include/Exclude
options



Explanation:

The MatchAllChar and MatchOneChar options must precede any
include-exclude options.

System action:

Current application ends

User response:

Move the MatchAllChar and MarchOneChar options before any
include-exclude options.

------------------------------------------------------------------------
ANS5027W

Objects of different types cannot be backed up at the same time.



Explanation:

Backing up objects of different types at the same time is not allowed in
certain scenarios. For example, backing up Hyper-V and VMware virtual
machines at the same time is not possible.

System action:

No processing takes place.

User response:

Select objects of the same type to perform backup operation.

------------------------------------------------------------------------
ANS5028I

Successful completion



Explanation:

The operation successfully completed.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS5029E

This operation cannot continue due to an error on the IBM Spectrum
Protect server. See your IBM Spectrum Protect server administrator for
assistance.



Explanation:

The IBM Spectrum Protect server encountered an error condition that
prevents the IBM Spectrum Protect client operation from continuing. Your
IBM Spectrum Protect server administrator can review the IBM Spectrum
Protect server activity log for more details about the error.

System action:

The processing stopped.

User response:

Contact your IBM Spectrum Protect server administrator for assistance.
The administrator can review the IBM Spectrum Protect server activity
log for further information about the conditions that lead to this
error.

------------------------------------------------------------------------
ANS5030E

No objects on server match query



Explanation:

No objects on the server match the query operation being performed.

System action:

The processing stopped.

User response:

Ensure the names are properly entered.

------------------------------------------------------------------------
ANS5031E

Client aborted transaction



Explanation:

The client system ended the operation with the server and ended the
current transaction.

System action:

The processing stopped.

User response:

Restart the session.

------------------------------------------------------------------------
ANS5032W

Active object not found



Explanation:

An attempt was made to expire an object, but the server was unable to
find an active backup version of the object. This message is preceded by
message ANS1228E which specifies the object name. For instance, this
message could be issued if two separate client processes are backing up
the same file system at the same time. If one of the processes expires a
file, then the server will make that file inactive. If the second
process subsequently attempts to expire that same file, the server will
not find an active version of the file, so the second process will issue
this message for that file.

System action:

The object is not expired. Processing continues with the next object..

User response:

Review the console output, schedule log, or error log and locate the
ANS1228E message that immediately precedes this message. ANS1228E will
identify the object that could not be expired. Examine the conditions
under which the problem occurred and assess whether those conditions
explain the occurrence of this message. For example, this message could
appear if multiple instances of the client were attempting to back up
the file system concurrently. If the reason this message occurred can
not be determined and the message occurs when the operation is tried
again, then contact support for further assistance. Also try searching
for this message number on http://www.ibm.com for possible solutions.

------------------------------------------------------------------------
ANS5033E

Server has no data for the object.



Explanation:

Server tried to do a restore or retrieve on an object that has no data
associated with it. If a corrective action is possible, it is with the
server.

System action:

Server ends the current operation.

User response:

Ask the administrator to check the activity log for any messages related
to this error that might help identify the problem.

------------------------------------------------------------------------
ANS5034E

You entered an incorrect password.



Explanation:

You entered an incorrect current password or you entered a new password
that does not fulfill the password length requirements set on the
server.

System action:

The processing stops.

User response:

Retry the session with the correct password. If this fails or you have
forgotten your password, ask the administrator to assign a new password.

------------------------------------------------------------------------
ANS5035E

Node is in use.



Explanation:

The node you are running on is in use by another operation on the
server. This might be from another client or from some activity on the
server.

System action:

The processing stopped.

User response:

Retry the operation, or see your system administrator to see what other
operations are running for your node.

------------------------------------------------------------------------
ANS5036E

Expiration date must be greater than today's date



Explanation:

Archive expiration date is too low, the date must be greater than
today's date.

System action:

The current operation is canceled.

User response:

Retry archiving the file with an expiration date that is higher than
today's date.

------------------------------------------------------------------------
ANS5037W

The requested data is offline



Explanation:

For the restore or retrieve operation, one or more of the requested
files must be recalled from offline storage media (generally tape). The
wait time depends on your site's offline storage management policies.

System action:

CLient waits for offline storage media to become available and then
continues.

User response:

None.

------------------------------------------------------------------------
ANS5038E

Object too large for server limits.



Explanation:

The object is too large. The configuration of the server does not have
any data storage space that accepts the object.

System action:

File skipped.

User response:

See your system administrator to determine the maximum file (object)
size for which your site's server is configured.

------------------------------------------------------------------------
ANS5039E

Server out of data storage space.



Explanation:

The server does not have any space available to store the object.

System action:

Ended the current operation.

User response:

You can take any of the following actions:

*  For client, set COMPRESSALWAYS=NO and COMPRESSIon=YES in the options
   file (DSM.OPT), then the file will be resent uncompressed if it grows
   during compression.

*  Request the system administrator to add space to the storage pool.

*  The system administrator can also turn off disk caching in the disk
   storage pool, and issue MOVE DATA commands to each disk pool volume
   to clear out the cached bitfiles.

------------------------------------------------------------------------
ANS5040E

Server media mount not possible.



Explanation:

Server media mount not possible. The server timed out waiting for a
mount of an offline volume.

System action:

File skipped.

User response:

Retry later when server volumes can be mounted. Ensure that the MAXNUMMP
(maximum number of mount points) defined on the server for this node is
greater than 0.

------------------------------------------------------------------------
ANS5041E

Size estimate exceeded.



Explanation:

The total amount of data for a backup or archive operation exceeds the
estimated size originally sent to the server for allocating data storage
space. This happens when many files are growing by large amounts while
the backup or archive operation is in session.

System action:

Processing stopped.

User response:

Retry the operation. If the problem continues, check what other
processes are running on the client machine that are generating large
amounts of data. Disable those operations while the backup or archive
operation is taking place.

------------------------------------------------------------------------
ANS5042E

File data is currently unavailable on the IBM Spectrum Protect server



Explanation:

The IBM Spectrum Protect client was trying to restore or retrieve data
that is currently unavailable on the IBM Spectrum Protect server.
Possible causes are:

*  Data is corrupted at the IBM Spectrum Protect server

*  The IBM Spectrum Protect server encountered a read error

*  File is temporarily involved in a reclaim operation at the server

*  The IBM Spectrum Protect requested a tape volume that is unavailable.
   Typical reasons for a volume to be unavailable: a disk volume is
   offline, the volume is marked unavailable due to an I/O error, or a
   tape volume is checked out of the tape library.

System action:

Processing stopped.

User response:

Try the operation again at a later time. If the problem continues,
contact your IBM Spectrum Protect server administrator for further
assistance. The administrator can review the IBM Spectrum Protect server
activity log for messages related to the problem.

------------------------------------------------------------------------
ANS5043W

Unexpected retry request. The server found an error while writing the
data.



Explanation:

None.

System action:

The client retries the operation.

User response:

None.

------------------------------------------------------------------------
ANS5044E

Session rejected: All server sessions are currently in use.



Explanation:

Server has all available sessions in use and cannot accept a new one at
this time.

System action:

Server canceled the current operation.

User response:

Retry the operation.If the problem continues, see your system
administrator to increase the number of concurrently active sessions to
the server.

------------------------------------------------------------------------
ANS5045E

The session is rejected. Your password has expired.



Explanation:

Your password has expired.

System action:

Server canceled the current operation. You are not allowed to connect to
the server until the password is updated.

User response:

Update your password. You may use the SET PASSWORD command, or have the
administrator update your node.

------------------------------------------------------------------------
ANS5046E

Session rejected: Unknown or incorrect node ID entered



Explanation:

The node name you entered is not known by the server, or you are
attempting to access a file migrated to a different node.

System action:

The current operation is canceled. You are not allowed to connect to the
server until your node name is registered with the server. If attempting
to access a migrated file, your node name must be the same node which
migrated the file.

User response:

Ensure that you entered your node name correctly. If yes, see your
system administrator. Verify that the server is using closed
registration and that your node name is registered with the server.

------------------------------------------------------------------------
ANS5047E

Session rejected: Duplicate ID entered. Node already logged onto server



Explanation:

Another process using this node name is active with the server.

System action:

Cannot connect to the server. Canceled the current operation.

User response:

Ensure that your node name is unique to the server so that it cannot be
used by another person. See your system administrator to identify the
owner of that node name.

------------------------------------------------------------------------
ANS5048E

Please choose a filespace.The filespace to delete/set access cannot be
found.



Explanation:

The filespace to delete cannot be found.

System action:

The system returns to the calling procedure.

User response:

Verify the filespace name.

------------------------------------------------------------------------
ANS5049E

Session rejected: The server is disabled



Explanation:

The server is in a disabled state and cannot be accessed for normal
activity.

System action:

Canceled the current operation.

User response:

Retry the operation after the server returns to an enabled state. If the
problem continues, see your system administrator.

------------------------------------------------------------------------
ANS5050E

The server is not configured to allow open registration.



Explanation:

No authorization. Registration is required by your system administrator.
The server is not configured to allow open registration.

System action:

Session not started.

User response:

You must obtain a node and password from your system administrator.

------------------------------------------------------------------------
ANS5051S

Session rejected: the client code is down-level



Explanation:

The server version and your client version do not match. The client code
is downlevel.

System action:

The current operation is canceled.

User response:

See your system administrator to see what version to run for your
location.

------------------------------------------------------------------------
ANS5052E

Session rejected: Downlevel server code version.



Explanation:

The server version and your client version do not match. The server code
is downlevel.

System action:

The current operation is canceled.

User response:

See your system administrator to see what version to run for your
location.

------------------------------------------------------------------------
ANS5053W

The operation was stopped by the user.



Explanation:

The operation was stopped at the request of the user. This usually
occurs when the 'Q' key is pressed two times.

System action:

Processing stopped.

User response:

None.

------------------------------------------------------------------------
ANS5054E

The operating system refused a request for memory allocation.



Explanation:

The client requires access to memory in order to store information as
processing proceeds. In this case, more memory was requested than the
operating system would allocate. Possible reasons include:

*  The system is low on memory.

*  The process in which the program runs has exceeded the maximum
   allocated memory.

*  Some other error condition occurred. No memory is available.

System action:

Client cannot complete the requested operation.

User response:

Close all unneeded applications and try the operation again. If the
operation still fails, try dividing the task into several smaller units.
For example, if a file specification contains several high-level
directories, run the task serially for each directory. If the task is an
incremental backup, use the option "-memoryefficientbackup=yes".

------------------------------------------------------------------------
ANS5055E

File not found during Backup, Archive or Migrate processing. No file
specification entered.



Explanation:

The file being processed for backup, archive or migrate no longer exists
on the client. Another process deleted the file before it could be
backed up, archived or migrated.

System action:

File skipped.

User response:

None.

------------------------------------------------------------------------
ANS5056E

The specified directory path could not be found.



Explanation:

An invalid or unreachable directory path was specified.

System action:

Processing stopped.

User response:

Try the operation again using a valid directory path.

------------------------------------------------------------------------
ANS5057E

Access to the specified file or directory is denied.



Explanation:

Access to the specified file or directory is denied. You tried to read
from or write to a file and you do not have access permission for either
the file or the directory.

System action:

Processing stopped.

User response:

Ensure that you specified the correct file or directory name, correct
the permissions, or specify a new location.

------------------------------------------------------------------------
ANS5058E

No file handles available



Explanation:

All file handles for your system are currently in use. No more are
available.

System action:

Processing stopped.

User response:

Either free some file handles by ending other processes, or modify your
system setup to allow for more files to be open at the same time.

------------------------------------------------------------------------
ANS5059E

The file exists and cannot be overwritten.



Explanation:

The file being restored or retrieved exists and cannot be overwritten
due to lack of authority or access permissions.

System action:

The file is skipped.

User response:

Verify that you have sufficient access permissions to overwrite the
file, then try the operation again. If the problem persists, contact
your system administrator or administrator for further assistance.

------------------------------------------------------------------------
ANS5060E

Invalid parameter passed.



Explanation:

The system encountered an internal program error due to an invalid
parameter.

System action:

The system returns to the calling procedure.

User response:

Ask your service representative to check the error log.

------------------------------------------------------------------------
ANS5061E

An invalid file handle passed. Report how you got this system error.



Explanation:

An internal system error occurred. A file operation failed because of an
invalid file handle.

System action:

Processing stops.

User response:

Try the operation again. If the failure persists, obtain a service trace
that captures the problem and contact technical support for additional
assistance. Your administrator can help you configure the trace.

------------------------------------------------------------------------
ANS5062E

Disk full



Explanation:

Operation has stopped because the destination disk is full.

System action:

Processing stopped.

User response:

Free up disk space and retry the operation

------------------------------------------------------------------------
ANS5083E

Drive specification contains wildcard character.



Explanation:

Drive name shouldn't contain wildcard character.

System action:

Wildcarded objects skipped.

User response:

Use valid drive specification.

------------------------------------------------------------------------
ANS5091S

The IBM Spectrum Protect server does not currently have space in the
storage pool for this file. This might be a temporary condition.



Explanation:

This message is typically issued when the storage pool in which the data
is being placed does not have sufficient to store the data, but that the
space will be available soon. For example, a storage pool migration may
free up sufficient space to store the data.

System action:

Process ends.

User response:

This is possibly a temporary condition. Try the operation again at a
later time. If the error persists, contact your IBM Spectrum Protect
administrator, who can examine server console and error logs to locate
the cause of the problem.

------------------------------------------------------------------------
ANS5092S

Server out of data storage space.



Explanation:

The server does not have any more space available to store the object.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Report to your system administrator that a storage pool on the server is
full.

------------------------------------------------------------------------
ANS5093S

SLM_LICENSE_EXCEEDED: The client licenses for IBM Spectrum Protect are
exceeded. See your IBM Spectrum Protect administrator.



Explanation:

Adding a new enrollment will exceed the product license count for this
IBM Spectrum Protect server.

System action:

The client enrollment or connection request ends.

User response:

See your IBM Spectrum Protect administrator to delete unused enrollments
or negotiate an increase in the number of allowed licenses for your
server.

------------------------------------------------------------------------
ANS5094E

Session Rejected. Sufficient server memory is not available.



Explanation:

The server does not have enough memory to allow your client to establish
a connection with the server.

System action:

Session was not started.

User response:

Retry later or see your system administrator.

------------------------------------------------------------------------
ANS5122E

The specified filespace does not exist on the server. The filespace
might have been deleted by another client or an administrator.



Explanation:

The specified filespace does not exist on the server. Your administrator
might have already deleted the filespace or another client using your
client's node name might have deleted it.

System action:

IBM Spectrum Protect ends the current operation.

User response:

The filespace you selected does not exist any more. See your IBM
Spectrum Protect administrator for help in finding how the filespace was
deleted.

------------------------------------------------------------------------
ANS5123S

Open registration failed because the specified node name is already
defined in the server.



Explanation:

Open registration failed because a node is defined on the server with
the same name.

System action:

Current operation has been cancelled.

User response:

Retry with another node name.

------------------------------------------------------------------------
ANS5124S

Open registration failed because there is no default domain.



Explanation:

Open registration failed because a default policy domain does not exist
in which to place your node. A default policy domain is required to
fully support open node registration.

System action:

Current operation has been cancelled.

User response:

See your IBM Spectrum Protect administrator for assistance in
registering your node.

------------------------------------------------------------------------
ANS5125S

Open registration failed because an invalid node name was specified.



Explanation:

Open registration failed because the specified node name has invalid
characters.

System action:

Current operation has been cancelled.

User response:

Retry with another node name that does not have any invalid characters.

------------------------------------------------------------------------
ANS5126S

Filespaces with duplicate names are not supported. Unmount the duplicate
file space.



Explanation:

The selected file space has a duplicate volume label. Because IBM
Spectrum Protect uses the volume label to keep track of backup/archive
information, it cannot back up or archive files from a file space with a
duplicate volume label.

System action:

IBM Spectrum Protect cannot select the volume.

User response:

If the file space needs to be available to the system, exit IBM Spectrum
Protect, and assign a volume label to the file space. Restart the
process and retry the operation. Otherwise, unmount the duplicate file
space.

------------------------------------------------------------------------
ANS5127I

IBM Spectrum Protect has detected an incomplete setup! The system
options file 'dsm.sys' was not found, while the client options file
'file-path' exists! The wizard will guide you through the configuration
process of the initial basic IBM Spectrum Protect client options files
replacing your current option file. Would you like to continue?



Explanation:

IBM Spectrum Protect has detected an incomplete setup. The system
options file, dsm.sys, was not found. Additionally, a user options file,
dsm.opt, was found. To complete the configuration the configuration
wizard will create dsm.sys and replace dsm.opt with minimal settings.

System action:

IBM Spectrum Protect may stop

User response:

If the current version of dsm.opt is needed, rename the file and restart
IBM Spectrum Protect. If the current version is not needed, select yes
and allow IBM Spectrum Protect to replace the file.

------------------------------------------------------------------------
ANS5128E

The management class for this file did not have a backup copy group.



Explanation:

For backup operations, a file may only be bound to a management class
that has a backup copy group.

System action:

IBM Spectrum Protect did not back up the file.

User response:

See your IBM Spectrum Protect system administrator for assistance in
finding a management class with the required copy group. The
administrator may also define such a management class for you.

------------------------------------------------------------------------
ANS5129E

The management class for this file did not have an archive copy group
specified.



Explanation:

For archive operations, a file may only be bound to a management class
that has an archive copy group.

System action:

The file was not archived.

User response:

See your IBM Spectrum Protect system administrator for assistance in
finding a management class with the required copy group. The
administrator may also define such a management class for you.

------------------------------------------------------------------------
ANS5130W

No filespaces selected for deletion



Explanation:

You requested a deletion operation without selecting a client domain.

System action:

IBM Spectrum Protect cannot perform a deletion without a domain
selected.

User response:

Select the volumes you want to delete and retry the operation.

------------------------------------------------------------------------
ANS5132I

Filespace deletion canceled by user



Explanation:

You requested to cancel the filespace deletion operation.

System action:

The filespace deletion operation stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5133I

Filespace 'filespace' was deleted



Explanation:

The specified filespace was successfully deleted.

System action:

IBM Spectrum Protect deleted the filespace.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5134E

Unable to delete the filespace because this node does not have
permission to delete archived or backed up data.



Explanation:

You tried to delete a filespace that you do not have permission to
access.

System action:

Processing stopped.

User response:

Ensure that you specify the correct filespace, or specify a filespace
you have access to.

------------------------------------------------------------------------
ANS5135I

Archive delete stopped by user



Explanation:

You requested to stop the archive delete operation.

System action:

Archive delete stopped.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5138I

Archive delete completed



Explanation:

An archive delete was completed.

System action:

IBM Spectrum Protect deleted the archived files.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5139E

Your node does not have permission to delete archived files.



Explanation:

Your node is registered at the server with the ARCHDELETE option set to
'NO'. Therefore your node is not allowed by the server to delete
archived files.

System action:

Archived files were not deleted.

User response:

See your IBM Spectrum Protect system administrator. The administrator
has authority to delete archived files, and can also grant that
authority to your node.

------------------------------------------------------------------------
ANS5145W

Server cannot restart the last restore request. Do you want to restore
without restart?



Explanation:

The restart restore token has expired. The server cannot restart the
restore from where it last ended.

System action:

Processing stopped; waiting for user intervention.

User response:

Retry the request without restart or abort the request.

------------------------------------------------------------------------
ANS5146W

You cannot perform this operation while accessing data for another node.
Do you wish to switch back to accessing your own node?



Explanation:

The user cannot perform the selected operation while accessing another
users data.

System action:

Processing stopped; waiting for user intervention.

User response:

Answer "Yes" to switch back to accessing the server as the original
node.

------------------------------------------------------------------------
ANS5148W

The server needs to do a one-time conversion of your archive data before
you can continue. This operation may take a long time, and cannot be
canceled once it has started. Are you willing to wait for the conversion
to complete?



Explanation:

The server must do a conversion of the archive data before continuing.
The conversion could take a long time, and cannot be canceled once it is
started.

System action:

Processing stopped; waiting for user intervention.

User response:

Answer "Yes" to start the archive data conversion. If you answer "No",
the current operation will be canceled.

------------------------------------------------------------------------
ANS5150E

An active restore for the same source file specification exists. Unable
to continue with this request.



Explanation:

Currently, there is an active restore for the same source file
specification. Another restore of the same source file specification
cannot be started.

System action:

The requested restore fails.

User response:

Start another restore with a different source file specification.

------------------------------------------------------------------------
ANS5151S

This node currently has a pending restartable restore session. The
requested operation cannot complete until this session either completes
or is canceled.



Explanation:

This operation can not be completed because a restartable restore
session is pending. The operation is not allowed because the restartable
session and the current operation affect the same file space.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Issue the Query Restore command to view a list of your restartable
restore sessions in the server database. Issue the Cancel Restore
command to cancel any unneeded restartable restore sessions.

------------------------------------------------------------------------
ANS5152S

Session Rejected: The server is not licensed for this platform type. See
your IBM Spectrum Protect administrator.



Explanation:

The server license governs the types of client that can connect to it.
The license for this server does not include the requesting client type.

System action:

The client enrollment or connection request ends.

User response:

See your IBM Spectrum Protect administrator who must upgrade the server
license to accept your client type.

------------------------------------------------------------------------
ANS5153E

Session Rejected: The server does not allow a signon as a Unicode
enabled client.



Explanation:

The client cannot establish a connection to the server because of a
unicode enabling mismatch between server and client.

System action:

Session was not started.

User response:

See your system administrator immediately.

------------------------------------------------------------------------
ANS5154I

File is implicitly excluded



Explanation:

You tried to back up or migrate a file that is implicitly excluded.

System action:

IBM Spectrum Protect will not back up or migrate an implicitly excluded
file.

User response:

None.

------------------------------------------------------------------------
ANS5155E

The valid password is not available. The IBM Spectrum Protect
administrator for your system must run IBM Spectrum Protect and enter
the password to store it locally.



Explanation:

The file containing the stored password for the specified server is
unavailable.

System action:

Process ends.

User response:

The system administrator for your system must set and store a new
password.

------------------------------------------------------------------------
ANS5158S

Filespace deletion is in progress. Try again later.



Explanation:

The filespace is in the process of being deleted.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Try the operation again later. If the filespace was being deleted, it
could take awhile for it to complete. If the problem continues, report
the problem to your system administrator.

------------------------------------------------------------------------
ANS5164E

Backup or archive of drives with duplicate volume labels is not allowed.



Explanation:

You tried to back up or archive a drive that has a duplicate volume
label. Because IBM Spectrum Protect uses the volume label to keep track
of backup or archive information, it cannot back up or archive files
from a drive with a duplicate volume label.

System action:

IBM Spectrum Protect cannot select the drive for backup or archive
operations.

User response:

If the volume needs to be available to the system, exit IBM Spectrum
Protect and assign a unique volume label to the drive. Restart IBM
Spectrum Protect and try the operation again.

------------------------------------------------------------------------
ANS5165E

Drive has no volume label. Backup/Archive not allowed.



Explanation:

You tried to backup or archive a drive that has no volume label.

System action:

IBM Spectrum Protect rejected the selected drive.

User response:

If the drive is a floppy drive, place a disk with a volume label in it
and retry the operation. If the disk is a hard drive, ensure the drive
has a volume label, and retry the operation.

------------------------------------------------------------------------
ANS5176W

The requested virtual machine operation cannot be performed because a
virtual machine backup or restore operation is already in progress.
Please retry the operation after the first operation completes.



Explanation:

A virtual machine operation is already in progress, so the requested
virtual machine operation cannot be performed until the first operation
complets.

System action:

Processing stops

User response:

Wait for the first virtual machine operation to complete, and then
restart the current request.

------------------------------------------------------------------------
ANS5177E

Client-side deduplication and server-initiated sessions are mutually
exclusive.



Explanation:

Conflicting options SESSIONINIT=serveronly and DEDUPLICATION=yes were
specified. This combination is not allowed.

System action:

Processing stops.

User response:

Use client-initiated sessions or disable client-side deduplication

------------------------------------------------------------------------
ANS5178E

Restart of the RSM service failed. Restart the RSM service manually.



Explanation:

RSM database files have been restored from the IBM Spectrum Protect
server and imported. The client has tried to restart the RSM service on
the user's behalf but has run into a problem.

System action:

Processing stopped.

User response:

Restart the RSM service manually.

------------------------------------------------------------------------
ANS5179E

Client is unable to continue. Exiting program.



Explanation:

Client ran into a problem and is unable to continue. This error message
is usually preceded by other error messages. Resolve those errors and
try again.

System action:

Program terminates.

User response:

Fix the problem(s) that preceded this message and then restart the
client.

------------------------------------------------------------------------
ANS5181E

Invalid selection; A specific backup set must be selected.



Explanation:

A selection was made that might result in multiple backup sets being
restored at the same time, but restoring multiple backup sets at the
same time is not supported.

System action:

The backup set restore was not performed.

User response:

Select a specific backup set to be restored.

------------------------------------------------------------------------
ANS5182E

Multiple backup sets can not be restored at the same time.



Explanation:

Multiple backup sets were selected to be restored, but restoring
multiple backup sets at the same time is not supported.

System action:

The backup set restore was not performed.

User response:

Select a specific backup set to be restored.

------------------------------------------------------------------------
ANS5183W

Objects of different types cannot be restored at the same time.



Explanation:

Restoring objects of different types is not allowed. For example,
restoring Backup Sets and regular file objects at the same time is not
possible.

System action:

No processing takes place.

User response:

Select objects of the same type to perform restore operation.

------------------------------------------------------------------------
ANS5184E

Illegal Operation On Following Object: object



Explanation:

Requested operation cannot be performed on this object.

System action:

This object will be skipped.

User response:

Try another operation on this object, or try the same operation on
another object.

------------------------------------------------------------------------
ANS5186E

Server is downlevel, System Services and System State backup disabled
for this session.



Explanation:

The operation cannot be performed because server version is downlevel.

System action:

System Service and System State backup is disabled for this session.

User response:

Must use level 5.2.0 or higher server.

------------------------------------------------------------------------
ANS5187E

Unable to set SHAREAS extended attribute for file: 'pathname' Return
code: 'returncode' 'strerror' Reason code: 'reasoncode'



Explanation:

You must be the file owner or have superuser authority.

System action:

File processed without setting attribute.

User response:

The attribute must be set manually.

------------------------------------------------------------------------
ANS5188E

Periodic Full plus Incremental VM backups have been deprecated. Please
use Incremental Forever Full or Incremental Forever Incremental to
perform virtual machine backups.



Explanation:

Periodic Full plus Incremental virtual machine backups have been
deprecated.

System action:

Processing stops

User response:

Restart the virtual machine backup and use Incremental Forever Full or
Incremental Forever Incremental instead for the backup mode.

------------------------------------------------------------------------
ANS5189E

Online SystemState restore has been deprecated. Please use offline WinPE
method for performing system state restore.



Explanation:

Online SystemState restore has been deprecated.

System action:

Processing stops

User response:

Perform the system state restore using offline WinPE method.

------------------------------------------------------------------------
ANS5191E

NT Active Directory is not online. Offline backup is not supported.



Explanation:

NT Active Directory is not online when performing a backup operation.
Offline backup is not supported.

System action:

Processing stopped.

User response:

Reboot computer and turn on Active Directory, and try the operation
again.

------------------------------------------------------------------------
ANS5192E

NT Active Directory is online. Online restore is not supported.



Explanation:

NT Active Directory is online when performing a restore operation.
Online restore is not supported.

System action:

Processing stopped.

User response:

Reboot computer and enter Active Directory repair mode, then try the
operation again.

------------------------------------------------------------------------
ANS5193E

Certificate Services is not online. Offline backup is not supported.



Explanation:

Certificate Services is not online when performing a backup operation.
Offline backup is not supported.

System action:

Processing stopped.

User response:

Start Certificate Services and try the operation again.

------------------------------------------------------------------------
ANS5194E

Certificate Services is online. Online restore is not supported.



Explanation:

Certificate Services is online when performing a restore operation.
Online restore is not supported.

System action:

Processing stopped.

User response:

Stop Certificate Services and try the operation again.

------------------------------------------------------------------------
ANS5196W

Invalid encryption key password entered.



Explanation:

The encryption key password supplied does not meet the IBM Spectrum
Protect requirements. This key can be up to 63 bytes in length and
include the following characters: A-Z Any letter, A through Z, uppercase
or lowercase 0-9 Any number, 0 through 9 + Plus . Period _ Underscore -
Hyphen & Ampersand

System action:

IBM Spectrum Protect allows you to try again.

User response:

Enter the correct encryption key password.

------------------------------------------------------------------------
ANS5201E

The specified function is not implemented



Explanation:

The specified function is not implemented.

System action:

Processing stopped.

User response:

Correct the command and retry the operation.

------------------------------------------------------------------------
ANS5202I

One or more system objects were excluded from processing by entries in
the include-exclude list.



Explanation:

One or more system objects were excluded from processing by entries in
the include-exclude list and the client did not process them.

System action:

Excluded objects skipped.

User response:

None.

------------------------------------------------------------------------
ANS5204W

Only one backup set may be selected for restore.



Explanation:

Restoring multiple backup sets is not allowed. Only one backup set may
be selected and restored.

System action:

No processing takes place.

User response:

Only one backup set may be selected for restore.

------------------------------------------------------------------------
ANS5208E

An invalid date or time was entered.



Explanation:

An invalid date or time value was entered. Either the syntax of the
value was not correct, or an actual value (for example, "45" for month)
was invalid.

System action:

Processing stops.

User response:

Identify and correct the invalid date or time value. Refer to the user's
guide of the corresponding platform for the correct date syntax.

------------------------------------------------------------------------
ANS5209E

System Volume backup failed.



Explanation:

IBM Spectrum Protect encountered an error while backing up files of the
Windows 2000 System Volume

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the system volume was successfully initialized. Restart the service and
retry the backup operation

------------------------------------------------------------------------
ANS5210E

System Volume restore failed.



Explanation:

IBM Spectrum Protect encountered an error while restoring files of the
Windows 2000 System Volume

System action:

Processing stopped.

User response:

Examine the Windows 2000 File Replication Service Event log to insure
the system volume was successfully initialized. Restart the service and
retry the restore operation.

------------------------------------------------------------------------
ANS5211E

The cluster service is offline. The cluster service must be online to
perform an authoritative cluster database restore operation.



Explanation:

The cluster service must be online to restore the cluster database. IBM
Spectrum Protect tried to start the service and failed. It is possible
that an authoritative restore cannot be done.

System action:

Processing stops.

User response:

Start the cluster service and retry the operation.

------------------------------------------------------------------------
ANS5212E

An error occurred while trying to rename file space.



Explanation:

This operation can not be completed because the file space could not be
renamed.

System action:

IBM Spectrum Protect ended the current operation.

User response:

Contact system administrator for more information.

------------------------------------------------------------------------
ANS5215E

function-type is not allowed on object 'object'. Object is not sent to
the server.



Explanation:

The operation could not be performed on this object. For example, if
this is an image operation, the selected path is a file or a directory
and therefore is not a valid object for image operations.

System action:

This object is skipped.

User response:

Verify that the object named is of a type supported by the command. For
example, if a filespace name is required but a directory name was given,
change the name so it includes only the filespace name.

------------------------------------------------------------------------
ANS5216E

Could not establish a TCP/IP connection with address
'tcp-addr:tcp-port'. The TCP/IP error is 'tcp-err-string' (errno =
errno).



Explanation:

A TCP/IP connection was attempted with a server or agent program and
failed.

System action:

Processing stops.

User response:

Ensure that the target TCP/IP address and port number is correct. Check
to ensure that a IBM Spectrum Protect server or agent has been started
at the target TCP/IP address and is configured to listen at the port
listed in the message.

------------------------------------------------------------------------
ANS5217E

Your node does not have permission to delete backed up files.



Explanation:

You cannot delete backed up files unless your IBM Spectrum Protect
administrator has authorized your node to do so.

System action:

IBM Spectrum Protect does not delete the backed up files.

User response:

Use the DSMC QUERY SESSION command to verify your authorization. Ask
your IBM Spectrum Protect administrator to provide the necessary
authorization.

------------------------------------------------------------------------
ANS5219W

Objects of different groups cannot be restored at the same time.



Explanation:

Restoring objects of different groups is not allowed.

System action:

No processing takes place.

User response:

Select objects of the same group to perform restore operation.

------------------------------------------------------------------------
ANS5222E

The archive description exceeds 254 characters.



Explanation:

IBM Spectrum Protect places a maximum length of 254 characters on the
archive description.

System action:

processing stops.

User response:

Issue the command again and specify a shorter valid archive description.

------------------------------------------------------------------------
ANS5224W

Error error code encountered while reverting to the restored snapshot.



Explanation:

After the virtual machine disks are restored, the virtual machine is
reverted to the restored state. The specified error was encountered
while performing this revert operation.

System action:

Processing continues

User response:

Try powering on the restored virtual machine. If it fails to start,
re-try the restore process.

------------------------------------------------------------------------
ANS5225W

Error error code encountered while removing the restored snapshot.



Explanation:

After the virtual machine disks are restored, the virtual machine is
reverted to the restored state, and the snapshot is removed. The
specified error was encountered while removing the snapshot.

System action:

Processing continues

User response:

Try powering on the restored virtual machine. If it fails to start,
re-try the restore process.

------------------------------------------------------------------------
ANS5226E

The virtual machine backup operation failed.



Explanation:

The virtual machine backup operation failed. Check the error log for
details on why the operation failed.

System action:

Processing stops

User response:

Review the console output and error logs for the details on the problem.
Fix any issues and restart the operation.

------------------------------------------------------------------------
ANS5227E

IBM Spectrum Protect detected an error where both a snapshot name was
specified, and a request to create a snapshot were specified.



Explanation:

Either a snapshot name should be specified, or a request for IBM
Spectrum Protect to create the snapshot should be specified, but not
both.

System action:

Processing stops.

User response:

This is an internal error and should be reported to your service
representative.

------------------------------------------------------------------------
ANS5228E

A backup VM operation failed because VMMAXPARALLEL was reduced to 1 and
the client still cannot obtain a server mount point.



Explanation:

During a parallel backup operation, concurrent backup sessions required
additional server mount points to perform the backups in parallel. The
client attempted to obtain the additional mount points, but the client
requests exceeded the number of mount points (MAXNUMMP) defined for the
node. In an effort to make the backup occur, the client reduced the
VMMAXPARALLEL option to 1, but was still unable to obtain a mount point.
The backup operation was stopped.

System action:

The backup operation was stopped

User response:

Check the console or schedule log for additional information. Retry the
operation at a later time. Ensure VMMAXPARALLEL is set to a value less
than or equal to MAXNUMMP.

------------------------------------------------------------------------
ANS5229E

The Snapshot is already mounted for backup 'backup-name'.



Explanation:

The Snapshot is currently mounted on the local machine or a remote
machine. No mount operation on the snapshot will be allowed until it has
been unmounted.

System action:

Processing stops

User response:

See the dsmerror.log file for further details.

------------------------------------------------------------------------
ANS5230E

The Snapshot is already imported to the local system for backup
'backup-name'.



Explanation:

The Snapshot is currently imported on the local machine. This maybe
becasue the Snapshot is in use or it was not created with the Import VSS
snapshots only when needed feature enabled.

System action:

Processing stops

User response:

Remote Mount operation not allowed on snapshots that are currenlty
imported.

------------------------------------------------------------------------
ANS5231E

VMDK size reported by VMware vSphere API is different than actual size
of vmdk file. Reissue the restore command with the testflag
-VMRESTORE_INCVMDKSIZE.



Explanation:

VMDK size reported by VMware vSphere API for virtual machine
configuration is different than actual size of vmdk file. This can be
the result of running a storage alignment tool on vmdk files before
backup.

System action:

Restore processing stops.

User response:

Reissue the restore command with the testflag -VMRESTORE_INCVMDKSIZE.

------------------------------------------------------------------------
ANS5232I

The virtual machine backup operation was skipped.



Explanation:

The virtual machine backup operation was skipped. Check the error log
for details on why the operation was skipped.

System action:

Processing of the virtual machine is skipped

User response:

Review the console output and error logs for the details.

------------------------------------------------------------------------
ANS5233E

The directory cannot be found in the specified backup. The top-level
directory is displayed.



Explanation:

An invalid or unreachable directory path was specified.

System action:

The top-level directory is displayed instead.

User response:

Select a valid directory and change the backup again.

------------------------------------------------------------------------
ANS5234E

The system cannot connect to the virtual machine or the machine is
powered off. If the problem persists, contact your administrator.



Explanation:

The virtual machine is powered off or the Windows domain administrator
credentials is not correct.

System action:

Processing stops.

User response:

Ensure that the virtual machine is powered on. Use dsmc SET PASSWORD
-type=DOMAIN 'domain\userid' 'password' to update the Windows domain
credentials. Then, try the operation again.

------------------------------------------------------------------------
ANS5235E

The virtual machine cannot be reached or a firewall is blocking the
connection to the machine.



Explanation:

The file restore interface cannot reach the virtual machine or a
firewall is blocking the connection.

System action:

Processing stops.

User response:

Ensure that the virtual machine is powered on. If the virtual machine is
powered on, review the firewall rules to ensure that the correct ports
are opened. Also ensure that the virtual machine host name and TCP/IP
address are resolving in the DNS server and there are no network issues.

------------------------------------------------------------------------
ANS5236E

You do not have permission to restore the file to the destination
folder.



Explanation:

The user does not have permission to restore files to the selected
destination.

System action:

Processing stops.

User response:

Ensure that the user has proper permissions to restore files to selected
location.

------------------------------------------------------------------------
ANS5237E

File Restore is not set up correctly or the virtual machine cannot be
reached. Contact your administrator for assistance.



Explanation:

The user is unable to log in to the file restore interface due to one of
the following reasons:

*  The configuration of File Restore is incorrect because the Windows
   domain credentials do not have the correct permissions.

*  The virtual machine is powered off or a firewall is blocking the
   connection.

*  A network issue.



System action:

Processing stops.

User response:

The administrator can take the following actions to correct the problem:

*  Ensure that the Windows domain credentials provided in the
   configurations notebook has the correct permissions to connect to the
   virtual machine.

*  Ensure that the virtual machine is powered on and any firewall has
   been updated to allow connections from the mount proxy machine.

*  Ensure that the mount proxy machine is able to connect to the virtual
   machine manually to ensure there is no networking issue.



------------------------------------------------------------------------
ANS5238E

Cannot get list of Linux block devices on the Linux mount proxy machine.



Explanation:

The Linux command blkid to get the list of block devices fails.

System action:

The operation stops.

User response:

Check that the blkid Linux command is working correctly on the Linux
mount proxy machine.

------------------------------------------------------------------------
ANS5239E

Cannot add the disk flat file 'flat file because no free loop devices
are available on the Linux mount proxy machine.



Explanation:

Some Linux machines have a limited number of loop devices. For file
restore operations of a local snapshot, it is required that each Linux
proxy machine have a free loop device for each volume to mount.

System action:

The file restore operation stops.

User response:

Increase the number of loop devices on the Linux mount proxy machine or
install the Linux mount proxy on a Linux distribution where the number
of loop devices is not limited.

------------------------------------------------------------------------
ANS5240E

Setting up device mappings for the disk flat file 'flat file' by using
the kpartx command on the Linux mount proxy machine failed with rc 'rc'.



Explanation:

A failure occurred trying to create devices with the Linux utility
command kpartx.

System action:

The file restore operation stops.

User response:

Check that the kpartx Linux command is working correctly on the Linux
mount proxy machine.

------------------------------------------------------------------------
ANS5241E

Mounting block device 'device_name' to 'mount-point' failed with rc
'rc'.



Explanation:

A file restore operation was unable to mount the original block device
on the Linux mount proxy. The mount command on the Linux mount proxy
produced an unexpected error and the related block device was not
mounted. The specified volume was skipped.

System action:

File restore operations continue with the next device.

User response:

Update the Linux mount proxy OS. This behavior has been observed with
LVM on a guest machine with Redhat 7.3 and Redhat 6.5 on the mount
proxy.

------------------------------------------------------------------------
ANS5242E

Assembling the RAID device 'device' failed with rc 'rc'.



Explanation:

A failure occurred trying to assemble a RAID device on the Linux mount
proxy.

System action:

Marking device as 'mount_failed' and continuing the file restore
operation.

User response:

Check the consistency of the RAID device.

------------------------------------------------------------------------
ANS5243E

Activating LVM device number 'device-number' failed with rc 'rc'.



Explanation:

A failure occurred trying to activate LVM device on the Linux mount
proxy.

System action:

Marking device as 'mount_failed' and continuing the file restore
operation.

User response:

Check the consistency of the LVM device.

------------------------------------------------------------------------
ANS5244E

It is not possible to detect the original mount points because the etc
path cannot be found in any mounted volumes.



Explanation:

To detect the original mount points, it is required to read the fstab
and mtab files that are present in the etc path.

System action:

The file restore operation continues.

User response:

Check that the original virtual machine guest has a valid etc path.

------------------------------------------------------------------------
ANS5245W

TCPWINDOWSIZE optionCur is specified, but exceeds the maximum value
allowed by IBM Spectrum Protect. TCPWINDOWSIZE optionNew will be used
instead.



Explanation:

Refer to product manual for more information about the TCPWINDOWSIZE
option.

System action:

The operation continues with the maximum value allowed by IBM Spectrum
Protect.

User response:

Set TCP window size to a value in the allowable range.

------------------------------------------------------------------------
ANS5246W

TCPWINDOWSIZE optionCur is specified, but exceeds the maximum value
allowed by the operating system. TCPWINDOWSIZE optionNew will be used
instead.



Explanation:

The specified value is within the range allowed by IBM Spectrum Protect,
but the operating system restricts the value to something less.

System action:

The operation continues with the maximum value allowed by the operating
system.

User response:

Set TCP window size to a value allowed by the operating system.

------------------------------------------------------------------------
ANS5247E

The configuration for File Restore is not complete. Contact your
administrator for assistance.



Explanation:

The user is unable to log in to the file restore interface because the
Windows domain credentials are missing.

System action:

Processing stops.

User response:

The administrator must provide the Windows domain administrator
credentials in the File Restore page of the configuration notebook in
the Data Protection for VMware vSphere GUI.

------------------------------------------------------------------------
ANS5248E

It is not possible to detect the original mount points because the
original virtual machine guest file system information cannot be read.
rc='rc'.



Explanation:

To detect the original mount points, it is required to read the fstab
file that is present in the etc path.

System action:

The file restore operation continues.

User response:

Check that the original virtual machine guest has a valid fstab file.

------------------------------------------------------------------------
ANS5249E

The virtual machine restore operation failed.



Explanation:

The virtual machine restore operation failed. Check the error log for
details on why the operation failed.

System action:

Processing stops

User response:

Review the console output and error logs for the details on the problem.
Fix any issues and restart the operation.

------------------------------------------------------------------------
ANS5250E

An unexpected error was encountered. IBM Spectrum Protect function name
: function-name IBM Spectrum Protect function : function-desc IBM
Spectrum Protect return code : TSM-rc IBM Spectrum Protect file :
file-name (line-number)



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS5251E

The snapshot provider is not available for this operation.



Explanation:

IBM Spectrum Protect was not able to take a snapshot because the
snapshot provider is not available.

System action:

Processing stopped.

User response:

If you are attempting an operation using the Microsoft Volume Shadow
Copy service make sure that Volume Shadow Copy service is installed on
the system and also ensure that the IBM Spectrum Protect snapshot plugin
"pivss.dll" is present.

------------------------------------------------------------------------
ANS5252E

IBM Spectrum Protect attempted to execute a system command which failed.
command : command rc : rc



Explanation:

IBM Spectrum Protect needed to execute a system command in conjunction
with a snapshot operation.

System action:

Processing stops.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS5253W

The system could not create Volume Shadow Copy Services staging
directory 'dir'.



Explanation:

The system was unable to create a user-specified location for the Volume
Shadow Copy Services staging area. The default staging area on the
system drive will be used instead.

System action:

Processing continues.

User response:

Check the option to specify the staging area for Volume Shadow Copy
Services operations and specify a valid location.

------------------------------------------------------------------------
ANS5254E

The Volume Shadow Copy Services snapshot plugin 'pivss.dll' was not
found.



Explanation:

The system cannot find the VSS snapshot plugin 'pivss.dll' in any of the
plugin locations.

System action:

Processing stops.

User response:

Check the IBM Spectrum Protect installation to ensure the plugin was
installed correctly.

------------------------------------------------------------------------
ANS5255E

Unable to copy local file 'local-file' to remote location 'remote-file'.



Explanation:

An attempt to transfer a file to a remote system failed..

System action:

Processing stops.

User response:

Ensure that the directory path on the remote system exists and that the
IBM Spectrum Protect application has the proper authority to write to
that location.

------------------------------------------------------------------------
ANS5256W

Cannot find the original mtab file.



Explanation:

To detect the original mount points, it is required to read the original
mtab information. In some Linux distributions, the mtab file could be a
symbolic link to /proc/self/mounts that could interfere with the Linux
mount proxy.

System action:

The file restore operation continues.

User response:

Check that the original virtual machine guest has a valid mtab file.

------------------------------------------------------------------------
ANS5257E

The volume 'volume' does not support the requested VSS operation.



Explanation:

The volume does not support the requested VSS operation. Some reasons
for this error include the following conditions:

*  For off-load backup requests, a hardware provider cannot be found

*  For off-load backup requests, the provider does not support
   transportable media

*  For local backup requests, the provider does not support persistent
   snapshots

*  For backup requests of Hyper-V virtual machines that are located on
   the volume with a Cluster Shared Volume File System and the
   VSSUSESYSTEMPROVIDER option is set to YES

System action:

Processing stops.

User response:

Try the backup again, and use a supported backup destination. If you are
backing up Hyper-V VMs and the VSSUSESYSTEMPROVIDER option is set to
YES, try the operation again, with the VSSUSESYSTEMPROVIDER option set
to NO.

------------------------------------------------------------------------
ANS5258E

Microsoft volume shadow copy snapshot initialization failed.



Explanation:

IBM Spectrum Protect encountered an error while initializing the
Microsoft Volume Shadow Copy Service for backup or restore. The IBM
Spectrum Protect error log and Windows event log can contain additional
information about this error.

System action:

IBM Spectrum Protect stops the operation.

User response:

Try the operation again. If the error persists, review the IBM Spectrum
Protect error log and Windows event log for information related to this
error. Use the Windows command VSSADMIN LIST WRITERS to determine the
status of the Volume Shadow Copy service. Reboot the machine to clear
the volume shadow copy error state. If the system is a Domain Controller
and the Active Directory service is stopped, restart the Active
Directory service.

------------------------------------------------------------------------
ANS5259W

Failed to update volume 'volume' for read-write access used for
'volume'.



Explanation:

Changing the volume to read-write access requires exclusive access to
the volume. If the volume is opened by any application, this operation
will fail.

System action:

Processing continues.

User response:

Close all the applications using the volumes and use operating system's
interface to mount failed volume for read-write access.

------------------------------------------------------------------------
ANS5260W

Restore object 'volume' has volume either source 'volume' or target
'volume' volume that has already been selected for restore from a
different snapshot volumes. It will be restore using file-level copy.



Explanation:

This error can occur when multiple objects are selected for snapshot
restore and have data overlapping on the volumes and were selected for
restore from different backup versions. Snapshot restore can only be
performed from one local backup.

System action:

The restore object identified in the message will be restored using the
file-level copy after snapshot restore is completed.

User response:

Retry the restore of identified object separately for faster restore
using snapshot.

------------------------------------------------------------------------
ANS5261W

An attempt to create a snapshot has failed. Another attempt will be made
to create the snapshot in number seconds.



Explanation:

An attempt to create a snapshot has failed with a retryable error. The
program will wait for a short time and retry the operation.

System action:

None.

User response:

Check the IBM Spectrum Protect error logs for additional information.

------------------------------------------------------------------------
ANS5262I

Snapshot restore will failover to file-level copy from snapshot volume.



Explanation:

Snapshot restore is not possible due to an error at this time. IBM
Spectrum Protect will automatically fail over to other restore method to
complete the restore operation.

System action:

Processing continues.

User response:

Check the error log for more information from messages preceding this
one to identify the error condition.

------------------------------------------------------------------------
ANS5263E

Snapshot module for 'snapshot provider' failed with error 'error msg'.



Explanation:

The snapshot module for identified snapshot provider failed to perform
the operation and returned with the identified error.

System action:

Restore may automatically failover to alternate restore method
'file-level copy from snapshot volume' if possible. Otherwise,
processing stops.

User response:

Check the error log for more information from messages preceding this
one. Use snapshot provider interface to identify and correct the
problem.

------------------------------------------------------------------------
ANS5264W

No snapshot plugin found for 'snapshot provider' snapshot provider.



Explanation:

The snapshot restore requires a plugin for the specified snapshot
provider type. The plugin must be installed under IBM Spectrum Protect
directory.

System action:

Restore will failover to alternate restore method of 'file-level copy
from snapshot volume'.

User response:

Contact your IBM Spectrum Protect administrator to obtain and install
the required plugin module.

------------------------------------------------------------------------
ANS5265W

Snapshot restore has already been initialized using 'snapshot provider'
provider module. Another module for 'snapshot provider' provider can not
be loaded at the same time for restore of 'object name'.



Explanation:

This error occurs when restoring multiple LOCAL backup objects that were
created using different snapshot providers. Snapshot restore can only be
done using one snapshot interface.

System action:

Restore will failover to file-level copy restore from snapshot volume.

User response:

If snapshot restore is desired for the object identified in the message,
restore it using a separate command.

------------------------------------------------------------------------
ANS5266E

File-level copy restore of 'object name' failed.



Explanation:

Data files could not be copied from the local backup to their
destination, causing restore to fail.

System action:

Processing continues to another object, if multiple objects are selected
for restore.

User response:

Check the error log for more information from messages preceding this
one.

------------------------------------------------------------------------
ANS5267E

Disk Mapper module failed for the operation.



Explanation:

An underlying IBM Spectrum Protect operation has failed to perform the
operation due to a system error.

System action:

Processing stops.

User response:

Check the error log for more information from messages preceding this
one to identify cause of the failure. Contact IBM Spectrum Protect
administrator for more information.

------------------------------------------------------------------------
ANS5268W

The Microsoft Volume Shadow Copy Services writer 'name' current state
(state) is not valid for the current operation.



Explanation:

None.

System action:

The system will retry the operation automatically after thirty seconds
up to three times to allow the writer to return to the proper state. If
after three attempts the writer is still in the incorrect state, the
operation will fail.

User response:

Determine if there are other Volume Shadow Copy Services operations that
are occurring concurrently with the current operation.

------------------------------------------------------------------------
ANS5269E

The Microsoft Volume Shadow Copy Services writer 'name' current state
(state) is not valid for the current operation or cannot be determined.
The last error reported is 'error'.



Explanation:

None.

System action:

Processing stops.

User response:

Check the Microsoft event log to determine if there are any problems
with the writer.

------------------------------------------------------------------------
ANS5270E

A VSS restore request with timestamp 'time1' conflicts with a restore
request with timestamp 'time2'



Explanation:

A VSS restore request was issued which requires restoring multiple
components which reside in VSS backup documents with different backup
timestamps. For example, a user backs up Exchange storage group STG1 on
Monday and Exchange storage group STG2 on Tuesday. On Wednesday, the
user tries to restore STG1 and STG2.

System action:

Processing stops.

User response:

Resubmit the restore request as separate requests for each component.
For example, if you receive this error trying to restore Exchange
storage groups STG1 and STG2, resubmit a restore request for storage
group STG1 and a separate restore request for storage group STG2.

------------------------------------------------------------------------
ANS5271E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
before snapshot initialization.



Explanation:

None.

System action:

Processing stops.

User response:

See the IBM Spectrum Protect error logs for additional information.

One of the VSS writers is in an invalid or unexpected state. Try the
command "vssadmin list writers" and check the state of VSS writers.
Writers must be in STABLE state before IBM Spectrum Protect can continue
with VSS operations. Some of the writers can recover automatically from
minor errors. In most cases, restarting a writer solves the problem. The
easiest way to restart writers is to restart the operating system. It is
possible to restart the specific service that implements a VSS writer,
but it is difficult to determine which service to restart.

------------------------------------------------------------------------
ANS5272E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
after snapshot initialization.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5273E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
after taking a snapshot.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5274E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
after backup completion.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5275E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
before restore initialization.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5276E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
after preparing for a restore operation.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5277E

A Microsoft Volume Shadow Copy Services writer is in an invalid state
after restore termination.



Explanation:

None.

System action:

Processing stops.

User response:

See the error log for additional information.

------------------------------------------------------------------------
ANS5278W

Cannot detect all the original mount points because the number of
standard devices mounted 'device-number' is different than the number of
standard devices found in fstab and mtab files 'device-number'.



Explanation:

This is a requisite for the recognition of the standard devices.

System action:

The file restore operation continues.

User response:

Check that the devices are correct in the fstab and mtab of the virtual
machine guest.

------------------------------------------------------------------------
ANS5279E

Error processing 'filename': file not found.



Explanation:

The file being processed for backup, archive, or migrate, no longer
exists on the client. Another process deleted the file before it was
backed up, archived, or migrated by IBM Spectrum Protect.

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS5280E

Object enumeration from a file set or file list failed.



Explanation:

For more information, see the IBM Spectrum Protect client error log.
This message is always accompanied by error log message ANS5279E if the
object was not found or by ANS5250E for other causes, for example,
access was denied. These messages identify the object in question.

System action:

Processing stopped.

User response:

See the user response based on other messages in the client error log.

------------------------------------------------------------------------
ANS5281E

A remote backup failure has occurred. remote node name : node remote
address : address multi-node name : multi-node error message : msg
return code : rc



Explanation:

For more information, see the IBM Spectrum Protect client error log on
the remote system.

System action:

Processing stopped.

User response:

See the user response based on other messages in the client error log.

------------------------------------------------------------------------
ANS5282E

A remote backup failure has occurred.



Explanation:

For more information, see the IBM Spectrum Protect client error log.

System action:

Processing stopped.

User response:

See the user response based on other messages in the client error log.

------------------------------------------------------------------------
ANS5283E

The operation was unsuccessful.



Explanation:

None.

System action:

Processing stopped.

User response:

See the user response based on other messages in the client error log.

------------------------------------------------------------------------
ANS5284I

IBM Spectrum Protect has detected an incomplete setup! The client
options file 'dsm.opt' was not found, while the system options file
'file-path' exists! The wizard will guide you through the configuration
process of the initial basic IBM Spectrum Protect client options files
replacing your current option file. Would you like to continue?



Explanation:

IBM Spectrum Protect has detected an incomplete setup. The user options
file, dsm.opt, was not found. Additionally, a system options file,
dsm.sys, was found. To complete the configuration the configuration
wizard will create dsm.opt and replace dsm.sys with minimal settings.

System action:

IBM Spectrum Protect may stop

User response:

If the current version of dsm.sys is needed, rename the file and restart
IBM Spectrum Protect. If the current version is not needed, select yes
and allow IBM Spectrum Protect to replace the file.

------------------------------------------------------------------------
ANS5285E

The Microsoft Volume Shadow Copy Services (VSS) backup XML document is
not valid for restore. For more information, see the client error log.



Explanation:

Microsoft has released a Volume Shadow Copy Services (VSS) update in the
following operating system versions:

*  Windows 2003 update rollup package KB940349

*  Windows Vista Service Pack 1

This new VSS fix packages causes VSS to generates .xml control files in
a format which is not compatible with the earlier versions of VSS. This
error can occur when a system state restore is being performed from a
base operating system level which does not have the VSS fixes applied
and the system state backup files were created by an operating system
level that did have the VSS fixes applied.

System action:

Processing stops.

User response:

The restore procedure for Windows system state requires that the
operating system version and service pack level used to initiate the
restore be at the same operating system and service pack level used to
create the system state backup. In addition note the following:

*  On Windows 2003 systems you must also apply the VSS rollup package
   KB940349 prior to performing the Ssystem state restore.

*  On Windows Vista you must apply the same service pack that was
   installed at the time of backup prior to performing the system state
   restore.

------------------------------------------------------------------------
ANS5286I

The VSS Instant Restore operation was successful but some existing VSS
snapshots have been deleted by the VSS provider.



Explanation:

A successful VSS Instant Restore operation was performed for snapshot
volumes that were in a dependent relationship. In order for the restore
process to succeed, it was necessary to remove the snapshot volumes
causing the dependency. Those snapshot volumes typically represent newer
snapshot backups. This forced IBM Spectrum Protect to remove the backups
that included the deleted snapshots. This situation is typical when
using SAN Volume Controller (SVC) space-efficient volumes that have
multiple snapshots.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS5287W

VSS restore operation will be performed using VSS Fast Restore because
the XIV VSS Hardware Provider is at level 2.2.2.



Explanation:

XIV VSS Hardware Provider 2.2.2 has issues with VSS Instant Restore.
Please update the XIV VSS Hardware Provider to version 2.2.3, or later.

System action:

Processing continues.

User response:

Update XIV VSS Hardware Provider to version 2.2.3, or later.

------------------------------------------------------------------------
ANS5288W

Test flag DISCARDZEROFILEDATA enabled. Discarding data for zero length
object file-name



Explanation:

During the restore of a zero length file or directory, data was
decompressed. This data could be Extended Attributes, Alternate Streams,
or ACL data. By default this data is restored. Because the
DISCARDZEROFILEDATA test flag is set the data is discarded.

System action:

The data is discarded and processing continues

User response:

Note the file or directory name in this message and determine if the
discarded data needs to be reset through some other means.

------------------------------------------------------------------------
ANS5289W

The sequence of the devices is not correct and it is not possible to
identify all the original mount points. The volume 'volume' is not
consistent. The detection of the original mount points is stopped.



Explanation:

The correct order of the devices is required for the recognition of the
standard devices.

System action:

The detection of the original mount points is stopped. The file restore
operation continues.

User response:

Check that the devices are correct in the fstab and mtab files of the
virtual machine guest.

------------------------------------------------------------------------
ANS5290W

Devices of type 'device_type' are not supported. Skipping device
'device_name'.



Explanation:

The device detected is not supported.

System action:

The device for the target virtual machine is not mounted. The operation
continues.

User response:

Use a different type of device on the guest machine. Only
ext2,ext3,ext4,xfs, btrfs and reiserfs are supported devices.

------------------------------------------------------------------------
ANS5291E

An error occurred while attempting to delete the temporary linked clone
virtual machine 'linked clone name' (rc=return code). Check if this
virtual machine still exists and delete it manually.



Explanation:

It was not possible to delete the linked clone virtual machine. This
temporary virtual machine was created for file restore purposes to mount
a local snapshot. This virtual machine may have been manually renamed,
or accidentally modified or deleted.

System action:

The file restore cleanup operation continues.

User response:

Check if this virtual machine still exists and delete it manually.

------------------------------------------------------------------------
ANS5292E

A valid password file was not found for server 'server-name'. The
administrator for your system must run the backup-archive client and
enter the password to store it locally. Additionally, the administrator
needs to give the non-administrative user read access to the password
file.



Explanation:

The file containing the stored password for the specified server
server-name is unavailable.

System action:

Processing ends.

User response:

The administrator for your system must set and store a new password and
make the password file readable by the non-administrative user.

------------------------------------------------------------------------
ANS5293E

A valid password file was found for server 'server-name', but it does
not have read access granted to non-administrative users. The
administrator for your system needs to change the password files to
allow non-administrative users to read the files or the user needs to
become an authorized user.



Explanation:

The file containing the stored password for the specified server
server-name is not readable by non-administrative users.

System action:

Processing ends.

User response:

The administrator for your system must set the password files to be
readable by the non-administrative user.

------------------------------------------------------------------------
ANS5294E

The current user is not an IBM Spectrum Protect Authorized user. You
must be an IBM Spectrum Protect Authorized user to perform the current
operation.



Explanation:

In order to perform normal IBM Spectrum Protect operations you must be
an Authorized user. Please refer to the 'IBM Spectrum Protect UNIX and
Linux Backup-Archive Clients Installation and User's Guide' for details
configuring your environment to allow the system user to become an IBM
Spectrum Protect Authorized user.

System action:

Processing ends.

User response:

The administrator must update the dsm.sys options file to set the
PASSWORDDIR option to a location readable by the current user or to give
the current user read/write permissions to the password file.

------------------------------------------------------------------------
ANS5296I

The virtual machine 'vm-name' contains one or more virtual disks that
are of type Thick Eager Zero. Creating disks of this type can take a
long time. This restore operation might time out before the disks are
ready.



Explanation:

Restoring a VM that has Thick Eager Zero virtual disks can take a long
time to complete because the disks are zero-filled to obscure any
previous content. The time that is required to provision a Thick Eager
Zero disk depends on processing loads on the VMware resources (vCenter
and datastores).

System action:

None

User response:

Reattempt the restore operation at a time when the processing load is
light on the datacenter and vCenter resources

------------------------------------------------------------------------
ANS5298E

A Flashcopy background copy is in progress between source volume: and
target volume: .



Explanation:

A Flashcopy background copy from a previous operation is not complete
for the given source and target volumes.

System action:

Command will fail.

User response:

Please wait until the background copy is complete and retry the command.

------------------------------------------------------------------------
ANS5300E

Error detected in specified file list 'file list name' during processing
of line line number: found an invalid external object ID / inode number
/ inode generation number / restore order number / alias entry: 'invalid
entry'. Invalid line: 'invalid entry'



Explanation:

File list parsing failed because of an invalid entry.

System action:

The operation aborted because of an file list error.

User response:

Correct the invalid file list entry and restart the operation.

------------------------------------------------------------------------
ANS5301E

Error detected in specified file list 'file list name' during processing
of line line number: found an invalid ordering of external object IDs.
ext. object ID of previous file: previous external object ID ext. object
ID of current file: current external object ID



Explanation:

File list parsing failed because of an invalid ordering of the external
object IDs.

System action:

The operation aborted because of an file list error.

User response:

Correct the invalid file list ordering and restart the operation.

------------------------------------------------------------------------
ANS5302E

File list stream error to file 'file list name' detected during
processing of line line number.



Explanation:

File list processing failed because of an stream error.

System action:

The operation aborted because of an file list stream error.

User response:

Check the specified file list and restart the operation.

------------------------------------------------------------------------
ANS5303I

***** date Processed count IBM Spectrum Protect server and count file
list objects *****



Explanation:

IBM Spectrum Protect has processed the specified number of IBM Spectrum
Protect server and file list objects.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS5304E

program-name: synchronous file deletion failed for external object ID:
external object ID.



Explanation:

The HSM client could not delete an object on the IBM Spectrum Protect
Server.

System action:

The current file is skipped for synchronous file deletion and the
process will continue.

User response:

Check the IBM Spectrum Protect server log file.

------------------------------------------------------------------------
ANS5307E

The session is rejected. The server does not allow a signon of a client
that is not enabled for space-management retention-protection.



Explanation:

The client cannot establish a connection to the server because the
server is enabled for space-management retention-protection and the
client is not.

System action:

The session is not started.

User response:

See your system administrator.

------------------------------------------------------------------------
ANS5308W

No matching NAS nodes were found on the server.



Explanation:

You tried to start a backup or restore of a NAS system but the IBM
Spectrum Protect client was not able to find a corresponding node on the
server that is configured to access the NAS system.

System action:

The NAS backup or restore window will be closed.

User response:

See your IBM Spectrum Protect administrator for assistance in
associating your node with a NAS node that has the authority to access
the NAS system on the server. Then try the operation again.

------------------------------------------------------------------------
ANS5821E

Cannot connect to Active Directory.



Explanation:

IBM Spectrum Protect could not connect to Active Directory. The Active
Directory is either not running or you don't have enough permissions to
use it.

System action:

Processing stops.

User response:

Make sure your system is set up as Active Directory controller and the
the service is active. Make sure you are logged in as a user with
sufficient rights to administer the Active Directory.

------------------------------------------------------------------------
ANS5822E

No Active Directory objects match query.



Explanation:

A search has been performed in Active Directory; however, no objects
matching the query were found.

System action:

Processing stops.

User response:

Make sure you specify a valid distinguished name of Active Directory
object or a container, or a valid wildcarded name, and that you have
sufficient rights to administer the Active Directory.

------------------------------------------------------------------------
ANS5823W

Object exists, skipping



Explanation:

The client tried to restore the specified object, but the object already
existed in the target restore location and the user chose not to replace
the existing object.

System action:

The object is skipped, a message is logged in dsmerror.log, and restore
processing continues with the next object.

User response:

The object was skipped because either REPLACE NO was in effect, causing
all existing objects to be skipped, or REPLACE PROMPT was in effect, and
when prompted, the user chose to skip this object. No additional action
is necessary if the decision to skip the object was deliberate.
Otherwise the operation can be retried using either REPLACE ALL
(automatically replace existing object) or REPLACE PROMPT (prompt the
user whether to replace the object).

------------------------------------------------------------------------
ANS5824E

Invalid Active Directory search specification.



Explanation:

The search specification for Active Directory objects is not valid.

System action:

Processing stops.

User response:

Refer to the documentation for supported Active Directory syntax.

------------------------------------------------------------------------
ANS5825E

Reanimate 'tombstone-name' to 'distinguished-name' failed. See the error
log for more details.



Explanation:

An attempt to reanimate Active Directory tombstone object has been
performed, but an error occurred.

System action:

Processing continues to process all other tombstone objects per user's
request.

User response:

None.

------------------------------------------------------------------------
ANS5826E

Restoring to a read-only domain controller is not allowed.



Explanation:

An attempt to restore to a read-only domain controller.

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS5827E

A backup copy of the Active Directory database was not found.



Explanation:

An attempt to restore Active Directory objects from a database that was
not backed up.

System action:

Processing stops.

User response:

Verify the Active Directory was backed up with system state.

------------------------------------------------------------------------
ANS5828E

A system state file space was not found on the server. Active Directory
functions can not be executed.



Explanation:

An attempt to restore the Active Directory database from a system state
backup that does not exist.

System action:

Processing stops.

User response:

Verify that system state was backed up or back up the system state then
retry the command.

------------------------------------------------------------------------
ANS5829E

A system state backup on the specified date was not found. Active
Directory functions can not be executed.



Explanation:

An attempt to restore the Active Directory database from a system state
backup that does not exist.

System action:

Processing stops.

User response:

Verify that system state was backed up on the specified date or specify
a new date.

------------------------------------------------------------------------
ANS5830E

Restore of object 'tombstone-name' is not allowed by Active Directory.



Explanation:

Object of certain types cannot be restored. This is a system limitation.

System action:

Processing continues to process all other objects per user's request.

User response:

None.

------------------------------------------------------------------------
ANS5831E

Restore for this object is not allowed by Active Directory.



Explanation:

Object of certain types cannot be restord. This is a system limitation.

System action:

Processing continues to process all other objects per user's request.

User response:

None.

------------------------------------------------------------------------
ANS5832E

Reanimate tombstone object failed. See the error log for more details.



Explanation:

An attempt to reanimate Active Directory tombstone object has been
performed, but an error occurred.

System action:

Processing continues to process all other tombstone objects per user's
request.

User response:

None.

------------------------------------------------------------------------
ANS5833E

This system is a Domain Controller but the Active Directory service is
stopped. You can not perform the operation unless the Active Directory
service is running.



Explanation:

The Active Directory service must be running when you back up or restore
the system state or operate on Active Directory objects. When the Active
Directory service is running, it can be in online state or in offline
state. When you query or restore Active Directory objects, or back up
the system state, the Active Directory service must be online. When you
restore the system state, the Active Directory service must be offline
(but not stopped).

System action:

Processing stopped.

User response:

If you are querying or a restoring the Active Directory objects or
backing up the system state, put the Active Directory service in online
state by starting the Active Directory service. If you are restoring the
system state, put the Active Directory service in offline state by
rebooting to the Active Directory Restore Mode. When the Active
Directory service is in the appropriate state, retry the operation.

------------------------------------------------------------------------
ANS5834E

Unexpected LDAP error occurred. See the error log for more details.



Explanation:

An unexpected error occurred during Active Directory tombstone
reanimation.

System action:

Processing continues to process all other tombstone objects per user's
request.

User response:

Check the error log for detailed information on the LDAP error.

------------------------------------------------------------------------
ANS5835E

An LDAP operation returned return code: 'error string'



Explanation:

An unexpected error occurred during Active Directory tombstone
reanimation.

System action:

Processing continues to process all other tombstone objects per user's
request.

User response:

None.

------------------------------------------------------------------------
ANS5836W

One or more attributes were not restored. See the error log.



Explanation:

During processing of an Active Directory object, one or more object
attributes could not be restored.

System action:

Processing continues to process all other Active Directory objects per
user's request.

User response:

Check the error log for detailed information on which attribute(s) could
not be restored.

------------------------------------------------------------------------
ANS5837W

'object name': attribute 'attribute name' could not be restored.



Explanation:

The listed attribute could not be restored during processing on the
Active Directory object.

System action:

Processing continues to process all other Active Directory objects per
user's request.

User response:

None.

------------------------------------------------------------------------
ANS5838E

The utility dsamain.exe does not exist on the system. You cannot perform
the operation unless IBM Spectrum Protect can launch this utility.



Explanation:

You attempted to launch dsamain.exe, but the utility does not exist.

System action:

Processing stopped.

User response:

Verify that the dsamain.exe utility exists in the Windows system32
directory. When you can run the utility independently of IBM Spectrum
Protect, retry the operation.

------------------------------------------------------------------------
ANS5839E

The Active Directory object specification is not allowed.



Explanation:

You attempted to restore the domain object (starting with "DC="), or you
attempted to restore all objects ("name=*"), or you did not specify
anything.

System action:

Processing stops.

User response:

Modify the specification then retry the operation.

------------------------------------------------------------------------
ANS5840E

The current user is not a member of the Administrators group, and cannot
perform this function.



Explanation:

You must be a member of the Administrators group to perform the Active
Directory objects function.

System action:

Processing stops.

User response:

Log on with a user who is a member of the Administrators group or add
this user to the Administrators group then retry the operation.

------------------------------------------------------------------------
ANS5841E

Active Directory database could not be opened.



Explanation:

An error occurred while opening the restored Active Directory database.

System action:

Processing stopped.

User response:

Make sure ntdsutil.exe utility is located in the same directory with IBM
Spectrum Protect client executables. If it doesn't exist, reinstall the
client. Verify that the dsamain.exe utility exists in the Windows
system32 directory. When you can run the utility independently of IBM
Spectrum Protect, retry the operation. If the problem persists, contact
the support.

------------------------------------------------------------------------
ANS5842E

'tombstone-name': object class violation.



Explanation:

Object class error violation occurred during tombstone reanimation. This
can happen if the Active Directory schema was modified and is no longer
compatible with the tombstone.

System action:

Processing continues to process all other objects per user's request.

User response:

Recreate the failing object manually or restore it from a backup.

------------------------------------------------------------------------
ANS5843E

Object class violation.



Explanation:

Object class error violation occurred during tombstone reanimation. This
can happen if the Active Directory schema was modified and is no longer
compatible with the tombstone.

System action:

Processing continues to process all other objects per user's request.

User response:

Recreate the failing object manually or restore it from a backup.

------------------------------------------------------------------------
ANS5844E

Unable to update password.



Explanation:

An error occurred during the password update attempt.

System action:

The password is not updated on the server.

User response:

Try to update the password again.

------------------------------------------------------------------------
ANS5845E

Unable to update password because the maximum number of update attempts
has been exceeded.



Explanation:

This message is issued after making 3 unsuccessful attempts to update
the password. The original password for the node was entered
incorrectly; the new password does not meet the length or valid
character requirements for our passwords; or there was a mismatch
between the first and second times the new password was entered.

System action:

The password is not updated.

User response:

*  Make sure the original password is entered correctly. Contact your
   IBM Spectrum Protect administrator for further assistance if you do
   not know the original password.

*  Make sure the new password meets the password length and character
   requirements.

*  You will be prompted to enter the new password two times, so make
   sure it is entered correctly both times.

------------------------------------------------------------------------
ANS5876I

SET EVENT Activate Retention completed



Explanation:

The Data Retention ACTIVATE transaction has completed.

System action:

IBM Spectrum Protect activated the objects that were selected.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5877I

SET EVENT Hold completed



Explanation:

The Data Retention HOLD transaction has completed.

System action:

IBM Spectrum Protect held the objects that were selected.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS5878I

SET EVENT Release completed



Explanation:

The Data Retention RELEASE transaction has completed.

System action:

IBM Spectrum Protect released the objects that were selected.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS6586E

Recovery Agent operation failed.



Explanation:

The Recovery Agent operation on a VMVSS snapshot failed.

System action:

Processing stops.

User response:

Check the Recovery Agent logs and error messages, resolve the problem,
and try the operation again.

------------------------------------------------------------------------
ANS6587W

VMVSS backup failed to back up Exchange mailbox history from virtual
machine 'VM-Name'.



Explanation:

An error occurred when a data mover tried to back up the Exchange
mailbox history from a virtual machine. The current version of Data
Protection for Exchange might not support uploading mailbox history at
the same time as a virtual machine backup. The error code indicates the
reason for the failure.

System action:

Processing continues without backing up the mailbox history information.

User response:

Try to back up mailbox history on guest vm by using Data Protection for
Exchange command 'tdpexcc.exe backup * full /UpdateMailboxInfoOnly'.
Upgrade Data Protection for Exchange if the current product level does
not support mailbox history backup command. Use traceflags VMTSMVSS in
data mover dsm.opt file to further diagnose the problem.

------------------------------------------------------------------------
ANS6718E

The path contains too many nested subdirectories. The maximum number of
nested directories is 1400.



Explanation:

To avoid exhausting system resources, the client stops processing
directory structures that exceed the maximum nesting depth. Directories
that exceed the maximum nesting depth are not typical.

System action:

Processing of the current operation is stopped.

User response:

Determine whether the directory is valid. Directory structures of this
depth are not typical, and could indicate a problem with the file system
structure. An example of such a directory is if the directory is
cyclical. If the directory is not valid, remove or repair the directory,
then try the operation again. If the directory is valid, reduce the
depth of the directory structure. Then try the operation again.
Alternatively you can use an EXCLUDE.DIR statement to exclude the
directory from backup or archive processing. Then try the operation
again.

------------------------------------------------------------------------
ANS7421W

The archive attribute for file filename cannot be reset. The return code
from Windows API function SetFileAttributes() is rc.



Explanation:

The client was unable to reset the archive attribute for the file
indicated in the message. This error is due to an error received from
the Windows API function SetFileAttributes().

System action:

processing stops.

User response:

Try the operation again. If the problem persists, it may be indicative
of a problem with the file. Contact your system administrator or IBM
Spectrum Protect administrator for further assistance.

------------------------------------------------------------------------
ANS7422E

Unsupported action 'action' in schedule 'schedule name'.



Explanation:

The scheduled action is unknown to the current version of the IBM
Spectrum Protect client and cannot be performed by means of a schedule.
The most likely cause is that the scheduled action requires a later
version of the backup-archive client. The unsupported action is
displayed as a number because the text description is not available.
Scheduled actions and their corresponding action number can be found by
searching for this message on the IBM Spectrum Protect support site.

System action:

The scheduled action is not performed or queried.

User response:

Search the IBM Spectrum Protect support site for this message to find
information about scheduled actions, their corresponding action numbers
and the client version at which the action is supported. Then upgrade
your IBM Spectrum Protect client to a version that supports running this
action as a scheduled event. Until the client is upgraded, you can run
the action manually if your version of the client supports it.

------------------------------------------------------------------------
ANS7423E

Use Set Access backup <vmname> -TYPE=VM for VMware backup file spaces.
Use of the long form fs-name is not allowed.



Explanation:

You have chosen to set access using the long-form VM file space name.
This name format is not platform independent and requires special
processing. Use the -TYPE=VM option and supply only the VM name.

System action:

The set access command is not processed.

User response:

Enter the set access command using the -TYPE=VM option and the short
form of the VM file space name which is simply the VM name.

------------------------------------------------------------------------
ANS7500W

Object 'object-name' could not be bound to management class
'mgmt-specified' specified in an 'option' statement.



Explanation:

The management class specified in an include statement was not valid. If
the include statement is an "INCLUDE.SIZE" statement the warning message
will be issued if an appropriate copygroup is defined for the management
class. For example, this warning will be issued on a backup operation if
no backup copygroup is defined for the management class or this message
will be issued on an archive operation if no archive copygroup is
defined for the management class.

System action:

The management class on the include statement is ignored and processing
continues.

User response:

Contact the IBM Spectrum Protect administrator to correct the
appropriate copygroup definition on the IBM Spectrum Protect Server.

------------------------------------------------------------------------
ANS7501E

An invalid host address was received. Host address is too long.



Explanation:

An invalid host parameter was found in the HTTP Request. The parameter
is too long. The maximum length for a host address is 64 characters.

System action:

IBM Spectrum Protect returns HTTP error code 400 Bad Request.

User response:

Use a host machine with a valid/shorter host address.

------------------------------------------------------------------------
ANS7502E

An invalid filename was received. Filename is too long.



Explanation:

A filename passed to the dsmcad service is too long and thus invalid.

System action:

IBM Spectrum Protect returns HTTP error code 400 Bad Request.

User response:

Retry connecting to dsmcad but use a valid/shorter filename.

------------------------------------------------------------------------
ANS7507W

The node name entry is invalid. Please try again.



Explanation:

An invalid entry is entered on the Node Name field.

System action:

IBM Spectrum Protect prompts you to enter a valid node name.

User response:

Enter a valid node name or see your system administrator for the correct
syntax.

------------------------------------------------------------------------
ANS7510E

A NAS node cannot be used for this operation.



Explanation:

NAS nodes cannot be used for operations like Access Another Node.

System action:

IBM Spectrum Protect prompts you to enter a valid node name.

User response:

Enter a valid, non-NAS, IBM Spectrum Protect node name.

------------------------------------------------------------------------
ANS7524E

SSL is required.



Explanation:

SSL is required to protect the client password during authentication.

System action:

Processing terminates.

User response:

Enable SSL communication or set SSLREQUIRED to NO.

------------------------------------------------------------------------
ANS7525E

SSL is required by server.



Explanation:

SSL is required to protect the client password during authentication.

System action:

Processing terminates.

User response:

Enable SSL communication or contact your IBM Spectrum Protect server
administrator.

------------------------------------------------------------------------
ANS7526E

The SNAPSHOTROOT option is not valid with either of the following
options: -GROUPNAME and -VIRTUALFSNAME.



Explanation:

The SNAPSHOTROOT option is incompatible with the -GROUPNAME and
-VIRTUALFSNAME options and cannot be used with either one of those
options.

System action:

Processing stops.

User response:

For information about backup-archive client processing options, see IBM
Spectrum Protect Backup-archive Clients Installation and User's Guide.

------------------------------------------------------------------------
ANS7527E

The (-SNAPSHOTROOT) option is not valid in conjunction with num-specs
file specifications.



Explanation:

The (-SNAPSHOTROOT) option must be used in conjunction with only one
file specification. It cannot be used with zero file specification
(e.g., an INCREMENTAL command with no file specifications) or with more
than one file specification.

System action:

Processing stopped.

User response:

See the appropriate Using the Backup-Archive Client book for your
operating system for correct use of the named option.

------------------------------------------------------------------------
ANS7528E

The (-SNAPSHOTROOT) option for GPFS fileset is not valid without
filelist



Explanation:

The (-SNAPSHOTROOT) option for GPFS fileset is only supported using a
filelist.

System action:

Processing stopped.

User response:

See the appropriate Using the Backup-Archive Client book for your
operating system for correct use of the named option.

------------------------------------------------------------------------
ANS7529E

The specified SNAPSHOTROOT 'obj-name' is not valid for the BACKUP IMAGE
command.



Explanation:

When you use the (-SNAPSHOTROOT) option with the BACKUP IMAGE command,
SNAPSHOTROOT must specify the device name of the logical volume
containing the snapshot for the backup. An example is /dev/fslv01 (on
Unix) or \\?\GLOBALROOT\Device\HarddiskVolumeShadowCopy1 (on Windows).

With BACKUP IMAGE, SNAPSHOTROOT cannot be used unless
SNAPSHOTPROVIDERIMAGE has one of the following values in effect:

*  VSS

*  JFS2



System action:

Processing is stopped.

User response:

For the correct use of the (-SNAPSHOTROOT) option, see the appropriate
Backup-Archive Client Installation and User's Guide book for your
operating system.

------------------------------------------------------------------------
ANS7531E

The (-SNAPSHOTROOT) option is invalid when processing the NetWare NDS or
Server Specific Information.



Explanation:

The (-SNAPSHOTROOT) option is only intended with NetWare file server
volumes and is not compatible with processing the NDS or Server Specific
Information on NetWare.

System action:

Processing stopped.

User response:

See the appropriate Using the Backup-Archive Client book for your
operating system for correct use of the named option.

------------------------------------------------------------------------
ANS7533E

The specified file system 'obj-name' does not exist or is not local.



Explanation:

When you use the (-SNAPSHOTROOT) option, the target and source file
systems must be valid, local file systems. The file systems cannot be
non-local, such as a remote NetWare drive, a remote Windows drive, or an
NFS mount. The (-SNAPSHOTROOT) option is valid for local operations
only.

System action:

Processing is stopped.

User response:

For the correct use of the (-SNAPSHOTROOT) option, see the appropriate
Backup-Archive Client Installation and User's Guide book for your
operating system.

------------------------------------------------------------------------
ANS7534W

Initialization functions cannot open /dev/tty special file. errno =
errno-value, error message



Explanation:

Special file /dev/tty, required by command line internal editor could
not be opened during initialization. The system set the error code
errno-value.

System action:

Processing continues as if EDITOR option was set to NO.

User response:

Check your terminal settings.

------------------------------------------------------------------------
ANS7535W

Command line internal editor can not be initialized.



Explanation:

EDITOR option is set to YES in the options file, but command line
internal editor can not be started.

System action:

Processing continues as if EDITOR option was set to NO

User response:

Check previous messages to determine the reason why the internal editor
could not be started.

------------------------------------------------------------------------
ANS7543E

Error: Scout is not available for object query. Either scout is not
running or the initial file system scan has not finished.



Explanation:

The scout daemon must be running for the reconcile process to do a query
for all migrated files. If the scout daemon is not running or the
initial file system scan has not finished you cannot run the reconcile
tool in orphan check mode.

System action:

Processing stops.

User response:

Ensure that the scout daemon is running. If the scout daemon is not
running, restart it and retry the command. If the scout daemon is
running, wait until it finishes the initial file system scan. You can
check the current status of the scout daemon by using the dsmscoutd
scanplan command.

------------------------------------------------------------------------
ANS7544E

ICC routine icc-routine failed with the following error: "error-string".



Explanation:

There was an error within ICC cryptography library while processing the
data. For example, this problem can occur when encrypted client data is
corrupted, so the restore operation cannot correctly decrypt it. This
message reports an error code and problem description which can be used
by IBM Spectrum Protect technical support personnel to determine the
cause of the failure.

System action:

The processing stops.

User response:

Ensure IBM Spectrum Protect software is installed correctly. If needed,
reinstall the software. Make sure you use the correct encryption key
password for the data. Make sure there are no IBM Spectrum Protect
server or network problems that may affect the transfer of data. If the
problem still exists, contact IBM Spectrum Protect technical support.

------------------------------------------------------------------------
ANS7545E

Unexpected error while encrypting the data.



Explanation:

There was an error while encrypting the data. See the error log for more
information.

System action:

The object is not backed up.

User response:

Ensure IBM Spectrum Protect software is installed correctly. If needed,
reinstall the software. Retry the operation. If the problem still
exists, contact IBM Spectrum Protect technical support.

------------------------------------------------------------------------
ANS7546E

Unexpected error while decrypting the data.



Explanation:

There was an error while decrypting the data. See the error log for more
information. This can happen if the encrypted data has been corrupted
while in storage, during the network transfer, or both.

System action:

The object is not restored.

User response:

Ensure IBM Spectrum Protect software is installed correctly. If needed,
reinstall the software. Make sure there are no IBM Spectrum Protect
server or network problems that may affect the transfer of data. Retry
the operation. If the problem still exists, contact IBM Spectrum Protect
technical support.

------------------------------------------------------------------------
ANS7547E

Unexpected error while digesting the data.



Explanation:

There was an error while digesting the data. See the error log for more
information.

System action:

The object is not backed up.

User response:

Ensure IBM Spectrum Protect software is installed correctly. If needed,
reinstall the software. Retry the operation. If the problem still
exists, contact IBM Spectrum Protect technical support.

------------------------------------------------------------------------
ANS7550E

The absolute option requires using the CreateNewBase=yes option when
performing a snapshot differential backup.



Explanation:

The absolute option specified does not have any effect when performing a
snapshot differential backup.

System action:

Processing stopped.

User response:

Try to use the CreateNewBase=yes option when performing a snapshot
differential backup.

------------------------------------------------------------------------
ANS7552I

timestamp ***** Processed count files *****



Explanation:

IBM Spectrum Protect has processed the specified number of files.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS7553W

Disabled demand migration (ENOSPC) on file system file-system-name
because of high threshold, low threshold, and pmpercentage settings.



Explanation:

The settings of high threshold = 100, low threshold = 100, and
pmpercentage = 0 are reserved to disable demand migration and
automigration. Used for GPFS driven migration.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS7554E

provider option is required if HSMBACKENDMODE is set to TSMFREE.



Explanation:

You need to specify provider option for every operation with dsmmigrate.

System action:

The operation stopped.

User response:

Specify the provider option value for the operation.

------------------------------------------------------------------------
ANS7557E

invalid provider.



Explanation:

You need to specify a valid provider for every operation with
dsmmigrate.

System action:

The operation stopped.

User response:

Specify a valid provider option value for the operation.

------------------------------------------------------------------------
ANS7558E

target option is required if HSMBACKENDMODE is set to TSMFREE.



Explanation:

You need to specify target option for every operation with dsmmigrate.

System action:

The operation stopped.

User response:

Specify the target option value for the operation.

------------------------------------------------------------------------
ANS7559E

The absolute option requires specifying the NoJournal option when
performing a Journal Based Backup for backing up fs .



Explanation:

The absolute option specified does not have any effect when performing
journal based backups.

System action:

Incremental backup is performed.

User response:

Verify that the file spaces specified are not associated with journal
based backup. If the -nojournal option is also specified, then this
message will not appear.

------------------------------------------------------------------------
ANS7566E

Unable to load external library: reason



Explanation:

There is no valid library in hsm/bin directory.

System action:

The operation stopped.

User response:

Copy a valid external library to hsm/bin directory.

------------------------------------------------------------------------
ANS7567E

program-name:External recall failed! Reason:



Explanation:

There is no valid library in hsm/bin directory.

System action:

The operation stopped.

User response:

Copy a valid external library to hsm/bin directory.

------------------------------------------------------------------------
ANS7641I

The user does not have administrative credentials to perform a full
system state backup.



Explanation:

The user account used to perform system state backup including ASR
Writer data must be a member of the Administrators group.

System action:

System state backup skips ASR Writer data.

User response:

Log on with a user who is a member of the Administrators group or add
this user to the Administrators group. Then try the system state backup
again.

------------------------------------------------------------------------
ANS7642E

An error occurred creating the registry directory structure.



Explanation:

An error occurred while creating the directory structure to save or
replace a registry key.

System action:

Registry function fails.

User response:

Ensure that the user account that is running the backup of the registry
has the proper authority. If the user account has the proper authority,
you might need to restart the machine. There might be operations that
are pending which have a file or files in the registry directory
structure locked.

------------------------------------------------------------------------
ANS7650E

The user does not have sufficient privileges to execute IBM Spectrum
Protect.



Explanation:

The user account used to execute IBM Spectrum Protect must have the
"Back up files and directories" and the "Restore files and directories"
security settings assigned.

System action:

Processing stops.

User response:

Assign the "Back up files and directories" and the "Restore files and
directories" security settings to the account using the Windows Local
Security Settings tool or use a different user-id to execute IBM
Spectrum Protect.

------------------------------------------------------------------------
ANS7660E

An error occurred replacing one or more registry keys.



Explanation:

The registry key or keys being replaced are exclusively held by another
process. The registry keys were previously restored but the system was
not restarted.

System action:

processing stops.

User response:

Restart the system and try the restore operation again.

------------------------------------------------------------------------
ANS7709E

Restore operation failed. Not all files were restored.



Explanation:

Restore operation failed due to an error.

System action:

Operation completed.

User response:

Check the error log for more details.

------------------------------------------------------------------------
ANS7899E

The client referenced a deduplicated extent that does not exist on the
IBM Spectrum Protect server



Explanation:

The deduplicated extent has been deleted from the server during the
backup or archive operation. If you are using deduplication cache, it
might be out of synch with the IBM Spectrum Protect server.

System action:

The processing stops.

User response:

Retry the operation. If the problem persists, turn off deduplication and
retry the operation.

------------------------------------------------------------------------
ANS7900I

Deduplication cache has been reset because it is not synchronized with
the IBM Spectrum Protect server



Explanation:

The deduplication cache contains deduplicated extent entries that do not
exist on the IBM Spectrum Protect server. This occurs when the extents
are deleted from the IBM Spectrum Protect server after they were
recorded in the deduplication cache.

System action:

The deduplication cache is reset, and all cache entries are removed. The
processing continues.

User response:

None

------------------------------------------------------------------------
ANS7901W

Client deduplication and option-name are mutually exclusive.



Explanation:

The following features cannot be used with deduplication: lan-free,
subfile, NAS, useTsmBuffers.

System action:

Client deduplication is disabled.

User response:

Review the configuration. Do not configure deduplication with the
lan-free, subfile, NAS, or useTsmBuffers features.

------------------------------------------------------------------------
ANS7902I

Client deduplication cache is full. Cache is reset.



Explanation:

The number of entries cached in the client deduplication cache has
exceeded the configured size for the cache.

System action:

The deduplication feature is designed so that this happens periodically.
The cache is reset to no entries.

User response:

You can reconfigure the client deduplication cache size to a larger
value to reduce the frequency of resets.

------------------------------------------------------------------------
ANS7903W

Client deduplication cache is locked by another process.



Explanation:

Another process is using the client deduplication cache. Only one
process may use it at a time.

System action:

This process does not use the client deduplication cache. The server
deduplication is not changed.

User response:

You can serialize processes using the client deduplication cache. Or you
can reconfigure the current process to use a different cache path to
avoid contention.

------------------------------------------------------------------------
ANS7904E

Client deduplication and lan-free or subfile backup are mutually
exclusive.



Explanation:

Client deduplication and lan-free or subfile are mutually exclusive.

System action:

Client deduplication is disabled.

User response:

Review the configuration. Do not configure deduplication with the
lan-free or subfile feature.

------------------------------------------------------------------------
ANS7906W

The current storage pool either ran out of space or the current object
exceeded the maxsize configuration parameter for the storage pool, data
will be stored into the next pool - deduplication is disabled.



Explanation:

The current storage pool on the IBM Spectrum Protect server is either
out of space or the current object exceeded the maxsize configuration
parameter for the storage pool . Data will be stored in the next storage
pool. Deduplication is disabled and the transaction is being resent.

System action:

Deduplication is disabled to allow the backup to complete.

User response:

Contact your system administrator to add volumes to the current storage
pool.

------------------------------------------------------------------------
ANS7907W

Connection to repository repos-name failed. Retrying with repos2-name.



Explanation:

Unable to connect to the FastBack DR Hub repository. Retry using
FastBack server repository.

System action:

Retry operation.

User response:

Specify a vaild repository.

------------------------------------------------------------------------
ANS7908E

Unable to mount FastBack snapshot policy 'Policy' client 'Client' volume
'Volume'. Reason: reason



Explanation:

IBM Spectrum Protect Mount failed.

System action:

IBM Spectrum Protect cannot continue processing.

User response:

Check the Recovery Agent logs for information about why the mount
operation failed to complete.

------------------------------------------------------------------------
ANS7912E

FastBackMount or FastBackShell is not installed.



Explanation:

Failure initializing FastBack environment. FastBackShell or
FastBackMount are not installed or are not located in the FastBack
install directory.

System action:

The FastBack operation cannot continue.

User response:

Reinstall the software. The FastBackShell and FastBackMount must be
installed on the dedicated proxy computer.

------------------------------------------------------------------------
ANS7913E

The given branch was not found in the DR Hub repository.



Explanation:

The parameter to the required fbbranch option is incorrect.

System action:

The operation cannot continue.

User response:

Correct the parameter given for the fbbranch option.

------------------------------------------------------------------------
ANS7914E

Incremental backup of FastBack client 'vmname' failed with RC rc



Explanation:

The archive or incremental backup of FastBack client volumes failed.

System action:

The archive or backup of FastBack client finished with failures. The
next FastBack client will be processed. The reason for the failure is
written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS7915E

Failure mounting FastBack client 'vmname' with FastBack command. RC=rc



Explanation:

The FastBackMount command failed to mount a FastBack volume.

System action:

The archive or backup of the FastBack volume can not continue. The next
Volume in in line will be processed. The output of the FastBackMount
command will show the reason for the failure.

User response:

Check the local client error log for the reason for the failure. Issue a
FastBack command for the FastBack volume to determine the reason for the
failure. Refer to the documentation for that message for more
information.

------------------------------------------------------------------------
ANS7916E

Failure initializing FastBack environment.RC=rc



Explanation:

Failure initializing FastBack environment. Can not find
FastBackShell.exe command. The FastBackShell or FastBackMount is not
installed or FastBackShell.exe command is not located in the FastBack
install directory.

System action:

The backup can not continue. The output of the FastBack command will
show the reason for the failure.

User response:

Issue a FastBack command to determine the reason for the failure. Refer
to the documentation for that message for more information. The
FastBackShell and FastBackMount must be installed on the backup proxy
computer.

------------------------------------------------------------------------
ANS7917E

No FastBack snapshots found for input policy, client and volume
combination.



Explanation:

Failure processing fbClientName option.

System action:

The backup cannot continue.

User response:

Check for errors in the FBClientName option value. Refer to the
documentation for the FBClientName option for more information.

------------------------------------------------------------------------
ANS7918E

Failure locating mounted volumes for FastBack client 'vmname' volumes.
Failed with RC=rc



Explanation:

FastBack client volumes can not be found. Volume mount points are not
available on the backup proxy computer.

System action:

The backup of the FastBack client can not continue. The next FastBack
client in the list will be processed. The output of the FastBackMount
command will show the reason for the failure.

User response:

Issue a fastbackshell mount add command for the FastBack client volume
to determine the reason for the failure. Refer to the documentation for
that message for more information.

------------------------------------------------------------------------
ANS7919E

Password for Host host could not be read from encrypted password file.



Explanation:

Use dsmc SET PASSWORD -type=FastBack 'FastBack hostname' 'userid'
'password' to save encrypted password

System action:

The backup cannot continue.

User response:

Use dsmc SET PASSWORD -type=FastBack 'FastBack hostname' 'userid'
'password' to save encrypted password

------------------------------------------------------------------------
ANS7936E

objType objName not found in dump.



Explanation:

IBM Spectrum Protect server could not find the object that is specified
in the FastBack Dump command..

System action:

IBM Spectrum Protect skips the current object.

User response:

Ensure that there is at least one snapshot for this FastBack volume,
client, and policy. Ensure that a correct object is specified as input.

------------------------------------------------------------------------
ANS7937E

No objType found in dump for input objType1 objType2.



Explanation:

IBM Spectrum Protect server found no clients for the specified policy.
IBM Spectrum Protect server found no volumes for the specified FastBack
client.

System action:

IBM Spectrum Protect skips the current object.

User response:

Ensure that there is at least one snapshot for this FastBack volume,
client, and policy. Ensure that a correct object is specified as input.

------------------------------------------------------------------------
ANS7938E

Unable to dismount FastBack volume 'volName'. RC = rc



Explanation:

IBM Spectrum Protect Dismount failed.

System action:



User response:



------------------------------------------------------------------------
ANS7939E

Invalid FastBack volume specification.



Explanation:

You must enter at least one FastBack client with the "-fbclientname="
option before entering a FastBack volume name.

System action:



User response:

When entering a FastBack volume name, enter at least one FastBack client
name using the "-fbclientname=" option.

------------------------------------------------------------------------
ANS7940W

SUBDIR NO is not valid in this context. SUBDIR will be forced to YES for
FastBack commands.



Explanation:

When using FastBack, SUBDIR is forced to YES to ensure that the whole
volume is processed.

System action:

SUBDIR is forced to YES.

User response:

To avoid this message, do not use SUBDIR NO with the command.

------------------------------------------------------------------------
ANS7941E

FastBack invalid repository name or domain not set in password file
entry for hostname.



Explanation:

IBM Spectrum Protect The FastBack repository name is invalid or the
domain has not been set in the password file when specifying the REP
form of the repository.

System action:

IBM Spectrum Protect

User response:

Issue the command dsmc set password server userid:domain password
-type=fastback.

------------------------------------------------------------------------
ANS7942E

Maximum number of FastBack objName objects exceeded.



Explanation:

IBM Spectrum Protect The maximum number of FastBack objects shown in the
message has been exceeded.

System action:

IBM Spectrum Protect

User response:

Re-run the command with no more than the maximum number of objects
specified.

------------------------------------------------------------------------
ANS7943E

The combination of objName and objName is invalid.



Explanation:

IBM Spectrum Protect The combination of options specified is invalid.

System action:

IBM Spectrum Protect

User response:

Re-run the command with a compatible set of options.

------------------------------------------------------------------------
ANS7944W

The number of FastBack clients specified client is greater than the
number of FastBack clients found client.



Explanation:

IBM Spectrum Protect One or more of the FastBack clients specified was
not found. Look for message ANS7936E specifying the client name.

System action:

IBM Spectrum Protect

User response:

Correct the names of the clients specified.

------------------------------------------------------------------------
ANS7945W

The number of FastBack policies specified policy is greater than the
number of FastBack policies found policy.



Explanation:

IBM Spectrum Protect One or more of the FastBack policies specified was
not found. Look for message ANS7936E specifying the policy name.

System action:

IBM Spectrum Protect

User response:

Correct the names of the policies specified.

------------------------------------------------------------------------
ANS7946E

FastBack shell command timeout.SSH Keys may not be configured for no
password.



Explanation:

IBM Spectrum Protect The FastBack shell command timeout. SSH may not be
configured properly.

System action:

IBM Spectrum Protect

User response:

Correct SSH configuration.

------------------------------------------------------------------------
ANS7947E

The root user .ssh directory was not found. SSH is not configured
properly.



Explanation:

IBM Spectrum Protect SSH is not configured properly for the root user.

System action:

IBM Spectrum Protect

User response:

Correct SSH configuration.

------------------------------------------------------------------------
ANS7948E

The public key for the FastBack server was not found. SSH public keys
are configured properly.



Explanation:

IBM Spectrum Protect The SSH public keys are not configured properly for
the root user.

System action:

IBM Spectrum Protect

User response:

Correct SSH configuration.

------------------------------------------------------------------------
ANS7949E

The connection to FastBack server failed.



Explanation:

IBM Spectrum Protect The connection to FastBack server failed.

System action:

IBM Spectrum Protect

User response:

Insure that the FastBack server on the target machine is runing
properly.

------------------------------------------------------------------------
ANS7950E

The FastBack server is not installed on the target machine.



Explanation:

IBM Spectrum Protect The FastBack server is not installed on the target
machine.

System action:

IBM Spectrum Protect

User response:

Install the FastBack server on the target machine or specify a different
target machiner.

------------------------------------------------------------------------
ANS7951E

The FastBackShell on the target machine returned with the message
errormsg .



Explanation:

IBM Spectrum Protect An error occurred with the command issued to the
FastBackShell on the target machine.

System action:

IBM Spectrum Protect

User response:

Correct the options specified on the commandr.

------------------------------------------------------------------------
ANS7952E

The package package required for FastBack support is not installed.



Explanation:

IBM Spectrum Protect The required package is not installed.

System action:

IBM Spectrum Protect

User response:

Install and configure the required package.

------------------------------------------------------------------------
ANS7953E

The FastBack shell scripts returned an unexpected error error.



Explanation:

IBM Spectrum Protect The FastBack shell scripts returned an unexpected
error.

System action:

IBM Spectrum Protect

User response:

Correct the error.

------------------------------------------------------------------------
ANS7954E

The SSH connection failed. The SSH daemon may not be started or
configured on the target machine



Explanation:

IBM Spectrum Protect Ensure that the SSH daemon is configured correctly.

System action:

IBM Spectrum Protect

User response:

Correct the error.

------------------------------------------------------------------------
ANS7955E

The cygdrive-prefix is set incorrectly.



Explanation:

IBM Spectrum Protect Ensure that cygdrive-prefix is set to / in the ssh
cygwin environment. The command mount -s --change-cygdrive-prefix / can
be use to set the drive prefix correctly.

System action:

IBM Spectrum Protect

User response:

Correct the error.

------------------------------------------------------------------------
ANS7956E

Unable to execute cygwin shell commands. The cygwin environment may be
incorrectly



Explanation:

IBM Spectrum Protect Use ssh to connect to the cygwin shell and ensure
that the cygwin environment and cygdrive are configured correctly.

System action:

IBM Spectrum Protect

User response:

Correct the error.

------------------------------------------------------------------------
ANS7957E

Unable discover the FastBackShell location in the registry



Explanation:

IBM Spectrum Protect Check that the FastBackShell was installed on the
Windows FastBack server machine.

System action:

IBM Spectrum Protect

User response:

Correct the error.

------------------------------------------------------------------------
ANS8000I

Server command: 'command'.



Explanation:

The specified command is being sent to the server. This message is
displayed when the command is generated from a macro or when the client
is running in batch mode.

System action:

The command is sent to the server for processing.

User response:

None.

------------------------------------------------------------------------
ANS8001I

Return code return code value.



Explanation:

The error code shown has been returned from the preceding server
command. This message is preceded by a server message explaining the
reason for the error code.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS8002I

Highest return code was return code value.



Explanation:

At exit from the client, the highest return code encountered during the
session is displayed.

System action:

This value is used as the program exit code.

User response:

None.

------------------------------------------------------------------------
ANS8003I

Process number process ID started.



Explanation:

As a result of the preceding server command, the process whose ID is
shown starts to execute the command. The process can be monitored using
the QUERY PROCESS command.

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS8004W

Your password will expire within daysRemaining day(s).



Explanation:

The password for this id is about to expire.

System action:

Logging on to the IBM Spectrum Protect Server will not be prevented,
however, the id will be locked out once it expires.

User response:

Change the password or contact your IBM Spectrum Protect administrator
to get the password updated.

------------------------------------------------------------------------
ANS8005E

Java Applet failed to load. Please ensure that the Java Java version
Plugin has been installed for this browser.



Explanation:

Java Plugin is missing from browser. Since plugin is not present, applet
is not able to load.

System action:

Applet unable to load and message displayed.

User response:

Install appropriate plugin for browser in order to use web client.

------------------------------------------------------------------------
ANS8006E

Unable to generate an acceptable password.



Explanation:

An error occurred during a password update attempt using a generated
password.

System action:

The password is not updated on the server.

User response:

Contact your IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS8007E

The user is not authorized to perform LDAP authentication.



Explanation:

Your node uses LDAP authentication. Your PASSWORDACCESS option is set to
GENERATE but the current user cannot access the stored password to
perform authentication.

System action:

The operation is stopped.

User response:

Run IBM Spectrum Protect client as root user or set PASSWORDACCESS to
PROMPT.

------------------------------------------------------------------------
ANS8008W

Redirection inside macro whose output is redirected is ignored.



Explanation:

An output redirection symbol has been encountered inside a macro.
However, the output of the macro itself (or a higher level macro) is
already being redirected.

System action:

The redirection request is ignored.

User response:

None.

------------------------------------------------------------------------
ANS8010E

An attempt to backup or archive a file has exceed the maximum number of
retries.



Explanation:

After five unsuccessful attempts to backup or archive a file, the client
will no longer attempt to send the file to the server.

System action:

File skipped.

User response:

Check the console or schedule log for additional information. Retry the
operation at a later time.

------------------------------------------------------------------------
ANS8011W

Rejected server-initiated session with LDAP authentication from peer
name.



Explanation:

For security, the client will not accept server-initiated sessions from
servers that use LDAP authentication.

System action:

The client-server session is not opened, and the schedule is not
executed. The scheduler continues to wait for contact by a server that
uses LOCAL authentication.

User response:

If the client system is supposed to accept scheduled events from the
prompting IBM Spectrum Protect server, either ask the IBM Spectrum
Protect server administrator to configure your node to use LOCAL
authentication, or do not use server-initiated sessions. If the client
system is not supposed to accept scheduled events from the prompting
server, ask the IBM Spectrum Protect server administrator to remove the
client node name from the schedule on the prompting server.

------------------------------------------------------------------------
ANS8012E

Option processing storage exhausted.



Explanation:

During processing of the client options file, the client runs out of
memory.

System action:

The client session is ended.

User response:

Make more memory available and restart the administrative client.

------------------------------------------------------------------------
ANS8013I

Invalid encryption key password



Explanation:

The key you entered does not match the key that was used to encrypt the
file during backup. The file can not be restored unless the matching key
is entered.

System action:

User is prompted for encryption key password.

User response:

Enter the correct encryption key password.

------------------------------------------------------------------------
ANS8014E

Insufficient information to connect to host.



Explanation:

The client options file or command line, or both, do not contain enough
communications information to successfully connect to the server system.
For example, with TCP/IP both the TCPPort number and TCPServer address
are required to make a connection.

System action:

The administrative client session is ended.

User response:

Determine what information is needed to establish a connection for your
communications method and then specify all that information in your
client options file or on the administrative client command line.

------------------------------------------------------------------------
ANS8015E

File 'file spec', error code error code from options processing.



Explanation:

An unknown error code is returned from the routine that processes the
client options file.

System action:

The administrative client session is ended.

User response:

Attempt to determine the error and correct it. If the problem persists,
contact your service representative.

------------------------------------------------------------------------
ANS8016E

Command line parameter parameter number: 'parameter' is too long.



Explanation:

The specified command line parameter exceeds the maximum length for a
command line parameter.

System action:

The administrative client session is ended.

User response:

Reissue the command with a shorter parameter.

------------------------------------------------------------------------
ANS8017E

Command line parameter parameter number: 'parameter' is not valid.



Explanation:

The command line parameter shown is not a valid administrative client
parameter.

System action:

The administrative client session is ended.

User response:

Reissue the command with valid parameters.

------------------------------------------------------------------------
ANS8018E

Administrative command not valid in Console mode.



Explanation:

The Console Mode option has been specified but the client encounters
what appears to be a server command on the command line.

System action:

The administrative client session is ended.

User response:

Reissue the command with no server command.

------------------------------------------------------------------------
ANS8019E

Id and password must be supplied in Batch mode.



Explanation:

A server command has been encountered on the command line, but no
administrator ID or password, or both, are specified.

System action:

The administrative client session is ended.

User response:

Reissue the command and include the -ID and -PASSWORD parameters on the
command line.

------------------------------------------------------------------------
ANS8020E

Unable to open file 'file spec' for output.



Explanation:

The file name specified in the -OUTFILE option cannot be opened.

System action:

The -OUTFILE parameter is ignored.

User response:

Allow processing to continue or exit the session and correct the file
name.

------------------------------------------------------------------------
ANS8021E

Exiting Batch mode session due to output file error.



Explanation:

The file specified in the -OUTFILE parameter cannot be opened for a
session running in Batch mode.

System action:

The administrative client session is ended.

User response:

Reissue the command with a valid output file name or make space
available for the output file.

------------------------------------------------------------------------
ANS8022E

Output will be written only to stdout.



Explanation:

The file specified in the -OUTFILE parameter cannot be opened, so output
is written only to the standard output stream.

System action:

Output that would have been written to the output file is written to the
standard output stream.

User response:

Allow processing to continue or exit the session and correct the file
name.

------------------------------------------------------------------------
ANS8023E

Unable to establish session with server.



Explanation:

The administrative client cannot start a session with the requested
server. This message is preceded by another message that explains the
reason for the error.

System action:

The administrative client session is ended.

User response:

Attempt to correct the error. If the problem persists, contact your
service representative.

------------------------------------------------------------------------
ANS8024E

End of macro after continued command line.



Explanation:

A macro containing a continuation line has been executed, but no more
lines are found in the macro file.

System action:

The continued command is ignored, and an error return code is set for
the macro.

User response:

Correct the macro in error.

------------------------------------------------------------------------
ANS8025E

I/O Error reading command input.



Explanation:

The client is unable to read an input command from the terminal.

System action:

The administrative client session is ended.

User response:

Correct the problem on the terminal and retry the administrative
session.

------------------------------------------------------------------------
ANS8026E

Input line longer than maximum of max length characters. Use
continuation.



Explanation:

An input command line is longer than the maximum input line length
allowed.

System action:

The input command is ignored.

User response:

Reissue the command with several lines using continuation characters.

------------------------------------------------------------------------
ANS8027E

Unterminated comment in command.



Explanation:

An input command contains an opening comment mark but no closing comment
mark.

System action:

The input command is ignored.

User response:

Reissue the command with matching comment marks.

------------------------------------------------------------------------
ANS8028E

Command longer than maximum of max length characters.



Explanation:

An input command longer than the maximum command length allowed has been
entered.

System action:

The input command is ignored.

User response:

Reissue the command with fewer characters. This could mean replacing
series of repeating blanks with a single blank.

------------------------------------------------------------------------
ANS8029E

Macro processing terminated.



Explanation:

An error occurs during processing of a macro because the -ITEMCOMMIT
option is not specified on the command line. Processing of this macro
and any higher level macro is terminated.

System action:

All current macro processing ends.

User response:

Specify the -ITEMCOMMIT option on the command line to ensure that the
server commits each command in the macro individually.

------------------------------------------------------------------------
ANS8030E

Substituted command longer than maximum of max length characters.



Explanation:

After variable substitution, an input command is longer than the maximum
command length allowed.

System action:

The input command is ignored.

User response:

Reissue the command with fewer characters. This may require replacing a
series of repeating blanks with a single blank.

------------------------------------------------------------------------
ANS8031E

Missing name of macro to execute.



Explanation:

A macro command is encountered that does not contain a macro name.

System action:

The command is ignored.

User response:

Reissue the macro command with a macro file name.

------------------------------------------------------------------------
ANS8032E

Could not allocate storage to process macro 'file spec'.



Explanation:

The client cannot allocate enough memory to process the macro shown.

System action:

The macro is ignored and an error is returned.

User response:

Make more memory available to the client and retry the macro command.

------------------------------------------------------------------------
ANS8033E

LDAP authentication is not supported by Web client.



Explanation:

The id you entered uses LDAP authentication. LDAP authentication is not
supported by Web client.

System action:

Login is unsuccessful.

User response:

Use an id with LOCAL authentication.

------------------------------------------------------------------------
ANS8034E

Your administrator ID is not recognized by this server.



Explanation:

The administrator ID entered is not known to the requested server.

System action:

The administrative session terminates.

User response:

Ensure that you are using a registered administrative ID for the server
to which you are connecting.

------------------------------------------------------------------------
ANS8036E

Administrative command not valid in Mount mode.



Explanation:

The Mount Mode option has been specified but the client encounters what
appears to be a server command on the command line.

System action:

The administrative client session is ended.

User response:

Reissue the command with no server command.

------------------------------------------------------------------------
ANS8037E

Missing name for redirection file.



Explanation:

A command is entered that contains an output redirection symbol but no
output file name.

System action:

The command is ignored and an error is returned.

User response:

Reissue the command with an output file name.

------------------------------------------------------------------------
ANS8038E

Unable to open file 'file spec' for redirection.



Explanation:

A command has been entered that specifies an output redirection file,
but the file cannot be opened.

System action:

The command is ignored and an error is returned.

User response:

Reissue the command with a valid output file name or make space
available for the output file.

------------------------------------------------------------------------
ANS8041E

The server connection has been lost and cannot be re-established.



Explanation:

During an administrative session, the client discovers that the
connection with the server has been severed; an attempt to reestablish
the connection fails.

System action:

The client session is ended.

User response:

Determine the cause of the failure; then try to restart the session at a
later time. If the problem persists, contact your service
representative.

------------------------------------------------------------------------
ANS8045E

Communications error.



Explanation:

An unexpected communications error occurs during an administrative
session.

System action:

The client session is ended.

User response:

Verify that communications are active between the client and server
machines. Server outages, processor outages, and communication
controller outages can cause this error.

------------------------------------------------------------------------
ANS8046E

The client connection with the server has ended due to an unexpected
error.



Explanation:

The error log might contain other messages related to this error.

System action:

The client session ends.

User response:

Check the communication link between the client and server to ensure
that it is operational. Examine the client error log for additional
messages related to this error.

------------------------------------------------------------------------
ANS8047E

The client connection with the server has ended due to a communications
buffer overflow.



Explanation:

The error log might contain other messages related to this error.

System action:

The client session ends.

User response:

Try the operation again. Check the communication link between the client
and server to ensure that it is operational. Examine the client error
log for additional messages related to this error.

------------------------------------------------------------------------
ANS8048W

Warning! Performing image restore of the Linux file system 'src' to an
alternate destination 'dest' is not recommended as this may result in
duplicate UUIDs leading to failed mounts after a successful restore.



Explanation:

Performing an image restore of a Linux file system to an alternate
destination may result in duplicate UUID leading to failed mounts after
a successful restore. On Linux, some file systems use UUID to identify
themselves. If you took an image backup of such volume and restored it
to a different location, you will have two volumes with the same UUID.
If you use UUID to define your file systems in /etc/fstab, be aware that
IBM Spectrum Protect may be unable to mount the restored file system
correctly. To avoid such situation, restore the image to its original
location.

System action:

Processing continues.

User response:

If it is not possible or not desirable to avoid performing an image
restore to an alternate destination, change the UUID of either the
original or restored volume. Refer to your Linux documentation for
instructions on how to do this. You may also need to edit your
/etc/fstab manually to allow the original, the restored or both volumes
to mount.

------------------------------------------------------------------------
ANS8049E

A connection with the server cannot be established due to a
communications time-out.



Explanation:

The error log might contain other messages related to this error.

System action:

The client session ends.

User response:

Check the communication link between the client and server to ensure
that it is operational. Examine the client error log for additional
messages related to this error.

------------------------------------------------------------------------
ANS8050E

The IBM Spectrum Protect server is not accepting administrative sessions
on the client port. You must use the port number designated for
administrative sessions.



Explanation:

The IBM Spectrum Protect server is configured to not allow
administrative sessions on the client TCP/IP port. A different port
number has been designated for use by administrative sessions.

System action:

The administrative session is not established.

User response:

Use the TCPADMINPORT client option to specify the TCP/IP port number
that the IBM Spectrum Protect server uses for administrative sessions.
See your IBM Spectrum Protect server administrator if you do not know
the correct port number.

------------------------------------------------------------------------
ANS8052E

Unable to decrypt file 'filespace namepath-namefile-name'....Please try
to restore this file individually



Explanation:

File could not be decrypted and restored.

System action:

File is not restored.

User response:

Restore the file separately.

------------------------------------------------------------------------
ANS8053E

The network cannot be accessed.



Explanation:

The error log might contain other messages related to this error.

System action:

The client session ends.

User response:

Check the communication link between the client and server to ensure it
is operational. Examine the client error log for additional messages
related to this error. Try the operation again.

------------------------------------------------------------------------
ANS8054E

No memory available to service request.



Explanation:

Sufficient server memory is not available.

System action:

The client session is ended.

User response:

Retry the administrative session. If the problem persists, contact your
service representative.

------------------------------------------------------------------------
ANS8055E

The server has insufficient resources to perform the operation.



Explanation:

The server ran out of resources. A lack of storage or other problem
condition does not allow any new activity. The server activity log might
contain additional information about this problem.

System action:

The client session ends.

User response:

The IBM Spectrum Protect administrator should examine the IBM Spectrum
Protect server activity log to determine the source of the resource
constraints. Try the operation again when the server is under less load.

------------------------------------------------------------------------
ANS8056E

Your administrator ID is locked.



Explanation:

The administrative ID entered has been locked by a system administrator
and cannot be used.

System action:

The client session is ended.

User response:

Contact your system administrator to unlock your ID.

------------------------------------------------------------------------
ANS8057E

The requested language files are not available.



Explanation:

The NLS repository for the language specified is not available.

System action:

The client session is ended.

User response:

Use a different language or obtain a copy of the NLS repository for the
language desired.

------------------------------------------------------------------------
ANS8058E

The specified path is a Linux Btrfs subvolume and is not valid for image
backup.



Explanation:

Linux Btrfs subvolumes are not supported for image backup.

System action:

The image backup operation is not performed.

User response:

Try the operation again using a valid Linux Btrfs file system.

------------------------------------------------------------------------
ANS8060E

Error validating file 'VHDX file name'



Explanation:

IBM Spectrum Protect cannot locate the file or the file format is not
valid.

System action:

The backup operation does not start.

User response:

Try the operation again. If the problem continues, check the error log
file for information about how to resolve this issue.

------------------------------------------------------------------------
ANS8061E

Session Rejected: The server does not allow a signon as a Unicode
enabled administrative client



Explanation:

The administrative client is unable to establish a connection to the
server because of a unicode enabling mismatch between server and client.

System action:

The client session is ended.

User response:

Register a new administrator from a different administrative client or
the server console, and signon with the new administrator ID.

------------------------------------------------------------------------
ANS8062E

Client-to-Client communication is not allowed to take place when IBM
Spectrum Protect Server authentication is turned off.



Explanation:

Client-to-Client communication requires IBM Spectrum Protect
Authentication to be enabled.

System action:

Processing stops.

User response:

Turn IBM Spectrum Protect Server authentication on using the Set
AUthentication ON command.

------------------------------------------------------------------------
ANS8063E

The remote IBM Spectrum Protect Client Acceptor associated with Node
'name' could not authenticate with the IBM Spectrum Protect Server.



Explanation:

Some IBM Spectrum Protect Client operations require the Backup/Archive
Client to contact Clients on remote machines. The remote machine in
question cannot authenticate with the IBM Spectrum Protect Server.

System action:

Processing stops.

User response:

On the remote machine, create a new IBM Spectrum Protect password for
the Client Acceptor or verify that the current password is still valid
before retrying the operation.

------------------------------------------------------------------------
ANS8064E

Communication timeout. Reissue the command.



Explanation:

The connection to the server is ended because of a communication timeout
from the server.

System action:

The server does not process the command.

User response:

Reissue the command. If necessary, increase the values of IDLETIMEOUT
and COMMTIMEOUT options in the server options file.

------------------------------------------------------------------------
ANS8103W

A command was not successful. command : command IBM Spectrum Protect
function name : function-name error output : error-output return code :
return code IBM Spectrum Protect file : file-name (line-number)



Explanation:

IBM Spectrum Protect client called an external program that failed.

System action:

Depending on the circumstances, the failure may or may not prevent
further processing.

User response:

See addition information in the error log. Use the information provided
in this message for troubleshooting or when talking with IBM Spectrum
Protect support.

------------------------------------------------------------------------
ANS8104W

Cannot determine EFS status of the file system 'file-system name',
errno='errnor number', processing data normally.



Explanation:

IBM Spectrum Protect cannot determine EFS status on the specified
filesystem. No EFS specific processing will take place for files on this
filesystem. If EFS is indeed enabled on the filesystem, all accessaible
files will be backedup in cleartext.

System action:

The filesystem will be processed as a regular filesystem.

User response:

Contact your system administrator to determine the cause of the error
reported in the message.

------------------------------------------------------------------------
ANS8105W

Unable to remove snapshot for volume 'filespace-name'.



Explanation:

IBM Spectrum Protect client was unable to remove the snapshot used for
image backup.

System action:

Processing continues.

User response:

See additional information in the error log. Use lvdisplay command to
view the active snapshots and lvremove command to remove the snapshot
manually.

------------------------------------------------------------------------
ANS8106E

Support for multiple IBM Spectrum Protect servers is enabled on this
node. The server name must be specified for this command.



Explanation:

When a node is enabled to support multiple IBM Spectrum Protect servers,
the command must specify a valid IBM Spectrum Protect server name.

System action:

Processing stopped.

User response:

Specify a valid server name for this command.

------------------------------------------------------------------------
ANS8107I

The -server='option-value' option value is ignored. The reconciliation
will proceed with the default server default-server.



Explanation:

The -server option is valid only in a multiple-server environment, and
must be used only with the two-way, orphan-check reconciliation mode.

System action:

Processing continues.

User response:

Use the -server option only with the two-way, orphan-check
reconciliation mode.

------------------------------------------------------------------------
ANS8201E

Windows Hyper-V incremental backups require Windows 2012 or later. On
Windows Server 2016 or later, the virtual machine version must be
greater than 5.



Explanation:

IBM Spectrum Protect can only perform incremental backups of Windows
Hyper-V on Windows operating systems of Windows Server 2012 and later.
If running on Windows Server 2016 or later than the virtual machine
version must be greater than 5.

System action:

The incremental backup operation was stopped.

User response:

To access incremental backups for Windows Hyper-V, upgrade the operating
system to Windows Server 2012 or later. On Windows Server 2016 and
later, the virtual machine version must be greater than 5 to support
Microsoft Hyper-V Resilient Change Tracking (RCT).

------------------------------------------------------------------------
ANS8503I

No matching option found for pattern: 'pattern'.



Explanation:

You specified a pattern which does not match the name of any supported
option.

System action:

This message is the only response to your query.

User response:

Specify a different pattern or omit the pattern to display all options.

------------------------------------------------------------------------
ANS8563E

Recall mode has an invalid value: invalidValue.



Explanation:

The recall mode you try to enable on the system is not existing.

System action:

None.

User response:

Check the value of the recall option.

------------------------------------------------------------------------
ANS8565W

ProgramName: list of recall IDs not found in queue. These recalls are
already finished:



Explanation:

The program is not able to find the recall IDs and is not able to delete
these processes.

System action:

None.

User response:

Check that recall IDs exist and are correct.

------------------------------------------------------------------------
ANS8778E

A browser program cannot be found or cannot be started. An error
occurred executing the command.command Verify that a browser is
installed and works correctly on your local machine.



Explanation:

A browser program cannot be found, so it is not possible to access the
IBM Spectrum Protect Web site and online documentation.

System action:

IBM Spectrum Protect continues to process user requests.

User response:

For the Windows platform, the default system browser is used. Verify
that a browser is installed on your machine.

------------------------------------------------------------------------
ANS8779E

A browser program cannot be found or cannot be started. One of the
following browsers is required: browser-list Verify that one of these
browsers is installed and works correctly on your local machine.



Explanation:

A browser program cannot be found, so it is not possible to access the
IBM Spectrum Protect Web site and online documentation.

System action:

IBM Spectrum Protect continues to process user requests.

User response:

For UNIX platforms, a list of supported browsers is provided in the
README. Install the required browser to access the IBM Spectrum Protect
Web sites and online documentation.

------------------------------------------------------------------------
ANS8780E

A browser program cannot be found or cannot be started. Check the
'file-name' file on your local machine for more information.



Explanation:

A browser program cannot be found, so it is not possible to access the
Web site or online documentation.

System action:

IBM Spectrum Protect continues to process user requests.

User response:

Install a browser to access the Web site or online documentation.

------------------------------------------------------------------------
ANS8809E

The LD_LIBRARY_PATH is either not set or is set incorrectly. Ensure that
the LD_LIBRARY_PATH environment variable contains the installation
directory path name.



Explanation:

The LD_LIBRARY_PATH must be set and it must contain the installation
directory path.

System action:

The VMware backup or restore operation fails.

User response:

Set the LD_LIBRARY_PATH and ensure that it contains the Backup/Archive
client installation directory.

------------------------------------------------------------------------
ANS8810E

The LD_LIBRARY_PATH is either not set or is set incorrectly. Ensure that
the LD_LIBRARY_PATH environment variable contains the installation
directory.



Explanation:

The LD_LIBRARY_PATH must be set and it must contain the installation
directory path.

System action:

The VMware backup or restore operation fails.

User response:

Set the LD_LIBRARY_PATH and ensure that it contains the Backup/Archive
client installation directory.

------------------------------------------------------------------------
ANS8811E

VMware operations can not be run when the hardware plugin product
TIVsm-BAhdw is installed and loaded. Please either uninstall the
hardware product TIVsm-BAhdw, or set the option DONTLOAD PIHDW in the
options file to prevent the hardware plugin from being loaded.



Explanation:

VMware operations are incompatible with the hardware plugin product
libraries.

System action:

The VMware backup or restore operation fails.

User response:

Uninstall the hardware product product TIVsm-BAhdw, or set the option
DONTLOAD PIHDW to prevent the hardware plugin from being loaded.

------------------------------------------------------------------------
ANS8818E

An error occurred trying to apply your changes. Your changes have not
been applied to the system. Contact your system administrator.



Explanation:

An error occurred trying to apply your changes.

System action:

User changes are not applied.

User response:

Contact your system administrator.

------------------------------------------------------------------------
ANS8819E

The following trace flag(s) are not valid: trace-flag-list. Correct them
before continuing.



Explanation:

One or more of the trace flags are not valid.

System action:

Prompts the user to correct the trace flags.

User response:

Correct the wrong trace flags.

------------------------------------------------------------------------
ANS8830W

Different server name stanzas (HSM-stanza and BA-stanza) for
file-system-name file system for space management and backup-archive.



Explanation:

The server name stanzas you specified for the space management (HSM)
client and the backup-archive (BA) client are different. The inline
backup and stub restore features will be unavailable for the file
system.

System action:

Processing continues.

User response:

If you want to allow inline backup and stub restore for the file system,
the MIGRATESERVER and DEFAULTSERVER options must specify the same
SERVERNAME stanza in dsm.sys. You may also choose to supply a server
stanza name using the SERVERNAME option in dsm.opt or on the command
line. In either case the stanza name must match the stanza specified in
the MIGRATESERVER option.

------------------------------------------------------------------------
ANS8939E

An unexpected error occurred trying to filter the directory tree.
rc=return-code



Explanation:

The filter was not applied to the directory tree.

System action:

The directory tree is not filtered.

User response:

Contact your system administrator for further assistance.

------------------------------------------------------------------------
ANS8946E

RPC call failed.



Explanation:

Unable to connect receiver recall daemon.

System action:

Processing stopped.

User response:

System is not operating correctly or recall daemons are not started.

------------------------------------------------------------------------
ANS8956E

Port port which is specified by the HSMRPCPORT option is already in use



Explanation:

The port specified by the HSMRPCPORT option is in use by a different
process.

System action:

Processing stopped.

User response:

Update the HSMRPCPORT with new available port number and restart HSM
daemons

------------------------------------------------------------------------
ANS8957E

Start of RPC Server process failed



Explanation:

dsmrecalld can not start RPC server.

System action:

Processing stopped.

User response:

Error detail can be found in system log.

------------------------------------------------------------------------
ANS9005W

program name: invalid 'parameter name' value: value (must be in [minimum
value..maximum value]).



Explanation:

The program found an invalid parameter in the space management
configuration of a filesystem.

System action:

The paramter value was rejected.

User response:

In case you tried to set the specified value manually, choose a value
from the specified range instead. If the value is read from a file
system's space management configuration file (located at
[fs]/.SpaceMan/hsmfsconfig.xml), edit the file accordingly. The name of
the filesystem can be determined from a subsequent error message.

------------------------------------------------------------------------
ANS9007W

program name: invalid 'parameter name' value: value (must be in [minimum
value..maximum value]).



Explanation:

The program found an invalid parameter in the space management
configuration of a filesystem.

System action:

The paramter value was rejected.

User response:

In case you tried to set the specified value manually, choose a value
from the specified range instead. If the value is read from a file
system's space management configuration file (located at
[fs]/.SpaceMan/hsmfsconfig.xml), edit the file accordingly. The name of
the filesystem can be determined from a subsequent error message.

------------------------------------------------------------------------
ANS9008W

Compression is enabled. Recall mode for file file-name cannot be set to
partial.



Explanation:

IBM Spectrum Protect can only set file attributes to a uncompressed
migrated file. This file has been migrated with compression enabled.

System action:

IBM Spectrum Protect does not set the file attributes.

User response:

Recall the file to state resident disable compression and migrate the
file again. Retry the operation.

------------------------------------------------------------------------
ANS9009E

program name: found invalid space management configuration for
'filesystem'.



Explanation:

The program found an invalid space management configuration for the
given filesystem.

System action:

The space management configuration was rejected for the given filesystem
. When updating an existing configuration, invalid configurations to set
are ignored. When a persistent configuration file is invalid, the
filesystem will appear to not have space management enabled.

User response:

In case you tried to update space management for this filesystem
manually, enter a valid configuration instead. In case the persistent
configuration file is invalid, edit the file accordingly; alternatively,
you can add space management explicitly (which will remove / overwrite
the existing configuration). The reason for the configuration can be
determined from a preceding error message. The filesystem's space
management configuration file is located at
'filesystem'/.SpaceMan/hsmfsconfig.xml.

------------------------------------------------------------------------
ANS9010E

program name: could not parse space management configuration file
'configuration file' for filesystem.



Explanation:

The space management configuration file for the given filesystem is
present but its content appears to have invalid format.

System action:

The configuration was rejected. The filesystem will appear to not have
space management enabled.

User response:

Check the given space management configuration file; it is supposed to
contain a well-formed XML document with a root element named
'HsmFsConfig'. To create a new configuration file, you can simply add
space management to this filesystem.

------------------------------------------------------------------------
ANS9011E

program name: could not write space management configuration file
'configuration file' for filesystem.



Explanation:

IBM Spectrum Protect could not write and save the space management
configuration file for the given filesystem.

System action:

IBM Spectrum Protect did not save the space management configuration
information. If you tried to add space management for this filesystem,
it was not added. If you tried to update the space managment
configuration, it was probably not updated. If an existing configuration
file in old format was read successfully, but could not be converted to
XML format, space management will be active for this filesystem with the
configuration from the old file.

User response:

Determine if there is any reason why the given file cannot be written.

------------------------------------------------------------------------
ANS9012E

error-program: Command must be run by root user.



Explanation:

IBM Spectrum Protect requires that a root user perform this operation.

System action:

IBM Spectrum Protect terminates the operation.

User response:

Change to root user, and then retry the operation.

------------------------------------------------------------------------
ANS9016E

Cannot get space management migration status for path.



Explanation:

An error occurred while trying to get the space management migration
status. Either the permissions for the status file are not set
correctly, or the status file is damaged.

System action:

IBM Spectrum Protect terminates the operation.

User response:

The root user should check the permissions of the status file, or
contact the service representative.

------------------------------------------------------------------------
ANS9017W

error-program: Minimum number of recall daemons min-dsmrecalld cannot be
greater than maximum number of recall daemons max-dsmrecalld; defaulting
to minimum min-dsmrecalld and maximum max-dsmrecalld.



Explanation:

A minimum number of recall daemons has been entered that is greater than
the maximum number of recall daemons.

System action:

IBM Spectrum Protect uses defaults instead of the values specified in
the client system options file (dsm.sys).

User response:

Correct the MINRECALLDAEMONS and MAXRECALLDAEMONS options in the client
system options file and retry the operation.

------------------------------------------------------------------------
ANS9020E

A session could not be established with a IBM Spectrum Protect server or
client agent. The return code is tsm-error;.



Explanation:

An issue prevented the client from making a connection with the IBM
Spectrum Protect server. Additional detail is not available to include
with this message. However, additional messages are likely to be
reported in the IBM Spectrum Protect error log.

System action:

Processing stops.

User response:

Check the error log for additional messages. Refer to those messages to
determine how to resolve any reported issues. If the IBM Spectrum
Protect-error is -50, there is a communication failure. Typical causes
of this error include misconfiguration of the server TCP/IP address or
port. Verify the configuration and that the client system network is
connected. Verify that a firewall does not prevent access to the IBM
Spectrum Protect server. Finally, verify that the IBM Spectrum Protect
server is running and accepting connections on the expected port.

------------------------------------------------------------------------
ANS9021E

error-program Unknown recall daemon (pid process-ID) terminated
abnormally, status: status.



Explanation:

A recall daemon stops abnormally.

System action:

IBM Spectrum Protect terminates the operation.

User response:

Try the operation again. If the problem persists, send the core file to
IBM technical support for analysis.

------------------------------------------------------------------------
ANS9022E

error-program Recall daemon (pid process-ID) ended abnormally, status:
status.



Explanation:

A recall daemon stopped abnormally.

System action:

The operation does not complete.

User response:

Try the operation again. If the problem persists, send the core file to
IBM technical support for analysis.

------------------------------------------------------------------------
ANS9024E

Starting with this release all candidate processing is done internally
by the IBM Spectrum Protect monitor daemon. Thus -c is no longer a valid
option for dsmreconcile.



Explanation:

The command line options -c and -Candidates are no longer valid for
dsmreconcile as all candidates processing is now performed by
dsmmonitord.

System action:

IBM Spectrum Protect detected an invalid option. dsmreconcile is
exiting.

User response:

Don't use options -c and -Candidates with dsmreconcile anymore.

------------------------------------------------------------------------
ANS9025E

The Data Protection for WebSphere plug-in version and the backup-archive
client version do not match. Please upgrade your Data Protection for
WebSphere plug-in.



Explanation:

The release and version of the Data Protection for WebSphere plug-in is
downlevel from the release and version of the Backup-Archive Client.

System action:

None

User response:

Upgrade Data Protection for WebSphere to the proper release and version.

------------------------------------------------------------------------
ANS9028E

program name: could not acquire lock for filesystem.



Explanation:

Prior to modifying a space management configuration file, it is required
to lock the file in order to avoid concurrent access. If acquiring the
lock fails, there was a concurrent access.

System action:

The action was cancelled.

User response:

Retry the same request or determine the process holding the lock.

------------------------------------------------------------------------
ANS9029E

The WebSphere server is running, but the server must be shut down for a
restore operation. Shut down the WebSphere server and try the restore
operation again.



Explanation:

The WebSphere server must be brought down to perform a restore.

System action:

The restore operation fails.

User response:

Shut down the WebSphere server and try the restore operation again.

------------------------------------------------------------------------
ANS9030W

Cannot set conflicting attributes to file file-name.



Explanation:

IBM Spectrum Protect cannot set the file attributes because the
requested attributes are in conflict with one another.

System action:

IBM Spectrum Protect does not set the file attributes.

User response:

Retry this operation with attributes that do not conflict with each
other. This error also appears if you try to set partial recall mode for
an executable file.

------------------------------------------------------------------------
ANS9031W

File file-name is not a migrated file.



Explanation:

IBM Spectrum Protect can only set file attributes to a migrated file.
This file has not been migrated.

System action:

IBM Spectrum Protect does not set the file attributes.

User response:

Migrate this file, and then retry the operation.

------------------------------------------------------------------------
ANS9032W

File file-name is not in an HSM managed file system.



Explanation:

IBM Spectrum Protect detects that the file is not in an HSM managed file
system, and therefore, it cannot perform the operation requested.

System action:

IBM Spectrum Protect does not set the file attributes.

User response:

Add space management to the file system, migrate the file, and then
retry the operation.

------------------------------------------------------------------------
ANS9034E

The restore operation did not complete, due to a change in the original
WebSphere environment.



Explanation:

The data must be restored to the same environment that it was backed up
from. This includes items such as cell name, node name, and the location
where WebSphere is installed.

System action:

The restore operation does not complete.

User response:

Perform the restore procedure in the DP for WebSphere book.

------------------------------------------------------------------------
ANS9036W

program-name: migrated file(s) are missing on server for number stub
file(s). Look in 'file-spec' for file names.



Explanation:

IBM Spectrum Protect cannot find the migrated file(s) on the server.

System action:

Processing continues.

User response:

Look in the path mentioned in the message for the file name. Also ensure
that you are working with the correct server for this file.

------------------------------------------------------------------------
ANS9050I

program-name: One or more specified options are not valid.



Explanation:

IBM Spectrum Protect The specified options are not valid. No option was
changed.

System action:

Processing continues without changed options.

User response:

Verify the specified options and correct the command line options for
the command.

------------------------------------------------------------------------
ANS9051I

program-name: The options were successfully changed.



Explanation:

IBM Spectrum Protect Update of options was successful.

System action:

Processing continues with changed options.

User response:

Continue normal processing.

------------------------------------------------------------------------
ANS9054E

The plug-in was not found.



Explanation:

None.

System action:

None

User response:

Run "dsmc show plugins" at the command prompt to see the available
plug-ins on the system.

------------------------------------------------------------------------
ANS9057W

error-program: cannot get space information for file-system: error.



Explanation:

IBM Spectrum Protect cannot get the space information for the file
system.

System action:

Processing continues.

User response:

Verify that space management has been added to the file system.

------------------------------------------------------------------------
ANS9059E

error-program: process cannot detach to become a daemon.



Explanation:

IBM Spectrum Protect process cannot detach itself to become a daemon.

System action:

IBM Spectrum Protect cannot start the daemon as requested. IBM Spectrum
Protect stops.

User response:

Retry the operation.

------------------------------------------------------------------------
ANS9060W

error-program: cannot get and increase limit of open files.



Explanation:

IBM Spectrum Protect either cannot get the limit of the number of open
files, or cannot increase the limit of the number of open files.

System action:

IBM Spectrum Protect cannot increase the number of open files, and was
not able to complete the operation.

User response:

Free some file space by ending some processes or removing some files,
and retry the operation.

------------------------------------------------------------------------
ANS9062E

File 'filename' has changed during the backup.



Explanation:

A file changed during the backup. Check the dsmerror.log file for a list
of files that have changed.

System action:

The backup fails.

User response:

Try the backup again.

------------------------------------------------------------------------
ANS9063E

error-program: file system file-system is out of inodes.



Explanation:

IBM Spectrum Protect cannot get space for the file system because the
file system is out of inodes.

System action:

IBM Spectrum Protect cannot get space via migration.

User response:

Remove some files to make more inodes available and retry.

------------------------------------------------------------------------
ANS9064E

error-program: Cannot fork a new process: error.



Explanation:

IBM Spectrum Protect cannot fork a new process that is needed. If the
operating system errno is EAGAIN, then the limit on the total number of
processes running on the system or by a single user has been exceeded,
or the system does not have the resources necessary to create another
process. If the errno is ENOMEM, then there is not enough memory to
create the process.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Depending on the error code (errno), either allocate additional virtual
memory (swap space) or increase the operating system process limit. Then
restart the HSM daemons or reboot the system.

------------------------------------------------------------------------
ANS9065E

File 'filename' or file 'filename2' has been added or removed during the
backup.



Explanation:

A file was added or removed during the backup.

System action:

The backup fails.

User response:

Try the backup again.

------------------------------------------------------------------------
ANS9067W

error-program: error updating dsmmigfstab file for file-system.



Explanation:

IBM Spectrum Protect found an error in updating the dsmmigfstab file for
this file system.

System action:

IBM Spectrum Protect does not update the dsmmigfstab file.

User response:

See the preceding error message and correct the error if possible. Then,
retry the operation. If problem persists, contact your system
administrator.

------------------------------------------------------------------------
ANS9068I

program-name: dsmmigfstab file updated for file system file-system.



Explanation:

IBM Spectrum Protect successfully updated the dsmmigfstab file for the
file system.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9069I

program-name: all file systems are reactivated to previous states.



Explanation:

IBM Spectrum Protect has reactivated all file systems managed by HSM to
their previous states before the global deactivation.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9070I

program-name: space management is now deactivated for all HSM file
systems.



Explanation:

IBM Spectrum Protect has deactivated space management for all file
systems listed in the dsmmigfstab file.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9071W

program-name: error reactivating space management for all HSM file
systems.



Explanation:

IBM Spectrum Protect found an error in trying to reactivate space
management.

System action:

IBM Spectrum Protect does not reactivate space management for HSM file
systems.

User response:

Make sure space management is installed correctly and retry the
operation.

------------------------------------------------------------------------
ANS9072W

error-program: error deactivating space management for all FSM file
systems.



Explanation:

IBM Spectrum Protect found an error in trying to deactivate space
management.

System action:

IBM Spectrum Protect does not deactivate space management for FSM file
systems.

User response:

Make sure space management is installed correctly and retry the
operation.

------------------------------------------------------------------------
ANS9073W

program-name: error deactivating space management for file system
file-system.



Explanation:

IBM Spectrum Protect found an error in trying to deactivate the file
system.

System action:

IBM Spectrum Protect does not deactivate space management for the file
system.

User response:

Make sure space management is installed correctly and retry the
operation.

------------------------------------------------------------------------
ANS9074I

program-name: space management functions have been locally deactivated
for file system file-system.



Explanation:

IBM Spectrum Protect has locally deactivated space management functions
like migration, recall and reconciliation for the file system.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9075W

program-name: error reactivating space management for file system
file-system.



Explanation:

IBM Spectrum Protect found an error in trying to reactivate space
management for the file system.

System action:

IBM Spectrum Protect does not reactivate space management for the file
system.

User response:

Verify that the specified file system is mounted and that HSM is enabled
for this file system. Then try the operation again. If the problem
persists, contact IBM technical support for additional assistance.
Provide the /etc/filesystems (or equivalent file) and the output from
the mount and dsmdf commands.

------------------------------------------------------------------------
ANS9076I

program-name: space management functions have been locally reactivated
for file system file-system.



Explanation:

IBM Spectrum Protect has locally reactivated space management functions
like migration, recall and reconciliation for the file system. Please,
note however that the space management might still be globally
deactivated.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9077I

program-name: removed space management from file system file-system.



Explanation:

IBM Spectrum Protect removed space management. The file system is now a
native file system.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9078W

Space management is not removed from file system file-system.



Explanation:

IBM Spectrum Protect was not able to remove space management from this
file system. Possible causes:

   Kernel extension is downlevel.
   Program is downlevel.
   Insufficient disk space.

System action:

IBM Spectrum Protect is unable to complete the requested operation.

User response:

Refer to the immediately preceding error message and retry the
operation.

------------------------------------------------------------------------
ANS9079W

program-name: no migrated files matching search criteria found.



Explanation:

IBM Spectrum Protect did not find any migrated files matching the search
criteria.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

Retry the operation with a different search criteria.

------------------------------------------------------------------------
ANS9080E

program-name: not enough space in file system or storage pool to recall
all migrated files.



Explanation:

IBM Spectrum Protect detects there is not enough space in the file
system to hold all the migrated files if all are recalled. If you are
using GPFS storage pools, each pool needs to have enough space to recall
it's files.

System action:

IBM Spectrum Protect does not attempt to recall all the migrated files.

User response:

Make room in the file system by increasing the file system size or
removing some files. Retry the operation.

------------------------------------------------------------------------
ANS9081W

program-name: orphaned stub file(s) detected in file system file-system.



Explanation:

IBM Spectrum Protect detected one or more orphaned stub files. Either
the migration server was changed in the client system options file after
the file was migrated, or the migration server database is damaged.

System action:

IBM Spectrum Protect does not attempt to remove space management from
the file system.

User response:

Determine the cause of orphaned stub files. Switch to the correct
migration server and recall the migrated files. Retry the operation.

------------------------------------------------------------------------
ANS9082W

program-name: error encountered while reconciling file system
file-system.



Explanation:

IBM Spectrum Protect encountered an error performing reconciliation on
the file system.

System action:

Processing continues.

User response:

Refer to other messages displayed or messages in the log to correct the
problem. Then retry the operation.

------------------------------------------------------------------------
ANS9083W

program-name: cannot deactivate space management on file system
file-system.



Explanation:

IBM Spectrum Protect cannot deactivate space management on the file
system.

System action:

Processing continues.

User response:

Correct the error if possible and retry the operation.

------------------------------------------------------------------------
ANS9084E

program-name: file-system is not managed or not locally managed by space
management.



Explanation:

There is no entry for the file system in the dsmmigfstab file or the
file system is managed by another node.

System action:

IBM Spectrum Protect will not perform space management functions on this
file system.

User response:

Add space management to the file system, if appropriate, and then retry
the operation. If the file system is not locally managed, retry the
operation on the node managing the file system.

------------------------------------------------------------------------
ANS9085E

program-name: file system file-system is not managed by space
management.



Explanation:

There is no entry for the file system in the dsmmigfstab file.

System action:

IBM Spectrum Protect will not perform space management functions on this
file system.

User response:

Add space management to the file system, if appropriate, and then retry
the operation.

------------------------------------------------------------------------
ANS9086E

program-name: A DMAPI error occured adding space management to file
system file-system, it is possible DMAPI is disabled on this file
system. The system set the error code: errno = errno-value



Explanation:

IBM Spectrum Protect encountered an error and cannot add space
management to the file system.

System action:

The Space management cannot be added to file system.

User response:

Verify that DMAPI is enabled for this file system and retry the
operation.

------------------------------------------------------------------------
ANS9087I

Space management is successfully added to file system file-system.



Explanation:

IBM Spectrum Protect has added space management to the file system, and
will now monitor its space usage. You can also perform other space
management operations on this file system.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9088W

program-name: space management is already active for file system
filesystem.



Explanation:

This message is issued when trying to add space management to a
filesystem with space management already activated. It is not possible
to add space management for a filesystem that already has space
management activated.

System action:

The action was cancelled.

User response:

In case you wanted to update the filesystem's space management
configuration instead, use the appropriate update command.

------------------------------------------------------------------------
ANS9089E

The group backup validation failed. One or more files were added,
removed, or changed during the backup.



Explanation:

One or more files have been added, removed, or changed from the time
WebSphere was queried to the time that all the data was sent to the IBM
Spectrum Protect server. Check the dsmerror.log file for a list of files
that were added, removed, or changed.

System action:

The backup fails.

User response:

Try the backup again.

------------------------------------------------------------------------
ANS9090E

program-name: file-system is not a valid file system name.



Explanation:

IBM Spectrum Protect received an invalid file system name. The file
system is not mounted, or is not mounted correctly.

System action:

Processing continues.

User response:

Correct the file system name, and retry the operation.

------------------------------------------------------------------------
ANS9091E

The WebSphere backup validation failed. One or more files were added,
removed, or changed during the backup.



Explanation:

One or more files have been added, removed, or changed from the time
WebSphere was queried to the time that all the data was sent to the IBM
Spectrum Protect server. Check the dsmerror.log file for a list of files
that were added, removed, or changed.

System action:

The backup fails.

User response:

Try the backup again. Do not install new WebSphere applications or
change the WebSphere configuration while in the backup window.

------------------------------------------------------------------------
ANS9092E

An operation is attempted that is only supported for an primary server.
However the server 'option-value' is the failover server.



Explanation:

Only primary server is allowed to use for reconciliation and
dsmmigundelete.

System action:

Processing stops.

User response:

Specify the primary server.

------------------------------------------------------------------------
ANS9093W

program-name: cannot update migration candidates list file-name.



Explanation:

IBM Spectrum Protect cannot update the migration candidates list because
not enough memory is available to create a temporary file.

System action:

Processing stops.

User response:

Make some memory available by ending some processes, and then retry the
operation.

------------------------------------------------------------------------
ANS9094W

program-name: no candidates found in file system file-system.



Explanation:

IBM Spectrum Protect found no files eligible for migration in the file
system after running dsmreconcile.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9098E

program-name: space management does not support file system file-system.



Explanation:

The space management does not support this type of file system. Space
management supports only true local file systems (e.g. JFS on AIX).
Space management does not support other types of file systems (AFS, NFS,
etc).

System action:

Processing of the file system stopped.

User response:

None.

------------------------------------------------------------------------
ANS9099E

program-name: space management is not active for file system
file-system.



Explanation:

IBM Spectrum Protect found the file system did not have space management
activated.

System action:

Processing of that file system stopped.

User response:

Reactivate space management for the file system.

------------------------------------------------------------------------
ANS9100E

Unable to open file 'filename' for output.



Explanation:

The file name specified cannot be opened.

System action:

Make sure that user has access to write to specified file, or use
different file name.

User response:

Output will not be saved. Please specify different file or check
permissions on chose file.

------------------------------------------------------------------------
ANS9101E

Migrated files matching 'file-name' could not be found.



Explanation:

File name for search pattern can not be found in the IBM Spectrum
Protect server database as a migrated file.

System action:

No query result.

User response:

Verify that the search patter is correct.

------------------------------------------------------------------------
ANS9117E

Virtual machine 'VM_name' contains one or more of the following
unsupported special characters special_characters_list.



Explanation:

The specified virtual machine name contains characters that are not
supported for virtual machine backup and restore operations. The
following characters are not supported in names of restored virtual
machines: ":;'\"*?,<>/\\|"

System action:

The backup or restore for the specified virtual machine failed.

User response:

Rename the virtual machine without using unsupported special characters.

------------------------------------------------------------------------
ANS9121I

Activate completed.



Explanation:

A Domino activate databases operation was completed.

System action:

IBM Spectrum Protect activated the databases.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9126E

program-name: cannot determine whether space management is active or
inactive for file-system due to error: error.



Explanation:

The program 'program-name' indicated in the message text was unable to
obtain statistics for file system 'file-system'. Therefore the program
cannot determine whether space management is activated, deactivated, or
globally deactivated on that file system. The message text includes a
description of the Unix errno error that occurred while trying to get
the state of space management.

System action:

IBM Spectrum Protect stops the operation.

User response:

Verify that the file system is mounted and accessible. Using the
appropriate tools for that file system, check whether there are any I/O
or other integrity errors on that file system. Then try the operation
again. If the operation fails, then a system reboot might clear the
error condition. If, after taking these actions the problem persists,
contact IBM technical support for assistance.

------------------------------------------------------------------------
ANS9128I

Inactivate logs completed.



Explanation:

A Domino inactivate log operation was completed.

System action:

IBM Spectrum Protect inactivated the log.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9130E

The virtual machine name contains only whitespace characters.



Explanation:

The virtual machine name that was specified contains only whitespace
characters. A name consisting of only whitespace characters is not
supported for virtual machine backup and restore operations.

System action:

The backup or restore for the specified virtual machine failed.

User response:

Rename the virtual machine using valid characters. Try the operation
again.

------------------------------------------------------------------------
ANS9133E

program name: space management already active for filesystem.



Explanation:

This message is issued when trying to add space management to a
filesystem with space management already activated.

System action:

The action was cancelled.

User response:

Check the filesystem's space management configuration and consider
updating it in case it does not match your needs. It is not possible to
add space management for a filesystem that already has space management
activated.

------------------------------------------------------------------------
ANS9134E

program name: space management not active for filesystem.



Explanation:

The program requested the space management configuration for a file
system where space management is not active.

System action:

The action was cancelled.

User response:

In case you entered the filesystem specification, check for correct
spelling. It is not possible to perform space management actions on a
filesystem with space management not activated.

------------------------------------------------------------------------
ANS9135E

program name: space management for filesystem not controlled by the
local node.



Explanation:

The program requested the space management configuration for a file
system where space management is active, but not controlled by the local
node. In cluster environments, some space management actions are allowed
from the owner node only.

System action:

The action was cancelled.

User response:

Determine the controller node for this filesystem and retry.

------------------------------------------------------------------------
ANS9136E

program name: could not remove configuration file for filesystem.



Explanation:

During removal of space management for the given filesystem, this
configuration file could not be removed.

System action:

Space management could not be deactivated for this filesystem.

User response:

Determine the reason why the file could not be removed and retry.

------------------------------------------------------------------------
ANS9137I

File: file-name is not premigrated.



Explanation:

File must be premigrated to migrate it.

System action:

The file was skipped.

User response:

The migration of premigrated files requires that the file is in
premigration state.

------------------------------------------------------------------------
ANS9140E

The migration options premigration and stub cannot be combined.



Explanation:

The migration option premigration and stub are mutual exclusive. Both
options end in different results for the same file.

System action:

Command ends without changes to the file.

User response:

Use the migration options premigration and stub in different instances
of the command.

------------------------------------------------------------------------
ANS9145E

Virtual machine will not be backed up because it has an empty name.



Explanation:

The specified virtual machine name is empty. This is not supported for
virtual machine backup and restore operations.

System action:

The backup for the specified virtual machine fails.

User response:

Rename the virtual machine so that its name contains supported
characters.

------------------------------------------------------------------------
ANS9146E

The dsmrecalld daemon process running on node local-node cannot reach
the counterpart on node remote-node. RPC error code: rpcStat-value,
reason: rpcStat-explanation



Explanation:

IBM Spectrum Protect dsmrecalld executable running on the local node was
unable to connect to the remote counterpart executable via RPC.

System action:

Processing of the current operation is stopped.

User response:

Login to the indicated remote node and ensure that the dsmrecalld daemon
processes are running. If the daemon processes are running but the
warning continues, make sure that the appropriate RPC services are up
and running on both nodes. To do so: - on Linux, run 'service portmap
status' or 'service rpcbind status' or 'systemctl status rpcbind'
command depending on the Linux distribution in use; - on AIX, run 'lssrc
-s portmap' command. If the RPC error reason is "Program not registered"
or the RPC error persists even upon the RPC service restart, restart all
the HSM daemons via 'dsmmigfs restart' command on both nodes.

------------------------------------------------------------------------
ANS9147E

program-name: cannot read file-spec: error.



Explanation:

IBM Spectrum Protect cannot read this file.

System action:

IBM Spectrum Protect cannot fully complete the requested operation.

User response:

An error occurred reading an HSM managed file system status file. Verify
that the file system is mounted and enabled for HSM and is actually
managed by HSM and then try the operation again. If the problem
persists, contact IBM technical support for further assistance. Provide
the output from the mount, dsmdf and ls -l [file system name] commands.

------------------------------------------------------------------------
ANS9148E

program-name: cannot find mount point for file system file-system.



Explanation:

IBM Spectrum Protect cannot find file system mount point.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

The specified file system is not currently mounted. Mount the file
system and try the operation again.

------------------------------------------------------------------------
ANS9150I

Archive log completed.



Explanation:

A Domino archive log operation was completed.

System action:

IBM Spectrum Protect archived the log.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9151E

An unexpected program error was encountered . IBM Spectrum Protect
function name : function-name IBM Spectrum Protect function :
function-desc IBM Spectrum Protect return code : TSM-rc IBM Spectrum
Protect file : file-name (line-number)



Explanation:

None.

System action:

Processing stops.

User response:

Check error log for more information. Contact the IBM Spectrum Protect
administrator with the information provided in this message.

------------------------------------------------------------------------
ANS9152E

program-name: cannot deactivate space management for whole system:
error.



Explanation:

Space management cannot be deactivated for the whole machine.

System action:

IBM Spectrum Protect cannot deactivate space management support.

User response:

The HSM global status is inaccessible, possibly due to concurrent
access. Try the operation again. If the problem continues, examine the
output of the shell command ps -aef as well as the contents of
/etc/adsm/SpaceMan/config/dmiFSGlobalState.pid. If a pid is stored in
this file and it does correspond to a running process, remove the
dmiFSGlobalState.pid file and retry the operation. If the problem
persists, reboot the system and repeat the appropriate analysis for your
file system type.

------------------------------------------------------------------------
ANS9153E

program-name: cannot reactivate space management for whole system:
error.



Explanation:

Space management cannot be reactivated for the whole machine.

System action:

IBM Spectrum Protect cannot reactivate space management support.

User response:

The HSM global status is inaccessible, possibly due to concurrent
access. Try the operation again. If the problem continues, examine the
output of the shell command ps -aef as well as the contents of
/etc/adsm/SpaceMan/config/dmiFSGlobalState.pid. If a pid is stored in
this file and it does correspond to a running process, remove the
dmiFSGlobalState.pid file and retry the operation. If the problem
persists, reboot the system and repeat the appropriate analysis for your
file system type.

------------------------------------------------------------------------
ANS9154E

program-name: cannot deactivate space management for file system
file-system: error.



Explanation:

Space management cannot be deactivated for the file system.

System action:

IBM Spectrum Protect unable to deactivate space management support for
the file system.

User response:

The HSM file system status is inaccessible, possibly due to concurrent
access. Try the operation again. If the problem continues verify that
the file system is mounted and that HSM is enabled on the file system
with the Unix shell commands mount and dsmdf. If the problem persists,
reboot the system and try the operation again.

------------------------------------------------------------------------
ANS9155E

program-name: cannot reactivate space management for file system
file-system: error.



Explanation:

Space management cannot be reactivated for the file system.

System action:

IBM Spectrum Protect cannot reactivate space management support to the
file system.

User response:

The HSM file system status is inaccessible, possibly due to concurrent
access. Try the operation again. If the problem continues, verify that
the file system is mounted and that HSM is enabled on the file system
with the Unix shell commands mount and dsmdf. If the problem persists,
reboot the system and try the operation again.

------------------------------------------------------------------------
ANS9156I

Rollforward completed.



Explanation:

A Domino DB2 rollforward operation was completed.

System action:

IBM Spectrum Protect rollforward the Domino DB2 database log.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9159E

program-name: unable to create temporary file.



Explanation:

IBM Spectrum Protect cannot create a temporary file.

System action:

IBM Spectrum Protect cannot complete its operation.

User response:

Check with the Unix mount shell command that /tmp and /etc exist as
separate file systems on your system. Use the df command to check
whether they are full. Create additional space by deleting files or
increasing the file system size.

------------------------------------------------------------------------
ANS9160E

program-name: cannot write to temporary file or status filefile-spec:
error.



Explanation:

IBM Spectrum Protect cannot complete writing to the temporary file.

System action:

IBM Spectrum Protect cannot complete the requested operation.

User response:

The Unix error code may provide guidance as to why the write failed. Use
the Unix mount and df shell commands to verify that the associated file
system is mounted and has space available. If this message resulted from
a shell command, mount the file system and create additional space if
necessary, then retry the operation. If the message did not result from
a shell command, restart the daemons. If the problem persists, reboot
the system.

------------------------------------------------------------------------
ANS9161E

Invalid backupset file or device name entered.



Explanation:

The backupset file or device name specified does not contain a valid
backupset.

System action:

Processing stopped.

User response:

Specify a file name or device that contains a valid backupset and retry
the operation.

------------------------------------------------------------------------
ANS9162W

Object: 'dir-name' is skipped for recall: It is a directory.



Explanation:

The object is a directory. Space management does not recall directories.

System action:

IBM Spectrum Protect does not recall this object because it is a
directory.

User response:

None.

------------------------------------------------------------------------
ANS9163W

program-name: Could not acquire the recall daemon session id.



Explanation:

Could not set up the event disposition for the file system, because the
recall daemon session could not be acquired. It seems the recall daemon
is not running. Recall requests will not be handled, which means the IBM
Spectrum Protect client for space management can't react to recall
requests for this file system.

System action:

IBM Spectrum Protect could not set up the recall event handling. The
recall event handling is not enabled for this filesystem.

User response:

Start or restart the recall daemon.

------------------------------------------------------------------------
ANS9164W

program-name: Could not acquire the monitor daemon session id.



Explanation:

Could not set up the event disposition for the file system, because the
monitor daemon session could not be acquired. It seems the monitor
daemon is not running. Thus the thresholds for file system usage will
not be monitored and the NOSPACE event will not be handled, which means
the file system may run out of space.

System action:

IBM Spectrum Protect could not set up the NOSPACE event handling. The
NOSPACE event handling is not enabled for this filesystem.

User response:

Start or restart the monitor daemon.

------------------------------------------------------------------------
ANS9165E

program-name cannot open directory directory-spec due to the following
error: error.



Explanation:

The directory indicated in the message text cannot be opened. The
message text includes a description of the error that occurred.

System action:

The requested operation is not completed.

User response:

Try to correct the error condition that is indicated in the message
text, then try the operation again. If the problem persists, contact IBM
technical support for further assistance.

------------------------------------------------------------------------
ANS9166I

A 'backup type' backup version backup date 'datetime' is not consistent
with local repository and has been deleted from the server (object
name='filespace namepath-namefile-name', ID = 'object-id:object-id').



Explanation:

The specified backup instance of the named object is not valid with
local repository contents. This could happen if local repository is
modified or got corrupted on the client system. This backup can not be
restored, therefore it will be deleted on the server.

System action:

The specified backup object will be deleted on the server. Processing
will continue.

User response:

None.

------------------------------------------------------------------------
ANS9167W

The client cache for adaptive subfile backup is corrupt and cannot be
used.



Explanation:

The adaptive subfile cache has become corrupt. While the backup client
can detect the corruption, the reason for the corruption cannot be
determined.

System action:

The IBM Spectrum Protect client will proceed with standard selective or
incremental backup. The cache will be rebuilt so that subsequent backups
will use the adaptive subfile technique.

User response:

If the problem persists, contact IBM technical support for assistance.
Be prepared to provide the client error log, which will contain
additional messages that might be useful for support to help identify
the problem.

------------------------------------------------------------------------
ANS9169E

program-name: cannot create directory directory-spec, reason.



Explanation:

IBM Spectrum Protect cannot create this directory.

System action:

IBM Spectrum Protect does not create this directory.

User response:

Verify that this directory does not already exist, and that its parent
directory has proper permissions.

------------------------------------------------------------------------
ANS9170E

program-name: file-system is not a mounted local file system.



Explanation:

IBM Spectrum Protect did not find that this file system is properly
mounted.

System action:

IBM Spectrum Protect ignores the file system.

User response:

Verify that this file system is local and mounted and activated
properly.

------------------------------------------------------------------------
ANS9171E

An error internal to IBM Spectrum Protect has occurred. The following
string is too long: error.



Explanation:

None.

System action:

The requested operation does not complete.

User response:

A system reboot might clear up the problem, after which the operation
should be tried again. If the problem persists, contact IBM technical
support for further assistance.

------------------------------------------------------------------------
ANS9174I

A backup delete completed.



Explanation:

A Backup delete was completed.

System action:

IBM Spectrum Protect deleted backup files.

------------------------------------------------------------------------
ANS9177W

All data events for remote recalls running on node: 'cluster node ID',
hostname: 'cluster node hostname' are going to be aborted.



Explanation:

The remote node is not responding, so all DMAPI data events which are
currently being processed on this remote node should be aborted. This
warning is likely caused by an RPC communication issue between the local
node and the specified remote node.

System action:

The dsmrecalld distributor process is going to abort all data events (if
any) which are currently being processed on the specified remote node.

User response:

Ensure that the network and host connection are configured correctly.
Then, retry the recall operation.

------------------------------------------------------------------------
ANS9178E

program-name cannot open file file-spec due to the following error:
error.



Explanation:

The program indicated in the message text was unable to open the
specified file. The message text also includes a description of the
error that occurred when it tried to open the file.

System action:

The requested operation does not complete.

User response:

Verify that the file system on which the file resides is mounted, then
try the operation again. A system reboot might clear up the problem. If
the problem persists, contact IBM technical support for further
assistance.

------------------------------------------------------------------------
ANS9179W

The operation completed successfully. However, some error occurred on
creation of the required vApps list.



Explanation:

One or more of the items included in the vApps specification were not
found. This can be caused by a change in the vCD organizations
configuration or a user mistake in the provided vApp spec.

System action:

The operation completes successfully

User response:

Check the local client error log for a reason for the failure and check
the command specification. Correct any issues and execute the command
again.

------------------------------------------------------------------------
ANS9180W

An entry in the password file could not be decrypted.



Explanation:

The password failed decryption validation.

System action:

The password in the password file will be ignored. You will be prompted
for the password, unless the process is running in the background, such
as in scheduling mode.

User response:

Enter the password when prompted.

------------------------------------------------------------------------
ANS9184E

program-name cannot allocate memory due to the following error: error.



Explanation:

A memory allocation error occurred. The message text includes a
description of the error that occurred.

System action:

The requested operation does not complete.

User response:

Try the operation again. If the problem occurs in an HSM daemon, restart
the daemon, then try the operation again. If the problem continues to
occur, use your operating system's administrative tools to check virtual
memory (swap space) on your system, and increase it if necessary. Check
whether an application is consuming available virtual memory. A system
reboot might also clear up the problem. If the problem persists, contact
IBM technical support for further assistance.

------------------------------------------------------------------------
ANS9186E

program-name: cannot open mounted file system file-system: error.



Explanation:

IBM Spectrum Protect cannot open mounted file system.

System action:

IBM Spectrum Protect ignores the file system.

User response:

Verify that this file system is mounted and activated properly.

------------------------------------------------------------------------
ANS9201W

LAN-free path failed.



Explanation:

A LAN-free connection could not be made.

System action:

The system will connect to the server without using the LAN-free path.

User response:

Verify your LAN-free setup.

------------------------------------------------------------------------
ANS9203E

ENABLELANFREE can not be used when HSM is installed.



Explanation:

The IBM Spectrum Protect Client has detected that HSM is installed on
the system. LAN-free is not a valid option when HSM is installed.

*  This error occurs on AIX when this file is found:
   /usr/tivoli/tsm/client/hsm/bin/dsmrecalld

*  This error occurs on Solaris when this file is found:
   /opt/tivoli/tsm/client/hsm/bin/dsmrecalld

System action:

An invalid option is detected and processing stops.

User response:

Remove the ENABLELANFREE option from the system option file.
ENABLELANFREE can only be used when HSM is not installed.

------------------------------------------------------------------------
ANS9220E

The name of the virtual machine 'VM_name' contains 'VM_name_length'
characters. This length exceeds the maximum allowed by the hypervisor
'hypervisor_name' which is 'max_hypervisor_VM_name_length' characters.



Explanation:

The length of the name of the virtual machine exceeds the maximum length
allowed by the hypervisor.

System action:

The restore of the specified virtual machine failed.

User response:

Rename the virtual machine with a name that does not exceed the maximum
length set by the hypervisor. Try the restore operation again.

------------------------------------------------------------------------
ANS9240W

Could not acquire the serial number of disk 'disk-name' at LUN LUN-id.



Explanation:

IBM Spectrum Protect was not able to determine the serial number of the
specified disk. The disk may not support SCSI inquiries of the Vital
Product Data on page 0x80.

System action:

Server-free data movement will not be possible for data residing on the
specified disk.

User response:

None.

------------------------------------------------------------------------
ANS9249E

File 'file-namefile-namefile-name' accessed during migration. File
skipped.



Explanation:

The specified file-name was not migrated because the file was accessed
by another process during the attempt to migrate it.

System action:

IBM Spectrum Protect left the file resident.

User response:

If you want the file migrated, stop the process which is accessing the
file and retry the migration.

------------------------------------------------------------------------
ANS9250I

File system 'file-system' reconciliation completed.



Explanation:

IBM Spectrum Protect has finished reconciling the file system.

System action:

Processing continues.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9251E

ProgramName: Cannot parse command-line options correctly.



Explanation:

An internal program error occurred trying to parse the command-line
arguments.

System action:

The program is not able to process the request.

User response:

Use the -h or -help option to see what options are allowed on the
command-line, then retry the request.

------------------------------------------------------------------------
ANS9252I

Value of environment variable: envVar.



Explanation:

None.

System action:

This message is informational.

User response:

None.

------------------------------------------------------------------------
ANS9255I

An empty status file will be generated.



Explanation:

The HSM status file is missing or can not be opened. An empty status
file will be created.

System action:

File data migration will continue to work normally.

User response:

Please run dsmreconcile to create a complete status file.

------------------------------------------------------------------------
ANS9256E

File 'file-namefile-namefile-name' is currently opened by another
process.



Explanation:

The file is locked by a migration or recall operation. A file can be the
object of only one recall process or one recall operation at a time.

System action:

The file is skipped.

User response:

If this error is not a result of a parallel file migration or recall
operation, then this error might be due to the previous cancelled
migration or recall operation. In this case, restart the dsmrecalld
daemon and try the operation again.

------------------------------------------------------------------------
ANS9263W

You cannot restore both active and inactive versions of System State.



Explanation:

Restoring an active copy and inactive copy of System State is not
allowed.

System action:

No processing takes place.

User response:

Select either the active copy or the inactive copy to perform restore
operation.

------------------------------------------------------------------------
ANS9264E

Incremental backup of Virtual Machine 'vmname' failed with RC rc



Explanation:

The incremental backup of virtual machine volumes failed.

System action:

The backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS9267E

program-name: File system file-system has exceeded its quota.



Explanation:

IBM Spectrum Protect detects that the file system has exceeded its
quota. No more data can be migrated out of this file system.

System action:

IBM Spectrum Protect will not migrate files from this file system.

User response:

Recall some files, or ask the system administrator to increase the quota
for this file system.

------------------------------------------------------------------------
ANS9278E

Failure processing vmList option. RC=rc



Explanation:

Failure processing vmList option.

System action:

The backup can not continue.

User response:

Check for errors in the vmList option value. Refer to the documentation
for the vmList option for more information.

------------------------------------------------------------------------
ANS9279E

Failure locating Virtual Machine 'vmname' volumes. Failed with RC=rc



Explanation:

Virtual machine volumes can not found. Volume mount points are not
available on Backup Proxy machine.

System action:

The backup of the virtual machine can not continue. The next virtual
machine in the vmlist will be processed. The output of the vcbMounter
command will show the reason for the failure.

User response:

Issue a vcbMounter command for the virtual machine to determine the
reason for the failure. Refer to the documentation for that message for
more information.

------------------------------------------------------------------------
ANS9280E

'vmname' option must be set when running this operation.



Explanation:

A required option for the command is missing.

System action:

The operation can not continue.

User response:

Set the missing option using the Preference Editor or the command line.

------------------------------------------------------------------------
ANS9283E

No virtual machines have been associated with the Schedule Tag
'schedule'.



Explanation:

The command cannot execute because no virtual machines were found using
the provided schedule name. This error can also be caused by incorrect
settings for the 'Excluded' tag.

System action:

Processing stopped.

User response:

Try the operation again. Specify a schedule name that matches a relevant
schedule.

------------------------------------------------------------------------
ANS9287E

Invalid or unsupported device.



Explanation:

The logical volume device is either invalid or unsupported. Refer to the
documentation for device type support for image backup.

System action:

The logical volume operation is not performed.

User response:

For image backup source or image restore destination, specify a device
of one of the supported types.

------------------------------------------------------------------------
ANS9288W

File: file-name of logical size file-logical-size and allocated size
file-allocated-size is too small to qualify for migration.



Explanation:

To be eligible for migration, a file must satisfy all of the following
size criteria: - The file logical size is larger than the value of the
stubsize option. - The space that a file occupies (the allocated size)
is at least as great as the value of the minmigfilesize option.

System action:

IBM Spectrum Protect does not migrate this file because migration does
not free additional space.

User response:

Verify that the settings of the stubsize option and the minmigfilesize
option are appropriate for your migration requirements.

------------------------------------------------------------------------
ANS9289W

Object: 'dir-name' is skipped for migration: It is a directory.



Explanation:

The object is a directory. Space management does not migrate
directories.

System action:

IBM Spectrum Protect does not migrate this object because it is a
directory.

User response:

None.

------------------------------------------------------------------------
ANS9290W

File: file-name is skipped for migration: The file type is either
unknown or unsupported.



Explanation:

The file either cannot be read, is not a regular file, or its type is
unknown to the HSM client. The HSM client migrates only regular files
and does not migrate directories, symbolic links, and special files.

System action:

IBM Spectrum Protect does not migrate this file.

User response:

None.

------------------------------------------------------------------------
ANS9291E

program-name: A conflicting space management program is already running
in the file-system file system. Re-run this program later in this file
system.



Explanation:

IBM Spectrum Protect detected another program running in the file system
that cannot run at the same time as the program your tried to initiate.
The following programs cannot run at the same time for a file system:

   dsmreconcile
   dsmautomig
   dsmmigfs remove.

Also, dsmmigfs remove cannot run while a migration process is running in
the file system.

System action:

IBM Spectrum Protect will not run the program at this time.

User response:

Try running the program later.

------------------------------------------------------------------------
ANS9292E

program-name: Cannot access lock file lock-file/lock-filelock-file:
error



Explanation:

IBM Spectrum Protect cannot access a lock file due to an error. The lock
file provides serialization of certain programs to prevent conflicting
processes from running at the same time.

System action:

IBM Spectrum Protect will not run the program at this time.

User response:

Check the permissions on the directories leading up to the lock file and
also the permissions on the program executable.

------------------------------------------------------------------------
ANS9293E

The space management cannot access ERRORPROG error-program: error



Explanation:

IBM Spectrum Protect encountered an error trying to access the program
specified with the ERRORPROG option in your client system options file
(dsm.sys). This message will appear only the first time this error
occurs.

System action:

IBM Spectrum Protect cannot send a severe error message to the specified
error message program.

User response:

Check to make sure the program exists and that it accepts standard input
when run. It is usually best if ERRORPROG specifies the fully qualified
file name of the program.

------------------------------------------------------------------------
ANS9294I

No files matching 'file-name' were found.



Explanation:

You entered a search pattern or file name that cannot be found in the
local file system.

System action:

Processing stopped.

User response:

Ensure that your search pattern is correct, or specify a new search
string.

------------------------------------------------------------------------
ANS9296W

Performing image backup of the entire volume for volume name. The
IMAGEGAPSIZE option and used block image backup is not supported for
non-JFS2 file systems on AIX.



Explanation:

None.

System action:

The entire volume is backed up.

User response:

Refer to the client manual for additional information regarding the
IMAGEGAPSIZE option and used block image backup.

------------------------------------------------------------------------
ANS9297W

File file-name is skipped for migration: No backup copy found.



Explanation:

A management class is assigned to the file with the attribute
MIGREQUIRESBKUP set to YES. This option requires that there exists a
current backup copy of the file before migration. However, there is no
backup copy found on the migration server. This file is not migrated.
Note: IBM Spectrum Protect checks only the migration server for a backup
copy. If the migration server and backup server are different servers,
IBM Spectrum Protect does not find a backup copy of the file.

System action:

The file is skipped.

User response:

Back up this file on the migration server, or assign a management class
to this file that does not require a current backup copy. Try the
operation again.

------------------------------------------------------------------------
ANS9298W

File file-name is skipped for migration: Backup copy found is not
current.



Explanation:

A management class is assigned to the file with the attribute
MIGREQUIRESBKUP set to YES. This option requires that there exists a
current backup copy of the file before migration. However, the backup
copy found on the migration server is an old version. This file is not
migrated. Note: IBM Spectrum Protect checks only the migration server
for a backup copy. If the migration server and backup server are
different servers, there must be a valid backup copy of the file on the
migration server.

System action:

The file is skipped.

User response:

Back up the current file on the migration server, or assign a management
class to this file that does not require a current backup copy. Retry
the operation.

------------------------------------------------------------------------
ANS9299I

Cannot get the number of migrated files for file system file-system.



Explanation:

Failed to get the number of migrated files on the file system. The
number is stored in the status file for the file system.

System action:

If you are removing space management from the file system, processing
stops. Space management is not removed.

User response:

Run reconciliation to reconcile the file system. Retry operation.

------------------------------------------------------------------------
ANS9300I

Migrated files found in file system file-system. Check for any error
encountered during recall.



Explanation:

Remove space management failed because there are migrated files in the
file system. IBM Spectrum Protect was unable to recall any files, or
some of the migrated files may have failed during a recall operation.

System action:

IBM Spectrum Protect remove processing stops.

User response:

Check for error messages that occurred during the recall process,
correct any problems, and retry the remove process.

------------------------------------------------------------------------
ANS9301E

Full VM backup of Virtual Machine 'vmname' failed with RC rc



Explanation:

The Full VM backup of virtual machine failed.

System action:

The full backup of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS9302E

The Restore VM command does not support VMBACKUPTYPE=FILE data. VM File
level restore must be run from inside the virtual machine or with the
'asnodename' option.



Explanation:

The Restore VM function not supported for file level data.

System action:

The system does not process your requested action.

User response:

Virtual machine File level restore must be run from inside the virtual
machine or with the asnodename option. To process a full virtual machine
restore, issue the command with VMBACKUPTYPE=FULLVM.

------------------------------------------------------------------------
ANS9303E

Full VM restore of Virtual Machine 'vmname' failed with RC rc



Explanation:

The Full VM restore of virtual machine failed.

System action:

The full restore of the virtual machine finished with failures. The next
virtual machine in the vmlist will be processed. The reason for the
failure is written to the local client error log.

User response:

Check the local client error log for reason for the failure.

------------------------------------------------------------------------
ANS9304E

VMware Converter tool not installed on system.



Explanation:

VMware Converter tool install could not be detected on system.

System action:

The full virtual machine image files have been restored successfully at
the specified location.

User response:

No further action is necessary. The full virtual machine images files
can be used by various tools. VMware Converter tool can be installed on
system.

------------------------------------------------------------------------
ANS9305E

An invalid Hyper-V VM name 'string' was entered.



Explanation:

You entered a Hyper-V VM name that contains incorrect characters or
contains wildcard characters.

System action:

Processing stopped.

User response:

Enter a correct Hyper-V VM name.

------------------------------------------------------------------------
ANS9306E

An invalid Hyper-V VM list 'string' was entered.



Explanation:

You entered a Hyper-V VM list that contains incorrect characters or
contains wildcard characters.

System action:

Processing stopped.

User response:

Enter a correct Hyper-V VM list.

------------------------------------------------------------------------
ANS9307E

No Hyper-V VM name or VMList entered



Explanation:

No Hyper-V VM name or VMList parameter was specified.

System action:

Processing stopped.

User response:

Specify a correct Hyper-V VM name or VMList parameter.

------------------------------------------------------------------------
ANS9308E

No match found for the Hyper-V VM name or VMList 'string' entered



Explanation:

No match found for the Hyper-V VM name or VMList parameter entered.

System action:

Processing stopped.

User response:

Specify a correct Hyper-V VM name or VMList parameter.

------------------------------------------------------------------------
ANS9309E

Pick option specified but also a value for the Hyper-V VM name or VMList
'string' entered



Explanation:

You cannot specify the -pick option and also include a Hyper-V VM name
or VMList parameter.

System action:

Processing stopped.

User response:

Specify the -pick option without a Hyper-V VM name or VMList parameter.

------------------------------------------------------------------------
ANS9311E

No Hyper-V VMs exist on the IBM Spectrum Protect server



Explanation:

No filespaces representing a Hyper-V Virtual Machine currently exist on
the IBM Spectrum Protect server.

System action:

Processing stopped.

User response:

You must successfully backup a Hyper-V Virtual Machine before using this
command.

------------------------------------------------------------------------
ANS9312S

program-name: Cannot change owner/group on file: file-name: error



Explanation:

IBM Spectrum Protect cannot change the ownership or group, or both for
the specified file. This change is necessary for space management to run
properly.

System action:

Processing stops.

User response:

Ensure that directory permissions allow the file owner or group to be
changed. Reissue the command.

------------------------------------------------------------------------
ANS9313E

program-name: The TMP directory is full.



Explanation:

The TMP directory from the operating system is full.

System action:

Process stops.

User response:

Delete some files in the TMP directory and retry the operation.

------------------------------------------------------------------------
ANS9316T

File system 'file-system' undelete completed.



Explanation:

IBM Spectrum Protect has finished undeleting the file system.

System action:

Processing continues.

User response:

Continue with normal operations.

------------------------------------------------------------------------
ANS9330E

The virtual machine that was specified on the string command could not
be found or was excluded from the operation.



Explanation:

The command cannot complete because the virtual machine could not be
found or was excluded from the operation.

System action:

Processing stopped.

User response:

Try the operation again. Specify a correct VM name or DOMAIN option.
This error can also be caused by incorrect settings for the VMHOST,
VMHOSTCLUSTER, VMFOLDER, VMDATASTORE, -VM options, or the 'Excluded'
tag. The VMHOST option value must be specified as an IP address or as a
server name that is in fully qualified domain name (FQDN) format. The
host name that you specify must match the host name as it is displayed
in the vCenter server in the Host and Clusters view. This host name
could can be the fully qualified host name (FQDN), the shortened domain
name, or the host IP address.

------------------------------------------------------------------------
ANS9331W

VMware vCenter or ESX Server userid and password for VMC Host <host> VMC
Userid <userid> could not be read from encrypted pwd file.



Explanation:

VMware vCenter or ESX Server userid and password could not be read from
encrypted password file.

System action:

Processing stops.

User response:

Use dsmc SET PASSWORD -type=VM 'vCenter hostname' 'userid' 'password' to
save encrypted password.

------------------------------------------------------------------------
ANS9332E

VMware vCenter or ESX Server userid and password not set. Use dsmc SET
PASSWORD -type=VM 'vCenter hostname' 'userid' 'password' to save
encrypted password.



Explanation:

VMware vCenter or ESX Server userid and password could not be read from
encrypted password file.

System action:

Processing stops.

User response:

Use dsmc SET PASSWORD -type=VM 'vCenter hostname' 'userid' 'password' to
save encrypted password.

------------------------------------------------------------------------
ANS9333E

Unable to re-create 'file-name' as a stub file due to Unix-system-call()
failure; errno: error; reason: 'error-reason'.



Explanation:

IBM Spectrum Protect was unable to re-create the specified file as a
stub due to an error.

System action:

The processing continues with the next file.

User response:

Please, look into the dsmerror.log for further error details. If the
affected file path doesn't exist, restore it from your backup (if any)
or re-create it manually, then re-try the operation. Make sure that the
specified file system is IBM Spectrum Protect space managed, writable
and in consistent state.

------------------------------------------------------------------------
ANS9334E

Wrong alias 'alias-name' received from the server.



Explanation:

IBM Spectrum Protect could not build a valid pathname for a migrated
file due to the invalid alias received from the server.

System action:

The processing continues with the next file.

User response:

If possible, perform either an orphan check reconcile or an inline
incremental backup of the initial file, so that the alias is updated on
the server. Then, retry the operation. Otherwise, contact IBM Spectrum
Protect support for further investigation and problem resolution.

------------------------------------------------------------------------
ANS9347W

Warning:'domain-keyword' specified on Domain will be ignored when
connecting to VMware ESX/ESXi host. Connect to VMware vCenter to process
this domain.



Explanation:

None.

System action:

Domain keyword is ignored.

User response:

Connect to VMware vCenter to process this domain.

------------------------------------------------------------------------
ANS9350E

Backup operation failed due to volume mixture. Please refer to
explanation section for additional information.



Explanation:

IBM Spectrum Protect failed to create the backup because of the mixture
of volumes was detected. Some volumes selected meet the requirements for
importing snapshots only when needed and some do not. This situation
occurs when a backup operation is requested and the "Import VSS
snapshots Only When Needed" feature is enabled and not all the volumes
involved in the backup operation are managed by a VSS Hardware Provider
that supports transportable snapshots. Additionally the situation can
also occur in a clustered environment during a backup operation, when
not all the volumes involved in the backup operation are managed by a
VSS Hardware Provider that supports transportable snapshots.

System action:

processing stops.

User response:

Try the operation again by splitting the backup operation. Ensure that
all the volumes involved in the backup operation are either managed by a
Hardware Provider that supports transportable snapshots or that all the
volumes involved in the operation do not support transportable
snapshots. Additionally you may also turn off the "Import VSS snapshots
Only When Needed" feature to allow the backup to allow the mixure.

------------------------------------------------------------------------
ANS9351E

Data was not available on server and was skipped.



Explanation:

The data to be restored is not available on the server, so it will not
be restored.

System action:

The data is skipped, and the restore processing continues with the next
object to be restored.

User response:

Contact your IBM Spectrum Protect administrator.

------------------------------------------------------------------------
ANS9352E

SAN was chosen as the transport for at least one of the disks in the
operation, but the SAN policy is not OnlineAll for this datamover. SAN
cannot be used unless the SAN policy is OnlineAll.



Explanation:

SAN was chosen as the transport because either the default transport
setting was used, or it was specified in the VMVSTORTRANSPORT option. In
order to use SAN as the transport mode, the SAN policy must be set to
OnlineAll.

System action:

Restore processing stops.

User response:

Set the SAN policy to OnlineAll, or set VMVSTORTRANSPORT to something
other than SAN, such as NBD. Then try the restore operation again.

------------------------------------------------------------------------
ANS9354E

The node or owner name 'node' specified in the SET ACCESS command
exceeds the maximum allowed length (64).



Explanation:

An invalid node or owner name has been entered in the SET ACCESS
command.

System action:

Processing stops.

User response:

Enter the SET ACCESS command using the correct node or owner name.

------------------------------------------------------------------------
ANS9355E

VMware vStorage VI Web Service API reported error message: vstor-api-msg



Explanation:

The VMware vStorage VI Web Service API reported an error with the
specified message text.

System action:

Processing stops.

User response:

Check the dsmerror log file for additional information, and contact the
IBM Spectrum Protect administrator with the information provided in this
message.

------------------------------------------------------------------------
ANS9356E

A VMware vStorage API error was reported.



Explanation:

A VMware vStorage API was reported. See other messages displayed and
logged for additional information about the problem.

System action:

Processing stops.

User response:

Check the dsmerror log file for additional information, and contact the
IBM Spectrum Protect administrator with the information provided in this
message.

------------------------------------------------------------------------
ANS9357E

HOTADD was chosen as the transport for at least one of the disks in the
operation, but the SAN policy is not OfflineAll for this datamover.
HOTADD cannot be used unless the SAN policy is OfflineAll.



Explanation:

HOTADD was chosen as the transport because either the default transport
setting was used, or it was specified in the VMVSTORTRANSPORT option. In
order to use HOTADD as the transport mode, the SAN policy must be set to
OfflineAll.

System action:

Restore processing stops.

User response:

Set the SAN policy to OfflineAll, or set VMVSTORTRANSPORT to something
other than HOTADD, such as NBD. Then try the restore operation again.

------------------------------------------------------------------------
ANS9359W

program-name: file-system: high threshold high-threshold exceeds
recommended maximum max-threshold maximum percentage.



Explanation:

System performance can be impacted. There can be delays from waiting for
demand migration.

System action:

Processing continues.

User response:

Set the migration high threshold lower than the file system capacity.

------------------------------------------------------------------------
ANS9360W

program-name: file-system: configured low-threshold low threshold is
below the recommended minimum floor-percent low threshold.



Explanation:

IBM Spectrum Protect low threshold is not recommended to be less than
teh minimum space required by this file system and may result in endless
attempts to find migration candidates. Usage of the file system may be
higher than the recommended minimum of low threshold on GPFS and Veritas
because these types of file system allocate some space for metadata.

System action:

Processing continues.

User response:

Set the migration low threshold higher than the recommended-minimum size
of the file system.

------------------------------------------------------------------------
ANS9361W

program-name: file-system: the configured pre-mig premigration is
greater than the difference between the configured low-threshold low
threshold and the recommended-minimum size of the file system Min_size.



Explanation:

IBM Spectrum Protect premigration percentage below the low threshold may
not leave sufficient space for the file system, and can result in
endless attempts to find migration candidates. Usage of the file system
may be higher than the recommended minimum of low threshold on GPFS and
Veritas because these types of file system allocate some space for
metadata.

System action:

Processing continues.

User response:

Lower the premigration setting.

------------------------------------------------------------------------
ANS9362W

program-name: file-system: MAXFILES max-files is less than used inodes
used inodes in the file system. MAXFILES will be set to the minimum
possible value.



Explanation:

The specified MAXFILES value is below the number of files already
existing in the file system. The value will be ignored, and CFI will
default to the minimum possible size according to the number of
currently used inodes.

System action:

Processing continues.

User response:

Increase the value of MAXFILES.

------------------------------------------------------------------------
ANS9363W

program-name: file-system: MAXFILES max-files is more than files total
available inodes in the file system. MAXFILES will be set to the maximum
possible value.



Explanation:

The specified MAXFILES value is above the number of available inodes in
the file system. The value will be ignored, and CFI will default to the
maximum size that corresponds to the number of available inodes.

System action:

Processing continues.

User response:

Decrease the value of MAXFILES.

------------------------------------------------------------------------
ANS9364E

Failure initializing virtual machine environment. Refer to dsmerror.log
for detailed error messages.



Explanation:

Failure initializing virtual machine environment. Refer to dsmerror.log
for detailed error messages.

System action:

The backup can not continue.

User response:

Refer to dsmerror.log for detailed error message.

------------------------------------------------------------------------
ANS9365E

VMware vStorage API error for virtual machine 'VM-name'. IBM Spectrum
Protect function name : function-name IBM Spectrum Protect file :
file-name (line-number) API return code : TSM-rc API error message :
function-desc



Explanation:

None.

System action:

Processing stops.

User response:

If virtual machine backup fails and the error message points to function
ReadEnvironmentVariableInGuest(), verify the validity of guest virtual
machine login credentials, update virtual machine login credentials on
data mover if necessary. Contact the IBM Spectrum Protect administrator
with the information provided in this message.

------------------------------------------------------------------------
ANS9368W

WARNING: VMware Host Userid <hostuserid> read from pwd file different
than VMCUSER option value <vmcuserid>. Using VMCUSER option value.



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS9369W

WARNING: VMware VirtualCenter or ESX Server User Password for VMC Host
<host> VMC Userid <userid> set in options file.



Explanation:

None.

System action:

Processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS9370W

Use Preferences Editor or dsmc SET PASSWORD -type=VM 'VirtualCenter
hostname' 'userid' 'password' to save encrypted password.



Explanation:

The VMCPW option was found either in an option file or on the command
line. While this method of entry is allowed, it presents a security risk
because the password is in plain text and not encrypted.

System action:

The option is accepted and the VMC password is used in the current
session.

User response:

To save the encrypted password, use the Preferences Editor VM Backup
panel or the command: dsmc SET PASSWORD -type=VM 'VirtualCenter
hostname' 'userid' 'password'

------------------------------------------------------------------------
ANS9371I

program-name: file-system: The specified MAXFILES value is 0. The CFI
size will be calculated automatically now.



Explanation:

IBM Spectrum Protect The specified maxfiles value is 0, which means that
the CFI size is managed automatically now.

System action:

IBM Spectrum Protect continues.

User response:

none.

------------------------------------------------------------------------
ANS9372E

Unable to create the virtual machine to be restored due to an invalid
host name, datacenter name, or datastore name.



Explanation:

IBM Spectrum Protect was unable to create the virtual machine to be
restored because an invalid host name, datacenter name, or datastore
name was specified. Check the dsmerror log file for information on the
specific reason for the failure.

System action:

Processing stops.

User response:

Check the dsmerror log file for additional information, and contact the
IBM Spectrum Protect administrator with the information provided in this
message.

------------------------------------------------------------------------
ANS9373E

The backup of virtual machine 'vm-name' stopped because the backup
operation was not progressing.



Explanation:

IBM Spectrum Protect detected a deadlock, which prevents the backup
operation of the virtual machine to finish. The backup operation was
cancelled.

System action:

The backup of the virtual machine was cancelled.

User response:

Retry the backup of the virtual machine. If the problem persists,
contact IBM Software Support.

------------------------------------------------------------------------
ANS9374E

VMware vStorage virtual storage driver service is not running or could
not be found. Make sure VMware 'vstor2-mntapi20-shared.sys' service is
installed and running. Install the VMware vStorage API runtime files.



Explanation:

Failure initializing VMware vStorage API environment.

System action:

The backup can not continue.

User response:

Make sure the VMware 'vstor2-mntapi20-shared.sys' service is installed
and running. Install the VMware vStorage API runtime files.

------------------------------------------------------------------------
ANS9376E

The Backup VM command domain keyword 'domain-keyword' was specified, but
this domain does not contain any virtual machines. This error can also
occur if the value for the VMHOST parameter is not specified as an IP
address or as a fully qualified domain name.



Explanation:

The command cannot complete because the virtual machine could not be
found.

System action:

Processing stops.

User response:

Try the operation again. Ensure that the value for the VMHOST parameter
is specified as an IP address or as a fully qualified domain name. The
host name that you specify must match the host name as it is displayed
in the vCenter server in the Host and Clusters view. This could be the
fully qualified host name (FQDN), the shortened domain name, or the host
IP address.

------------------------------------------------------------------------
ANS9377E

No virtual machine is specified on the string command or the virtual
machine domain list could not be processed.



Explanation:

No virtual machine found with name or specified in domain option.

System action:

Processing stops.

User response:

Specify a correct VM name or domain option.

------------------------------------------------------------------------
ANS9378E

Unexpected error while fingeprinting the data



Explanation:

There was an error while fingerprinting the data. See the error log for
more information.

System action:

The object is not backed up.

User response:

Retry the operation. Retry the operation without client-side
deduplication. If the problem persists, contact IBM Spectrum Protect
technical support.

------------------------------------------------------------------------
ANS9379E

Unexpected error while deduplicating the data



Explanation:

There was an error while deduplicating the data. See the error log for
more information.

System action:

The object is not backed up.

User response:

Retry the operation. Retry the operation without client-side
deduplication. If the problem persists, contact IBM Spectrum Protect
technical support.

------------------------------------------------------------------------
ANS9380E

The virtual machine that was specified on the string command could not
be found.



Explanation:

The command cannot complete because the virtual machine could not be
found.

System action:

Processing stopped.

User response:

Try the operation again. Specify a correct VM name or DOMAIN option.
This error can also be caused by incorrect settings for the VMHOST,
VMHOSTCLUSTER, VMFOLDER or VMDATASTORE options. The VMHOST option value
must be specified as an IP address or as a server name that is in fully
qualified domain name (FQDN) format. The host name that you specify must
match the host name as it is displayed in the vCenter server in the Host
and Clusters view. This could be the fully qualified host name (FQDN),
the shortened domain name, or the host IP address.

------------------------------------------------------------------------
ANS9381I

The value set for vmlist option will be migrated to the new domain
option.



Explanation:

New option has been set.

System action:

Processing continues.

User response:

None.

------------------------------------------------------------------------
ANS9383E

The required files for the virtual machine operations were not found.
The files are installed only if the client is defined as a data mover in
IBM Spectrum Protect for Virtual Environments.



Explanation:

A failure occurred when initializing the virtual machine environment.

System action:

The operation cannot continue.

User response:

Install IBM Spectrum Protect for Virtual Environments package to use the
client to back up virtual machines.

------------------------------------------------------------------------
ANS9384W

Unable to get VMware Changed Block Tracking(CBT) data for virtual
machine 'virtual machine name'. Full VM backup continues, and includes
both used and unused areas of the disk.



Explanation:

IBM Spectrum Protect was unable to obtain Changed Block Tracking(CBT)
data for the specified virtual machine. The backup continues, but
instead of backing up just the used blocks (in the full VM backup case),
or just the changed blocks (in the incremental VM backup case), the
entire virtual machine is backed up. This backup includes both the used
and unused blocks of the disk.

System action:

The backup continues.

User response:

See the error log dsmerror.log for information about why the changed
block data is not obtained.

------------------------------------------------------------------------
ANS9385W

Error returned from VMware vStorage API for virtual machine 'VM-name' in
vSphere API function __ns2__QueryChangedDiskAreas. RC=API return code,
Detail message: API message



Explanation:

None.

System action:

CBT processing stops.

User response:

Contact the IBM Spectrum Protect administrator with the information
provided in this message.

------------------------------------------------------------------------
ANS9386W

Changed block tracking is not supported for virtual machine 'virtual
machine name'. A FULL backup of the disk will be performed and will
include both used and unused areas of the disk.



Explanation:

IBM Spectrum Protect was unable to obtain Changed Block Tracking(CBT)
data for the specified virtual machine because changed block tracking is
not supported. RDM disks in physical mode, virtual disks attached to
shared virtual SCSI bus, and VMs with hardware version 6 or earlier are
not supported. The backup continues, but instead of backing up just the
used blocks (in the full VM backup case), or just the changed blocks (in
the incremental VM backup case), the entire virtual machine is backed
up. This backup includes both the used and unused blocks of the disk.

System action:

The backup continues.

User response:

See the error log dsmerror.log for information about why the changed
block data is not obtained.

------------------------------------------------------------------------
ANS9387W

An incremental backup for virtual machine 'virtual machine name' is not
possible because changed block information cannot be obtained. A full VM
backup is attempted instead.



Explanation:

Changed block information is required to perform an incremental backup,
but the information could not be obtained from the virtual machine. The
information can be missing if two nodes back up the same virtual
machine. One node runs a daily incremental backup, and the other node
runs a weekly full backup. After the weekly full backup runs, the next
daily backup cannot obtain changed block information, so a full backup
is run instead of an incremental backup. Subsequent daily backups will
be incremental until the next weekly full backup.

System action:

The backup continues as a full backup instead of an incremental backup.

User response:

Search the IBM Spectrum Protect support site IBM Spectrum Protect
Support Portal
(https://www.ibm.com/mysupport/s/topic/0TO50000000IQWvGAO/spectrum-protect)
for this message number, for other possible causes of this error.

------------------------------------------------------------------------
ANS9388E

The management class 'management class name' specified for the 'option
name' option is invalid, or does not have a backup copy group.



Explanation:

The management class name for the specified option does not exist, or it
exists but does not have a valid backup copy group.

System action:

Processing stops.

User response:

Verify that the specified management class name is valid, and that it
contains a valid backup copy group.

------------------------------------------------------------------------
ANS9389W

The DEDUP backup attempt was unsuccessful for virtual machine 'virtual
machine name'. Retry #retry attempt number with DEDUP disabled.



Explanation:

The attempt to backup the virtual machine with DEDUP enabled was
unsuccessful. Instead of failing the backup right away, an attempt is
being made to backup the virtual machine with DEDUP disabled.

System action:

Processing continues with DEDUP disabled.

User response:

Check the log files for messages as to why DEDUP failed. If future
attempts to backup using DEDUP fail, contact your system administator.

------------------------------------------------------------------------
ANS9390W

The DEDUP backup attempt was unsuccessful for virtual machine 'virtual
machine name'. Retry #retry attempt number with DEDUP still enabled.



Explanation:

The attempt to backup the virtual machine with DEDUP enabled was
unsuccessful. Instead of failing the backup right away, an attempt is
being made to retry the backup of the virtual machine with DEDUP still
enabled.

System action:

Processing continues with DEDUP still enabled.

User response:

Check the log files for messages as to why DEDUP failed. If future
attempts to backup using DEDUP fail, contact your system administator.

------------------------------------------------------------------------
ANS9391W

Linux guest OS with EFI Boot enabled is not fully supported by IBM
Spectrum Protect VMware backup. Manual steps may be required following
restore to enable the virtual machine to power on correctly.



Explanation:

A restored Linux guest OS with EFI boot enabled may not successfully
start. Manual steps are required to successfully boot the guest OS.

System action:

Restore processing continues.

User response:

Following guest OS restore: remove and reattach the guest Linux boot
disk, select Guest Boot Option to enter EFI setup configuration on next
boot, power on the guest, enter EFI Boot Maintenance, add Boot Device,
select unnamed volume, give it a label, save and commit changes,
continue with boot.

------------------------------------------------------------------------
ANS9392W

No backupset name entered.



Explanation:

You must provide a backupset for this operation.

System action:

Processing stops.

User response:

Specify a valid backupset name.

------------------------------------------------------------------------
ANS9393W

Incorrect backupset name entered.



Explanation:

The backupset name provided was invalid. Wildcards are not allowed.

System action:

Processing stops.

User response:

Specify a valid backupset name.

------------------------------------------------------------------------
ANS9394W

No backupset file or device name entered.



Explanation:

You must provide a backupset file or device name for this operation.

System action:

Processing stops.

User response:

Specify a valid backupset file or device name.

------------------------------------------------------------------------
ANS9395E

The filespace has been migrated to the incremental forever model;
MODE=FULL and MODE=INCR are not valid.



Explanation:

You must run only incremental forever backup types (IFINCR or IFFULL) if
the filespace has been migrated to the incremental forever type.

System action:

Processing stops.

User response:

Specify either MODE=IFFULL or MODE=IFINCR.

------------------------------------------------------------------------
ANS9396W

Virtual machine 'VM' is not running. IBM Spectrum Protect Application
Protection will not be used while backing up this VM.



Explanation:

IBM Spectrum Protect Application Protection can only protect VMs that
are running.

System action:

IBM Spectrum Protect Application Protection uses the VMWare tools to
provide application consistency.

User response:

Turn on the virtual machine or exclude it from IBM Spectrum Protect
application protection by removing the INCLUDE.VMTSMVSS option for this
virtual machine. If you want logs to be truncated use INCLUDE.VMTSMVSS
to protect this machine.

------------------------------------------------------------------------
ANS9397W

IBM Spectrum Protect application protection cannot protect this machine.
Virtual machine 'VM' does not have operating system or applications
supported by IBM Spectrum Protect application protection.



Explanation:

The application protection can be used only for virtual machines that
have operating systems or applications that are supported by IBM
Spectrum Protect application protection. Refer to the product
documentation for the list of supported operating systems and
applications.

System action:

IBM Spectrum Protect will use the VMware Tools to provide application
consistency.

User response:

Exclude the virtual machine from application protection by removing the
INCLUDE.VMTSMVSS option for this virtual machine.

------------------------------------------------------------------------
ANS9398E

IBM Spectrum Protect application protection failed to initialize on
virtual machine 'VM'. See the error log for more details.



Explanation:

IBM Spectrum Protect application protection encountered an error during
initialization.

System action:

Processing stops.

User response:

See the error log for more details. Correct the error(s) and try the
operation again.

------------------------------------------------------------------------
ANS9399W

program-name: lock file access error for operation value on path value
value with errno text value.



Explanation:

A lock file operation has failed.

System action:

IBM Spectrum Protect logs the condition and continues processing, or
exits if directory not found.

User response:

Correct the configuration.

------------------------------------------------------------------------
ANS9400W

Unable to restore NVRAM file for vm 'virtual machine name'. Manual steps
may be required following restore to enable the virtual machine to power
on correctly.



Explanation:

IBM Spectrum Protect was unable to upload NVRAM file for the specified
virtual machine. The restore continues, but a restored guest OS with EFI
boot enabled may not successfully start. Manual steps may be required to
successfully boot the guest OS.

System action:

The restore continues.

User response:

Following guest OS restore if guest OS fails to boot: remove and
reattach the guest OS boot disk, select Guest Boot Option to enter EFI
setup configuration on next boot, power on the guest, enter EFI Boot
Maintenance, add Boot Device, select unnamed volume, give it a label,
save and commit changes, continue with boot.

------------------------------------------------------------------------
ANS9401E

program-name: Cannot kill recall daemon.



Explanation:

IBM Spectrum Protect A request for killing the recall daemon failed.
This may occur during node failover.

System action:

none.

User response:

Continue with normal operation unless further errors occur.

------------------------------------------------------------------------
ANS9402E

program-name: Cannot notify process name to recover HSM operations on a
failing node.



Explanation:

In order to assume the functionality of a failing partner node, the
dsmwatchd daemon must notify the local daemons.

System action:

none.

User response:

Communication cannot be established with the HSM daemon specified in
this message. Check whether the target daemon is running. Start or
restart the target daemon as appropriate. If the problem persists,
restart the GPFS cluster.

------------------------------------------------------------------------
ANS9403E

IBM Spectrum Protect has detected that the data to back up does not
match the list of data to back up that was sent from the virtual
machine. The backup of 'VM-Name' cannot continue.



Explanation:

The data that IBM Spectrum Protect would have backed up for a virtual
machine would not match the data needed for a correct backup. The backup
has been cancelled to prevent data loss.

System action:

The backup is cancelled to prevent data loss.

User response:

Retry the backup. If this error occurs again, contact IBM Software
Support.

------------------------------------------------------------------------
ANS9404E

Error creating the specified Virtual Machine. See log files for more
information.



Explanation:

An error was encountered creating the Virtual Machine. Look in the
dsmerror.log for additional information on why the Virtual Machine could
not be created.

System action:

Processing stops.

User response:

Check the dsmerror.log for more specific messages on why the virtual
machine could not be created.

------------------------------------------------------------------------
ANS9405I

program-name: The takeover of filesystem file system started.



Explanation:

The local activation of the specified file system started successfully.

System action:

IBM Spectrum Protect on the local node will try to activate the file
system that is space managed on another node.

User response:

None.

------------------------------------------------------------------------
ANS9410W

VMware Tools are either not runnning or out-of-date on virtual machine
'VM'. IBM Spectrum Protect application protection cannot be used.



Explanation:

IBM Spectrum Protect application protection requires that VMware tools
are installed and running with an up-to-date version on the virtual
machine.

System action:

IBM Spectrum Protect will not provide application consistency.
Application logs are not truncated.

User response:

Install and/or upgrade and/or start VMware Tools on the virtual machine
or exclude it from the application protection by removing the
INCLUDE.VMTSMVSS option for this virtual machine.

------------------------------------------------------------------------
ANS9411E

VSS provider registration failed. Command 'command' failed with Windows
RC=return code



Explanation:

IBM Spectrum Protect was unable to register the VSS provider on the
virtual machine.

System action:

Processing stops.

User response:

Restart the virtual machine and try the operation again.

------------------------------------------------------------------------
ANS9412E

program-name: Failover is disabled on the local machine. Aborting
failover ...



Explanation:

IBM Spectrum Protect Failover operations were disabled either by the
system or the user.

System action:

None.

User response:

Check failover policy if necessary.

------------------------------------------------------------------------
ANS9413E

The instant restore or instant access operation failed because these
operations do not support virtual machines that are in virtual volume
(VVOL) datastores.



Explanation:

The instant restore and instant access operations do not support
restores of virtual machines that are in VVOL datastores. VVOL
datastores do not support Raw Device Mapping (RDM), which is required
for these operations.

System action:

The operation fails.

User response:

For instant restore operations, specify a datastore and temporary
datastore that is not a VVOL datastore.For instant access operations,
specify a datastore that is not a VVOL datastore.

------------------------------------------------------------------------
ANS9414E

Application protection is enabled for virtual machine 'VM-name',
however, this virtual machine resides on a Virtual Volume (VVol)
datastore. Application protection needs to be disabled in order to back
up this virtual machine.



Explanation:

Application protection is not supported for virtual machines that reside
on VVol datastores.

System action:

The operation fails.

User response:

Disable application protection by removing the include.vmtsmvss option
from the options file and back up the virtual machine again.

------------------------------------------------------------------------
ANS9415E

Failed to copy 'source' to 'destination' with VMware RC=rc on virtual
machine 'guest VM name'.



Explanation:

IBM Spectrum Protect was unable to copy a file to the virtual machine.

System action:

Processing stops.

User response:

Verify that the source file exists and the destination is accessible.
Restart the virtual machine and try the operation again.

------------------------------------------------------------------------
ANS9416E

Cannot create the directory 'source' on the virtual machine with Windows
RC=rc



Explanation:

IBM Spectrum Protect client was unable to create the specified directory
on the virtual machine. It is possible that the directory exists and is
locked by a process.

System action:

Processing stops.

User response:

Verify the the specified directory does not exist on the virtual
machine. Restart the virtual machine and try the operation again.

------------------------------------------------------------------------
ANS9417E

IBM Spectrum Protect application protection could not freeze the VSS
writers on the virtual machine named 'VM'. See the error log for more
details.



Explanation:

IBM Spectrum Protect application protection encountered an error while
freezing the VSS writers.

System action:

Processing stops

User response:

Use the 'vssadmin list writers' command to determine if any VSS writers
detect errors on the virtual machine. Restart the VM. Retry the
operation. If the retry fails, see the error log for details about the
errors.

------------------------------------------------------------------------
ANS9418E

SAN was chosen as the transport for at least one of the disks in the
operation, but VMware Changed Block Tracking (CBT) is enabled on the
target VM. SAN cannot be used to update existing VM, when CBT is
enabled.



Explanation:

SAN was chosen as the transport because either the default transport
setting was used, or it was specified in the VMVSTORTRANSPORT option. In
order to use SAN as the transport mode, VMware Changed Block Tracking
(CBT) has to be disabled on the target VM.

System action:

Restore processing stops.

User response:

Disable VMware Changed Block Tracking (CBT) on the target VM, or set
VMVSTORTRANSPORT to something other than SAN, such as NBD. Then try the
restore operation again.

------------------------------------------------------------------------
ANS9419E

VM backup failed for virtual machine 'virtual machine name' because
VMware Changed Block Tracking(CBT) cannot be enabled or reset due to an
existing snapshot.



Explanation:

VMware does not allow changing state of Changed Block Tracking(CBT),
when a snapshot exists.

System action:

The backup stops.

User response:

Delete snapshot on the target vm to allow CBT to be enabled or reset or
set the VMNOCBTCONTINUE YES option then try the backup again. If you set
VMNOCBTCONTINUE YES, then used and unused blocks on each disk of the VM
are backed up.

------------------------------------------------------------------------
ANS9420W

VMware Changed Block Tracking(CBT) cannot be enabled or reset for
virtual machine 'virtual machine name' due to an existing snapshot. Full
VM backup continues, and includes both used and unused areas of the
disk.



Explanation:

VMware does not allow changing state of Changed Block Tracking(CBT),
when a snapshot exists. The backup continues, but instead of backing up
just the used blocks (in the full VM backup case), or just the changed
blocks (in the incremental VM backup case), the entire virtual machine
is backed up. This backup includes both the used and unused blocks of
the disk.

System action:

The backup continues.

User response:

Delete snapshot on the target vm to allow CBT to be enabled or reset.

------------------------------------------------------------------------
ANS9421E

VM backup failed for virtual machine 'virtual machine name' because one
of the disks has size that is not multiple of 1MB.



Explanation:

VMware does not support backup of disks with size that is not multiple
of 1MB. The backup fails.

System action:

The backup fails.

User response:

Increase the affected disk size to be a multiple of 1MB.

------------------------------------------------------------------------
ANS9422I

program-name: The rollback of filesystem file system started.



Explanation:

The local activation of the specified file system started successfully.

System action:

IBM Spectrum Protect on the local node will try to activate the file
system that is space managed on another node.

User response:

None.

------------------------------------------------------------------------
ANS9427E

The virtual machine 'virtual machine name' disk 'virtual machine disk
name' could not be opened because none of the allowed transports
('allowed transport modes') is available.



Explanation:

The disk can only be opened using one of the transport modes specified
in the VMVSTORTRANSPORT option. However, none of the specified transport
modes were available, so the disk cannot be opened.Since none of the
specified transport modes was available, the disk could not be opened.

System action:

The virtual machine is not backed up. Processing continues with the next
virtual machine.

User response:

Carry out one or more of the following actions and then try the backup
again.

*  Check the VMVSTORTRANSPORT option value and verify that the desired
   transport modes are available.

*  Add NBD or NBDSSL to the VMVSTORTRANSPORT option.

*  Check the "%TEMP%/VMWARE-%USER%" directory for leftover files from a
   previous backup. Leftover files can prevent the use of advanced
   transport modes. This directory can be safely deleted as long as no
   other VM operations are running.



------------------------------------------------------------------------
ANS9428E

program-name: The takeover of filesystem file system failed to start.



Explanation:

The local activation of the specified file system failed to start.
Please, note that only file systems which are space managed on another
node within the same cluster can be taken over. Additionally, the file
system must be mounted locally.

System action:

IBM Spectrum Protect will not take over the file system.

User response:

Make sure the file system is mounted locally and managed with the IBM
Spectrum Protect client for space management on another node within the
same cluster and retry the operation.

------------------------------------------------------------------------
ANS9431E

IBM Spectrum Protect application protection failed to thaw VSS writers
on virtual machine 'VM'. See the IBM Spectrum Protect error log for more
details.



Explanation:

IBM Spectrum Protect application protection encountered an error while
thawing VSS writers.

System action:

Processing stops

User response:

See the error log for more details. Verify that all VSS writers are not
reporitng errors by running command 'vssadmin list writers'. Restart the
virtual machine and try the operation again. If the retry fails, see the
error log for details about the errors.

------------------------------------------------------------------------
ANS9432W

IBM Spectrum Protect application protection failed to truncate
application logs on virtual machine 'VM'.



Explanation:

IBM Spectrum Protect application protection encountered an error while
completing VSS backup operation. The applications were successfully
quiesced, but their logs were not truncated.

System action:

Application logs are not truncated.

User response:

See the error log for more details. Verify that all VSS writers are not
reporting errors by running command 'vssadmin list writers'. Restart the
virtual machine and try the operation again. If the retry fails, see the
error log for details about the errors. On the guest VM, verify that a
mounted volume is not online. Use the Recovery Agent to dismount and
remove any existing mount directories. Then, try the backup operation
again.

------------------------------------------------------------------------
ANS9433E

program-name: dm_send_msg failed with errno Errno.



Explanation:

Unable to execute DMApi call.

System action:

Aborting operation.

User response:

Check consistency of the GPFS daemon.

------------------------------------------------------------------------
ANS9443E

program-name: The operation cannot be executed in a deactivated failover
environment.



Explanation:

The operation relies on an active failover environment.

System action:

Aborting operation.

User response:

Run dsmmigfs enableFailover on the local node and repeat the operation.

------------------------------------------------------------------------
ANS9447E

The virtual machine 'virtual machine name' disk could not be opened
because none of the allowed transports is available.



Explanation:

The disk can only be opened using one of the transport modes specified
in the VMVSTORTRANSPORT option. However, none of the specified
transports modes was available, so the disk cannot be opened.

System action:

The virtual machine is not backed up. Processing continues with the next
virtual machine.

User response:

Carry out one or more of the following actions and then try the backup
again.

*  Check the console output and error logs for information about which
   transport modes are allowed.

*  Check the VMVSTORTRANSPORT option value and verify that the desired
   transport modes are available.

*  Add NBD or NBDSSL to the VMVSTORTRANSPORT option.

*  Check the "%TEMP%/VMWARE-%USER%" directory for leftover files from a
   previous backup. Leftover files can prevent the use of advanced
   transport modes. This directory can be safely deleted as long as no
   other VM operations are running.



------------------------------------------------------------------------
ANS9450W

program-name: No eligible filesystem for takeover.



Explanation:

None of the locally mounted GPFS filesystems matches with the remotely
managed filesystems of the failure node.

System action:

Aborting takeover operation.

User response:

Check that the filesystems of the remote failure node get managed
elsewhere within the node set.

------------------------------------------------------------------------
ANS9451E

program-name: GPFS or the SP switch is down locally. Aborting takeover
activities ...



Explanation:

IBM Spectrum Protect GPFS is not functional locally.

System action:

Aborting takeover operation.

User response:

Check switch and VSD status. The local system must be unfenced.

------------------------------------------------------------------------
ANS9452E

program-name: The DMApi is not functional locally. Aborting takeover
activities ...



Explanation:

The operation stopped because the DMApi interface is not accessible.

System action:

Aborting takeover operation.

User response:

Check GPFS status.

------------------------------------------------------------------------
ANS9453E

program-name: Could not determine the GPFS storage pool id for file
'file-path'. Reason: reason



Explanation:

The processed file does not exist or is located on a file system without
storage pool support.

System action:

The requested operation stops.

User response:

Please check the input parameters and if DMAPI is enabled on the file
system.

------------------------------------------------------------------------
ANS9457E

program-name: Could not determine the storage pools of file system
'file-system'. Reason: reason



Explanation:

The specified file system is not a GPFS file system or has an old GPFS
version.

System action:

The requested operation stops.

User response:

Please update to a supported version of GPFS.

------------------------------------------------------------------------
ANS9459E

Using the specified MAXCANDIDATES parameter would produce an
out-of-space condition in the parent filesystem of
/etc/adsm/SpaceMan/candidatesPool. Based on the current free space
situation the maximum value for the MAXCANDIDATES parameter is value.



Explanation:

The automigration candidate pools for the selected filesystem require
MAXCANDIDATES per 10 KB plus a safety buffer of 5 MB of memory under
/etc/adsm/SpaceMan/candidatesPool , which exceeds the available space.

System action:

IBM Spectrum Protect Abort operation.

User response:

Increase the filesystem size or choose a smaller value for the
MAXCANDIDATES parameter. You may also create a dedicated filesystem with
sufficient space for the migration pools under
/etc/adsm/SpaceMan/candidatesPool. Kill the dsmscout processes after
performing this option.

------------------------------------------------------------------------
ANS9462E

Failover functionality is not supported with this HSM release.



Explanation:

The IBM Spectrum Protect user ran dsmmigfs with the failover flag on an
unsupported platform.

System action:

IBM Spectrum Protect ends the operation.

User response:

None.

------------------------------------------------------------------------
ANS9469E

Warning! Unable to write a complete migration candidate list due to low
space in the parent filesystem of name.



Explanation:

IBM Spectrum Protect Low space in filesystem which stores the migration
candidates files.

System action:

IBM Spectrum Protect The executable writes a partial migration
candidates list.

User response:

Increase the filesystem size or create a dedicated filesystem with
sufficient size under the given path.

------------------------------------------------------------------------
ANS9474E

program-name: Lost my session with errno: errno . Trying to recover.



Explanation:

The DMAPI session is not valid.

System action:

Trying to recover session.

User response:

Check the failure node. You might have to recover the local GPFS daemon.

------------------------------------------------------------------------
ANS9475W

IBM Spectrum Protect application protection failed to cleanup after a
VSS backup on virtual machine VM.



Explanation:

IBM Spectrum Protect application protection encountered an error while
cleaning up after a VSS backup operation.

System action:

None

User response:

See the error log for more details. Restart the virtual machine and try
the operation again. If the problem persists, contact IBM technical
support for further assistance.

------------------------------------------------------------------------
ANS9476I

program-name: Recovered my DM session sid.



Explanation:

DMAPI session is recovered.

System action:

This message is for informational purposes only.

User response:

No action is required.

------------------------------------------------------------------------
ANS9480E

program-name: The rollback of filesystem file system failed to start.



Explanation:

The local activation of the specified file system failed to start.
Please, note that a rollback can only be performed after the space
management of the file system was moved from the local node to another
node during failover. Additionally, the file system must be mounted
locally.

System action:

IBM Spectrum Protect will not roll back the file system.

User response:

Make sure the file system is mounted locally and managed with the IBM
Spectrum Protect client for space management on another node within the
same cluster and retry the operation.

------------------------------------------------------------------------
ANS9487W

program-name: cannot query the right on session session for file handle
= filehandle token = token. Reason : error



Explanation:

The Space Management cannot query the right on a file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9488E

IBM Spectrum Protect uses the Java Runtime Environment (JRE), but either
the JRE could not be found in the 'jrePath' directory, or the JRE
version could not be determined. Possible reasons are that there is a
problem with the product installation, or the TEMP or TMP environment
variables are set to a directory that is inaccessible by the user.



Explanation:

JRE was not found in the IBM Spectrum Protect installation directory.

System action:

Processing stops

User response:

Re-install the product or install a required version of JRE and try
again. If JRE is already installed on your machine, then make sure the
PATH environment variable contains path to javaw.exe. In addition to
that, verify that the TEMP and TMP environment variables each point to
an existing directory, and that the user has sufficient permissions to
access the directory.

------------------------------------------------------------------------
ANS9489E

Java Runtime Environment (JRE) was not found.



Explanation:

JRE was not found.

System action:

Processing stops

User response:

If you have already installed JRE, verify that the \"java\" executable
can be reached via an appropriate PATH environment variable setting.
Otherwise, install the required JRE version. For more details on the
hardware and software requirements, see the following technote:
http://www-01.ibm.com/support/docview.wss?uid=swg21505139 For more
details on how to configure the data mover nodes in a vSphere
environment, see "Advanced configuration tasks" appendix of the IBM
Spectrum Protect for Virtual Environments "Data Protection for VMware
Installation Guide".

------------------------------------------------------------------------
ANS9490E

Cannot find httpagent.jar in the IBM Spectrum Protect client
installation directory.



Explanation:

The required file was not found.

System action:

Processing stops

User response:

Re-install the product or install a required version of JRE and try
again.

------------------------------------------------------------------------
ANS9491E

The password credentials for virtual machine 'guest VM name' could not
be found. Use dsmc SET PASSWORD -type=VMGUEST 'VM guest name' 'userid'
'password' to save encrypted password.



Explanation:

The required password was not found.

System action:

Processing stops

User response:

Use dsmc SET PASSWORD -type=VMGUEST 'VM guest name' 'userid' 'password'
to save encrypted password. And then retry the 'backup vm' operation.

------------------------------------------------------------------------
ANS9492E

Destination size is not equal to source



Explanation:

The space allocation for the selected destination is not the same as the
source.

System action:

The restore operation is not performed.

User response:

Choose a different destination which is equal in size to the source.

------------------------------------------------------------------------
ANS9493E

The credentials found for virtual machine 'guest VM name' are incorrect.
Verify the credentials and use dsmc SET PASSWORD -type=VMGUEST 'VM guest
name' 'userid' 'password' to update the username and password.



Explanation:

The supplied credentials are incorrect. Failed to authenticate to guest
VM using these credentials.

System action:

Processing stops

User response:

Use dsmc SET PASSWORD -type=VMGUEST 'VM guest name' 'userid' 'password'
to update the username and password. And then retry the 'backup vm'
operation.

------------------------------------------------------------------------
ANS9494E

Command 'command' completed with RC=return code on virtual machine
'guest VM name'.



Explanation:

A remote command either timed out or failed.

System action:

Processing stops

User response:

Increase the value of VMTIMEOUT option and try the operation again.

------------------------------------------------------------------------
ANS9495E

Failed to login to virtual machine 'guest VM name' because the VMware
Tools are not running in the guest machine. Verify that the VMware tools
are running and that no other program has access or is making any
changes to this VM.



Explanation:

Failed to login to virtual machine because the VMware Tools are not
running in the guest machine.

System action:

Processing stops

User response:

Make sure that the VMware tools are running and that no other program
has access or is making changes to this VM. And then retry the 'backup
vm' operation.

------------------------------------------------------------------------
ANS9496E

Unable to lock virtual machine VM for application protection.



Explanation:

The virtual machine is being backed up by another process. Only one
process is allowed to use IBM Spectrum Protect application protection
during a backup of a virtual machine at a time.

System action:

Processing stops

User response:

There is already another virtual machine backup in process via another
datamover. Please wait for the other virtual machine backup to complete
and re-try the operation. Or there was a crash or CTRL+C during the
previous virutal machine backup. Please wait 10 minutes and re-try the
operation.

------------------------------------------------------------------------
ANS9497W

Virtual machine 'VM' resides on an ESX Server or vCenter that is not
supported by IBM Spectrum Protect application protection. IBM Spectrum
Protect application protection will not be used.



Explanation:

Refer to the product documentation for the list of supported ESX and
vCenter versions.

System action:

IBM Spectrum Protect will use the VMware Tools to provide application
consistency.

User response:

Exclude the virtual machine from application protection by removing the
INCLUDE.VMTSMVSS option for this virtual machine.

------------------------------------------------------------------------
ANS9498W

A valid IBM Spectrum Protect for Virtual Environments license file
(license-file) cannot be located. IBM Spectrum Protect application
protection will not be used.



Explanation:

The license file was not found, or cannot be opened because of
permissions, or the file is corrupted.

System action:

IBM Spectrum Protect will use the VMware Tools to provide application
consistency.

User response:

Check permissions on file. See if the license file is in the correct
place.

------------------------------------------------------------------------
ANS9499W

VMware tools on virtual machine 'VM' need to be updated. IBM Spectrum
Protect application protection will still be used.



Explanation:

IBM Spectrum Protect application protection requires that VMware Tools
are up to date.

System action:

IBM Spectrum Protect will use the VMware Tools to provide application
consistency.

User response:

Update VMware Tools on the virtual machine

------------------------------------------------------------------------
ANS9500W

program-name: cannot disposition the mount event. Reason: error



Explanation:

The system wide mount event could not be dispositioned. Mount events
will not be received by this daemon.

System action:

Processing continues.

User response:

Try to resolve the problem and restart the recall daemon. If the problem
cannot be resolved immediately, kill and restart the recall daemon after
an Space Management supported file system has been added using dsmmigfs
or after a file system has been mounted using the mount command.

------------------------------------------------------------------------
ANS9501W

program-name: cannot set event disposition on session session for file
system mountdir token = token. Reason : error



Explanation:

Events could not be dispositioned on the file system. No events will be
received for this filesystem. HSM is not enabled for this file system.

System action:

Processing continues.

User response:

The file system must be one of the supported native file systems in
order for the Space Management to support it. Verify that the mount
options the file system are correct. Correct the problem and remount the
file system.

------------------------------------------------------------------------
ANS9502W

program-name: cannot remove event disposition on session session for
file system mountdir token = token. Reason : error



Explanation:

Event dispositions could not be removed from the file system.

System action:

Processing continues.

User response:

Verify that the file system is mounted and that dmapi is enabled on that
file system. If the problem persists, unmount and remount the file
system, then try the operation again. If the problem still persists,
reboot the system.

------------------------------------------------------------------------
ANS9503I

program-name: events have been set and dispositioned on session session
for file system filesystem-name



Explanation:

Setting events and dispositioning these on a DM session enables the file
system for Space Management support.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9504W

program-name: The file system filesystem-name is not mounted or is
mounted with wrong options.



Explanation:

Either the file system is not mounted or it has been mounted with
incorrect options.

System action:

IBM Spectrum Protect continues.

User response:

Mount the file system or remount it with corrected mount options.

------------------------------------------------------------------------
ANS9505E

program-name: cannot initialize the DMAPI interface. Reason: error



Explanation:

IBM Spectrum Protect client failed to perform implementation-defined
initialization of the DMAPI interface.

System action:

The dm_init_service() function failed.

User response:

If you are running IBM Spectrum Protect as a non-root user and you have
IBM Spectrum Protect Space Management client installed, make sure that
the dsmrootd daemon is up and running, then retry the operation. If you
don't have the Space Management client installed, retry the operation
under the root user authority.

------------------------------------------------------------------------
ANS9506E

program-name: The provided filespace argument 'argument' has an invalid
format.



Explanation:

Occurs if you are on a GPFS file system and the file system parameter
was not in the correct format.

System action:

The requested operation stops.

User response:

See the dsmautomig documentation for the correct syntax.

------------------------------------------------------------------------
ANS9507E

program-name: cannot request the right on session session for file
handle filehandle token = token. Reason : error



Explanation:

Space Management cannot request the required right on a file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9508W

program-name: cannot release the right on session session for file
handle = filehandle token = token. Reason : error



Explanation:

Space Management cannot release the right on a file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9509W

program-name: received an unexpected event of type event-type on session
session.



Explanation:

The Space Management daemon received an unexpected event. This event has
not been dispositioned.

System action:

IBM Spectrum Protect ignores event and continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9510E

program-name: cannot get event messages from session session, expected
max message-length = msglen, returned message-length = return-length.
Reason : error



Explanation:

Space Management encountered an error while trying to receive a message
on a DM session.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9511E

program-name: cannot read DM attributes on session session for file:
name = name handle = handle token = token. Reason : error



Explanation:

Space Management cannot read the DM attributes of a DM object, usually a
file. If the file name is not available, it will be displayed as an
empty string or as <NA>.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9512E

program-name: cannot set DM attributes on session session for file
handle = filehandle token = token. Reason : error



Explanation:

Space Management cannot set DM attributes for a DM object, usually a
file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9513E

program-name: cannot remove DM attributes on session session for file
handle = filehandle token = token. Reason : error



Explanation:

Space Management cannot remove DM attributes for a DM object, usually a
file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9514E

program-name: cannot create a file handle from path. Reason: error



Explanation:

Space Management cannot create a file handle from the given file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9515E

program-name: cannot set the migration information. Reason: error



Explanation:

Space Management cannot set the migration information of a file, because
Space Management cannot create a file handle from the file or from the
file system.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9516E

program-name: cannot create an user event message on session session.
Reason: error



Explanation:

Space Management cannot create an user event message, needed to
reference rights on a file to be processed.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9518E

program-name: cannot respond to an event message on session session
using token token Reason : error



Explanation:

An event message could not be responded to (returned to the system).

System action:

Space Management continues.

User response:

If a user process is unexpectedly blocked and cannot be killed, see your
system administrator.

------------------------------------------------------------------------
ANS9519W

program-name: cannot set eventlist for a file system on session session
token = token fs-handle = fs-handle. Reason : error



Explanation:

An eventlist could not be set on a file system. None of the events will
be generated by the system on this file system.

System action:

Space Management continues.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
reboot the system.

------------------------------------------------------------------------
ANS9520E

program-name: cannot set a managed region on session session for file
handle = filehandle token = token. Reason : error



Explanation:

A managed region could not be set on a file. No events will be generated
for this file.

System action:

Processing of the file is interrupted.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
reboot the system.

------------------------------------------------------------------------
ANS9521E

program-name: cannot get the file attributes on session session for file
handle = handle token = token. Reason : error



Explanation:

Space Management cannot read the attributes of a file.

System action:

Processing of the file is interrupted.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
reboot the system.

------------------------------------------------------------------------
ANS9522E

program-name: can not create a file system handle from path. Reason:
error



Explanation:

The program can not create a file system handle from the file system
name. If Reason is Operation not permitted, the dmapi functionality may
be disabled for the file system.

System action:

Processing of the file system is interrupted.

User response:

If Reason is Operation not permitted, enable dmapi functionality for the
file system and retry.

------------------------------------------------------------------------
ANS9523E

program-name: is unable to verify the stub size for the file on session
session file handle = filehandle token = token. Reason : error



Explanation:

A correct stub size could not be determined by the system.

System action:

The system stops migration of the file.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9524W

program-name: adjusted stubsize to an allowed value on session session
file handle = filehandle token = token old stubsize = old-size new
stubsize = new-size



Explanation:

The predefined stubsize for the file should be corrected to accommodate
to the boundary and rounding constraints imposed by the DMAPI
implementation. Space Management can also change the stubsize during
migration if the predefined stubsize value is larger than the logical
file size.

System action:

Space Management continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9525E

program-name: is unable to create a stub file on session session for
file handle = handle token = token. Reason : error



Explanation:

An error occurred while creating a stub file.

System action:

Processing of the file is interrupted.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9526E

program-name: cannot open the state file filename for writing. Reason:
error



Explanation:

The global or file system state file could not be opened.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9527E

program-name: cannot write to the state file filename. Reason: error



Explanation:

Space Management could not write to the state file.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9528W

program-name: cannot read from the state file filename. . The file is
corrupted and will be recreated.



Explanation:

Space Management could not read from the state file.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9529W

program-name: cannot obtain the handle of a file system state file



Explanation:

IBM Spectrum Protect space management could not find the handle of a
file system state file that is stored in the global state file. This can
occur if either space management is querying a file system that has no
HSM support added, or the file system state file is corrupted, or the
global state file is corrupted.

System action:

IBM Spectrum Protect continues or stops processing, depending on the
situation.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9530W

program-name: cannot remove an entry for file-system from the global
state file.



Explanation:

The entry for the file system in the dmiFSGlobalState file cannot be
removed. Possible reasons:

*  There is not enough memory to create temporary file name for
   temporary file system table.

*  There is not enough free space or inodes to create temporary file
   system table

*  The real or temporary file system table files cannot be opened.

System action:

IBM Spectrum Protect does not remove the entry from the global state
file.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9531E

program-name: cannot create a DM session: old session = oldsession
session info = session-info. Reason : error



Explanation:

Space Management could not create a DM session.

System action:

Processing stops.

User response:

Try the operation again. If the problem persists restart the system.

------------------------------------------------------------------------
ANS9532W

program-name: cannot destroy the session session. Reason: error



Explanation:

Space Management could not destroy a DM session.

System action:

Processing continues.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9533W

program-name: failed getting all sessions. Reason: error



Explanation:

Space management could not get all DM sessions on the system.

System action:

Processing stopped.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9534W

program-name: cannot find existing DMAPI session for the program.
Reason: error



Explanation:

The Space Management program cannot find a previously used DMAPI session
on the system

System action:

The Space Management program will open a new DMAPI session

User response:

Continue with normal operation if a new DMAPI session can be created.
Issue error if a new DMAPI session cannot be created.

------------------------------------------------------------------------
ANS9535E

program-name: a file handle could not be created from the file
descriptor file-descriptor. Reason: error



Explanation:

Space management could not create a file handle.

System action:

Processing of the file is interrupted.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9536E

program-name: cannot query an event message on session session. Reason:
error



Explanation:

The space management recall service was not able to identify whether a
recall request was initiated from the NFS daemon.

System action:

Processing of the file is interrupted.

User response:

Verify the NFS daemon is properly running and retry the recall
operation.

------------------------------------------------------------------------
ANS9537E

program-name: Invalid storage pool 'storagepool' for file system
'filesystem'.



Explanation:

No storage pool with that name exists on the specified file system.

System action:

The requested operation stops.

User response:

Please make sure the storage pool exists on the specified file system.

------------------------------------------------------------------------
ANS9538W

program-name: request request for DM file attributes not recognized



Explanation:

An unknown request type has been encountered that cannot be handled.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9539E

program-name: cannot create a file system handle from the file handle =
filehandle. Reason : error



Explanation:

A file system handle could not be created from a file handle.

System action:

Processing continues.

User response:

Continue with normal operation.

------------------------------------------------------------------------
ANS9542E

program-name: the file attributes could not be set on session session
for file handle = filehandle token = token flag = flag Reason : error



Explanation:

Space management could not update file attributes.

System action:

Processing of the file is interrupted.

User response:

Try the operation again. If the problem persists, verify that the file
system is mounted with dmapi enabled. If the problem still persists,
restart the system.

------------------------------------------------------------------------
ANS9543W

program-name: The IBM Spectrum Protect client needs blocks-num1 free
file system blocks to be able to handle the nospace condition on file
system filesystem-name, errno: error-num, reason: error-str. Currently
blocks-num2 blocks with a block size of block-size bytes are available.



Explanation:

Either the client is not able to get status information for the file
system or there is insufficient space in the file system. The message
reports zero blocks if the file system status information is not
available.

System action:

Processing continues.

User response:

If there is insufficient space in the file system, free the required
space or increase the file system capacity. If this is due to an input
output error, perform an appropriate file system check (e.g. fsck). Then
try the operation again.

------------------------------------------------------------------------
ANS9545E

program-name: cannot get a lock for lockdirlockfile to continue
processing.



Explanation:

Space management could not obtain a lock for a file.

System action:

processing stops.

User response:

Try the operation again. If problem persists, restart HSM. If problem
still persists, restart the system.

------------------------------------------------------------------------
ANS9546E

IBM Spectrum Protect cannot perform instant restore because Microsoft
Active Directory Domain Controller was detected on virtual machine.



Explanation:

The virtual machine contains Microsoft Active Directory Domain
Controller. It cannot be recovered using instant restore.

System action:

Processing stops.

User response:

Use a regular restore to recover the virtaul machine.

------------------------------------------------------------------------
ANS9548W

Cannot complete remote file access for inode:'inode number', alias:'file
name'.



Explanation:

Space management cannot complete the remote file access. The file may be
migrated to an IBM Spectrum Protect migration server that could be
temporarily unavailable. The file may be an orphan stub.

System action:

Process terminates the current operation.

User response:

Check to see whether the server has been disabled by the system
administrator, then retry the operation. To check whether the file is an
orphan stub or not, run dsmreconcile for the affected file system. Note:
the file alias may be displayed as 'unavailable' if the connection to
server is unavailable or 'orphan' if the appropriate file copy cannot be
located on a particular migration server.

------------------------------------------------------------------------
ANS9550W

File recall has been discontinued.



Explanation:

Recall stops because the file being recalled would cause the file system
to run out of space.

System action:

Process terminates the current operation.

User response:

Increase the file system space, or remove unneeded files, or wait until
space management has migrated files off the file system by demand or
threshold migration, or manually migrate files. Then retry the
operation.

------------------------------------------------------------------------
ANS9551E

Incorrect use of the dsmmigrate command with the recover parameter. The
filelist is not set.



Explanation:

The filelist is not specified.

System action:

Processing stopped.

User response:

Ensure that you specified the filelist.

------------------------------------------------------------------------
ANS9552E

program-name: cannot add space management to file-system; path includes
non-local file system.



Explanation:

An attempt was made to add space management to a file system whose path
contains non-local elements.

System action:

Processing stopped.

User response:

File system must be entirely local.

------------------------------------------------------------------------
ANS9554E

program-name: command for file system mountdir Reason : error



Explanation:

An attempt to enable or disable xdsm api functionality on the file
system failed. If the attempt was to enable HSM, then HSM is not enabled
for this file system.

System action:

Processing continues.

User response:

The file system must be of type JFS2 in order for the Space Management
to successfully set the managed attribute. Verify that the file system
is of the correct type.

------------------------------------------------------------------------
ANS9556E

Number of CTL files on disk (number of CTLs on disk) do not match the
expected value (number of CTLs in cache).



Explanation:

The number of CTLs files counted in VCM lib cache should be equal to
that in the local disks.

System action:

Processing is aborted.

User response:

None.

------------------------------------------------------------------------
ANS9576E

Not enough space in filesystem to create meta data file!At least space
space required!



Explanation:

A disk full error occurred attempting to create the metadata file.
Please migrate some files in filesystem to free at least space kb.

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS9577E

An exception "msg"!Unable to use meta file!



Explanation:

An internal error occurred. The dsmscout is unable to use the meta data
file!

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS9578E

An unknown error occurred!



Explanation:

An internal error has occurred. The dsmscout is unable to use the meta
data file! The file has been deleted. A new meta data file will be
created.

System action:

Processing stops.

User response:

None.

------------------------------------------------------------------------
ANS9590E

The SOAP error information: message failed, reason: message



Explanation:

The detailed SOAP error message is created from gSOAP communication
module and does not exist in the chosen language!

System action:

Processing continues.

User response:

Verify your system and retry the operation.

------------------------------------------------------------------------
ANS9591E

A SOAP UDP connection error has happened!



Explanation:

The SOAP communication system had an UDP error. Please see errorlog file
for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9592E

A SOAP TCP connection error has happened!



Explanation:

The SOAP communication system had an TCP error. Please see errorlog file
for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9593E

A SOAP HTTP communication error has happened!



Explanation:

The SOAP communication system had an HTTP error. Please see errorlog
file for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9594E

An internal SOAP error has happend!



Explanation:

The SOAP communication system had an internal error. Please see errorlog
file for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9595E

The SOAP communication system is out of memory!



Explanation:

The SOAP communication system had an memory error. Please see errorlog
file for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9596E

The SOAP communication ended unexpected!



Explanation:

The SOAP communication system had an EOF error. Please see errorlog file
for more detailed information!

System action:

Processing ends.

User response:

None.

------------------------------------------------------------------------
ANS9613E

program-name: Stub size of stubsize bytes is not supported on
filesystem.



Explanation:

The given stub size value not a multiple of the file system block size
and cannot be supported.

System action:

The program aborts the operation.

User response:

Use a correct stub size.

------------------------------------------------------------------------
ANS9616E

program-name: cannot get migration information for migrated-file-alias
on file-system-name



Explanation:

Space management cannot access the specified file system object using
the system DMAPI functions. This condition might occur if DMAPI support
is not enabled for the file system, or if there is an inconsistency in
the file system. This message is typically preceded by other messages
that have more specific information about the error.

System action:

Processing of the file is interrupted. Processing continues with the
next file.

User response:

Review dsmerror.log for preceding messages that might have more specific
information about the error. Verify that the file system is consistent
and mounted with DMAPI support enabled. Then retry the operation. If the
problem persists, contact IBM technical support for further assistance.

------------------------------------------------------------------------
ANS9618W

The mount point of HSM managed file system has been changed from 'old
mount point' to 'new mount point'.



Explanation:

The mount event of HSM managed file system on a different mount point
has been received.

System action:

The dsmrecalld master process is going to proceed with mounting of the
HSM managed file system.

User response:

Ensure that the HSM file space is renamed on the IBM Spectrum Protect
server in accordance with the new HSM managed file system mount point.
Otherwise, a subsequent reconciliation job will report all previously
migrated files (if any) as orphans.

------------------------------------------------------------------------
ANS9645W

The vApps backup operation completed. However, one or more vApp backups
failed.



Explanation:

There were successfull vApp backups but there were backup failures as
well. The operation is considered successfull.

System action:

The backup operation completed successfully.

User response:

Check the console output and error logs for information about why the
backups failed. Correct any issues and try backing up the failed vApps
again.

------------------------------------------------------------------------
ANS9669W

program-name: file-system CFI is out of range.



Explanation:

IBM Spectrum Protect CFI is out of range on the specified file system.
The scout daemon could not insert a new file entry into the CFI during
the file system scan. As a result, it may not provide enough candidates
for the next automigration.

System action:

Processing continues.

User response:

Please, reconsider the MAXFILES option setting for the file system. The
CFI size should likely be increased via 'dsmmigfs update /fs
-MAXFiles=n' command.

------------------------------------------------------------------------
ANS9674W

One or more of the required vApps could not be retreived.



Explanation:

Not all of the vApps that were required by the given specification could
be retreived. This can be caused by a change in the vCD vApps definition
or a user mistake in the provided vApp spec.

System action:

The operation will proceed, as there are still existing items to operate
on.

User response:

Check the provided vApps specification to make sure the specification
matches the existing configuration. Correct any issues and try the
operation again.

------------------------------------------------------------------------
ANS9733E

File: File-name excluded by the Include/Exclude list



Explanation:

You tried to back up the named file-name that was specified to be
excluded from backup.

System action:

IBM Spectrum Protect did not back up the file.

User response:

Specify the file using the Include option and retry the operation.

------------------------------------------------------------------------
ANS9778E

Error(s) were detected in options file: '' Do you want IBM Spectrum
Protect to comment out the line with errors and continue?



Explanation:

Invalid options or option values were encountered while reading the
options file.

System action:

This message is displayed. Further action depends on your response.

User response:

Click "Yes" to allow the process to turn the invalid line into comments.
If you click "No", you will exit immediately.

------------------------------------------------------------------------
ANS9779E

Unable to open options file '' for writing.



Explanation:

An error occurred while tried to open options file for writing to update
it.

System action:

Program exits.

User response:

Check file and directory access permissions or correct invalid entries
in your options file manually.

------------------------------------------------------------------------
ANS9780I

The vCenter does not have NSX-T setup, the virtual machine NIC cannot be
restored. Use the VMDEFAULTNETWORK option to define the network to
create the NIC in.



Explanation:

The virtual machine NIC was defined as an opaque NSX-T device and NSX-T
can not be found in the location the virtual machine is being restored
to.

System action:

The virtual machine can be restored but the NIC cannot be restored.

User response:

After the virtual machine has been restored a new NIC card can be added.

------------------------------------------------------------------------
ANS9782S

The selected backupset was generated by a newer version of the backup
server, and the new backupset version is not supported by this client;
The backupset data cannot be restored by this version of the client.



Explanation:

The backupset you are attempting to restore was generated by a newer
server that has a different level of functionality. The client you are
using does not recognize this newer format so it cannot restore the data
from the backupset.

System action:

Processing stopped.

User response:

Restore the backupset with a client that is at the same or higher level
as the server that was used to generate the backupset.

------------------------------------------------------------------------
ANS9806W

The file system type is not supported.



Explanation:

The file system is not a type supported by space management.

System action:

Unable to add space management to the file system.

User response:

There is a mismatch between the HSM client and the file system type
specified. If the file system type is consistent with the intent,
install an HSM client that supports it, then try the operation again.
Only one HSM client can be installed at a time.

------------------------------------------------------------------------
ANS9807W

The specified backupset file does not contain a backupset of type "file"
for the specified nodename.



Explanation:

Local backupset support is limited to backupsets that contain file data;
Image backupsets are not supported locally. The specified backupset does
not contain a backupset with file data for the node name specified.

System action:

Processing stopped.

User response:

Specify a different backupset file to restore file data from a
backupset. To restore an image from a backupset, access the backupset
from a IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS9827W

Error accessing the Recall daemon lock file: file name.



Explanation:

There is a problem accessing the recall daemon lock file.

System action:

Unable to determine if the recall daemon is running. Because the recall
daemon is needed to perform file recalls, the recall fails.

User response:

Check with the system administrator. The recall process needs read
access to the /etc/adsm/SpaceMan/dsmrecalld.pid file.

------------------------------------------------------------------------
ANS9828W

File: file-name is skipped for migration: The file is either AFM
uncached or dirty.



Explanation:

If using GPFS Active file management, the file could either be uncached
or dirty. Uncached (no file data available in cache. Access would cause
replication from home) Dirty (changed file data in cache. No valid
replication in home)

System action:

The file is skipped from processing.

User response:

Uncached (fetch the file from home to cache and rerun the processing)
Dirty (replicate the file from cache to home and rerun the processing)

------------------------------------------------------------------------
ANS9829W

Recall daemon is not running.



Explanation:

The recall daemon is not running.

System action:

IBM Spectrum Protect recall fails.

User response:

Ask the system administrator to start a recall daemon by issuing the
dsmrecalld command.

------------------------------------------------------------------------
ANS9842E

The watch daemon is not running properly.



Explanation:

The watch daemon is either not running, has no dmapi session, or is not
connected to group services.

System action:

The IBM Spectrum Protect action fails.

User response:

Ask the system administrator to check GPFS, the group services, and to
restart a watch daemon by issuing the dsmwatchd command.

------------------------------------------------------------------------
ANS9845E

Space management action ends.



Explanation:

The requested space management operation is ended because the watch
daemon is not working properly.

System action:

Processing Ends.

User response:

Look for previous messages.

------------------------------------------------------------------------
ANS9849W

Local backupset cannot be expanded; Only full backupset restore is
supported locally.



Explanation:

Local backupsets cannot be expanded to show volumes, directories, and
files. Only full backupset restore is supported from local backupsets.

System action:

Processing stopped.

User response:

To restore specific volumes, directories, and files from a backupset,
restore the backupset from the IBM Spectrum Protect server.

------------------------------------------------------------------------
ANS9850E

Tape read error; Max Blocksize is blocksize. Attempted to read blocksize
blocksize. Run dsmmaxsg to update scsi driver max blocksize allowed and
retry operation.



Explanation:

An attempt to read from tape at the specified blocksize failed; Tha
maximum blocksize allowed for the scsi driver is shown.

System action:

Processing stopped.

User response:

If the maximum blocksize is less than the blocksize used by the
operation, run the dsmmaxsg utility to update the maximum blocksize
allowed for the scsi driver, and then retry the operation. If the
maximum blocksize is greater than or equal to the blocksize used, then
verify that the tape installed and operating correctly and retry the
operation.

------------------------------------------------------------------------
ANS9857W

The restored HSM for Windows stub file may be an orphan: stub file name



Explanation:

The restored stub file may not be accessible in the HSM client archive
and thus it possibly cannot be recalled.

System action:

Stub file is restored.

User response:

Check if the stub file can be accessed.

------------------------------------------------------------------------
ANS9858E

The backup-archive operation did not run. The backup-archive operation
involves stub files that were migrated with the HSM for Windows client.
The installed HSM for Windows client version version. release. level is
incompatible with installed backup-archive client version version.
release. level.



Explanation:

The backup-archive client uses the HSM for Windows client for
backup-archive operations that involve migrated files. The HSM for
Windows client and the backup-archive client must be at the same PTF
level.

System action:

The backup-archive operation does not run for any files. Migrated files
and resident files are not processed.

User response:

Uninstall the current HSM for Windows client and install an HSM for
Windows client at the same PTF level as the backup-archive client.

------------------------------------------------------------------------
ANS9890W

program-name: The file system filesystem is already owned by that node.



Explanation:

The file system is already owned by that node..

System action:

None.

User response:

None.

------------------------------------------------------------------------
ANS9891E

The release file for the Linux mount proxy node cannot be validated. A
common reason is that the Linux distribution is not supported.



Explanation:

IBM Spectrum Protect examines the Linux release file on the mount proxy
node to determine if the mount proxy node is running on a supported
Linux distribution. Either the release file for a supported Linux
distribution could not be found, or the release file content could not
be validated.

System action:

The operation stops.

User response:

Check the product requirements for the installed version of IBM Spectrum
Protect to ensure that the Linux distribution is supported for use as a
mount proxy node.

------------------------------------------------------------------------
ANS9892E

Unable to find snapshot(s) in the local repository.



Explanation:

The requested volume snapshot(s) were not found in the local repository.

System action:

Processing stops.

User response:

Ensure the operation is issued with the proper nodename and/or server
address. In a non-cluster environment perform the operation from a
different host with the expected hostname. Retry the operation.

------------------------------------------------------------------------
ANS9895W

Space management in file system file system is not active.



Explanation:

You tried to select a file in a file system for which space management
is inactive.

System action:

The process continues with normal operation.

User response:

Reactivate space management for the file system, and then proceed with
selecting files.

------------------------------------------------------------------------
ANS9910E

The stream of data to backup guest vm name was sent in the wrong order.
The backup cannot continue.



Explanation:

The backup verification system detected the stream of data of the
virtual machine was being sent to the server in the wrong order. The
backup has ended to prevent data loss.

System action:

The backup operation for this VM ends.

User response:

Try the backup again. If the error persists, contact IBM Software
Support.

------------------------------------------------------------------------
ANS9911E

The backup verification system detected that some data was not sent
during the backup of virtual machine vm_name. The backup has been
halted.



Explanation:

The backup verification system detected that some data on one of the
objects sent to the server is missing. The backup has been halted to
prevent data loss.

System action:

The backup operation for this virtual machine ends.

User response:

Try the backup again. If the error persists, contact IBM Software
Support.

------------------------------------------------------------------------
ANS9912E

An error occurred when attempting to create a VMware vSphere Virtual
Volume (VVol) object. This could be the result of an incompatibility
between the virtual machine and the datastore or insufficient available
storage space.



Explanation:

An error occurred when attempting to create an object in a VVol
datastore.

System action:

The operation fails.

User response:

Specify a different destination datastore and retry the operation.

------------------------------------------------------------------------
ANS9913W

The VM backup operation that uses SAN transport mode failed.



Explanation:

This issue typically occurs when the data mover that specifies the SAN
transport mode does not have SAN access to the VMware datastore.

System action:

The operation fails.

User response:

Specify a different transport mode and retry the operation.

------------------------------------------------------------------------
ANS9914W

The VM backup operation may fail because SAN transport mode is not
supported for vVol datastores.



Explanation:

The data mover specifies the SAN transport mode. This transport mode is
not supported in an environment that contains VMware Virtual Volume
(Vvol) datastores.

System action:

The operation fails.

User response:

Specify a different transport mode and retry the operation.

------------------------------------------------------------------------
ANS9915E

The guest vm name is missing expected data files from the previous
backups. The backup operation continues based on the setting of the
VMVERIFYAction option.



Explanation:

During the verify operation, the number of data files that were found on
the server are insufficient to match the requirements of the control
files.

System action:

The backup operation for this VM continues based on the setting of the
VMVERIFYIFAction option.

User response:

Run a full VM backup for this virtual machine. Or, specify the
VMVERIFYAction option to force a full VM backup.

------------------------------------------------------------------------
ANS9916I

VMCUSER does not have one or more required vSphere privileges to
create/update/cancel Tasks in vSphere related to this operation. The
operation will continue.



Explanation:

VMCUSER does not have one or more required vSphere privileges to
create/update/cancel Tasks related to this operation. This is
informational only and does not affect the Backup/Restore operation.

System action:

A Task related to this operation may not show up in the vSphere Client
due to missing privileges. The operation will continue.

User response:

The vSphere Task provides additional information about IBM Spectrum
Protect initiated VM Backup/Restore operations including progress as
well as the ability to cancel these tasks from the vSphere Client.
Please refer to the 'VMware vCenter Server user privilege requirements'
section of the 'IBM IBM Spectrum Protect for Virtual Environments: Data
Protection for VMware User's Guide.'

------------------------------------------------------------------------
ANS9917E

Size estimates that correspond to the expected control files for vm name
do not match.



Explanation:

During the verify operation, the control files that were found on the
server do not match the expected size estimate of the data files for one
or more disks.

System action:

The backup operation for this VM continues based on the setting of the
VMVERIFYIFAction option.

User response:

Run a full VM backup for this virtual machine. Or, specify the
VMVERIFYAction option to force a full VM backup.

------------------------------------------------------------------------
ANS9918E

Cannot open migration candidates list for file-system.



Explanation:

Cannot access the migration candidates list for the specified file
system.

System action:

The system continues normal operation.

User response:

Select OK to return.

------------------------------------------------------------------------
ANS9919E

Failed to find the expected control files for vm name.



Explanation:

During a verify operation, the number of control files that were found
on the server do not match the expected amount for one or more disks.

System action:

The backup operation for this VM continues based on the VMVERIFYIFAction
option.

User response:

Perform a full VM backup for this virtual machine or specify the
VMVERIFYAction option to force a full VM backup.

------------------------------------------------------------------------
ANS9920W

Forcing a full vm backup for vm name.



Explanation:

During a verify operation, the number of control files that were found
on the server do not match the expected amount for one or more disks. As
a result, a full VM backup is performed.

System action:

The backup operation for this VM is a full backup instead of an
incremental backup.

User response:

Ensure the VERIFYIFAction option is set to the wanted value.

------------------------------------------------------------------------
ANS9921E

Virtual machine disk, vm name (disk label), verification check failed
(size on disk/ ctl size). If the disk is on an NFS datastore and the
disk size was recently changed or the disk was moved from non-NFS
datastore to NFS datastore, the verification failure is expected and a
full backup is required.



Explanation:

During a verify operation, the number of control files that were found
on the server do not match the expected number for this disk. For disks
on NFS datastores: Because of how VMware processes disk size changes and
because the Change Block Tracking (CBT) QueryChangedDiskAreas API does
not support change ID "*", the backup operation cannot determine whether
the the disk size was changed, the disk was moved to NFS datastore or
some other error occurred.

System action:

The backup operation for this VM proceeds based on the VMVERIFYIFAction
option.

User response:

Perform a full VM backup for this virtual machine or specify the
VMVERIFYIFAction option to force a full VM backup.

------------------------------------------------------------------------
ANS9922I

VMVERIFYIFLatest is enabled for vm name (action: type).



Explanation:

This VM operation verifies the control files from the previous backup to
ensure that all expected files are on the server.

System action:

The operation proceeds based on the value of the VMVERIFYIFAction
option.

User response:

Ensure the VERIFYIFAction option is set to the wanted value.

------------------------------------------------------------------------
ANS9923W

Forcing a full backup for vm name.



Explanation:

The MAX capacity of MBLK is not enough for the disks in the incremental
backup. A full backup will be performed.

System action:

The backup operation for this VM is a full backup instead of an
incremental backup.

User response:

None.

------------------------------------------------------------------------
ANS9924W

A full backup for the vm name virtual machine will be performed because
of added disk capacity.



Explanation:

The disk capacity of the virtual machine has increased since the last
backup. A full backup and a Changed Block Tracking (CBT) reset will be
performed.

System action:

The backup operation for this virtual machine is a full backup instead
of an incremental backup.

User response:

No action is required.

------------------------------------------------------------------------
ANS9950W

Streaming and partial recall modes can not be set for files migrated
using external backend.



Explanation:

Streaming or partial recall modes are not supported for files in this
mode.

System action:

Operation aborted.

User response:

Special recall modes are only available for files migrated using IBM
Spectrum Protect Server as a backend.

------------------------------------------------------------------------
ANS9951I

File: file-name has already been migrated.



Explanation:

You tried to migrate a file that is already migrated. Note that you may
get this message if the file is hard linked with another, already
migrated file.

System action:

The file is skipped.

User response:

None.

------------------------------------------------------------------------
ANS9958E

File 'file-namefile-namefile-name has not yet reached the age for
migration. File skipped.



Explanation:

This file cannot be migrated because it has not yet reached the age for
migration.

System action:

The file resides in state resident.

User response:

The minimal age of a file to be eligible for migration is two minutes.
Retry the migration operation after two minutes or use processing option
HSMENABLEIMMediatemigrate YES to force the migration.

------------------------------------------------------------------------
ANS9959W

IBM Spectrum Protect acceptor received a non-critical network error
errno, IBM Spectrum Protect return code : TSM-rc.



Explanation:

The communication problem happened while listening for inbound
connection but the IBM Spectrum Protect acceptor continues running.

System action:

Processing continues.

User response:

No further action is required, it can be safely ignored.

------------------------------------------------------------------------
ANS9984W

PFR plugin library was not found.



Explanation:

PFR plugin library should have been installed when the client was
installed, but it cannot be found.

System action:

The selected operation is not performed.

User response:

None.

------------------------------------------------------------------------
ANS9987W

Partial recall mode is not set for full-file-name



Explanation:

Partial recall mode is not set for the specified file.

System action:

The recall is not performed for the specified file. Processing stopped.

User response:

Set the partial recall mode on the file ("dsmattr
-recallmode=partialrecall" command) and re-try the operation.

------------------------------------------------------------------------
ANS9989W

Management class mcName specified on the INCLUDEstatement in file-name
at line line-number does not exist.



Explanation:

Management class named on the INCLUDE statement in the file-name file
does not exist in your assigned policy set on the server.

System action:

The object is bound to the default management class.

User response:

*  Update the INCLUDE statement so that it specifies a valid management
   class.

*  Define the management class named on the INCLUDE statement (if it is
   intended to have a management class with that name).

*  Verify that the node is in the correct policy domain (perhaps the
   node was accidentally put in the wrong policy domain, and the correct
   domain has the management class).

*  Remove the INCLUDE statement if it is no longer necessary to bind the
   files to the management class.

------------------------------------------------------------------------
ANS9990W

Management class mcName specified on INCLUDE statementin client option
set does not exist.



Explanation:

Management class named on the INCLUDE statement in client option file
does not exist in your assigned policy set on the server.

System action:

The object is bound to the default management class.

User response:

*  Update the INCLUDE statement so that it specifies a valid management
   class.

*  Define the management class named on the INCLUDE statement (if it is
   intended to have a management class with that name).

*  Verify that the node is in the correct policy domain (perhaps the
   node was accidentally put in the wrong policy domain, and the correct
   domain has the management class).

*  Remove the INCLUDE statement if it is no longer necessary to bind the
   files to the management class.

------------------------------------------------------------------------
ANS9992E

The following options must be set before running this operation: VMCHOST
or VMCUSER.



Explanation:

VMCHOST or VMCUSER is missing from the options file.

System action:

Operation cannot continue without options being set.

User response:

Manually edit the options file or use the preferences editor to set
these options.

------------------------------------------------------------------------
ANS9993E

Not able to override options.



Explanation:

The process can not override the options.

System action:

The command is not processed.

User response:

None.

------------------------------------------------------------------------
ANS9994W

Can not get response message, timeout reached.



Explanation:

The timeout was reached before getting response message. The option
override could be successful.

System action:

The command processed.

User response:

None.

------------------------------------------------------------------------
ANS9995W

The value of the VMMAXBACKUPSESSIONS option is 'ivmMaxBackupSessions'.
This value must be greater than or equal to the value of the
VMMAXPARALLEL option, which is 'ivmMaxParallel'.The value will be set to
the value of the VMMAXPARALLEL option.



Explanation:

The number of server sessions that are specified by the
VMMAXBACKUPSESSIONS option must be equal to or greater than the number
of virtual machines that are specified by the VMMAXPARALLEL option.

System action:

The operation continues.

User response:

Set the value of the VMMAXBACKUPSESSIONS option to a value that is
greater than or equal to the value of the VMMAXPARALLEL option.

------------------------------------------------------------------------
ANS9996W

The node has exceeded the maximum tape mounts that are allowed. No new
sessions will be added for 'vm-name'.



Explanation:

The node has exceeded the maximum tape mounts that are allowed. No new
sessions will be added for the backup VM.

System action:

The backup operation continues.

User response:

Use the MAXNUMMP parameter for the UPDATE NODE command on the server to
increase the number of allowed tape mounts for this node.

------------------------------------------------------------------------
ANS9997W

The dsmwatchd daemon failed to register failover mode: 'failover-mode'
on nodeID: 'node-ID'.



Explanation:

The dsmwatchd daemon was unable to register an appropriate HSM failover
callback on the mentioned node.

System action:

The dsmwatchd daemon operation continues without HSM failover support.

User response:

To register the HSM failover callback, restart the dsmwatchd daemon on
the affected node: - on AIX: run "kill -15 dsmwatchd_pid" command; - on
Linux: run "systemctl restart hsm" command.

------------------------------------------------------------------------
ANS9998W

The DMAPI dm_punch_hole() function failed to discard local file data
blocks during migration of 'file-name' file.



Explanation:

The migration operation succeeded, but it was unable to discard the file
local file data blocks due to a DMAPI dm_punch_hole() function issue. As
a result, the file system occupation didn't change upon such a
migration.

System action:

The migration operation continues.

User response:

To re-stub the file, perform a subsequent normal recall operation,
followed by one more migrate operation. If the cause of this message can
not be determined or resolved, contact your support representative.

------------------------------------------------------------------------
ANS9999E

():



Explanation:

This message carries diagnostic text relating to a client process or
algorithm. This information is intended for reporting processing
exceptions and other non-standard situations that occur on the IBM
Spectrum Protect client. The (component), (code), and (text) will vary
depending upon the cause of the message and the client process or
algorithm that issues the message.

System action:

Client processing may or may not continue depending upon the cause of
this message.

User response:

Examine error messages that may have been displayed before and/or after
this message and correct any problems, if possible. If the cause of this
message can not be determined or resolved, contact your support
representative. If you contact your support representative, the entire
text of this message should be reported.
