Export (0) Print
Expand All
Expand Minimize

Set-CsNetworkRegion

 

Topic Last Modified: 2012-03-24

Modifies an existing network region. Network regions represent network hubs or backbones in an enterprise network.

Set-CsNetworkRegion [-Identity <XdsGlobalRelativeIdentity>] [-AudioAlternatePath <$true | $false>] [-BWAlternatePaths <PSListModifier>] [-BypassID <String>] [-CentralSite <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-VideoAlternatePath <$true | $false>] [-WhatIf [<SwitchParameter>]]
Set-CsNetworkRegion [-AudioAlternatePath <$true | $false>] [-BWAlternatePaths <PSListModifier>] [-BypassID <String>] [-CentralSite <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-VideoAlternatePath <$true | $false>] [-WhatIf [<SwitchParameter>]]

A network region interconnects various parts of a network across multiple geographic areas. Every network region must be associated with a central site. The central site is the data center site on which the call admission control (CAC) bandwidth policy service is running. Use this cmdlet to modify an existing network region, including settings that determine whether alternate paths are allowed for audio and video connections, and that associate the sites within the region with a media bypass configuration.

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

 

Parameter Required Type Description

Identity

Optional

XdsGlobalRelativeIdentity

The unique identifier of the network region you want to modify. The Identity will be in the form of a string that uniquely identifies that region.

Instance

Optional

PSObject

A reference to a network region object. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType and can be retrieved by calling Get-CsNetworkRegion.

AudioAlternatePath

Optional

Boolean

This parameter determines whether audio calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path.

This parameter populates the BWAlternatePaths property. The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Audio.

If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter.

If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings.

BWAlternatePaths

Optional

PSListModifier

A list of objects that contain information about whether alternate connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. You can create objects of this type by calling the New-CsNetworkBWAlternatePath cmdlet.

BypassID

Optional

String

A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or Enhanced 9-1-1 (E9-1-1) network configuration. (Use this BypassID value in the call to New-CsNetworkMediaBypassConfiguration.)

This parameter can be auto-generated when the region is created (by calling the New-CsNetworkRegion cmdlet). Changing this value is not recommended. If you do specify a value, it must be in the form of a GUID (for example, 3b24a047-dce6-48b2-9f20-9fbff17ed62a). You will receive a confirmation prompting you to verify that you want to manually set this value.

CentralSite

Optional

String

The central site running the bandwidth policy service. This service must be enabled in order to use CAC. This service runs on the Front End Server or the Standard Edition server.

Description

Optional

String

A string that describes the region. This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone.

VideoAlternatePath

Optional

Boolean

This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path.

This parameter populates the BWAlternatePaths property. The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Video.

If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter.

If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings.

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.

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

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

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

Set-CsNetworkRegion -Identity NorthAmerica -Description "North American Region"

In this example the network region named NorthAmerica is modified. The Description parameter is given a value of "North American Region." If a Description existed on the NorthAmerica region, this command overwrites it with this value. If no Description had been set, this command sets it.

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

Set-CsNetworkRegion -Identity EMEA -VideoAlternatePath $False

This example modifies the network region named EMEA and gives it a new video alternate path setting. To do this we call Set-CsNetworkRegion, passing an Identity of EMEA. We then specify the VideoAlternatePath parameter, passing the value $False. Setting VideoAlternatePath to False indicates that if adequate bandwidth is not available, the video call will not be routed to an alternate path; instead, it will simply not be completed.

-------------------------- Example 3 --------------------------

$a = Get-CsNetworkRegion -Identity NorthAmerica
$a.BWAlternatePaths | foreach {Set-CsNetworkRegion -Identity Asia -BWAlternatePaths @{add=$_}}

Example 3 assigns the same set of alternate path settings to the Asia network region that has been set for the NorthAmerica region. The first line in this example retrieves an instance of the network region NorthAmerica and assigns it to variable $a. The second line begins by retrieving the contents of the BWAlternatePaths property or the NorthAmerica region (stored in variable $a): $a.BWAlternatePaths. This will be a collection of all the alternate path settings in the NorthAmerica region.

The next thing we do is pipe that collection of settings to the foreach function. Foreach will cycle through the collection one item at a time, performing the actions in the following curly braces. In this case the action is to call Set-CsNetworkRegion with an Identity of Asia to set the properties of the Asia region. The next parameter is BWAlternatePaths. We pass the value @{add=$_} to this parameter. The variable $_ represents the current item in the collection, in this case the current alternate path. The @{add=} portion of the value adds that item to the collection of BWAlternatePaths for the Asia region.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft