Compartilhar via

  • Artigo

Remove-CsDiagnosticHeaderConfiguration

 

Tópico modificado em: 2012-03-27

Remove uma ou várias coleções de definições de configuração do cabeçalho de diagnóstico em uso na organização. As definições de configuração de cabeçalho de diagnóstico 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

Remove-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-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 erro que permitem ao aplicativo cliente tomar um curso predeterminado de ação, se ocorrer 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).

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.

Todas as novas coleções que forem criadas (no escopo de site ou de serviço) podem ser removidas posteriormente, usando-se o cmdlet Remove-CsDiagnosticHeaderConfiguration. Também é possível executar esse cmdlet na coleção global. No entanto, nesse caso, a coleção global não será removida porque não é possível removê-la. Em vez disso, as duas propriedades contidas na coleção global (SendToExternalNetworks e SendToOutsideUnauthenticatedUsers) serão redefinidas com os seus valores padrão (False, em ambos os casos).

Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Remove-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 "Remove-CsDiagnosticHeaderConfiguration"}

Parâmetros

Parâmetro Obrigatório Digite Descrição

Identity

Obrigatório

Identidade de Xds

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

Remove-CsDiagnosticHeaderConfiguration pode também ser executado nas definições de configuração globais; neste caso, use essa sintaxe: –Identity global. No entanto, observe que as definições globais não serão removidas. Em vez disso, as propriedades encontradas nas definições globais serão redefinidas com os seus valores padrão.

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. Remove-CsDiagnosticHeaderConfiguration aceita instâncias canalizadas do objeto de definições de cabeçalho de diagnóstico.

Tipos de Retorno

Nenhuma. Em vez disso, Remove-CsDiagnosticHeaderConfiguration exclui instâncias existentes do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemplo

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

Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond

No Exemplo 1, serão removidas as definições de configuração de cabeçalho de diagnóstico que possuírem a Identidade site:Redmond.

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

Get-CsDiagnosticHeaderConfiguration -Filter service:* | Remove-CsDiagnosticHeaderConfiguration

O comando exibido no Exemplo 2 retorna todas as definições de configuração do cabeçalho de diagnóstico que tiverem sido aplicadas no escopo de serviço. Para fazer isso, o comando primeiramente chama Get-CsDiagnosticHeaderConfiguration, juntamente com o parâmetro Filter. O valor de filtro "service:*" limita os dados retornados às definições cuja Identidade começar com os caracteres "service:". A coleção filtrada será então canalizada para Remove-CsDiagnosticHeaderConfiguration, que excluirá cada item na coleção.

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

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

O comando anterior exclui todas as definições de configuração do cabeçalho de diagnóstico que permitirem o envio para redes externas. 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. Esta coleção será canalizada para o cmdlet Where-Object, que selecionará apenas as definições cuja propriedade SendToExternalNetworks for igual a True. Essas definições serão então canalizadas para Remove-CsDiagnosticHeaderConfiguration, que excluirá cada definição que permita o envio para redes externas.