Configuring Plug-in for SAP HANA

When you configure Veeam Plug-in settings, you set up integration settings between an SAP HANA server, Veeam Backup & Replication server and backup repositories where backup files will be stored. Veeam Plug-in uses the SapBackintConfigTool wizard to configure the integration settings. The wizard configures the SAP HANA Backint settings and creates the/opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml file.

Note

The configuration of Veeam Plug-in must be performed by a user with database administrator rights on all SAP HANA instances of the server.
The SAP HANA High Level Isolation mode is not supported.

See the following instructions:

Veeam Plug-in Configuration
Configuration of Veeam Plug-in on Multiple SAP HANA Instances
Verifying Configuration of Veeam Plug-in for SAP HANA
Configuration Tool Parameters

Veeam Plug-in Configuration

To configure Veeam Plug-in, do the following:

Log in with operating system user (<sid>adm or a user with similar 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 Permissions section.

SapBackintConfigTool --wizard

If you have extracted files form the .TAR.GZ archive, go to the /opt/veeam/VeeamPluginforSAPHANA folder and run the following command:

./SapBackintConfigTool --wizard

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

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

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

Enter backup server port number: 10006

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

Enter username: serv02\administrator

Enter password for serv02\administrator:

Important

Consider the following:

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.

The account must have access permissions on the required backup repository. To learn how to configure access permissions and encryption settings on repositories, see Access and Encryption Settings on Repositories.

Select the backup repository where you want to store backups. In the terminal dialog, enter the number of the repository from the list of available repositories.

Available backup repositories:

1. serv10_repo
2. serv07_repo
Enter repository number: 1
Configuration result:

SID SH2 has been configured

Important

The used account must have access to Veeam backup repositories that you plan to use.
Encryption must be disabled on the repository.

Otherwise, the 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.

If you start the wizard for the first time on an SAP HANA scale-out cluster, the wizard asks you for a cluster name. The cluster name will be used by Veeam Backup & Replication to identify the backup job for the cluster. Further runs of the wizard within the SAP HANA scale-out cluster will not ask for this entry again.

Note

[For SAP HANA 1.0] If the wizard finishes with an error that required hdbbackint symlink cannotbe created, see this Veeam KB.

Configuration of Veeam Plug-in on Multiple SAP HANA Instances

Configuration of Veeam Plug-in includes configuration or creation of the SAP HANA Backint symlinks on all SAP HANA instances. To be able to do this for multiple SAP HANA instances at the same time, the configuration must be performed by a user with root privileges. Alternatively, you can use an account from the sapsys user group to configure the plug-in and set the symlink for SAP HANA instances where the account has access rights. You can repeat the wizard under another account to configure additional SAP HANA instances.

Alternatively, you can configure a Linux security group. To do that, you must add all Veeam Plug-in admins to this security group and set the following rights:

chown root:<youradmingroup> /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

chmod 664 /opt/veeam/VeeamPluginforSAPHANA/veeam_config.xml

To learn about required permissions for backup and restore operations within SAP HANA, see this SAP article.

Verifying Configuration of Veeam Plug-in for SAP HANA

When you finish the plug-in configuration wizard, the plug-in creates a soft link in the /hana/shared/<SID>/global/hdb/opt directory.

To verify that the Backint Agent is configured correctly, do the following:

Connect to the database using SAP HANA Studio.
Go to Backup/Configuration.
In the Backint Agent field, make sure that the specified path leads to /opt/veeam/VeeamPluginforSAPHANA/hdbbackint.

Configuration Tool Parameters

Apart from running a configuration wizard, you can use the SapBackintConfigTool tool to change a specific parameter in the Veeam Plug-in configuration 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.

The following table lists available parameters for SapBackintConfigTool.

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 Plug-in configuration file (veeam_config.xml) or creates a new one if the configuration file was removed from the /opt/veeam/VeeamPluginforSAPHANA directory on the machine where Veeam Plug-in is installed.
--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-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 SapBackintConfigTool 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 more information, see Restore to Another Server (System Copy).
--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-scale-out-cluster-name	This command is supported for Veeam Plug-in operating in the managed mode. For more information, see Standalone and Managed Operations Modes. Sets the custom name for the cluster. During the Veeam Plug-in deployment on the scale-out system nodes, Veeam Backup & Replication sets the scale-out system name using domain name and SAP system name. If you want to set a custom name, use the --set-scale-out-cluster-name command on the computer side. This custom name will be saved in the veeam_config.xml file.
--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 using Veeam Explorer for SAP HANA. After you run the SapBackintConfigTool command with this parameter, use the SapBackintConfigTool 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 with Veeam Explorer for SAP HANA.

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:

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