Test-CsVoiceRoute
トピックの最終更新日: 2012-03-26
ボイス ルート番号パターンに対して電話番号をテストし、入力された番号がルートの番号パターンと一致するかどうかを示すブール値 (true/false) を戻します。番号パターンは、エンタープライズ VoIP ユーザーからの通話を公衆交換電話網 (PSTN) または構内交換機 (PBX) の電話番号にルーティングする方法を Microsoft Lync Server 2010 に指示するために、ボイス ルートで使用されるプロパティの 1 つです。
構文
Test-CsVoiceRoute -Route <Route> -TargetNumber <PhoneNumber> [-Force <SwitchParameter>]
解説
ボイス ルートには、指定されたボイス ルートを介してルーティングされる電話番号を識別する正規表現が含まれます。正規表現に一致する電話番号が、そのルートを介してルーティングされます。このコマンドレットは、指定された電話番号が、ルートの番号パターン (NumberPattern プロパティ) に基づいて指定されたボイス ルート経由でルーティングされるかどうかを検証します。このコマンドレットを使用して、ルーティング問題のトラブルシューティングを行うことができます。または、単に特定のルートに対して電話番号を試し、結果が予想どおりになることを確認できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが、Test-CsVoiceRoute コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsVoiceRoute"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Route |
必須 |
ルート |
TargetNumber パラメーターで指定した番号をテストするときの対象となるボイス ルートへの参照を含んだオブジェクト。ボイス ルート オブジェクトを取得するには、Get-CsVoiceRoute コマンドレットを呼び出します。 完全なデータ型:Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route |
TargetNumber |
必須 |
電話番号 |
Route パラメーターで指定したボイス ルートをテストするときの対象となる電話番号。この番号は、E.164 形式 (たとえば、+14255551212) にする必要があります。 完全なデータ型:Microsoft.Rtc.Management.Voice.PhoneNumber |
Force |
省略可能 |
スイッチ パラメーター |
コマンドレットの実行時に発生する可能性のある、確認メッセージまたは致命的ではないエラー メッセージが表示されないようにします。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route オブジェクト。ボイス ルート オブジェクトのパイプライン入力を受け入れます。
戻り値の種類
Microsoft.Rtc.Management.Voice.VoiceRouteTestResult 型のオブジェクトを戻します。
例
-------------------------- 例 1 --------------------------
$vr = Get-CsVoiceRoute -Identity testroute
Test-CsVoiceRoute -TargetNumber "+14255551212" -Route $vr
このコマンドでは、指定された番号が指定されたルートのパターンと一致するかどうかを判別します。まず、Get-CsVoiceRoute コマンドレットを使用して testroute というボイス ルートを取得します。そのルートを、Test-CsVoiceRoute コマンドレットの Route パラメーターの値として使用します。また、テストする番号を TargetNumber パラメーターで指定します。出力は、ターゲット番号がそのルートのパターンと一致するかどうかを示すブール値です。
-------------------------- 例 2 --------------------------
Get-CsVoiceRoute -Identity testroute | Test-CsVoiceRoute -TargetNumber "+14255551212"
例 2 では、例 1 と同じアクションを実行します。ただし、この例の場合、そのアクションは 1 つのコマンドで実行されます。まず、Get-CsVoiceRoute を呼び出して Identity が testroute のボイス ルートを取得します。そのボイス ルートを Test-CsVoiceRoute コマンドレットにパイプ処理し、TargetNumber パラメーターで指定されている番号に対してそのルートをテストします。ルートはコマンドレットにパイプ処理されたため、Route パラメーターを指定する必要はありません。
-------------------------- 例 3 --------------------------
Get-CsVoiceRoute | Test-CsVoiceRoute -TargetNumber "+14255551212"
この例では、Lync Server 2010 展開内で定義されているすべてのボイル ルートのコレクションを取得し、Test-CsVoiceRoute コマンドレットの呼び出しで指定されている TargetNumber に対して各ルートの番号パターンをテストします。テストされるルートごとに、True または False が値として出力されます。
-------------------------- 例 4 --------------------------
$z = Get-CsVoiceRoute
foreach ($x in $z){$x.Identity; Test-CsVoiceRoute -TargetNumber "+14255551212" -Route $x}
この例は、複数のルートに対するボイス ルート テストの結果を取得する点で例 3 に似ています。ただし、例 3 の出力は単純な True/False 値の一覧であり、テスト結果が適用されるルートは明確に示されていません。この例では、その問題を解決しています(出力方法を改善するために行えることはありますが、この短い例では少なくともそのタスクを達成しています)。
まず、Get-CsVoiceRoute を呼び出してすべてのボイス ルートを取得し、そのコレクションを変数 $z に割り当てます。次の行で、foreach ループを開始します。このループは、コレクションの各メンバーを一度に 1 つ取得して変数 $x に割り当てます。$x (1 つのボイス ルートへの参照を含んでいる) に関して最初に実行する操作は、そのルートの ID($x.Identity) を表示することです。コマンドの次の部分は、Test-CsVoiceRoute の呼び出しです。このコマンドレットで、ターゲット番号に対してルート $x をテストします。最後の出力は、ボイス ルート ID の一覧 (書式設定はそれほど良くない) です。その後に、ターゲット番号がその ID のルートの番号パターンと一致したかどうかを示す true/false 値が続きます。