Set-CsSipResponseCodeTranslationRule
トピックの最終更新日: 2012-03-27
既存の SIP 応答コードの変換ルールを変更します。これらのルールを使用して、管理者は 400 ～ 699 の範囲の値を持つ SIP 応答コードを Microsoft Lync Server 2010 によって使用される値にマップできます。
構文
Set-CsSipResponseCodeTranslationRule [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Priority <Int32>] [-ReceivedISUPCauseValue <Int32>] [-ReceivedResponseCode <Int32>] [-TranslatedResponseCode <Int32>] [-WhatIf [<SwitchParameter>]]
Set-CsSipResponseCodeTranslationRule [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Priority <Int32>] [-ReceivedISUPCauseValue <Int32>] [-ReceivedResponseCode <Int32>] [-TranslatedResponseCode <Int32>] [-WhatIf [<SwitchParameter>]]
解説
SIP トランキングは、ボイス オーバー インターネット プロトコル (VoIP) ネットワーク (エンタープライズ VoIP など) と公衆交換電話網 (PSTN) を接続する方法を提供します。Lync Server 2010 では、仲介サーバー はトランキング ピアを使用して PSTN ネットワークと対話します。発信通話が PSTN ネットワークで失敗すると、ISDN User Part (ISUP) の原因コードが自動的に生成されます。たとえば、PSTN ゲートウェイは、原因コード 34 を送信し、通話を完了するための使用可能な回線またはチャネルが存在しないと示すことがあります。仲介サーバー のトランキング ピアがその ISUP 原因コードを受け取ると、そのコードは SIP 応答コードに変換されて、仲介サーバー 自体に送信されます。その結果、Lync Server は、これらの応答コードを使用して、発信ルーティングを判断します。たとえば、障害の発生しているゲートウェイは自動的に "優先度が低い" 状態に割り当てられ、これにより障害の発生しているゲートウェイのユーザーが最小限に抑えられ、発信が正常に完了する機会が最大となります。
ただし、Lync Server が使用している、ISUP 原因コードから SIP 応答コードへのマッピングに関して推奨される変換を、すべてのゲートウェイが使用しているわけではありません。これらのゲートウェイには、管理者は CsSipResponseCodeTranslationRule コマンドレットを使用して、Lync Server によって使用される SIP 応答コードにゲートウェイ SIP 応答コード (使用可能な場合、ISUP 原因コードとともに) をマップできます。たとえば、あるゲートウェイは ISUP 原因コード 34 ("No circuit/channel is available"、"使用可能な回線またはチャネルが存在しない") を、SIP 応答コード 486 ("Busy here"、"話中") にマップすることがあります。応答コード 486 に基づいて、通話を完了するために Lync Server の発信ルーティング ロジックが新しいゲートウェイを検索するよう試みることはありません。
ただし、Lync Server では、代わりに SIP 応答コード 486 を SIP 応答コード 503 にマップする必要があります。応答コード 503 は、Lync Server の発信ルーティング ロジックの再試行メカニズムを起動し、通話を完了するためにシステムによって別のゲートウェイが検索されます。この状況に対処するため、ISUP 原因コード 34 と SIP 応答コード 486 の組み合わせを SIP 応答コード 503 にマップする変換ルールを作成できます。
Set-CsSipResponseCodeTranslationRule を使用すると、組織での使用向けに以前に構成した変換ルールを変更できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが、Set-CsSipResponseCodeTranslationRule コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsSipResponseCodeTranslationRule"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Xds Identity |
変更する変換ルールの一意の識別子。変換ルールの Identity は、次の 2 つの部分で構成されています。ルールの構成を実行したスコープと、ルールを作成したときにルールに対して割り当てられた名前です。たとえば、グローバル スコープで作成された Rule404 という名前の変換ルールの Identity は、次のようになります。global/Rule404。 |
Instance |
省略可能 |
整数 |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
TranslatedResponseCode |
必須 |
整数 |
ReceivedResponseCode および ReceivedISUPCauseCode の変換後の SIP 応答コードの値。変換後の応答コードには、400 ～ 699 の範囲の整数値を指定できます。 |
Priority |
整数 |
変換ルールの相対的な優先度。ルールは割り当てられている優先度に従って処理されます。処理が最初のルールの優先度は 0 で、処理が 2 番目のルールの優先度は 1 で、以降も同様になります。 |
|
ReceivedISUPCauseValue |
省略可能 |
整数 |
INVITE メッセージへの応答時にゲートウェイによって使用される SIP 応答メッセージに示す必要がある、ISDN User Part (ISUP) コードの値。値 -1 は、変換ルールの実行時に SIP 応答コードだけが使用され、ISUP 原因コードは無視されることを示します。 |
ReceivedResponseCode |
省略可能 |
整数 |
INVITE メッセージへの応答時にゲートウェイによって使用される SIP 応答コードの値。応答コードには、400 ～ 699 の範囲の整数値を指定できます。コマンドレットは 400 未満の整数値を受け入れますが、これらの値は最終応答としては認識されません。そのため、変換ルールは使用されません。値 0 は、変換ルールの実行時に ISUP 原因コードが使用されて、SIP 応答コードは無視されることを示します。 |
Force |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
|
WhatIf |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
|
Confirm |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated オブジェクト。Set-CsSipResponseCodeTranslationRule は、SIP 応答コード変換ルール オブジェクトのパイプ処理されたインスタンスを受け入れます。
戻り値の種類
Set-CsSipResponseCodeTranslationRule は、値もオブジェクトも戻しません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated オブジェクトのインスタンスを変更します。
例
-------------------------- 例 1 ------------------------
Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -ReceivedISUPCauseValue 477
例 1 のコマンドで、PstnGateway:192.168.0.240/Rule404 とい う Identity を持つ変換ルールの ReceivedISUPCauseValue プロパティを変更します。
-------------------------- 例 2 ------------------------
Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -Priority 0
例 2 では、PstnGateway:192.168.0.240/Rule404 という Identity を持つ変換ルールを優先度が最も高いルール、つまり最初に処理されるルールとしてマークします。これを行うため、Priority を 0 に設定しています。
-------------------------- 例 3 ------------------------
Get-CsSipResponseCodeTranslationRule | Set-CsSipResponseCodeTranslationRule -ReceivedISUPCauseValue -1
例 3 は、組織での使用向けに構成されているすべての変換ルールの ReceivedISUPCauseValue プロパティを -1 に設定する方法を示しています。この設定により、ルールの変換時に ISUP 原因コードは無視されます。これを行うため、パラメーターを指定せずにコマンドでまず Get-CsSipResponseCodeTranslationRule を呼び出して、現在使用中のすべての SIP 応答コード変換ルールのコレクションを戻します。次に、このコレクションを Set-CsSipResponseCodeTranslationRule コマンドレットにパイプ処理し、コレクション内の各項目の ReceivedISUPCauseValue プロパティを変更します。