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.
Objects within a broad group of excluded objects that you want to include for backup, archive, and image 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.

Windows operating systems You can include remotely accessed files by specifying Universal Naming Convention (UNC) names in your include statement.

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:

The exclude.dir statement overrides all include statements that match the pattern.
The exclude.fs and exclude.dir statements override all include statements that match the pattern.
The include statements are not case-sensitive.
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

Mac OS X operating systems Oracle Solaris operating systems Linux operating systems AIX operating systems 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.

Windows operating systems Place these options in the client options file (dsm.opt). You can set these options on the Include-Exclude tab in the Preferences editor.

Syntax

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. Mac OS X operating systems

include.archive /home/test/* archmc 
include.backup /home/test/*

include.archive c:\test\*\ archmc 
include.backup c:\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
SYSTEMState
Asr

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® Storage Protect server 8.1.1 and later levels, or IBM Storage 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 Storage 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

AIX operating systems 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

If open file support has been configured, the client performs a snapshot backup or archive of files that are locked (or in use) by other applications. The snapshot allows the backup to be taken from a point-in-time copy that matches the file system at the time the snapshot is taken. Subsequent changes to the file system are not included in the backup. You can set the snapshotproviderfs parameter of the include.fs option to none to specify which drives do not use open file support.

To control how the client processes your file space for incremental backup, you can specify these additional options in your dsm.opt file as values of the include.fs option: diskcachelocation and memoryefficientbackup.

include.fs d: memoryefficientbackup=diskcachem 
  diskcachelocation=e:\temp
include.fs e: memoryefficientbackup=diskcachem 
  diskcachelocation=c:\temp

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.fs.nas

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.

Linux operating systems 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.

AIX operating systems 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.

Oracle Solaris operating systems Linux operating systems AIX operating systems This option is valid for AIX, Linux, and Oracle 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.

By default, the client performs an offline image backup. To enable and control an online image operation, you can specify these options in your dsm.opt file as values of the include.image option: snapshotproviderimage, presnapshotcmd, postsnapshotcmd.

include.systemstate

This option binds system state backups to the specified management class. If you specify this option, specify all as the pattern. If you do not specify this option system state backups are bound to the default management class.

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.

Oracle Solaris operating systems Linux operating systems AIX operating systems For the include.image option, the pattern is the name of a mounted file system or raw logical volume.

Windows operating systems For the include.image option, the pattern is the name of a file system or raw logical volume.

Note: When you specify include.systemstate, the only valid pattern is all.

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

include virtual_filespace_name/group_name management_class_name

where:

virtual_filespace_name

Specifies the name of the IBM Storage 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: Mac OS X operating systems

include MyVirtualFileSpace/MyGroup TEST

include MyVirtualFileSpace\MyGroup TEST

Table 1. 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


Windows only:

include c:\proj\text\devel.*
include c:\proj\text\* textfiles
include ?:\* managall
include WAS_ND_NDNODE mgmtclass
include WAS_APPNODE mgmtclass
include.backup c:\win98\system\* mybackupclass
include.archive c:\win98\system\* myarchiveclass
include.encrypt c:\win98\proj\gordon\*
include.compress c:\test\file.txt

include.image h: MGMTCLASSNAME 
  snapshotproviderimage=vss 
  
include.image x: 
  snapshotproviderimage=none
include.image y: 
  snapshotproviderimage=vss
include.image z: MGMTCLASSNAME
  snapshotproviderimage=none
include.fs c: 
  snapshotproviderfs=vss 
  
include.systemstate ALL mgmtc3
include.dedup c:\Users\Administrator\Documents\Important\...\*
include.dedup e:\*\* ieobjtype=image
include.dedup ALL ieobjtype=systemstate
include.dedup ALL ieobjtype=ASR

To encrypt all files on all drives:

include.encrypt ?:\...\*

Command line:

Does not apply.