Configuring Plug-in on Microsoft Windows
To configure backup and restore settings, use the Veeam Plug-in for Oracle RMAN configuration wizard. The wizard configures Oracle RMAN settings and creates the veeam_config.xml file which is stored in the %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN folder.
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 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.
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 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.
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_config.xml file or creates a new one if the configuration file was removed from the /opt/veeam/VeeamPluginforOracleRMAN directory. |
--set-credentials <"serv\username"> <"password"> | Specifies credentials to connect to the Veeam Backup & Replication server. |
--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. |
--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. |