Compartilhar via

  • Artigo

New-CsDiagnosticHeaderConfiguration

 

Tópico modificado em: 2012-03-23

Cria uma nova coleção de definições de configuração de cabeçalho de diagnóstico. 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

New-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-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 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 de diagnósticos 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.

A criação das definições de cabeçalho de diagnóstico personalizado utiliza o cmdlet New-CsDiagnosticHeaderConfiguration. Conforme observado, é possível criar novas definições no escopo de site ou de serviço (embora apenas para Servidor de Borda e os serviços do Registrador). Tenha em mente que apenas uma dessas coleções de definições é permitida por site ou serviço. Por exemplo, suponha que você esteja tentando criar uma nova coleção para o site Redmond, e que o site já hospede uma coleção de definições de cabeçalho de diagnóstico. Neste caso, o comando falhará. Da mesma forma, o comando falhará se se tentar criar uma nova coleção no escopo global.

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

Parâmetros

Parâmetro Obrigatório Tipo Descrição

Identity

Obrigatório

Xds Identity

Identificador exclusivo das definições de configuração de cabeçalho de diagnóstico a serem criadas. Para criar uma nova coleção de definições no escopo do site, utilize uma sintaxe similar a esta: -Identity "site:Redmond". Para criar uma nova coleção de definições no escopo do serviço, utilize uma sintaxe similar a esta: -Identity "service:EdgeServer:atl-cs-001.litwareinc.com".

Não é possível criar novas definições no escopo global. Além disso, não é possível criar novas definições no escopo de site ou de serviço se o site ou serviço especificado (por exemplo, site:Redmond) já hospeda uma coleção de definições.

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 surgir ao se executar o comando.

InMemory

Opcional

Parâmetro de opção

Cria uma referência de objeto, sem na verdade executar o objeto como uma alteração permanente. Se a saída deste cmdlet for atribuída, chamando-o com este parâmetro a uma variável, você poderá realizar alterações às propriedades da referência do objeto e executar estas alterações, chamando-se o cmdlet coincidente Set- deste cmdlet.

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

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

Tipos de Retorno

New-CsDiagnosticHeaderConfiguration cria novas instâncias do objeto Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings.

Exemplo

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

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

O Exemplo 1 cria uma nova configuração de cabeçalho de diagnóstico para o site de Redmond (-Identity site:Redmond). Além de especificar a identidade, o comando também utiliza o parâmetro SendToOutsideAuthenticatedUsers e o valor de parâmetro $True; isto habilita o envio de informações a usuários autenticados fora da rede interna.

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

$x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond
$x.SendToOutsideUnauthenticatedUsers = $True
$x.SendToExternalNetworks = $True
Set-CsDiagnosticHeaderConfiguration -Instance $x

Os comandos exibidos no Exemplo 2, demonstram como é possível criar uma coleção de definições de cabeçalho de diagnóstico que existem inicialmente apenas em memória. Para fazer isso, o primeiro comando no exemplo chama New-CsDiagnosticHeaderConfiguration, juntamente com o parâmetro Identity. O objeto resultante é armazenado na variável $x.

Depois que as definições virtuais tiverem sido criadas, os comandos 2 e 3 serão utilizados para modificar os valores de propriedade SendToOutsideUnauthenticatedUsers e SendToExternalNetworks, respectivamente. Finalmente, o comando 4 é utilizado para transformar as definições de configuração de cabeçalho de diagnóstico em uma coleção de definições aplicada ao site Redmond. Observe que este comando final é obrigatório. Se Set-CsDiagnosticHeaderConfiguration não for chamado, nenhuma definição será aplicada ao site e as definições virtuais desaparecerão assim que a sessão do Windows PowerShell for terminada ou a variável $x for excluída.