Configuration Commands

You can use the DB2ConfigTool tool to change specific parameters in the configuration file, located in the /opt/veeam/VeeamPluginforDB2 directory.

Important

When you work with the command-line tool, use one configuration parameter per command. The tool does not support commands with multiple parameters.

You can use the following parameters with DB2ConfigTool:

Parameter

Description

--help

Shows the list of tool parameters.

--show-config

Shows configuration parameters.

--wizard

Starts the wizard to configure the plug-in settings. This wizard edits the veeam_config.xml file or creates a new one if the configuration file was removed from the /opt/veeam/VeeamPluginforDB2 directory.

--set-credentials <"serv\username"> <password>

Specifies credentials to log in to the Veeam Backup & Replication server.

--set-host <hostname>

Specifies the IP address or hostname of the Veeam Backup & Replication server.

--set-port <port_number>

Specifies a port number that Veeam Plug-in will use to communicate with the Veeam Backup & Replication server.

--set-repository

Launches a wizard to select a backup repository. A backup repository is selected from repositories which are available in the connected Veeam Backup & Replication server.

--compression

Sets Veeam Plug-in to use built-in compression functionality of Veeam Backup & Replication.

--set-throttling

Sets Veeam Plug-in to limit network bandwidth consumption. For details, see Configuring Performance Throttling.

--set-logarchmeth

Sets Veeam Plug-in to use logarchmeth1 configuration parameter. For details, see this IBM article.

--map-backup

Maps the imported backups. For details, see Importing Backup Files.

--get-restore-points

Returns a list of backups of your machine which are available in the connected Veeam Backup & Replication server.

To run the DB2ConfigTool command with this parameter, you must also specify the --time-range parameter with value in the yyyymm format. For details, see Get Backup Time Stamp.

--set-force-delete

Deletes backup files after specified days.

--promote-backup-copy-to-primary

Maps the imported backup copy to a regular Veeam Plug-in backup chain.

--set-backup-for-restore

[For System Copy] Specifies the backup that will be used for restore operations. You can use this parameter if you want to restore a database to another server or to restore a database from a backup copy.

When you run the DB2ConfigTool command with this parameter, Veeam Plug-in will prompt you to select an authentication method to access a backup created for the original server and then select the backup from which you want to restore a database. For details, see Restore to Another Server.

Example

To specify credentials that will be used to log in to the Veeam Backup & Replication server, use the plug-in configuration tool with the following command:

DB2ConfigTool --set-credentials "serv02\Administrator" password

Page updated 9/3/2024

Page content applies to build 12.2.0.334