Edit

Share via

Set-CMBoundaryGroup

Module:
ConfigurationManager Module

Modify the properties of a boundary group.

Syntax

SetByValueMandatory (Default) 

Set-CMBoundaryGroup
    -InputObject <IResultObject>
    [-AddSiteSystemServer <IResultObject[]>]
    [-AddSiteSystemServerName <String[]>]
    [-AllowPeerDownload <Boolean>]
    [-ClearSiteSystemServer]
    [-DefaultSiteCode <String>]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-PreferCloudDPOverDP <Boolean>]
    [-PreferDPOverPeer <Boolean>]
    [-RemoveSiteSystemServer <IResultObject[]>]
    [-RemoveSiteSystemServerName <String[]>]
    [-SubnetPeerDownloadOnly <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetById 

Set-CMBoundaryGroup
    -Id <String>
    [-AddSiteSystemServer <IResultObject[]>]
    [-AddSiteSystemServerName <String[]>]
    [-AllowPeerDownload <Boolean>]
    [-ClearSiteSystemServer]
    [-DefaultSiteCode <String>]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-PreferCloudDPOverDP <Boolean>]
    [-PreferDPOverPeer <Boolean>]
    [-RemoveSiteSystemServer <IResultObject[]>]
    [-RemoveSiteSystemServerName <String[]>]
    [-SubnetPeerDownloadOnly <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByName 

Set-CMBoundaryGroup
    -Name <String>
    [-AddSiteSystemServer <IResultObject[]>]
    [-AddSiteSystemServerName <String[]>]
    [-AllowPeerDownload <Boolean>]
    [-ClearSiteSystemServer]
    [-DefaultSiteCode <String>]
    [-Description <String>]
    [-NewName <String>]
    [-PassThru]
    [-PreferCloudDPOverDP <Boolean>]
    [-PreferDPOverPeer <Boolean>]
    [-RemoveSiteSystemServer <IResultObject[]>]
    [-RemoveSiteSystemServerName <String[]>]
    [-SubnetPeerDownloadOnly <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMBoundaryGroup cmdlet modifies the properties of a boundary group. A boundary group is a collection of boundaries. For more information, see Define site boundaries and boundary groups and the New-CMBoundary cmdlet.

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 boundary group

This command renames a boundary group. It uses the Get-CMBoundaryGroup cmdlet to get the boundary group object, and then passes it using the pipeline operator.

Get-CMBoundaryGroup -Name "BGroup01" | Set-CMBoundaryGroup -NewName "BGroup00"

Example 2: Add a security scope to a boundary group

This command adds the security scope OSDeploymentScope to the boundary group BGroup02.

Set-CMBoundaryGroup -SecurityScopeAction AddMembership -SecurityScopeName "OSDeploymentScope" -Name "BGroup02"

Example 3: Add a site system server

This command uses the Get-CMSiteSystemServer cmdlet to get a server object, and then adds it to the boundary group.

$server = Get-CMSiteSystemServer -Name "granitefalls.cloudapp.net"
Set-CMBoundaryGroup -Name "Remote BG" -AddSiteSystemServer $server

Parameters

-AddSiteSystemServer

Specify a site system server object to add to this boundary group. Clients on the boundary group use these servers for policy and content. You can add management points, distribution points, state migration points, software update points, and cloud management gateways. To get a site system server object, use the Get-CMSiteSystemServer cmdlet.

Parameter properties

Type:

IResultObject[]

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

Parameter sets

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

-AddSiteSystemServerName

Specify the fully qualified domain name of a site system server to add to this boundary group. Clients on the boundary group use these servers for policy and content. You can add management points, distribution points, state migration points, software update points, and cloud management gateways.

Important

This parameter requires the fully qualified domain name of the site server.

Parameter properties

Type:

String[]

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

Parameter sets

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

-AllowPeerDownload

Configure the boundary group option to allow peer downloads in this boundary group. For more information, see Boundary group options for peer downloads.

Parameter properties

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

-ClearSiteSystemServer

Add this parameter to remove all referenced site system servers from the boundary group.

Parameter properties

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

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

-DefaultSiteCode

Specify the site code to set as the assigned site, and enable the boundary group for site assignment.

To disable site assignment for the boundary group, set this value to $null.

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

-Description

Specify an optional description for this boundary 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

-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

Specify the ID of a boundary group to configure. This ID is the GroupID property on the SMS_BoundaryGroup object. For example, 33.

Parameter properties

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

Parameter sets

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

-InputObject

Specify an object for a boundary group to configure. To get a boundary group object, use the Get-CMBoundaryGroup 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

Specify the name for a boundary group to configure.

Parameter properties

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

Parameter sets

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

-NewName

Use this parameter to rename a boundary 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

Returns an object representing 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

-PreferCloudDPOverDP

Configure the boundary group option to prefer cloud-based sources over on-premises sources. For more information, see Boundary group options for peer downloads.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PreferCloudDistributionPointOverDistributionPoint

Parameter sets

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

-PreferDPOverPeer

Configure the boundary group option to prefer distribution points over peers within the same subnet. To enable this setting, also enable -AllowPeerDownload. For more information, see Boundary group options for peer downloads.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PreferDistributionPointOverPeerInSubnet

Parameter sets

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

-RemoveSiteSystemServer

Specifies a site system server object to remove from the boundary group. To get this object, use the Get-CMSiteSystemServer cmdlet.

To remove all site system servers, use the -ClearSiteSystemServer parameter.

Parameter properties

Type:

IResultObject[]

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

Parameter sets

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

-RemoveSiteSystemServerName

Specifies the name of one or more site system servers to remove from the boundary group. To remove all site system servers, use the -ClearSiteSystemServer parameter.

Parameter properties

Type:

String[]

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

Parameter sets

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

-SubnetPeerDownloadOnly

Configure the boundary group option to only use peers within the same subnet during peer downloads. To enable this setting, also enable -AllowPeerDownload. For more information, see Boundary group options for peer downloads.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:PeerWithinSameSubnetOnly

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

IResultObject