Set-CsNetworkRegion
上一次修改主题： 2012-03-24
修改现有的网络区域。网络区域表示企业网络中的网络中心或主干网络。
语法
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>]]
详细说明
网络区域将跨多个地理区域的网络的各个部分相互连接起来。每个网络区域都必须与中央站点关联。中央站点是运行呼叫允许控制 (CAC) 带宽策略服务的数据中心站点。使用此 cmdlet 可修改现有的网络区域，包括确定是否允许音频和视频连接使用备用路径以及将区域内的站点与媒体绕过配置相关联的设置。
谁能运行此 cmdlet：默认情况下，以下各组的成员有权在本地运行 Set-CsNetworkRegion cmdlet：RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表（包括您自己创建的任何自定义 RBAC 角色），请从 Windows PowerShell 提示符处运行以下命令：
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsNetworkRegion\b"}
参数
| 参数 | 必需 | 类型 | 描述 |
|---|---|---|---|
Identity |
可选 |
XdsGlobalRelativeIdentity |
要修改的网络区域的唯一标识符。Identity 将采用唯一标识该区域的字符串的形式。 |
Instance |
可选 |
PSObject |
对网络区域对象的引用。该对象的类型必须是 Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType，可以通过调用 Get-CsNetworkRegion 来检索该对象类型。 |
AudioAlternatePath |
可选 |
布尔值 |
此参数确定当主要路径带宽不足时，是否通过备用路径路由音频呼叫。 此参数填充 BWAlternatePaths 属性。为此参数提供的值存储在 BWPolicyModality 值为 Audio 的备用路径元素的 AlternatePath 属性中。 如果为此参数提供值，则不能为 BWAlternatePaths 参数指定值。 如果您的某一呼叫是 Internet 呼叫，则无论带宽设置为何，该值必须设置为 True。 |
BWAlternatePaths |
可选 |
PSListModifier |
对象列表，这些对象包含有关当无法通过首选路径完成媒体请求时（例如，已超过该路径的限制），是否允许使用备用连接路径的信息。备用路径对象的类型必须为 Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType。可以通过调用 New-CsNetworkBWAlternatePath cmdlet 创建此类型的对象。 |
BypassID |
可选 |
字符串 |
全局唯一标识符 (GUID)。此 GUID 用于将网络区域映射到 CAC 或增强型 9-1-1 (E9-1-1) 网络配置中的媒体绕过设置。（请在调用 New-CsNetworkMediaBypassConfiguration 时使用此 BypassID 值。） 此参数可以在创建区域（通过调用 New-CsNetworkRegion cmdlet）时自动生成。建议不要更改此值。如果确实要指定一个值，那么该值必须采用 GUID 形式（例如 3b24a047-dce6-48b2-9f20-9fbff17ed62a）。您将收到确认，提示您确认是否要手动设置该值。 |
CentralSite |
可选 |
字符串 |
运行带宽策略服务的中央站点。必须启用该服务才能使用 CAC。此服务在前端服务器或 Standard Edition Server 上运行。 |
Description |
可选 |
字符串 |
用于描述区域的字符串。此参数可用于说明区域的用途，与只用 Identity 表示相比，该说明更具描述性。 |
VideoAlternatePath |
可选 |
布尔值 |
此参数确定当主要路径带宽不足时，是否通过备用路径路由视频呼叫。 此参数填充 BWAlternatePaths 属性。为此参数提供的值存储在 BWPolicyModality 值为 Video 的备用路径元素的 AlternatePath 属性中。 如果为此参数提供值，则不能为 BWAlternatePaths 参数指定值。 如果您的某一呼叫是 Internet 呼叫，则无论带宽设置为何，该值必须设置为 True。 |
Force |
可选 |
开关参数 |
在进行更改前取消可能另外显示的任何确认提示。 |
WhatIf |
可选 |
开关参数 |
描述如果执行命令会发生什么情况（无需实际执行命令）。 |
Confirm |
可选 |
开关参数 |
在执行命令之前提示您进行确认。 |
输入类型
Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType 对象。接受通过管道传递的网络区域对象的输入。
返回类型
此 cmdlet 不会返回值。它可修改类型为 Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType 的对象。
示例
-------------------------- 示例 1 --------------------------
Set-CsNetworkRegion -Identity NorthAmerica -Description "North American Region"
在此示例中，修改名为 NorthAmerica 的网络区域。为 Description 参数提供了值“North American Region”。如果 NorthAmerica 区域已存在 Description，此命令将使用该值覆盖它。如果尚未设置 Description，此命令会进行设置。
-------------------------- 示例 2 --------------------------
Set-CsNetworkRegion -Identity EMEA -VideoAlternatePath $False
此示例修改名为 EMEA 的网络区域，并为其提供一个新的视频备用路径设置。为执行此操作，我们调用 Set-CsNetworkRegion，并向其传递 Identity EMEA。然后指定 VideoAlternatePath 参数并传递值 $False。将 VideoAlternatePath 设置为 False 表明，如果没有足够的可用带宽，视频呼叫将不会路由至备用路径，最终无法完成。
-------------------------- 示例 3 --------------------------
$a = Get-CsNetworkRegion -Identity NorthAmerica
$a.BWAlternatePaths | foreach {Set-CsNetworkRegion -Identity Asia -BWAlternatePaths @{add=$_}}
示例 3 向 Asia 网络区域分配与 NorthAmerica 区域相同的备用路径设置集。此示例中的第一行检索网络区域 NorthAmerica 的一个实例，并将其分配给变量 $a。第二行首先检索 BWAlternatePaths 属性或 NorthAmerica 区域（存储在变量 $a 中）的内容：$a.BWAlternatePaths。检索结果应该是 NorthAmerica 区域中所有备用路径设置的集合。
接下来，我们将此设置集合通过管道传递到 foreach 函数。foreach 每次循环选择该集合中的一项，并执行后面的花括号中的操作。在此示例中，该操作是调用 Identity 为 Asia 的 Set-CsNetworkRegion 以设置 Asia 区域的属性。下一个参数是 BWAlternatePaths。向此参数传递值 @{add=$_}。变量 $_ 代表该集合中的当前项，在此示例中是当前备用路径。值的 @{add=} 部分会将该项添加到 Asia 区域的 BWAlternatePaths 集合。