Get-CsStaticRoutingConfiguration
トピックの最終更新日: 2012-03-23
組織内で使用する静的ルート構成設定に関する情報を戻します。
構文
Get-CsStaticRoutingConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsStaticRoutingConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]
解説
他のユーザーに SIP メッセージを送信する場合、配信される前に、そのメッセージが複数のサブネットやネットワークを通過することが必要になる場合があります。メッセージが通過するパスは多くの場合、ルートと呼ばれます。ネットワークでは、動的ルートと静的ルートの 2 種類のルートがあります。動的ルートでは、サーバーは、アルゴリズムを使用してメッセージを転送する次の場所 (次ホップ) を判断します。静的ルートでは、メッセージ パスはシステム管理者があらかじめ設定します。メッセージがサーバーによって受信されると、サーバーは、メッセージのアドレスを確認し、そのメッセージを管理者があらかじめ設定した次ホップ サーバーに転送します。正しく構成されている場合、静的ルートによって、メッセージを適切なタイミングで正確に配信でき、サーバーにかかるオーバーヘッドが最小限になります。静的ルートの欠点は、ネットワーク障害発生時にメッセージが動的に再ルーティングされない点です。
Microsoft Lync Server 2010 をインストールすると、静的ルートのグローバル コレクションが自動的に作成されます (コレクションは作成されますが、そのコレクションに割り当てられたルートはありません)。また、このソフトウェアにより、サービス スコープに適用される追加のコレクションを作成できます (これらの新しいコレクションは、レジストラー サービスにのみ割り当てることができます)。Get-CsStaticRoutingConfiguration コマンドレットでは、組織内で使用しているすべての静的ルート構成コレクションに関する情報を戻すことができます。これには、コレクションに割り当てられた各ルートに関する詳細な情報を戻す機能も含まれます。
このコマンドレットを実行できるユーザー: 既定では、Get-CsStaticRoutingConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalUserAdmins および RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsStaticRoutingConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
Xds Identity |
静的ルート構成コレクションの一意の識別子です。グローバル コレクションに関する情報を戻すには、次の構文を使用します。-Identity global。サービス スコープで構成されるコレクションに関する情報を取得するには、次のような構文を使用します。-Identity "service:Registrar:atl-cs-001.litwareinc.com"。Identity 指定時はワイルドカードを使用できないことに注意してください。ワイルドカードを使用する必要がある場合は、代わりに Filter パラメーターを使用します。 Identity または Filter パラメーターのどちらも指定されていない場合、Get-CsStaticRoutingConfiguration は、すべての静的ルート構成コレクションに関する情報を戻します。 |
Filter |
省略可能 |
文字列 |
これにより、戻される静的ルート構成コレクション (または複数のコレクション)を指定するときには、ワイルドカードを使用することができます。たとえば、次の構文はサービス スコープで構成されたすべての静的ルート コレクションを戻します。-Filter "service:*"。 Identity パラメーターと Filter パラメーターの両方を、同じコマンド内で使用することはできません。 |
LocalStore |
省略可能 |
スイッチ パラメーター |
静的ルート構成データを、中央管理ストア 本体ではなく、中央管理ストア のローカル レプリカから取得します。 |
入力の種類
なし。Get-CsStaticRoutingConfiguration は、パイプ処理による入力を受け入れません。
戻り値の種類
Get-CsStaticRoutingConfiguration は、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings オブジェクトのインスタンスを戻します。
例
-------------------------- 例 1 ------------------------
Get-CsStaticRoutingConfiguration
例 1 に示すコマンドでは、組織で使用するすべての静的ルート構成コレクションに関する情報が戻されます。
-------------------------- 例 2 ------------------------
Get-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com"
例 2 では、次の 1 つの静的ルート構成コレクションに関する情報が戻されます。Identity が "service:Registrar:atl-cs-001.litwareinc.com" であるコレクションです。
-------------------------- 例 3 ------------------------
Get-CsStaticRoutingConfiguration -Filter "service:*"
例 3 では、Filter パラメーターを使用して、サービス スコープに割り当てられた静的ルート構成コレクションに関する情報が戻されます。フィルター値 "service:*" は返りデータを文字列値 "service:" で始まる Identity のコレクションに制限します。
-------------------------- 例 4 ------------------------
Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route
上記のコマンドでは、組織で使用されるすべての静的ルート構成コレクションの詳細なルート情報が戻されます。これを行うため、まず Get-CsStaticRoutingConfiguration をパラメーターを指定せずに呼び出し、各静的ルート コレクションのすべての情報を戻します。次に、この情報を Select-Object コマンドレットへパイプ処理し、ExpandProperty パラメーターを使用して、Route プロパティの値を "展開" します。プロパティを展開すると、そのプロパティ内に格納されているすべてのオブジェクトと値が、読みやすい形式で画面に表示されます。
-------------------------- 例 5 ------------------------
Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route | Where-Object {$_.MatchOnlyPhoneUri -eq $True}
例 5 に示すコマンドでは、電話機の Uniform Resource Identifier (URI) のみに一致するよう構成されたすべての静的ルートに関する情報が戻されます。このタスクを実行するため、まず Get-CsStaticRoutingConfiguration をパラメーターを指定せずに呼び出し、すべての静的ルート構成コレクションとそれに関連付けられたルートを戻します。次に、このコレクションを Select-Object コマンドレットへパイプ処理し、ExpandProperty パラメーターを使用して、Route プロパティに格納されているすべてのオブジェクトを展開します。さらに、これらのルート オブジェクトを Where-Object コマンドレットへパイプ処理して、MatchOnlyPhoneUri プロパティが True に等しいルートのみを抽出します。