Konfigurieren von Szenarien für den zentralisierten Protokollierungsdienst in Lync Server 2013

Artikel
07/23/2014

Thema Letzte Änderung: 05.02.2014

Szenarien definieren den Bereich (d. h. global, Standort, Pool oder Computer) und welche Anbieter im zentralisierten Protokollierungsdienst verwendet werden sollen. Mithilfe von Szenarien können Sie die Ablaufverfolgung für Dienstanbieter aktivieren oder deaktivieren (z. B. bezüglich S4, SIPStack, IM und Anwesenheit). Durch das Konfigurieren eines Szenarios können Sie alle Dienstanbieter für eine bestimmte logische Sammlung gruppieren, die sich mit einem bestimmten Problemzustand befassen. Wenn Sie feststellen, dass ein Szenario geändert werden muss, um Ihre Problembehandlungs- und Protokollierungsanforderungen zu erfüllen, stellen die Lync Server 2013-Debugtools ein Windows PowerShell Modul namens ClsController.psm1 bereit, das eine Funktion mit dem Namen Edit-CsClsScenario enthält. Dieses Modul soll dazu dienen, die Eigenschaften des betreffenden Szenarios zu bearbeiten. Beispiele für die Funktionsweise des Moduls erhalten Sie in diesem Thema. Die Lync Server 2013-Debugtools werden über den folgenden Link heruntergeladen: https://go.microsoft.com/fwlink/?LinkId=285257

Wichtig

Für jeden bestimmten Bereich – Standort, Global, Pool oder Computer – können Sie maximal zwei Szenarien zu einem bestimmten Zeitpunkt ausführen. Um zu bestimmen, welche Szenarien derzeit ausgeführt werden, verwenden Sie Windows PowerShell und Get-CsClsScenario. Mithilfe von Windows PowerShell und Set-CsClsScenario können Sie dynamisch ändern, welche Szenarien ausgeführt werden. Sie können ändern, welche Szenarien während einer Protokollierungssitzung ausgeführt werden, um die gesammelten Daten und von welchen Anbietern anzupassen oder zu verfeinern.

Um die Funktionen des zentralisierten Protokollierungsdiensts mithilfe der Lync Server-Verwaltungsshell auszuführen, müssen Sie Entweder Mitglied der rollenbasierten Zugriffssteuerungsgruppe "CsAdministrator" oder "CsServerAdministrator" oder einer benutzerdefinierten RBAC-Rolle sein, die eine dieser beiden Gruppen enthält. Um eine Liste aller RBAC-Rollen zurückzugeben, die diesem Cmdlet zugewiesen wurden, einschließlich aller benutzerdefinierten RBAC-Rollen, die Sie selbst erstellt haben, führen Sie den folgenden Befehl über die Lync Server-Verwaltungsshell oder die Windows PowerShell Eingabeaufforderung aus:

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Lync Server 2013 cmdlet"}

Zum Beispiel:

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

Nachfolgend wird beschrieben, wie Sie ein Szenario definieren, ein Szenario ändern, wie Sie abrufen, welche Szenarien ausgeführt werden, wie Sie ein Szenario entfernen und wie Sie die Inhalte eines Szenarios auf eine optimale Problembehandlung abstimmen können. Es gibt zwei Möglichkeiten zum Ausgeben von Befehlen des zentralisierten Protokollierungsdiensts. Sie können die CLSController.exe verwenden, die sich standardmäßig im Verzeichnis "C:\Program Files\Common Files\Microsoft Lync Server 2013\CLSAgent" befindet. Sie können auch die Lync Server-Verwaltungsshell verwenden, um Windows PowerShell Befehle ausstellen. Der wichtige Unterschied besteht darin, dass bei Verwendung von CLSController.exe an der Befehlszeile eine begrenzte Auswahl von Szenarien verfügbar ist. Wenn Sie Windows PowerShell verwenden, können Sie neue Szenarien für die Verwendung in Ihren Protokollierungssitzungen definieren.

Wie in der Übersicht über den zentralisierten Protokollierungsdienst in Lync Server 2013 eingeführt, sind die Elemente eines Szenarios:

Anbieter Wenn Sie mit OCSLogger vertraut sind, sind Anbieter die Komponenten, die Sie auswählen, um OCSLogger mitzuteilen, von welchem Ablaufverfolgungsmodul Protokolle gesammelt werden sollen. Die Anbieter sind die gleichen Komponenten und haben in vielen Fällen denselben Namen wie die Komponenten in OCSLogger. Wenn Sie mit OCSLogger nicht vertraut sind, sind Anbieter serverrollenspezifische Komponenten, von denen der zentralisierte Protokollierungsdienst Protokolle sammeln kann. Ausführliche Informationen zur Konfiguration von Anbietern finden Sie unter Configuring providers for Centralized Logging Service in Lync Server 2013.
Identität Der Parameter –Identity legt den Bereich und den Namen des Szenarios fest. Sie können z. B. einen Bereich von "global" festlegen und das Szenario mit "LyssServiceScenario" identifizieren. Wenn Sie die beiden Elemente kombinieren, definieren Sie die Identität (z. B. "global/LyssServiceScenario").

Optional können Sie auch die Parameter „–Name“ und „–Parent“ verwenden. Sie definieren den Parameter „Name“, um das Szenario eindeutig zu identifizieren. Wenn Sie „Name“ verwenden, müssen Sie auch „Parent“ verwenden, um das Szenario entweder einem globalen oder einem standortweiten Geltungsbereich hinzuzufügen.

Wichtig

Falls Sie die Parameter „Name“ und „Parent“ verwenden, können Sie den Parameter –Identity nicht verwenden.

So erstellen Sie ein neues Szenario mit dem Cmdlet „New-CsClsScenario“

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Verwenden Sie für die Erstellung eines neuen Szenarios für eine Protokollierungssitzung New-CsClsProvider und definieren Sie den Namen für das Szenario (d. h. dessen eindeutige Identifikation). Wählen Sie als Typ für das Protokollierungsformat entweder WPP (Windows-Präprozessorformat für die Softwareablaufverfolgung, Standard), EventLog (Windows-Ereignisprotokoll-Format) oder IISLog (Datei im ASCII-Format basierend auf dem IIS-Protokolldatei-Format). Definieren Sie anschließend den Protokolliergrad (gemäß der Definition im entsprechenden Abschnitt in diesem Thema) und die Flags (gemäß der Definition im entsprechenden Abschnitt in diesem Thema).

Für dieses Beispielszenario verwenden wir LyssProvider als Beispiel für die Anbietervariable.

Geben Sie zum Erstellen eines Szenarios mit den definierten Optionen Folgendes ein:
```
New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
```
Beispiel:
```
New-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider $LyssProvider
```
Alternatives Format unter Verwendung von „–Name“ und „–Parent“:
```
New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
```

So erstellen Sie ein neues Szenario mit mehreren Anbietern mithilfe des Cmdlets „New-CsClsScenario“

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Es gilt eine Beschränkung auf zwei Szenarien pro Geltungsbereich. Sie sind jedoch nicht auf eine feste Anzahl von Anbietern beschränkt. In diesem Beispiel wird davon ausgegangen, dass drei Anbieter erstellt wurden, die Sie allesamt dem Szenario zuweisen möchten, das Sie soeben erstellen. Die Variablennamen der Anbieter lauten „LyssProvider“, „ABServerProvider“ und „SIPStackProvider“. Um ein Szenario zu definieren und mehrere Anbieter zuzuweisen, geben Sie Folgendes an einer Lync Server-Verwaltungsshell oder Windows PowerShell Eingabeaufforderung ein:
```
New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
```
Hinweis

Wie es in Windows PowerShell bekannt ist, wird die Konvention zum Erstellen einer Hashtabelle mit Werten @{<variable>=<value1>, <value2>, <value>...} als Splatting bezeichnet. Ausführliche Informationen zum Splatting in Windows PowerShell finden Sie https://go.microsoft.com/fwlink/p/?LinkId=267760unter .

So ändern Sie ein vorhandenes Szenario mithilfe des Cmdlets „Set-CsClsScenario“

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Es gilt eine Beschränkung auf zwei Szenarien pro Geltungsbereich. Sie können jederzeit ändern, welche Szenarien ausgeführt werden, auch wenn gerade eine Protokollerfassungssitzung läuft. Falls Sie die ausgeführten Szenarien neu definieren, verwendet die aktuelle Protokollierungssitzung ab diesem Zeitpunkt nicht mehr das entfernte Szenario, sondern stattdessen das neue Szenario. Die Protokollinformationen, die im Rahmen des entfernten Szenarios erfasst wurden, verbleiben jedoch in den erfassten Protokollen. Gehen Sie wie folgt vor, um ein neues Szenarios zu definieren (hierbei wird angenommen, dass ein bereits definierter Anbieter namens „S4Provider“ hinzugefügt wurde):
```
Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
```
Beispiel:
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Add=$S4Provider}
```
Falls Sie Anbieter ersetzen möchten, definieren Sie einen einzelnen Anbieter oder eine kommagetrennte Liste mit Anbietern, um die aktuelle Gruppe zu ersetzen. Für den Fall, dass Sie nur einen von vielen Anbietern ersetzen möchten, fügen Sie die aktuellen Anbieter zu den neuen Anbietern hinzu, um eine neue Gruppe von Anbietern zu erstellen, die sowohl die neuen als auch die zuvor vorhandenen Anbieter enthält. Geben Sie Folgendes ein, um sämtliche Anbieter durch eine neue Gruppe zu ersetzen:
```
Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Replace=<providers to replace existing provider set>}
```
Beispiel, bei dem die aktuelle aus „$LyssProvider“, „$ABServerProvider“ und „$SIPStackProvider“ bestehende Gruppe durch „$LyssServiceProvider“ ersetzt wird:
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider}
```
Geben Sie Folgendes ein, um lediglich den Anbieter „$LyssProvider“ aus der aktuellen Gruppe mit „$LyssProvider“, „$ABServerProvider“ und „$SIPStackProvider“ durch den Anbieter „$LyssServiceProvider“ zu ersetzen:
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
```

So entfernen Sie ein vorhandenes Szenario mithilfe des Cmdlets „Remove-CsClsScenario“

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Wenn Sie ein Szenario entfernen möchten, das zuvor definiert wurde, geben Sie Folgendes ein:
```
Remove-CsClsScenario -Identity <name of scope and scenario>
```
Beispiel für das Entfernen des Szenarios „site:Redmond/LyssServiceScenario“:
```
Remove-CsClsScenario -Identity "site:Redmond/LyssServiceScenario"
```

Das Cmdlet Remove-CsClsScenario entfernt das angegebene Szenario. Die bereits erfassten Ablaufverfolgungen sind jedoch nach wie vor in den Protokollen verfügbar und können gesucht werden.

So laden und entladen Sie das Edit-CsClsScenario-Cmdlet mithilfe des Moduls "ClsController.psm1"

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".

Wichtig

Das Modul ClsController.psm1 wird als separater Webdownload bereitgestellt. Das Modul ist Teil der Debugtools von Lync Server 2013. Standardmäßig werden die Debugtools im Verzeichnis C:\Program Files\Lync Server 2013\Debugging Tools installiert.
Geben Sie in der Windows PowerShell Folgendes ein:
```
Import-Module "C:\Program Files\Lync Server 2013\Debugging Tools\ClsController.psm1"
```
Tipp

Beim erfolgreichen Laden des Moduls kehren Sie zur Windows PowerShell Eingabeaufforderung zurück. Um zu bestätigen, dass das Modul geladen ist und dass Edit-CsClsScenario verfügbar ist, geben Sie Get-Help Edit-CsClsScenarioein. Daraufhin sollte die grundlegende Kurzfassung der Syntax für „EditCsClsScenario“ angezeigt werden.
Geben Sie zum Entladen des Moduls Folgendes ein:
```
Remove-Module ClsController
```
Tipp

Das erfolgreiche Entladen des Moduls gibt Sie an die Windows PowerShell Eingabeaufforderung zurück. Um zu bestätigen, dass das Modul entladen wurde, geben Sie Get-Help Edit-CsClsScenarioein. Windows PowerShell versucht, die Hilfe für das Cmdlet zu finden, und schlägt fehl.

So entfernen Sie einen vorhandenen Anbieter mithilfe des Edit-ClsController-Moduls aus einem Szenario

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Geben Sie Folgendes ein, um einen Anbieter aus dem Szenario „AlwaysOn“ zu entfernen:
```
Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
```
Beispiel:
```
Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Remove
```
Bei den Parametern „ScenarioName“ und „ProviderName“ handelt es sich um Positionsparameter (d. h., dass sie in der erwarteten Position in der Eingabeaufforderung definiert werden müssen). Der Parametername muss nicht explizit definiert werden, sofern der Szenarioname an zweiter Position und der Anbieter an dritter Position steht (in Bezug auf den Namen des Cmdlets, der an erster Position steht):
```
Edit-CsClsScenario AlwaysOn ChatServer -Remove
```
Die Platzierung der Parameterwerte an einer bestimmten Position gilt nur für „–Scenario“ und „–Provider“. Alle anderen Parameter müssen explizit definiert werden.

So fügen Sie ein Szenario mit dem Modul „Edit-ClsController“ hinzu

Starten Sie die Lync Server-Verwaltungsshell: Klicken Sie auf "Start", dann auf "Alle Programme", dann auf "Microsoft Lync Server 2013" und dann auf "Lync Server-Verwaltungsshell".
Geben Sie Folgendes ein, um einen Anbieter zum Szenario „AlwaysOn“ hinzuzufügen:
```
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>
```
Beispiel:
```
Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
```
Mögliche Typen für „-Loglevel“ sind „Fatal“, „Error“, „Warning“, „Info“, „Verbose“, „Debug“ oder „All“. Für „–Flags“ sind sämtliche Flags möglich, die vom Anbieter unterstützt werden, beispielsweise TF_COMPONENT, TF_DIAG. Der Wert ALL ist für „–Flags“ ebenfalls möglich.

Das vorherige Beispiel kann auch mithilfe der Positionsfunktion des Cmdlets eingegeben werden. So würden Sie beispielsweise Folgendes eingeben, um „ChatServer“ zum Szenario „AlwaysOn“ hinzuzufügen:
```
Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL
```