Keywords for the db2.conf file

The db2.conf file provides definitions NetBackup uses to perform DB2 backup and restore operations.

Each definition is a grouping of keyword value pairs.
Each definition contains an OBJECTTYPE keyword and value.
Each definition ends with the ENDOPER keyword.
All other keyword value pairs are optional, depending on the OBJECTTYPE.
Within a definition, the keyword value pairs can appear in any order.
The keywords are not case-sensitive, but the values are case-sensitive.
When a pound character (#) appears in the first column, the line is treated as a comment.
Backup and restore operations have two definitions, one for OBJECTTYPE DATABASE or TABLESPACE and one for OBJECTTYPE ARCHIVE.
Restore operations to a different instance or database (not the original) must also have a definition for OBJECTTYPE ALTERNATE.
NetBackup searches the file from top to bottom and uses the first definition that is found for the operation being performed. Later definitions for the same operation are ignored.
NetBackup searches each definition from top to bottom and uses the first value specified for each keyword found. Later definitions for the same keyword are ignored.

The db2.conf file specifies the keywords that are described in this topic. If LOGARCHMETH1 VENDOR is configured in your DB2 environment, NetBackup for DB2 ignores the following keywords.

The following keywords:

ARCDIR
ARCFUNC SAVE
ARCFUNC COPY
PARTITIONTYPE RAW
RETDIR

Table: Keyword value pairs for the db2.conf file describes the keywords and values that are used.

Table: Keyword value pairs for the db2.conf file

Keyword value	Description
ARCDIR dir	Full path to the location of the archive logs. No default. Required if ARCFUNC COPY is also specified. Note: Ignored for LOGARCHMETH1 VENDOR.
ARCFUNC SAVE ARCFUNC COPY	ARCFUNC SAVE saves archive logs to/from NetBackup. ARCFUNC COPY copies archive logs to/from ARCDIR/RETDIR directories. You must specify either ARCFUNC SAVE or ARCFUNC COPY if OBJECTTYPE ARCHIVE is also specified. Note: Ignored for LOGARCHMETH1 VENDOR.
CATALOG_HOST	The catalog name under which backup images are cataloged.
For UNIX: BKUP_IMAGE_PERM	Lets you set the permissions on a backup image at backup time. Possible values are the following: USER - set the permissions to 600. Only the original user who backed up the data has access to the backup images. GROUP - set the permissions to 660. Anyone from the same group as the original user who backed up the data has access to the backup images. ANY - set the permissions to 664. Anyone has access to the backup images. If this variable is not specified, the permissions default to 660. Does not apply to backups by the user exit program, normal file system permissions are used. If you use LOGARCHMETH1 VENDOR, you can use the new keyword in the `db2.conf` or specify the keyword in the LOGARCHOPT1 parameter in the database configuration.
CLIENT_NAMEclient_name	An alternate client name. Most commonly used to specify a different source client to use for alternate restores. May also be used on multi-homed client hosts to specify a host name that is associated with a specific local network interface. This host name can be different from the host name that is used for file system backups.
DATABASE db_name	DB2 database name. No default. Required for all definitions except OBJECTTYPE ALTERNATE.
DB2_COPY_NUMBER	Allows the user to explicitly specify the copy number to be used to perform restores.
DB2_MEDIA_SERVER	Allows the user to explicitly specify the media server to be used to perform restores. The media server must have access to the copy of the image from which the restore occurs.
DESTALIAS db_name DESTINST inst_name	DESTALIAS specifies the database alias name of the destination database for an alternate restore. DESTINST specifies the instance name of the destination instance for an alternate restore. No default. Required for OBJECTTYPE ALTERNATE.
ENDOPER	Signals the end of a definition. Required at the end of each definition.
FORCE_BACKUP_CLIENT	The local client name. The client name is needed when DB2 performs an archive backup immediately following an alternate restore from another client. This client name allows the backup to be taken using the correct client name for the local host. The CLIENT_NAME still references the source client that is used to select the backup images that the restore needs.
NODE number	Specifies the DB2 node number that must match the local node in order for the other keywords and values to be used. Do not specify this keyword unless you operate within a DB2 Enterprise Extended Edition (EEE) environment. Not required. No default.
OBJECTTYPE ALTERNATE OBJECTTYPE ARCHIVE OBJECTTYPE DATABASE OBJECTTYPE TABLESPACE	Specify OBJECTTYPE ALTERNATE to indicate that the definition pertains to performing a restore from an alternate instance or alternate database. Specify OBJECTTYPE DATABASE or OBJECTTYPE TABLESPACE for database container backup or restore. Specify OBJECTTYPE ARCHIVE for archive log backup or restore. One of OBJECTTYPE ALTERNATE, OBJECTTYPE ARCHIVE, OBJECTTYPE DATABASE, or OBJECTTYPE TABLESPACE is required in all db2.conf files. OBJECTTYPE ALTERNATE is required only if you want to perform an alternate restore.
PARTITIONTYPE RAW	Specifies the NetBackup search for the archive log files that are backed up from a raw partition during a restore. Not Required. For the POLICY, specify the name of a DB2 policy. This policy can be the same as the one that you use to back up the database. In the SCHEDULE line, specify an Application Backup schedule.
POLICY pol_name	The name of a NetBackup policy. If not specified, NetBackup uses the first policy of the correct type that is found in the configuration on the NetBackup master server. The policy should be of type DB2 unless the definition is OBJECTTYPE ARCHIVE for use with the user exit program and ARCFUNC SAVE. In that case it should be of type MS-Windows or Standard. Does not apply to OBJECTTYPE ALTERNATE. Should be specified for all other definitions.
RESTORE_PRIORITY	Specifies the restore priority in NetBackup.
RETDIR dir	Full path to the location from which the archive logs are retrieved. No default. Required if ARCFUNC COPY is also specified.
SCHEDULE sched_name	NetBackup schedule name in the policy. The default is the first schedule of the correct type in the policy. The schedule should be of type Application Backup unless the definition is OBJECTTYPE ARCHIVE for use with the user exit program and ARCFUNC SAVE. In that case it should be of type User Backup. Does not apply to OBJECTTYPE ALTERNATE.
SERVER	Name of the NetBackup master server.
SRCALIAS src_db_name SRCINST src_inst_name	SRCALIAS specifies the database alias name of the source database for an alternate restore. SRCINST specifies the instance name of the source instance for an alternate restore. No defaults. Required for OBJECTTYPE ALTERNATE.

More Information

NetBackup for DB2 backup types

Specifying the master server for a NetBackup for DB2 client

Creating a db2.conf file for use with the user exit program

Example db2.conf file using ARCFUNC SAVE

Example db2.conf file using ARCFUNC COPY

NetBackup for DB2 environment variables

Keywords for the db2.conf file

Feedback

Feedback