Backup Target
This section describes where backup files must be stored.
- General settings
- Computer disk settings
- Shared folder settings
- Backup repository settings
- Cloud repository settings
- Object storage settings
Parent Tag | Parameter | Description |
---|---|---|
TargetInfo | Parent tag that encapsulates information about the backup target. | |
| Type | Type of backup target. Possible values:
|
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\ |
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. |
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:
|
| 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. |
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:
|
| 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. |
The settings are different depending on the type of the object storage. For details, see the following subsectons:
- Amazon S3 Storage Settings
- Microsoft Azure Blob Storage Settings
- Google Cloud Storage Settings
- S3 Compatible 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:
For more information, see this Amazon article. |
| StorageClass | Type of the Amazon S3 storage class. Possible values:
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:
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:
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. |
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:
For more information, see this Google Cloud article. |
| RegionType | Type of the Google Cloud storage bucket location. Possible values:
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:
|
| UrlStyle | URL style used to access the S3 bucket. Possible values:
|
| 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> |
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:
- Username: TECH\Administrator
- Password: Password
The input XML file will contain the following parameters:
<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:
- Username: TECH\Administrator
- Password: Password
The input XML file will contain the following parameters:
<ExecutionResult> |
Example 4
You want to back up data to the Cloud01 backup repository accessed over the following gateway servers:
- 14.137.17.50 (default gateway server)
- 14.137.17.51 (additional gateway server)
- 14.137.17.52 (additional gateway server)
- Username: TECH\Administrator
- Password: Password
The input XML file will contain the following parameters:
<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> |