Retrieves one or more links between network regions configured for call admission control (CAC).
Syntax
Get-CsNetworkRegionLink [-Identity <XdsGlobalRelativeIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsNetworkRegionLink [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsGlobalRelativeIdentity |
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. |
|
Filter |
Optional |
String |
Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string. |
|
LocalStore |
Optional |
SwitchParameter |
Retrieves the network region link information from the local replica of the Central Management database, rather than the Central Management database itself. |
Detailed Description
Regions within a network are linked through physical WAN connectivity. This cmdlet retrieves one or more links defined for CAC within a Microsoft Communications Server 2010 deployment.
Return Types
Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Get-CsNetworkRegionLink |
|
Example 1 retrieves all network region links defined within a Communications Serverdeployment.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkRegionLink -Identity NA_EMEA |
|
Example 2 retrieves information about (at most) one network region link, the link with the Identity NA_EMEA.
-------------------------- Example 3 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkRegionLink -Filter *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.
-------------------------- Example 4 --------------------------
| Copy Code |
|
|---|---|
Get-CsNetworkRegionLink | Where-Object {$_.NetworkRegionID1 -eq "EMEA" -or $_.NetworkRegionID2 -eq "EMEA"}
|
|
This example retrieves all network region links that include EMEA as one of the two regions being linked. The example begins by calling Get-CsNetworkRegionLink with no parameters, which will retrieve all region links. This collection of links is then piped to the Where-Object cmdlet. Where-Object 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.