Backup and archive processing options

This topic describes the options that you can use to control some aspects of backup and archive processing.

Table 1. Backup and archive processing options
Option	Description
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.
archsymlinkasfile	Specifies whether you want Tivoli® Storage Manager to follow a symbolic link and archive the file or directory to which it points, or archive the symbolic link only.
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.
automount	Use this option with the domain option to specify all automounted file systems the Tivoli Storage Manager client tries to mount at the following points in time: When Tivoli Storage Manager client starts When the backup is started When the Tivoli Storage Manager client has reached an automounted file system during backup
autofsrename	Specifies whether to rename an existing file space on a Unicode-enabled server so a Unicode-enabled file space can be created for the current operation.
backmc	Specifies the Tivoli Storage Manager management class to apply to the backup fastback subcommand for retention purposes.
changingretries	Specifies the number of times a back up or archive action is retried on a file that is in use.
class	Specifies whether to list the NAS or client Application Server objects during a query backup, query filespace, or delete filespace operation.
compressalways	The compressalways option specifies whether to continue compressing an object if it grows during compression. Use this option with the compression option.
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.
createnewbase Createnewbase	The createnewbase option creates a base snapshot and uses it as a source to run a full incremental. This ensures that the backup of any files that might have been skipped during the snapshot difference incremental.
deduplication Deduplication	Specifies whether to eliminate redundant data on the client side when transferring data to theTivoli Storage Manager server, during backup or archive processing.
dedupcachepath Dedupcachepath	Specifies the location where the client-side data deduplication cache database is created, if the enablededupcache=yes option is set during backup or archive processing.
dedupcachesize Dedupcachesize	Determines the maximum size of the data deduplication cache file.
enablededupcache Enablededupcache	Specifies whether you want to enable client-side data deduplication cache, so that Tivoli Storage Manager gets the changed data from the cache.
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.
description	The description option assigns or specifies a description for files when performing archive, delete, retrieve, query archive, or query backupset operations.
detail	Use the detail option to list management class, file space, backup, and archive information depending on the command with which it is used.
diffsnapshot	Use the diffsnapshot option to determine whether Tivoli Storage Manager creates a differential snapshot.
dirmc	Specifies the management class to use for directories. If you do not specify this option, the client uses the management class in the active policy set of your policy domain with the longest retention period.
dirsonly	Backs up, restores, archives, retrieves, or queries directories only.
diskcachelocation	Specifies the location where the disk cache database is created if the option memoryefficient=diskcachemethod option is set during an incremental backup.
domain	Specifies the file systems to include in your default client domain for an incremental backup.
domain	Specifies the drives to include in your default client domain for an incremental backup.
domain.image	Specifies the mounted file systems and raw logical volumes that you want to include in your client domain for an image backup. This option is for AIX®, HP-UX, Linux x86_64, Linux on POWER®, and Solaris only.
domain.image	Specifies the file systems and raw logical volumes that you want to include in your client domain for an image backup. This option is only valid for Windows 32-bit clients.
domain.nas	Specifies the volumes to include in your default domain for NAS image backups.
domain.vmfile Domain.vmfile	Specifies the virtual machines to include in file-level backups of VMware virtual machines.
domain.vmfull Domain.vmfull	Specifies the virtual machines to include in full image backups of VMware virtual machines.
efsdecrypt	Specifies whether files encrypted by an AIX Encrypted File System (EFS) are read in encrypted or decrypted format.
enablearchiveretentionprotection	Allows the client to connect to a data retention server.
enablelanfree Enablelanfree	Specifies whether to enable an available LAN-free path to a storage area network (SAN) attached storage device.
exclude exclude.backup exclude.file exclude.file.backup	Use these options to exclude a file or group of files from backup services.
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.
encryptiontype	Select AES-256, AES-128 or DES-56 bit data encryption. AES 256-bit data encryption provides the highest level of data encryption.
encryptkey	Specifies whether to save the encryption key password locally when performing a backup-archive operation or whether to prompt for the encryption key password.
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.
exclude.compression	Excludes files from compression processing if you set the compression option to yes. This option applies to backups and archives.
exclude.dir	Excludes a directory, its files, and all its subdirectories and their files from backup processing.
exclude.encrypt	Excludes specified files from encryption processing.
exclude.fs	Excludes file spaces matching a pattern. This option is valid for all UNIX clients.
exclude.fs.nas	Excludes file systems on the NAS file server from an image backup when used with the backup nas command. This option is for AIX and Solaris clients only.
exclude.fs.nas	Excludes file systems on the NAS file server from an image backup when used with the backup nas command.
exclude.image	Excludes mounted file systems and raw logical volumes that match the specified pattern from full image backup operations. This option is valid only for AIX, HP-UX, Solaris, and all Linux clients.
exclude.image	Excludes mounted file systems and raw logical volumes that match the specified pattern from full image backup operations. Incremental image backup operations are unaffected by exclude.image.
exclude.subfile	Excludes files from adaptive subfile backup processing. This option does not apply to archive processing.
fbbranch	Specifies the branch ID of the remote FastBack server to back up or archive.
fbclientname	Specifies the name of one or more FastBack clients to back up from the backup proxy.
fbpolicyname	Specifies the name of one or more Tivoli Storage Manager FastBack policies that you want to back up from the backup proxy.
fbreposlocation	Specifies the location of the Tivoli Storage Manager FastBack repository for the Tivoli Storage Manager client proxy to connect to issue MOUNT DUMP, MOUNT ADD and MOUNT DEL commands.
fbserver	Specifies host name of the FastBack server workstation or the FastBack DR Hub workstation that owns the repository specified by the fbreposlocation option.
fbvolumename	Specifies the name of one or more Tivoli Storage Manager FastBack volumes to back up from the backup proxy.
filelist	Specifies a list of files to be processed for the command. Tivoli Storage Manager opens the designated filelist and processes the files listed within according to the command.
filesonly	Backs up, restores, retrieves, or queries files only.
groupname	Use this option with the backup group command to specify the fully qualified name of the group leader for a group.
guitreeviewafterbackup	Specifies whether the client GUI is returned to the Backup, Restore, Archive, or Retrieve window after an operation finishes.
ieobjtype Ieobjtype	Specifies an object type for a client-side data deduplication operation. This option is used with the include.dedup and exclude.dedup options.
imagegapsize	Specifies the minimum size of empty regions on a volume that you want to skip during image backup. This option is valid for AIX JFS2 clients.
imagegapsize	Specifies the minimum size of empty regions on a volume that you want to skip during backup. This option is valid for Windows 32-bit clients.
inclexcl	Specifies the path and file name of an include-exclude options file.
include include.backup include.file	Use these options to include files or assign management classes for backup processing.
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 (aliases apply to Mac OS X) within broad group of excluded files for backup processing only.
include.compression	Includes files for compression processing if you set the compression option to yes. This option applies to backups and archives.
include.encrypt	Includes the specified files for encryption processing. By default, Tivoli Storage Manager does not perform encryption processing.
include.fs	Use the include.fs option to control how Tivoli Storage Manager processes your file space for incremental backup.
include.fs	Use the include.fs option to specify processing options for a given file system. Use the include.fs option to specify which drives use open file support and to control how full file space incremental backups are processed.
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 Tivoli Storage Manager 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. See Toc for more information. This option is valid for AIX and Solaris clients only.
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 Tivoli Storage Manager 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 client options file (dsm.opt). See Toc for more information.
include.image	Specifies a file system or logical volume to be included for image backup processing. This option also provides a way to specify an explicit management class assignment for a specified file system or logical volume. The backup image command ignores all other include options. This option is valid for AIX, HP-UX, Solaris, and all Linux clients.
include.image	Specifies a file system or logical volume to be included for image backup processing. This option also provides a way to specify an explicit management class assignment for a specified file system or logical volume. The backup image command ignores all other include options. Use the include.fs option to specify which drives use open file support and to control how full file space incremental backups are processed.
include.subfile	Includes files for adaptive subfile backup processing. This option does not apply to archive processing.
include.systemstate	Assigns management classes for back up of the Windows system state. The default is to bind the system object to the default management class.
incrbydate	Use with the incremental command to request an incremental backup by date.
incremental	Use with the restore image command to ensure that any changes that were made to the base image are also applied to the restored image. This option is only valid for AIX, HP-UX, Linux x86_64, Linux on POWER, and Solaris.
incremental	Use 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.
memoryefficientbackup	Specifies a memory-saving backup algorithm for incremental backups when used with the incremental command.
mode	Use the mode option with these commands, as follows: 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 To specify whether to perform a selective or incremental backup of VMware systems. backup vm To specify whether to perform a full or incremental backup of a VMware virtual machine when vmbackuptype=fullvm and when you have installed IBM® Tivoli Storage Manager for Virtual Environments.
monitor	Specifies whether you want to monitor an image backup of file systems belonging to a Network Attached Storage (NAS) file server.
noprompt	Suppresses the confirmation prompt that is presented by the delete group, delete archive, expire, and set event commands.
noprompt	Suppresses the confirmation prompt that is presented by the delete group, delete archive, expire, restore image, and set event commands.
nojournal	Use this option with the incremental command to specify that you want to perform the traditional full incremental backup, instead of the default journal-based backup.
nojournal	Use this option with the incremental command to specify that you want to perform the traditional full incremental backup, instead of the default journal-based backup.
optfile	Specifies the client options file you want to use when you start a Tivoli Storage Manager session.
optfile	Specifies the client user-options file you want to use when you start a Tivoli Storage Manager session.
postsnapshotcmd	During a snapshot-based backup, this option allows you to manually open an application after the snapshot is created. This option is valid only for AIX JFS2 or Linux LVM snapshot-based operations.
postsnapshotcmd	During an online image backup or open file support operation, this option allows you to manually open an application after the snapshot provider starts a snapshot. This option is only valid if the OFS or online image support is enabled.
preservelastaccessdate	Use this option during a backup or archive operation to specify whether to reset the last access date of any specified files to their original value following a backup or archive operation. By default, the Tivoli Storage Manager client does not reset the last access date of any backed up or archived files to their original value before the backup or archive operation.
presnapshotcmd	During a snapshot-based backup operation, this option allows you to manually quiesce an application before the snapshot is created. This option is valid only for AIX JFS2 or Linux LVM snapshot-based operations.
presnapshotcmd	During an online image backup or open file support operation, this option allows you to manually quiesce an application before the snapshot provider starts a snapshot. This option is only valid if the OFS or online image support is enabled.
removeoperandlimit	Specifies that Tivoli Storage Manager removes the 20-operand limit. If you specify the removeoperandlimit option with the incremental, selective, or archive commands, the 20-operand limit is not enforced and is restricted only by available resources or other operating system limits.
resetarchiveattribute	Specifies whether Tivoli Storage Manager resets the Windows archive attribute on files that are successfully backed up to a Tivoli Storage Manager server. This option is valid for all Windows clients.
skipacl	Specifies whether to skip ACL processing completely.
skipaclupdatecheck	Specifies whether to perform checksum and size comparisons before and after backup and during incremental processing.
skipntpermissions	Specifies whether to back up, archive, retrieve, or restore Windows security information.
skipntsecuritycrc	Specifies whether to compute the security CRC for permission comparison during subsequent backups. Use this option on all Windows clients.
snapdiff	Specifies an incremental backup of the files reported as changed by NetApp, instead of scanning the volume looking for files that have changed. Use this option with a NAS full volume incremental backup.
snapshotcachesize	Linux and AIX only: Use this option to specify an appropriate snapshot size so that all original data blocks can be stored during file modification and deletion. A snapshot size of 100 percent ensures a valid snapshot. This option is valid for AIX JFS2 file systems and Linux x86_64 clients only and has a default value of 100 percent.
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.
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. 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.
snapshotproviderimage	Use the snapshotproviderimage option to enable snapshot-based online image backup, and to specify a snapshot provider.
snapshotroot	Use the snapshotroot option with the incremental, selective, or archive commands in conjunction with a 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 Tivoli Storage Manager server.
snapshotroot	Use the snapshotroot option with the incremental, selective, or archive commands in conjunction with a 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 Tivoli Storage Manager server. This option is valid for all UNIX and Linux clients.
subdir	Specifies whether to include subdirectories of a named directory.
subfilebackup	Specifies whether Tivoli Storage Manager uses adaptive subfile backup.
subfilecachepath	Specifies the path where the client cache resides for adaptive subfile backup processing.
subfilecachesize	Specifies the client cache size for adaptive subfile backup.
tapeprompt	Specifies whether you want Tivoli Storage Manager 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.
toc	Use the toc option with the backup nas command or the include.fs.nas option to specify whether Tivoli Storage Manager 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 in conjunction with the RESTORE NODE server command to restore individual files or directory trees. You can also use the Tivoli Storage Manager web client to examine the entire file system tree and select files and directories to restore.
type	Use the type option with the query node command to specify the type of node to query.
v2archive	Use the v2archive option with the archive command to archive only files to the server. Tivoli Storage Manager will not process directories that exist in the path of the source file specification.
virtualfsname (does not apply to Mac OS X)	Use this option with the backup group command to specify the name of the container for the group on which you want to perform the operation.
virtualmountpoint	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.
vmchost	Used with the backup VM, restore VM, or query VM commands to specify the host name of the VMware VirtualCenter or ESX server where the commands are directed.
vmcpw	Used with the backup VM, restore VM, or query VM commands to specify the password of the VirtualCenter or ESX user that is specified with the vmcuser option.
vmcuser	Used with the backup VM, restore VM, or query VM commands to specify the user name for the VMware VirtualCenter or ESX server where the commands are directed.
vmlist	Used with the backup VM, restore VM, or query VM commands to specify the host name or list of host names of the virtual machine to back up.

Windows operating systems The following options are Backup-Archive Client options that apply only to HSM for Windows migrated files. Refer to IBM Tivoli Storage Manager for HSM for Windows Administration Guide for details about these options:

Restorecheckstubaccess
Restoremigstate
Skipmigrated