Test-CsPstnOutboundCall
Topic Last Modified: 2012-03-26
Tests the ability of a user to make a call to a phone number located on the public switched telephone network (PSTN).
Syntax
Test-CsPstnOutboundCall -TargetFqdn <String> -TargetPstnPhoneNumber <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-UserSipAddress <String>]
Test-CsPstnOutboundCall [-TargetFqdn <String>] -TargetPstnPhoneNumber <String> -UserCredential <PSCredential> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>]
Detailed Description
Test-CsPstnOutboundCall is an example of a Microsoft Lync Server 2010 "synthetic transaction." Synthetic transactions are used in 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 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 you will need to supply the logon names and passwords for each user.
Test-CsPstnOutboundCall can also be used in server platform mode. In that case you only need to specify the SIP address of a user, and Lync Server 2010 will use certificates to authenticate that user.
When you run Test-CsPstnOutboundCall, the cmdlet first attempts to log the test user on to Lync Server. If the logon succeeds, the cmdlet will then attempt to make a phone call across the PSTN gateway. This phone call will be placed using the dial plan, voice policy, and other policies and settings assigned to the test account. When the call is answered, the cmdlet sends dual-tone multi-frequency (DTMF) codes across the network in order to verify media connectivity.
When conducting its test, Test-CsPstnOutboundCall will make an actual phone call: the target phone will ring and must be answered for the test to succeed. This call must also be manually ended by the administrator.
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-CsPstnOutboundCall"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
TargetFqdn |
Required |
String |
Fully qualified domain name (FQDN) of the pool to be tested. |
TargetPstnPhoneNumber |
Required |
String |
PSTN telephone number to be called when conducting the test. The target phone number is best specified using the E.164 format, which means that the number will look something like this "+14255551298", with that number containing a plus sign (+) followed by the country/region calling code (1), the area code (425) and the phone number (5551298). Do not use dashes, parentheses, or any other characters when specifying the phone number. If you do not use the E.164 format the dial plan of the test user will be appended to the number. Lync Server 2010 will then use that dial plan to normalize the number to the E.164 format. If the number cannot be normalized then the call cannot be placed and the test will fail. |
UserCredential |
Optional |
PS credential object |
User credential object for the 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. This parameter is not needed if the command is using test users configured by using the CsHealthMonitoringConfiguration cmdlets. You also do not need to specify this parameter if the test is being conducted in server platform mode. In that case, Lync Server 2010 will attempt to authenticate the user by using certificates. |
UserSipAddress |
Optional |
SIP address |
SIP address for the user account to be tested. For example: -SenderSipAddress "sip:kenmyer@litwareinc.com". The UserSipAddress parameter must reference the same user account as UserCredential. This parameter is not needed if the command is using test users configured by using the CsHealthMonitoringConfiguration cmdlets. |
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. |
RegistrarPort |
Optional |
Integer |
SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
Verbose |
Optional |
String |
Reports detailed activity to the screen as the cmdlet runs. |
Input Types
None. Test-CsPstnOutboundCall does not accept pipelined input.
Return Types
Test-CsPstnOutboundCall returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 --------------------------
Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -TargetPstnPhoneNumber "+15551234567"
The preceding example checks to see if a preconfigured test user can log on to the pool atl-cs-001.litwareinc.com and then make a phone call across the PSTN gateway. This command will work only if test users been defined for the pool atl-cs-001.litwareinc.com. If they have, then the command will determine whether the first test user can log on to the system and, if so, make a phone call to a phone located on the PSTN network.
If test users have not been defined then the command will fail because it will not know which user to employ when doing the test. If you have not defined test users for a pool, then you must include the UserSipAddress parameter as well as the corresponding credentials for the user account involved in the test. Test-CsPstnOutboundCall will then conduct its checks using the specified user.
-------------------------- Example 2 --------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -TargetPstnPhoneNumber "+15551234567" -UserSipAddress "sip:kenmyer@litwareinc.com" -UserCredential $cred1
The commands shown in Example 2 test the ability of a test user (litwareinc\kenmyer) to log on to Lync Server and then make a phone call over the PSTN gateway. To do this, the first command in the example 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 only requires the administrator to enter the password for the Ken Myer account.) The resulting credential object is then stored in a variable named $cred1.
With the credential object in hand, the second command in the example determines whether or not the test user can log on to Lync Server, and then make a phone call to the target phone number (+15551234567). To carry out this task, Test-CsPstnOutboundCall is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); UserSipAddress (the SIP address for the user making the call); UserCredential (the Windows PowerShell object containing the credentials for the test user); and TargetPstnPhoneNumber (the phone number being called).
-------------------------- Example 3 --------------------------
Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress sip:kenmyer@litwareinc.com -TargetPstnPhoneNumber "+15551234567"
Example 3 shows how Test-CsPstnOutboundCall can be used in server platform mode. In this mode, the user’s SIP address is specified, but the user credentials are not included. When run like this, Lync Server 2010 uses certificates to authenticate the test user.