Set-CsDiagnosticHeaderConfiguration

Syntax

Set-CsDiagnosticHeaderConfiguration
   [[-Identity] <XdsIdentity>]
   [-SendToExternalNetworks <Boolean>]
   [-SendToOutsideUnauthenticatedUsers <Boolean>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [-SendToExternalNetworksOnServiceEdge <Boolean>]
   [<CommonParameters>]

Set-CsDiagnosticHeaderConfiguration
   [-Instance <PSObject>]
   [-SendToExternalNetworks <Boolean>]
   [-SendToOutsideUnauthenticatedUsers <Boolean>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [-SendToExternalNetworksOnServiceEdge <Boolean>]
   [<CommonParameters>]

Description

Administrators have the option of attaching an ms-diagnostic header to each SIP message sent in their organization. This message (which is not visible to end users) contains information that might be useful in troubleshooting connection problems or in reporting errors. For example, the diagnostic header might contain error codes that enable the client application (for example, Skype for Business) to take a predetermined course of action should a specific situation arise.

For SIP messages sent within your internal network, there's little reason not to include these diagnostic headers: they have a minimal impact on message size and can be an invaluable tool for administrators trying to troubleshoot connectivity problems. However, diagnostic headers also contain information -- such as the fully qualified domain names (FQDNs) of your SIP servers -- that you might not want to make available to people outside the internal network. Because of this, the diagnostic header configuration settings enable you to decide whether you want diagnostic headers sent to users on external networks (such as users in a federated domain) and/or to outside users. (Outside users are users who have connected from outside the internal network and have not yet been authenticated.)

By default, headers are not included in messages sent either to external networks or to unauthenticated users. However, you can modify the global diagnostic header settings to include headers to external networks and/or unauthenticated users. Alternatively, you can create custom settings at the site scope or at the service scope (for the Edge Server or Registrar service). That way, you can choose to include diagnostic headers on messages sent from one site, or through one Edge Server, while disallowing headers on messages sent from other sites or through other Edge Servers.

The Set-CsDiagnosticHeaderConfiguration cmdlet provides a way for you to modify an existing diagnostic header configuration setting collection. You can use this cmdlet to enable (or disable) the transmission of diagnostic headers to external networks and/or to outside users.

Examples

-------------------------- Example 1 ------------------------

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

Example 1 modifies the diagnostic header configuration settings that have the Identity site:Redmond. In this example, the value of the SendToOutsideUnauthenticatedUsers property is set to True.

-------------------------- Example 2 ------------------------

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

The command shown in Example 2 is a variation of the command shown in Example 1; in this case, however, the SendToOutsideUnauthenticatedUsers property is modified for all the diagnostic header configuration settings in use. To do this, the Get-CsDiagnosticHeaderConfiguration cmdlet is first called without any parameters; this returns a collection of all the diagnostic header settings currently in use. This collection is then piped to the Set-CsDiagnosticHeaderConfiguration cmdlet, which sets the SendToOutsideUnauthenticatedUsers property of each item in the collection to True.

-------------------------- Example 3 ------------------------

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

In Example 3, the SendToOutsideUnauthenticatedUsers property is modified again, but this time only for those diagnostic header settings where the SendToExternalNetworks property is True. To carry out this task, the command first uses the Get-CsDiagnosticHeaderConfiguration cmdlet to return a collection of all the diagnostic header configuration settings currently in use. That collection is piped to the Where-Object cmdlet, which selects only those settings where the SendToExternalNetworks property is equal to True. That filtered collection is then piped to the Set-CsDiagnosticHeaderConfiguration cmdlet, which sets the value of the SendToOutsideUnauthenticatedUsers property for each item in the collection to True.

Parameters

-Confirm

-Force

-Identity

-Instance

-SendToExternalNetworks

-SendToExternalNetworksOnServiceEdge

-SendToOutsideUnauthenticatedUsers

-WhatIf

Inputs

Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. The Set-CsDiagnosticHeaderConfiguration cmdlet accepts pipelined instances of the diagnostic header settings object.

Outputs

The Set-CsDiagnosticHeaderConfiguration cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object.

Related Links

• Get-CsDiagnosticHeaderConfiguration
• New-CsDiagnosticHeaderConfiguration
• Remove-CsDiagnosticHeaderConfiguration