[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Test-CsDialInConferencing checks to see if a user can take part in a dial-in conferencing session.


Test-CsDialInConferencing -TargetFqdn <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-UserSipAddress <String>]
Test-CsDialInConferencing -TargetFqdn <String> -UserCredential <PSCredential> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>]


Parameter Required Type Description




Fully qualified domain name of the pool to be tested.



PS credential object

User credential object for the user account to be tested. 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.



SIP address

SIP address for user account to be tested. For example: -SenderSipAddres "sip:kenmyer@litwareinc.com". The UserSIPAddress parameter must reference the same user account as UserCredential.




SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.



Switch Parameter

Reports detailed activity to the screen as the cmdlet runs.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

Detailed Description

Test-CsAVConference 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 could 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.

The Test-CsDialInConferencing works by attempting to log a test user onto the system. (If you are using a health monitoring registrar, Test-CsDialInConferencing will use the first test account configured for that registrar.) If logon succeeds, the cmdlet will then use the user’s credentials and permissions to try the available dial-in conferencing access numbers. The success or failure of each dial-in attempt will be noted, then the test user will be logged off from Microsoft Communications Server.

Test-CsDialInConferencing only verifies that the appropriate connections can be made. The cmdlet does not actually make any phone calls or create any dial-in conferences that other users could join.

Return Types

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


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

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

The preceding example verifies that a preconfigured test user can take part in dial-in conferencing on the pool atl-cs-001.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 determine whether or not the first test user in the health monitoring registrar is able to logon to Microsoft Communications Server.

If a health monitoring registrar has not been defined then the command will fail because it will not know which user to logon as. If you have not defined a health monitoring registrar for a pool then you must include the -UserCredential parameter and the credentials of the user that the command should employ when trying to logon.

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

Copy Code
$cred1 = Get-Credential "litwareinc\jhaas"

Test-CsDialInConferencing -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress "sip:jhaas@litwareinc.com" -UserCredential $cred1

The commands shown in Example 2 test the ability of a specific user (litwareinc\jhaas) to take part in dial-in conferencing on the pool atl-cs-001.litwareinc.com. 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 the administrator only has to enter the password for the Jonathan Haas account.) The resulting credential object is then stored in a variable named $cred1.

The second command then checks to see if this user can logon to the pool atl-cs-001.litwareinc.com and then take part in a dial-in conference. To carry out this task, Test-CsRegistration is called, along with three parameters: -TargetFqdn (the fully qualified domain name of the registrar pool); -UserCredential (the PowerShell object containing Jonathan Haas’ user credentials); and -UserSipAddress (the SIP address corresponding to the supplied user credentials).