Configuration de scénarios pour le service de journalisation centralisée dans Lync Server 2013

Article
07/23/2014

Rubrique Dernière modification : 2014-02-05

Les scénarios définissent l’étendue (c’est-à-dire globale, le site, le pool ou l’ordinateur) et les fournisseurs à utiliser dans le service de journalisation centralisée. 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. Si vous constatez qu’un scénario doit être modifié pour répondre à vos besoins de dépannage et de journalisation, les outils de débogage Lync Server 2013 vous fournissent un module Windows PowerShell nommé ClsController.psm1 qui contient une fonction nommée Edit-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. Les outils de débogage Lync Server 2013 sont téléchargés à partir du lien suivant : https://go.microsoft.com/fwlink/?LinkId=285257

Important

Pour une étendue donnée (globale, site, pool ou ordinateur), deux scénarios au maximum peuvent être exécutés en même temps. Pour déterminer les scénarios en cours d’exécution, utilisez Windows PowerShell et Get-CsClsScenario. En utilisant Windows PowerShell et Set-CsClsScenario, vous pouvez modifier dynamiquement les scénarios en cours d’exécution. Cette opération peut s’avérer utile lors d’une session de journalisation pour ajuster ou affiner les données que vous collectez et les fournisseurs d’où ces données sont issues.

Pour exécuter les fonctions du service de journalisation centralisée à l’aide de Lync Server Management Shell, vous devez être membre des groupes de sécurité CsAdministrator ou CsServerAdministrator, ou d’un rôle RBAC personnalisé qui contient l’un de ces deux groupes. Pour renvoyer la liste de tous les rôles RBAC auxquels cette applet de commande a été affectée, y compris les rôles RBAC personnalisés que vous avez créés vous-même, exécutez la commande suivante à partir de Lync Server Management Shell ou de l’invite Windows PowerShell :

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

Par exemple :

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

Le reste de cette rubrique porte sur la façon de définir, de modifier, de supprimer un scénario, de récupérer des scénarios en cours dʼexécution et de spécifier les éléments dʼun scénario afin dʼoptimiser la résolution de problèmes. Il existe deux façons d’émettre des commandes de service de journalisation centralisée. Vous pouvez utiliser le CLSController.exe qui se trouve, par défaut, dans le répertoire C:\Program Files\Common Files\Microsoft Lync Server 2013\CLSAgent. Vous pouvez également utiliser Lync Server Management Shell pour émettre des commandes Windows PowerShell. La distinction importante est que lorsque vous utilisez CLSController.exe sur la ligne de commande, une sélection finie de scénarios est disponible. Lorsque vous utilisez Windows PowerShell, vous pouvez définir de nouveaux scénarios à utiliser dans vos sessions de journalisation.

Comme indiqué dans Vue d’ensemble du service de journalisation centralisée dans Lync Server 2013, les éléments d’un scénario sont les suivants :

Fournisseurs Si vous êtes familiarisé avec OCSLogger, les fournisseurs sont les composants que vous choisissez pour indiquer à OCSLogger à partir de quoi le moteur de suivi doit collecter les journaux. Les fournisseurs sont les mêmes composants et, dans de nombreux cas, ont le même nom que les composants dans OCSLogger. Si vous n’êtes pas familiarisé avec OCSLogger, les fournisseurs sont des composants spécifiques au rôle serveur dont le service de journalisation centralisée peut collecter les journaux. Pour plus d’informations sur la configuration des fournisseurs, consultez Configuration des fournisseurs pour le service de journalisation centralisée dans Lync Server 2013.
Identité Le paramètre –Identity définit l’étendue et le nom du scénario. Par exemple, vous pouvez définir une étendue au niveau « global » et identifier le scénario avec « LyssServiceScenario ». Lorsque vous combinez les deux, vous définissez l’identité (par exemple, « global/LyssServiceScenario »).

Vous pouvez éventuellement utiliser les paramètres –Name et –Parent. Le paramètre Name permet d’identifier le scénario de manière unique. Si vous utilisez Name, vous devez également utiliser Parent pour ajouter le scénario à global ou site.

Important

Si vous utilisez les paramètres Name et Parent, vous ne pouvez pas utiliser le paramètre –Identity.

Pour créer un scénario avec l’applet de commande New-CsClsScenario

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Pour créer un nouveau scénario pour une session de journalisation, utilisez New-CsClsProvider et définissez le nom du scénario (cʼest-à-dire comment il va être identifié de manière unique). Choisissez un type de format de journalisation dans WPP (cʼest-à-dire le préprocesseur de suivi Windows défini par défaut), EventLog (format de journal des événements Windows) ou IISLog (fichier au format ASCII basé sur le format de fichier journal IIS). Ensuite, définissez Level (voir la définition sous Niveaux de journalisation de cette rubrique) et Flags (voir la définition sous Indicateurs dans cette rubrique).

Dans cet exemple de scénario, nous utilisons LyssProvider comme exemple de variable de fournisseur.

Pour créer un scénario en utilisant les options définies, tapez :
```
New-CsClsScenario -Identity <scope>/<unique scenario name> -Provider <provider variable>
```
Exemple :
```
New-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider $LyssProvider
```
Autre format utilisant –Name et –Parent :
```
New-CsClsScenario -Name "LyssServiceScenario" -Parent "site:Redmond" -Provider $LyssProvider
```

Pour créer un scénario avec plusieurs fournisseurs à l’aide de l’applet de commande New-CsClsScenario

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Vous êtes limité à deux scénarios par étendue. Cependant, le nombre de fournisseurs n’est pas limité. Dans cet exemple, supposons que vous avez créé trois fournisseurs et que vous souhaitez les affecter tous les trois au scénario que vous définissez. Les noms des variables de fournisseur sont LyssProvider, ABServerProvider et SIPStackProvider. Pour définir et affecter plusieurs fournisseurs à un scénario, tapez ce qui suit dans une invite de commandes Lync Server Management Shell ou Windows PowerShell :
```
New-CsClsScenario -Identity "site:Redmond/CollectDataScenario" -Provider @{Add=$LyssProvider, $ABServerProvider,  $SIPStackProvider}
```
Remarque

Comme on le sait dans Windows PowerShell, la convention de création d’une table de hachage de valeurs à l’aide @{<variable>=<value1>, <value2>, <value>...} est appelée « splatting ». Pour plus d’informations sur l’éclaboussure dans Windows PowerShell, consultez https://go.microsoft.com/fwlink/p/?LinkId=267760.

Pour modifier un scénario existant avec l’applet de commande Set-CsClsScenario

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Vous êtes limité à deux scénarios par étendue. Vous pouvez modifier les scénarios qui s’ exécutent à tout moment, même lorsqu’une session de capture de journalisation est en cours. Si vous redéfinissez les scénarios en cours d’exécution, la session de journalisation actuelle cesse d’utiliser le scénario qui a été supprimé et utilise ensuite le nouveau scénario. Toutefois, les informations de journalisation qui ont été capturées avec le scénario supprimé sont conservées dans les journaux capturés. Pour définir un nouveau scénario, procédez comme suit (pour cela, nous partons du principe qu’un fournisseur déjà défini nommé « S4Provider » a été ajouté) :
```
Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Add=<new provider to add>}
```
Exemple :
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Add=$S4Provider}
```
Si vous souhaitez remplacer des fournisseurs, définissez un fournisseur unique ou une liste séparée par des virgules des fournisseurs pour remplacer l’ensemble actuel. Si vous souhaitez seulement remplacer l’un des fournisseurs, ajoutez les fournisseurs actuels aux nouveaux fournisseurs pour créer un nouvel ensemble de fournisseurs contenant les nouveaux fournisseurs et les fournisseurs existants. Pour remplacer tous les fournisseurs par un nouvel ensemble, tapez ce qui suit :
```
Set-CsClsScenario -Identity <name of scope and scenario defined by New-CsClsScenario> -Provider @{Replace=<providers to replace existing provider set>}
```
Par exemple, pour remplacer l’ensemble actuel comprenant $LyssProvider, $ABServerProvider et $SIPStackProvider par $LyssServiceProvider :
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider}
```
Pour remplacer seulement le fournisseur $LyssProvider de l’ensemble actuel comprenant $LyssProvider, $ABServerProvider et $SIPStackProvider par $LyssServiceProvider, tapez ce qui suit :
```
Set-CsClsScenario -Identity "site:Redmond/LyssServiceScenario" -Provider @{Replace=$LyssServiceProvider, $ABServerProvider, $SIPStackProvider}
```

Pour supprimer un scénario existant avec l’applet de commande Remove-CsClsScenario

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Si vous souhaitez supprimer un scénario précédemment défini, tapez ce qui suit :
```
Remove-CsClsScenario -Identity <name of scope and scenario>
```
Par exemple, pour supprimer le scénario défini site:Redmond/LyssServiceScenario :
```
Remove-CsClsScenario -Identity "site:Redmond/LyssServiceScenario"
```

L’applet de commande Remove-CsClsScenario supprime le scénario spécifié, mais vous pouvez toujours accéder aux suivis capturés dans les journaux et lancer des recherches dans ceux-ci.

Pour charger et décharger l’applet de commande Edit-CsClsScenario à l’aide du module ClsController.psm1

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.

Important

Le module ClsController.psm1 est fourni en tant que téléchargement web distinct. Le module fait partie des outils de débogage Lync Server 2013. Par défaut, les outils de débogage sont installés dans le répertoire C:\Program Files\Lync Server 2013\Debugging Tools.
À partir de Windows PowerShell, tapez :
```
Import-Module "C:\Program Files\Lync Server 2013\Debugging Tools\ClsController.psm1"
```
Pointe

Le chargement réussi du module vous renvoie à l’invite de commandes Windows PowerShell. Pour vérifier que le module est chargé et que Edit-CsClsScenario est disponible, tapez Get-Help Edit-CsClsScenario. Le résumé de base de la syntaxe pour EditCsClsScenario doit apparaître.
Pour décharger les modules, tapez :
```
Remove-Module ClsController
```
Pointe

Le déchargement réussi du module vous renvoie à l’invite de commandes Windows PowerShell. Pour confirmer que le module est déchargé, tapez Get-Help Edit-CsClsScenario. Windows PowerShell tente de localiser l’aide de l’applet de commande et échoue.

Pour supprimer un fournisseur existant d’un scénario avec le module Edit-ClsController

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Pour supprimer un fournisseur du scénario AlwaysOn, tapez :
```
Edit-CsClsScenario -ScenarioName <string of the scenario to edit> -ProviderName <string of the provider to remove> -Remove
```
Par exemple :
```
Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Remove
```
Les paramètres ScenarioName et ProviderName sont positionnels (c’est-à-dire qu’ils doivent être définis dans la position attendue dans la ligne de commande). Il n’est pas nécessaire de définir explicitement le nom du paramètre si le nom du scénario est en position deux et que le fournisseur est en position trois par rapport au nom de l’applet de commande (en position un). Compte tenu de ces informations, la commande précédente ressemble alors à ceci :
```
Edit-CsClsScenario AlwaysOn ChatServer -Remove
```
Le placement positionnel des valeurs de paramètre s’applique uniquement à –Scenario et à –Provider. Tous les autres paramètres doivent être définis explicitement.

Pour ajouter un fournisseur à un scénario avec le module Edit-ClsController

Démarrez Lync Server Management Shell : cliquez sur Démarrer, cliquez sur Tous les programmes, sur Microsoft Lync Server 2013, puis sur Lync Server Management Shell.
Pour ajouter un fournisseur au scénario AlwaysOn, tapez :
```
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>
```
Par exemple :
```
Edit-CsClsScenario -ScenarioName AlwaysOn -ProviderName ChatServer -Level Info -Flags TF_COMPONENT
```
-Loglevel peut être du type Fatal, Error, Warning, Info, Verbose, Debug ou All. –Flags peut avoir pour valeur n’importe quel indicateur pris en charge par le fournisseur, comme TF_COMPONENT, TF_DIAG. –Flags peut également avoir la valeur ALL.

Il est aussi possible de taper l’exemple précédent à l’aide de la fonctionnalité positionnelle de l’applet de commande. Par exemple, pour ajouter le fournisseur ChatServer au scénario AlwaysOn, tapez :
```
Edit-CsClsScenario AlwaysOn ChatServer -Level Info -Flags ALL
```

Partager via