Compartilhar via

  • Artigo

Get-CsDiagnosticHeaderConfiguration

 

Tópico modificado em: 2012-03-23

Retorna informações sobre as definições de configuração do cabeçalho do diagnóstico atualmente em uso em sua organização. As definições de configuração do cabeçalho de diagnóstico determinam se as informações do cabeçalho acompanharão as mensagens SIP. Essas informações podem ser úteis na resolução de problemas e na emissão de relatórios de erros.

Sintaxe

Get-CsDiagnosticHeaderConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsDiagnosticHeaderConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]

Descrição Detalhada

Ao enviar mensagens SIP, é possível anexar um cabeçalho do ms-diagnostics a cada mensagem. Essa mensagem (que não é visível para os usuários finais) contém informações que podem ser úteis na resolução de problemas de conexão ou na emissão de relatórios 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.

Para mensagens SIP enviadas dentro de sua rede interna, há poucos motivos para não incluir esses cabeçalhos de diagnóstico: 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 disponibilizados 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 em mensagens enviadas para redes externas ou para usuários não autenticados. No entanto, é possível modificar as definições do cabeçalho de diagnóstico global, de modo a incluir cabeçalhos em redes externas e/ou usuários não autenticados. Como alternativa, é possível criar definições personalizadas no escopo do site ou no escopo do serviço (para o Servidor de Borda ou serviço registrador). Dessa maneira, é possível optar por incluir cabeçalhos de diagnóstico em mensagens enviadas de um site, ou por meio de um Servidor de Borda, desabilitando cabeçalhos em mensagens enviadas de outros sites ou por outros Servidores de Borda.

O cmdlet Get-CsDiagnosticHeaderConfiguration constitui uma maneira de recuperar informações sobre as definições de configuração do cabeçalho de diagnóstico em uso pela sua organização.

Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Get-CsDiagnosticHeaderConfiguration localmente: RTCUniversalUserAdmins, RTCUniversalServerAdmins. Para retornar uma lista de todas as funções do controle de acesso baseado em função (RBAC) que receberam a atribuição desse cmdlet (incluindo qualquer função RBAC personalizada criada por você), execute o seguinte comando do prompt Windows PowerShell:

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

Parâmetros

Parâmetro Obrigatório Digite Descrição

Identity

Opcional

Identidade de Xds

Identificador exclusivo para as definições de configuração do cabeçalho de diagnóstico a serem retornadas. Para retornar as definições configuradas no escopo do site, use uma sintaxe semelhante a esta: -Identity "site:Redmond". Para retornar as definições configuradas no escopo do serviço, use uma sintaxe como esta: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". Para retornar as definições globais, use esta sintaxe: -Identity global.

Se esse parâmetro não for especificado, serão retornadas todas as definições de configuração do cabeçalho de diagnóstico em uso.

Filter

Opcional

Cadeia de caracteres

Permite que você use caracteres curinga ao especificar a coleção de definições (ou coleções) a ser retornada. Por exemplo, essa sintaxe retorna todas as definições configuradas no escopo do site: -Filter "site:*". Esta sintaxe retorna todas as definições configuradas no escopo de serviço: -Filter "service:*".

Observe que não é possível utilizar os parâmetros Filtro e Identidade no mesmo comando.

LocalStore

Opcional

Parâmetro de opção

Recupera os dados de configuração do cabeçalho de diagnóstico na réplica local do Repositório de Gerenciamento Central, em vez do Repositório de Gerenciamento Central em si.

Tipos de Entrada

Nenhuma. Get-CsDiagnosticHeaderConfiguration não aceita a entrada canalizada.

Tipos de Retorno

Get-CsDiagnosticHeaderConfiguration retorna instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemplo

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

Get-CsDiagnosticHeaderConfiguration

O comando precedente retorna informações sobre todas as definições de configuração do cabeçalho do diagnóstico em uso pela sua organização. Isso é realizado chamando-se Get-CsDiagnosticHeaderConfiguration sem nenhum parâmetro.

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

Get-CsDiagnosticHeaderConfiguration -Identity site:Redmond

No Exemplo 2, é retornada uma única coleção de definições de configuração do cabeçalho de diagnósticos: a coleção com a Identidade site:Redmond.

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

Get-CsDiagnosticHeaderConfiguration -Filter "service:*"

O comando exibido no Exemplo 3 retorna todas as definições do cabeçalho de diagnóstico que foram configuradas no escopo do serviço. Isso é realizado chamando-se Get-CsDiagnosticHeaderConfiguration e o parâmetro Filtro; o valor de filtro "service:*" garante que apenas as definições que forem retornadas são as que possuem uma Identidade iniciada pelos caracteres "service:".

-------------------------- Exemplo 4 ------------------------

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

O Exemplo 4 retorna todas as definições de configuração do cabeçalho de diagnóstico que permitem o envio para redes externas. Para realizar essa tarefa, o comando primeiramente chama 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 o cmdlet Where-Object, que selecionará apenas as definições cuja propriedade SendToExternalNetworks for igual a True.

-------------------------- Exemplo 5 ------------------------

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

O comando exibido no Exemplo 5 retorna informações sobre as definições de configuração do cabeçalho de diagnóstico que atenderem a pelo menos um dos seguintes critérios: 1) a propriedade SendToExternalNetworks é igual a True e/ou 2) SendToOutsideUnauthenticatedUsers é igual a True. Para fazer isso, o comando primeiramente usa Get-CsDiagnosticHeaderConfiguration para retornar uma coleção de todas as definições de cabeçalho de diagnóstico em uso. Essa coleção será então canalizada para Where-Object, que selecionará as definições cuja propriedade SendToExternalNetworks e/ou SendToOutsideUnauthenticatedUsers for igual a True.

O operador -or especifica que, para serem retornadas, as definições devem atender a um dos critérios especificados. Para exigir que as definições atendam a ambos os critérios especificados, use o operador -and:

Where-Object {$_.SendToExternalNetworks -eq $True -and $_.SendToOutsideUnauthenticatedUsers -eq $True}