Remove-CsDiagnosticHeaderConfiguration

 

Letztes Änderungsdatum des Themas: 2012-03-27

Entfernt eine oder mehrere der derzeit in Ihrer Organisation verwendeten Auflistungen von Konfigurationseinstellungen für Diagnoseheader. Mit diesen Einstellungen wird bestimmt, ob SIP-Nachrichten von Headerinformationen begleitet werden, die für die Problembehandlung und Fehlerberichterstattung nützlich sein können.

Syntax

Remove-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detaillierte Beschreibung

Administratoren haben die Möglichkeit, jeder in ihrer Organisation gesendeten SIP-Nachricht einen Header vom Typ "ms-diagnostics" anzufügen. Diese Nachricht (die Endbenutzern nicht angezeigt wird) enthält Informationen, die bei der Behandlung von Verbindungsproblemen oder in Fehlerberichten nützlich sein können. Der Diagnoseheader kann beispielsweise Fehlercodes enthalten, die es der Clientanwendung ermöglichen, vordefinierte Aktionen auszuführen, sollte eine bestimmte Situation eintreten.

Bei innerhalb in Ihrem internen Netzwerk gesendeten SIP-Nachrichten gibt es keinen Grund, diese Diagnoseheader nicht zu verwenden: Sie haben kaum Einfluss auf die Nachrichtengröße und sind ein unschätzbares Tool für Administratoren bei der Behebung von Verbindungsproblemen. Diagnoseheader enthalten jedoch auch Informationen, z. B. die vollqualifizierten Domänennamen Ihrer SIP-Server (FQDNs), die andere Personen außerhalb des internen Netzwerks u. U. nicht sehen sollen. Aus diesem Grund können Sie in den Konfigurationseinstellungen für Diagnoseheader festlegen, ob Diagnoseheader an Empfänger in externen Netzwerken (z. B. Benutzern in einer Partnerdomäne) und/oder externe Benutzer gesendet werden sollen. (Externe Benutzer sind Benutzer, die sich von außerhalb des internen Netzwerks verbinden und noch nicht authentifiziert wurden.)

Alternativ können Sie benutzerdefinierte Einstellungen auf Standort- oder Dienstebene (entweder für den Edgeserver oder für den Registrierungsdienst) erstellen. Auf diese Weise können Sie bestimmen, dass Diagnoseheader Nachrichten hinzugefügt werden, die von einem Standort oder über einen einzelnen Edgeserver gesendet werden, während Nachrichten, die von anderen Standorten oder über andere Edgeserver gesendet werden, keine Header hinzugefügt werden sollen.

Alle neuen Auflistungen, die Sie erstellen (auf Standort- oder Dienstebene), können später mit dem Cmdlet Remove-CsDiagnosticHeaderConfiguration entfernt werden. Sie können dieses Cmdlet auch für die globale Auflistung ausführen. In diesem Fall wird die globale Auflistung jedoch nicht entfernt, da dies nicht möglich ist. Stattdessen werden die beiden Eigenschaften in der globalen Auflistung – "SendToExternalNetworks" und "SendToOutsideUnauthenticatedUsers" – auf die Standardwerte zurückgesetzt (jeweils "False").

Dieses Cmdlet kann von folgenden Benutzern ausgeführt werden: Standardmäßig dürfen Mitglieder der folgenden Gruppen das Cmdlet Remove-CsDiagnosticHeaderConfiguration lokal ausführen: RTCUniversalServerAdmins. Geben Sie den folgenden Befehl an der Windows PowerShell-Eingabeaufforderung ein, um eine Liste aller rollenbasierten Zugriffssteuerungsrollen zurückzugeben, die diesem Cmdlet zugewiesen wurden (einschließlich der benutzerdefinierten rollenbasierten Zugriffssteuerungsrollen, die Sie selbst erstellt haben):

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

Parameter

Parameter Erforderlich Typ Beschreibung

Identity

Erforderlich

XdsIdentity

Die eindeutige ID für die Konfigurationseinstellungen für Diagnoseheader, die entfernt werden sollen. Verwenden Sie eine Syntax wie die folgende, um die auf Standortebene konfigurierten Einstellungen zu entfernen: -Identity "site:Redmond". Verwenden Sie eine Syntax wie die folgende, um die auf Dienstebene konfigurierten Einstellungen zu entfernen: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com".

Remove-CsDiagnosticHeaderConfiguration kann auch für die globalen Konfigurationseinstellungen ausgeführt werden. Verwenden Sie in diesem Fall folgende Syntax: –Identity global. Beachten Sie jedoch, dass die globalen Einstellungen nicht wirklich entfernt werden. Stattdessen werden die Eigenschaften in den globalen Einstellungen auf ihre Standardwerte zurückgesetzt.

Force

Optional

Switch-Parameter

Unterdrückt die Anzeige von Meldungen bei nicht schwerwiegenden Fehlern, die beim Ausführen des Befehls auftreten können.

WhatIf

Optional

Switch-Parameter

Beschreibt die Auswirkungen einer Ausführung des Befehls, ohne den Befehl tatsächlich auszuführen.

Confirm

Optional

Switch-Parameter

Fordert Sie vor der Ausführung des Befehls zum Bestätigen auf.

Eingabetypen

Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings-Objekt. Remove-CsDiagnosticHeaderConfiguration akzeptiert weitergeleitete Instanzen des Objekts für die Diagnoseheadereinstellungen.

Rückgabetypen

Keine. Mit Remove-CsDiagnosticHeaderConfiguration werden stattdessen vorhandene Instanzen des Objekts "Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings" gelöscht.

Beispiel

-------------------------- Beispiel 1 ------------------------

Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond

In Beispiel 1 werden nur die Konfigurationseinstellungen für Diagnoseheader mit dem Identitätswert "site:Redmond" entfernt.

-------------------------- Beispiel 2 ------------------------

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

Der Befehl in Beispiel 2 löscht alle Konfigurationseinstellungen für Diagnoseheader, die auf Dienstebene angewendet wurden. Dazu ruft der Befehl Get-CsDiagnosticHeaderConfiguration mit dem Parameter "Filter" auf. Mit dem Filterwert "service:*" werden aus den zurückgegebenen Daten die Einstellungen herausgefiltert, bei denen der Identitätswert mit den Zeichen "service:" beginnt. Diese gefilterte Auflistung wird dann an Remove-CsDiagnosticHeaderConfiguration weitergeleitet, um sämtliche Elemente in der Auflistung zu löschen.

-------------------------- Beispiel 3 ------------------------

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

Mit dem vorstehenden Befehl werden alle Konfigurationseinstellungen für Diagnoseheader gelöscht, die das Senden an externe Netzwerke zulassen. Hierzu verwendet der Befehl zunächst Get-CsDiagnosticHeaderConfiguration, um eine Auflistung aller derzeit verwendeten Diagnoseheadereinstellungen zurückzugeben. Diese Auflistung wird dann an das Cmdlet Where-Object weitergeleitet, das nur die Einstellungen herausfiltert, bei denen die Eigenschaft "SendToExternalNetworks" den Wert "True" aufweist. Diese Einstellungen werden dann an Remove-CsDiagnosticHeaderConfiguration weitergeleitet, um sämtliche Einstellungen zu löschen, die das Senden an externe Netzwerke zulassen.