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: - 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" 
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.
- 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. 
Adlocation
You can use the adlocation option with the query adobjects or restore adobjects commands to indicate whether the Active Directory objects are to be queried or restored from the local Active Directory Deleted Objects container or from a system state backup on the IBM Spectrum Protect server.- 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. - 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. - 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. - 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. - Asnodename
Use the asnodename option to allow an agent node to back up, archive, restore, retrieve, and query data on behalf of a target node. - Asrmode
Use the asrmode option with the restore and restore systemstate commands to specify whether to perform a restore operation in system ASR recovery mode. - 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. - 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. - Autodeploy
Use the autodeploy option to enable or disable an automatic deployment of the client if a restart is required. - 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. - Automount
The automount option adds an automounted file system into the domain by mounting it. Use this option with the domain option. - Backmc
The backmc option specifies the management class to apply to the backup fastback command for retention purposes. - Backupsetname
The backupsetname option specifies the name of a backup set from the IBM Spectrum Protect server. - 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. - Cadlistenonport
The cadlistenonport option specifies whether to open a listening port for the client acceptor. - Casesensitiveaware
The casesensitiveaware option specifies whether the Windows backup-archive client attempts to filter out file and directory objects that have name conflicts that are caused by different capitalization of the object names. - 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. - 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. - Clientview
The clientview option is available to users who have upgraded from the IBM® Tivoli® Storage Manager Express® backup client to the enterprise backup-archive client. - Clusterdisksonly
The clusterdisksonly option specifies whether the backup-archive client allows the backup of only clustered disks in specific environments. - Clusternode
The clusternode option specifies how the backup-archive client manages cluster drives. - 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. - Commmethod
The commmethod option specifies the communication method you use to provide connectivity for client-server communication. - 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. - 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. - Compressalways
The compressalways option specifies whether to continue compressing an object if it grows during compression. - Compression
The compression option compresses files before you send them to the server. - Console
Use the console option with the query systeminfo command to output information to the console. - Createnewbase
The createnewbase option creates a base snapshot and uses it as a source to run a full incremental backup. - Datacenter
Specifies the target location of the data center that will contain the restored machine data. - Datastore
Specifies the datastore target to be used during VMware restore operation. - Dateformat
The dateformat option specifies the format you want to use to display or enter dates. - Dedupcachepath
Use the dedupcachepath option to specify the location where the client-side data deduplication cache database is created. - 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. - 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. - 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. - Deletefiles
Use the deletefiles option with the archive command to delete files from your workstation after you archive them. - Description
The description option assigns or specifies a description for files when performing archive, delete archive, retrieve, query archive, or query backupset. - 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. - Diffsnapshot
The diffsnapshot option controls whether the backup-archive client creates the differential snapshot when it runs a snapshot difference incremental backup. - 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. - Dirmc
The dirmc option specifies the management class you want to use for directories. - Dirsonly
The dirsonly option processes directories only. The client does not process files. - 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. - 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. - 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. - Domain
The domain option specifies what you want to include for incremental backup. - Domain.image
The domain.image option specifies what you want to include in your client domain for an image backup. - Domain.nas
The domain.nas option specifies the volumes to include in your NAS image backups. - Domain.vmfull
The domain.vmfull option specifies the virtual machines (VMs) to include in your full virtual machine image backup operations. - 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. - 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. - 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. - Enable8dot3namesupport
The enable8dot3namesupport option specifies whether the client backs up and restores short 8.3 names for files that have long names on NTFS file systems. - 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. - 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. - 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. - Enablelanfree
The enablelanfree option specifies whether to enable an available LAN-free path to a storage area network (SAN) attached storage device. - Encryptiontype
Use the encryptiontype option to specify the algorithm for data encryption. - 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. - Errorlogmax
The errorlogmax option specifies the maximum size of the error log, in megabytes. The default name for the error log is dsmerror.log. - Errorlogname
This option specifies the fully qualified path and file name of the file that contains the error messages. - 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. - Exclude options
Use the exclude options to exclude objects from backup, image, or archive services. - Fbbranch
Use the fbbranch option with the backup fastback or archive fastback commands. - Fbclientname
Use the fbclientname option with the backup fastback or archive fastback commands. - Fbpolicyname
Use the fbpolicyname option with the backup fastback or archive fastback commands. - Fbreposlocation
Use the fbreposlocation option with the backup fastback or archive fastback commands. - Fbserver
Use the fbserver option with the backup fastback or archive fastback commands. - Fbvolumename
Use the fbvolumename option with the backup fastback or archive fastback commands. - Filelist
Use the filelist option to process a list of files. - Filename
Use the filename option with the query systeminfo command to specify a file name in which to store information. - Filesonly
The filesonly option restricts backup, restore, retrieve, or query processing to files only. - 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. - Forcefailover
The forcefailover option enables the client to immediately fail over to the secondary server. - 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. - 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. - 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. - 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. - 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. - Groups (deprecated)
This option is deprecated. - Host
The host option specifies the target ESX server location where the new virtual machine is created during a VMware restore operation. - Httpport
The httpport option specifies a TCP/IP port address for the web client. - Hsmreparsetag
The hsmreparsetag option specifies a unique reparse tag that is created by an HSM product installed on your system. - Ieobjtype
Use the ieobjtype option to specify an object type for a client-side data deduplication operation within include-exclude statements. - Ifnewer
The ifnewer option replaces an existing file with the latest backup version only if the backup version is newer than the existing file. - 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. - Imagetofile
Use the imagetofile option with the restore image command to specify that you want to restore the source image to a file. - Inactive
Use the inactive option to display both active and inactive objects. - Inclexcl
The inclexcl option specifies the path and file name of an include-exclude options file. - Include options
The include options specify objects that you want to include for backup and archive services. - 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. - 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. - Incrthreshold
The incrthreshold option specifies the threshold value for the number of directories in any journaled file space that might have active objects on the server, but no equivalent object on the workstation. - 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. - Instrlogname
The instrlogname option specifies the path and file name where you want to store performance information that the backup-archive client collects. - Journalpipe
The journalpipe option specifies the pipe name of a journal daemon session manager to which the backup clients attach. - 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. - 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. - Lanfreetcpport
The lanfreetcpport option specifies the TCP/IP port number where the IBM Spectrum Protect Storage Agent is listening. - 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 server V8.1.2 and later. - Lanfreetcpserveraddress
The lanfreetcpserveraddress option specifies the TCP/IP address for the IBM Spectrum Protect Storage Agent. - Language
The language option specifies the national language in which to present client messages. - Latest
Use the latest option to restore the most recent backup version of a file, even if the backup is inactive. - 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. - Makesparsefile
Use the makesparsefile option with the restore or retrieve commands to specify how sparse files are recreated. - Managedservices
The managedservices option specifies whether the IBM Spectrum Protect client acceptor service manages the scheduler, the web client, or both. - Maxcmdretries
The maxcmdretries option specifies the maximum number of times the client scheduler (on your workstation) attempts to process a scheduled command that fails. - 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. - 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. - Memoryefficientbackup
The memoryefficientbackup option specifies the memory-conserving algorithm to use for processing full file space backups. - Mode
Use the mode option to specify the backup mode to use when performing specific backup operations. - 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. - Myprimaryserver
The myprimaryserver option specifies the primary server name that the client uses to log on to the secondary server in failover mode. - Myreplicationserver
The myreplicationserver option specifies which secondary server stanza that the client uses during a failover. - Namedpipename
The namedpipename option specifies the name of a named pipe to use for communications between a client and a server on the same Windows server domain. - 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. - 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. - 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. - 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. - 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. - Noprompt
The noprompt option suppresses the confirmation prompt that is presented by the delete group, delete archive, expire, restore image, and set event commands. - 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. - Numberformat
The numberformat option specifies the format you want to use to display numbers. - Optfile
The optfile option specifies the client options file to use when you start a backup-archive client session. - Password
The password option specifies a password for IBM Spectrum Protect. - Passwordaccess
The passwordaccess option specifies whether you want to generate your password automatically or set as a user prompt. - Passworddir
The passworddir option specifies the directory location in which to store an encrypted password file. - Pick
The pick option creates a list of backup versions or archive copies that match the file specification you enter. - 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. - 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. - Postschedulecmd/Postnschedulecmd
The postschedulecmd/postnschedulecmd option specifies a command that the client program processes after it runs a schedule. - 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. - Preschedulecmd/Prenschedulecmd
The preschedulecmd option specifies a command that the client program processes before it runs a schedule. - Preservelastaccessdate
Use the preservelastaccessdate option to specify whether a backup or archive operation changes the last access time. - 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. - Presnapshotcmd
The presnapshotcmd option allows you to run operating system commands before the backup-archive client starts a snapshot. - 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. - Querysummary
The querysummary option provides statistics about files, directories and objects that are returned by the query backup or query archive commands. - Quiet
The quiet option limits the number of messages that are displayed on your screen during processing.. - 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. - Removeoperandlimit
The removeoperandlimit option specifies that the client removes the 20-operand limit. - 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. - Replserverguid
The replserverguid option specifies the globally unique identifier (GUID) that is used when the client connects to the secondary server during failover. The GUID is used to validate the secondary server to ensure that it is the expected server. - Replservername
The replservername option specifies the name of the secondary server that the client connects to during a failover. - Replsslport
The replsslport option specifies the TCP/IP port on the secondary server that is SSL-enabled. The replsslport option is used when the client connects to the secondary server during a failover. This option is deprecated if you are connecting to an IBM Spectrum Protect server V8.1.2 and later. - Repltcpport
The repltcpport option specifies the TCP/IP port on the secondary server to be used when the client connects to the secondary server during a failover. - Repltcpserveraddress
The repltcpserveraddress option specifies the TCP/IP address of the secondary server to be used when the client connects to the secondary server during a failover. - Resetarchiveattribute
Use the resetarchiveattribute option to specify whether the backup-archive client resets the Windows archive attribute on files that are successfully backed up to the IBM Spectrum Protect server. - 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. - 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. - Revokeremoteaccess
The revokeremoteaccess option restricts an administrator with client access privilege from accessing a client workstation that is running the web client. - Runasservice
The runasservice option forces the client command process to continue running, even if the account that started the client logs off. - Schedcmddisabled
The schedcmddisabled option specifies whether to disable the scheduling of commands by the server action=command option on the define schedule server command. - 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. - Schedgroup
The schedgroup option assigns a schedule to a group. - Schedlogmax
The schedlogmax option specifies the maximum size of the schedule log (dsmsched.log) and web client log (dsmwebcl.log), in megabytes. - Schedlogname
The schedlogname option specifies the path and file name where you want to store schedule log information. - 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. - 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). - Schedrestretrdisabled
The schedrestretrdisabled option specifies whether to disable the execution of restore or retrieve schedule operations. - Scrolllines
The scrolllines option specifies the number of lines of information that are displayed on your screen at one time. - 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. - 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. - 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. - Setwindowtitle
Use the setwindowtitle option to modify the title of the administrative client command window during processing. - 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. - Showmembers
Use the showmembers option to display all members of a group. - 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. - Skipaclupdatecheck
The skipaclupdatecheck option disables checksum and size comparisons of ACL data. - Skipmissingsyswfiles
Use the Skipmissingsyswfiles option to specify whether the backup-archive client skips certain missing VSS writer files and continues the system state backup. - Skipntpermissions
The skipntpermissions option bypasses processing of Windows file system security information. - Skipntsecuritycrc
The skipntsecuritycrc option controls the computation of the security cyclic redundancy check (CRC) for a comparison of Windows NTFS or ReFS security information during an incremental or selective backup, archive, restore, or retrieve operation. - Skipsystemexclude
Use the skipsystemexclude option to specify how to process exclude statements for certain operating system files that the IBM Spectrum Protect for Virtual Environments client skips by default. - Snapdiff
Using the snapdiff 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. - Snapdiffchangelogdir
The snapdiffchangelogdir option defines the location where the client stores persistent change logs that are used for snapshot differential backup operations. - Snapdiffhttps
Specify the snapdiffhttps option to use a secure HTTPS connection for communicating with a NetApp filer during a snapshot differential backup. - Snapshotcachesize
Use the snapshotcachesize option to specify an appropriate size to create the snapshot. - Snapshotproviderfs
Use the snapshotproviderfs option to enable snapshot-based file backup and archive operations, and to specify a snapshot provider. - Snapshotproviderimage
Use the snapshotproviderimage option to enable snapshot-based image backup, and to specify a snapshot provider. - 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. - Srvoptsetencryptiondisabled
The srvoptsetencryptiondisabled option allows the client to ignore encryption options in a client options set from the IBM Spectrum Protect server. - 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. - 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. - 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 V8.1.1 and earlier V8 levels, and V7.1.7 and earlier levels, it determines whether SSL is enabled. When the backup-archive client communicates with an IBM Spectrum Protect server V8.1.2 and later, 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. - 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 V8.1.2 and later. - Ssldisablelegacytls
Use the ssldisablelegacytls option to disallow the use of SSL protocols that are lower than TLS 1.2. - 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. - 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 V8.1.2 and later, this option no longer applies since SSL is always used. - 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. - Subdir
The subdir option specifies whether you want to include subdirectories of named directories for processing. - Systemstatebackupmethod
Use the systemstatebackupmethod option to specify which backup method to use to back up the system writer portion of the system state data. The method you select is used when you backup the system state data. - 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. - 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. - 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. - 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. - 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. - 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. - Tcpnodelay
The tcpnodelay option specifies whether the client disables the delay of sending successive small packets on the network, per transaction. - Tcpport
The tcpport option specifies a TCP/IP port address for the IBM Spectrum Protect server. You can obtain this address from your administrator. - Tcpserveraddress
The tcpserveraddress option specifies the TCP/IP address for the IBM Spectrum Protect server. You can obtain this server address from your administrator. - 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. - Timeformat
The timeformat option specifies the format in which you want to display and enter system time. - 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. - 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 - 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. - Txnbytelimit
The txnbytelimit option specifies the number of kilobytes the client program buffers before it sends a transaction to the server. - 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. - Updatectime
Use the updatectime option to check the change time (ctime) attribute during an incremental backup operation. - Usedirectory
The usedirectory option queries the Active Directory for the communication method and server with which to connect. - 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. - Usereplicationfailover
The usereplicationfailover option specifies whether automated client failover occurs on a client node. - Users (deprecated)
This option is deprecated. - V2archive
Use the v2archive option with the archive command to archive only files to the server. - Verbose
The verbose option specifies that you want to display detailed processing information on your screen. This is the default. - 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. - 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. - 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. - Virtualnodename
The virtualnodename option specifies the node name of your workstation when you want to restore or retrieve files to a different workstation. - Vmautostartvm
Use the vmautostartvm option with the restore VM vmrestoretype=instantaccess command to specify whether the VM created during instant access processing is automatically powered on. - 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. - 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. - 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. - 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. - 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. - 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. - Vmctlmc
This option specifies the management class to use when backing up virtual machine control files. - 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. - Vmdatastorethreshold
Use the vmdatastorethreshold option to set the threshold percentage of space usage for each VMware datastore of a virtual machine. - 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. - 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. - 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. - Vmdiskprovision
Use the vmdiskprovision option to specify a provisioning policy for the virtual disk file that is used to restore VMware virtual machine data. This option is valid only for restore vm operations where vmrestoretype=instantrestore is specified. - 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. - Vmexpireprotect
Use this option to protect virtual machine snapshots so that they cannot be expired while an instant restore or instant access operation of VMware VMs or while a file-level restore of a VMware VM is in progress. Use this option to protect virtual machine snapshots so that they cannot be expired while an instant restore or instant access operation of Hyper-V VMs or while a file-level restore of a Hyper-V VM is in progress. - Vmiscsiadapter
This option specifies which iSCSI adapter, on the ESX host, to use for instant restore and instant access operations for VMware virtual machines. - Vmiscsiserveraddress
Use the vmiscsiserveraddress option with the restore VM command to specify the host name or the IP address of the iSCSI server that provides the iSCSI targets for instant restore and instant access operations. - 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. - 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. - Vmlist
The vmlist option is deprecated for Hyper-V backup operations. To specify one or more Hyper-V virtual machines (VMs) to include in Data Protection for Microsoft Hyper-V backup operations, use the domain.vmfull option or specify the VMs when you run the backup vm command. - 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. - 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. - Vmmaxpersnapshot
Use the vmmaxpersnapshot option to specify the maximum number of virtual machines (VMs) to include in a Hyper-V snapshot. The VMs in the snapshot are backed up to the IBM Spectrum Protect server. - Vmmaxrestoresessions
The vmmaxrestoresessions option specifies the maximum number of IBM Spectrum Protect server sessions that can be included in an optimized restore operation for a virtual machine (VM). - Vmmaxrestoreparalleldisks
The vmmaxrestoreparalleldisks option enables an IBM Spectrum Protect client to restore multiple virtual disks at the same time. - Vmmaxsnapshotretry
Use the vmmaxsnapshotretry option to specify the maximum number of times to retry a snapshot operation of a virtual machine (VM) if the initial snapshot fails with a recoverable condition. - Vmmaxvirtualdisks
The vmmaxvirtualdisks option specifies the maximum size of the VMware virtual machine disks (VMDKs) to include in a backup operation. - 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. - Vmmountage
Use the vmmountage option with the restore VM "*" -vmrestoretype=mountcleanupall command to specify the number of hours that a VM file level restore mount must be active to be cleaned up. - 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. - 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. - 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). - Vmprocessvmwithindependent
Use this option to control whether full VMware virtual machine backups are processed if the machine is provisioned with one or more independent disk volumes. - Vmprocessvmwithphysdisks
Use the vmprocessvmwithphysdisks option to control whether Hyper-V RCT virtual machine (VM) backups are processed if the VM has one or more physical disks (pass-through disks) provisioned. - 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). - Vmrestoretype
Use the vmrestoretype option with the query VM or restore VM commands to specify the type of restore operation to perform or query. - 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) - Vmskipmaxvirtualdisks
The vmskipmaxvirtualdisks option specifies how the backup operation processes VMware virtual machine disks (VMDKs) that exceed the maximum disk size. - Vmskipmaxvmdks
The vmskipmaxvmdks option specifies how the backup operation processes VMware virtual machine disks (VMDKs) that exceed the maximum disk size. - Vmskipphysdisks
Use the vmskipphysdisks option to restore configuration information for physical disks (pass-through disks) that are associated with a Hyper-V virtual machine (VM), if the logical unit numbers (LUNs) that are associated with the volumes on the physical disks are available. - Vmstoragetype
Use the vmstoragetype option with the restore VM command to specify the storage device type from which the snapshot is mounted with IBM Spectrum Protect recovery agent. - 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. - 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. - Vmtempdatastore
Use the vmtempdatastore option with the restore VM command to define a temporary datastore on the ESX host for an instant restore operation. - 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. - 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. - 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. - Vssaltstagingdir
The vssaltstagingdir option specifies the fully qualified path that contains the system exclude cache and temporary data for VSS snapshot operation. - Vssusesystemprovider
The vssusesystemprovider option specifies whether to use the Windows system provider, or to let Windows decide the most suitable provider to use. - 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. - Webports
The webports option enables the use of the web client outside a firewall. - 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.