Configuring Plug-in on Microsoft Windows

To configure backup, restore and authentication settings, use the Veeam Plug-in for Oracle RMAN configuration wizard. The wizard configures Oracle RMAN settings and creates the Veeam Plug-in configuration file (veeam_config.xml) which is stored in the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN folder on the machine where Veeam Plug-in is installed.

Note that configuration wizard of Veeam Plug-in for Oracle RMAN changes the settings of Oracle RMAN. All original settings of Oracle RMAN are saved in the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\RMANParameters.xml file.

To configure Veeam Plug-in, do the following:

On the Oracle server, click launch the Veeam RMAN Configuration Wizard (%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\Veeam.Backup.RMAN.Configuration.exe).
At the Backup Server step of the wizard, specify the DNS name of the Veeam Backup & Replication server and OS user account credentials that will be used to connect to the server.

At the Backup Repository step of the wizard:

Click Add and select the required repository. For Oracle Database Standard Edition, you can select only one repository. If you want to use the Oracle RMAN Backup Duplexing functionality, you can select up to four repositories. The copies of backups will be sent to all selected repositories.

You must allow access to Veeam backup repositories that you plan to use. Also, the encryption on the repository must be disabled. To learn how to configure access and encryption on repositories, see Access and Encryption Settings on Repositories.

If you want to use another repository, select the repository from the list and click Remove. Then, you can add another repository.
At the Channels per repository field, specify the number of allowed parallel data streams for each repository.
If you want to enable Veeam Plug-in compression, select the Enable backup compression by the plug-in check box.

Note that if you use Veeam Plug-in compression in combination with Oracle RMAN integrated compression (BACKUP AS COMPRESSED commands), it can slow down processing.

Click Next.

Configuring Plug-in on Microsoft Windows

Important

You can work with backups created by Veeam Plug-in only with the account used for creating the backups. If you want to use another account, assign the Veeam Backup Administrator role or Veeam Backup Operator and Veeam Restore Operator roles to the account.

To learn how to assign Veeam Backup & Replication roles, see the Users and Roles section in the Veeam Backup & Replication User Guide.

At the Authentication step of the wizard, you can select a preferred authentication method to connect to the backup database.

You can choose between the operating authentication and database authentication methods. With the OS authentication method, you can connect to the server and database using OS user credentials. With the database authentication method, you can connect to the server using OS user credentials and to the database using database user credentials. The OS user account must be a user on the Oracle server with the required permissions to run RMAN.

If you select the database authentication method, you must specify the database user account credentials. The OS user credentials are applied automatically.

Note that the Veeam Plug-in configuration tool changes the settings of Oracle RMAN. All original settings of Oracle RMAN are saved in the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\RMANParameters.xml file.

For details, see Authentication Against Database.

Select Operating system authentication, to choose the OS authentication method.

The OS user credentials are applied automatically.

Configuring Plug-in on Microsoft Windows

Select Database authentication, to choose the database authentication method.

You can configure credentials for each of the target databases or one set of credentials for multiple databases. You can update all database credentials using the OracleRMANConfigTool command, if needed. The list of set credentials is stored in the veeam_config.xml configuration file.

The database user account must have the SYSBACKUP permission on the database. To learn more about Oracle permissions, see this Oracle article.

To set database credentials, perform one of the following:

Select an individual database and click Set user to configure the database user account credentials.
Select multiple databases and click Set user to configure common credentials for multiple target databases.

Configuring Plug-in on Microsoft Windows

At the Summary step of the wizard, you can export the plug-in and Oracle RMAN configuration files. You can use the configuration files to apply the plug-in settings on other servers.

To export the veeam_config.xml file click Export and select Veeam Config.
Click Finish.

Configuring Plug-in on Microsoft Windows

Note

When you export the configuration files, Veeam Plug-in automatically enables Oracle's Controlfile Autobackup feature. This feature is required for restoring with different settings using Veeam Explorer for Oracle.

Tip

It is recommended to save the configuration files, so that you can use it as a reference. For example, if you are planning to manually allocate channels for backup and restore operations, you will need the repository UUID. The RMAN configuration file (rman_config.txt) contains an example for channel allocation definition for the target repository. You can use this statement in your backup/restore scripts.

Configuration Tool Commands

Apart from running a configuration wizard, you can use the OracleRMANConfigTool.exe tool to change a specific parameter in the veeam_config.xml file or enable/disable Veeam Plug-in features.

Important

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

To run a specific command, do the following:

On the Oracle server, go to %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN.
Run the required OracleRMANConfigTool.exe command from the table below.

For 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:

OracleRMANConfigTool.exe --set-credentials "serv02\Joelle" "password"

Command	Description
--help	Shows the list of parameters of the plug-in configuration tool.
--show-config	Shows configuration parameters.
--wizard	Starts the wizard to configure the plug-in settings. This wizard edits the Veeam Plug-in configuration file (veeam_config.xml) or creates a new one if the configuration file was removed from the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN directory on the machine where Veeam Plug-in is installed.
--set-credentials <"serv\username"> <"password">	Specifies credentials to connect to the Veeam Backup & Replication server.
--set-db-credentials	Specifies credentials to connect to a single database.
--set-host <hostname>	Specifies the host of the Veeam Backup & Replication server.
--set-port <port_number>	Specifies the host to connect to the Veeam Backup & Replication server.
--set-repositories	Launches a wizard to select a backup repository. A backup repository is selected from repositories which are available in the connected Veeam Backup & Replication instance.
--set-parallelism <number_of_channels>	Configures Oracle RMAN parallelism settings.
--compression <y/n>	Enables/disables Veeam proprietary feature which compresses backup files.
--set-throttling	Enables/disables network traffic throttling. For more information, see Configuring Performance Throttling.
--map-backup	Maps the imported backups.
--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-auth-data-for-restore	Specifies an authentication method for database restore. Use this parameter if you want to restore a database to another server or to restore a database from a backup copy. After you run the OracleRMANConfigTool command with this parameter, use the OracleRMANConfigTool command with the --set-backup-for-restore parameter to select a backup from which you want to restore a database. For more information, see Restore to Another Server.
--get-backup-for-restore	Selects the backup for database restore. Use this parameter if you want to restore a database to another server or to restore a database from a backup copy. You can run the OracleRMANConfigTool command with this parameter to select a backup after you have specified an authentication method to access the backup using the OracleRMANConfigTool --set-backup-for-restore command. For more information, see Restore to Another Server.
--show-preferred-networks	Shows the list of preferred networks set for Veeam Plug-in data traffic to the remote backup repository. The list shows set preferred networks in descending order of priority. If the list is empty, no networks are set as preferred and Veeam Plug-in routes data traffic to the preferred networks set in Veeam Backup & Replication. For more information, see Specifying Preferred Networks for Veeam Plug-ins.
--add-preferred-network <network_IP_address> <position_in_list>	Adds a network to the list of preferred networks for Veeam Plug-in data traffic to the remote backup repository. To select to which network Veeam Plug-in connects first, you can set the order number of the network in the list. For more information, see Specifying Preferred Networks for Veeam Plug-ins.
--remove-preferred-network <network_IP_address>	Removes a specified network from the list of preferred networks for Veeam Plug-in data traffic to the remote backup repository.