次の方法で共有

  • [アーティクル]

Set-CsVoiceRoute

 

トピックの最終更新日: 2012-03-25

ボイス ルートを変更します。ボイス ルートには、エンタープライズ VoIP ユーザーからの呼び出しを公衆交換電話網 (PSTN) または構内交換機 (PBX) の電話番号へルーティングする方法についての Microsoft Lync Server 2010 に対する指示が含まれます。

構文

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) の使用法を介して、音声ポリシーに関連付けられます。ボイス ルートには、指定されたボイス ルートを介してルーティングされる電話番号を識別する正規表現が含まれます。正規表現に一致する電話番号が、そのルートを介してルーティングされます。

このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Set-CsVoiceRoute コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsVoiceRoute"}

パラメーター

パラメーター 必須かどうか 型 説明

Identity

省略可能

XdsIdentity

ボイス ルートの一意の ID です。(Test Route など、ルート名にスペースがある場合は、全文字列をかっこで囲む必要があります。)

Instance

省略可能

ルート

個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 このオブジェクトは、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 ゲートウェイか 仲介サーバー のサービス ID である必要があります。この値が 仲介サーバー を参照できるのは、仲介サーバー が Microsoft Office Communications Server 2007 または Microsoft Office Communications Server 2007 R2 に対して構成されている場合に限ります。Lync Server 2010 の場合、PSTN ゲートウェイを使用する必要があります。サービス ID は、ServiceRole:FQDN という形式の文字列です。ServiceRole はサービス ロール名 (PSTNGateway)、FQDN はサーバーのプールまたは IP アドレスの完全修飾ドメイン名 (FQDN) です。たとえば、PSTNGateway:redmondpool.litwareinc.com です。サービス ID は、Get-CsService | Select-Object Identity コマンドを呼び出すと取得できます。

ボイス ルートを変更して PstnGatewayList 一覧を空のままにした場合、またはこの変更によりこの一覧からすべての項目が削除された場合、ユーザーが PSTN 通話できないという警告メッセージが表示されます。

PstnUsages

省略可能

このボイス ルートに適用できる (ローカルや市外通話などの) PSTN 使用法一覧。PSTN 使用法は、既存のものである必要があります (PSTN 使用法は Get-CsPstnUsage コマンドレットを呼び出すことで取得できます)。

ボイス ルートを変更して PstnUsages 一覧を空のままにした場合、またはこの変更によりすべての PSTN 使用法がこの一覧から削除された場合、ユーザーが PSTN 通話できないという警告メッセージが表示されます。

SuppressCallerId

省略可能

ブール値

発信通話で発信者 ID を表示するかどうかを決定します。このパラメーターが True に設定されていると、発信者 ID が表示されません。実際の ID の代わりに AlternateCallerId の値が表示されます。SuppressCallerId を True に設定する場合、AlternateCallerId 値を指定する必要があります。

Confirm

省略可能

SwitchParameter

コマンドの実行前に確認メッセージを表示します。

Force

省略可能

SwitchParameter

変更を行う前に表示されるように設定されているすべての確認メッセージを表示しないようにします。

WhatIf

省略可能

SwitchParameter

実際にコマンドを実行せずに、コマンドの実行結果がわかります。

入力の種類

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 という ID を持つボイス ルートが変更され、このボイス ルートの使用法一覧に PSTN 使用法 (市外通話) が追加されます。市外通話は、グローバル PSTN 使用法一覧に設定する必要があります (この一覧は、Get-CsPstnUsage を呼び出すと取得できます)。

-------------------------- 例 3 --------------------------

$x = (Get-CsPstnUsage).Usage
Set-CsVoiceRoute -Identity Route1 -PstnUsages @{replace=$x}

この例では、Route1 というボイス ルートを変更して、そのルートのPSTN 使用法の一覧を、組織の既存の使用法すべてに設定しています。この例では、1 番目のコマンドを実行してグローバル PSTN の使用法一覧を取得しています。Get-CsPstnUsage の呼び出しがかっこで囲まれていることに注意してください。これは、PSTN 使用法情報が含まれるオブジェクトを最初に取得することを示しています (グローバルの PSTN 使用法は 1 つしかないため、オブジェクトが 1 つだけ取得されます)。次に、このオブジェクトの Usage プロパティを取得しています。PSTN 使用法一覧を含んだ Usage プロパティを、変数 $x に代入しています。この例の 2 行目で、Route1 という ID を持つボイス ルートを変更するために、Set-CsVoiceRoute を呼び出しています。PstnUsages パラメーターに渡される値 @{replace=$x}。この値により、このルートの PstnUsages 一覧のすべてを $x の内容に置き換えるよう指示されます。$x には、行 1 で取得した PSTN 使用法が含まれます。

-------------------------- 例 4 --------------------------

$x = Get-CsVoiceRoute -Identity Route1
$x.Name = "RouteA"
Set-CsVoiceRoute -Instance $x

この一連のコマンドによって、Route1 の ID を持つボイス ルートの Name プロパティが RouteA に変更されます。Name プロパティを変更すると、Identity プロパティも自動的に変更され、この例では RouteA に変更されます。

最初の行で、Get-CsVoiceRoute が呼び出されて、Route1 の ID を持つボイス ルートが取得されます。戻されたオブジェクトは変数 $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 という Identity を持つゲートウェイのサーバーの役割が設定されます。この例の 1 行目では、Get-CsVoiceRoute を呼び出して、変更するボイス ルート (この場合は Route1) を取得しています。次に、Route1 の PstnGatewayList プロパティに対し、Add メソッドを呼び出します。追加するサービスの Identity を Add メソッドに渡しています。最後に、Set-CsVoiceRoute を呼び出して、Instance パラメーターに変数 $y を渡しています。これにより、新しく追加された PSTN ゲートウェイで、Route1 ($y に格納済み) が更新されます。