Partager via

  • Article

New-CsDiagnosticHeaderConfiguration

 

Dernière rubrique modifiée : 2012-03-23

Crée une nouvelle collection de paramètres de configuration pour l’en-tête de diagnostic. Les paramètres de configuration de l’en-tête de diagnostic déterminent si les messages SIP doivent être accompagnés d’informations d’en-tête pouvant être utiles au dépannage des erreurs ou à leur consignation dans des rapports.

Syntaxe

New-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-SendToExternalNetworks <$true | $false>] [-SendToOutsideUnauthenticatedUsers <$true | $false>] [-WhatIf [<SwitchParameter>]]

Description détaillée

Les administrateurs ont la possibilité de joindre un en-tête de diagnostic ms à chaque message SIP envoyé dans une organisation. Ce message (que les utilisateurs finaux ne voient pas) contient des informations qui pourraient se révéler utiles pour la résolution des problèmes de connexion ou le signalement des erreurs. Par exemple, l’en-tête de diagnostic peut contenir des codes d’erreur qui indiquent à l’application cliente (Microsoft Lync 2010, notamment) de prendre des mesures prédéterminées quand une situation particulière se présente.

Pour les messages SIP envoyés à l’intérieur du réseau interne, peu de raisons s’opposent à ce que les en-têtes de diagnostic ne soient pas inclus. Ils ont un impact minimal sur la taille du message et peuvent constituer un outil précieux pour les administrateurs qui tentent de résoudre des problèmes de connectivité. Toutefois, les en-têtes de diagnostic contiennent également des informations, telles que les noms de domaine complets (FQDN) de vos serveurs SIP, que vous ne souhaitez pas mettre à la disposition des personnes externes au réseau. De ce fait, les paramètres de configuration permettent de décider si vous souhaitez envoyer des en-têtes de diagnostic aux utilisateurs situés sur des réseaux externes (par exemple, des utilisateurs dans un domaine fédéré) et/ou à des utilisateurs externes. (Les utilisateurs externes sont des utilisateurs qui se sont connectés depuis un réseau externe et qui n’ont pas encore été authentifiés.)

Par défaut, les en-têtes de diagnostic ne sont pas inclus dans les messages envoyés vers des réseaux externes ou vers des utilisateurs non authentifiés. Cependant, vous pouvez modifier les paramètres globaux des en-têtes de diagnostic pour les mettre à la disposition des réseaux externes ou des utilisateurs non authentifiés. Vous pouvez également créer des paramètres personnalisés au niveau de l’étendue Site ou Service (pour le serveur Edge ou le service Serveur d’inscriptions). Ainsi, vous pouvez choisir d’inclure les en-têtes de diagnostic pour les messages envoyés à partir d’un site ou par un serveur Edge, tout en désactivant les en-têtes de messages envoyés d’autres sites ou par les autres serveurs Edge.

Les paramètres d’en-tête de diagnostic personnalisés sont créés à l’aide de la cmdlet New-CsDiagnosticHeaderConfiguration. Comme nous l’avons fait remarquer, les nouveaux paramètres peuvent être créés soit dans l’étendue du site soit dans celle du service (mais pour les services serveur Edge et le service d’inscriptions uniquement). Il faut garder à l’esprit que vous ne pouvez avoir qu’une seule collection de paramètres de ce genre par site ou par service. Par exemple, supposons que vous essayiez de créer une nouvelle collection pour le site Redmond, et que le site héberge déjà une collection de paramètres d’en-tête de diagnostic. Dans ce cas, votre commande échouera. De la même manière, votre commande échouera si vous essayez de créer une nouvelle collection pour l’étendue globale.

Personnes autorisées à exécuter cette cmdlet : Par défaut, les membres des groupes qui suivent sont autorisés à exécuter localement la cmdlet New-CsDiagnosticHeaderConfiguration : RTCUniversalServerAdmins. Pour retourner une liste de tous les rôles RBAC (Contrôle d’accès basé sur un rôle) auxquels cette cmdlet a été affectée (y compris les rôles RBAC personnalisés créés par vos soins), exécutez la commande suivante à l’invite Windows PowerShell :

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticHeaderConfiguration"}

Paramètres

Paramètre Obligatoire Type Description

Identity

Obligatoire

XdsIdentity

Identificateur unique à créer pour les paramètres de configuration de l’en-tête de diagnostic. Pour créer une nouvelle collection de paramètres au niveau du site, utilisez une syntaxe similaire à celle-ci : -Identity "site:Redmond". Pour créer une nouvelle collection de paramètres au niveau du site, utilisez une syntaxe similaire à celle-ci : -Identity "service:EdgeServer:atl-cs-001.litwareinc.com".

Vous ne pouvez pas créer de nouveaux paramètres pour l’étendue globale. De plus, vous ne pouvez pas créer de nouveaux paramètres pour l’étendue de site ou de service si le site ou le service spécifié (par exemple, site:Redmond) héberge déjà une collection de paramètres.

SendToExternalNetworks

Facultatif

Booléen

Lorsque la valeur est True, des en-têtes de diagnostic sont joints aux messages envoyés aux utilisateurs sur des réseaux externes (tels que les utilisateurs dans un domaine fédéré). La valeur par défaut est False.

SendToOutsideUnauthenticatedUsers

Facultatif

Booléen

Lorsque la valeur est True, des en-têtes de diagnostic sont joints aux messages envoyés aux utilisateurs. Les utilisateurs externes sont des utilisateurs qui se sont connectés depuis un réseau externe (comme un serveur proxy) et qui n’ont pas encore été authentifiés.

La valeur par défaut est False.

Force

Facultatif

Paramètre de commutateur

Supprime l’affichage de tous les messages d’erreur récupérable susceptibles d’apparaître lors de l’exécution de la commande.

InMemory

Facultatif

Paramètre de commutateur

Crée une référence d’objet sans valider l’objet comme une modification définitive. Si vous affectez à une variable la sortie de cette cmdlet appelée avec ce paramètre, vous pouvez apporter des modifications aux propriétés de la référence d’objet, puis les valider en appelant la cmdlet Set- correspondante.

WhatIf

Facultatif

Paramètre de commutateur

Décrit ce qui se passe si vous exécutez la commande sans l’exécuter réellement.

Confirm

Facultatif

Paramètre de commutateur

Vous demande confirmation avant d’exécuter la commande.

Types d’entrées

Aucun. New-CsDiagnosticHeaderConfiguration n’accepte pas la saisie de données transmises via le pipeline.

Types de retours

New-CsDiagnosticHeaderConfiguration crée de nouvelles instances de l’objet Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemple

-------------------------- Exemple 1 --------------------------

New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True

L’exemple 1 crée une nouvelle configuration d’en-tête de diagnostic pour le site Redmond (-Identity site:Redmond). En plus de spécifier l’identité, la commande utilise également le paramètre SendToOutsideAuthenticatedUsers et la valeur de paramètre $True. Cela permet d’envoyer des informations aux utilisateurs authentifiés qui se trouvent en dehors du réseau interne.

-------------------------- Exemple 2 --------------------------

$x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond
$x.SendToOutsideUnauthenticatedUsers = $True
$x.SendToExternalNetworks = $True
Set-CsDiagnosticHeaderConfiguration -Instance $x

Les commandes illustrées à l’exemple 2 montrent comment créer une collection de paramètres d’en-tête de diagnostic n’existant qu’en mémoire initialement. Pour ce faire, la première commande appelle New-CsDiagnosticHeaderConfiguration ainsi que le paramètre Identity. L’objet résultant est enregistré dans la variable $x.

Une fois les paramètres virtuels créés, les commandes 2 et 3 sont utilisées pour modifier les valeurs des propriétés SendToOutsideUnauthenticatedUsers et SendToExternalNetworks respectivement. Enfin, la commande 4 est utilisée pour transformer les paramètres de configuration d’en-tête de diagnostic en collection virtuelle de paramètres appliqués au site Redmond. Notez que cette commande finale est obligatoire. Si vous n’appelez pas Set-CsDiagnosticHeaderConfiguration, aucun paramètre ne sera appliqué au site et les paramètres virtuels disparaîtront dès que vous aurez terminé votre session Windows PowerShell ou supprimé la variable $x.