次の方法で共有


Set-CsDiagnosticConfiguration

 

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

既存の診断構成設定を変更します。診断構成設定を使用して、特定のドメインまたは URI (Uniform Resource Identifier) との間のトラフィックを Microsoft Lync Server 2010 ログ ファイルに記録するかどうかを指定します。

構文

Set-CsDiagnosticConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Filter <Filter>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Set-CsDiagnosticConfiguration [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Filter <Filter>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]

解説

Lync Server 2010 のログの記録を有効にした場合、既定では、任意のドメインまたは URI に転送されるトラフィックまたはそれらから転送されてくるトラフィックがログ ファイルに記録されます。これにより、できる限り多くの情報をログ ファイルに記録できます。

ただしこの結果、情報が多くなりすぎる場合があります。たとえば、特定のドメインで接続の問題が発生している場合、ログへの記録をネットワークとそのドメインとの間のトラフィックに限定する必要がある場合があります。これにより、関係のあるレコードの識別が容易になり、さらには問題の診断と修正が容易になります。

診断構成設定を使用して、ログ ファイルに記録されるドメインまたは URI を指定することができます。Lync Server では、サイト スコープで診断構成設定を作成することができます。そのため、他のサイトではこの設定を適用しておき、Redmond サイトに異なる設定を適用することができます。

Set-CsDiagnosticConfiguration コマンドレットを使用して、特定のコレクションのフィルターを追加または削除できます。フィルターは、トラフィックをログに記録するドメインを示すために使用します。

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

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

パラメーター

パラメーター 必須 説明

Identity

省略可能

Xds Identity

変更する診断構成設定の一意の識別子です。サイト スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "site:Redmond"。グローバル設定を変更するには、次の構文を使用します。-Identity global。

このパラメーターを指定しない場合、Set-CsDiagnosticConfiguration は自動的にグローバル設定を変更します。

Instance

省略可能

DiagnosticFilterSettings オブジェクト

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

Filter

省略可能

PS リスト修飾子

トラフィックがログに記録されるドメインおよび URI のコレクション。Filter プロパティは、3 つの別項目で構成され、New-CsDiagnosticsFilter コマンドレットを使用して作成する必要があります。

Fqdn - フィルターに含めるドメインのコレクション (より専門的な言葉では、SIP アドレスのホスト部分)。たとえば、完全修飾ドメイン名 (FQDN) は次のようになります。fabrikam.com。または、ワイルドカードを使用して、次のように複数のドメインを表すこともできます。*.fabrikam.com。1 つのフィルターに複数のドメインを含めることができます。

Uri - フィルターに含める URI のコレクション (URI は、SIP アドレスの user@host 部分を表します)。URI は次のいずれかのパターンで構成されます。user@fabrikam.com、user@*、*@fabrikam.com。1 つのフィルターに複数の URI を含めることができます。

Enabled - フィルターを有効にする必要があるかどうかを示します。

LoggingShare

省略可能

文字列

診断ログをアップロードする共有フォルダー。

Force

省略可能

スイッチ パラメーター

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

WhatIf

省略可能

スイッチ パラメーター

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

Confirm

省略可能

スイッチ パラメーター

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

入力の種類

Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings オブジェクト。Set-CsDiagnosticConfiguration は、診断構成設定オブジェクトのパイプ処理されたインスタンスを受け入れます。

戻り値の種類

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

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

$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri sip:user@fabrikam.com 
Set-CsDiagnosticConfiguration -Identity global -Filter $x

例 1 に示すコマンドは、New-CsDiagnosticsFilter を使用して新しい診断フィルターを作成し、そのフィルターをグローバル診断構成設定に割り当てます。このタスクを実行するため、最初のコマンドは New-CsDiagnosticsFilter を呼び出して、メモリ内専用の診断フィルターを作成します。このフィルターが fabrikam.com という FQDN と sip:user@fabrikam.com という URI を使用します。その後、"仮想" フィルターが、変数 $x に格納されます。

コマンド 2 では、Set-CsDiagnosticConfiguration が新しいフィルターをグローバル診断構成設定に割り当てます。この場合、Filter プロパティ内の既存の値は、新しく作成されたフィルターに置き換えられます。

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

$x = (Get-CsDiagnosticConfiguration -Identity global).Filter
$x.Fqdn.Add("fabrikam.com")
Set-CsDiagnosticConfiguration -Identity global -Filter $x

例 2 では、新しい FQDN をグローバル診断構成設定の Filter プロパティに追加する方法を示しています。このタスクを実行するため、例の最初のコマンドで Get-CsDiagnosticConfiguration を使用して、グローバル設定の Filter プロパティの値を取得します。これを行うために、Get-CsDiagnosticConfiguration の呼び出しをかっこで囲みます。これにより、Windows PowerShell が他の処理を実行する前に、このコマンドを実行するようにします。グローバル設定が戻されると、Filter プロパティの値が抽出されて、$x という変数に格納されます。

2 番目のコマンドでは、Add メソッドを使用して新しい FQDN (fabrikam.com) をフィルターに追加します。この処理が完了すると、例の最後のコマンドで Set-CsDiagnosticConfiguration を使用して、変更した診断の収集を書き込みます。最終的に、Filter プロパティに既に含まれている FQDN に、fabrikam.com が追加されます。

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

$x = (Get-CsDiagnosticConfiguration -Identity global).Filter
$x.Fqdn.Remove("fabrikam.com")
Set-CsDiagnosticConfiguration -Identity global -Filter $x

例 3 に示すコマンドは、Filter プロパティのグローバル診断構成設定から FQDN (fabrikam.com) を削除します。例の最初のコマンドで Get-CsDiagnosticConfiguration を使用して、グローバル設定の Filter プロパティの現在の値を取得します。この値は $x という変数に格納されます。その値を取得すると、Remove メソッドを使用して FQDN fabrikam.com を削除します。FQDN の削除後、Set-CsDiagnosticConfiguration を使用して、変更したフィルター (変数 $x に格納済み) をグローバル設定に書き込みます。

-------------------------- 例 4 ------------------------

Set-CsDiagnosticConfiguration -Identity global -Filter $Null

例 4 では、すべての項目をグローバル診断構成設定の Filter プロパティから削除します。このタスクを実行するには、Filter プロパティを NULL 値に設定します。