New-CsNetworkRegionLink
Topic Last Modified: 2012-03-25
Creates a link between two regions configured for call admission control (CAC).
Syntax
New-CsNetworkRegionLink -Identity <XdsGlobalRelativeIdentity> -NetworkRegionID1 <String> -NetworkRegionID2 <String> [-BWPolicyProfileID <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
New-CsNetworkRegionLink -NetworkRegionID1 <String> -NetworkRegionID2 <String> -NetworkRegionLinkID <String> [-BWPolicyProfileID <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Regions within a network are linked through physical WAN connectivity. This cmdlet defines a link between two regions and sets the bandwidth limitations on audio and video connections between these regions.
Who can run this cmdlet: By default, members of the following groups are authorized to run the New-CsNetworkRegionLink 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 "New-CsNetworkRegionLink"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
XdsGlobalRelativeIdentity |
A unique identifier for the newly created network region link. 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. |
NetworkRegionID1 |
Required |
String |
The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 parameter. |
NetworkRegionID2 |
Required |
String |
The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 parameter. |
NetworkRegionLinkID |
Required |
String |
This value is the same as the Identity. You cannot specify both an Identity and a NetworkRegionLinkID; a value entered for one will be automatically used for both. |
BWPolicyProfileID |
Optional |
String |
The Identity of the bandwidth policy profile that will define the bandwidth limitations for this link. You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
InMemory |
Optional |
SwitchParameter |
Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet. |
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. |
Input Types
None.
Return Types
This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType.
Example
-------------------------- Example 1 --------------------------
New-CsNetworkRegionLink -Identity NA_EMEA -NetworkRegionID1 NorthAmerica -NetworkRegionID2 EMEA -BWPolicyProfileID LowBWLimits
This example creates a new network region link named NA_EMEA to link the regions NorthAmerica and EMEA. The region link name is specified as the value for the Identity parameter. (This will automatically be assigned as the value of the NetworkRegionLinkID.) The two network regions being linked are required parameters for creating the link, in this case the regions named NorthAmerica and EMEA. In this example we’ve also assigned a value to the BWPolicyProfile parameter. This will assign the bandwidth limitations defined in that bandwidth policy profile (LowBWLimits) to connections between these regions. If no BWPolicyProfileID is supplied, there are no bandwidth limitations on connections between these two regions. (There could still be limitations between sites. For details, see the New-CsNetworkSite Help topic.)