Test-CsAddressBookWebQuery
Tópico modificado em: 2012-03-25
Testa a capacidade do usuário pesquisar e retornar informações do Catálogo de Endereços utilizando o Serviço de Consulta à Web do Catálogo de Endereços.
Sintaxe
Test-CsAddressBookWebQuery -TargetFqdn <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>] [-UserSipAddress <String>]
Test-CsAddressBookWebQuery -TargetUri <String> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-TargetSipAddress <String>] [-WebCredential <PSCredential>]
Test-CsAddressBookWebQuery [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>]
Descrição Detalhada
Test-CsAddressBookWebQuery é um exemplo de uma "transação sintética". As transações sintéticas são usadas no Microsoft Lync Server 2010 para se certificar de que os usuários sejam capazes de concluir tarefas comuns com sucesso, como fazer logon no sistema, trocar mensagens instantâneas ou realizar chamadas para um telefone localizado na PSTN (rede telefônica pública comutada). Esses testes podem ser conduzidos manualmente por um administrador ou executados automaticamente por um aplicativo como o Microsoft System Center Operations Manager (anteriormente Microsoft Operations Manager).
Normalmente, as transações sintéticas são conduzidas de duas maneiras diferentes. Muitos administradores usarão os cmdlets CsHealthMonitoringConfiguration para configurar os usuários de teste para cada um de seus pools de registradores. Esses usuários de teste são um par de usuários que foram configurados previamente para uso com transações sintéticas. (normalmente, essas são contas de teste e não contas que pertencem a usuários reais). Com usuários de teste configurados para um pool, os administradores podem executar uma transação sintética nesse pool, sem ter de especificar as identidades (nem fornecer credenciais) das contas dos usuários envolvidos no teste.
Como alternativa, os administradores podem executar uma transação sintética utilizando contas de usuários reais. Por exemplo, se dois usuários não puderem trocar mensagens instantâneas, um administrador pode executar uma transação sintética usando as duas contas dos usuários em questão (em vez de um par de contas de teste) e tentar diagnosticar e solucionar o problema. Se decidir conduzir uma transação sintética usando contas de usuários reais, você terá de fornecer o nome e a senha de logon de cada usuário.
O cmdlet Test-CsAddressBookWebQuery fornece aos administradores uma maneira de verificar se os usuários podem utilizar o Serviço de Consulta à Web do Catálogo de Endereços para pesquisar um contato específico. Ao se executar o cmdlet, Test-CsAddressBookWebQuery se conectará primeiro ao serviço Web Ticket, para obter autenticação. Se a autenticação for bem-sucedida, o cmdlet então se conectará ao Serviço de Consulta à Web do Catálogo de Endereços e pesquisará o contato especificado. Se o contato for localizado, o cmdlet tentará retornar essas informações para o computador local. O teste será marcado como bem-sucedido apenas se todas as etapas forem concluídas.
Quem pode executar esse cmdlet: 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 "Test-CsAddressBookWebQuery"}
Parâmetros
| Parâmetro | Obrigatório | Digite | Descrição |
|---|---|---|---|
TargetFqdn |
Obrigatório |
Cadeia de caracteres |
O nome de domínio totalmente qualificado (FQDN) do pool do registrador no qual Serviço de Consulta à Web do Catálogo de Endereços será testado. Por exemplo: -TargetFqdn "atl-cs-001.litwareinc.com". Observe que não é possível utilizar os parâmetros TargetUri e TargetFqdn no mesmo comando. |
TargetSipAddress |
Obrigatório |
Endereço SIP |
Endereço SIP do contato que se espera ser retornado pelo Serviço de Consulta à Web do Catálogo de Endereços. Por exemplo: -TargetSipAddress "sip:kenmyer@litwareinc.com". |
TargetUri |
Obrigatório |
Cadeia de caracteres |
O Identificador de Recurso Uniforme (URI) do Serviço de Consulta à Web do Catálogo de Endereços. Por exemplo: -TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion". Observe que não é possível utilizar os parâmetros TargetUri e TargetFqdn no mesmo comando. |
UserCredential |
Obrigatório |
Objeto PSCredential |
O objeto de credencial do usuário da conta a ser utilizada no teste. O valor passado para UserCredential deve ser uma referência de objeto obtida ao se utilizar o cmdlet Get-Credential. Por exemplo, este código retorna um objeto de credenciais do usuário litwareinc\kenmyer e armazena esse objeto em uma variável denominada $x: $x = Get-Credential "litwareinc\kenmyer" Ao se executar esse comando, é necessário fornecer a senha do usuário. |
UserSipAddress |
Obrigatório |
Endereço SIP |
Endereço SIP do usuário a ser utilizado no teste. Se esse parâmetro não for especificado, Test-CsAddressBookWebQuery conduzirá as suas verificações usando as definições de configuração de monitoramento de integridade correspondentes ao pool testado. |
External |
Opcional |
Parâmetro de opção |
Permite verificar se os usuários externos podem usar Serviço de Consulta à Web do Catálogo de Endereços. |
RegistrarPort |
Opcional |
Inteiro |
Porta SIP usada pelo serviço Registrador. Esse parâmetro não é necessário se o Registrador usar a porta padrão 5061. |
WebCredential |
Opcional |
Objeto PS Credential |
Um objeto que contém credenciais de usuário para acesso ao serviço de Informações de Local. Esse objeto pode ser recuperado chamando o cmdlet Get-Credential e fornecendo as credenciais apropriadas. Esse parâmetro será necessário se os parâmetros TargetUri e UserSipAddress forem especificados e se o computador em que estiver se executando o comando não possuir um certificado de servidor. |
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. |
OutVerboseVariable |
Opcional |
Cadeia de caracteres |
Quando presente, a saída detalhada da execução do cmdlet será armazenada na variável especificada. Por exemplo, para armazenar a saída em uma variável denominada $TestOutput, use a seguinte sintaxe: -OutVerboseVariable TestOutput Não coloque um caractere $ como prefixo ao especificar o nome da variável. |
Verbose |
Opcional |
Parâmetro de opção |
Relata na tela a atividade detalhada, à medida que o cmdlet for executado. |
Tipos de Entrada
Nenhuma. Test-CsAddressBookWebQuery não aceita a entrada canalizada.
Tipos de Retorno
Test-CsAddressBookWebQuery retorna uma instância do objeto Microsoft.Rtc.SyntheticTransactions.TaskOutput.
Exemplo
-------------------------- Exemplo 1 --------------------------
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com"
O exemplo anterior testa o Serviço de Consulta à Web do Catálogo de Endereços do pool atl-cs-001.litwareinc.com, mediante a procura do contato com o endereço SIP sip:kenmyer@litwareinc.com. Este comando funcionará apenas se tiverem sido definidos usuários de teste do pool atl-cs-001.litwareinc.com. Se tiverem sido definidos, o comando será executado com as credenciais do primeiro usuário de teste no registrador de monitoramento de integridade do pool.
Se não tiverem sido definidos usuários de teste, o comando falhará. Se não tiverem sido definidos usuários de teste para um pool, deve-se incluir o parâmetro UserSipAddress e as credenciais do usuário com as quais se executará o comando.
-------------------------- Exemplo 2 --------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -UserCredential $cred1 -UserSipAddress "sip:kenmyer@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
Os comandos apresentados no Exemplo 2 também testam a disponibilidade do Serviço de Consulta à Web do Catálogo de Endereços; neste caso, entretanto, os comandos são executados com as credenciais do usuário Ken Myer (litwareinc\kenmyer). Para tal, o primeiro comando utiliza o cmdlet Get-Credential para criar um objeto de credencial do Windows PowerShell contendo o nome e a senha do usuário Ken Myer. Como o nome de logon (litwareinc\kenmyer) foi incluído como um parâmetro, a caixa de diálogo resultante de Solicitação de Credenciais do Windows PowerShell solicitará apenas que o administrador insira a senha da conta de Ken Myer). O objeto de credencial resultante será então armazenado em uma variável denominada $cred1.
No segundo comando, Test-CsAddressBookWebQuery é utilizado para testar o Serviço de Consulta à Web do Catálogo de Endereços do pool atl-cs-001.litwareinc.com. Para executar esse comando com as credenciais do usuário Ken Myer, será incluído o parâmetro UserCredential, juntamente com o valor do parâmetro $cred1. O comando também utiliza o parâmetro TargetSipAddress para especificar que o cmdlet deve procurar o contato no Catálogo de Endereços cujo endereço SIP for sip:kenmyer@litwareinc.com.
-------------------------- Exemplo 3 --------------------------
Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
O Exemplo 3 mostra como se pode testar o Serviço de Consulta à Web do Catálogo de Endereços para atl-cs-001.litwareinc.com. Para fazer isso, Test-CsAddressBookWebQuery é chamado com três parâmetros: TargetUri, que especifica o URI do Serviço de Consulta à Web do Catálogo de Endereços, UserSipAddress, que contém o endereço SIP do Windows PowerShell da conta do usuário que estiver sendo usada no teste e TargetSipAddress, que contém o endereço SIP da conta do usuário que estiver sendo procurada.