Set-CMBoundary
Configure a site boundary.
Syntax
Set-CMBoundary
-InputObject <IResultObject>
[-NewName <String>]
[-NewType <BoundaryTypes>]
[-NewValue <String>]
[-PassThru]
[-ValueStartsWith <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-CMBoundary
-Id <String>
[-NewName <String>]
[-NewType <BoundaryTypes>]
[-NewValue <String>]
[-PassThru]
[-ValueStartsWith <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Set-CMBoundary
[-NewName <String>]
[-NewType <BoundaryTypes>]
[-NewValue <String>]
[-PassThru]
-Type <BoundaryTypes>
-Value <String>
[-ValueStartsWith <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Use this cmdlet to configure a site boundary. A boundary is a network location that contains one or more devices that you can manage. A boundary can be an IP subnet, Active Directory site name, IPv6 prefix, an IP address range, or a VPN. For more information, see Define site boundaries and boundary groups.
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
This command changes a boundary name from Default-ADSite to ADSiteBoundary01.
Set-CMBoundary -Name "Default-ADSite" -NewName "ADSiteBoundary01"Example 2: Modify the value of a boundary by using an InputObject
In this example, the first command gets a boundary that has the ID of 16777217 and inserts it into the input object $BoundaryObj.
The second command identifies the boundary by using the input object $BoundaryObj and modifies its value to IPSubnet17.
$BoundaryObj = Get-CMBoundary -Id "16777217"
Set-CMBoundary -InputObject $BoundaryObj -Value "IPSubnet17"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 |
-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 a boundary identifier (ID) to modify. This value is an integer, for example 26.
| Type: | String |
| Aliases: | BoundaryId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specify a boundary object to modify. To get this object, use the Get-CMBoundary cmdlet.
| Type: | IResultObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NewName
Specify a new name for a boundary.
| Type: | String |
| Aliases: | DisplayName, Name |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewType
Specify the boundary type.
| Type: | BoundaryTypes |
| Aliases: | NewBoundaryType |
| Accepted values: | IPSubnet, ADSite, IPV6Prefix, IPRange, Vpn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewValue
Specify the data that defines the boundary. For example, an Active Directory site value can be Default-First-Site-Name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Type
Specify a boundary type.
| Type: | BoundaryTypes |
| Aliases: | BoundaryType |
| Accepted values: | IPSubnet, ADSite, IPV6Prefix, IPRange, Vpn |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Value
Specify the data that describes the boundary.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ValueStartsWith
Set this parameter to $true to match the start of a connection name or description instead of the whole string. For more information, see Define network locations as boundaries.
| Type: | Boolean |
| 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
Notes
For more information on this return object and its properties, see SMS_Boundary server WMI class.
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