Tests the ability of a user to search for, and return, information from the Address Book using the Address Book Web Query service.
Syntax
Test-CsAddressBookWebQuery -TargetFqdn <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>] [-UserSipAddress <String>] |
Test-CsAddressBookWebQuery -TargetFqdn <String> -UserCredential <PSCredential> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
TargetFqdn |
Required |
String |
Fully qualified domain name of the registrar pool where the Address Book 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. |
|
Certificate |
Required |
X509Certificate2 object |
Enables you to use an X.509 certificate for authentication purposes when running Test-CsAddressBookWebQuery. |
|
TargetSipAddress |
Required |
SIP Address |
SIP address of the contact expected to be returned by the Address Book service. For example: -TargetSipAddress "sip:kenmyer@litwareinc.com". |
|
TargetUri |
Required |
String |
URI of the Address Book service’s Web 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-CsAddressBookService will conduct its checks using an account preconfigured in the health monitoring registrar for the pool being tested.. |
|
External |
Optional |
Switch Parameter |
Enables you to verify that external users can use the Address Book service. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
Detailed Description
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. Assuming 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 then 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.
Return Types
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com" |
|
The preceding example tests the Address Book 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 a health monitoring registrar has 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 health monitoring registrar for the pool.
If a registrar has not been defined then the command will fail. If you have not defined a health monitoring registrar for a pool then you must include the -UserSipAddress parameter and the credentials of the user the command should be run under.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
$cred1 = Get-Credential "litwareinc\jhaas" Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -UserCredential $cred1 -UserSipAddress "sip:jhaas@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com" |
|
The commands shown in Example 2 also test the availability of the Address Book server; in this case, however, the commands are running under the credentials for the user Jonathan Haas (litwareinc\jhaas). To do this, the first command uses the Get-Credential cmdlet to create a PowerShell credential object containing the name and password of the user Jonathan Haas. (Because the logon name - litwareinc\jhaas - has been included as a parameter, the resulting Windows PowerShell Credential Request dialog box will only require the administrator to enter the password for the Jonathan Haas 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 service for the pool atl-cs-001.litwareinc.com. To run this command under Jonathan Haas’ 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 ------------------------
| Copy Code |
|
|---|---|
$cred1 = Get-Credential "litwareinc\jhaas" Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserCredential $cred1 -UserSipAddress "sip:jhaas@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com" |
|
Example 3 shows how you can test the Web service associated with the Address Book service for atl-cs-001.litwareinc.com. To do, the first command in the example uses Get-Credential to create a PowerShell credential object for the user litwareinc\jhaas; this credential object is then stored in a variable named $cred1. In the second command, Test-CsAddressBookService is called along with two parameters: -TargetUri, which specifies the URI of the Address Book Web service; and –UserCredential, which contains the PowerShell credential object for the user account being utilized in the test. As per the previous two examples, this one searches for the contact with the SIP address sip:kenmyer@vdomain.com.