> Expert > Backup and Restore Agents > Databases > DB2 > DB2 Backup Administrator Guide > DB2 XML Parameters

XML Parameters for DB2 Subclient Configuration

The following table describes the supported DB2 subclient parameters.

Parameter

Description of Parameter Values

appName

The name of the application.

For Windows, use 'DB2'.

For UNIX, use 'DB2 on Unix''

clientName

The name of the client computer, as displayed in the CommCell Console where the instance is located

instanceName

The name of the DB2 instance

backupsetName

The backup set name

subclientName

The subclient name

encryptionFlag

Enable encryption

Valid values are:

  • ENC_MEDIA_ONLY, enable Media Only (MediaAgent Side) encryption

  • ENC_NETWORK_MEDIA, enable Network and Media (Agent Side) encryption

  • ENC_NETWORK_ONLY, enable Network Only (Agent Encrypts, MediaAgent Decrypts) encryption

  • ENC_NONE, no encryption

description

The subclient description

enableBackup

Option to allow backups. Set this to true.

networkAgents

Number of network agents.

Range: 1-4.

softwareCompression

Enable compression on the client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, enable software compression on the client

  • ON_MEDIAAGENT, enable software compression on the MediaAgent

  • USE_STORAGE_POLICY_SETTINGS, use the software compression options defined on the storage policy

  • OFF, disable software compression

throttleNetworkBandwidth

Enhance backup performance by reducing network bandwidth overhead.

Range: 2-2147483647.

applicableReadSize

The amount of application data backup jobs read for each unit transferred to the MediaAgent.

storagePolicyName

The data backup storage policy for the Oracle data backup.

enableDeduplication

Enable or disable deduplication

Valid values are:

  • true, enable deduplication

  • false, disable deduplication

generateSignature

Deduplication signature generated on the client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, enable signature generation on the client

  • ON_MEDIA_AGENT, enable signature generation on the MediaAgent

  • OFF, disable the signature generation

preBackupCommand

The script to run before a backup starts.

postBackupCommand

The script to run after the backup completes.

runPostBackup

Run the post-process script even if the restore job failed

Valid values are:

  • YES, run the script even if the job failed

  • NO, run the script only if the job succeeds

isSnapBackupEnabled

Enable or disable IntelliSnap

Valid values are:

  • true

  • false

snapShotEngineName

The IntelliSnap engine name.

snapToTapeProxyToUse/clientName

The proxy client name.

snapToTapeProxyToUseSource

Use the source if the proxy is unavailable.

Valid values are:

  • true, use the source

  • false, do not use the source

db2BackupMode

Specifies manner in which data file backups for this Subclient will be conducted.

Valid values are:

  • ONLINE_BACKUP, to perform an online backup of the database,

  • OFFLINE_BACKUP, to perform an offline (cold) backup of the database

contentOperationType

This can only be set when the db2backupType is 'DATABASE_SUBSET'.

Add or delete subclient content.

Valid values are:

  • ADD, add content

  • DELETE, remove content

db2NumberofBuffer

Specifies the number of buffers for the backup.

Valid values are 1-1000.

db2BufferSize

The size in KB of each buffer

Valid values are 8-1000.

db2Parallelism

Specifies the number of table spaces to be read in parallel for restore

Valid values are 0-1000.

db2UseCompression

Specifies whether to compress the backup

Valid values are:

  • true

  • false

db2BackupData

Backup the data.

Valid values are:

  • true

  • false

db2BackupType

Specifies whether to backup the entire database. Can only be used when db2BackupData is 'true'.

Valid Values are

  • ENTIRE_DATABASE, backup the entire database

  • DATABASE_SUBSET, backup a subset

db2Content/db2DataFile

Specifies the DB2 data to backup. Can only be used when db2BackupData is 'True and db2BackupType is 'DATABASE_SUBSET'.

db2BackupLogFiles

Backup the logs.

Valid values are:

  • true

  • false

db2DeleteLogFilesAfter

Delete the log files. Can only be set when db2backupLogFiles is 'True'.

Valid values are:

  • true

  • false

db2DisableSwitchCurrentLog

Set Disable Switch Current Log

This can be set if db2BackupLogFiles is 'True' and db2BackupData is 'False'.

Valid values are:

  • true

  • false

db2SubclientProp/numberOfBackupStreams

Specifies the maximum number of data backup streams.

Valid values are:

  • true

  • false

enableTableBrowse

Specifies whether you can browse and restore a DB2 table.

Valid values are:

  • 1, enable the table browse feature.

  • 0, do not enable the table browse feature

db2UseDedupeDevice

When this is enabled, the DB2 deduplication parameter DEDUP_DEVICE is used. This feature is available starting on DB2 version 9.7 with FixPack 3.

For additional information on the DB2 DEDUP_DEVICE parameter, go to the DB2 Knowledge Center, DEDUP_DEVICE.

Valid values are:

  • true

  • false

Loading...