Test-CsPresence -TargetFqdn <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-PublisherSipAddress <String>] [-RegistrarPort <Nullable>] [-SubscriberSipAddress <String>] [-SubscriberSipAddress <String>]

Test-CsPresence -TargetFqdn <String> -PublisherCredential <PSCredential> -PublisherSipAddress <String> -SubscriberCredential <PSCredential> -SubscriberSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-SubscriberSipAddress <String>]

Parameters

Test-CsPresence is an example of a Communications Server "synthetic transaction." Synthetic transactions are used in Microsoft Communications Server 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.

Synthetic transactions are typically conducted in two different ways. Many administrators will use the CsHealthMonitoringConfiguration cmdlets to set up a "health registrar" for each of their registrar pools. A health registrar is nothing more than a pair of users who have been preconfigured for use with synthetic transactions. (Typically these are test accounts and not accounts belonging to actual users.) With a health registrar configured for a pool, administrators can simply 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 using actual user accounts. For example, if two users are unable to exchange instant messages, an administrator can run a synthetic transaction using the two user accounts in question (as opposed to a pair of test accounts) and try to diagnose and resolve the problem. If you decide to conduct a synthetic transaction using actual user accounts keep in mind that you will have to supply the logon names and passwords for each user.

Test-CsPresence is used to determine whether a pair of test users can log on to Microsoft Communications Server and then exchange presence information. To do this, the cmdlet first logs the two users on to the system. If both logons succeed, the first test user then asks to receive presence information from the second user. The second user publishes this information, and Test-CsPresence verifies that the information was successfully transmitted to the first user. After the exchange of presence information, the two test users are then logged off from Microsoft Communications Server.

Test-CsPresence returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

-------------------------- Example 1 --------------------------

	Copy Code
Test-CsPresence -TargetFqdn atl-cs-001.litwareinc.com

The preceding example checks to see if a pair of preconfigured test users can log on to the pool atl-cs-001.litwareinc.com; after the test users are logged on, Test-CsPresence then checks to see if the two users are able to exchange presence information. 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 determine whether the first test user can log on to the system, then check to see if this user can exchange presence information with the second test user defined for the pool.

If a registrar has not been defined then the command will fail because it will not know which users to employ when doing the test. If you have not defined a health monitoring registrar for a pool then you must include the –SubscriberSipAddress and –PublisherSipAddress parameters as well as the corresponding credentials for the users acting as the presence subscriber and the presence publisher. Test-CsPresence will then conduct its checks using the two specified users.

-------------------------- Example 2 --------------------------

	Copy Code
$cred1 = Get-Credential "litwareinc\jhaas" $cred2 = Get-Credential "litwareinc\kenmyer" Test-CsPresence -TargetFqdn atl-cs-001.litwareinc.com -SubscriberSipAddress "sip:jhaas@litwareinc.com" -SubscriberCredential $cred1 -PublisherSipAddress "sip:kenmyer@litwareinc.com" -PublisherCredential $cred2

The commands shown in Example 2 test the ability of a pair of users (litwareinc\jhaas and litwareinc\kenmyer)) to logon on to Microsoft Communications Server and then exchange presence information. To do this, the first command in the example 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. The second command does the same thing, this time returning a credential object for the Ken Myer account.

With the two credential objects in hand, the third command in the example determines whether or not the two users can log on to Microsoft Communications Server and exchange presence information. To carry out this task, Test-CsPresence is called, along with the following parameters: -TargetFqdn (the fully qualified domain name of the registrar pool); -SubscriberSipAddress (the SIP address for user 1); -SubscriberCredential (the PowerShell object containing the credentials for user 1); -PublisherSipAddress (the SIP address for user 2); and –PublisherCredential (the PowerShell object containing the credentials for user 2).