Partager via

  • Article

Remove-CsDiagnosticHeaderConfiguration

 

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

Supprime une ou plusieurs collections de paramètres de configuration des en-têtes de diagnostic actuellement utilisés 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

Remove-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-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 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 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 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.)

Vous pouvez également créer des paramètres personnalisés au niveau de l’étendue Site ou Service (pour le service Serveur d’inscriptions ou le serveur Edge). 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 Edge.

Toute nouvelle collection que vous créez (au niveau de l’étendue Site ou Service) peut par la suite être supprimée avec la cmdlet Remove-CsDiagnosticHeaderConfiguration. Vous pouvez également exécuter cette cmdlet sur la collection globale. Toutefois, la collection globale n’est pas supprimée dans ce cas car sa suppression est impossible. Au lieu de cela, les deux propriétés contenues dans la collection globale (SendToExternalNetworks et SendToOutsideUnauthenticatedUsers) sont réinitialisées à leurs valeurs par défaut (False dans chaque cas).

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

Paramètres

Paramètre Obligatoire Type Description

Identity

Obligatoire

XdsIdentity

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

Remove-CsDiagnosticHeaderConfiguration peut également être exécutée avec les paramètres de configuration globaux ; dans ce cas, utilisez la syntaxe : –Identity global. Notez cependant que les paramètres globaux ne seront pas réellement supprimés ; au lieu de cela, les propriétés trouvées dans les paramètres globaux seront réinitialisées à leurs valeurs par défaut.

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. Remove-CsDiagnosticHeaderConfiguration accepte les instances transmises via le pipeline de l’objet de paramètres d’en-tête de diagnostic.

Types de retours

Aucun. Au lieu de cela, Remove-CsDiagnosticHeaderConfiguration supprime les instances existantes de l’objet Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemple

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

Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond

Dans l’exemple 1, les paramètres de configuration des en-têtes de diagnostic dont l’identité est site:Redmond sont supprimés.

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

Get-CsDiagnosticHeaderConfiguration -Filter service:* | Remove-CsDiagnosticHeaderConfiguration

La commande présentée dans l’exemple 2 supprime tous les paramètres de configuration des en-têtes de diagnostic qui ont été appliqués au niveau de l’étendue Service. Pour ce faire, la commande appelle d’abord Get-CsDiagnosticHeaderConfiguration et le paramètre Filter. La valeur du filtre « service:* » limite les données retournées aux paramètres dont l’identité commence par les caractères « service: ». Cette collection filtrée est alors redirigée vers Remove-CsDiagnosticHeaderConfiguration, qui supprime chaque élément contenu dans la collection.

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

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

La commande précédente supprime tous les paramètres de configuration des en-têtes de diagnostic qui autorisent l’envoi à des réseaux externes. Pour ce faire, la commande utilise d’abord Get-CsDiagnosticHeaderConfiguration pour retourner une collection de tous les paramètres 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. Ces paramètres sont ensuite redirigés vers Remove-CsDiagnosticHeaderConfiguration qui supprime chaque paramètre autorisant l’envoi à des réseaux externes.