Set-CsVoiceRoute
上次修改主題的時間: 2012-03-25
修改語音路由。語音路由包含一些指示,告知 Microsoft Lync Server 2010 如何將 Enterprise Voice 使用者的來電轉接至公用交換電話網路 (PSTN) 或專用交換機 (PBX) 上的電話號碼。
語法
Set-CsVoiceRoute [-Identity <XdsGlobalRelativeIdentity>] [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]
Set-CsVoiceRoute [-AlternateCallerId <String>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-NumberPattern <String>] [-Priority <Int32>] [-PstnGatewayList <PSListModifier>] [-PstnUsages <PSListModifier>] [-SuppressCallerId <Nullable>] [-WhatIf [<SwitchParameter>]]
詳細描述
使用此指令程式修改現有的語音路由。語音路由透過公用交換電話網路 (PSTN) 使用方式而與語音原則產生關聯。語音路由包含規則運算式,可識別將經由指定的語音路由來轉接的電話號碼:符合規則運算式的電話號碼會經由此路由來轉接。
誰可以執行此 Cmdlet:下列群組的成員預設會獲授權可以在本機上執行 Set-CsVoiceRoute Cmdlet:RTCUniversalServerAdmins。若要傳回所有獲指派此 Cmdlet 的角色存取控制 (RBAC) 角色清單 (包括您自行建立的自訂 RBAC 角色),請在 Windows PowerShell 提示字元中執行下列命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsVoiceRoute"}
參數
參數 | 必要 | 類型 | 描述 |
---|---|---|---|
Identity |
選用 |
XdsIdentity |
語音路由的唯一識別身分 (如果路由名稱包含空格 (例如 Test Route),必須使用括弧括住整個字串)。 |
Instance |
選用 |
路由 |
允許您將物件參照傳遞給 Cmdlet,而不設定個別參數值。 此物件必須是 Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route 類型,呼叫 Get-CsVoiceRoute 即可擷取此物件。 |
AlternateCallerId |
選用 |
字串 |
如果 SuppressCallerId 參數設為 True,則會顯示 AlternateCallerId 參數的值以接收各通話方,而非來電者的實際號碼。此號碼應該為有效號碼,且可用來代表組織內的部門,例如「支援」或「人力資源」。 如果 SuppressCallerId 參數設為 False,則會忽略 AlternateCallerId 參數。 此值必須符合規則運算式 (\+)?[1-9]\d*(;ext=[1-9]\d*)?。換言之,值的開頭可以是加號 (+),但不一定必須是加號;必須由任何數目的數字組成;後面可以接著以 ;ext= 開頭的分機,最後再接著任何數目的數字(請注意,如果加入分機,則必須以雙引號括住字串)。 |
Description |
選用 |
字串 |
此電話路由用途的描述。 |
NumberPattern |
選用 |
字串 |
指定套用此路由之電話號碼的規則運算式。符合此模式的號碼將根據其餘路由設定來轉接。例如,預設號碼模式 [0-9]{10} 指定包含 0 到 9 之任何數字的 10 位數號碼。 |
Priority |
選用 |
Int32 |
數字可解析至多個語音路由。如果有多個路由,則優先順序可決定套用路由的順序。 |
PstnGatewayList |
選用 |
PSListModifier |
一個 中繼伺服器 可以與多個閘道產生關聯。此參數包含與此語音路由相關聯的閘道清單。此清單的每一個成員必須是 PSTN 閘道或 中繼伺服器 的服務識別碼。唯有在針對 Microsoft Office Communications Server 2007 或 Microsoft Office Communications Server 2007 R2 設定中繼伺服器後,此值才能參照中繼伺服器。對於 Lync Server 2010,PSTN 閘道是必須要使用的項目。Identity 服務是 ServiceRole:FQDN 格式的字串,其中 ServiceRole 為服務角色 (PSTNGateway) 的名稱,FQDN 是集區的完整網域名稱 (FQDN),或該伺服器的 IP 位址。例如,PSTNGateway:redmondpool.litwareinc.com. Service 識別可透過呼叫 Get-CsService | Select-Object Identity 命令來擷取。 如果您變更語音路由並讓 PstnGatewayList 清單空白,或者如果您做的變更是移除清單中的所有項目,就會收到警告訊息表示使用者無法進行 PSTN 通話。 |
PstnUsages |
選用 |
可套用至此語音路由的 PSTN 使用方式 (例如 Local 或 Long Distance)。PSTN 使用方式必須是現有的使用方式(您可以呼叫 Get-CsPstnUsage 指令程式來擷取 PSTN使用方式)。 如果您變更語音路由並讓 PstnUsages 清單空白,或者如果您做的變更是移除清單中的所有 PSTN 使用方式,就會收到警告訊息表示使用者無法進行 PSTN 通話。 |
|
SuppressCallerId |
選用 |
布林值 |
決定是否在撥出電話上顯示來電者的識別碼。如果此參數設為 True,則會隱藏來電者識別碼。將會顯示 AlternateCallerId 的值,而非實際識別碼。當 SuppressCallerId 設為 True 時,必須提供 AlternateCallerId 的值。 |
Confirm |
選用 |
切換參數 |
執行命令前先要求您確認。 |
Force |
選用 |
切換參數 |
隱藏任何會在進行變更之前顯示的確認提示。 |
WhatIf |
選用 |
切換參數 |
描述執行命令後的結果,但無須實際執行命令。 |
輸入類型
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route 物件。接受語音路由物件管線傳送的輸入。
傳回類型
Set-CsVoiceRoute 不會傳回值或物件。而是指令程式會設定 Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route 物件的執行個體。
範例
-------------------------- 範例 1 --------------------------
Set-CsVoiceRoute -Identity Route1 -Description "Test Route"
這個命令將 Route1 語音路由的 Description 設定為 "Test Route"。
-------------------------- 範例 2 --------------------------
Set-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"}
這個範例中的命令會修改識別身分為 Route1 的語音路由,將 PSTN 使用方式 Long Distance 加入此語音路由的使用方式清單。Long Distance 必須在通用 PSTN 使用方式的清單中 (呼叫 Get-CsPstnUsage 可擷取此清單)。
-------------------------- 範例 3 --------------------------
$x = (Get-CsPstnUsage).Usage
Set-CsVoiceRoute -Identity Route1 -PstnUsages @{replace=$x}
這個範例會修改名為 Route1 的語音路由,在該路由的 PSTN 使用方式清單中填入組織所有的現有電話使用方式。此範例的第一個命令會擷取通用 PSTN 使用方式的清單。請注意,Get-CsPstnUsage 的呼叫會以括弧括住,表示我們先擷取包含 PSTN 使用方式資訊的物件(由於只有一個 one--global--PSTN 使用方式,因此只會擷取一個物件)。命令接著擷取此物件的 Usage 屬性。該屬性 (包含 PSTN 使用方式的清單) 會指派給變數 $x。在這個範例的第二行中,呼叫 Set-CsVoiceRoute 以修改識別身分為 Route1 的語音路由。請注意傳遞給 PstnUsages 參數的值:@{replace=$x}。此值表示將此路由的 PstnUsages 清單中的所有內容取代為 $x 的內容,其中包含在第 1 行擷取的 PSTN 使用方式清單。
-------------------------- 範例 4 --------------------------
$x = Get-CsVoiceRoute -Identity Route1
$x.Name = "RouteA"
Set-CsVoiceRoute -Instance $x
這組命令會將識別身分為 Route1 之語音路由的 Name 屬性變更為 RouteA。變更 Name 屬性會自動變更 Identity 屬性,在此例中會變更為 RouteA。
在第一行中,呼叫 Get-CsVoiceRoute 擷取識別身分為 Route1 的語音路由。傳回的物件會儲存在變數 $x 中。接著將該物件的 Name 屬性指定為字串值 "RouteA"。最後,將物件 (包含在變數 $x 中) 傳遞到 Set-CsVoiceRoute 的 Instance 參數以進行變更。
-------------------------- 範例 5 --------------------------
$y = Get-CsVoiceRoute -Identity Route1
$y.PstnGatewayList.Add("PstnGateway:192.168.0.100")
Set-CsVoiceRoute -Instance $y
這個範例會修改名為 Route1 的語音路由,並在該路由的 PSTN 閘道路由清單 (PstnGatewayList) 中填入識別身分為 PstnGateway:192.168.0.100 的閘道伺服器角色。在此範例的第一行中,呼叫 Get-CsVoiceRoute 擷取我們要修改的語音路由,在這個例子中是 Route1。接著在 Route1 的 PstnGatewayList 屬性上呼叫 Add 方法。我們將 Add 方法傳遞到我們要新增之服務的 Identity。最後呼叫 Set-CsVoiceRoute,將 Instance 參數傳遞到變數 $y,這樣將會以新加入的 PSTN 閘道更新 Route1 (儲存在 $y 中)。