Configuring Plug-in for SAP on Oracle

In this article

    When you configure Veeam Plug-in settings, you set up integration settings between the SAP on Oracle server, Veeam Backup & Replication server and backup repositories where backup files will be stored.

    Veeam Plug-in uses the SapOracleBackintConfigTool wizard to configure the integration settings. The wizard searches for all SAP on Oracle systems deployed on the server and creates the veeam_initODB.sap file for each system. This file will be used as an initialization profile for brbackup, brrestore and brarchive tools.

    Depending on which version of Oracle Database is used, Veeam Plug-in stores the configuration file in the following directories.

    • For Oracle 12 and later, the configuration file is stored at SAPDATA_HOME/sapprof.
    • For Oracle 11, the configuration file is stored at ORACLE_HOME/dbs.

    Note

    The configuration of Veeam Plug-in must be performed by a user with database administrator rights on the SAP server.

    In this section:

    Veeam Plug-in Configuration

    To configure Veeam Plug-in, do the following:

    1. Log in to the SAP server as a user with database administrator rights and run the following command to launch the Veeam Plug-in configuration tool. You do not need root privileges if you have configured group access as described in the Required Permissions section.

    sudo SapOracleBackintConfigTool --wizard

    1. Specify the DNS name or IP address of your Veeam Backup & Replication server.

    Enter backup server name or IP address: serv02.tech.local

    1. Specify the port which will be used to communicate with the backup server. Default port: 10006.

    Enter backup server port number: 10006

    1. Specify credentials to authenticate against the Veeam Backup & Replication server.

    Enter username: serv02\administrator

    Enter password for serv02\administrator:

     

    Important

    You can work with backup files created by Veeam Plug-in only with the account that was used to create the backups. If you want to use another account, assign the Veeam Backup Administrator role or the 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. Select a backup repository where you want to store backups.

    In the wizard dialog, you will see a list of available repositories. Enter the number of the target repository from the list.

    Available backup repositories:

    1. serv10_repo

    2. serv07_repo

    Enter repository number: 1

     

    Important

    Mind the following:

    • The account used to connect to the Veeam Backup & Replication server must have access to the target backup repositories.
    • Encryption must be disabled on the target backup repositories.

    Otherwise, backup repositories will not be listed as available. To learn how to configure access and encryption settings on repositories, see Access and Encryption Settings on Repositories.

    1. Specify the number of parallel data streams for each backup repository.

    Enter number of data streams (From 1 to 32) to run in parallel: 4

     

    Configuration result:

    An auxiliary initialization profile has been successfully created for SAP system "ODB": /oracle/ODB/sapprof/veeam_initODB.sap

    The created profile must be leveraged to perform backup and restore tasks by BR*Tools.

    Note that this parallelism setting applies only to backup and restore of Oracle datafiles. If you want to configure parallel channels for backup and restore of redo logs, see Configuring Parallelism for Redo Logs.

    Configuration Tool Commands

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

    See the list of available commands for SapOracleBackintConfigTool:

    Command

    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/VeeamPluginforSAPOracle/ 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 will be used 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 instance.

    --set-restore-server

    [for System Copy] Specifies the backup that will be copied.

    --set-parallelism <number_of_channels>

    Define the number of parallel channels that must be used to transfer Oracle datafiles during the backup and restore operations.

    You can set up to 32 channels.

    Note that the parallelism for redo logs is configured separately. For details, see Configuring Parallelism for Redo Logs.

    --map-backup

    Maps the imported backup.

    --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.

    Note that when you launch the command, the wizard will ask you to reconfigure the catalog backup from backint to disk.

    --promote-backup-copy-to-primary

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

    Example:

    The following example shows how to specify credentials that will be used to log in to the Veeam Backup & Replication server.

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

    I want to report a typo

    There is a misspelling right here:

     

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