Get-CsNetworkInterRegionRoute

Syntax

Get-CsNetworkInterRegionRoute
   [[-Identity] <XdsGlobalRelativeIdentity>]
   [-LocalStore]
   [<CommonParameters>]

Get-CsNetworkInterRegionRoute
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]

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 retrieves information about these route associations.

Examples

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

Get-CsNetworkInterRegionRoute -Identity NA_APAC_Route

Example 1 retrieves the route with the Identity NA_APAC_Route.

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

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

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. The Where-Object cmdlet takes the collection and retrieves all items in the collection that have the value NA_EMEA within their NetworkRegionLinks list.

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

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.

Parameters

-Filter

-Identity

-LocalStore

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType

Related Links

• New-CsNetworkInterRegionRoute
• Remove-CsNetworkInterRegionRoute
• Set-CsNetworkInterRegionRoute