Edit

Set-CMDistributionPointGroup

  • Reference
Module:
ConfigurationManager

Configure distribution point groups.

Syntax

Set-CMDistributionPointGroup
   [-Description <String>]
   -InputObject <IResultObject>
   [-NewName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMDistributionPointGroup
   [-Description <String>]
   -Id <String>
   [-NewName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMDistributionPointGroup
   [-Description <String>]
   -Name <String>
   [-NewName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMDistributionPointGroup cmdlet changes the configuration settings of a distribution point group.

Note

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

Examples

Example 1: Rename a distribution point group

This command renames the distribution point group DpgDept01 to DPG01.

Set-CMDistributionPointGroup -Name "DpgDept01" -NewName "DPG01"

Example 2: Add a description to a distribution point group

This example first gets a distribution point group object with the Get-CMDistributionPointGroup cmdlet. It passes that object using the pipeline operator, and adds a description.

Get-CMDistributionPointGroup -Name "DPG01" | Set-CMDistributionPointGroup -Description "Core distribution points, contact JQPublic"

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Description

Specify an optional description for the distribution point group.

Type:String
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

-Id

Specify the ID of a distribution point group to configure. This ID is the GroupID property of the SMS_DistributionPointGroup WMI class. The format is a GUID, for example, {19797865-d8d9-454b-855f-cb0f099204d0}.

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

-InputObject

Specify a distribution point group object to configure. To get this object, use the Get-CMDistributionPointGroup cmdlet.

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

-Name

Specify the name of a distribution point group to configure.

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

-NewName

Use this parameter to rename the distribution point group.

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

-WhatIf

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

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object