Applying Custom Settings to Veeam Software Appliance
Purpose
This article documents the configuration files on the Veeam Software Appliance that correspond to registry locations in Windows used for custom settings in Veeam Backup & Replication.
Custom registry-based settings for Veeam Backup & Replication on Windows can also be applied to the Veeam Software Appliance. However, because the appliance runs on Linux, which does not use a registry hive, these settings must be placed in configuration files. These files can be customized through the Veeam Host Management Console.
Solution
Veeam Software Appliance configuration files are managed using the Veeam Host Management Console. For more information, review the following user guide page: Managing Configuration Files.
Accessing Configuration Files
- Access the Veeam Host Management Console Web UI
- Select Logs and Services in the left-side Navigation panel.
- Select Host Configuration within the Logs and Services view.
- From here, you can search for a specific configuration file.
See the table below for the registry to configuration file equivalent to know which one to edit.
| Registry Key | VSA Config File |
| HKLM\SOFTWARE\Veeam\Veeam Mount Service | /etc/veeam/veeam_mount_service.conf |
| HKLM\SOFTWARE\Veeam\Veeam Backup Catalog | /etc/veeam/veeam_backup_catalog.conf |
| HKLM\SOFTWARE\Veeam\Veeam Backup and Replication | /etc/veeam/veeam_backup_and_replication.conf |
| HKLM\SOFTWARE\Veeam\Veeam Threat Hunter\ | /etc/veeam/veeam_threat_hunter.conf |
This list is not exhaustive, and more entries may be added at a later time.
The configuration files consist of different sections in square brackets (e.g., [root]). Where [root] is the equivalent of the root of the listed key. Here are some examples for /etc/veeam/veeam_backup_and_replication.conf:
- [root] = HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
[API]= HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\API\[API\DbProvider]= HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\API\DbProvider\[DatabaseConfigurations\PostgreSql]=
HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\DatabaseConfigurations\PostgreSql\
Exporting and Importing
- When possible, export the existing configuration file, modify it as needed, and then import the modified file.
- If exporting a configuration file is not possible, create a new file with the required section header and values, and then import that file.
- If the Security Officer role is enabled, importing an updated configuration file will require approval from the Security Officer.
More Information
Example
This example uses the registry value shared and discussed on KB1230.
Windows-based Registry Value
Key Location: HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\
Value Name: InverseVssProtocolOrder
Value Type: DWORD (32-Bit) Value
Value Data: 1
Veeam Software Appliance Configuration Value
File: /etc/veeam/veeam_backup_and_replication.conf
Section: [root]
Value: InverseVssProtocolOrder=1
Explanation
As shown in the table above, the equivalent of HKLM\SOFTWARE\Veeam\Veeam Backup and Replication\ is /etc/veeam/veeam_backup_and_replication.conf . Since the registry value is not being added to a subkey, the appropriate section header in the conf file is [root]. So the registry Value Name is entered into that section with an equal symbol (=) and the value needed, "1".
Validating Setting Was Applied
For settings applied to the /etc/veeam/veeam_backup_and_replication.conf file, the following log file can be checked to verify that the service observed the conf file change:
/var/log/VeeamBackup/RegistryOptions/veeam_backup_and_replication.conf.log
Log example based on the example above:
Info (3) [Options] The following options are loaded from the registry:
Info (3) InverseVssProtocolOrder: "1"
If this KB article did not resolve your issue or you need further assistance with Veeam software, please create a Veeam Support Case.
To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.
Spelling error in text
Thank you!
Your feedback has been received and will be reviewed.
KB Feedback/Suggestion
This form is only for KB Feedback/Suggestions, if you need help with the software open a support case
Thank you!
Your feedback has been received and will be reviewed.
Oops! Something went wrong.
Please, try again later.