Edit

Share via

New-CMPrebootRecoveryInfo

  • Reference
Module:
ConfigurationManager

Configure the recovery message that the pre-boot key recovery screen displays when the OS drive is locked.

Syntax

New-CMPrebootRecoveryInfo
   [-PolicyState <State>]
   [-RecoveryMessage <String>]
   [-RecoveryUrl <Uri>]
   [-UseRecoveryMessage]
   [-UseRecoveryUrl]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

Use this cmdlet to configure the entire recovery message or replace the existing URL the pre-boot key recovery screen shows when the OS drive is locked.

If you use both -UseRecoveryUrl and -UseRecoveryMessage parameters, the pre-boot key recovery screen displays the default BitLocker recovery message and URL. If you previously configured a custom recovery message or URL and want to revert to the default message, keep the policy enabled and use both -UseRecoveryUrl and -UseRecoveryMessage parameters

Note

Pre-boot doesn't support all characters and languages. Test the characters that you want to use for the custom message or URL. Make sure the pre-boot recovery screen correctly displays your custom message or URL.

Examples

Example 1: New enabled policy with a custom recovery message and URL

This example creates a new policy that's enabled with custom values.

New-CMPrebootRecoveryInfo -PolicyState Enabled -UseRecoveryMessage -RecoveryMessage "Contact the Contoso Helpdesk at 515-555-8127 or https://contoso.com/bitlockerrecovery"

Example 2: New enabled policy with a custom recovery URL

New-CMPrebootRecoveryInfo -PolicyState Enabled -UseRecoveryUrl -RecoveryUrl https://contoso.com/bitlockerrecovery

Parameters

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PolicyState

Use this parameter to configure the policy.

  • Enabled: If you enable this policy, BitLocker uses the custom information that you specify.

  • Disabled or NotConfigured: If you disable or don't configure this policy, BitLocker uses the default information.

Type:State
Accepted values:Enabled, Disabled, NotConfigured
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RecoveryMessage

Specify a custom message to display on the pre-boot recovery screen. If you also want to specify a recovery URL, include it as part of this custom recovery message. The maximum string length is 32,768 characters. Use this parameter with the -UseRecoveryMessage parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RecoveryUrl

Replace the default URL displayed in the pre-boot BitLocker recovery screen. The maximum URI length is 32,768 characters. Use this parameter with the -UseRecoveryUrl parameter.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseRecoveryMessage

If you add this parameter, the pre-boot key recovery screen displays the value of -RecoveryMessage.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseRecoveryUrl

If you add this parameter, the URL you specify for -RecoveryUrl replaces the default URL in the default recovery message.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.ConfigurationManagement.AdminConsole.BitlockerManagement.PolicyObject