Configuring Plug-in on Windows

In this article

    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:

    1. On the Oracle server, click launch the Veeam RMAN Configuration Wizard (%PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN\Veeam.Backup.RMAN.Configuration.exe).
    2. 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. The specified account must have the local Administrator permissions on the Veeam Backup & Replication server.

    Configuring Plug-in on Windows 

    1. At the Backup Repository step of the wizard:
    1. 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.

    1. If you want to use another repository, select the repository from the list and click Remove. Then, you can add another repository
    2. At the Channels per repository field, specify the number of allowed parallel data streams for each repository.
    3. 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.

    1. Click Next.

    Configuring Plug-in on 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 Roles and Users section of the Veeam Backup & Replication Guide.

    1. 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.
    1. To export the veeam_config.xml file click Export and select Veeam Config.
    2. Click Finish.

    Configuring Plug-in on 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.

    To run a specific command, do the following:

    1. On the Oracle server, go to %PROGRAMFILES%\Veeam\VeeamPluginforOracleRMAN.
    2. 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.

    --configure-restore-from-copy

    Enables restore from backup copy. Note that if you enable restore from backup copy, you cannot back up databases with Veeam Plug-in. To revert changes, you must disable restore from backup copy.

    --promote-backup-copy-to-primary

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

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.