New-CsDiagnosticHeaderConfiguration

 

Letztes Änderungsdatum des Themas: 2012-03-23

Erstellt eine neue Auflistung 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

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

Detaillierte Beschreibung

Administratoren haben die Möglichkeit, jeder in einer 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 Diagnoseheader 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.

Benutzerdefinierte Diagnoseheadereinstellungen werden mit dem Cmdlet New-CsDiagnosticHeaderConfiguration erstellt. Neue Einstellungen können, wie schon erwähnt, entweder auf Standort- oder Dienstebene (jedoch nur für den Edgeserver oder den Registrierungsdienst) erstellt werden. Bedenken, dass nur eine solche Einstellungsauflistung pro Standort oder Dienst möglich ist. Angenommen, Sie versuchen, eine neue Auflistung für den Standort "Redmond" zu erstellen, und für diesen Standort gibt es bereits eine Auflistung von Diagnoseheadereinstellungen. In diesem Fall hat Ihr Befehl keinen Erfolg. Der Befehl ebenfalls nicht erfolgreich, wenn Sie versuchen, eine neue Auflistung auf globaler Ebene zu erstellen.

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

Parameter

Parameter Erforderlich Typ Beschreibung

Identity

Erforderlich

XdsIdentity

Eindeutige ID der zu erstellenden Konfigurationseinstellungen für Diagnoseheader. Verwenden Sie eine Syntax wie die folgende, um eine neue Einstellungsauflistung auf Standortebene zu erstellen: -Identity "site:Redmond". Verwenden Sie eine Syntax wie die folgende, um eine neue Einstellungsauflistung auf Dienstebene zu erstellen: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com".

Neue Einstellungen können nicht auf globaler Ebene erstellt werden. Ebenso können Sie keine neuen Einstellungen auf Standort- oder Dienstebene erstellen, wenn der angegebene Standort oder Dienst (z. B. "site:Redmond") bereits eine Auflistung von Einstellungen aufweist.

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.

InMemory

Optional

Switch-Parameter

Erstellt einen Objektverweis ohne einen Commit für das Objekt auszuführen und die Änderungen dadurch dauerhaft zu speichern. Wenn Sie die Ausgabe des mit diesem Parameter aufgerufenen Cmdlet einer Variablen zuweisen, können Sie die Eigenschaften des Objektverweises ändern und anschließend einen Commit für diese Änderungen ausführen, indem Sie das entsprechende Cmdlet vom Typ "Set-" aufrufen.

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

Keine. New-CsDiagnosticHeaderConfiguration akzeptiert keine weitergeleitete Eingabe.

Rückgabetypen

Mit New-CsDiagnosticHeaderConfiguration werden neue Instanzen des Objekts "Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings" erstellt.

Beispiel

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

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

In Beispiel 1 wird eine neue Diagnoseheaderkonfiguration für den Standort "Redmond" (-Identity site:Redmond) erstellt. Zusätzlich zum Angeben des Identitätswerts verwendet dieser Befehl auch den Parameter "SendToOutsideAuthenticatedUsers" und den Parameterwert "$True", wodurch das Senden von Informationen an authentifizierte Benutzer außerhalb des internen Netzwerks ermöglicht wird.

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

$x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond
$x.SendToOutsideUnauthenticatedUsers = $True
$x.SendToExternalNetworks = $True
Set-CsDiagnosticHeaderConfiguration -Instance $x

Die Befehle in Beispiel 2 zeigen, wie Sie eine neue Auflistung von Diagnoseheadereinstellungen erstellen können, die nur im Arbeitsspeicher vorhanden ist. Hierzu ruft der erste Befehl im Beispiel New-CsDiagnosticHeaderConfiguration mit dem Parameter "Identity" auf. Das resultierende Objekt wird in der Variablen "$x" gespeichert.

Nach der Erstellung der virtuellen Einstellungen dienen die Befehle 2 und 3 zum Ändern der Werte der Eigenschaften "SendToOutsideUnauthenticatedUsers" bzw. "SendToExternalNetworks". Der vierte Befehl dient schließlich dazu, die virtuellen Konfigurationseinstellungen für Diagnoseheader in eine tatsächliche Auflistung von Einstellungen umzuwandeln, die auf den Standort "Redmond" angewendet wird. Dieser letzte Befehl ist verbindlich. Wenn Sie Set-CsDiagnosticHeaderConfiguration nicht aufrufen, werden keine Einstellungen auf den Standort angewendet, und die virtuellen Einstellungen gehen verloren, sobald Sie die Windows PowerShell-Sitzung beenden oder die Variable "$x" löschen.