The OFFLOAD section of the
configuration contains information that is related to Tivoli® Storage Manager backups
from a snapshot.
File names that are specified in this section typically
point to files that are on a backup server. The offload section is
optional and can exist for DB2®, DB2 in an SAP environment, Oracle, Oracle in an SAP environment,
and custom applications. The parameters do not depend on the storage
device.
The following list provides the parameters, a description
of each parameter, and default values applicable in all of the following
environments:
- DB2
- DB2 in an SAP environment
- Oracle
- Oracle in an SAP environment
- 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.
- DB2 and DB2 in an SAP environment - DB2
- DB2 standby
server - TSM_CLIENT
- Oracle - ORACLE
- Oracle in an SAP environment - BACKINT
- Custom application - TSM_CLIENT. When this option
is set for custom applications, in the CLIENT section,
the APPLICATION_TYPE is set to GENERIC.
If the parameter settings are not correct, an error might occur.
- Default
- Preset by the setup script, according to the environment.
- Advanced mode only
- Yes.
Offload DB2 and DB2 in an SAP environment parameters
The
following list provides the parameters, a description of each parameter,
and default values applicable in only
DB2 and
DB2 in an SAP environment:
- OPTIONS
- A file specification must be a fully qualified file name. If IBM® Tivoli Storage Manager for Enterprise Resource Planning is being
used, the IBM Tivoli Storage Manager for Enterprise Resource Planning DB2 vendor options file, vendor.env,
must be specified.
To be able to set up individual partitions in
a
DB2 environment
in a different manner, the placeholder string
%DB2NODE can
be embedded in the options string. At run time, the string is replaced
with the appropriate partition number for which the backup was issued.
This placeholder can be part of the vendor options file entry, thus
allowing different configuration files depending on the partition.
For example, if there are two partitions:
OPTIONS @/db2/T01/tdpr3/vendor_%DB2NODE.env
The
following two files are referred to:
/db2/T01/tdpr3/vendor_0.env
/db2/T01/tdpr3/vendor_1.env
The first file is used for
partition
0, the second for partition
1.
Specifying this parameter overrides the value that is specified by
the
VENDOROPT database configuration parameter.
- options string
- Specifies options to be used for this Tivoli Storage Manager backup
operation. The string is passed directly to the backup utility.
- @filename
- Specifies that the options to be used for the Tivoli Storage Manager backup
operation are contained in a file that is located on the backup server.
The string is passed directly to the backup utility.
- Default
- The default value is an empty string.
- Advanced mode only
- No.
- DB2_OPTIONS
- This parameter allows certain extra DB2 backup
command options to be set during an offload backup to Tivoli Storage Manager. The
options string that is specified by the DB2_OPTIONS parameter
is passed directly to the DB2 backup
command.
If multiple options must be specified in DB2_OPTIONS parameter
string, you must enclose the complete options string in single or
double quotation marks. The string (without the quotation marks) is
passed to the DB2 backup command.
The following example shows you how to define more than one option:
DB2_OPTIONS "DEDUP_DEVICE UTIL_IMPACT_PRIORITY 50"
- <options string>
- Specifies options to be used for this Tivoli Storage Manager backup
operation. The string is passed directly to the DB2 backup
command.
- Default
- The default value is an empty string.
- Advanced mode only
- Yes.
- DBPARTITIONNUM
- This parameter can be overridden by the tsm4acs command
option -N.
- ALL
- All partitions
- partition list
- Comma-separated list of partition numbers
- Default
- ALL
- Advanced mode only
- Yes.
- PARALLELISM
- The following list identifies the options for this parameter:
- n
- Number of table spaces that can be read in parallel by the backup
utility.
- AUTO
- DB2 calculates
an optimum value.
- Default
- AUTO
- Advanced mode only
- Yes.
- NUM_SESSIONS
- The following list identifies the options for this parameter:
- n
- Number of I/O sessions to be created between DB2 and Tivoli Storage Manager.
- Default
- 1
- Advanced mode only
- No.
- NUM_BUFFERS
- The following list identifies the options for this parameter:
- n
- The number of buffers to be used by DB2
- AUTO
- The DB2 software
calculates the optimum value for this parameter.
- Default
- AUTO
- Advanced mode only
- Yes.
- BUFFER_SIZE
- The following list identifies the options for this parameter:
- n
- The value of this parameter specifies the size, in 4 KB pages,
of the buffer that is used by the DB2 software
when the backup image is built. The minimum value is 8 pages.
- AUTO
- If the backup is automatically started, the DB2 software
calculates the optimum value.
- Default
- AUTO
- Advanced mode only
- Yes.
- PARALLEL_BACKUP
- The following list identifies the options for this parameter:
- YES
- The Tivoli Storage Manager backup
of all participating partitions is run in parallel.
- NO
- The Tivoli Storage Manager backups
of all participating partitions are sequentially run.
- Default
- No
- Advanced mode only
- Yes.
- DATABASE_MEMORY
- For Tivoli Storage FlashCopy® Manager software
to correctly protect DB2 database
data, the DB2 database
must be started on the backup system during the offload of this database
to Tivoli Storage Manager.
To start this database on the backup system, the DB2 software
needs the database memory size that is specified on the DB2 database
on the production system.
This parameter specifies the size of DB2 database
shared memory on the backup system. By specifying an empty string
or 0, the DB2 memory
size that is specified in the DB2 database
configuration on the production system is used.
- Default
- 0
- Advanced mode only
- Yes.
- NUMBER_BACKUPS_IN_PARALLEL
- In DB2 DPF
environments with more than one DB2 partition
start the offloaded Tivoli Storage Manager backup
in parallel for multiple DB2 partitions.
When running in large DB2 DPF environments
with more than one backup system, the performance of the overall offloaded Tivoli Storage Manager backup
can be increased if the Tivoli Storage Manager backups
of each DB2 partition
can be started in parallel on each of the backup systems.
This
profile parameter specifies the degree of parallelism to use during
the offloaded backup. If you specify a positive integer value for
this parameter, the specified number of Tivoli Storage Manager backups
start in parallel on each of the backup systems. For example, if a
value of 1 is specified, one backup is started
in parallel on each backup system. If the parameter value is 0,
no parallelism is used. If you want to use a value greater than 0 for NUMBER_BACKUPS_IN_PARALLEL,
set the PARALLEL_BACKUP value to NO.
- Default
- 0
- Advanced mode only
- Yes.
- VENDOR_LIB
- DEFAULT
- Use library or agent corresponding to database environment
- DB2_TSM_AGENT
- Use the DB2 Tivoli Storage Manager agent.
- TSM4ERP
- Use IBM Tivoli Storage Manager for Enterprise Resource Planning.
- library
- Use the fully qualified name for the custom library.
- Default
- DEFAULT
- Advanced mode only
- Yes.
Offload Oracle parameters
The following
list provides the parameters, a description of each parameter, and
default values applicable in only Oracle environments:
- OVERWRITE_DATABASE_PARAMETER_FILE
- The following list identifies the options for this parameter:
- YES
- To ensure that the database configuration files are identical,
replace the database configuration file on the backup system with
the version defined on the production system.
- NO
- Do not copy the production system database configuration file
to the backup system.
- Default
- YES
- Advanced mode only
- No.
- DATABASE_BACKUP_INCREMENTAL_LEVEL
- This parameter specifies the level of backup. Any numerical value
can be entered. The following conditions apply:
- To complete a full backup, use option 0. A full
backup must be completed before an incremental backup can be performed.
- To complete an incremental backup, enter a numerical value greater
than 0. Incremental backups are progressive. For
example, a level 0 backup must be performed before
a level 1 backup can occur. A level 1 backup
must be performed before a level 2 backup can occur.
- Default
- 0
- Advanced mode only
- No.
- ASM_INSTANCE_USER
- This parameter is used for the backup server. If this parameter
is not specified for the OFFLOAD section, the value
of this parameter, as specified in the ORACLE section,
is used for the backup server.
- user name
- Specify the user name of the ASM instance owner. Use this parameter
when the target database and the ASM instance are running under different
user IDs. The ASM instance has one of the following permissions: sysdba, sysasm,
or sysadm.
- AUTO
- When this parameter is set to AUTO, the database
user who is running the process is used.
- Default
- There is no default value.
- Advanced mode only
- Yes.
- ASM_INSTANCE_ID
- This parameter specifies the SID of the ASM instance. This parameter
is used for the backup server. If this parameter is not specified
for the OFFLOAD section, the value of this parameter,
as specified in the ORACLE section, is used for the
backup server.
You can have a SID for the ASM instance other than +ASM.
In this scenario, this profile parameter specifies the ASM instance
SID.
- Default
- 0
- Advanced mode only
- Yes.
- ASM_ROLE
- Specify the role that is used when connecting to the ASM instance.
When you use Oracle 11g, specify the sysasm role.
- Default
- 0
- Advanced mode only
- Yes.
Offload Oracle in an SAP environment parameters
The
following list provides the parameters, a description of each parameter,
and default values applicable in only
Oracle in an SAP environment environments:
- PROFILE
- This required parameter is used to specify the name of the external
SAP Backint profile (init<SID>.utl).
- Default
- There is no default value.
- Advanced mode only
- Yes.
Offload custom application parameters
The
following list provides the parameters, a description of each parameter,
and default values applicable in custom application environments and DB2 standby servers:
- MODE
- This parameter determines which of the following Tivoli Storage Manager Backup
Archive client backup functions to use when a Tivoli Storage Manager 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
of the advantages of the archive management class is that Tivoli Storage FlashCopy Manager 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 a Tivoli Storage Manager offloaded
backup.
ASNODENAME is the same option that
can be set in the dsm.sys file.
- Default
- None. This parameter is required.
- Advanced mode only
- No.
- 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 used for the DSM_DIR environment
variable. For UNIX and Linux operating systems, specify
the path where the executable file dsmc, the
resource files, and the dsm.sys file reside.
- Default
- The default value is an empty string.
- Advanced mode only
- Yes.
- DSM_OPT
- This optional parameter identifies the path and file name of the Tivoli Storage Manager client
options file: dsm.opt
- Default
- The default value is the path of the Tivoli Storage Manager client
installation directory.
- Advanced mode only
- Yes.
- DSM_LOG
- This optional parameter identifies the path used for the Tivoli Storage Manager client
error log file: dsmerror.log
- Default
- The default value is an empty string.
- Advanced mode only
- Yes.