Help Center
Choose product document...
Veeam Agent for Microsoft Windows 2.0
Configurator Reference

Backup Scope

This section describes what data the backup job must process.

Parent Tag

Parameter

Description

SourceInfo

Parent tag that encapsulates information about the backup scope.

EpDiskFilter

Parent tag that encapsulates information about the backup mode.

 

BackupUserFolders

This parameter is used only for file-level backup.

Parameter describing if user personal files must be backed up. Possible values:

  • False — user personal files are not backed up.
  • True — user personal files are backed up.

 

BackupSystemState

Parameter that enables system state backup. Possible values:

  • False — system state data is not backed up.
  • True — system state data is backed up.

 

BackupMode

Backup mode. Possible values:

  • 0 — entire computer backup.
  • 1 — volume-level backup.
  • 2 — file-level backup.

 

Drive

This tag is used only for volume-level and file-level backup modes.

Parent tag that encapsulates information about volumes or folders added to the backup scope.

 

FilterType

This parameter is used only for volume-level and file-level backup modes.

Backup mode. Possible values:

  • 0 — volume-level backup.
  • 1 — file-level backup.

 

VolumeOrPartitionId MountPoint

This parameter is used only for volume-level and file-level backup modes.

Mount point of the backed up volume or volume on which backed up folders are located. In the value, the volume name is specified, for example: C:\.

 

Path

This parameter is used only for volume-level and file-level backup modes.

GUID path of the backed up volume or volume on which backed up folders are located, for example: \\?\Volume{26a37f5a-c4a6-4ae4-b724-4a36df814334}.

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

 

Type

This parameter is used only for volume-level and file-level backup modes.

Type of backed up volume or volume on which backed up folders are located. Possible values:

  • 0 — UEFI system partition.
  • 1 — System Reserved partition or computer volume.

IncludeFolders

This tag is used only for volume-level and file-level backup modes.

Parent tag that encapsulates paths to backed up volumes and folders.

 

String value

This parameter is used only for volume-level and file-level backup modes.

Backed up disks and folders:

  • For volume-level backup, a volume name is specified, for example: C:\.
  • For file-level backup, a path to the folder is specified, for example: C:\Documents.

ExcludeFolders

This tag is used only for hybrid file-level backup (backup that includes computer volumes and folders with files).

Parent tag that encapsulates paths to folders that are excluded from the backup.

 

String value

This parameter is used only for hybrid file-level backup (backup that includes computer volumes and folders with files).

Parameter describing folders that are excluded from the backup, for example: C:\ProgramData.

IncludeMasks

This tag is used only for file-level backup.

Parent tag that encapsulates masks of files that are included in the backup.

 

String value

This parameter is used only for file-level backup.

Mask of files that are included in the backup, for example: *.docx. To provide several masks, use separate string value parameters.

ExcludeMasks

This tag is used only for the file-level backup.

Parent tag that encapsulates masks of files that are excluded from the backup.

 

String value

This parameter is used only for the file-level backup.

Mask of files that are excluded from the backup, for example: *.avi. To provide several masks, use separate string value parameters.

Example 1

You want the backup job to back up the D:\ drive. The input XML file must contain the following parameters:

<?xml version="1.0"?>
 <JobInfo CryptType="10">
   <SourceInfo>
    <EpDiskFilter BackupUserFolders="False" BackupSystemState="False" BackupMode="1">
      <Drive FilterType="0">
       <VolumeOrPartitionId MountPoint="D:\" Type="1"/>
         <IncludeFolders>
           <String value="D:\"/>
         </IncludeFolders>
         <ExcludeFolders/>
       </Drive>
       <IncludeMasks/>
      <ExcludeMasks/>
    </EpDiskFilter>
   </SourceInfo>
    ...
 </JobInfo>

Example 2

You want to back up the C:\Documents folder, user personal files and exclude all TXT files from it. The input XML file will contain the following parameters:

<?xml version="1.0"?>
 <JobInfo CryptType="10">
   <SourceInfo>
    <EpDiskFilter BackupUserFolders="True" BackupSystemState="False" BackupMode="2">
      <Drive FilterType="1">
        <VolumeOrPartitionId MountPoint="C:\" Type="1"/>
          <IncludeFolders>
            <String value="C:\Documents"/>
            <String value="C:\Users"/>
          </IncludeFolders>
          <ExcludeFolders/>
      </Drive>
      <VolumeOrPartitionId MountPoint="" Type="1" Path="\\?\Volume{422b9636-8907-11e3-93e7-806e6f6e6963}"/>
        <IncludeMasks/>
        <ExcludeMasks>
          <String value="*.TXT"/>
        </ExcludeMasks>
     </EpDiskFilter>
   </SourceInfo>
    ...
 </JobInfo>

 

Veeam Large Logo

User Guide

Configurator Reference

Veeam Backup & Replication Documentation

Veeam ONE Documentation

Veeam Management Pack Documentation

Veeam Agent for Linux Documentation