Test-CsAddressBookWebQuery
Topic Last Modified: 2012-03-25
Tests the ability of a user to search for, and return, information from the Address Book by using the Address Book Web Query service.
Syntax
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>]
Detailed Description
Test-CsAddressBookWebQuery is an example of a "synthetic transaction." Synthetic transactions are used in Microsoft Lync Server 2010 to verify that users are able to successfully complete common tasks such as logging on to the system, exchanging instant messages, or making calls to a phone located on the public switched telephone network (PSTN). These tests can be conducted manually by an administrator, or they can be automatically run by an application such as Microsoft System Center Operations Manager (formerly Microsoft Operations Manager).
Synthetic transactions are typically conducted in two different ways. Many administrators will use the CsHealthMonitoringConfiguration cmdlets to set up test users for each of their Registrar pools. These test users are a pair of users who have been preconfigured for use with synthetic transactions. (Typically these are test accounts and not accounts that belong to actual users.) With test users configured for a pool, administrators can run a synthetic transaction against that pool without having to specify the identities of (and supply the credentials for) the user accounts involved in the test.
Alternatively, administrators can run a synthetic transaction by using actual user accounts. For example, if two users are unable to exchange instant messages, an administrator could run a synthetic transaction using those two user accounts (as opposed to a pair of test accounts), and then try to diagnose and resolve the problem. If you decide to conduct a synthetic transaction using actual user accounts, you will need to supply the logon names and passwords for each user.
The Test-CsAddressBookWebQuery cmdlet provides a way for administrators to verify that users can use the Address Book Web Query service to search for a specific contact. When you run the cmdlet, Test-CsAddressBookWebQuery will first connect to the Web Ticket service in order to be authenticated. If authentication is successful, the cmdlet will then connect to the Address Book Web Query service and search for the specified contact. If that contact is found, the cmdlet will attempt to return that information to the local computer. The test will be marked a success only if all of those steps can be completed.
Who can run this cmdlet: To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsAddressBookWebQuery"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
TargetFqdn |
Required |
String |
Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Web Query service is to be tested. For example: -TargetFqdn "atl-cs-001.litwareinc.com". Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. |
TargetSipAddress |
Required |
SIP Address |
SIP address of the contact expected to be returned by the Address Book Web Query service. For example: -TargetSipAddress "sip:kenmyer@litwareinc.com". |
TargetUri |
Required |
String |
Uniform Resource Identifier (URI) of the Address Book Web Query service. For example: -TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion". Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. |
UserCredential |
Required |
PSCredential object |
User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the Get-Credential cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: $x = Get-Credential "litwareinc\kenmyer" You need to supply the user password when running this command. |
UserSipAddress |
Required |
SIP Address |
SIP address of the user to be used in the test. If this parameter is not specified then Test-CsAddressBookWebQuery will conduct its checks by using health monitoring configuration settings for the pool being tested. |
External |
Optional |
Switch Parameter |
Enables you to verify that external users can use the Address Book Web Query service. |
RegistrarPort |
Optional |
Integer |
SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. |
WebCredential |
Optional |
PS Credential object |
An object containing user credentials for accessing the Location Information service. This object can be retrieved by calling the Get-Credential cmdlet and supplying the appropriate credentials. This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
OutVerboseVariable |
Optional |
String |
When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: -OutVerboseVariable TestOutput Do not prepend a $ character when specifying the variable name. |
Verbose |
Optional |
Switch Parameter |
Reports detailed activity to the screen as the cmdlet runs. |
Input Types
None. Test-CsAddressBookWebQuery does not accept pipelined input.
Return Types
Test-CsAddressBookWebQuery returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 ------------------------
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com"
The preceding example tests the Address Book Web Query service for the pool atl-cs-001.litwareinc.com by searching for the contact with the SIP Address sip:kenmyer@litwareinc.com. This command will work only if test users have been defined for the pool atl-cs-001.litwareinc.com. If it has, then the command will run under the credentials of the first test user in the defined for the pool.
If test users have not been defined, then the command will fail. If you have not defined test users for a pool then you must include the UserSipAddress parameter and the credentials of the user under which the command should be run.
-------------------------- Example 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"
The commands shown in Example 2 also test the availability of the Address Book Web Query service; in this case, however, the commands are running under the credentials of the user Ken Myer (litwareinc\kenmyer). To do this, the first command uses the Get-Credential cmdlet to create a Windows PowerShell credential object containing the name and password of the user Ken Myer. (Because the logon name, litwareinc\kenmyer, has been included as a parameter, the Windows PowerShell Credential Request dialog box will only require the administrator to enter the password for the Ken Myer account.) The resulting credential object is then stored in a variable named $cred1.
In the second command, Test-CsAddressBookWebQuery is used to test the Address Book Web Query service for the pool atl-cs-001.litwareinc.com. To run this command under Ken Myer’s user credentials, the UserCredential parameter is included, along with the parameter value $cred1. The command also uses the TargetSipAddress to specify that the cmdlet should search the Address Book for the contact with the SIP Address sip:kenmyer@litwareinc.com.
-------------------------- Example 3 ------------------------
Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
Example 3 shows how you can test the Address Book Web Query service for atl-cs-001.litwareinc.com. To do this, Test-CsAddressBookWebQuery is called along with three parameters: TargetUri, which specifies the URI of the Address Book Web Query service; UserSipAddress, which contains the Windows PowerShell SIP address of the user account being used in the test; and TargetSipAddress, which contains the SIP address of the user account being searched for.