`OFFLOAD`

Edit online

The OFFLOAD section of the profile configuration contains information that is related to IBM® Storage Protect backups from a snapshot.

File names that are specified in the offload section, typically point to files that are on a backup server. There is an exception for GPFS™. The file names point to files in the cluster node where the offload agent is running. The parameters do not depend on the storage device. There are different parameter sets for environments in GPFS clusters and other environments.

The following list provides the parameters, a description of each parameter, and default values applicable for custom applications.

BACKUP_METHOD

This parameter is preset by the setup script (the profile configuration wizard). The setup script value depends on the environment where the setup script is running:

If the BACKUP_ METHOD is set to TSM_CLIENT for custom applications, as set in the CLIENT section, the APPLICATION_TYPE is set to GENERIC.
The BACKUP_ METHOD is automatically set to MMBACKUP for custom applications in a GPFS environment.

Default: Preset by the setup script, according to the environment.
Advanced mode only: Yes.

Custom Applications OFFLOAD parameters

The following list provides the parameters, a description of each parameter, and default values applicable in custom application environments:

MODE

This parameter determines which of the following backup-archive client backup functions to use when an IBM Storage Protect offloaded backup is created:

ARCHIVE: Creates an archive backup of all files and directories that are specified in the backup request. Directories are processed recursively.
The ARCHIVE mode is similar to the FULL mode, except that the archive management class is used instead of a backup management class. One advantage of the archive management class is that IBM Storage Protect Snapshot does not need to resend all data after a failure during an archive operation. The remainder of the data is sent after the failure occurs.
FULL: Creates a full backup of all files and directories that are specified in the backup request. Directories are processed recursively.
DIFF: Creates a differential backup of all files and directories that are specified in the backup request. Directories are processed recursively. This operation backs up changes since the most recent full backup.
USE_FOR device class: Allows the backup mode to be changed based on the device class that is used to create the snapshot. Use this option to define rules that create a weekly full backup and daily incremental backups.
Tip: You can use the USE_FOR option to define multiple MODE statements within the OFFLOAD section.

Default: FULL
Advanced mode only: No.

ASNODENAME nodename

This required parameter identifies the name of the node where data is stored during an IBM Storage Protect offloaded backup.

The ASNODENAME parameter can be set in the dsm.sys file.

Default: None. This parameter is required.
Advanced mode only: No.

RUN_OFFLOAD_BACKUP_AS_ROOT

This parameter defines the user ID that runs the offloaded backup to the server on the backup system.

AUTO

The offloaded backup to the IBM Storage Protect server runs with the application backup user. If the application backup user does not have the permissions to back up the files on the input list, IBM Storage Protect Snapshot automatically switches to the root user ID. The offloaded backup then runs with the root user ID.

The offloaded backup to the IBM Storage Protect server always runs with the root user ID.

Default: AUTO.
Advanced mode: Yes.

VIRTUALFSNAME name

This parameter identifies the virtual file space name of a backup group. The parameter is available when the MODE parameter specifies a value of FULL or DIFF. VIRTUALFSNAME is optional.

Default: fcm
Advanced mode only: Yes.

DSM_DIR

This optional parameter identifies the path that is used for the DSM_DIR environment variable. For UNIX™ and Linux™ operating systems, this value specifies the path where the executable file dsmc, the resource files, and the dsm.sys file are stored.

Default: The default value is an empty string.
Advanced mode only: Yes.

DSM_CONFIG

This optional parameter identifies the path and file name of the IBM Storage Protect client options file: dsm.config.

Default: The default value is the path of the IBM Storage Protect client installation directory.
Advanced mode only: Yes.

DSM_LOG

This optional parameter identifies the path that is used for the IBM Storage Protect client error log file: dsmerror.log.

Default: The default value is an empty string.
Advanced mode only: Yes.

OFFLOAD parameters for custom applications in a GPFS cluster

The following offload parameters apply to GPFS environments:

MMBACKUP_SERVER

MMBACKUP_SERVER is a required parameter that identifies an IBM Storage Protect server where backup data is sent during an offloaded backup. Server names must be listed in the appropriate dsm.sys file. If data is to be sent to multiple IBM Storage Protect servers, multiple instances of this parameter can be specified. Snapshots are sent to each of the specified servers when a backup is requested.

Default: There is no default value.
Advanced mode only: No.

IBM Storage Protect Snapshot initiates incremental backup operations that use the GPFS mmbackup command. If a full backup was not completed to a particular IBM Storage Protect server, a full backup is created.

An offload operation fails when data is offloaded to two or more IBM Storage Protect servers when one server has data while another does not. If you want to add an IBM Storage Protect server to the list, create an offloaded backup to the new server first. Afterward, offloaded backups can be done to all servers.

MMBACKUP_OPTIONS

Use this optional parameter to add options to the mmbackup command. For a list of mmbackup options, see mmbackup command.

The following options are used by IBM Storage Protect, and cannot be set with this parameter: -t, -S, -v, -L, --scope, --tsm-servers, --rebuild.

The -q option is used by IBM Storage Protect Snapshot in certain circumstances, but can also be specified with the MMBACKUP_OPTIONS parameter. An offload operation fails if the backup contains a root file set and option -q is specified.

If the options string contains a blank character, it must be in quotation marks.

Default: No options are specified.
Advanced mode only: Yes.

MMBACKUP_MAX_RETRIES

In a GPFS environment, the value for the MMBACKUP_MAX_RETRIES parameter indicates the maximum number of times the mmbackup command is retried after it returns an exit code 1.

Default: 2
Advanced mode only: Yes.

DSM_DIR

This optional parameter applies to GPFS environments also. It identifies the path for the DSM_DIR environment variable. The DSM_DIR value shows the path where the executable file dsmc, resource files, and the dsm.sys file are stored.

Default: The default value is an empty string.
Advanced mode only: Yes.