Get-CMSoftwareUpdate

SYNOPSIS

Gets a software update.

SYNTAX

SearchByName (Default)

Get-CMSoftwareUpdate [-Name <String>] [-DatePostedMin <DateTime>] [-DatePostedMax <DateTime>]
 [-DateRevisedMin <DateTime>] [-DateRevisedMax <DateTime>] [-Severity <CustomSeverityType>]
 [-IsDeployed <Boolean>] [-IsContentProvisioned <Boolean>] [-EulaExist <Boolean>] [-IsExpired <Boolean>]
 [-IsOfflineServiceable <Boolean>] [-CategoryName <String[]>] [-IsSuperseded <Boolean>] [-IsLatest <Boolean>]
 [-IsUserDefined <Boolean>] [-Category <IResultObject[]>] [-ArticleId <String>] [-BulletinId <String>]
 [-OnlyExpired] [-IncludeUpgrade] [-Fast] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [<CommonParameters>]

SearchByUpdateGroupIdMandatory

Get-CMSoftwareUpdate -UpdateGroupId <String[]> [-Fast] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [<CommonParameters>]

SearchByUpdateGroupNameMandatory

Get-CMSoftwareUpdate -UpdateGroupName <String[]> [-Fast] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [<CommonParameters>]

SearchByUpdateGroup

Get-CMSoftwareUpdate -UpdateGroup <IResultObject> [-Fast] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [<CommonParameters>]

SearchById

Get-CMSoftwareUpdate -Id <Int32> [-Fast] [-DisableWildcardHandling] [-ForceWildcardHandling]
 [<CommonParameters>]

DESCRIPTION

The Get-CMSoftwareUpdate cmdlet gets one or more software updates. Clients receive a software update object when manually or automatically deploying a software update.

EXAMPLES

Example 1: Get software updates that have been downloaded

PS C:\> Get-CMSoftwareUpdate -IsContentProvisioned $True

This command gets all software updates that have been downloaded.

Example 2: Get software updates by update group

PS C:\> Get-CMSoftwareUpdateGroup -Name "TestSUgroup10" | Get-CMSoftwareUpdate

This command gets the software update group object named TestSUgroup10 and uses the pipeline operator to pass the object to Get-CMSoftwareUpdate, which gets all software updates for the software update group object.

PARAMETERS

-ArticleId

Specifies the article ID of a software update.

Type: String
Parameter Sets: SearchByName
Aliases: 

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

-BulletinId

Specifies the bulletin ID of a software update.

Type: String
Parameter Sets: SearchByName
Aliases: 

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

-Category

Specifies the category of a software update. To obtain a category object, use the Get-CMSoftwareUpdateCategory cmdlet.

Type: IResultObject[]
Parameter Sets: SearchByName
Aliases: 

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

-CategoryName

Specifies an array of category names for software updates.

Type: String[]
Parameter Sets: SearchByName
Aliases: CategoryNames

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

-DatePostedMax

Specifies the latest date that a software update was released.

Type: DateTime
Parameter Sets: SearchByName
Aliases: 

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

-DatePostedMin

Specifies the earliest date that a software update was released.

Type: DateTime
Parameter Sets: SearchByName
Aliases: 

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

-DateRevisedMax

Specifies the latest date that a software update was revised.

Type: DateTime
Parameter Sets: SearchByName
Aliases: 

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

-DateRevisedMin

Specifies the earliest date that a software update was revised.

Type: DateTime
Parameter Sets: SearchByName
Aliases: 

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

-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-EulaExist

Type: Boolean
Parameter Sets: SearchByName
Aliases: EulaExists

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

-Fast

Indicates that the cmdlet does not automatically refresh lazy properties.

Lazy properties contain values that are relatively inefficient to retrieve which can cause additional network traffic and decrease cmdlet performance. If lazy properties are not used, this parameter should be specified.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-Id

Specifies the ID of a software update.

Type: Int32
Parameter Sets: SearchById
Aliases: CIId, CI_ID

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

-IncludeUpgrade

Type: SwitchParameter
Parameter Sets: SearchByName
Aliases: IncludeUpgrades

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

-IsContentProvisioned

Indicates whether the software update is downloaded.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsDeployed

Indicates whether the software update is deployed.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsExpired

Indicates whether the software update has expired.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsLatest

Indicates whether the software update is the latest version.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsOfflineServiceable

Indicates whether the software update is offline-serviceable.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsSuperseded

Indicates whether the software update is superseded.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-IsUserDefined

Indicates whether the software update is user-defined.

Type: Boolean
Parameter Sets: SearchByName
Aliases: 

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

-Name

Specifies the name of a software update.

Type: String
Parameter Sets: SearchByName
Aliases: LocalizedDisplayName

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

-OnlyExpired

Indicates that the cmdlet only searches for expired software updates.

Type: SwitchParameter
Parameter Sets: SearchByName
Aliases: 

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

-Severity

Specifies the severity of software update. Valid values are:

  • None
  • Low
  • Moderate
  • Important
  • Critical
Type: CustomSeverityType
Parameter Sets: SearchByName
Aliases: 
Accepted values: None, Low, Moderate, Important, Critical

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

-UpdateGroup

Specifies a software update group object. To obtain an update group object, use the Get-CMSoftwareUpdateGroup cmdlet.

Type: IResultObject
Parameter Sets: SearchByUpdateGroup
Aliases: 

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

-UpdateGroupId

Specifies an array of IDs of software update groups.

Type: String[]
Parameter Sets: SearchByUpdateGroupIdMandatory
Aliases: 

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

-UpdateGroupName

Specifies an array of names of software update groups.

Type: String[]
Parameter Sets: SearchByUpdateGroupNameMandatory
Aliases: 

Required: True
Position: Named
Default value: None
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Get-CMSoftwareUpdateGroup

Save-CMSoftwareUpdate

Set-CMSoftwareUpdate

Sync-CMSoftwareUpdate