Set-CMBoundaryGroup
Modify the properties of a boundary group.
Syntax
Set-CMBoundaryGroup
[-AddSiteSystemServer <IResultObject[]>]
[-AddSiteSystemServerName <String[]>]
[-AllowPeerDownload <Boolean>]
[-ClearSiteSystemServer]
[-DefaultSiteCode <String>]
[-Description <String>]
-InputObject <IResultObject>
[-NewName <String>]
[-PassThru]
[-PreferCloudDPOverDP <Boolean>]
[-PreferDPOverPeer <Boolean>]
[-RemoveSiteSystemServer <IResultObject[]>]
[-RemoveSiteSystemServerName <String[]>]
[-SubnetPeerDownloadOnly <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMBoundaryGroup
[-AddSiteSystemServer <IResultObject[]>]
[-AddSiteSystemServerName <String[]>]
[-AllowPeerDownload <Boolean>]
[-ClearSiteSystemServer]
[-DefaultSiteCode <String>]
[-Description <String>]
-Id <String>
[-NewName <String>]
[-PassThru]
[-PreferCloudDPOverDP <Boolean>]
[-PreferDPOverPeer <Boolean>]
[-RemoveSiteSystemServer <IResultObject[]>]
[-RemoveSiteSystemServerName <String[]>]
[-SubnetPeerDownloadOnly <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMBoundaryGroup
[-AddSiteSystemServer <IResultObject[]>]
[-AddSiteSystemServerName <String[]>]
[-AllowPeerDownload <Boolean>]
[-ClearSiteSystemServer]
[-DefaultSiteCode <String>]
[-Description <String>]
-Name <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 $serverParameters
-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.
| Type: | IResultObject[] |
| Aliases: | AddSiteSystemServers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String[] |
| Aliases: | AddSiteSystemServerNames |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ClearSiteSystemServer
Add this parameter to remove all referenced site system servers from the boundary group.
| Type: | SwitchParameter |
| Aliases: | ClearSiteSystemServers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 |
-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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specify an optional description for this boundary 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 boundary group to configure. This ID is the GroupID property on the SMS_BoundaryGroup object. For example, 33.
| Type: | String |
| Aliases: | GroupId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specify an object for a boundary group to configure. To get a boundary group object, use the Get-CMBoundaryGroup cmdlet.
| Type: | IResultObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specify the name for a boundary 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 a boundary group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Aliases: | PreferCloudDistributionPointOverDistributionPoint |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Aliases: | PreferDistributionPointOverPeerInSubnet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | IResultObject[] |
| Aliases: | RemoveSiteSystemServers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String[] |
| Aliases: | RemoveSiteSystemServerNames |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Boolean |
| Aliases: | PeerWithinSameSubnetOnly |
| 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
IResultObject
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for