Compartilhar via

  • Artigo

Set-CsDiagnosticHeaderConfiguration

 

Tópico modificado em: 2012-03-26

Modifica uma coleção existente de definições de configuração de cabeçalhos de diagnósticos em uso na organização. As definições de configuração de cabeçalhos de diagnósticos determinam se as mensagens SIP são acompanhadas pela informação de cabeçalho, que pode ser útil na resolução de problemas e nos relatórios de erro.

Sintaxe

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

Descrição Detalhada

Os administradores têm a opção de anexar um cabeçalho ms-diagnostic a cada mensagem SIP enviada na organização. Esta mensagem (que não é visível a usuários finais) contém informações que podem ser úteis na resolução de problemas de conexão ou no relato de erros. Por exemplo, o cabeçalho de diagnóstico pode conter códigos de erros que permitem que o aplicativo cliente (por exemplo, Microsoft Lync 2010) tome um curso de ação predeterminado caso ocorra uma situação específica.

Há poucos motivos para não incluir esses cabeçalhos de diagnóstico nas mensagens SIP enviadas dentro da rede interna: eles possuem um impacto mínimo no tamanho da mensagem e podem ser uma ferramenta inestimável para os administradores que estiverem tentando solucionar problemas de conectividade. No entanto, os cabeçalhos de diagnóstico também contêm informações, como os nomes de domínios totalmente qualificados de seus servidores SIP, que talvez não devam ser disponibilizadas para pessoas fora da rede interna. Por isso, as definições de configuração de cabeçalho de diagnóstico permitem optar pelo envio de cabeçalhos de diagnóstico aos usuários de redes externas (usuários de um domínio federado, por exemplo) e/ou aos de fora. (os usuários de fora se conectaram de fora da rede interna e ainda não foram autenticados).

Por padrão, os cabeçalhos não são incluídos nas mensagens enviadas a redes externas ou a usuários não-autenticados. Entretanto, é possível modificar as definições de cabeçalho de diagnóstico globais, de modo a incluir cabeçalhos a redes externas e/ou usuários não-autenticados. Como alternativa, é possível criar definições personalizadas no escopo de site ou de serviço (para Servidor de Borda ou o serviço do Registrador). Dessa forma, pode-se optar por incluir cabeçalhos de diagnóstico em mensagens enviadas de um site, ou através de um Servidor de Borda, impedindo a inclusão de cabeçalhos em mensagens enviadas de outros sites ou através de outros Servidores de Borda.

O cmdlet Set-CsDiagnosticHeaderConfiguration permite modificar uma coleção existente de definições de configuração de cabeçalhos de diagnósticos. É possível usar esse cmdlet para habilitar (ou desabilitar) a transmissão de cabeçalhos de diagnósticos para redes externas e/ou para usuários de fora.

Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Set-CsDiagnosticHeaderConfiguration localmente: RTCUniversalServerAdmins. Para retornar uma lista de todas as funções de controle de acesso baseado em função (RBAC) às quais este cmdlet tiver sido atribuído (inclusive qualquer função RBAC personalizada que tiver sido criada por você), execute o seguinte comando no prompt do Windows PowerShell:

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

Parâmetros

Parâmetro Obrigatório Digite Descrição

Identity

Opcional

Identidade de Xds

Identificador exclusivo das definições de configuração de cabeçalhos de diagnósticos a serem modificadas. Para modificar as definições configuradas no escopo de site, utilize uma sintaxe similar a esta: -Identity "site:Redmond". Para modificar as definições configuradas no escopo de serviço, utilize uma sintaxe similar a esta: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com". Para modificar as definições globais, use a sintaxe a seguir: -Identity global.

Se esse parâmetro não for especificado, Set-CsDiagnosticHeaderConfiguration modificará automaticamente as definições globais.

Instance

Opcional

Objeto DiagnosticHeaderSettings

Permite passar uma referência a um objeto para o cmdlet, em vez de definir valores de parâmetros individuais.

SendToExternalNetworks

Opcional

Booleano

Quando forem definidos como True, os cabeçalhos de diagnósticos serão anexados às mensagens enviadas a usuários de redes externas (usuários de um domínio federado, por exemplo). O valor padrão é False.

SendToOutsideUnauthenticatedUsers

Opcional

Booleano

Quando forem definidos como True, os cabeçalhos de diagnósticos serão anexados às mensagens enviadas aos usuários de fora. Os usuários de fora se conectaram de fora da rede interna (por um servidor proxy, por exemplo) e ainda não foram autenticados.

O valor padrão é False.

Force

Opcional

Parâmetro de opção

Suprime a exibição de qualquer mensagem de erro não-fatal que possa ocorrer durante a execução do comando.

WhatIf

Opcional

Parâmetro de opção

Descreve o que aconteceria se o comando fosse executado sem ser executado de fato.

Confirm

Opcional

Parâmetro de opção

Solicita confirmação antes da execução do comando.

Tipos de Entrada

Objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings. Set-CsDiagnosticHeaderConfiguration aceita instâncias canalizadas do objeto de definições de cabeçalhos de diagnósticos.

Tipos de Retorno

Set-CsDiagnosticHeaderConfiguration não retorna qualquer objeto ou valor. Em vez disso, o cmdlet modifica instâncias existentes do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemplo

-------------------------- Exemplo 1 ------------------------

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

O comando anterior remove as definições de configuração do cabeçalho de diagnóstico cuja identidade for site:Redmond. Neste exemplo, o valor da propriedade SendToOutsideUnauthenticatedUsers é definido como True.

-------------------------- Exemplo 2 ------------------------

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

O comando exibido no Exemplo 2 é uma variação do comando exibido no Exemplo 1. No entanto, nesse caso, modifica-se a propriedade SendToOutsideUnauthenticatedUsers de todas as definições de configuração dos cabeçalhos de diagnósticos em uso. Para realizar essa tarefa, chama-se Get-CsDiagnosticHeaderConfiguration sem nenhum parâmetro; isso retorna uma coleção de todas as definições de cabeçalho de diagnóstico que estiverem em uso. Esta coleção será canalizada para Set-CsDiagnosticHeaderConfiguration, que definirá como True a propriedade SendToOutsideUnauthenticatedUsers de cada item na coleção.

-------------------------- Exemplo 3 ------------------------

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

No Exemplo 3, a propriedade SendToOutsideUnauthenticatedUsers é modificada novamente, mas, dessa vez, apenas para as definições de cabeçalho de diagnóstico cuja propriedade SendToExternalNetworks for True. Para fazer isso, o comando primeiramente usa Get-CsDiagnosticHeaderConfiguration, para retornar uma coleção de todas as definições de configuração de cabeçalho de diagnóstico em uso. Esta coleção será conectada ao cmdlet Where-Object, que selecionará apenas as definições cuja propriedade SendToExternalNetworks for igual a True. Esta coleção filtrada será então canalizada para Set-CsDiagnosticHeaderConfiguration, que definirá como True o valor da propriedade SendToOutsideUnauthenticatedUsers de cada item na coleção.