Test-CsAddressBookService
Tópico modificado em: 2012-03-26
Testa a capacidade do usuário acessar o servidor que hospeda o Serviço Web de Download do Catálogo de Endereços.
Sintaxe
Test-CsAddressBookService -TargetFqdn <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-UserSipAddress <String>]
Test-CsAddressBookService -TargetUri <String> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-WebCredential <PSCredential>]
Test-CsAddressBookService [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>]
Descrição Detalhada
Test-CsAddressBookService é um exemplo de "transação sintética". As transações sintéticas são usadas no 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-CsAddressBookService permite verificar se um usuário pode se conectar ao Serviço Web de Download do Catálogo de Endereços. Ao se executar o cmdlet, Test-CsAddressBookService se conecta ao Serviço Web de Download do Catálogo de Endereços no pool especificado e solicita o local dos arquivos do Catálogo de Endereços. Se o Serviço Web de Download do Catálogo de Endereços fornecer o local, o teste será considerado bem-sucedido. Se a solicitação for negada, o teste falhará.
É possível testar o Serviço Web de Download do Catálogo de Endereços de duas maneiras diferentes: ao testar o serviço ou ao testar o serviço de Web associado.
Quem pode executar esse cmdlet: Por padrão, membros dos seguintes grupos são autorizados a executar o cmdlet Test-CsAddressBookService localmente: 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 "Test-CsAddressBookService"}
Parâmetros
| Parâmetro | Obrigatório | Digite | Descrição |
|---|---|---|---|
UserCredential |
Obrigatório |
Objeto PS credential |
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 este 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-CsAddressBookService conduzirá as verificações utilizando a conta do usuário registrado no sistema. |
External |
Opcional |
Parâmetro de opção |
Permite verificar se os usuários externos podem usar Serviço Web de Download 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. |
TargetFqdn |
Opcional |
Cadeia de caracteres |
O nome de domínio totalmente qualificado (FQDN) do pool do registrador no qual Serviço Web de Download do Catálogo de Endereços será testado. Por exemplo: -TargetFqdn "atl-cs-001.litwareinc.com". Não é possível utilizar os parâmetros TargetUri e TargetFqdn no mesmo comando. |
TargetUri |
Opcional |
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/abs/handler". Não é possível utilizar os parâmetros TargetUri e TargetFqdn no mesmo comando. |
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 |
Obrigatório |
Parâmetro de opção |
Relata a atividade detalhada na tela à medida que o cmdlet for executado. |
Tipos de Entrada
Nenhuma. Test-CsAddressBookService não aceita a entrada canalizada.
Tipos de Retorno
Test-CsAddressBookService retorna uma instância do objeto Microsoft.Rtc.SyntheticTransactions.TaskOutput.
Exemplo
-------------------------- Exemplo 1 ------------------------
Test-CsAddressBookService -TargetFqdn atl-cs-001.litwareinc.com
O exemplo anterior testa o Serviço Web de Download do Catálogo de Endereços para o pool atl-cs-001.litwareinc.com. Esse comando testa o Serviço Web de Download do Catálogo de Endereços usando os usuários de teste configurados anteriormente para o pool atl-cs-001.litwareinc.com.
-------------------------- Exemplo 2 ------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsAddressBookService -TargetFqdn atl-cs-001.litwareinc.com -UserCredential $cred1 -UserSipAddress "sip:kenmyer@litwareinc.com"
Os comandos apresentados no Exemplo 2 também testam a disponibilidade do servidor que executa o Serviço Web de Download 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-CsAddressBookService é utilizado para testar o Serviço Web de Download 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. Além disso, o endereço SIP de Ken deve ser fornecido, utilizando-se o parâmetro UserSipAddress.
-------------------------- Exemplo 3 ------------------------
Test-CsAddressBookService -TargetUri https://atl-cs-001.litwareinc.com/abs/handler -UserSipAddress "sip:kenmyer@litwareinc.com"
O Exemplo 3 mostra como se pode testar o Serviço Web de Download do Catálogo de Endereços para atl-cs-001.litwareinc.com. Para fazer isso, o Test-CsAddressBookService é chamado, juntamente com dois parâmetros: TargetUri, que especifica o URI do Serviço Web de Download do Catálogo de Endereços e UserSipAddress, que contém o endereço SIP do Windows PowerShell da conta de usuário que estiver sendo utilizada no teste.