Remove-CsProxyConfiguration
トピックの最終更新日: 2012-03-25
プロキシ サーバー構成設定の既存のコレクションを削除します。
構文
Remove-CsProxyConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
Microsoft Lync Server 2010 では、プロキシ サーバー構成設定でプロキシ サーバーを管理することができます。この構成設定はグローバル スコープとサービス スコープ (ただし、エッジ サーバーおよびレジストラー サービスに限る) の両方で適用でき、クライアント エンドポイントが使用できる認証プロトコルや、プロキシ サーバーの送受信接続での圧縮の使用の有無などが制御可能です。Lync Server 2010 をインストールすると、プロキシ サーバーの構成設定のグローバル コレクションが自動的に作成されます。既に説明したように、サービス スコープで追加のコレクションを作成することもできます。
作成する新しいプロキシ サーバー設定は、Remove-CsProxyConfiguration コマンドレットを使用して後で削除することができます。また、グローバル コレクションに対して Remove-CsProxyConfiguration を実行することもできます。ただし、その場合、Lync Server ではグローバル設定を削除することはできないため、グローバル設定は削除されません。代わりに、グローバル コレクション内のすべてのプロパティが既定値にリセットされます。たとえば、既定のプロキシ サーバー設定では、クライアントが Kerberos プロトコルを使用して認証することが許可されています。グローバル設定を変更して、Kerberos の使用を無効にすることができます。ただし、Remove-CsProxyConfiguration をグローバル コレクションに対して実行すると、問題のプロパティ (UseKerberosForClientToProxyAuth) は既定値にリセットされ、Kerberos は再び、認証プロトコルとして使用可能になります。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Remove-CsProxyConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsProxyConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
必須 |
Xds Identity |
削除するプロキシ サーバー構成設定の一意の識別子です。たとえば次のようになります。-Identity "service:Registrar:atl-cs-001.litwareinc.com"。 Remove-CsProxyConfiguration は、グローバル設定に対しても実行できます。ただし、その場合、設定は削除されません。代わりに、そのグローバル コレクションのプロパティがすべて既定値にリセットされます。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクト。Remove-CsProxyConfiguration は、パイプライン処理されたプロキシ設定オブジェクトのインスタンスを受け入れます。
戻り値の種類
なし。代わりに、Remove-CsProxyConfiguration は、Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings オブジェクトの既存のインスタンスを削除します。
例
-------------------------- 例 1 --------------------------
Remove-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-011.litwareinc.com
例 1 に示すコマンドでは、service:EdgeServer:atl-edge-litwareinc.com の Identity を持つプロキシ構成設定を削除します。
-------------------------- 例 2 --------------------------
Get-CsProxyConfiguration -Filter "service:*" | Remove-CsProxyConfiguration
例 2 では、サイト スコープで適用されたプロキシ構成設定がすべて削除されます。このタスクを実行するには、まず、Get-CsProxyConfiguration と Filter パラメーターを呼び出します。フィルター値 "service:*" により、Identity が文字列値 "service:" で始まるプロキシ設定のみが戻されます。フィルター処理されたこのコレクションは Remove-CsProxyConfiguration にパイプ処理され、それにより、そのコレクション内の各項目が削除されます。
-------------------------- 例 3 --------------------------
Get-CsProxyConfiguration | Where-Object {$_.TreatAllClientsAsRemote -eq $True} | Remove-CsProxyConfiguration
上記のコマンドは、全クライアントをリモート クライアントとして処理するプロキシ構成設定をすべて削除します。このタスクを実行するには、まず、パラメーターなしで Get-CsProxyConfiguration を呼び出して、現在使用中のすべてのプロキシ サーバー構成設定のコレクションを戻します。このコレクションは Where-Object コマンドレットにパイプ処理され、それにより、TreatAllClientsAsRemote プロパティが True に等しい設定のみが選択されます。次に、このプロキシ構成設定のサブセットは Remove-CsProxyConfiguration にパイプ処理され、コレクション内のすべての設定が削除されます。