Select Disk Image Standard Volumes

Disk Image Standard selections are made either by volume drive letter, or by device id (some volumes may have no drive letter).

If the boot volume is selected (for example, c:), the API automatically includes the system volume to the backup set. You do not need to include the system volume specifically in the backup set.

Attention: For JSON to be valid, if Windows gives you, as an example, device ID \\?\Volume{40392658-0000-0000-0000-100000000000}\ (you can run mountvol, for example), the JSON needs to be escaped, resulting in, for example, \\\\?\\Volume{40392658-0000-0000-0000-100000000000}\\

Input Parameters

The following table provides the input parameters and descriptions.

Parameter	Description
type	For Disk Image Standard backup set, the value is "Disk_Image"
selection	Array of strings, containing one of the following: drive letter(s) (e.g. C:) device id(s) (e.g. \\\\?\\Volume{40392658-0000-0000-0000-100000000000}\\ ) wildcard (specified between %) - the following wildcards are supported: ¾ %SystemDrive% - auto includes the boot and system volumes ¾ %All% - auto includes all supported volumes, with the exception of the following: non NTFS (e.g. FAT32) removable drives volumes on which the Local Vault resides (when local vault enabled) volumes included in other Disk Image Standard Backup Sets
exclusions	Array of strings. Items to be excluded from selection; should be used to exclude volumes or %SystemDrive% when selection is set to %All% Accepts the same input as selection (drive letters, wildcards and device ids).
useDynamicVolumeInclusion	Boolean, optional parameter. The default value is true, when "selection" is %All% Can only be used in conjunction with "selection", when it contains the %All% wildcard. When "selection" is %All% and "useDynamicVolumeInclusion" is set to true (the default), the backup set is created using all available supported volumes on that system at the time that the backup set was created. Volumes are dynamically added or removed from the backup set when the backup set runs. For example, if a new volume appears in Windows, or a volume is deleted, it is automatically added or deleted from the backup set (the already backed-up data is always kept). When "selection" is %All% and "useDynamicVolumeInclusion" is set to false, the backup set is created using all available supported volumes on that system at the time that the backup set was created. Volumes are not dynamically added or removed from the backup set.

Example 1

{

"type":"Disk_Image",

"selection":[

"%SystemDrive%",

"e:",

"\\\\?\\Volume{40392658-0000-0000-0000-100000000000}\\"

]

}

Example 2

{

"type":"Disk_Image",

"selection": [ "%All%" ],

"exclusions": [ "%SystemDrive%", "E:" ]

}

Example 3

{

"type":"Disk_Image",

"selection": [ "%All%" ],

"exclusions": [ "D:" ],

"useDynamicVolumeInclusion": false

}