Backup Target

In this article

    This section describes where backup files must be stored.

    General Settings

    Parent Tag

    Parameter

    Description

    TargetInfo

    Parent tag that encapsulates information about the backup target.

     

    Type

    Type of backup target. Possible values:

    • 1 — folder on a computer disk.
    • 2 — shared folder.
    • 3 — Veeam backup repository.
    • 4 — Veeam cloud backup repository.
    • 5 — Microsoft OneDrive.

     

    Backup Target NOTE

    Due to the limitations of the Microsoft OneDrive platform you cannot set Microsoft OneDrive as a backup job target with Veeam Agent Configurator. The Microsoft OneDrive target is available only in the output XML file. You cannot use it in the input XML file.

    Computer Disk Settings

    Parent Tag

    Parameter

    Description

    TargetInfo

    Parent tag that encapsulates information about the backup target.

     

    DriveName

    Name of a volume where backup files must be stored, for example: C:\.

     

    VolumeID

    GUID path of a volume where backup files must be stored, for example: {26a37f5a-c4a6-4ae4-b724-4a36df814334}.

    Note: The VolumeID parameter is not available in the output XML file. However, you can use it in the input XML file.

     

    RelativePath

    Path to a folder where backup files must be stored, for example: Backup\

    Shared Folder Settings

    Parent Tag

    Parameter

    Description

    TargetInfo

    Parent tag that encapsulates information about the backup target.

     

    Path

    Path to a shared folder where backups must be stored, for example: \\172.17.25.73\Backups.

    CredentialsInfo

    This tag is used only if you plan to store backup files in a shared folder that requires user authentication.

    Parent tag that encapsulates information about credentials for access to the shared folder.

     

    UserName

    This parameter is used only if you plan to store backup files in a shared folder that requires user authentication.

    User name for access to the shared folder. The user name is specified as a text string encoded in the Base64 format.

     

    Password

    This parameter is used only if you plan to store backup files in a shared folder that requires user authentication.

    Password for access to the shared folder. The password is encrypted. For more information, see Encryption of User Credentials.

    Backup Repository Settings

    Parent Tag

    Parameter

    Description

    TargetInfo

    Parent tag that encapsulates information about the backup target.

     

    ServerName

    Name of the backup server that manages the target Veeam backup repository.

     

    ServerPort

    Port used for communication between the machine on which Veeam Agent for Microsoft Windows is installed and Veeam backup server. By default, port 10001 is used.

     

    RemoteRepositoryID

    GUID path of the cloud backup repository where backup files are stored, for example: {88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec}.

    Note: The RemoteRepositoryID parameter is not available in the output XML file. However, you can use it in the input XML file.

     

    RemoteRepositoryName

    Name of the backup repository, for example: Backup Volume 01.

     

    AgentDeletedRetentionEnable

    This parameter is used only if you plan to store backup files on a Veeam backup repository or Veeam Cloud Connect repository.

    This parameter specifies retention policy for outdated backups. Possible values:

    • True — Veeam Agent for Microsoft Windows retains outdated backups for the specified period of time.
    • False — Veeam Agent for Microsoft Windows does not retain outdated backups.

     

    AgentDeletedRetailDays

    This parameter is used only if you set the AgentDeletedRetentionEnable parameter value to True.

    Number of days Veeam Agent for Microsoft Windows retains outdated backups. By default, Veeam Agent for Microsoft Windows retains outdated backups for 30 days.

    ServerCredentials

    This tag is used only if you plan to store backup files on a Veeam backup repository that requires user authentication.

    Parent tag that encapsulates information about credentials for access to the Veeam backup repository.

     

    UserName

    This parameter is used only if you plan to store backup files on a Veeam backup repository that requires user authentication.

    User name for access to the Veeam backup repository. The user name is specified as a text string encoded in the Base64 format.

     

    Password

    This parameter is used only if you plan to store backup files on a Veeam backup server that requires user authentication.

    Password for access to the Veeam backup repository. The password is encrypted. For more information, see Encryption of User Credentials.

    Cloud Repository Settings

    Parent Tag

    Parameter

    Description

    TargetInfo

    Parent tag that encapsulates information about the backup target.

     

    ServerName

    Full DNS name or IP address of the default cloud gateway over which backup data is transported to the cloud backup repository.

    Beside the default gateway, you can specify a list of additional cloud gateways in the GateList parameter. Veeam Agent for Microsoft Windows uses additional cloud gateways if the default cloud gateway is inaccessible.

     

    ServerPort

    TCP/IP port over which user backup servers must communicate with the cloud gateway. By default, port 6180 is used.

     

    GateList

    List of additional cloud gateway servers and ports over which backup data is transported to the cloud backup repository. Veeam Agent for Microsoft Windows uses additional cloud gateways if the default cloud gateway is inaccessible.

    Information about additional cloud gateways is specified following format: Gateway:Port. Additional cloud gateways are listed in the priority order, entries in the list are separated with a semicolon followed by a space, for example: GateList=" 14.137.17.51:6180; 14.137.17.52:6180".

     

    RemoteRepositoryName

    Name of a cloud backup repository on which backups are stored.

     

    RemoteRepositoryID

    GUID path of the cloud backup repository where backup files must be stored, for example: {fcaaef5e-6f9d-4311-96f0-8005518df1b8}.

    Note: The RemoteRepositoryID parameter is not available in the output XML file. However, you can use it in the input XML file.

     

    TrustedThumbprint

    Thumbprint of the TLS certificate used to secure communication in the Veeam Cloud Connect infrastructure.

    The TrustedThumbprint parameter is optional, and is used for TLS certificate verification.

     

    AgentDeletedRetentionEnable

    This parameter is used only if you plan to store backup files on a Veeam backup repository or Veeam Cloud Connect repository.

    This parameter specifies retention policy for outdated backups. Possible values:

    • True — Veeam Agent for Microsoft Windows retains outdated backups for the specified period of time.
    • False — Veeam Agent for Microsoft Windows does not retain outdated backups.

     

    AgentDeletedRetailDays

    This parameter is used only if you set the AgentDeletedRetentionEnable parameter value to True.

    Number of days Veeam Agent for Microsoft Windows retains outdated backups. By default, Veeam Agent for Microsoft Windows retains outdated backups for 30 days.

    ServerCredentials

    Parent tag that encapsulates information about credentials for access to the cloud backup repository.

     

    UserName

    User name for access to the cloud backup repository. The user name is specified as a text string encoded in the Base64 format.

     

    Password

    Password for access to the cloud backup repository. The password is encrypted. For more information, see Encryption of User Credentials.

    Example 1

    You want to back up data to the Backups folder on the D:\ drive on the computer. The input XML file will contain the following parameters:

    <ExecutionResult>
    <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
    <TargetInfo Type="1" RelativePath="Backups\" DriveName="D:\"/>
    </JobInfo>
    </ExecutionResult>

    Example 2

    You want to back up data to the \\fileserver01\Backups shared folder. The shared folder requires authentication, and you use the following user account to access it:

    The input XML file will contain the following parameters:

    <ExecutionResult>
    <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
       <TargetInfo Type="2" Path="\\fileserver01\Backups">
         <CredentialsInfo UserName="VEVDSFxBZG1pbmlzdHJhdG9y" Password="UGFzc3dvcmQ="/>
       </TargetInfo>
     </JobInfo>
    </ExecutionResult>

    Example 3

    You want to back up data to the BackupVolume01 backup repository configured on the backup01.tech.local backup server. You use the following credentials to access the backup server:

    The input XML file will contain the following parameters:

    <ExecutionResult>
       <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job" CryptType="10">
         <TargetInfo Type="3" RemoteRepositoryName="BackupVolume01" ServerPort="10001" ServerName="backup01.tech.local">
           <ServerCredentials Password="UGFzc3dvcmQ=" UserName="VEVDSFxBZG1pbmlzdHJhdG9y"/>
         </TargetInfo>
       </JobInfo>
    </ExecutionResult>

    Example 4

    You want to back up data to the Cloud01 backup repository accessed over the following gateway servers:

    The input XML file will contain the following parameters:

    <ExecutionResult>
    <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job" CryptType="10">
       <TargetInfo type="4" GateList="14.137.17.51:6180; 14.137.17.52:6180" RemoteRepositoryName="Cloud01" ServerPort="6180" ServerName="14.137.17.50"/>
        <ServerCredentials Password="UGFzc3dvcmQ=" UserName="VEVDSFxBZG1pbmlzdHJhdG9y"/>
    </JobInfo>
    </ExecutionResult>