Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-CMSoftwareUpdate
- Module:
- ConfigurationManager Module
Get a software update.
Syntax
SearchByName (Default)
Get-CMSoftwareUpdate
[-ArticleId <String>]
[-BulletinId <String>]
[-Category <IResultObject[]>]
[-CategoryName <String[]>]
[-DatePostedMax <DateTime>]
[-DatePostedMin <DateTime>]
[-DateRevisedMax <DateTime>]
[-DateRevisedMin <DateTime>]
[-EulaExist <Boolean>]
[-Fast]
[-IncludeUpgrade]
[-IsContentProvisioned <Boolean>]
[-IsDeployed <Boolean>]
[-IsExpired <Boolean>]
[-IsLatest <Boolean>]
[-IsOfflineServiceable <Boolean>]
[-IsSuperseded <Boolean>]
[-IsUserDefined <Boolean>]
[-Name <String>]
[-OnlyExpired]
[-Severity <CustomSeverityType>]
[-Vendor <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchById
Get-CMSoftwareUpdate
-Id <Int32>
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByUpdateGroup
Get-CMSoftwareUpdate
-UpdateGroup <IResultObject>
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByUpdateGroupIdMandatory
Get-CMSoftwareUpdate
-UpdateGroupId <String[]>
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByUpdateGroupNameMandatory
Get-CMSoftwareUpdate
-UpdateGroupName <String[]>
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
Description
Use this cmdlet to get one or more software updates.
For more information, see Software update management documentation in the core docs.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Get downloaded software updates
This command gets all software updates that the site has downloaded.
Get-CMSoftwareUpdate -IsContentProvisioned $True
Example 2: Get software updates by update group
This command first gets the software update group object named TestSUgroup10. It then uses the pipeline operator to pass the object to Get-CMSoftwareUpdate. The result is the list of all software updates for the software update group.
Get-CMSoftwareUpdateGroup -Name "TestSUgroup10" | Get-CMSoftwareUpdate
Parameters
-ArticleId
Specify the Article ID of a software update. For example, 4571687.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-BulletinId
Specify the Bulletin ID of a software update. For example, MS18-952.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-Category
Specify the category of a software update. To get a category object, use the Get-CMSoftwareUpdateCategory cmdlet.
Parameter properties
| Type: | IResultObject[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CategoryName
Specify an array of category names for software updates.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CategoryNames |
Parameter sets
-DatePostedMax
Specify the latest date that a software update was released.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DatePostedMin
Specify the earliest date that a software update was released.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DateRevisedMax
Specify the latest date that a software update was revised.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DateRevisedMin
Specify the earliest date that a software update was revised.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EulaExist
Set this parameter to $true to filter results for all updates that have a license agreement.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | EulaExists |
Parameter sets
-Fast
Add this parameter to not automatically refresh lazy properties. Lazy properties contain values that are relatively inefficient to retrieve. Getting these properties can cause additional network traffic and decrease cmdlet performance.
If you don't use this parameter, the cmdlet displays a warning. To disable this warning, set $CMPSSuppressFastNotUsedCheck = $true.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
Specifies the ID of a software update. This value is the CI_ID, for example 143404.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | CIId, CI_ID |
Parameter sets
-IncludeUpgrade
Add this parameter to include software updates in the upgrade category.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | IncludeUpgrades |
Parameter sets
-IsContentProvisioned
Set this parameter to $true to filter results for all updates for which the site has downloaded content.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsDeployed
Set this parameter to $true to filter results for all updates that are deployed.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsExpired
Set this parameter to $true to filter results for all updates that are expired.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsLatest
Set this parameter to $true to filter results for the latest version of the software update.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsOfflineServiceable
Set this parameter to $true to filter results for all updates that are offline-serviceable. You can use the DISM command-line tool to inject these updates into an OS image.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsSuperseded
Set this parameter to $true to filter results for all updates that are superseded.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IsUserDefined
Set this parameter to $true to filter results for all updates that are user-defined.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Specify the name of a software update. This parameter compares against the localized display name attribute.
You can use wildcard characters:
*: Multiple characters?: Single character
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
| Aliases: | LocalizedDisplayName |
Parameter sets
-OnlyExpired
Add this parameter to only search for expired software updates.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Severity
Specify the severity of the software update.
Parameter properties
| Type: | CustomSeverityType |
| Default value: | None |
| Accepted values: | None, Low, Moderate, Important, Critical |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UpdateGroup
Specify software update group object. To get this object, use the Get-CMSoftwareUpdateGroup cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UpdateGroupId
Specify an array of IDs of software update groups. This value is the CI_ID or Config Item ID of the software update group. For example, 107078.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UpdateGroupName
Specify an array of names of software update groups.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Vendor
Applies to version 2010 and later. Specify the name of the software update vendor. The vendor for most software updates is "Microsoft". If you configure third-party software updates, use this value to filter on other update vendors.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject
IResultObject
Notes
For more information on this return object and its properties, see SMS_SoftwareUpdate server WMI class.
Related Links
Feedback
Was this page helpful?