Partager via

  • Article

Get-CsDiagnosticHeaderConfiguration

 

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

Renvoie des informations sur tous les paramètres de configuration des en-têtes de diagnostic 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. Ces données sont utiles pour établir des rapports d’erreurs et résoudre les incidents.

Syntaxe

Get-CsDiagnosticHeaderConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsDiagnosticHeaderConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Description détaillée

Lorsque vous envoyez des messages SIP (Session Initiation Protocol), vous avez la possibilité de joindre un en-tête de diagnostic ms à chaque message. 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 au sein de votre réseau interne, il est préférable d’inclure ces en-têtes de diagnostic : ils ont en effet 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 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 de l’étendue Service (pour le service Serveur d’inscriptions ou 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 de périphérie.

La cmdlet Get-CsDiagnosticHeaderConfiguration permet de retourner les informations concernant les paramètres de configuration des en-têtes de diagnostic utilisés dans votre organisation.

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

Paramètres

Paramètre Obligatoire Type Description

Identity

Facultatif

XdsIdentity

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

Si ce paramètre n’est pas spécifié, alors tous les paramètres de configuration des en-têtes de diagnostic utilisés dans votre organisation sont retournés.

Filter

Facultatif

Chaîne

Permet d’utiliser des caractères génériques lorsque vous indiquez la ou les collections de paramètres à retourner. Par exemple, cette syntaxe retourne tous les paramètres configurés au niveau de l’étendue Site : -Filter "site:*". Cette syntaxe retourne tous les paramètres configurés au niveau de l’étendue Service : -Filter "service:*".

Notez que vous ne pouvez pas utiliser les paramètres –Identity et –Filter dans la même commande.

LocalStore

Facultatif

Paramètre de commutateur

Récupère les données de configuration d’en-tête de diagnostic à partir du réplica local du magasin central de gestion et non depuis le magasin central de gestion lui-même.

Types d’entrées

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

Types de retours

Get-CsDiagnosticHeaderConfiguration retourne des instances de l’objet Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemple

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

Get-CsDiagnosticHeaderConfiguration

La commande ci-dessus retourne des informations sur tous les paramètres de configuration des en-têtes de diagnostic utilisés dans l’organisation. Cela s’effectue par l’appel de Get-CsDiagnosticHeaderConfiguration sans paramètres.

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

Get-CsDiagnosticHeaderConfiguration -Identity site:Redmond

Dans l’exemple 2, n’est retournée qu’une seule collection de paramètres de configuration des en-têtes de diagnostic. Il s’agit de la collection dont l’identité est site:Redmond.

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

Get-CsDiagnosticHeaderConfiguration -Filter "service:*"

La commande illustrée dans l’exemple 3 retourne tous les paramètres des en-têtes de diagnostic qui ont été configurés au niveau de l’étendue Service. Cela s’effectue par l’appel de Get-CsDiagnosticHeaderConfiguration et du paramètre Filter ; la valeur du filtre "service:*" garantit que seuls les paramètres dont l’identité commence par les caractères "service:" sont retournés.

-------------------------- Exemple 4 ------------------------

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

L’exemple 4 retourne 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 sans paramètres 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.

-------------------------- Exemple 5 ------------------------

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

La commande illustrée dans l’exemple 5 retourne des informations sur tous les paramètres de configuration des en-têtes de diagnostic répondant au moins à l’un des critères suivants : 1) la propriété SendToExternalNetworks est égale à True et/ou 2) la propriété SendToOutsideUnauthenticatedUsers est égale à True. 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 alors redirigée vers Where-Object, qui sélectionne uniquement les paramètres dont les propriétés SendToExternalNetworks et/ou SendToOutsideUnauthenticatedUsers sont égales à True.

L’opérateur -or spécifie que, pour être retournés, les paramètres ne doivent répondre qu’à un seul des critères indiqués. Pour faire en sorte que les paramètres répondent aux deux critères spécifiés, utilisez l’opérateur -and :

Where-Object {$_.SendToExternalNetworks -eq $True -and $_.SendToOutsideUnauthenticatedUsers -eq $True}