Edit

Get-CMSoftwareUpdateDeployment

  • Reference
Module:
ConfigurationManager

Get a software update deployment.

Syntax

Get-CMSoftwareUpdateDeployment
   [-Name <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMSoftwareUpdateDeployment
   [-DeploymentId <String>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMSoftwareUpdateDeployment
   [-InputObject <IResultObject>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]
Get-CMSoftwareUpdateDeployment
   [-SmsObjectId <Int32>]
   [-Summary]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [<CommonParameters>]

Description

The Get-CMSoftwareUpdateDeployment cmdlet gets a software update deployment.

Note

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

Examples

Example 1: Display deployment status for a Patch Tuesday deployment

This example uses the Get-CMSoftwareUpdateDeployment cmdlet to get a software update deployment object. That object is then used as the input to show the status.

$sudeploy = Get-CMSoftwareUpdateDeployment -Name "Patch Tuesday - Office and Edge 2020-07-15 00:11:11"

Get-CMSoftwareUpdateDeploymentStatus -InputObject $sudeploy

Parameters

-Collection

Specify a collection object for the software update deployment.

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

-CollectionId

Specify a collection by ID for the software update deployment.

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

-CollectionName

Specify a collection by name for the software update deployment.

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

-DeploymentId

Specify the deployment ID to get. The format is a GUID.

Type:String
Aliases:AssignmentUniqueID, SoftwareUpdateDeploymentID
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

-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

-InputObject

Type:IResultObject
Aliases:SoftwareUpdate
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specify the name of the software update deployment to get.

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

-SmsObjectId

Type:Int32
Aliases:CI_ID, SoftwareUpdateID
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Summary

Add this parameter to return the SMS_DeploymentSummary WMI class object.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject[]

IResultObject

IResultObject[]

IResultObject

Notes

For more information on these return objects and their properties, see the following articles: