Share via

  • Article

Set-CsNetworkRegionLink

 

Topic Last Modified: 2012-03-25

Modifies a link between two network regions configured for call admission control (CAC).

Syntax

Set-CsNetworkRegionLink [-Identity <XdsGlobalRelativeIdentity>] [-BWPolicyProfileID <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-NetworkRegionID1 <String>] [-NetworkRegionID2 <String>] [-WhatIf [<SwitchParameter>]]

Set-CsNetworkRegionLink [-BWPolicyProfileID <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-NetworkRegionID1 <String>] [-NetworkRegionID2 <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

Regions within a network are linked through physical WAN connectivity. This cmdlet modifies a link between two regions, allowing you to change the regions that are linked as well as the bandwidth limitations on audio and video connections between those regions.

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

Parameters

Parameter Required Type Description

Identity

Optional

XdsGlobalRelativeIdentity

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

Instance

Optional

NetworkRegionLinkType

An object reference to a network region link. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType, which can be retrieved by calling Get-CsNetworkRegionLink.

BWPolicyProfileID

Optional

String

The Identity of the bandwidth policy profile that will define the limitations for this link. You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet.

NetworkRegionID1

Optional

String

The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 property.

NetworkRegionID2

Optional

String

The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 property.

Force

Optional

SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

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

Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType object. Accepts pipelined input of network region link objects.

Return Types

This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType.

Example

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

Set-CsNetworkRegionLink -Identity NA_EMEA -BWPolicyProfileID HighBWLimits

This example changes the bandwidth policy profile of the network region link named NA_EMEA to the HighBWLimits profile. The name of the network region link we want to modify is specified as the value for the Identity parameter. Next, we’ve assigned the value HighBWLimits to the BWPolicyProfile parameter. This will assign the bandwidth limitations defined in that bandwidth policy profile (HighBWLimits) to connections between these regions.