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

Windows operating systems The backup-archive client uses the domain value in the following situations to determine which drives to process during an incremental backup:

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

Example 1: This example uses one domain statement to back up all local file systems except for the system state:

domain all-local -systemstate

Example 2: This example uses multiple domain statements to back up all local file systems except for the system state:

domain all-local domain -systemstate

Example 3: This example excludes the system state from a backup operation. If no other domain statement is used, the result is an empty domain. Nothing is backed up.

domain -systemstate

If you start the incremental command with a file specification, the client ignores any domain definitions and backs up only the file specification.

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

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

Windows operating systems Place this option in the options file, dsm.opt. You can set this option on the Backup tab, Domain for Backup section of the Preferences editor.

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

Parameters

all-local

Back up all local volumes on the system, and the Windows system state. This is the default setting. Local volumes are defined as volumes that are formatted with a supported file system (ReFS, NTFS, FAT32, or FAT) on a direct-attached storage device, including SAN and iSCSI attached storage. Directories that are mapped to drive letters by using the Windows subst command are included in a backup if the mapped directory is on a local disk.

The following types of volumes are not included when all-local is specified:

Network attached volumes, including CIFS shares that are mapped to drive letters.
Removable volumes, including CD/DVD drives, USB thumb drives, and floppy diskette drives. Some USB-attached hard disks are included in the all-local domain if Windows does not classify them as a removable storage device.

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.

systemstate

Back up the Windows system state. The systemstate domain is included in the all- local domain.

-systemstate

Exclude system state from backup processing.

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

domain c: d: e:
domain c: systemstate
domain ALL-LOCAL -systemstate
domain ALL-LOCAL -c:
domain ALL-LOCAL -\\florence\e$

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=c: d:
-domain="ALL-LOCAL -c: -systemstate"

Domain definition interaction

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

Windows operating systems 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 drive. 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 1. Interaction of domain definitions from several sources
Options file	Command line	Client option set	Objects backed up using the incremental command
`domain FS1`	`incremental -domain=FS2`	`domain FS3`	FS1 FS2 FS3
`domain FS1`	`incremental`	`domain FS3`	FS1 FS3
	`incremental -domain=FS2`		FS2
	`incremental -domain=FS2`	`domain FS3`	FS2 FS3
	`incremental`	`domain FS3`	FS3
	`incremental`		all-local
`domain all-local`	`incremental`	`domain FS3`	all-local + FS3
`domain all-local domain -FS1`	`incremental`		all-local, but not FS1
`domain -FS1`	`incremental`		none
`domain FS1 FS3`	`incremental`	`domain -FS3`	FS1
`domain all-local`	`incremental`	`domain -FS3`	all-local, but not FS3
	`incremental FS1 -domain=all-local`		FS1
	`incremental FS1`	`domain all-local`	FS1
`domain -FS1`	`incremental FS1`		FS1