[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Retrieves one or more routes that connect network regions within a call admission control (CAC) configuration.


Get-CsNetworkInterRegionRoute [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>]
Get-CsNetworkInterRegionRoute [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description




The unique identifier for the network region route you want to retrieve. 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.




A string that allows you to retrieve routes based on matching the Identity values to the wildcard string passed as a value to this parameter.




Retrieves the network inter-region route information from the local replica of the Central Management database, rather than the Central Management database itself.

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, a route determines which linked path the connection will traverse from one region to another. This cmdlet retrieves information about these route associations.

Return Types

This cmdlet returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType.


-------------------------- Example 1 --------------------------

Copy Code
Get-CsNetworkInterRegionRoute -Identity NA_APAC_Route

Example 1 retrieves the route with the Identity NA_APAC_Route.

-------------------------- Example 2 --------------------------

Copy Code
Get-CsNetworkInterRegionRoute -Filter *APAC*

In Example 2, we use the Filter parameter to retrieve all routes that contain the string APAC anywhere within the Identity.

-------------------------- Example 3 --------------------------

Copy Code
Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionLinks -eq "NA_EMEA"}

This example retrieves all region routes that use the network region link NA_EMEA. The command begins by calling the Get-CsNetworkInterRegionRoute cmdlet. Calling this cmdlet with no parameters retrieves all routes defined with the CAC configuration. This collection of routes is then piped to the Where-Object cmdlet. Where-Object takes the collection and retrieves all items in the collection that have the value NA_EMEA within their NetworkRegionLinks list.

-------------------------- Example 4 --------------------------

Copy Code
Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"}

Example 4 retrieves 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.