See Also
Topic Last Modified: 2010-10-01
Removes a route that connects network regions within a call admission control (CAC) configuration.
Syntax
Remove-CsNetworkInterRegionRoute -Identity
<XdsGlobalRelativeIdentity> [-Confirm
[<SwitchParameter>]] [-Force <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
XdsGlobalRelativeIdentity |
The unique identifier for the network region route you want to remove. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. |
|
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Detailed Description
Every region within a CAC configuration must have some way to access every other region. While region links set bandwidth limitations on the connections between regions and also represent the physical links, a route determines which linked path the connection will traverse from one region to another. This cmdlet removes one of these route associations.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsNetworkInterRegionRoute cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsNetworkInterRegionRoute"}
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType object. Accepts pipelined input of network inter-region route objects.
Return Types
This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType.
Example
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Remove-CsNetworkInterRegionRoute -Identity NA_APAC_Route |
|
Example 1 removes the route with the Identity NA_APAC_Route.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"} | Remove-CsNetworkInterRegionRoute
|
|
Example 2 removes all region routes that include the NorthAmerica region. The first part of the command is a call to the Get-CsNetworkInterRegionRoute cmdlet. This cmdlet, called with no parameters, will retrieve all region routes. Next, this collection of routes is piped to the Where-Object cmdlet. The Where-Object cmdlet will narrow the collection down to only those routes that have NorthAmerica defined as one of the regions in the route. It does this by checking to see if the route has a NetworkRegionID1 value equal to (-eq) NorthAmerica, or (-or) a NetworkRegionID2 value equal to NorthAmerica. Once the collection contains only the routes that include the NorthAmerica region, we pipe the collection to Remove-CsNetworkInterRegionRoute, which removes each of those routes.