New-CsDiagnosticsFilter
トピックの最終更新日: 2012-03-23
診断の構成設定で使用される新しい診断フィルターを作成します。診断の構成設定を使用して、特定のドメインまたは URI (Uniform Resource Identifier) との間のトラフィックが Microsoft Lync Server 2010 ログ ファイルに記録されるかどうかを決定します。
構文
New-CsDiagnosticsFilter [-Enabled <$true | $false>] [-ExcludeConferenceMessages <$true | $false>] [-ExcludePresenceNotifications <$true | $false>] [-ExcludeRegisterMessages <$true | $false>] [-ExcludeSubscribeMessages <$true | $false>] [-Fqdn <PSListModifier>] [-Uri <PSListModifier>]
解説
Lync Server 2010 のログの記録を有効にした場合、既定では、任意のドメインまたは URI に転送されるトラフィックまたはそれらから転送されてくるトラフィックがログ ファイルに記録されます。これにより、できる限り多くの情報をログ ファイルに記録できます。
一方で、情報過多の結果になる場合もあります。たとえば、特定のドメインで接続の問題が発生している場合、ログへの記録をネットワークとそのドメインとの間のトラフィックに限定する必要がある場合があります。これにより、関係のあるレコードの識別が容易になり、さらには問題の診断と修正が容易になります。
診断の構成設定により、ログ ファイルに記録されるドメインまたは URI を指定することができます。たとえば、指定したドメインとの間のトラフィックのみをログに記録することがあります。グローバル設定に加えて、Lync Server により、サイト スコープまたはサービス スコープ (エッジ サーバー またはレジストラー サービスのいずれかの場合) で診断の設定を作成できます。同様に、これによって、Redmond サイトには、他のサイトに適用する設定とは異なる設定を適用できます。
New-CsDiagnosticsFilter を使用すると、診断の設定のコレクションにフィルターを追加することができます。このコレクションには、ログ ファイルにトラフィックが記録されるドメインおよび URI が含まれます。フィルターを追加した場合、フィルター内のそのドメインまたは URI に関連する情報のみがログに記録されます。ログを記録するために、他のドメインおよび URI からのトラフィックは無視されます。
New-CsDiagnosticsFilter コマンドレットは、診断フィルターのメモリ内インスタンスのみを作成することに注意してください。そのインスタンスのいずれかの仮想フィルターを作成した後で、New-CsDiagnosticConfiguration または Set-CsDiagnosticConfiguration のどちらかを使用して、フィルターをコレクションに追加する必要があります。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーが、New-CsDiagnosticsFilter コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticsFilter"}
パラメーター
| パラメーター | 必須 | 型 | 説明 |
|---|---|---|---|
Enabled |
必須 |
ブール値 |
フィルターを採用するかどうかを示します。既定値は True ($True) です。 |
ExcludeConferenceMessages |
省略可能 |
ブール値 |
True に設定すると、会議メッセージに関する情報 (つまり、To ヘッダーまたは From ヘッダーに会議 URI が含まれるすべてのメッセージ) はログ ファイルに記録されません。既定値は False です。 |
ExcludePresenceNotifications |
省略可能 |
ブール値 |
True に設定すると、プレゼンス通知に関する情報 (つまり、NOTIFY メソッドまたは BENOTIFY メソッドを使用するすべてのメッセージ) はログ ファイルに記録されません。既定値は False です。 |
ExcludeRegisterMessages |
省略可能 |
ブール値 |
True に設定すると、クライアントの登録に関する情報 (つまり、REGISTER メソッドを使用するすべてのメッセージ) はログ ファイルに記録されません。既定値は False です。 |
ExcludeSubscribeMessages |
省略可能 |
ブール値 |
True に設定すると、クライアントの購読に関する情報 (つまり、SUBSCRIBE メソッドを使用するすべてのメッセージ) はログ ファイルに記録されません。既定値は False です。 |
Fqdn |
省略可能 |
PS リスト修飾子 |
フィルターに含まれるドメインのコレクション (より専門的な言葉では、これらのドメインは SIP アドレスのホスト部分を表します)。FQDN プロパティに関しては、次のような完全修飾ドメイン名 (FQDN) を使用できます。fabrikam.com。または、ワイルドカードを使用して、次のように複数のドメインを表すこともできます。*.fabrikam.com。1 つのフィルターには複数のドメインを設定できます。 |
Uri |
省略可能 |
PS リスト修飾子 |
フィルターに含まれる URI のコレクション (この URI は、SIP アドレスの user@host 部分です)。URI は次のいずれかのパターンで構成されます。 user@fabrikam.com user@* *@fabrikam.com 1 つのフィルターに複数の URI を設定できます。 |
入力の種類
なし。New-CsDiagnosticsFilter はパイプライン入力を受け入れません。
戻り値の種類
New-CsDiagnosticsFilter により、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.Filter オブジェクトの新しいインスタンスが作成されます。
例
-------------------------- 例 1 ------------------------
$x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com" -Enabled $False
Set-CsDiagnosticConfiguration -Identity global -Filter $x
例 1 に示すコマンドは、New-CsDiagnosticsFilter を使用して新しい診断フィルターを作成し、そのフィルターを診断のグローバル構成設定に割り当てます。このタスクを実行するため、最初のコマンドは New-CsDiagnosticsFilter を呼び出し、メモリ内のみの診断フィルターを作成します。このフィルターにより、FQDN の fabrikam.com と URI の user@fabrikam.com がフィルターに追加されます。また、Enabled プロパティを True ($True) に設定して、フィルターを有効にします。結果としての仮想フィルターが変数 $x に格納されます。
2 番目のコマンドでは、Set-CsDiagnosticConfiguration を使用して、新しいフィルターを診断のグローバル構成設定に割り当てます。この場合、Filter プロパティ内の既存の値は、新しく作成されて $x に格納されているフィルターに置き換えられます。
-------------------------- 例 2 ------------------------
$x = New-CsDiagnosticsFilter -Fqdn "fabrikam.com","contoso.com" -Enabled $False
Set-CsDiagnosticConfiguration -Identity global -Filter $x
例 2 に示すコマンドは、例 1 に示すコマンドの変化形です。ただし例 2 では、2 つの FQDN (fabrikam.com および contoso.com) をフィルターの Fqdn プロパティに追加しています。この処理を行うため、両方の名前をコンマで区切って Fqdn パラメーターのパラメーター値として使用しています。