Using Veeam Configuration Database Connection Utility in Veeam Backup & Replication for Linux
The utility is located on the backup server in the following directory: /opt/veeam/dbconfig. To use the utility, you must have root permissions on the local machine.
To manage connection settings for Veeam Backup & Replication, check prerequisites and perform the following steps:
Limitations and Considerations
Before you configure database connection settings, consider the following:
- Do not connect Veeam Backup & Replication to the database which is being used by another Veeam Backup & Replication. In that case, Veeam Backup & Replication will not be able to utilize the encrypted data stored in this database.
- Both local and remote PostgreSQL instances are supported. If a database with the specified name does not exist on the selected PostgreSQL instance, it will be created anew.
- The configuration database connection utility supports only connection to configuration databases of the current version.
- If the database requires a schema upgrade or all saved passwords must be entered again, you must allow these operations in the answer file. Otherwise, the utility stops with an error. See the ACCEPT_DATABASE_SCHEMA_UPGRADE and ACCEPT_STORED_PASSWORDS_LOSS parameters.
To generate the answer file, do the following:
- Log in to the host management console.
- Click Remote Access Configuration.
- Click Enter Shell.
- Run the following command to generate the answer file. In the generate parameter, specify the path where the answer file will be saved.
|
dotnet /opt/veeam/dbconfig/Veeam.Backup.DBConfig.Unattended.dll /generate:/var/lib/veeam/answerfile.xml |
After you run the command, the answer file will be generated with default preferences in the path you specified.
Edit the generated answer file and specify the necessary parameter values. Remove the optional parameters that you do not use.
|
Note |
|
If the answer file contains the SQL Server account password, store the file in a safe location. |
Answer File Parameters
|
Parameter |
Description |
Required |
|---|---|---|
|
product |
Specifies the product configuration mode. This is an attribute of the root element. For Veeam Backup & Replication, use vbr. |
Yes |
|
SQLSERVER_ENGINE |
Specifies the database server type. Supported values: postgresql or mssql. If you do not specify the parameter, the current product configuration is used. |
No |
|
DATABASE_SERVER |
Specifies the server on which the configuration database is deployed. Supported values: hostname:port or IP address:port. If you do not specify the parameter, the current product configuration is used. |
No |
|
SQLSERVER_DATABASE |
Specifies the name of the configuration database. If you do not specify the parameter, VeeamBackup is used. |
No |
|
SQLSERVER_AUTHENTICATION |
Specifies the authentication mode. Supported values: 1 for native authentication or 0 for Microsoft Windows authentication. If you do not specify the parameter, the current product configuration is used. |
No |
|
SQLSERVER_USERNAME |
Specifies the login name for the database server. Required if SQLSERVER_AUTHENTICATION is set to 1. |
No |
|
SQLSERVER_PASSWORD |
Specifies the password for the database server. Required if SQLSERVER_USERNAME is specified. |
No |
|
RETRY_COUNT |
Specifies the number of times the utility retries the configuration. If you do not specify the parameter, 3 is used. |
No |
|
STOP_PROCESSES |
Specifies whether the utility stops all running backup server processes. Supported values: 1 for Yes or 0 for No. If you do not specify the parameter, 1 is used. |
No |
|
ACCEPT_STORED_PASSWORDS_LOSS |
Specifies whether to proceed with attaching the database if all saved passwords must be entered again. Supported values: 1 for Yes or 0 for No. If you do not specify the parameter, 0 is used. If the value is 0 and the passwords must be entered again, the utility stops with an error. |
No |
|
ACCEPT_DATABASE_SCHEMA_UPGRADE |
Specifies whether to upgrade the database schema to the product version. Supported values: 1 for Yes or 0 for No. If you do not specify the parameter, 0 is used. If the value is 0 and the database requires an upgrade, the utility stops with an error. |
No |
To run the utility, do the following:
- Log in to the host management console.
- Click Remote Access Configuration.
- Click Enter Shell.
- Run the following command. In the file parameter, specify the path to the answer file.
|
dotnet /opt/veeam/dbconfig/Veeam.Backup.DBConfig.Unattended.dll /file:/var/lib/veeam/answerfile.xml |
The utility checks the database, applies the connection settings and starts the Veeam Backup & Replication services. You do not need to start the services manually.
The utility writes the log to /var/lib/veeam/VeeamBackupLogFolder/Utils/Util.VeeamBackupConfiguration.Reconfiguration.log.
Specifying Parameters at Runtime
You can specify answer file parameters when you run the utility in the following ways:
- Use the property argument. Specify the argument once for each parameter. For example: /property:SQLSERVER_DATABASE=VeeamBackup.
- Use an environment variable named VEEAM_<parameter name>. For example: VEEAM_SQLSERVER_DATABASE.
If you specify the same parameter in more than one place, the utility uses the value in the following order:
- The property argument.
- A non-empty value in the answer file.
- The environment variable.
If you do not specify a parameter anywhere, the utility uses the default value of the parameter. If the parameter has no default value, the utility returns an error.
The utility does not write secured parameter values, such as passwords, to the log.