Set-CMAutoDeploymentRuleDeployment
Sets a deployment for an automatic deployment rule.
Syntax
Set-CMAutoDeploymentRuleDeployment
[-AlertTime <Int32>]
[-AlertTimeUnit <TimeUnitType>]
[-AllowDownloadFromMicrosoftUpdate <Boolean>]
[-AllowRestart <Boolean>]
[-AllowSoftwareInstallationOutsideMaintenanceWindow <Boolean>]
[-AllowUseMeteredNetwork <Boolean>]
[-AvailableImmediately <Boolean>]
[-AvailableTime <Int32>]
[-AvailableTimeUnit <TimeUnitType>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DeadlineImmediately <Boolean>]
[-DeadlineTime <Int32>]
[-DeadlineTimeUnit <TimeUnitType>]
[-DisableOperationsManager <Boolean>]
[-EnableDeployment <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-InputObject] <IResultObject>
[-NoInstallOnRemote <Boolean>]
[-NoInstallOnUnprotected <Boolean>]
[-PassThru]
[-RequirePostRebootFullScan <Boolean>]
[-SendWakeupPacket <Boolean>]
[-SoftDeadlineEnabled <Boolean>]
[-SuccessPercentage <Int32>]
[-SuppressRestartServer <Boolean>]
[-SuppressRestartWorkstation <Boolean>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationOption>]
[-UseUtc <Boolean>]
[-VerboseLevel <VerboseLevelType>]
[-WriteFilterHandling <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMAutoDeploymentRuleDeployment
[-AlertTime <Int32>]
[-AlertTimeUnit <TimeUnitType>]
[-AllowDownloadFromMicrosoftUpdate <Boolean>]
[-AllowRestart <Boolean>]
[-AllowSoftwareInstallationOutsideMaintenanceWindow <Boolean>]
[-AllowUseMeteredNetwork <Boolean>]
[-AvailableImmediately <Boolean>]
[-AvailableTime <Int32>]
[-AvailableTimeUnit <TimeUnitType>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DeadlineImmediately <Boolean>]
[-DeadlineTime <Int32>]
[-DeadlineTimeUnit <TimeUnitType>]
[-DisableOperationsManager <Boolean>]
[-EnableDeployment <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-Id] <Int32>
[-NoInstallOnRemote <Boolean>]
[-NoInstallOnUnprotected <Boolean>]
[-PassThru]
[-RequirePostRebootFullScan <Boolean>]
[-SendWakeupPacket <Boolean>]
[-SoftDeadlineEnabled <Boolean>]
[-SuccessPercentage <Int32>]
[-SuppressRestartServer <Boolean>]
[-SuppressRestartWorkstation <Boolean>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationOption>]
[-UseUtc <Boolean>]
[-VerboseLevel <VerboseLevelType>]
[-WriteFilterHandling <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-CMAutoDeploymentRuleDeployment cmdlet updates a deployment for an automatic deployment rule.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Set a deployment by ID
PS XYZ:\> Set-CMAutoDeploymentRuleDeployment -ID 348 -CollectionName "All Systems" -EnableDeployment $True -SendWakeupPacket $False -VerboseLevel OnlySuccessAndErrorMessages -UseUtc $False -AvailableTime 7 -AvailableTimeUnit Days -DeadlineTime 7 -DeadlineTimeUnit Days -UserNotification DisplaySoftwareCenterOnly -AllowSoftwareInstallationOutsideMaintenanceWindow $False -AllowRestart $False -SuppressRestartServer $False -SuppressRestartWorkstation $False -WriteFilterHandling $False -GenerateSuccessAlert $True -SuccessPercentage 10 -AlertTime 7 -AlertTimeUnit Days -DisableOperationsManager $False -GenerateOperationsManagerAlert $False -NoInstallOnRemote $False -NoInstallOnUnprotected $False -UseBranchCache $FalseThis command updates the settings for the deployment rule deployment with the action ID of 348 and the collection named All Systems.
Example 2: Set a deployment using a variable
PS XYZ:\> $ReferenceADR = Get-CMAutoDeploymentRule -Name "TestADR01"
PS XYZ:\> $Deployment = $ReferenceADR | Get-CMAutoDeploymentRuleDeployment
PS XYZ:\> Set-CMAutoDeploymentRuleDeployment -InputObject $Deployment[0] -CollectionName "All Systems" -EnableDeployment $True -SendWakeupPacket $False -VerboseLevel OnlySuccessAndErrorMessages -UseUtc $False -AvailableTime 7 -AvailableTimeUnit Days -DeadlineTime 7 -DeadlineTimeUnit Days -UserNotification DisplaySoftwareCenterOnly -AllowSoftwareInstallationOutsideMaintenanceWindow $False -AllowRestart $False -SuppressRestartServer $False -SuppressRestartWorkstation $False -WriteFilterHandling $False -GenerateSuccessAlert $True -SuccessPercentage 10 -AlertTime 7 -AlertTimeUnit Days -DisableOperationsManager $False -GenerateOperationsManagerAlert $False -NoInstallOnRemote $False -NoInstallOnUnprotected $False -UseBranchCache $FalseThe first command gets the automatic deployment rule object named TestADR01 and stores the object in the $ReferenceADR variable.
The second command gets the deployments associated with the automatic deployment rule object stored in $ReferenceADR and stores the deployments in the $Deployment variable.
The last command updates the settings for the first deployment stored in $Deployment.
Parameters
-AlertTime
Specifies the number of time units for the offset from the deadline.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AlertTimeUnit
Specifies the time unit type for the offset from the deadline. Valid values are:
- Hours
- Days
- Weeks
- Months
| Type: | TimeUnitType |
| Accepted values: | Hours, Days, Weeks, Months |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowDownloadFromMicrosoftUpdate
Use this parameter to set the following option on the Download Settings page of the ADR deployment settings: If software updates are not available on distribution point in current, neighbor or site boundary groups, download content from Microsoft Updates.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowRestart
Indicates whether a system restart is allowed to be performed outside of any defined maintenance windows when the installation deadline is reached.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowSoftwareInstallationOutsideMaintenanceWindow
Indicates whether software installation is allowed to be performed outside of any defined maintenance windows when the installation deadline is reached.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowUseMeteredNetwork
Use this parameter to set the following option on the Download Settings page of the ADR deployment settings: Allow clients on a metered Internet connection to download content after the installation deadline, which might incur additionl costs
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableImmediately
Indicates whether software updates are available to install as soon as possible after the rule is run.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableTime
Specifies the number of time units for the software available time.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AvailableTimeUnit
Specifies the time unit type for the software available time. Valid values are:
- Hours
- Days
- Weeks
- Months
| Type: | TimeUnitType |
| Accepted values: | Hours, Days, Weeks, Months |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Collection
Specifies a target collection object for the software update deployment. To obtain a collection object, use the Get-CMCollection cmdlet.
| Type: | IResultObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionId
Specifies the ID of the target collection for the software update deployment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionName
Specifies the name of the target collection for the software update deployment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineImmediately
Indicates whether required software updates are installed as soon as possible when the deadline is reached.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineTime
Specifies the number of time units for the deadline.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeadlineTimeUnit
Specifies the time unit type for the deadline. Valid values are:
- Hours
- Days
- Weeks
- Months
| Type: | TimeUnitType |
| Accepted values: | Hours, Days, Weeks, Months |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableOperationsManager
Indicates whether Operations Manager alerts are disabled while software updates run.
| Type: | Boolean |
| Aliases: | DisableOperationManager |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-EnableDeployment
Indicates whether to enable the deployment after this rule runs for the associated software group. If set to $False, you must manually deploy the software update group.
| Type: | Boolean |
| Aliases: | Enable, EnabledAfterCreate, EnableAfterCreate |
| 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 |
-GenerateOperationsManagerAlert
Indicates whether Operations Manager alerts are generated when a software update installation fails.
| Type: | Boolean |
| Aliases: | GenerateOperationManagerAlert |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GenerateSuccessAlert
Indicates whether an alert is generated when this rule runs successfully.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
Specifies the action ID of the automatic deployment rule deployment.
| Type: | Int32 |
| Aliases: | ActionID |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies an automatic deployment rule object. To obtain an automatic deployment rule object, use the Get-CMSoftwareUpdateAutoDeploymentRule cmdlet.
| Type: | IResultObject |
| Aliases: | AutoDeploymentRuleDeployment |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NoInstallOnRemote
Indicates whether to install software updates when the updates are not available on any remote distribution points.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoInstallOnUnprotected
Indicates whether to install software updates when the updates are not available on any unprotected distribution points.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Add this parameter to return an object that represents 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 |
-RequirePostRebootFullScan
Use this parameter to set the following option on the User Experience page of the ADR deployment settings: If any update in this deployment requires a system restart, run updates deployment evaluation cycle after restart.
| Type: | Boolean |
| Aliases: | RunEvaluationAfterRestart |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SendWakeupPacket
Indicates whether to use Wake-on-LAN to wake up clients for required deployments.
| Type: | Boolean |
| Aliases: | EnableWakeOnLan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SoftDeadlineEnabled
Use this parameter to set the following option on the Deployment Schedule page of the ADR deployment settings: Delay enforcement of this deployment according to user preferences, up to the grace period defined in client settings.
| Type: | Boolean |
| Aliases: | DelayEnforcementAndUpToGracePeriod |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SuccessPercentage
Specifies the percent, as an integer, of client compliance. When client compliance falls below this percentage, an alert is generated.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SuppressRestartServer
Indicates whether a system restart is suppressed on servers when a software update requires a system restart to complete the installation process.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SuppressRestartWorkstation
Indicates whether a system restart is suppressed on workstations when a software update requires a system restart to complete the installation process.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseBranchCache
Indicates whether clients are allowed to share content with other clients on the same subnet.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserNotification
Specifies the notification behavior of the user visual experience. Valid values are:
- DisplayAll
- DisplaySoftwareCenterOnly
- HideAll
| Type: | UserNotificationOption |
| Accepted values: | DisplayAll, DisplaySoftwareCenterOnly, HideAll |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseUtc
Indicates whether the schedule for this deployment is evaluated based upon Universal Coordinated Time (UTC).
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VerboseLevel
Specifies how much state detail the clients report back for deployments created by this rule. Valid values are:
- OnlyErrorMessages
- OnlySuccessAndErrorMessages
- AllMessages
| Type: | VerboseLevelType |
| Accepted values: | OnlyErrorMessages, OnlySuccessAndErrorMessages, AllMessages |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteFilterHandling
Indicates whether changes are committed at deadline or during a maintenance window (requires restarts). If set to $False, content is applied on the overlay and committed later.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for