Get-MbamBitLockerRecoveryKey
Requests an MBAM recovery key.
Syntax
Get-MbamBitLockerRecoveryKey
-KeyID <String>
-Reason <String>
[-UserDomain <String>]
[-UserID <String>]
-HelpDeskUrl <Uri>
[<CommonParameters>] Description
The Get-MbamBitLockerRecoveryKey cmdlet requests a Microsoft BitLocker Administration and Monitoring (MBAM) recovery key. This recovery key enables a user to unlock a volume that is in recovery mode. A volume can enter recovery mode due to a forgotten BitLocker PIN or password, a Windows update, or a change to the BIOS settings of the computer.
Examples
Example 1: Get a recovery key by specifying an eight-digit recovery key ID
PS C:\> Get-MbamBitLockerRecoveryKey -KeyID "4374f3b9" -Reason "Forgot PIN" -HelpDeskUrl https://helpdeskserver/HelpDesk -UserDomain "ContosoDomain" -UserID "ContosoUser"This command gets the recovery key from the specified help desk server for the user ContosoUser. The command specifies only the first eight digits of the key ID.
Example 2: Get a recovery key by specifying the complete recovery key ID
PS C:\> Get-MbamBitLockerRecoveryKey -KeyID "4374f3b9-58c7-4a41-87a5-0701d4fdbb86" -Reason "Forgot PIN" -HelpDeskUrl https://helpdeskserver/HelpDesk -UserDomain "ContosoDomain" -UserID "ContosoUser"This command gets the recovery key from the specified help desk server for the user ContosoUser. The command specifies the complete key ID.
Parameters
-HelpDeskUrl
Specifies the URL for the MBAM help desk site.
| Type: | Uri |
| Aliases: | url |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-KeyID
Specifies the recovery key ID. You can specify the first eight digits of the recovery key ID for this parameter or you can specify the complete ID. For example, if the recovery key ID is 4734f3b9-58c7-4a41-87a5-0701d4fdbb86, you can specify 4734f3b9 for this parameter.
| Type: | String |
| Aliases: | key, k |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Reason
Specifies the reason for the recovery key request. Reasons can include a forgotten BitLocker PIN or password, a Windows Update, or a change to BIOS settings of the computer.
| Type: | String |
| Aliases: | r |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserDomain
Specifies the domain of the user.
| Type: | String |
| Aliases: | ud |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserID
Specifies the ID of the user.
| Type: | String |
| Aliases: | uid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
string
The BitLocker recovery key for the specified volume.