Backup Scope

In this article

    This section describes what data the backup job must process.

    General Settings

    Parent Tag

    Parameter

    Description

    SourceInfo

    Parent tag that encapsulates information about the backup scope.

    EpDiskFilter

    Parent tag that encapsulates information about the backup mode.

     

    ExcludeOneDriveFolders

    This parameter is used only if you work with Veeam Agent for Microsoft Windows operating in the Managed mode.

    Parameter that describes if Microsoft OneDrive folders and their content must be excluded from the backup.

    • False — Microsoft OneDrive folders and their content are included.
    • True — Microsoft OneDrive folders and their content are excluded.

     

    ExcludeSystemState

    This parameter is used only if you work with Veeam Agent for Microsoft Windows operating in the Managed mode.

    Parameter that describes if data related to the OS installed on a protected computer must be excluded from the backup.

    • False — the OS volume is included.
    • True — the OS volume is excluded.

     

    BackupAllUsbDrives

    This parameter is used only if you backup entire computer image.

    Parameter that describes if external USB drives must be included into the computer image. Possible values:

    • False — external USB drives are not included into the computer image.
    • True — external USB drives are included into the computer image.

     

    BackupUserFolders

    This parameter is used only for file-level backup.

    Parameter that describes 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 operating system data backup. Possible values:

    • False — operating system data is not backed up.
    • True — operating system 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.

     

    IsExternaldrive

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

    Type of the backed up drive. Possible values:

    • False — backed up drive is internal.
    • True — backed up drive is external.

    VolumeOrPartitionID

     

    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:\.

     

    MountPoint

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

    Personal Data Settings

    Parent Tag

    Parameter

    Description

    UserProfilesBackupOptions

    Parent tag that encapsulates information about the backup mode.

     

    ExcludeCorruptedProfiles

    This parameter is used only for file-level backup.

    Parameter that describes if corrupted profiles must be excluded from the backup.

    Possible values:

    • False — corrupted profiles are included.
    • True — corrupted profiles are excluded.

     

    ExcludeTemporaryProfiles

    This parameter is used only for file-level backup.

    Parameter that describes if temporary profiles must be excluded from the backup.

    Possible values:

    • False — temporary profiles are included.
    • True — temporary profiles are excluded.

     

    ExcludeRoamingProfiles

    This parameter is used only for file-level backup.

    Parameter that describes if roaming profiles must be excluded from the backup.

    Possible values:

    • False — roaming profiles are included.
    • True — roaming profiles are excluded.

     

    SelectedSpecialFolders

    This parameter is used only for file-level backup.

    Parameter that describes if folders and files, that are located in the Users folder but are not managed by the SelectedFolderTypes parameter, must be included in the backup.

    • 0 — folders and files are excluded.
    • 1 — folders and files are included.

     

    SelectedFolderTypes

    This parameter is used only for file-level backup.

    Parameter that describes what subfolders of the Users folder must be included in the backup.

    Possible values:

    • 1 — the Desktop subfolder is included.
    • 2 — the Documents subfolder is included.
    • 4 — the Pictures subfolder is included.
    • 8 — the Video subfolder is included.
    • 16 — the Music subfolder is included.
    • 32 — the Favorites subfolder is included.
    • 64 — the Downloads subfolder is included.
    • 128 — the Application Data subfolder is included.

    If you want to include several subfolders of the Users folder, specify the sum of the values. For example, to include the Desktop and Documents subfolders, you must set the SelectedFolderTypes parameter to 3.

    Example 1

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

    <ExecutionResult>
    <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
      <SourceInfo>
       <EpDiskFilter BackupSystemState="False" BackupUserFolders="False" BackupMode="1">
         <Drive FilterType="0" IsExternaldrive="False">
          <VolumeOrPartitionId MountPoint="E:\" Type="1"/>
            <IncludeFolders>
              <String value="E:\"/>
            </IncludeFolders>
            <ExcludeFolders/>
          </Drive>
          <IncludeMasks/>
         <ExcludeMasks/>
       </EpDiskFilter>
      </SourceInfo>
    </JobInfo>
    </ExecutionResult>

    Example 2

    You want to back up the Documents folder of the Users folder and exclude all TXT files from it. The input XML file will contain the following parameters:

    <ExecutionResult>
    <JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
     <SourceInfo>
       <EpDiskFilter BackupSystemState="False" BackupUserFolders="True" BackupMode="2">
         <IncludeMasks/>
         <ExcludeMasks>
           <String value="*.TXT"/>
         <ExcludeMasks/>
              <UserProfilesBackupOptions ExcludeCorruptedProfiles="True" ExcludeTemporaryProfiles="True" ExcludeRoamingProfiles="True" SelectedSpecialFolders="0" SelectedFolderTypes="2"/>
       </EpDiskFilter>
      </SourceInfo>
    </JobInfo>
    </ExecutionResult>