New-CsDiagnosticConfiguration
トピックの最終更新日: 2012-03-23
新しい診断構成設定を作成します。診断構成設定を使用して、特定のドメインまたは Uniform Resource Identifier (URI) との間のトラフィックを Microsoft Lync Server 2010 ログ ファイルに記録するかどうかを決定します。
構文
New-CsDiagnosticConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Enabled <$true | $false>] [-Filter <Filter>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
Lync Server 2010 でログの記録を有効にすると、既定では、すべてのドメインまたは URI との間で交わされるトラフィックがログ ファイルに記録されます。これにより、できる限り多くの情報をログ ファイルに記録できます。
ただしこの結果、情報が多くなりすぎる場合があります。たとえば、特定のドメインで接続の問題が発生している場合は、そのドメインとこちらのネットワークの間のトラフィックのみをログに記録します。そのようにすると関係するレコードを識別しやすくなり、その結果、問題の診断や修正が容易になります。
診断構成設定では、ログ ファイルに記録するドメインまたは URI を指定することができます。たとえば、指定したドメインとの間のトラフィックのログのみを記録することができます。Lync Server では、サイト スコープで診断構成設定を作成できます。したがって、たとえば Redmond サイトに他のサイトに適用しているものと異なる設定を適用することができます。
グローバル スコープでは診断構成設定が既にホストされているため、グローバル スコープの診断構成設定を作成することはできません。同様に、指定したサイトに既に診断構成設定がある場合は、サイト スコープで新しい設定コレクションを作成することはできません。たとえば、Redmond サイト用に新しいコレクションを作成しようとしたときに、Redmond サイトで既に診断構成設定がホストされている場合、コマンドは失敗します。
このコマンドレットを実行できるユーザー: 既定では、New-CsDiagnosticConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Xds Identity |
作成する診断構成設定の一意の識別子です。新しい設定はサイト スコープでのみ作成できるため、次のような構文を使用する必要があります。-Identity "site:Redmond"。 |
Filter |
省略可能 |
PS リスト修飾子 |
診断フィルター処理が有効なときにトラフィックが記録されるドメインおよび URI のコレクション。Filter プロパティは、次の 3 つの別項目から構成されます。 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 |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
スイッチ パラメーター |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。New-CsDiagnosticConfiguration は、パイプ処理による入力を受け入れません。
戻り値の種類
New-CsDiagnosticConfiguration は、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings の新しいインスタンスを作成します。
例
-------------------------- 例 1 ------------------------
New-CsDiagnosticConfiguration -Identity site:Redmond
上記のコマンドでは、Redmond サイトの新しい診断構成設定コレクションを作成します。
-------------------------- 例 2 ------------------------
$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False
New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x
例 2 に示すコマンドでは、新しい診断フィルターを作成して、そのフィルターを新しい診断設定コレクションに割り当てます。このタスクを実行するため、最初のコマンドで New-CsDiagnosticsFilter を呼び出してメモリ内専用の診断フィルターを作成し、このフィルターに fabrikam.com という FQDN と sip:user@fabrikam.com という URI を追加します。また、Enabled プロパティを True ($True) に設定して、フィルターを有効にします。結果としての仮想フィルターが変数 $x に格納されます。
2 番目のコマンドでは、New-CsDiagnosticConfiguration を使用して、Redmond サイトの新しい診断構成設定コレクションを作成しています。これらの新しい設定は、変数 $x に格納されている診断フィルターを使用します。
-------------------------- 例 3 ------------------------
$x = New-CsDiagnosticConfiguration -Identity site:Redmond -InMemory
$x.LoggingShare = "\\atl-fs-001\logs"
Set-CsDiagnosticConfiguration -Instance $x
例 3 に示すコマンドでは、作成当初にメモリ内のみに存在する診断構成設定を作成する方法を示しています。これを実行するため、最初のコマンドでは、New-CsDiagnosticConfiguration に次の 2 つのパラメーターを指定して呼び出しています。Identity (設定の ID を指定します)、および InMemory (新しい設定をメモリ内のみに作成する必要があることを示します)。結果のオブジェクトは、変数 $x に保存されます。
仮想の設定を作成した後、2 番目のコマンドを使用して、LoggingShare プロパティを \\atl-fs-001\logs という UNC パスに構成しています。次に、最後のコマンドを使用して、この仮想の診断構成設定を、Redmond サイトに適用する実際の設定コレクションに変換しています。この最後のコマンドは必須であることに注意してください。Set-CsDiagnosticConfiguration を呼び出さなかった場合、設定は Redmond サイトに適用されません。また、仮想の設定は、Windows PowerShell セッションを終了したり、変数 $x を削除したりすると、すぐに失われてしまいます。