Modifying DB2 Subclient Properties Using the Commvault Command Line Interface

Updated

Use XML to modify DB2 subclient properties. Run the operation from the command line, or automate configuration by combining command line operations in a script.

The XML parameters can be included in the XML file, or specified on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

Procedure

  1. On the DB2 Agent host, run the qlogin command to log on to the CommServe.

  2. Download the UpdateSubclient.xml file and save it on the computer from where you will run the command.

  3. Open the UpdateSubclient.xml file, add your specific parameters and save the file.

    For information on supported subclient XML parameters, see Available XML Parameters for DB2 Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base and type the command.

    UNIX

    qoperation execute -af UpdateSubclient.xml -appName 'DB2 on Unix' -clientName 'client1' -instanceName 'dbname' -backupsetName 'backupset_name'-subclientName 'subclient_name'

    Windows

    qoperation execute -af UpdateSubclient.xml -appName 'DB2' -clientName 'client1' -instanceName 'dbname' -backupsetName 'backupset_name'-subclientName 'subclient_name'

  5. Run the qlogout command to log off the CommServe computer.

Examples

Modifying the Storage Policy and Deduplication on a Subclient on Windows

Note: You must set the enableDeduplication parameter to 'true' when you use the generateSignature parameter.

To modify a subclient Storage Policy (in this example, the software compression will use the Storage Policy Settings and deduplication is enabled with the signature on the MediaAgent), set the following parameters:

Parameter

Value

storagePolicy

'the data storage policy

enableDeduplication

'true'

generateSignature

'ON_MEDIA_AGENT'

dataBackupStoragePolicy/storagePolicyName

Storage Policy Name (in this example, 'data_sp').

appName

In this example, 'DB2'.

qoperation execute UpdateSubclient.xml -appName 'DB2' -clientName 'client1' -instanceName 'Instance001' -backupsetName 'test_backup_set'-subclientName 'subclient1' -enableDeduplication true -generateSignature ON_MEDIA_AGENT -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Modifying the Storage Policy and Deduplication on a Subclient on UNIX

Note: You must set the enableDeduplication parameter to 'true' when you use the generateSignature parameter.

To modify a subclient Storage Policy (in this example, the software compression will use the Storage Policy Settings and deduplication is enabled with the signature on the MediaAgent), set the following parameters:

Parameter

Value

storagePolicy

'the data storage policy

enableDeduplication

'true'

generateSignature

'ON_MEDIA_AGENT'

dataBackupStoragePolicy/storagePolicyName

Storage Policy Name (in this example, 'data_sp').

appName

In this example, 'DB2 on Unix'.

qoperation execute UpdateSubclient.xml -appName 'DB2 on Unix' -clientName 'client1' -instanceName 'Instance001' -backupsetName 'test_backup_set'-subclientName 'subclient1' -enableDeduplication true -generateSignature ON_MEDIA_AGENT -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Renaming a Subclient on Windows

To rename a subclient, set the following parameters

Parameter

Value

newName

In this example "subclient1a"

appName

In this example, 'DB2'.

qoperation execute UpdateSubclient.xml -appName 'DB2' -clientName 'client1' -instanceName 'Instance001' -backupsetName 'test_backup_set'-subclientName 'subclient1' -newName 'subclient1a

Renaming a Subclient on UNIX

To rename a subclient, set the following parameters

Parameter

Value

newName

In this example "subclient1a"

appName

In this example, 'DB2 on Unix'.

qoperation execute UpdateSubclient.xml -appName 'DB2 on Unix' -clientName 'client1' -instanceName 'Instance001' -backupsetName 'test_backup_set'-subclientName 'subclient1' -newName 'subclient1a

Configuring the Subclient to Use the DB2 Deduplication Parameter

To modify a subclient so that the Commvault software uses the DB2 deduplication parameter, set the following parameters:

Parameter

Value

db2UseDedupeDevice

'true'

appName

In this example, 'DB2 on Unix'.

qoperation execute UpdateSubclient.xml -appName 'DB2 on Unix' -clientName 'client1' -instanceName 'Instance001' -backupsetName 'test_backup_set'-subclientName 'subclient1' -db2UseDedupeDevice true

Was this page helpful?