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:下列群組的成員預設會獲授權可以在本機上執行 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 屬性。提供給此參數的值會儲存在 AlternatePath 屬性,以使路徑項目取代為 Audio 的 BWPolicyModality 值。 如果為此參數提供值,便無法指定 BWAlternatePaths 參數的值。 如果您的所有電話都是網際網路電話,此值必須設為 True,無論頻寬設定為何。 |
BWAlternatePaths |
選用 |
PSListModifier |
包含若媒體要求無法利用慣用路徑來完成 (例如,若已超過該路徑的限制),是否要允許替代連線路徑之資訊的物件清單。替代路徑物件的類型必須是 Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType。您可以呼叫 New-CsNetworkBWAlternatePath 指令程式來建立此類型的物件。 |
BypassID |
選用 |
字串 |
全域唯一識別碼 (GUID)。這個 GUID 可用來將網路區域對應至 CAC 或增強型9-1-1 (E9-1-1) 網路組態內的略過媒體設定 (對 New-CsNetworkMediaBypassConfiguration 呼叫時使用這個 BypassID 值)。 此參數會在建立區域時 (透過呼叫 New-CsNetworkRegion 指令程式) 自動產生。不建議變更此值。如果指定值,該值必須是 GUID 的格式 (例如,3b24a047-dce6-48b2-9f20-9fbff17ed62a)。您將收到一則確認,提示您確認要手動設定此值。 |
CentralSite |
選用 |
字串 |
執行頻寬原則服務的中央網站。必須啟用此服務,才能使用 CAC。此服務在前端伺服器或 Standard Edition Server 上執行。 |
Description |
選用 |
字串 |
描述區域的字串。比起單獨使用 Identity 來說,此參數可用來提供更多此區域之用途的描述性說明。 |
VideoAlternatePath |
選用 |
布林值 |
此參數會決定適當的頻寬不存在於主要路徑時,是否要透過替代路徑路由傳送視訊通話。 此參數會填入 BWAlternatePaths 屬性。提供給此參數的值會儲存在 AlternatePath 屬性,以使路徑項目取代為 Video 的 BWPolicyModality 值。 如果為此參數提供值,便無法指定 BWAlternatePaths 參數的值。 如果您的所有電話都是網際網路電話,此值必須設為 True,無論頻寬設定為何。 |
Force |
選用 |
切換參數 |
隱藏任何會在進行變更之前顯示的確認提示。 |
WhatIf |
選用 |
切換參數 |
描述執行命令後的結果,但無須實際執行命令。 |
Confirm |
選用 |
切換參數 |
執行命令前先要求您確認。 |
輸入類型
Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType 物件。接受網路區域物件的管線傳送資料。
傳回類型
這個指令程式不會傳回值。它會修改 Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType 類型的物件。
範例
-------------------------- 範例 1 --------------------------
Set-CsNetworkRegion -Identity NorthAmerica -Description "North American Region"
在此範例中,會修改名為 NorthAmerica 的網路區域,並針對 Description 參數指定 "North American Region" 的值。如果 Description 已存在於 NorthAmerica 地區,此命令便會利用此值將其複寫。如果尚未設定 Description,則此命令會設定之。
-------------------------- 範例 2 --------------------------
Set-CsNetworkRegion -Identity EMEA -VideoAlternatePath $False
此範例會修改名為 EMEA 的網路區域,並為其指定新的視訊替代路徑設定。為達成此目的,會呼叫 Set-CsNetworkRegion 來傳送 EMEA 的 Identity。然後指定 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 將在整個集合中循環執行,一次一個,執行下列大括號中的動作。在此例中,動作要呼叫 Set-CsNetworkRegion (其 Identity 為 Asia) 來設定 Asia 區域的屬性。下一個參數是 BWAlternatePaths。我們將 @{add=$_} 值傳送給此參數。變數 $_ 代表集合中目前的項目,在此案例中為目前的替代路徑。值的 @{add=} 部分會將該項目新增至適用於 Asia 區域的 BWAlternatePaths 集合。