The ApplicationSettings section in the input XML file contains Veeam Agent for Microsoft Windows application settings.
<ApplicationSettings LogoText="Veeam Agent" LastCheckForUpdates="04/12/2017 01:31:07" ServiceProviderMode="False" LockDownMode="False" DisableBackupOverMeteredConnection="True" ShowBackupDuration="False" ThrottleBackupActivity="True" DisableControlPanelNotification="False" DisableScheduledBackups="False" CheckUpdates="True" CryptType="10"> |
For application settings configuration, the following parameters can be used:
Parent Tag | Parameter | Description |
---|---|---|
ApplicationSettings | Parent tag that encapsulates information about application settings of Veeam Agent for Microsoft Windows. | |
| LogoText | Text displayed at the top left corner of the Control Panel of Veeam Agent for Microsoft Windows. By default, the 'Veeam Agent' text is displayed. |
| ServiceProviderMode | Parameter describing if the Managed mode must be enabled. Possible values:
|
| LockDownMode | Parameter describing if the LockDown mode must be enabled. Possible values:
|
| DisableBackup | Parameter specifying if backup over metered connection must be performed. Possible values:
|
| ShowBackupDuration | Parameter switching the mode of displaying the backup statistics in the Control Panel of Veeam Agent for Microsoft Windows. Possible values:
|
| ThrottleBackupActivity | Parameter specifying if Veeam Agent for Microsoft Windows activities must be throttled during backup. Possible values:
|
| DisableControlPanel | Parameter specifying if Veeam Agent for Microsoft Windows notifications displayed on the notification bar must be disabled. Possible values:
|
| DisableScheduledBackups | Parameter describing if the scheduled backup job must be disabled. Possible values:
|
| CheckUpdates | Parameter describing if Veeam Agent for Microsoft Windows must automatically check for product updates. Possible values:
|
| LastCheckForUpdates | This parameter is available in the output XML file only. Date and time of the last check for application updates. |
| CryptType | This parameter is used if you configure email notifications settings, and the SMTP server requires authentication. Encryption method used to encrypt the user password. For more information, see Encryption of User Credentials. |
| CryptID | Required only for ProtectedDataCurrentUser and ProtectedDataLocalMachine encryption methods. GUID based on which a pair of asymmetric keys is generated (string of 32 characters with 4dashes, for example: 12345678-1234-1234-1234-123456789012). |
Parent Tag | Parameter | Description |
---|---|---|
EmailReport | Parent tag that encapsulates information about email notification settings in Veeam Agent for Microsoft Windows. | |
| Notification | Parameter describing if email notifications are enabled in Veeam Agent for Microsoft Windows. Possible values:
|
Header | Parent tag that encapsulates information about the header in email notifications. | |
| From | Email address from which Veeam Agent for Microsoft Windows sends email notifications. |
| To | Email address at which Veeam Agent for Microsoft Windows sends email notifications. |
| Subject | Subject of email notifications. You can use the following variables in the subject:
By default, Veeam Agent for Microsoft Windows sends email notifications with the following subject: [%JobResult%] %ComputerName% - %CompletionTime%. |
Conditions | Parent tag that encapsulates information about conditions in which Veeam Agent for Microsoft Windows sends email notifications. | |
| Failure | Parameter describing if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Failed status. Possible values:
|
| Warning | Parameter describing if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Warning status. Possible values:
|
| Success | Parameter describing if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Success status. Possible values:
|
Smtp | Parent tag that encapsulates information about the SMTP server that Veeam Agent for Microsoft Windows uses to send email notifications. | |
| Server | Full DNS name or IP address of the SMTP server. |
| Port | Port number for communication with the SMTP server. |
| SecureConnection | Parameter specifying if the SMTP server requires authentication. Possible values:
|
Credentials | This tag is used only if the SMTP server requires authentication. Parent tag that encapsulates information about credentials used to connect to the SMTP server. | |
| Username | This parameter is used only if the SMTP server requires authentication. User name of the account used to connect to the SMTP server. The user name is specified as a text string encoded in the Base64 format. |
| Password | This parameter is used only if the SMTP server requires authentication. Password of the account used to connect to the SMTP server. The password is encrypted. For more information, see Encryption of User Credentials. |
Example
This example runs the Import command and loads the following parameters from the C:\Veeam\Configuration.xml input XML file:
- Backup over metered connections is enabled.
- Backup activities are throttled when the system is busy.
- Veeam Agent for Microsoft Windows notifications in the Control Panel are disabled.
Veeam.Agent.Configurator.exe -import /f:C:\Veeam\Configuration.xml |
The input XML file has the following parameters:
<?xml version="1.0"?> |