Discover Disk Image Volumes

Parameter

Description

deviceId

String. Use this value for creating a Disk Image Backup Set (preferred over using the drive letter, since not all volumes have drive letters).

driveLetter

String. Use this value for creating a Disk Image Backup Set, but this is not preferred. Deviceid is recommended.

label

String. Volume label (can be empty).

capacity

Long. Volume capacity in bytes.

usedSpace

Long. Volume used space in bytes.

isBoot

Boolean, whether the volume is boot or not.

volumeKind

Integer. Contains the following possible integer values (parenthesis lists enum's value):

• 0 (None)

• 1 (PrimaryPartition)

• 2 (LogicalDrive)

• 3 (Simple)

• 4 (Spanned)

• 5 (Striped)

• 6 (Mirror)

• 7 (Raid5)

driveType

Integer, with the following possible values (matches System.IO.DriveType). Only Fixed drives are supported:

• 0 (Unknown)

• 1 (NoRootDirectory)

• 2 (Removable)

• 3 (Fixed)

• 4 (Network)

• 5 (CDRom)

• 6 (Ram)

isSupported

Boolean. Determines whether the volume is supported for backup or not. When false, the reason can be found via the volumeUnsupportedReason property

volumeUnsupportedReason

Integer. When > 0, shows the reason why a volume is unsupported, with the following possible values:

• 0 (None) - volume is supported

• 1 (FileSystemNotSupported) - anything different than NTFS is not supported

• 2 (RemovableMediaNotSupported)

• 3 (VolumeSizeNotSupported)

• 4 (VolumeEncrypted)

• 64 (IncludedInAnotherBackupSet) - volume is already included in another Disk Image Standard backup set (allowed to include the same volume in a backup set of type QuickSpin and in one of type Standard)

• 70 (ContainsLocalVault) - volume contains the local vault location

Parameter

Description

account

String ( mandatory ). The parameter represents the account name.

computer

String ( mandatory ). The parameter represents the subaccount of the current account.