Backup Target

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
  • 6 — object storage

 

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

Object Storage Settings

The settings are different depending on the type of the object storage. For details, see the following subsectons:

Amazon S3 Storage Settings

Parent Tag

Parameter

Description

TargetInfo

Parent tag that encapsulates information about the backup target.

 

VersioningEnabled

This parameter shows if S3 Versioning is enabled on the Amazon S3 storage side to keep multiple versions of an object in one bucket. Possible values:

  • True — S3 Versioning is enabled.
  • False — S3 Versioning is disabled.

For more information, see this Amazon article.

 

StorageClass

Type of the Amazon S3 storage class. Possible values:

  • 0 — Amazon S3 Standard
  • 1 — Amazon S3 Standard-Infrequent Access
  • 2 — Amazon S3 One Zone-Infrequent Access
  • 3 — Amazon S3 Intelligent-Tiering
  • 4 — Amazon S3 Glacier Flexible Retrieval
  • 5 — Amazon S3 Glacier Deep Archive
  • 6 — Amazon S3 Glacier Instant Retrieval

For more information, see this Amazon article.

 

ClientName

Name of the Veeam product. For Veeam Agent for Microsoft Windows, this parameter has the following value: VAW.

 

FolderName

Name of the folder in the bucket to store backups.

 

BucketName

Name of the bucket in the storage to store backups.

 

Region

Datacenter location.

 

ClientId

Identificator of the object storage client.

 

CloudType

For the Amazon S3 storage, this parameter has the following value: 1.

AccessKeys

Parent tag that encapsulates information about credentials for access to the object storage.

 

UserName

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

 

Password

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

Microsoft Azure Blob Storage Settings

Parent Tag

Parameter

Description

TargetInfo

Parent tag that encapsulates information about the backup target.

 

VersioningEnabled

This parameter shows if Blob versioning is enabled on the Microsoft Azure Blob storage side to maintain previous versions of an object in the storage. Possible values:

  • True — Blob versioning is enabled.
  • False — Blob versioning is disabled.

For more information, see Microsoft documentation.

 

ClientName

Name of the Veeam product. For Veeam Agent for Microsoft Windows, this parameter has the following value: VAW.

 

StorageClass

Type of the blob access tier. Possible values:

  • 0 — Default
  • 1 — Hot
  • 2 — Cool
  • 3 — Archive

For more information, see Microsoft documentation.

 

FolderName

Name of the folder in the container to store backups.

 

ContainerName

Name of the container in the storage to store backups.

 

Region

Data center location.

 

ClientId

Identificator of the object storage client.

 

CloudType

For the Microsoft Azure Blob storage, this parameter has the following value: 2.

AccessKeys

Parent tag that encapsulates information about credentials for access to the object storage.

 

UserName

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

 

Password

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

Google Cloud Storage Settings

Parent Tag

Parameter

Description

TargetInfo

Parent tag that encapsulates information about the backup target.

 

ClientName

Name of the Veeam product. For Veeam Agent for Microsoft Windows, this parameter has the following value: VAW.

 

StorageClass

Type of the Google Cloud storage class. Possible values:

  • 0 — Standard
  • 1 — Nearline
  • 2 — Coldline
  • 3 — Archive

For more information, see this Google Cloud article.

 

RegionType

Type of the Google Cloud storage bucket location. Possible values:

  • 0 — Single
  • 1 — Dual
  • 2 — Multi

For more information, see this Google Cloud article.

 

FolderName

Name of the folder in the bucket to store backups.

 

BucketName

Name of the container in the storage to store backups.

 

Region

Data center location.

 

ClientId

Identificator of the object storage client.

 

CloudType

For the Google Cloud storage, this parameter has the following value: 3.

AccessKeys

Parent tag that encapsulates information about credentials for access to the object storage.

 

UserName

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

 

Password

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

S3 Compatible Storage Settings

Parent Tag

Parameter

Description

TargetInfo

Parent tag that encapsulates information about the backup target.

 

VersioningEnabled

This parameter shows if versioning is enabled on the S3 Compatible storage side to keep multiple versions of an object in one bucket. Possible values:

  • True — Versioning is enabled.
  • False — Versioning is disabled.

 

UrlStyle

URL style used to access the S3 bucket. Possible values:

  • 0 — Virtual-hosted–style
  • 1 — Path-style

 

ServicePoint

Endpoint address of the S3 Compatible device.

 

ClientName

Name of the Veeam product. For Veeam Agent for Microsoft Windows, this parameter has the following value: VAW.

 

FolderName

Name of the folder in the bucket to store backups.

 

BucketName

Name of the bucket in the storage to store backups.

 

Region

Data center location.

 

ClientId

Identificator of the object storage client.

 

CloudType

For the S3 Compatible storage, this parameter has the following value: 4.

AccessKeys

Parent tag that encapsulates information about credentials for access to the object storage.

 

UserName

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

 

Password

Password for access to the object storage. 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>

Example 5

You want to back up data to the Backups folder in the Veeam bucket located on the Belgium data center in the Google Cloud storage. The input XML file will contain the following parameters:

<ExecutionResult>
 <JobInfo ConfigId="8c56c897-0x7a-445c-91f9-x8b12c7bas45" JobName="Backup Job">
   <TargetInfo Type="6" ClientName="VAW" StorageClass="0" RegionType="0" FolderName="veeam_backup" BucketName="eu-west" Region="EUROPE-WEST1" ClientId="46453951-f154-8x6d-3733-5a4a38f55eb2" CloudType="3">
     <AccessKeys Password="SsMyr6seDWPv" UserName="NZLkFKRTY1YKWLSzxTOSLDWRzGSVdOV0qWZXx"/>
   </TargetInfo>
 </JobInfo>
</ExecutionResult>