Remove-CsDiagnosticConfiguration
トピックの最終更新日: 2012-03-25
現在組織で使用中の、1 つまたは複数の診断構成設定のコレクションを削除します。診断構成設定を使用して、特定のドメインまたは Uniform Resource Identifier (URI) との間のトラフィックを Microsoft Lync Server 2010 ログ ファイルに記録するかどうかを設定します。
構文
Remove-CsDiagnosticConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
Lync Server 2010 のログの記録を有効にした場合、既定では、任意のドメインまたは URI に転送されるトラフィックまたはそれらから転送されてくるトラフィックがログ ファイルに記録されます。これにより、できる限り多くの情報をログ ファイルに記録できます。
ただしこの結果、情報が多くなりすぎる場合があります。たとえば、特定のドメインで接続の問題が発生している場合、ログへの記録をネットワークとそのドメインとの間のトラフィックに限定する必要がある場合があります。これにより、関係のある記録の識別が容易になり、さらには問題の診断と修正が容易になります。
診断構成設定により、ログ ファイルに記録されるドメインまたは URI を指定することができます。その場合、診断フィルターが有効なら、指定したドメインとの間のトラフィックのみがログに記録されます。Lync Server では、サイト スコープで、診断構成設定を作成して診断フィルターを適用できます。同様に、これによって、Redmond サイトなどへのフィルター処理を有効にしながら、他のサイトではフィルター処理を無効にしておくことができます。
Remove-CsDiagnosticConfiguration コマンドレットを使用して、サイト スコープで作成した任意の診断構成設定を削除できます。Remove-CsDiagnosticConfiguration コマンドレットは、グローバル診断構成設定に対しても実行することができます。ただしその場合、コレクション自体は削除されません。これは、Lync Server ではグローバル コレクションの削除が許可されないからです。その代わり、グローバル コレクションを削除すると、そのコレクションに含まれるプロパティが既定値にリセットされます。つまり、そのコレクションに追加されていたすべてのフィルターが削除されます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Remove-CsDiagnosticConfiguration コマンドレットをローカルで実行することを承認されています。ローカルでのコマンドレット実行:RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsDiagnosticConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Xds Identity |
削除する診断構成設定の一意の識別子。サイト スコープで構成されている設定を削除するには、次のような構文を使用します。-Identity "site:Redmond"。 Remove-CsDiagnosticConfiguration は、グローバル構成設定に対して実行することもできます。その場合は、次の構文を使用します。–Identity global。ただし、グローバル設定は実際には削除されず、代わりにグローバル設定内のプロパティが既定値にリセットされます。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings オブジェクト。Remove-CsDiagnosticConfiguration は、診断フィルター設定オブジェクトのパイプライン処理されたインスタンスを受け入れます。
戻り値の種類
なし。代わりに、Remove-CsDiagnosticConfiguration は、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings オブジェクトの既存のインスタンスを削除します。
例
-------------------------- 例 1 ------------------------
Remove-CsDiagnosticConfiguration -Identity site:Redmond
上記のコマンドでは、Identity が site:Redmond の診断構成設定が削除されます。
-------------------------- 例 2 ------------------------
Get-CsDiagnosticConfiguration -Filter site:* | Remove-CsDiagnosticConfiguration
例 2 に示すコマンドでは、サイト スコープで構成された診断構成設定がすべて削除されます。このタスクを実行するには、Filter パラメーターを指定して Get-CsDiagnosticConfiguration を呼び出します。フィルター値 "site:*" により、戻されるデータは、Identity が文字列 "site:" で始まる設定に限定されます。次に、このフィルター処理されたコレクションは Remove-CsDiagnosticConfiguration にパイプ処理され、その結果、コレクション内の各項目が削除されます。
-------------------------- 例 3 ------------------------
Get-CsDiagnosticConfiguration | Remove-CsDiagnosticConfiguration
例 3 のコマンドは、組織で現在使用されているすべての診断構成設定を削除します。このタスクを実行するため、まず、パラメーターを指定せずに Get-CsDiagnosticConfiguration を呼び出し、組織で現在使用中のすべての診断構成設定のコレクションを戻します。次にこの項目は Remove-CsDiagnosticConfiguration にパイプ処理され、その結果、コレクション内の各項目が削除されます。