Set-CMSettingDeployment
Configure an existing settings policy deployment.
Syntax
Set-CMSettingDeployment
[-CMSettingsDeployment] <SettingsDeployment>
[-Schedule <IResultObject>]
[-OverrideServiceWindows <Boolean>]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
Description
Configure an existing settings policy deployment. For example, configure the deployment of a BitLocker management policy or a Microsoft Defender Application Control policy.
Examples
Example 1: Modify the schedule for the deployment of a BitLocker management policy
This example gets a BitLocker management policy setting object by name. It then uses the pipe operator to get a deployment for that policy object. It uses the pipe operator to modify the schedule of the deployment.
Get-CMBlmSetting -Name "My BitLocker setting" | Get-CMSettingDeployment | Set-CMSettingDeployment -Schedule (New-CMSchedule -Start ((Get-Date).AddDays(-30)).ToString() -RecurCount 7 -RecurInterval Minutes)
Example 2: Configure the deployment of a Microsoft Defender Application Control policy
This example gets an Application Control policy object by name. It then uses the pipe operator to get a deployment for that policy object. It uses the pipe operator to modify the deployment to allow the client to remediate the policy outside of a maintenance window.
Get-CMWdacSetting -Name "My App Control setting" | Get-CMSettingDeployment | Set-CMSettingDeployment -OverrideServiceWindows
Parameters
-CMSettingsDeployment
Specify the settings deployment object to configure. To get the deployment object, use the Get-CMSettingDeployment cmdlet.
Type: | SettingsDeployment |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-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 |
-OverrideServiceWindows
When you add this parameter, the client can remediate the settings outside of a maintenance window.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Schedule
Specify a schedule object to apply to the deployment. To create a custom schedule, use the New-CMSchedule cmdlet.
Type: | IResultObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.PowerShell.Cmdlets.Deployments.SettingsDeployment.SettingsDeployment
Outputs
Microsoft.ConfigurationManagement.PowerShell.Cmdlets.Deployments.SettingsDeployment.SettingsDeployment