Set-CsDiagnosticHeaderConfiguration

 

Letztes Änderungsdatum des Themas: 2012-03-26

Ändert eine vorhandene Auflistung von Konfigurationseinstellungen für Diagnoseheader, die derzeit in Ihrer Organisation verwendet werden. 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

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>]]

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 (z. B. Microsoft Lync 2010) 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.)

Standardmäßig werden Nachrichten, die entweder an externe Netzwerke oder an nicht authentifizierte Benutzer gesendet werden, keine Header hinzugefügt. Sie können jedoch die globalen Einstellungen für Diagnoseheader so ändern, dass Header an externe Netzwerke und/oder nicht authentifizierte Benutzer gesendet werden. 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.

Mit dem Cmdlet Set-CsDiagnosticHeaderConfiguration können Sie eine vorhandene Auflistung von Konfigurationseinstellungen für Diagnoseheader ändern. Dieses Cmdlet ermöglicht es Ihnen, die Übertragung von Diagnoseheadern an externe Netzwerke und/oder externe Benutzer zu aktivieren (oder zu deaktivieren).

Dieses Cmdlet kann von folgenden Benutzern ausgeführt werden: Standardmäßig dürfen Mitglieder der folgenden Gruppen das Cmdlet Set-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 "Set-CsDiagnosticHeaderConfiguration"}

Parameter

Parameter Erforderlich Typ Beschreibung

Identity

Optional

XdsIdentity

Eindeutige ID der zu ändernden Konfigurationseinstellungen für Diagnoseheader. Verwenden Sie eine Syntax wie die folgende, um die auf Standortebene konfigurierten Einstellungen zu ändern: -Identity "site:Redmond". Verwenden Sie eine Syntax wie die folgende, um die auf Dienstebene konfigurierten Einstellungen zu ändern: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Verwenden Sie folgende Syntax, um die globalen Einstellungen zu ändern: -Identity global.

Wenn dieser Parameter nicht angegeben wird, ändert Set-CsDiagnosticHeaderConfiguration die globalen Einstellungen automatisch.

Instance

Optional

DiagnosticHeaderSettings-Objekt

Ermöglicht Ihnen, einen Verweis auf ein Objekt an das Cmdlet zu übergeben, statt individuelle Parameterwerte festzulegen.

SendToExternalNetworks

Optional

Boolescher Wert

Bei Festlegung auf "True" werden Diagnoseheader Nachrichten hinzugefügt, die an Benutzer in externen Netzwerken (z. B. in einer Partnerdomäne) gesendet werden. Der Standardwert lautet "False".

SendToOutsideUnauthenticatedUsers

Optional

Boolescher Wert

Bei Festlegung auf "True" werden Diagnoseheader Nachrichten hinzugefügt, die an externe Benutzer gesendet werden. Externe Benutzer sind Benutzer, die eine Verbindung von außerhalb des internen Netzwerks herstellen (z. B. über einen Proxyserver) und noch nicht authentifiziert wurden.

Der Standardwert lautet "False".

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. Set-CsDiagnosticHeaderConfiguration akzeptiert weitergeleitete Instanzen des Objekts für die Diagnoseheadereinstellungen.

Rückgabetypen

Set-CsDiagnosticHeaderConfiguration gibt keine Objekte oder Werte zurück. Stattdessen ändert das Cmdlet vorhandene Instanzen des Objekts "Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings".

Beispiel

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

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

Mit dem vorstehenden Befehl werden die Konfigurationseinstellungen für Diagnoseheader mit dem Identitätswert "site:Redmond" geändert. In diesem Beispiel wird der Wert der Eigenschaft "SendToOutsideUnauthenticatedUsers" auf "True" festgelegt.

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

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

Der Befehl in Beispiel 2 ist eine Variante des Befehls in Beispiel 1. In diesem Fall wird die Eigenschaft "SendToOutsideUnauthenticatedUsers" jedoch für alle verwendeten Konfigurationseinstellungen für Diagnoseheader geändert. Dazu wird Get-CsDiagnosticHeaderConfiguration zunächst ohne Parameter aufgerufen. Daraufhin wird eine Auflistung aller derzeit verwendeten Diagnoseheadereinstellungen zurückgegeben. Diese Auflistung wird dann an das Cmdlet Set-CsDiagnosticHeaderConfiguration weitergeleitet, das die Eigenschaft "SendToOutsideUnauthenticatedUsers" jedes Elements in der Auflistung auf "True" festlegt.

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

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

In Beispiel 3 wird die Eigenschaft "SendToOutsideUnauthenticatedUsers" erneut geändert, diesmal jedoch nur für die Diagnoseheadereinstellungen, bei denen die Eigenschaft "SendToExternalNetworks" den Wert "True" aufweist. Dazu verwendet der Befehl zunächst Get-CsDiagnosticHeaderConfiguration, um eine Auflistung aller derzeit verwendeten Konfigurationseinstellungen für Diagnoseheader zurückzugeben. Diese Auflistung wird an das Cmdlet Where-Object weitergeleitet, das die Einstellungen herausfiltert, bei denen die Eigenschaft "SendToExternalNetworks" den Wert "True" aufweist. Diese gefilterte Auflistung wird dann an das Cmdlet Set-CsDiagnosticHeaderConfiguration weitergeleitet, das den Wert der Eigenschaft "SendToOutsideUnauthenticatedUsers" für jedes Element in der Auflistung auf "True" festlegt.