Get-CMSoftwareUpdate

Get-CMSoftwareUpdate

Retrieves configuration settings for software updates.

Syntax

Parameter Set: SearchByName
Get-CMSoftwareUpdate [-Name <String[]> ] [-SecuredScopeNames <String> ] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Get-CMSoftwareUpdate -Id <String[]> [-SecuredScopeNames <String> ] [ <CommonParameters>]

Parameter Set: SearchByUpdateGroup
Get-CMSoftwareUpdate -UpdateGroup <IResultObject> [ <CommonParameters>]

Parameter Set: SearchByUpdateGroupIdMandatory
Get-CMSoftwareUpdate -UpdateGroupId <String[]> [ <CommonParameters>]

Parameter Set: SearchByUpdateGroupNameMandatory
Get-CMSoftwareUpdate -UpdateGroupName <String[]> [ <CommonParameters>]

Detailed Description

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

Parameters

-Id<String[]>

Specifies an array of IDs of software updates.

Aliases

CIId

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of software updates.

Aliases

LocalizedDisplayName

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SecuredScopeNames<String>

Specifies a security scope for the deployment package. The default value is Default.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UpdateGroup<IResultObject>

Specifies a CMSoftwareUpdate object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UpdateGroupId<String[]>

Specifies an array of IDs of update groups.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UpdateGroupName<String[]>

Specifies an array of names of update groups.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Retrieve all software updates

This command retrieves all software updates.

PS C:\> Get-CMSoftwareUpdate

Example 2: Retrieve a software update by using a name

This command retrieves the software update named Cumulative Security Update for ActiveX Killbits for Windows 7 (KB2618451).

PS C:\> Get-CMSoftwareUpdate -Name "Cumulative Security Update for ActiveX Killbits for Windows 7 (KB2618451)"

Save-CMSoftwareUpdate

Set-CMSoftwareUpdate

Sync-CMSoftwareUpdate