Remove-CsStaticRoutingConfiguration
トピックの最終更新日: 2012-03-25
指定した静的ルート構成設定のコレクションを削除します。
構文
Remove-CsStaticRoutingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
他のユーザーに SIP メッセージを送信する場合、配信される前に、そのメッセージが複数のサブネットやネットワークを通過することが必要になる場合があります。多くの場合、メッセージが通過するパスをルートと呼びます。ネットワークでは、動的ルートと静的ルートの 2 種類のルートがあります。動的ルートでは、サーバーは、アルゴリズムを使用してメッセージを転送する次の場所 (次ホップ) を判断します。静的ルートでは、メッセージ パスはシステム管理者があらかじめ設定します。メッセージがサーバーによって受信されると、サーバーは、メッセージのアドレスを確認し、そのメッセージを管理者があらかじめ設定した次ホップ サーバーに転送します。正しく構成されている場合、静的ルートによって、メッセージを適切なタイミングで正確に配信でき、サーバーにかかるオーバーヘッドが最小限になります。静的ルートの欠点は、ネットワーク障害が発生した場合に、メッセージが動的に再ルーティングされないという点です。
Microsoft Lync Server 2010 をインストールすると、静的ルートのグローバル コレクションが自動的に作成されます。(コレクションは作成されますが、そのコレクションに割り当てられたルートはありません)。また、このソフトウェアにより、サービス スコープに適用される追加のコレクションを作成できます (これらの新しいコレクションは、レジストラー サービスにのみ割り当てることができます)。後で変更する場合には、Remove-CsStaticRoutingConfiguration コマンドレットを使用して、サービス スコープに適用したコレクションを削除することができます。
また、グローバル コレクションに対して Remove-CsStaticRoutingConfiguration を実行することもできます。ただし、この場合、グローバル コレクションは削除されません。Lync Server 2010 では、グローバル コレクションを削除できないためです。代わりに、グローバル コレクションのすべてのプロパティが既定値にリセットされます。つまり、グローバル コレクションに割り当てられているルートがすべて削除されるということです。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Remove-CsStaticRoutingConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsStaticRoutingConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Xds Identity |
削除する静的ルート構成コレクションの一意の識別子です。サービス スコープで構成されているコレクションを削除するには、次のような構文を使用します。-Identity "service:Registrar:atl-cs-001.litwareinc.com"。 グローバル コレクションに対して、Remove-CsStaticRoutingConfiguration を実行することもできます。その場合、次の構文を使用します。-Identity global。ただし、グローバル コレクションが実際に削除されるわけではないので注意してください。代わりに、そのコレクションのプロパティが既定値にリセットされます。つまり、Route プロパティ内の項目すべてが削除されるということです。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings オブジェクト。Remove-CsStaticRoutingConfiguration は、パイプライン処理された静的ルート設定オブジェクトのインスタンスを受け入れます。
戻り値の種類
Remove-CsStaticRoutingConfiguration を実行しても、値やオブジェクトが戻されることはありません。代わりに、このコマンドレットは、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings オブジェクトのインスタンスを削除します。
例
-------------------------- 例 1 ------------------------
Remove-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com"
例 1 に示すコマンドを実行すると、Identity が service:Registrar:atl-cs-001.litwareinc.com の静的ルート構成コレクションが削除されます。
-------------------------- 例 2 ------------------------
Get-CsStaticRoutingConfiguration -Filter "service:*" | Remove-CsStaticRoutingConfiguration
例 2 では、サービス スコープに適用されているすべての静的ルート構成コレクションを削除します。これを実行するには、まず Get-CsStaticRoutingConfiguration と Filter パラメーターを使用します。フィルター値 "service:*" を設定して、戻されるデータを "service:" という文字列から始まる Identity を持つコレクションに限定します。このフィルター処理したコレクションを Remove-CsStaticRoutingConfiguration にパイプ処理し、コレクション内の各項目を削除します。
-------------------------- 例 3 ------------------------
Get-CsStaticRoutingConfiguration | Where-Object {$_.Route.Count -eq 0} | Remove-CsStaticRoutingConfiguration
例 3 では、実際のルートに割り当てられていない静的ルート構成コレクションをすべて削除する方法について示します。このタスクを実行するには、まず Get-CsStaticRoutingConfiguration を呼び出し、組織内で使用中のすべての静的ルート コレクションに関する情報を戻します。次に、このコレクションを Where-Object コマンドレットにパイプ処理して、ルート数 (Route.Count) が 0 と等しいコレクションのみを抽出します。次に、フィルターした情報を Remove-CsStaticRoutingConfiguration にパイプ処理して、どのルートも割り当てられていない各コレクションを削除します。