次の方法で共有

  • [アーティクル]

Set-CsStaticRoutingConfiguration

 

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

既存の静的ルーティングの構成設定のコレクションを変更します。

構文

Set-CsStaticRoutingConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]]

Set-CsStaticRoutingConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Route <PSListModifier>] [-WhatIf [<SwitchParameter>]]

解説

他のユーザーに SIP メッセージを送信する場合、配信される前に、そのメッセージが複数のサブネットやネットワークを通過することが必要になる場合があります。メッセージが通過するパスは多くの場合、ルートと呼ばれます。ネットワークでは、動的ルートと静的ルートの 2 種類のルートがあります。動的ルートでは、サーバーは、アルゴリズムを使用してメッセージを転送する次の場所 (次ホップ) を判断します。静的ルートでは、メッセージ パスはシステム管理者があらかじめ設定します。メッセージがサーバーによって受信されると、サーバーは、メッセージのアドレスを確認し、そのメッセージを管理者があらかじめ設定した次ホップ サーバーに転送します。正しく構成されている場合、静的ルートによって、メッセージを適切なタイミングで正確に配信でき、サーバーにかかるオーバーヘッドが最小限になります。静的ルートの欠点は、ネットワーク障害発生時にメッセージが動的に再ルーティングされない点です。

Microsoft Lync Server 2010 をインストールすると、静的ルートのグローバル コレクションが自動的に作成されます (コレクションは作成されますが、そのコレクションに割り当てられたルートはありません)。また、このソフトウェアにより、サービス スコープに適用される追加のコレクションを作成できます (これらの新しいコレクションは、レジストラー サービスにのみ割り当てることができます)。Set-CsStaticRoutingConfiguration コマンドレットにより、既存の静的ルーティング コレクションのプロパティ値を変更できます。つまり、このコマンドレットを使用して新しいルートをコレクションに追加するか、または既存のルートをコレクションから削除することができます。

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

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

パラメーター

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

Identity

省略可能

Xds Identity

変更する静的ルーティング構成コレクションの一意の識別子です。グローバル コレクションを変更するには、次の構文を使用します。-Identity global。サービス スコープに適用されたコレクションを変更するには、次のような構文を使用します。-Identity "service:Registrar:atl-cs-001.litwareinc.com"。ID の指定時にワイルドカードを使用することはできません。

このパラメーターが含まれていない場合、Set-CsStaticRoutingConfiguration は自動的にグローバル コレクションを変更します。

Instance

省略可能

RoutingSettings オブジェクト

個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。

Route

省略可能

PS リスト修飾子

コレクション内で維持される個々の静的ルートです。コレクションに追加するルートは別のコレクションからコピーするか、または New-CsStaticRoute コマンドレットを使用して作成する必要があります。コレクションからルートを削除するには、まずそのルートへのオブジェクト参照を作成する必要があります。詳細については、ヘルプ トピックの「例」セクションを参照してください。

Force

省略可能

スイッチ パラメーター

コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。

WhatIf

省略可能

スイッチ パラメーター

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

Confirm

省略可能

スイッチ パラメーター

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

入力の種類

Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings オブジェクトです。Set-CsStaticRoutingConfiguration は、静的ルーティング設定オブジェクトのインスタンスをパイプ処理で受け入れます。

戻り値の種類

Set-CsStaticRoutingConfiguration は、値またはオブジェクトを戻しません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings オブジェクトのインスタンスを構成します。

例

-------------------------- 例 1 ------------------------

$x = Get-CsStaticRoutingConfiguration -Identity global | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True}

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route @{Add=$x}

例 1 に示すコマンドでは、グローバル静的ルーティング コレクションからルートをコピーしてから、そのルートを 2 番目の静的ルーティング コレクション (service:Registrar:atl-cs-001.litwareinc.com という Identity のコレクション) に割り当てます。このタスクを実行するため、この例の最初のコマンドではグローバル コレクションに接続し、MatchUri が litwareinc.com であり、MatchOnlyPhoneUri が True に等しいルートへのオブジェクト参照を戻しています。

これを実行するため、Get-CsStaticRoutingConfiguration を呼び出し、グローバル ルーティング静的構成コレクションから情報を戻します。次に、このデータを Select-Object コマンドレットにパイプ処理し、ExpandProperty パラメーターを使用して Route プロパティの値を展開します。さらに、これらの展開された値 (コレクションに割り当てられた個々のルートを表します) を Where-Object コマンドレットにパイプ処理し、MatchUri プロパティが litwareinc.com に等しく、MatchOnlyPhoneUri プロパティが True に等しい 1 つのルートを選び出します。戻されたルートは、$x という名前の変数に格納されます。

ルートを取得した後、この例の 2 番目のコマンドで、そのルートを service: Registrar:atl-cs-001.litwareinc.com コレクションに追加しています。これを行うため、Set-CsStaticRoutingConfiguration を Route パラメーターを指定して呼び出しています。パラメーター値 @{Add=$x} は、変数 $x に格納されているルートを Route プロパティに保持されているルート コレクションに追加するよう、Set-CsStaticRoutingConfiguration に指示します。

-------------------------- 例 2 ------------------------

$x = Get-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True}

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route @{Remove=$x}

上記のコマンドでは、静的ルーティング コレクションからルートを削除しています。これを行うため、この例の最初のコマンドでは service:Registrar:atl-cs-001.litwareinc.com という Identity のコレクションに接続し、MatchUri が litwareinc.com であり、MatchOnlyPhoneUri が True に等しいルートへのオブジェクト参照を戻しています。そのために、Get-CsStaticRoutingConfiguration を呼び出し、service:Registrar:atl-cs-001.litwareinc.com コレクションから情報を戻します。次に、このデータを Select-Object コマンドレットにパイプ処理し、ExpandProperty パラメーターを使用して Route プロパティの値を展開します。さらに、これらの展開された値 (コレクションに割り当てられた個々のルートを表します) を Where-Object コマンドレットにパイプ処理し、MatchUri プロパティが litwareinc.com に等しく、MatchOnlyPhoneUri プロパティが True に等しい 1 つのルートを選び出します。戻されたルートは次に $x という名前の変数に格納されます。

ルートが取得された後、2 番目のコマンドではそのルートをコレクションから削除しています。これを行うため、Set-CsStaticRoutingConfiguration を Route パラメーターを指定して呼び出しています。パラメーター値 @{Remove=$x} は、変数 $x に格納されているルートを削除するよう、Set-CsStaticRoutingConfiguration に指示します。

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

Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route $Null

例 3 では、静的ルーティング構成コレクションに割り当てられたルートをすべて削除する方法を示しています。これを行うには、単純に Route パラメーターを指定して、パラメーター値を Null に設定します。このコマンドの実行後もコレクションは引き続き存在しますが、割り当てられたルートはなくなります。