Compartir a través de


Set-CsDiagnosticHeaderConfiguration

 

Última modificación del tema: 2012-03-26

Modifica una recopilación de opciones de configuración de encabezado de diagnóstico que utiliza la organización. La configuración de encabezados de diagnóstico determina si los mensajes SIP contienen información de encabezado que puede resultar útil para la solución de problemas y la generación de informes de errores.

Sintaxis

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

Descripción detallada

Los administradores tienen la opción de adjuntar un encabezado de ms-diagnostic a cada mensaje SIP que se envía en su organización. Este mensaje (que no pueden ver los usuarios finales) contiene información que puede resultar útil para la solución de problemas de conexión y la generación de informes de errores. Por ejemplo, el encabezado de diagnóstico puede contener códigos de error que permitan a la aplicación cliente (como Microsoft Lync 2010) actuar de una manera predeterminada si se da cierta situación.

Para los mensajes SIP enviados dentro de la red interna, no existe ninguna razón por la que no incluir estos encabezados de diagnóstico: tienen una repercusión mínima en el tamaño del mensaje y pueden constituir una herramienta de valor incalculable para los administradores que intenten solucionar problemas de conectividad. No obstante, los encabezados de diagnóstico también contienen información, como los nombres de dominio completos (FQDN) de los servidores SIP, y es posible que no quiera que sea visible para las personas que no pertenezcan a la red interna. Por este motivo, las opciones de configuración de encabezados de diagnóstico le permiten decidir si quiere enviar los encabezados de diagnóstico a los usuarios de redes externas (como los usuarios de un dominio federado) y/o a los usuarios externos. (Los usuarios externos son aquellos que están conectados desde fuera de la red interna y que no se han autenticado todavía.)

De forma predeterminada, los encabezados no se incluyen en los mensajes enviados a redes externas ni a usuarios no autenticados. Sin embargo, puede modificar la configuración global de encabezados de diagnóstico para incluir los encabezados en los mensajes enviados a redes externas y a usuarios no autenticados. También puede crear configuraciones personalizadas en el ámbito de sitio o de servicio (para Servidor perimetral o para el servicio de registrador). De esta forma, puede seleccionar si desea incluir encabezados de diagnóstico en los mensajes enviados desde un sitio o a través de un Servidor perimetral determinado, al tiempo que prohíbe los encabezados en los mensajes enviados desde otros sitios o a través de otros servidores perimetrales.

El cmdlet Set-CsDiagnosticHeaderConfiguration permite modificar una recopilación de opciones de configuración de encabezado de diagnóstico. Puede usar este cmdlet para habilitar (o deshabilitar) la transmisión de encabezados de diagnóstico a redes externas y/o a usuarios externos.

Quién puede ejecutar este cmdlet: de forma predeterminada, están autorizados para ejecutar el cmdlet Set-CsDiagnosticHeaderConfiguration localmente los miembros de los siguientes grupos: RTCUniversalServerAdmins. Para devolver una lista de todos los roles de control de acceso basado en roles (RBAC) a los que se ha asignado este cmdlet (incluidos los roles de RBAC personalizados que haya creado), ejecute el siguiente comando en el símbolo del sistema de Windows PowerShell:

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

Parámetros

Parámetro Requerido Tipo Descripción

Identity

Opcional

Identidad Xds

Identificador único de las opciones de configuración de encabezado de diagnóstico que se modificarán. Para modificar configuraciones definidas en el ámbito de sitio, use una sintaxis similar a ésta: -Identity "site:Redmond". Para modificar configuraciones definidas en el ámbito de servicio, use una sintaxis como ésta: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Para modificar la configuración global, use esta sintaxis: -Identity global.

Si no se especifica este parámetro, Set-CsDiagnosticHeaderConfiguration modificará automáticamente la configuración global.

Instance

Opcional

Objeto DiagnosticHeaderSettings

Permite enviar una referencia a un objeto al cmdlet, en lugar de definir valores de parámetros individuales.

SendToExternalNetworks

Opcional

Booleano

Si está definido como True, se adjuntarán encabezados de diagnóstico a los mensajes enviados a los usuarios de redes externas (como los usuarios de un dominio federado). El valor predeterminado es False.

SendToOutsideUnauthenticatedUsers

Opcional

Booleano

Si está definido como True, se adjuntarán encabezados de diagnóstico a los mensajes enviados a usuarios externos. Los usuarios externos son aquellos que están conectados desde fuera de la red interna (por ejemplo, a través de un servidor proxy) y que no se han autenticado todavía.

El valor predeterminado es False.

Force

Opcional

Parámetro modificador

Suprime la visualización de los mensajes de error que no sean irrecuperables y que puedan surgir al ejecutar el comando.

WhatIf

Opcional

Parámetro modificador

Describe lo que ocurriría si se ejecutara el comando sin ejecutarlo realmente.

Confirm

Opcional

Parámetro modificador

Solicita confirmación antes de ejecutar el comando.

Tipos de entrada

Objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings. Set-CsDiagnosticHeaderConfiguration acepta instancias por canalización del objeto de configuraciones de encabezado de diagnóstico.

Tipos de valores devueltos

Set-CsDiagnosticHeaderConfiguration no devuelve un objeto o valor. En su lugar, el cmdlet modifica instancias del objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Ejemplo

-------------------------- Ejemplo 1 ------------------------

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

El comando anterior modifica las opciones de configuración de encabezado de diagnóstico que tengan el valor de Identity site:Redmond. En este ejemplo, el valor de la propiedad SendToOutsideUnauthenticatedUsers se define como True.

-------------------------- Ejemplo 2 ------------------------

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

El comando del Ejemplo 2 es una variación del comando del Ejemplo 1; en este caso, se modifica la propiedad SendToOutsideUnauthenticatedUsers de todas las opciones de configuración de encabezado de diagnóstico en uso. Para ello, primero se llama a Get-CsDiagnosticHeaderConfiguration sin parámetros para que devuelva una recopilación de todas las configuraciones de encabezado de diagnóstico en uso. A continuación, la recopilación se transfiere a Set-CsDiagnosticHeaderConfiguration que define la propiedad SendToOutsideUnauthenticatedUsers de todos los elementos de la recopilación como True.

-------------------------- Ejemplo 3 ------------------------

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

En el Ejemplo 3, también se modifica la propiedad SendToOutsideUnauthenticatedUsers, pero en este caso sólo en las configuraciones de encabezado de diagnóstico en las que la propiedad SendToExternalNetworks está definida en True. Para ello, el comando primero usa Get-CsDiagnosticHeaderConfiguration para que devuelva una recopilación de todas las opciones de configuración de encabezado de diagnóstico en uso. Dicha recopilación se transfiere al cmdlet Where-Object, que selecciona sólo las configuraciones en las que la propiedad SendToExternalNetworks es igual a True. A continuación, la recopilación filtrada se transfiere a Set-CsDiagnosticHeaderConfiguration, que define el valor de la propiedad SendToOutsideUnauthenticatedUsers de todos los elementos de la recopilación como True.