Connecting to Another Database in Unattended Mode
In the unattended mode, the Configuration Database Connection Settings utility reads database connection settings from an answer file and does not require user input. You can use the unattended mode for Enterprise Manager installed on Microsoft Windows and Linux.
The utility comes with Veeam Backup Enterprise Manager and is located on the Enterprise Manager server. The default path is the following:
- On a Microsoft Windows-based machine:
|
%PROGRAMFILES%\Common Files\Veeam\Backup and Replication\DBConfig\Veeam.Backup.DBConfig.Unattended.exe |
- On a Linux-based machine:
|
/opt/veeam/dbconfig/Veeam.Backup.DBConfig.Unattended.dll |
Before You Begin
Before you connect Enterprise Manager to another configuration database in the unattended mode, consider the following:
- On a Microsoft Windows-based machine, you must have administrative rights on the local machine. Run the command-line shell as administrator.
- On a Linux-based machine, you must have root access. To request root access, use Veeam Host Management. For details, see Configuring Remote Access Settings.
- If Enterprise Manager is installed on the backup server, run the utility from the %PROGRAMFILES%\Veeam\Backup and Replication\Backup folder.
- 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. For details, see the ACCEPT_DATABASE_SCHEMA_UPGRADE and ACCEPT_STORED_PASSWORDS_LOSS parameters.
To connect Enterprise Manager to another configuration database in the unattended mode, do the following:
- Generate an answer file.
- Edit the answer file.
- Run the utility.
Step 1. Generate Answer File
Run the utility with the /generate parameter. In the parameter, specify the path where the utility must save the answer file:
- On a Microsoft Windows-based machine:
|
"%PROGRAMFILES%\Common Files\Veeam\Backup and Replication\DBConfig\Veeam.Backup.DBConfig.Unattended.exe" /generate:C:\answerfile.xml |
- On a Linux-based machine:
|
dotnet /opt/veeam/dbconfig/Veeam.Backup.DBConfig.Unattended.dll /generate:/root/answerfile.xml |
The utility saves a template of the answer file to the specified path.
Step 2. Edit Answer File
Open the answer file and do the following:
- In the root element, set the product attribute to em. The utility always generates the answer file with the vbr value.
|
<unattendedDatabaseConfiguration product="em"> |
- Specify the values of the parameters that you want to change. Always specify the SQLSERVER_DATABASE parameter. If you do not specify it, the utility uses the VeeamBackup database name, not the name of the Enterprise Manager configuration database.
- Remove the optional parameters that you do not use.
|
Note |
|
If the answer file contains the password for the database server account, store the file in a safe location. |
Answer File Parameters
The answer file contains the following parameters:
|
Parameter |
Description |
Required |
|
product |
Specifies the product whose configuration database connection settings you want to change. This is an attribute of the root element. Set the attribute to em. |
Yes |
|
SQLSERVER_ENGINE |
Specifies the database engine. Supported values: postgresql or mssql. If you do not specify the parameter, the current product configuration is used. |
No |
|
DATABASE_SERVER |
Specifies the database server on which the configuration database is deployed. Supported values: SERVER\INSTANCE for Microsoft SQL Server or HOSTNAME:PORT for PostgreSQL. If you do not specify the parameter, the current product configuration is used. |
No |
|
SQLSERVER_DATABASE |
Specifies the name of the configuration database. If a database with the specified name does not exist, the utility creates it. If you do not specify the parameter, VeeamBackup is used. Make sure that you specify this parameter, for example, VeeamBackupReporting. |
No |
|
SQLSERVER_AUTHENTICATION |
Specifies the authentication method. Supported values: 0 for Microsoft Windows authentication or 1 for native database server authentication. If you do not specify the parameter, the current product configuration is used. |
No |
|
SQLSERVER_USERNAME |
Specifies the login name of the database server account. Required if SQLSERVER_AUTHENTICATION is set to 1. If you do not specify the parameter, the current product configuration is used. |
No |
|
SQLSERVER_PASSWORD |
Specifies the password of the database server account. Required if SQLSERVER_USERNAME is specified. If you do not specify the parameter, the current product configuration is used. |
No |
|
RETRY_COUNT |
Specifies the number of times the utility retries to start or stop services if the operation fails. If you do not specify the parameter, 3 is used. |
No |
|
STOP_PROCESSES |
Specifies whether the utility stops the running product 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 the utility proceeds if all saved passwords must be entered again after you connect to the database. 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 the utility upgrades the database schema if the schema version of the database is earlier than the schema version that the installed Enterprise Manager requires. 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 schema requires an upgrade, the utility stops with an error. |
No |
Step 3. Run Utility
Run the utility with the /file parameter. In the parameter, specify the path to the answer file:
- On a Microsoft Windows-based machine:
|
"%PROGRAMFILES%\Common Files\Veeam\Backup and Replication\DBConfig\Veeam.Backup.DBConfig.Unattended.exe" /file:C:\answerfile.xml |
- On a Linux-based machine:
|
dotnet /opt/veeam/dbconfig/Veeam.Backup.DBConfig.Unattended.dll /file:/root/answerfile.xml |
The utility analyzes the database for issues, validates the new connection settings, stops the running Enterprise Manager processes, saves the connection settings and starts the Enterprise Manager services. You do not need to start the services manually.
Specifying Parameters at Runtime
You can specify answer file parameters when you run the utility in the following ways:
- Use the /property parameter. Specify the parameter once for each answer file parameter. For example: /property:SQLSERVER_DATABASE=VeeamBackupReporting.
- 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 parameter.
- 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 passwords to the log.