Skip to content

Latest commit

 

History

History
344 lines (251 loc) · 8.01 KB

Set-CMSoftwareUpdateDeploymentPackage.md

File metadata and controls

344 lines (251 loc) · 8.01 KB
external help file Module Name ms.date schema title
AdminUI.PS.dll-Help.xml
ConfigurationManager
12/16/2021
2.0.0
Set-CMSoftwareUpdateDeploymentPackage

Set-CMSoftwareUpdateDeploymentPackage

SYNOPSIS

Modify a software update deployment package.

SYNTAX

SetById (Default)

Set-CMSoftwareUpdateDeploymentPackage [-Description <String>] [-Force] -Id <String> [-NewName <String>]
 [-PassThru] [-Path <String>] [-Priority <Priorities>] [-RefreshDistributionPoint] [-RemoveExpired]
 [-RemoveSuperseded] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SetByValueMandatory

Set-CMSoftwareUpdateDeploymentPackage [-Description <String>] [-Force] -InputObject <IResultObject>
 [-NewName <String>] [-PassThru] [-Path <String>] [-Priority <Priorities>] [-RefreshDistributionPoint]
 [-RemoveExpired] [-RemoveSuperseded] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

SetByName

Set-CMSoftwareUpdateDeploymentPackage [-Description <String>] [-Force] -Name <String> [-NewName <String>]
 [-PassThru] [-Path <String>] [-Priority <Priorities>] [-RefreshDistributionPoint] [-RemoveExpired]
 [-RemoveSuperseded] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Use this cmdlet to modify a software update deployment package. A software update deployment package contains one or more software updates for deployment to a collection of computers. For more information, see Deploy software updates.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

EXAMPLES

Example 1: Update the name and description of a deployment package

This command sets a new name and description for the deployment package that has the ID ST10000C.

Set-CMSoftwareUpdateDeploymentPackage -Id "ST10000C" -Description "Deployment pack 107" -NewName "SDPTest"

PARAMETERS

-Description

Specify an optional description for the deployment package.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-Force

Add this parameter to force remove an expired NAP update.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-Id

Specify the ID of a deployment package to modify.

Type: String
Parameter Sets: SetById
Aliases: PackageId

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

-InputObject

Specify a deployment package object to modify. To get this object, use the Get-CMSoftwareUpdateDeploymentPackage cmdlet.

Type: IResultObject
Parameter Sets: SetByValueMandatory
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specify the name of the deployment package to modify.

Type: String
Parameter Sets: SetByName
Aliases:

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

-NewName

Specify a new name for the deployment package.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases:

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

-Path

Specify a package source path for the deployment package.

Type: String
Parameter Sets: (All)
Aliases: PackageSourcePath, PkgSourcePath

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

-Priority

Specify the order in which the site sends the content to other sites and the distribution points in this site.

The site sends high priority content before packages with medium or low priority. Packages with equal priority are sent in the order in which they're created.

Type: Priorities
Parameter Sets: (All)
Aliases:
Accepted values: High, Normal, Low

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

-RefreshDistributionPoint

Add this parameter to refresh the package on distribution points.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: RefreshDistributionPointAfterRemoveSoftwareUpdateFromPackage

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

-RemoveExpired

Add this parameter to decline updates that aren't approved and have been expired by Microsoft.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: RemoveDownloadedExpiredSoftwareUpdateFromPackage

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

-RemoveSuperseded

Add this parameter to decline updates that haven't been approved for 30 days or more, aren't currently needed by any clients, and are superseded by an approved update.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: RemoveDownloadedSupersededSoftwareUpdateFromPackage

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-CMSoftwareUpdateDeploymentPackage

New-CMSoftwareUpdateDeploymentPackage

Remove-CMSoftwareUpdateDeploymentPackage

Save-CMSoftwareUpdate

Deploy software updates

Software updates maintenance