Topic Last Modified: 2013-03-06

Retrieves one or more links between network regions configured for call admission control (CAC). This cmdlet was introduced in Lync Server 2010.


Get-CsNetworkRegionLink [-Identity <XdsGlobalRelativeIdentity>] <COMMON PARAMETERS>
Get-CsNetworkRegionLink [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]



Example 1 retrieves all network region links defined within a Lync Server deployment.

Copy Code


Example 2 retrieves information about (at most) one network region link, the link with the Identity NA_EMEA.

Copy Code
Get-CsNetworkRegionLink -Identity NA_EMEA


In this example we use the Filter parameter to retrieve all network region links with the string EMEA in the name (Identity) of the link. Notice the * characters, one before the string EMEA and one after. This means any character or characters can precede or follow the string; the string EMEA simply must be included in the Identity somewhere. This will retrieve links with names such as NA_EMEA, EMEA_APAC, and EMEA2_SA.

Copy Code
Get-CsNetworkRegionLink -Filter *EMEA*


This example retrieves all network region links that include EMEA as one of the two regions being linked. The example begins by calling the Get-CsNetworkRegionLink cmdlet with no parameters, which will retrieve all region links. This collection of links is then piped to the Where-Object cmdlet. The Where-Object cmdlet looks through each member of the collection one-by-one, checking the values of the NetworkRegionID1 and NetworkRegionID2 properties. If either of these properties is equal to EMEA--in other words if either NetworkRegionID1 is equal to (-eq) EMEA or (-or) NetworkRegionID2 is equal to (-eq) EMEA--then we want to keep that item in the collection and display it.

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

Detailed Description

Regions within a network are linked through physical WAN connectivity. This cmdlet retrieves one or more region links that are defined within the network configuration settings for a Lync Server deployment.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsNetworkRegionLink cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsNetworkRegionLink"}


Parameter Required Type Description




Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string.




The unique identifier of the network region link you want to retrieve. Network region links 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 link. (Note that this value is the same as the NetworkRegionLinkID.)




Retrieves the network region link information from the local replica of the Central Management store, rather than the Central Management store itself.

Input Types


Return Types

Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType.

See Also