{"id":28389781,"url":"https://github.com/dsccommunity/xBitlocker","last_synced_at":"2025-06-27T21:32:24.105Z","repository":{"id":30468236,"uuid":"34022221","full_name":"dsccommunity/xBitlocker","owner":"dsccommunity","description":"This DSC module allows you to configure Bitlocker on a single disk, configure a TPM chip, or automatically enable Bitlocker on multiple disks.","archived":false,"fork":false,"pushed_at":"2020-09-11T15:11:00.000Z","size":229,"stargazers_count":20,"open_issues_count":7,"forks_count":17,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-31T11:36:12.264Z","etag":null,"topics":["bitlocker","dsc","dsc-resources","powershell","tpm-chip"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsccommunity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-15T22:42:57.000Z","updated_at":"2024-09-01T23:06:31.000Z","dependencies_parsed_at":"2022-08-22T23:40:32.157Z","dependency_job_id":null,"html_url":"https://github.com/dsccommunity/xBitlocker","commit_stats":null,"previous_names":["powershell/xbitlocker"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/dsccommunity/xBitlocker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxBitlocker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxBitlocker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxBitlocker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxBitlocker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsccommunity","download_url":"https://codeload.github.com/dsccommunity/xBitlocker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxBitlocker/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262335302,"owners_count":23295620,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitlocker","dsc","dsc-resources","powershell","tpm-chip"],"created_at":"2025-05-31T02:08:51.000Z","updated_at":"2025-06-27T21:32:24.083Z","avatar_url":"https://github.com/dsccommunity.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xBitlocker\r\n\r\n[![Build Status](https://dev.azure.com/dsccommunity/xBitlocker/_apis/build/status/dsccommunity.xBitlocker?branchName=master)](https://dev.azure.com/dsccommunity/xBitlocker/_build/latest?definitionId=46\u0026branchName=master)\r\n![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/xBitlocker/46/master)\r\n[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/xBitlocker/46/master)](https://dsccommunity.visualstudio.com/xBitlocker/_test/analytics?definitionId=46\u0026contextType=build)\r\n[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/xBitlocker?label=xBitlocker%20Preview)](https://www.powershellgallery.com/packages/xBitlocker/)\r\n[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/xBitlocker?label=xBitlocker)](https://www.powershellgallery.com/packages/xBitlocker/)\r\n\r\nThis DSC module allows you to configure Bitlocker on a single disk, configure a\r\nTPM chip, or automatically enable Bitlocker on multiple disks.\r\n\r\n## Code of Conduct\r\n\r\nThis project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).\r\n\r\n## Releases\r\n\r\nFor each merge to the branch `master` a preview release will be\r\ndeployed to [PowerShell Gallery](https://www.powershellgallery.com/).\r\nPeriodically a release version tag will be pushed which will deploy a\r\nfull release to [PowerShell Gallery](https://www.powershellgallery.com/).\r\n\r\n## Contributing\r\n\r\nPlease check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).\r\n\r\n## Requirements\r\n\r\nThis module requires that both the **Bitlocker** and\r\n**RSAT-Feature-Tools-Bitlocker** features are installed.\r\nIt also requires the latest version of PowerShell (v4.0, which ships in Windows\r\n8.1 or Windows Server 2012R2).\r\nFor more information on using PowerShell 4.0 on older operating systems,\r\n[Install WMF 4.0](https://social.technet.microsoft.com/wiki/contents/articles/21016.how-to-install-windows-powershell-4-0.aspx).\r\n\r\n## Description\r\n\r\nThe **xBitlocker** module contains the **xBLAutoBitlocker, xBLBitlocker,\r\nxBLTpm** DSC Resources.\r\nThis DSC Module allows you to configure Bitlocker on a single disk, configure a\r\nTPM chip, or automatically enable Bitlocker on multiple disks.\r\n\r\n## Resources\r\n\r\n**xBLAutoBitlocker** is used to automatically enable Bitlocker on drives of\r\ntype Fixed or Removable.\r\nIt does not work on Operating System drives.\r\n**xBLAutoBitlocker** has the following properties.\r\nWhere no description is listed, properties correspond directly to\r\n[Enable-Bitlocker](https://docs.microsoft.com/en-us/powershell/module/bitlocker/enable-bitlocker)\r\nparameters.\r\n\r\n* DriveType: The type of volume to auto apply Bitlocker to. Valid values are\r\n  \"Fixed\" or \"Removable\"\r\n* PrimaryProtector: The primary protector type to be used for AutoBitlocker.\r\n  Valid values are: \"AdAccountOrGroupProtector\", \"PasswordProtector\", \"Pin\",\r\n  \"RecoveryKeyProtector\", \"RecoveryPasswordProtector\", \"StartupKeyProtector\",\r\n  or \"TpmProtector\"\r\n* MinDiskCapacityGB: If specified, only disks this size or greater will auto\r\n  apply Bitlocker\r\n* AutoUnlock: Whether volumes should be enabled for auto unlock using\r\n  Enable-BitlockerAutoUnlock\r\n* AdAccountOrGroup\r\n* AdAccountOrGroupProtector\r\n* EncryptionMethod\r\n* HardwareEncryption\r\n* Password\r\n* PasswordProtector\r\n* Pin\r\n* RecoveryKeyPath\r\n* RecoveryKeyProtector\r\n* RecoveryPasswordProtector\r\n* Service\r\n* SkipHardwareTest\r\n* StartupKeyPath\r\n* StartupKeyProtector\r\n* TpmProtector\r\n* UsedSpaceOnly\r\n\r\n**xBLBitlocker** has the following properties.\r\nWhere no description is listed, properties correspond directly to\r\n[Enable-Bitlocker](https://docs.microsoft.com/en-us/powershell/module/bitlocker/enable-bitlocker)\r\nparameters.\r\n\r\n* MountPoint: The MountPoint name as reported in Get-BitLockerVolume\r\n* PrimaryProtector: The primary protector type to be used for AutoBitlocker.\r\n  Valid values are: \"AdAccountOrGroupProtector\", \"PasswordProtector\", \"Pin\",\r\n  \"RecoveryKeyProtector\", \"RecoveryPasswordProtector\", \"StartupKeyProtector\",\r\n  or \"TpmProtector\"\r\n* AutoUnlock: Whether volumes should be enabled for auto unlock using\r\n  Enable-BitlockerAutoUnlock\r\n* AllowImmediateReboot: Whether the computer can be immediately rebooted after\r\n  enabling Bitlocker on an OS drive.\r\n  Defaults to false.\r\n\r\n* AdAccountOrGroup\r\n* AdAccountOrGroupProtector\r\n* EncryptionMethod\r\n* HardwareEncryption\r\n* Password\r\n* PasswordProtector\r\n* Pin\r\n* RecoveryKeyPath\r\n* RecoveryKeyProtector\r\n* RecoveryPasswordProtector\r\n* Service\r\n* SkipHardwareTest\r\n* StartupKeyPath\r\n* StartupKeyProtector\r\n* TpmProtector\r\n* UsedSpaceOnly\r\n\r\n**xBLTpm** is used to initialize a TPM chip using [Initialize-TPM](https://docs.microsoft.com/en-us/powershell/module/trustedplatformmodule/initialize-tpm).\r\n**xBLTpm** has the following properties.\r\n\r\n* Identity: A required string value which is used as a Key for the resource.\r\n  The value does not matter, as long as its not empty.\r\n* AllowClear: Indicates that the provisioning process clears the TPM, if\r\n  necessary, to move the TPM closer to complying with Windows Server 2012\r\n  standards.\r\n* AllowPhysicalPresence: Indicates that the provisioning process may send\r\n  physical presence commands that require a user to be present in order to\r\n  continue.\r\n* AllowImmediateReboot: Whether the computer can rebooted immediately after\r\n  initializing the TPM.\r\n\r\n## Examples\r\n\r\n### [ConfigureBitlockerOnOSDrive](source/Examples/ConfigureBitlockerOnOSDrive)\r\n\r\nThis example enables Bitlocker on an Operating System drive.\r\nThe example code for ConfigureBitlockerOnOSDrive is located in\r\n[`ConfigureBitlockerOnOSDrive.ps1`](source/Examples/ConfigureBitlockerOnOSDrive/ConfigureBitlockerOnOSDrive.ps1).\r\n\r\n### [ConfigureBitlockerAndAutoBitlocker](source/Examples/ConfigureBitlockerAndAutoBitlocker)\r\n\r\nEnables Bitlocker on an Operating System drive, and automatically enables\r\nBitlocker on all drives of type 'Fixed'. The example code for\r\nConfigureBitlockerAndAutoBitlocker is located in\r\n[`ConfigureBitlockerAndAutoBitlocker.ps1`](source/Examples/ConfigureBitlockerAndAutoBitlocker/ConfigureBitlockerAndAutoBitlocker.ps1).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2FxBitlocker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsccommunity%2FxBitlocker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2FxBitlocker/lists"}