Application Parameters

In this article

    The ApplicationSettings section in the XML file contains Veeam Agent for Microsoft Windows application settings.

    <ExecutionResult>
    <ApplicationSettings CryptId='00000000-0000-0000-0000-000000000000' CryptType='10' DisableControlPanelNotification='False' DisableScheduledBackups='False' DisableWakeupTimers='False' EnableUserFlr='False' LastCheckForUpdates='01/14/2019 02:30:17' LockDownMode='False' LogoText='Veeam Agent' ServiceProviderMode='False' ShowBackupDuration='False' ThrottleBackupActivity='True'>
           <Throttling DisableBackupOverMeteredConnection='True' LimitBandwith='False' RestrictVPNConnections='False' RestrictWiFiNetworks='False' SpeedLimit='1' SpeedUnit='2' />
    </ApplicationSettings>
    </ExecutionResult>

    For application settings configuration, the following parameters can be used in the input XML file:

    General Settings

    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 describes if the Managed mode must be enabled. Possible values:

    • True — Managed mode is enabled.
    • False — Managed mode is not enabled.

     

    LockDownMode

    Parameter describes if the LockDown mode must be enabled. Possible values:

    • True — LockDown mode is enabled.
    • False — LockDown mode is not enabled.

     

    ShowBackupDuration

    Parameter switches the mode of displaying the backup statistics in the Control Panel of Veeam Agent for Microsoft Windows. Possible values:

    • True — Veeam Agent for Microsoft Windows displays backup duration.
    • False — Veeam Agent for Microsoft Windows displays backup size.

     

    ThrottleBackupActivity

    Parameter specifies if Veeam Agent for Microsoft Windows activities must be throttled during backup. Possible values:

    • True — backup activities are throttled.
    • False — backup activities are not throttled.

     

    DisableControlPanel
    Notification

    Parameter specifies if Veeam Agent for Microsoft Windows notifications displayed on the notification bar must be disabled. Possible values:

    • True — notifications are disabled.
    • False — notifications are enabled.

     

    DisableScheduledBackups

    Parameter describes if the scheduled backup job sessions must be disabled. Possible values:

    • True — scheduled backup job sessions are disabled.
    • False — scheduled backup job sessions are enabled.

     

    DisableWakeupTimers

    Parameter describes if Veeam Agent for Microsoft Windows must automatically wake your computer from sleep when the backup job must start. Possible values:

    • True — Veeam Agent for Microsoft Windows wakes the computer.
    • False — Veeam Agent for Microsoft Windows does not wake the computer.

     

    CheckUpdates

    Parameter describes if Veeam Agent for Microsoft Windows must automatically check for product updates. Possible values:

    • True — Veeam Agent for Microsoft Windows checks for updates.
    • False — Veeam Agent for Microsoft Windows does not check for updates.

     

    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).

     

    Notification Settings

    Parent Tag

    Parameter

    Description

    EmailReport

    Parent tag that encapsulates information about email notification settings in Veeam Agent for Microsoft Windows.

     

    Notification

    Parameter describes if email notifications are enabled in Veeam Agent for Microsoft Windows. Possible values:

    • True — email notifications are enabled.
    • False — email notifications are disabled.

    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 or addresses at which Veeam Agent for Microsoft Windows sends email notifications.

    List of email addresses separated by comma or semicolon.

     

    Subject

    Subject of email notifications. You can use the following variables in the subject:

    • %ComputerName%
    • %JobResult%
    • %JobName%
    • %CompletionTime%

    By default, Veeam Agent for Microsoft Windows sends email notifications with the following subject: [%JobResult%] %ComputerName% - %JobName% - %CompletionTime%

    Conditions

    Parent tag that encapsulates information about conditions in which Veeam Agent for Microsoft Windows sends email notifications.

     

    Failure

    Parameter describes if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Failed status. Possible values:

    • True — email notifications must be sent.
    • False — email notifications must not be sent.

     

    Success

    Parameter describes if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Success status. Possible values:

    • True — email notifications must be sent.
    • False — email notifications must not be sent.

     

    Warning

    Parameter describes if Veeam Agent for Microsoft Windows must send an email notification in case the backup job completes with the Warning status. Possible values:

    • True — email notifications must be sent.
    • False — email notifications must not be sent.

    Smtp

    Parent tag that encapsulates information about the SMTP server that Veeam Agent for Microsoft Windows uses to send email notifications.

     

    Port

    Port number for communication with the SMTP server.

     

    SecureConnection

    Parameter specifies if the SMTP server requires authentication. Possible values:

    • True — SMTP server requires authentication. If you set the SecureConnection parameter to True, you must specify Credentials parameters.
    • False — SMTP server does not require authentication.

     

    Server

    Full DNS name or IP address of the SMTP server.

    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.

     

    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.

     

    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.

    Throttling Settings

    Parent Tag

    Parameter

    Description

    Throttling

    Parent tag that encapsulates information about bandwidth consumption limit set for Veeam Agent backup jobs.

     

    DisableBackup
    OverMeteredConnection

    Parameter specifies if backup over metered connection can be performed. Possible values:

    • True — metered connections cannot be used.
    • False — metered connections can be used.

     

    LimitBandwith

    Parameter specifies if bandwidth consumption is limited for backup jobs. Possible values:

    • True — bandwidth consumption is limited.
    • False —bandwidth consumption is not limited.

     

    RestrictVPNConnections

    Parameter specifies if backup over VPN connection can be performed. Possible values:

    • True — VPN connections cannot be used.
    • False — VPN connections can be used.

     

    RestrictWiFiNetworks

    Parameter specifies if backup over Wi-Fi connection can be performed. Possible values:

    • True — Wi-Fi connections cannot be used.
    • False — Wi-Fi connections can be used.

     

    WiFiNetworksNames

    This parameter is used if you allow backup over the specified Wi-Fi connections only.

    List of names of the allowed Wi-Fi connections separated by comma.

     

    SpeedLimit

    This parameter is used if you limit bandwidth consumption for backup jobs.

    The value up to which the bandwidth consumption is set is specified.

     

    SpeedUnit

    This parameter is used if you limit bandwidth consumption for backup jobs.

    The parameter describes the unit of measurement for the value specified in the SpeedLimit setting. Possible values:

    • 0 — Mbps
    • 1 — KB\s
    • 2 — MB\s

    Example

    This example runs the Import command and loads the following parameters from the C:\Veeam\Configuration.xml input XML file:

    Veeam.Agent.Configurator.exe -import /f:C:\Veeam\Configuration.xml

    The input XML file has the following parameters:

    <ExecutionResult>
    <ApplicationSettings DisableBackupOverMeteredConnection="False" ThrottleBackupActivity="True" DisableControlPanelNotification="True"/>
    </ExecutionResult>

     

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.