Edit

Share via


Set-CMSoftwareUpdateGroup

Changes configuration settings for software update groups in Configuration Manager.

Syntax

SetById (Default)

Set-CMSoftwareUpdateGroup
    -Id <Int32>
    [-AddSoftwareUpdate <IResultObject[]>]
    [-ClearExpiredSoftwareUpdate]
    [-ClearSoftwareUpdate]
    [-ClearSupersededSoftwareUpdate]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveSoftwareUpdate <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByValueMandatory

Set-CMSoftwareUpdateGroup
    -InputObject <IResultObject>
    [-AddSoftwareUpdate <IResultObject[]>]
    [-ClearExpiredSoftwareUpdate]
    [-ClearSoftwareUpdate]
    [-ClearSupersededSoftwareUpdate]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveSoftwareUpdate <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByName

Set-CMSoftwareUpdateGroup
    -Name <String>
    [-AddSoftwareUpdate <IResultObject[]>]
    [-ClearExpiredSoftwareUpdate]
    [-ClearSoftwareUpdate]
    [-ClearSupersededSoftwareUpdate]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-RemoveSoftwareUpdate <IResultObject[]>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Examples

Example 1: Add a software update group to a security scope

PS XYZ:\> Set-CMSoftwareUpdateGroup -SecurityScopeAction AddMembership -SecurityScopeName "ScopeNameD02" -Name "SUGroup01"

This command adds a software update group named SUGroup01 as a member of the security scope named ScopeNameD02.

Example 2: Remove a software update group from a security scope

PS XYZ:\> Set-CMSoftwareUpdateGroup -SecurityScopeAction RemoveMembership -SecurityScopeName "ScopeNameD17" -Name "SUGroup01"

This command removes the software update group named SUGroup01 from membership in the security scope named ScopeNameD17.

Parameters

-AddSoftwareUpdate

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddSoftwareUpdates

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearExpiredSoftwareUpdate

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearSoftwareUpdate

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearSupersededSoftwareUpdate

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for a software update group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LocalizedDescription

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

Specifies an array of IDs of software update groups.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CIId, CI_ID

Parameter sets

SetById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies an array of names of software update groups.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:LocalizedDisplayName

Parameter sets

SetByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewName

Specifies a name for a software update group. This name replaces the current name of the group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveSoftwareUpdate

The Set-CMSoftwareUpdateGroup cmdlet changes the name or description of one or more Configuration Manager software update groups, or it adds or removes software update groups for one or more security scopes.

A software update group is a collection of one or more software updates. You can add software updates to a software update group and then deploy the group to clients. After you deploy a software update group, you can add new software updates to the group and Configuration Manager automatically deploys them.

Note

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

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:RemoveSoftwareUpdates

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Outputs

System.Object