Documentation
-
ProtectKeyWithExternalKey method of the Win32_EncryptableVolume class - Win32 apps
Secures the volume's encryption key with a 256-bit external key.
This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
To enable the client computers to report BitLocker compliance details through the Microsoft BitLocker Administration and Monitoring (MBAM) Configuration Manager reports, you have to edit the Configuration.mof file, whether you're using System Center 2012 Configuration Manager or Configuration Manager 2007. Complete the following instructions for the version of Configuration Manager that you're using.
On the Configuration Manager Server, browse to the location of the Configuration.mof file:
<CMInstallLocation>\Inboxes\clifiles.src\hinv\
On a default installation, the installation location is %systemdrive%\Program Files \Microsoft Configuration Manager.
Edit the Configuration.mof file to append the following MBAM classes:
//===================================================
// Microsoft BitLocker Administration and Monitoring
//===================================================
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("Win32_BitLockerEncryptionDetails", NOFAIL)
[Union, ViewSources{"select DeviceId, BitlockerPersistentVolumeId, BitLockerManagementPersistentVolumeId, BitLockerManagementVolumeType, DriveLetter, Compliant, ReasonsForNonCompliance, KeyProtectorTypes, EncryptionMethod, ConversionStatus, ProtectionStatus, IsAutoUnlockEnabled, NoncomplianceDetectedDate, EnforcePolicyDate from Mbam_Volume"}, ViewSpaces{"\\\\.\\root\\microsoft\\mbam"}, dynamic, Provider("MS_VIEW_INSTANCE_PROVIDER")]
class Win32_BitLockerEncryptionDetails
{
[PropertySources{"DeviceId"},key]
String DeviceId;
[PropertySources{"BitlockerPersistentVolumeId"}]
String BitlockerPersistentVolumeId;
[PropertySources{"BitLockerManagementPersistentVolumeId"}]
String MbamPersistentVolumeId;
//UNKNOWN = 0, OS_Volume = 1, FIXED_VOLUME = 2, REMOVABLE_VOLUME = 3
[PropertySources{"BitLockerManagementVolumeType"}]
SInt32 MbamVolumeType;
[PropertySources{"DriveLetter"}]
String DriveLetter;
//VOLUME_NOT_COMPLIANT = 0, VOLUME_COMPLIANT = 1, NOT_APPLICABLE = 2
[PropertySources{"Compliant"}]
SInt32 Compliant;
[PropertySources{"ReasonsForNonCompliance"}]
SInt32 ReasonsForNonCompliance[];
[PropertySources{"KeyProtectorTypes"}]
SInt32 KeyProtectorTypes[];
[PropertySources{"EncryptionMethod"}]
SInt32 EncryptionMethod;
[PropertySources{"ConversionStatus"}]
SInt32 ConversionStatus;
[PropertySources{"ProtectionStatus"}]
SInt32 ProtectionStatus;
[PropertySources{"IsAutoUnlockEnabled"}]
Boolean IsAutoUnlockEnabled;
[PropertySources{"NoncomplianceDetectedDate"}]
String NoncomplianceDetectedDate;
[PropertySources{"EnforcePolicyDate"}]
String EnforcePolicyDate;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("Win32Reg_MBAMPolicy", NOFAIL)
[DYNPROPS]
Class Win32Reg_MBAMPolicy
{
[key]
string KeyName;
//General encryption requirements
UInt32 OsDriveEncryption;
UInt32 FixedDataDriveEncryption;
UInt32 EncryptionMethod;
//Required protectors properties
UInt32 OsDriveProtector;
UInt32 FixedDataDriveAutoUnlock;
UInt32 FixedDataDrivePassphrase;
//MBAM Agent fields
Uint32 MBAMPolicyEnforced;
string LastConsoleUser;
datetime UserExemptionDate;
UInt32 MBAMMachineError;
// Encoded Computer Name
string EncodedComputerName;
};
[DYNPROPS]
Instance of Win32Reg_MBAMPolicy
{
KeyName="BitLocker policy";
//General encryption requirements
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptOsDrive"),Dynamic,Provider("RegPropProv")]
OsDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|EncryptionMethod"),Dynamic,Provider("RegPropProv")]
EncryptionMethod;
//Required protectors properties
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|OSVolumeProtectorPolicy"),Dynamic,Provider("RegPropProv")]
OsDriveProtector;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|AutoUnlockFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveAutoUnlock;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|FDVPassphrase"),Dynamic,Provider("RegPropProv")]
FixedDataDrivePassphrase;
//MBAM agent fields
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMPolicyEnforced"),Dynamic,Provider("RegPropProv")]
MBAMPolicyEnforced;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|LastConsoleUser"),Dynamic,Provider("RegPropProv")]
LastConsoleUser;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|UserExemptionDate"),Dynamic,Provider("RegPropProv")]
UserExemptionDate; //Registry value should be string in the format of yyyymmddHHMMSS.mmmmmmsUUU
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMMachineError"),Dynamic,Provider("RegPropProv")]
MBAMMachineError;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|EncodedComputerName"),Dynamic,Provider("RegPropProv")]
EncodedComputerName;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("CCM_OperatingSystemExtended", NOFAIL)
[Union, ViewSources{"select Name,OperatingSystemSKU from Win32_OperatingSystem"}, ViewSpaces{"\\\\.\\root\\cimv2"},
dynamic,Provider("MS_VIEW_INSTANCE_PROVIDER")]
class CCM_OperatingSystemExtended
{
[PropertySources{"Name"},key]
string Name;
[PropertySources{"OperatingSystemSKU"}]
uint32 SKU;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("CCM_ComputerSystemExtended", NOFAIL)
[Union, ViewSources{"select Name,PCSystemType from Win32_ComputerSystem"}, ViewSpaces{"\\\\.\\root\\cimv2"},
dynamic,Provider("MS_VIEW_INSTANCE_PROVIDER")]
class CCM_ComputerSystemExtended
{
[PropertySources{"Name"},key]
string Name;
[PropertySources{"PCSystemType"}]
uint16 PCSystemType;
};
//=======================================================
// Microsoft BitLocker Administration and Monitoring end
//=======================================================
On the Configuration Manager Server, browse to the location of the Configuration.mof file:
<CMInstallLocation>\Inboxes\clifiles.src\hinv\
On a default installation, the installation location is %systemdrive%\Program Files (x86)\Microsoft Configuration Manager.
Edit the Configuration.mof file to append the following MBAM classes:
//===================================================
// Microsoft BitLocker Administration and Monitoring
//===================================================
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("Win32_BitLockerEncryptionDetails", NOFAIL)
[Union, ViewSources{"select DeviceId, BitlockerPersistentVolumeId, BitLockerManagementPersistentVolumeId, BitLockerManagementVolumeType, DriveLetter, Compliant, ReasonsForNonCompliance, KeyProtectorTypes, EncryptionMethod, ConversionStatus, ProtectionStatus, IsAutoUnlockEnabled, NoncomplianceDetectedDate, EnforcePolicyDate from Mbam_Volume"}, ViewSpaces{"\\\\.\\root\\microsoft\\mbam"}, dynamic, Provider("MS_VIEW_INSTANCE_PROVIDER")]
class Win32_BitLockerEncryptionDetails
{
[PropertySources{"DeviceId"},key]
String DeviceId;
[PropertySources{"BitlockerPersistentVolumeId"}]
String BitlockerPersistentVolumeId;
[PropertySources{"BitLockerManagementPersistentVolumeId"}]
String MbamPersistentVolumeId;
//UNKNOWN = 0, OS_Volume = 1, FIXED_VOLUME = 2, REMOVABLE_VOLUME = 3
[PropertySources{"BitLockerManagementVolumeType"}]
SInt32 MbamVolumeType;
[PropertySources{"DriveLetter"}]
String DriveLetter;
//VOLUME_NOT_COMPLIANT = 0, VOLUME_COMPLIANT = 1, NOT_APPLICABLE = 2
[PropertySources{"Compliant"}]
SInt32 Compliant;
[PropertySources{"ReasonsForNonCompliance"}]
SInt32 ReasonsForNonCompliance[];
[PropertySources{"KeyProtectorTypes"}]
SInt32 KeyProtectorTypes[];
[PropertySources{"EncryptionMethod"}]
SInt32 EncryptionMethod;
[PropertySources{"ConversionStatus"}]
SInt32 ConversionStatus;
[PropertySources{"ProtectionStatus"}]
SInt32 ProtectionStatus;
[PropertySources{"IsAutoUnlockEnabled"}]
Boolean IsAutoUnlockEnabled;
[PropertySources{"NoncomplianceDetectedDate"}]
String NoncomplianceDetectedDate;
[PropertySources{"EnforcePolicyDate"}]
String EnforcePolicyDate;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("Win32Reg_MBAMPolicy", NOFAIL)
[DYNPROPS]
Class Win32Reg_MBAMPolicy
{
[key]
string KeyName;
//General encryption requirements
UInt32 OsDriveEncryption;
UInt32 FixedDataDriveEncryption;
UInt32 EncryptionMethod;
//Required protectors properties
UInt32 OsDriveProtector;
UInt32 FixedDataDriveAutoUnlock;
UInt32 FixedDataDrivePassphrase;
//MBAM Agent fields
Uint32 MBAMPolicyEnforced;
string LastConsoleUser;
datetime UserExemptionDate;
UInt32 MBAMMachineError;
// Encoded Computer Name
string EncodedComputerName;
};
[DYNPROPS]
Instance of Win32Reg_MBAMPolicy
{
KeyName="BitLocker policy";
//General encryption requirements
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptOsDrive"),Dynamic,Provider("RegPropProv")]
OsDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|EncryptionMethod"),Dynamic,Provider("RegPropProv")]
EncryptionMethod;
//Required protectors properties
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|OSVolumeProtectorPolicy"),Dynamic,Provider("RegPropProv")]
OsDriveProtector;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|AutoUnlockFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveAutoUnlock;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|FDVPassphrase"),Dynamic,Provider("RegPropProv")]
FixedDataDrivePassphrase;
//MBAM agent fields
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMPolicyEnforced"),Dynamic,Provider("RegPropProv")]
MBAMPolicyEnforced;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|LastConsoleUser"),Dynamic,Provider("RegPropProv")]
LastConsoleUser;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|UserExemptionDate"),Dynamic,Provider("RegPropProv")]
UserExemptionDate; //Registry value should be string in the format of yyyymmddHHMMSS.mmmmmmsUUU
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMMachineError"),Dynamic,Provider("RegPropProv")]
MBAMMachineError;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|EncodedComputerName"),Dynamic,Provider("RegPropProv")]
EncodedComputerName;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("Win32Reg_MBAMPolicy_64", NOFAIL)
[DYNPROPS]
Class Win32Reg_MBAMPolicy_64
{
[key]
string KeyName;
//General encryption requirements
UInt32 OsDriveEncryption;
UInt32 FixedDataDriveEncryption;
UInt32 EncryptionMethod;
//Required protectors properties
UInt32 OsDriveProtector;
UInt32 FixedDataDriveAutoUnlock;
UInt32 FixedDataDrivePassphrase;
//MBAM Agent fields
Uint32 MBAMPolicyEnforced;
string LastConsoleUser;
datetime UserExemptionDate; //Registry value should be string in the format of yyyymmddHHMMSS.mmmmmmsUUU
UInt32 MBAMMachineError;
// Encoded Computer Name
string EncodedComputerName;
};
[DYNPROPS]
Instance of Win32Reg_MBAMPolicy_64
{
KeyName="BitLocker policy";
//General encryption requirements
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptOsDrive"),Dynamic,Provider("RegPropProv")]
OsDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|ShouldEncryptFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveEncryption;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|EncryptionMethod"),Dynamic,Provider("RegPropProv")]
EncryptionMethod;
//Required protectors properties
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|OSVolumeProtectorPolicy"),Dynamic,Provider("RegPropProv")]
OsDriveProtector;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE\\MDOPBitLockerManagement|AutoUnlockFixedDataDrive"),Dynamic,Provider("RegPropProv")]
FixedDataDriveAutoUnlock;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Policies\\Microsoft\\FVE|FDVPassphrase"),Dynamic,Provider("RegPropProv")]
FixedDataDrivePassphrase;
//MBAM agent fields
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMPolicyEnforced"),Dynamic,Provider("RegPropProv")]
MBAMPolicyEnforced;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|LastConsoleUser"),Dynamic,Provider("RegPropProv")]
LastConsoleUser;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|UserExemptionDate"),Dynamic,Provider("RegPropProv")]
UserExemptionDate; //Registry value should be string in the format of yyyymmddHHMMSS.mmmmmmsUUU
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|MBAMMachineError"),Dynamic,Provider("RegPropProv")]
MBAMMachineError;
[PropertyContext("Local|HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MBAM|EncodedComputerName"),Dynamic,Provider("RegPropProv")]
EncodedComputerName;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("CCM_OperatingSystemExtended", NOFAIL)
[Union, ViewSources{"select Name,OperatingSystemSKU from Win32_OperatingSystem"}, ViewSpaces{"\\\\.\\root\\cimv2"},
dynamic,Provider("MS_VIEW_INSTANCE_PROVIDER")]
class CCM_OperatingSystemExtended
{
[PropertySources{"Name"},key]
string Name;
[PropertySources{"OperatingSystemSKU"}]
uint32 SKU;
};
#pragma namespace ("\\\\.\\root\\cimv2")
#pragma deleteclass("CCM_ComputerSystemExtended", NOFAIL)
[Union, ViewSources{"select Name,PCSystemType from Win32_ComputerSystem"}, ViewSpaces{"\\\\.\\root\\cimv2"},
dynamic,Provider("MS_VIEW_INSTANCE_PROVIDER")]
class CCM_ComputerSystemExtended
{
[PropertySources{"Name"},key]
string Name;
[PropertySources{"PCSystemType"}]
uint16 PCSystemType;
};
//=======================================================
// Microsoft BitLocker Administration and Monitoring end
//=======================================================
MBAM 2.5 server prerequisites that apply only to the Configuration Manager integration topology
Create or edit the sms_def.mof file
MBAM 2.5 server prerequisites for stand-alone and Configuration Manager integration topologies
Documentation
ProtectKeyWithExternalKey method of the Win32_EncryptableVolume class - Win32 apps
Secures the volume's encryption key with a 256-bit external key.
Training
Module
Enroll devices using Microsoft Configuration Manager - Training
This module introduces students to client deployment options and some of the high-level management and monitoring options that are available using Configuration Manager
Certification
Microsoft Certified: Information Protection and Compliance Administrator Associate - Certifications
Demonstrate the fundamentals of data security, lifecycle management, information security, and compliance to protect a Microsoft 365 deployment.