Get BitLocker Configurations

This object allows you to retrieve the BitLocker configurations for all your mountpoints.

Input Parameters

Name Type Required Description
Drive Letter String Yes This field is the mountpoint for the drive that you want to get status for.

The field supports wildcards, so to return all drives, use "*" as the value.

Output Parameters

Name Type Description
Configurations Collection

A list of all drives and their BitLocker configurations. It contains the following information:

Item Type Description
MountPoint String The drive letter.
EncryptionMethod String The method used for Encryption.
AutoUnlockEnabled Boolean If Auto Unlocking of the removable drive is turned on.
AutoUnlockKeyStored Boolean If the Auto Unlock Key for the removable drive is stored locally.
MetadataVersion Int The version of metadata for BitLocker.
VolumeStatus String The current Encryption Status.
ProtectionStatus String If protection is On or Off.
LockStatus String If the drive is locked (applies to removable drives).
EncryptionPercentage Double Percentage of the drive encrypted (shows progress percentage while drive is being encrypted).
VolumeType String The type of volume.
CapacityGB Double The capacity of the drive (GB).
Configurations Count Number The number of drives found and returned in the configurations variable.
Result Number Returns a success value of zero or any value other than zero to indicate failure.
Result String String Object execution error details.

Example Input Parameters

Name Type Required Example
Drive Letter String Yes C:

*