Skype for Business Server 2015 の集中ログ サービスのシナリオを構成するConfigure scenarios for the Centralized Logging Service in Skype for Business Server 2015

概要: Skype for Business Server 2015 の集中ログ サービスのシナリオを作成、変更、および削除する方法について説明します。Summary: Learn how to create, modify, and remove scenarios for the Centralized Logging Service in Skype for Business Server 2015.

シナリオでは、スコープ (グローバル、サイト、プール、またはコンピューター) と、集中ログ サービスで使用するプロバイダーを定義します。Scenarios define the scope (that is, global, site, pool, or computer) and what providers to use in the Centralized Logging Service. シナリオを使用して、プロバイダー (S4、SIPStack、IM、プレゼンスなど) のトレースを有効または無効にします。By using scenarios, you enable or disable tracing on providers (for example, S4, SIPStack, IM, and Presence). シナリオを構成することで、特定の問題の条件に対応する特定の論理コレクションのすべてのプロバイダーをグループ化できます。By configuring a scenario, you can group all of the providers for a given logical collection that address a specific problem condition. トラブルシューティングとログ記録のニーズを満たすためにシナリオを変更する必要がある場合は、Skype for Business Server 2015 デバッグ ツールから ClsScenarioEdit.psm1 という名前の Windows PowerShell モジュールが提供されます。このモジュールには、Edit-CsClsScenario という名前の関数が含まれています。If you find that a scenario needs to be modified to meet your troubleshooting and logging needs, the Skype for Business Server 2015 Debug Tools provides you a Windows PowerShell module named ClsScenarioEdit.psm1 that contains a function namedEdit-CsClsScenario. このモジュールの目的は、指定したシナリオのプロパティを編集することです。The purpose of the module is to edit the properties of the named scenario. このトピックでは、このモジュールの使用方法の例を示します。Examples of how this module works are provided in this topic. さらに進む前に、Skype for Business Server 2015 デバッグ ツール をダウンロードしてください。Download the Skype for Business Server 2015 Debugging Tools before going any further.

重要

どのスコープ (サイト、グローバル、プール、またはコンピューター) でも、一度に最大で 2 つのシナリオを実行できます。For any given scope—site, global, pool or computer—you can run a maximum of two scenarios at any given time. 現在実行されているシナリオを特定するには、Windows PowerShell Get-CsClsScenario を使用しますTo determine which scenarios are currently running, use Windows PowerShell and Get-CsClsScenario. Set-CsClsScenarioWindows PowerShellを使用すると、実行中のシナリオを動的に変更できます。By using Windows PowerShell and Set-CsClsScenario, you can dynamically change which scenarios are running. ログ セッション中に実行するシナリオを変更して、収集するデータや収集元のプロバイダーを変更または微調整することができます。You can modify which scenarios are running during a logging session to adjust or refine the data you are collecting and from which providers.

Skype for Business Server 管理シェルを使用して集中ログ サービス機能を実行するには、CsAdministrator または CsServerAdministrator の役割ベースのアクセス制御 (RBAC) セキュリティ グループのメンバーか、これら 2 つのグループのいずれかを含むカスタム RBAC の役割のメンバーである必要があります。To run the Centralized Logging Service functions by using the Skype for Business Server Management Shell, you must be a member of either the CsAdministrator or the CsServerAdministrator role-based access control (RBAC) security groups, or a custom RBAC role that contains either of these two groups. このコマンドレットが割り当てられているすべての RBAC の役割 (自身が作成したカスタムの RBAC の役割を含む) の一覧を戻す場合は、Skype for Business Server 管理シェルまたは Windows PowerShell プロンプトから次のコマンドを実行します。To return a list of all the RBAC roles this cmdlet has been assigned to, including any custom RBAC roles you have created yourself, run the following command from the Skype for Business Server Management Shell or the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Skype for Business Server 2015 cmdlet"}

次に例を示します。For example:

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

このトピックの残りの部分では、シナリオの定義方法、シナリオの変更方法、実行中のシナリオの取得方法、シナリオの削除方法、およびトラブルシューティングを最適化するためのシナリオの指定方法について説明します。The remainder of this topic focuses on how to define a scenario, modify a scenario, retrieve what scenarios are running, remove a scenario, and specify what a scenario contains to optimize your troubleshooting. Skype for Business Server 管理シェルを使用して、次のコマンドWindows PowerShellできます。You can use the Skype for Business Server Management Shell to issue Windows PowerShell commands. この機能を使用Windows PowerShell、ログ セッションで使用する新しいシナリオを定義できます。When you use Windows PowerShell, you can define new scenarios for use in your logging sessions.

Skype for Business 2015の集中ログ サービスで導入されたシナリオの要素は次のとおりです。As introduced in Centralized Logging Service in Skype for Business 2015, the elements of a scenario are:

  • プロバイダー OCSLogger に慣れ親しんだ場合、プロバイダーはトレース エンジンがログを収集する必要があるコンポーネントを OCSLogger に伝えるコンポーネントです。Providers If you are familiar with OCSLogger, providers are the components that you choose to tell OCSLogger what the tracing engine should collect logs from. プロバイダーは同じコンポーネントであり、多くの場合、OCSLogger のコンポーネントと同じ名前です。The providers are the same components, and in many cases have the same name as the components in OCSLogger. OCSLogger について詳しくない場合、プロバイダーは、集中ログ サービスがログを収集できるサーバーの役割固有のコンポーネントです。If you are not familiar with OCSLogger, providers are server role specific components that the Centralized Logging Service can collect logs from. プロバイダーの構成の詳細については 、「Configure providers for Centralized Logging Service in Skype for Business Server 2015」を参照してください。For details about the configuration of providers, see Configure providers for Centralized Logging Service in Skype for Business Server 2015.

  • ID パラメーター -Identity は、シナリオのスコープと名前を設定します。Identity The parameter -Identity sets the scope and name of the scenario. たとえば、スコープを "global" に設定し、"LyssServiceScenario" を使用してシナリオを特定できます。For example, you could set a scope of "global" and identify the scenario with "LyssServiceScenario". この 2 つを組み合わせる場合は、Identity ("global/LyssServiceScenario" など) を定義します。When you combine the two, you define the Identity (for example, "global/LyssServiceScenario").

    必要に応じて、-Name パラメーターと -Parent パラメーターを使用できます。Optionally, you can use the -Name and -Parent parameters. Name パラメーターは、シナリオを一意に識別するために定義します。You define the Name parameter to uniquely identify the scenario. Name を使用する場合は、Parent も使用して、グローバルまたはサイトにシナリオを追加する必要があります。If you use Name, you must also use Parent to add the scenario to either global or site.

    重要

    Name パラメーターと Parent パラメーターを使用する場合、-Identity パラメーター は使用 できません。If you use the Name and Parent parameters, you cannot use the -Identity parameter.

New-CsClsScenario コマンドレットを使用して新しいシナリオを作成するにはTo create a new scenario with the New-CsClsScenario cmdlet

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. ログ セッションの新しいシナリオを作成するには 、New-CsClsProvider を使用して、シナリオの名前 (つまり、シナリオを一意に識別する方法) を定義します。To create a new scenario for a logging session, use New-CsClsProvider and define the name of the scenario (that is, how it will be uniquely identified). WPP (既定の Windows ソフトウェア トレース プリプロセッサ)、EventLog (Windows イベント ログ形式)、または IISLog (IIS ログ ファイル形式に基づく ASCII 形式ファイル) から、ログ形式の種類を選択します。Choose a type of logging format from WPP (that is, Windows software tracing preprocessor and is the default), EventLog (that is, Windows event log format), or IISLog (that is, ASCII format file based on the IIS log file format). 次に、レベル (このトピックの [ログ レベル] で定義) とフラグ (このトピックの [フラグ] で定義) を定義します。Next, define Level (as the defined under Logging Levels in this topic), and Flags (as defined under Flags in this topic).

    このシナリオ例では、プロバイダー変数の例として LyssProvider を使用します。For this example scenario, we use LyssProvider as the example provider variable.

    定義されたオプションを使用してシナリオを作成するには、次のように入力します。To create a scenario using the options defined, type:

    New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
    

    次に例を示します。For example:

    New-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider $LyssProvider
    

    -Name と -Parent を使用する代替形式:The alternate format using -Name and -Parent:

    New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
    

複数のプロバイダーを指定した新しいシナリオを New-CsClsScenario コマンドレットを使用して作成するにはTo create a new scenario with multiple providers with the New-CsClsScenario cmdlet

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. スコープごとのシナリオ数は 2 つまでに制限されています。You are limited to two scenarios per scope. しかし、設定するプロバイダーの数に制限はありません。However, you are not limited to a set number of providers. この例では、3 つのプロバイダーを作成済みで、定義するシナリオに 3 つのプロバイダーをすべて割り当てる必要があるとします。In this example, assume that we have created three providers, and you want to assign all three to the scenario you are defining. プロバイダー変数の名前は LyssProvider、ABServerProvider、および SIPStackProvider です。The provider variable names are LyssProvider, ABServerProvider, and SIPStackProvider. 複数のプロバイダーを定義してシナリオに割り当てるには、Skype for Business Server 管理シェルで次を入力するか、コマンド Windows PowerShell入力します。To define and assign multiple providers to a scenario, type the following at a Skype for Business Server Management Shell or Windows PowerShell command prompt:

    New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
    

    注意

    この規則は、Windows PowerShellで知られているので、値のハッシュ テーブルを作成するための規則は"ス @{<variable>=<value1>, <value2>, <value>…} プラットフォーム" と呼ばれる方法です。As it is known in Windows PowerShell, the convention for creating a hash table of values using @{<variable>=<value1>, <value2>, <value>…} is known assplatting. スプラッティングの詳細については、「Windows PowerShell参照してください https://go.microsoft.com/fwlink/p/?LinkId=267760For details about splatting in Windows PowerShell, see https://go.microsoft.com/fwlink/p/?LinkId=267760.

Set-CsClsScenario コマンドレットを使用して既存のシナリオを変更するにはTo modify an existing scenario with the Set-CsClsScenario cmdlet

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. スコープごとのシナリオ数は 2 つまでに制限されています。You are limited to two scenarios per scope. 実行するシナリオは、ログ キャプチャ セッションの実行中を含め、いつでも変更できます。You can change which scenarios are running at any time, even when a logging capture session is in process. 実行するシナリオを再定義すると、現在のログ セッションは削除されたシナリオの使用を停止し、新しいシナリオの使用を開始します。If you redefine the running scenarios, the current logging session will stop using the scenario that was removed and then begin using the new scenario. ただし、削除されたシナリオでキャプチャされたログ情報はキャプチャされたログに残ります。However, the logging information that was captured with the removed scenario remains in the captured logs. 新しいシナリオを定義するには、次の手順を実行します (つまり、"S4Provider" という名前の定義済みプロバイダーが追加されたと仮定します)。To define a new scenario, do the following (that is, assuming the addition of an already defined provider named "S4Provider"):

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
    

    次に例を示します。For example:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Add=$S4Provider}
    

    プロバイダーを置き換える場合は、現在のセットと置き換える単一のプロバイダーか、プロバイダーのコンマ区切りリストを定義します。多数のプロバイダーのうち 1 つだけを置き換える場合は、現在のプロバイダーに新しいプロバイダーを追加して、新しいプロバイダーと既存のプロバイダーの両方を含む新しいプロバイダーのセットを作成します。すべてのプロバイダーを新しいセットで置き換える場合は、次のように入力します。If you want to replace providers, define a single provider or a comma separated list of providers to replace the current set. If you only want to replace one of many providers, add the current providers with the new providers to create a new set of providers that contains both new providers and existing providers. To replace all providers with a new set, type the following:

    Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Replace=<providers to replace existing provider set>}
    

    たとえば、現在の $LyssProvider、$ABServerProvider、および $SIPStackProvider のセットを $LyssServiceProvider に置き換えるには、次のように入力します。For example, to replace the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider}
    

    現在の $LyssProvider、$ABServerProvider、および $SIPStackProvider のセットのうち、$LyssProvider プロバイダーだけを $LyssServiceProvider に置き換えるには、次のように入力します。To replace just the $LyssProvider provider from the current set of $LyssProvider, $ABServerProvider, and $SIPStackProvider with $LyssServiceProvider, type the following:

    Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
    

Remove-CsClsScenario コマンドレットを使用して既存のシナリオを削除するにはTo remove an existing scenario with the Remove-CsClsScenario cmdlet

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. 定義済みのシナリオを削除する場合は、次のように入力します。If you want to remove a scenario that has been previously defined, type the following:

    Remove-CsClsScenario -Identity <name of scope and scenario>
    

    たとえば、定義済みのシナリオ site:Redmond/LyssServiceScenario を削除するには、次のようにします。For example, to remove the defined scenario site:Redmond/LyssServiceScenario:

    Remove-CsClsScenario -Identity "site:Redmond/LyssServiceScenario"
    

Remove-CsClsScenario コマンドレットでは指定したシナリオが削除されますが、キャプチャ済みのトレースはログに残り、検索に利用できます。The Remove-CsClsScenario cmdlet removes the specified scenario, but the traces that have been captured are still available in the logs for you to search on.

ClsScenarioEdit.psm1 モジュールEdit-CsClsScenarioコマンドレットを読み込み、アンロードするにはTo load and unload the Edit-CsClsScenario cmdlet using the ClsScenarioEdit.psm1 module

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

    重要

    ClsScenarioEdit.psm1 モジュールは、別の Web ダウンロードとして提供されます。The ClsScenarioEdit.psm1 module is provided as a separate Web download. このモジュールは、Skype for Business Server 2015 デバッグ ツールの一部です。The module is part of the Skype for Business Server 2015 Debugging tools. 既定では、デバッグ ツールは C:\Program Files\Skype for Business Server 2015\Debugging Tools ディレクトリにインストールされます。By default, the debugging tools are installed in the directory C:\Program Files\Skype for Business Server 2015\Debugging Tools.

  2. 次のコマンドWindows PowerShell入力します。From the Windows PowerShell, type:

    Import-Module "CDBurn\OCO\amd64\Support"
    

    ヒント

    モジュールの読み込みが成功すると、コマンド プロンプトWindows PowerShell戻されます。Successful loading of the module returns you to the Windows PowerShell command prompt. モジュールが読み込まれ、そのモジュールが使用可能Edit-CsClsScenario、次のコマンドを入力します Get-Help Edit-CsClsScenarioTo confirm that the module is loaded and that Edit-CsClsScenario is available, type Get-Help Edit-CsClsScenario. すると、EditCsClsScenario の構文の基本的な概要が表示されます。You should see the basic synopsis of the syntax for EditCsClsScenario.

  3. モジュールをアンロードするには、次のように入力します。To unload the modules, type:

    Remove-Module ClsController
    

    ヒント

    モジュールのアンロードが成功すると、コマンド プロンプトWindows PowerShell戻されます。Successful unloading of the module returns you to the Windows PowerShell command prompt. モジュールがアンロードされたのを確認するには、次のコマンドを入力します Get-Help Edit-CsClsScenarioTo confirm that the module is unloaded, type Get-Help Edit-CsClsScenario. Windows PowerShellコマンドレットのヘルプの検索が試行され、失敗します。Windows PowerShell will attempt to locate the help for the cmdlet and fail.

Edit-ClsController モジュールを使用してシナリオから既存のプロバイダーを削除するにはTo remove an existing provider from a scenario with the Edit-ClsController module

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. 次のコマンドWindows PowerShell入力します。From the Windows PowerShell, type:

    Import-Module "CDBurn\OCO\amd64\Support"
    

    ヒント

    モジュールの読み込みが成功すると、コマンド プロンプトWindows PowerShell戻されます。Successful loading of the module returns you to the Windows PowerShell command prompt. モジュールが読み込まれ、そのモジュールが使用可能Edit-CsClsScenario、次のコマンドを入力します Get-Help Edit-CsClsScenarioTo confirm that the module is loaded and that Edit-CsClsScenario is available, type Get-Help Edit-CsClsScenario. すると、EditCsClsScenario の構文の基本的な概要が表示されます。You should see the basic synopsis of the syntax for EditCsClsScenario.

  3. AlwaysOn シナリオからプロバイダーを削除するには、次のように入力します。To remove a provider from the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
    

    次に例を示します。For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Remove
    

    パラメーター ScenarioName および ProviderName は、位置指定 (コマンド ライン内の指定された位置に定義する必要がある) パラメーターです。コマンドレット名を位置 1 として、シナリオ名が位置 2、プロバイダーが位置 3 にある場合は、パラメーター名を明示的に定義する必要はありません。この情報を使用すると、上記のコマンドは次のように入力できます。The parameters ScenarioName and ProviderName are positional (that is, they must be defined in the expected position in the command line) parameters. The parameter name does not have to be explicitly defined if the scenario name is in position two and the provider is in position three, relative to the name of the cmdlet as position one. Using this information, the previous command would be typed as:

    Edit-CsClsScenario AlwaysOn ChatServer -Remove
    

    パラメーター値の位置指定は、-Scenario および -Provider にのみ適用されます。The positional placing of the parameter values applies only to -Scenario and -Provider. 他のすべてのパラメーターは明示的に定義する必要があります。All other parameters must be explicitly defined.

Edit-ClsController モジュールを使用してシナリオにプロバイダーを追加するにはTo add a provider to a scenario with the Edit-ClsController module

  1. Skype for Business Server 管理シェルを起動します。[スタート] ボタン、[すべてのプログラム] の順にクリックし 、[Skype for Business 2015] をクリックして 、[Skype for Business Server 管理シェル] をクリックします。Start the Skype for Business Server Management Shell: Click Start, click All Programs, click Skype for Business 2015, and then click Skype for Business Server Management Shell.

  2. AlwaysOn シナリオにプロバイダーを追加するには、次のように入力します。To add a provider to the AlwaysOn scenario, type:

    Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to add> -Level <string of type level> -Flags <string of type flags>
    

    次に例を示します。For Example:

    Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
    

    -Loglevel には、Fatal、Error、Warning、Info、Verbose、Debug、または All を指定できます。-Loglevel can be of the type Fatal, Error, Warning, Info, Verbose, Debug, or All. -Flags には、プロバイダーがサポートするフラグ (TF_COMPONENT、TF_DIAG。-Flags can be any of the flags that the provider supports, such as TF_COMPONENT, TF_DIAG. -Flags は値 ALL に設定できます-Flags can also be of value ALL

    上記の例を、コマンドレットの位置指定機能を使用して入力することもできます。たとえば、プロバイダー ChatServer を AlwaysOn シナリオに追加するには、次のように入力します。The previous example can also be typed using the positional feature of the cmdlet. For example, to add the provider ChatServer to the AlwaysOn scenario, type:

    Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL