Partager via

  • Article

Set-CsDiagnosticHeaderConfiguration

 

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

Modifie une collection de paramètres de configuration d’en-têtes de diagnostic existante actuellement utilisée dans votre organisation. Les paramètres de configuration des en-têtes de diagnostic déterminent si les messages SIP sont accompagnés d’informations d’en-tête, parfois utiles pour le dépannage et le signalement des erreurs.

Syntaxe

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

Set-CsDiagnosticHeaderConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-SendToExternalNetworks <$true | $false>] [-SendToOutsideUnauthenticatedUsers <$true | $false>] [-WhatIf [<SwitchParameter>]]

Description détaillée

Les administrateurs peuvent joindre un en-tête ms-diagnostic à chaque message SIP transmis dans leur organisation. Ce message (que les utilisateurs finaux ne voient pas) contient des informations qui pourraient s’avérer 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 au sein de votre réseau interne, il est préférable d’inclure ces en-têtes de diagnostic : 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 situées en dehors de votre réseau interne. 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 ne sont pas inclus dans les messages envoyés vers des réseaux externes ou vers des utilisateurs non authentifiés. Toutefois, vous pouvez modifier les paramètres globaux afin d’inclure des en-têtes pour les réseaux externes et/ou les 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). Vous pouvez ainsi choisir d’inclure des en-têtes de diagnostic dans les messages envoyés depuis un site, ou via un serveur Edge, tout en évitant d’en inclure dans les messages envoyés à partir d’autres sites ou via d’autres serveurs de périphérie.

La cmdlet Set-CsDiagnosticHeaderConfiguration fournit un moyen de modifier une collection de paramètres de configuration d’en-têtes de diagnostic existante. Vous pouvez utiliser cette cmdlet pour activer (ou désactiver) la transmission des en-têtes de diagnostic vers des réseaux externes et/ou des utilisateurs externes.

Personnes autorisées à exécuter cette cmdlet : Par défaut, les membres des groupes qui suivent sont autorisés à exécuter localement la cmdlet Set-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 "Set-CsDiagnosticHeaderConfiguration"}

Paramètres

Paramètre Obligatoire Type Description

Identity

Facultatif

XdsIdentity

Identificateur unique pour les paramètres de configuration des en-têtes de diagnostic à modifier. Pour modifier les paramètres configurés au niveau de l’étendue Site, utilisez une syntaxe similaire à celle-ci : -Identity "site:Redmond". Pour modifier les paramètres configurés au niveau de l’étendue Service, utilisez une syntaxe semblable à ceci : -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Pour modifier les paramètres globaux, utilisez cette syntaxe : -Identity global.

Si vous ne définissez pas ce paramètre, Set-CsDiagnosticHeaderConfiguration modifiera automatiquement les paramètres globaux.

Instance

Facultatif

Objet DiagnosticHeaderSettings

Permet de transmettre une référence à un objet à la cmdlet plutôt que de définir des valeurs de paramètre individuelles.

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 externes. Les utilisateurs externes sont des utilisateurs qui se sont connectés en dehors du réseau interne (par exemple, via 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.

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

Objet Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings. Set-CsDiagnosticHeaderConfiguration accepte les instances transmises via le pipeline de l’objet de paramètres d’en-tête de diagnostic.

Types de retours

Set-CsDiagnosticHeaderConfiguration ne retourne ni objet, ni valeur. Au lieu de cela, la cmdlet modifie les instances existantes de l’objet Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemple

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

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

La commande ci-dessus modifie les paramètres de configuration des en-têtes de diagnostic dont l’identité est site:Redmond. Dans cet exemple, la valeur de la propriété SendToOutsideUnauthenticatedUsers est définie sur True.

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

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

La commande présentée dans l’exemple 2 est une variante de la commande dévoilée dans l’exemple 1. Cependant, dans le cas présenté ici, la propriété SendToOutsideUnauthenticatedUsers est modifiée pour tous les paramètres de configuration des en-têtes de diagnostic utilisés. Pour ce faire, Get-CsDiagnosticHeaderConfiguration est préalablement appelée sans paramètre, ce qui retourne une collection de tous les paramètres d’en-têtes de diagnostic actuellement utilisés. Cette collection est ensuite redirigée vers Set-CsDiagnosticHeaderConfiguration qui définit la propriété SendToOutsideUnauthenticatedUsers de chaque élément de la collection sur True.

-------------------------- Exemple 3 ------------------------

Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

Dans l’exemple 3, la propriété SendToOutsideUnauthenticatedUsers est modifiée à nouveau, mais cette fois uniquement pour les paramètres des en-têtes de diagnostic dont la propriété SendToExternalNetworks a la valeur True. Pour effectuer cette tâche, la commande utilise d’abord Get-CsDiagnosticHeaderConfiguration pour retourner une collection de tous les paramètres de configuration des en-têtes de diagnostic actuellement utilisés. Cette collection est ensuite redirigée vers la cmdlet Where-Object qui sélectionne uniquement les paramètres dont la propriété SendToExternalNetworks est égale à True. Cette collection filtrée est ensuite redirigée vers Set-CsDiagnosticHeaderConfiguration qui définit la valeur de la propriété SendToOutsideUnauthenticatedUsers de chaque élément de la collection sur True.