> For the complete documentation index, see [llms.txt](https://osd.osdeploy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://osd.osdeploy.com/docs/trash/mybitlocker.md).

# MyBitLocker

MyBitLocker Functions require the BitLocker PowerShell Module and RunAsAdministrator.  WinPE is supported by adding the OSD and the BitLocker PowerShell Modules

```
PS C:\> Get-Command *MyBitLocker*

CommandType     Name                                               Version    Source                                                               
-----------     ----                                               -------    ------                                                               
Function        Backup-MyBitLockerKeys                             21.2.10.1  OSD                                                                  
Function        Get-MyBitLockerKeyProtectors                       21.2.10.1  OSD                                                                  
Function        Save-MyBitLockerExternalKey                        21.2.10.1  OSD                                                                  
Function        Save-MyBitLockerKeyPackage                         21.2.10.1  OSD                                                                  
Function        Save-MyBitLockerRecoveryPassword                   21.2.10.1  OSD                                                                  
Function        Unlock-MyBitLockerExternalKey                      21.2.10.1  OSD  
```

## Get-Help -Full

All the details on how to use the functions are in Get-Help -Full

```
Get-Help -Full Backup-MyBitLockerKeys
Get-Help -Full Get-MyBitLockerKeyProtectors
Get-Help -Full Save-MyBitLockerExternalKey
Get-Help -Full Save-MyBitLockerKeyPackage
Get-Help -Full Save-MyBitLockerRecoveryPassword
Get-Help -Full Unlock-MyBitLockerExternalKey
```

```
PS C:\> Get-Help -Full Backup-MyBitLockerKeys

NAME
    Backup-MyBitLockerKeys
    
SYNOPSIS
    Saves all BitLocker ExternalKeys (BEK), KeyPackages (KPG), and RecoveryPasswords (TXT)
    
    
SYNTAX
    Backup-MyBitLockerKeys [-Path] <String[]> [<CommonParameters>]
    
    
DESCRIPTION
    Saves all BitLocker ExternalKeys (BEK), KeyPackages (KPG), and RecoveryPasswords (TXT) to a Directory (Path)
    

PARAMETERS
    -Path <String[]>
        Directory to save the BitLocker Keys.  This directory will be created if it does not exist
        
        Required?                    true
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters?  false
        
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). 
    
INPUTS
    
OUTPUTS
    
NOTES
    
    
        Requires Administrative Rights
        Requires BitLocker Module | Get-BitLockerVolume
        21.2.10  Initial Release
    
    
RELATED LINKS
    https://osd.osdeploy.com/module/mybitlocker/backup-mybitlockerkeys
```

## Get-Help -Online

The -Online parameter will open these function links in your browser

```
Get-Help -Online Backup-MyBitLockerKeys
Get-Help -Online Get-MyBitLockerKeyProtectors
Get-Help -Online Save-MyBitLockerExternalKey
Get-Help -Online Save-MyBitLockerKeyPackage
Get-Help -Online Save-MyBitLockerRecoveryPassword
Get-Help -Online Unlock-MyBitLockerExternalKey
```

![](/files/-MTCO-_U0l-3G2QItEo6)

## WinPE Installation

```
Copy-PSModuleToWim -ImagePath <Path to WIM> -ExecutionPolicy Bypass -Name OSD, BitLocker
```
