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. | |
| 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:
|
| BackupUserFolders | This parameter is used only for file-level backup. Parameter that describes if user personal files must be backed up. Possible values:
|
| BackupSystemState | Parameter that enables operating system data backup. Possible values:
|
| BackupMode | Backup mode. Possible values:
|
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:
|
| IsExternaldrive | This parameter is used only for volume-level and file-level backup modes. Type of the backed up drive. Possible values:
|
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:
|
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:
|
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. |
Example 1
You want the backup job to back up the E:\ drive. The input XML file must contain the following parameters:
<ExecutionResult> |
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:
<ExecutionResult> |