Edit

Share via


Set-CMBlmSetting

Modify an existing BitLocker management policy setting.

Syntax

Default (Default)

Set-CMBlmSetting
    [-BlmSettings] <BlmSettings>
    [-Policies <PolicyObject[]>]
    [-PassThru]
    [-Name <String>]
    [-Description <String>]
    [-Precedence <Int32>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

Description

Modify an existing BitLocker management policy setting. Use New-CMBlmSetting to create a new management policy, and Get-CMBlmSetting to get an existing management policy.

Examples

Example 1: Add a new policy to an existing setting

This example gets the existing BitLocker management policy by name. It then passes that object to the Set-CMBlmSetting cmdlet to add a new policy. The new policy is created by the New-CMBMSOSDEncryptionPolicy cmdlet.

Get-CMBlmSetting -Name "My BitLocker settings" | Set-CMBlmSetting -Policies (New-CMBMSOSDEncryptionPolicy -PolicyState Enabled -Protector TpmOnly)

Parameters

-BlmSettings

Specify a BitLocker management policy settings object to configure. Use the Get-CMBlmSetting to get this object.

Parameter properties

Type:BlmSettings
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specify a new description for the BitLocker management policy object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Use this parameter to change the name of the specified BitLocker management policy object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Policies

Specify an array of BitLocker policies to include. For more information on the specific policy cmdlets, see the Related links in the New-CMBlmSetting cmdlet.

If you don't specify any policies with the -Policies parameter, the default policy is a single, not configured, OS drive encryption policy. For more information on this default policy type, see New-CMBMSOSDEncryptionPolicy.

Parameter properties

Type:

PolicyObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Precedence

Change the priority order of this policy. If you deploy multiple policies to the same client, the lowest number takes precedence.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.PowerShell.Cmdlets.EP.BitLockerManagement.BlmSettings

Outputs

Microsoft.ConfigurationManagement.PowerShell.Cmdlets.EP.BitLockerManagement.BlmSettings