Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-11-04

Use the Test-ExchangeUMCallFlow cmdlet to test call flow between Unified Messaging (UM) servers, IP gateways, IP PBXs, and Session Initiation Protocol (SIP) servers. The Test-ExchangeUMCallFlow cmdlet can be used to diagnose configuration errors found in telephony components, Microsoft Exchange Server 2010 Service Pack 1 (SP1) Unified Messaging server settings, and connectivity issues between on-premises and cross-premises Unified Messaging deployments.

Syntax

Test-ExchangeUMCallFlow [-Mode <Gateway | SIPClient>] [-VoIPSecurity <Unsecured | SIPSecured | Secured>] [-CertificateThumbprint <string>] [-NextHop <string>] [-Diversion <string>] [-HuntGroup <string>]
Test-ExchangeUMCallFlow [-Mode <Gateway | SIPClient>] [-NextHop <string>] [-CalledParty <string>] [-CallingParty <string>] [-Credential <PSCredential>]

Detailed Description

The Exchange 2010 UM Troubleshooting Tool is an Exchange Management Shell cmdlet named Test-ExchangeUMCallFlow. You can use this cmdlet to diagnose configuration errors specific to call answering scenarios to test whether voice mail is functioning correctly in both on-premises and cross-premises UM deployments. The Test-ExchangeUMCallFlow cmdlet only supports testing of call answering scenarios; however, it can’t currently be used to test the following incoming call scenarios:

  • Incoming calls to a UM auto attendant.

  • Incoming calls to a subscriber access number as an unauthenticated user.

  • Incoming calls to a subscriber access number as an authenticated Outlook Voice Access user.

You can use this cmdlet in deployments with Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010 or in UM deployments with IP gateways or IP PBXs.

This cmdlet emulates calls and runs a series of diagnostic tests that help on-premises administrators to identify configuration errors in telephony equipment, Exchange 2010 SP1 Unified Messaging settings, and connectivity issues between on-premises and cross-premises deployment of Exchange 2010 SP1 Unified Messaging.

When you run the cmdlet, it states the reason and possible solutions for issues that have been detected. It also outputs general audio quality metrics for diagnosing audio quality issues related to network connectivity such as jitter and average packet loss. The Test-ExchangeUMCallFlow cmdlet supports testing UM components in Secured, SIP Secured, and Unsecured calls, and it can be run either in Gateway or SIPClient modes.

Important:
The Test-ExchangeUMCallFlow cmdlet must be used to test only the voice mail functionality of a Unified Messaging server that has Exchange 2010 SP1 installed.

The Test-ExchangeUMCallFlow cmdlet can be installed on a local Unified Messaging server or on another 64-bit computer running:

  • Either the Windows 7 or Windows Vista operating systems.

  • Either the Windows Server 2008 or Windows Server 2008 R2 operating systems.

Prior to installing the Exchange 2010 UM Troubleshooting Tool, the following components must be installed on a 64-bit version of Windows 7, Windows Vista, or the 64-bit edition of Windows Server 2008:

The Test-ExchangeUMCallFlow cmdlet isn't included on the Exchange 2010 SP1 DVD or the Exchange 2010 SP1-only download; however, you can download the Test-ExchangeUMCallFlow cmdlet from the Microsoft Download Center.

Parameters

Parameter Required Type Description

CalledParty

Required

System.String

The CalledParty parameter specifies the SIP URI of the Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010 user that has been enabled for the Enterprise Voice user that the Test-ExchangeUMCallFlow cmdlet will make the voice call to, for example: -CalledParty tonysmith@contoso.com. Use this parameter if you're running the tool in SIPClient mode.

CallingParty

Required

System.String

The CallingParty parameter specifies the SIP URI of the Office Communications Server 2007 R2 or Lync Server 2010 user that has been enabled for the Enterprise Voice user who's making the incoming call, for example: -CallingParty tonysmith@contoso.com. Use this parameter if you're running the tool in SIPClient mode.

Diversion

Required

System.String

The Diversion parameter specifies the string that should be sent as diversion information for the incoming call. This can be in the form of a Diversion or History-Info header. The diversion information can be either an extension number or also include additional diversion information.

When you provide diversion information as a History-Info header, verify the following:

  • There are at least two different entries with different user parts.

  • The last entry should contain the user's associated UM dial plan pilot number.

  • The second to last entry should include the UM-enabled user's extension number. This entry must also include the appropriate Reason text. This text must be properly escaped in accordance with standard URL parameter escaping rules.

Mode

Required

Microsoft.Exchange.UM.TroubleshootingTool.TestMode

The Mode parameter specifies whether the IP gateway, IP PBX, or Office Communications Server mode is to be used. You can specify either Gateway mode when your UM deployment includes IP gateways or IP PBXs or SIPClient mode if your UM deployment includes Office Communications Server 2007 R2 or Lync Server 2010.

NextHop

Required

System.String

The NextHop parameter specifies the IP address or fully qualified domain name (FQDN) and can also include the TCP port of the next hop that the Test-ExchangeUMCallFlow cmdlet must connect to while emulating the IP gateway or IP PBX. When you include the TCP port, you must include either port 5060 for Unsecured mode or port 5061 for Secured or SIPSecured mode, for example: gateway.contoso.com:5061 If you're using the cmdlet in a cross-premises environment, you must enter the FQDN of the Session Border Controller (SBC). If you're using the cmdlet in an on-premises environment, you must use the FQDN of a UM server.

CertificateThumbprint

Optional

System.String

The CertificateThumbprint parameter specifies the thumbprint of the certificate used for Transport Layer Security (TLS). This is required if either the SIPSecured or Secured mode is configured on the UM dial plan. This certificate thumbprint is the certificate that was exported from the IP gateway, IP Private Branch eXchange (PBX), or Session Border Controller (SBC). Also, the computer that has the UM Troubleshooting Tool installed and is being used to test for call flow must trust the next hop's certificate of authority.

Credential

Optional

System.String

The Credential parameter specifies the credentials that will be used to run the cmdlet.

HuntGroup

Optional

System.String

The HuntGroup parameter specifies the UM hunt group associated with the IP gateway being emulated. This is typically an extension number. Use this parameter if you're running the tool in Gateway mode.

VoIPSecurity

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMVoIPSecurityType

The VoIPSecurity parameter specifies the security mode when using the cmdlet in Gateway mode. You can use one of the following Voice over IP (VoIP) security modes:

  • Secured (TLS/SRTP)

  • Unsecured (TCP/RTP) (default)

  • SIPSecured (TLS/RTP)

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Examples

EXAMPLE 1

This example uses the Gateway mode and tests the call flow in a non-Office Communications Server 2007 R2 or Lync Server 2010 environment. This example sets the VoIP security mode to Unsecured, uses the IP address 10.1.1.1 as the next hop, and includes an extension number in the diversion information.

Copy Code 
Test-ExchangeUMCallFlow -Mode Gateway -VoIPSecurity Unsecured -NextHop 10.1.1.1 -Diversion 12345

EXAMPLE 2

This example uses the SIPClient mode and tests the call flow with a Secured UM dial plan in an environment that contains Office Communications Server 2007 R2 or Lync Server 2010 servers. By default, when you run the cmdlet, the cmdlet uses the credentials of the user currently logged onto the computer.

Copy Code 
Test-ExchangeUMCallFlow -Mode SIPClient -CallingParty tony@contoso.com -CalledParty david@contoso.com -Credential $get

EXAMPLE 3

This example uses the Gateway mode and tests the call flow in a non-Office Communications Server environment. This example sets the VoIP security mode to Secured, uses the IP address 10.176.10.194 as the next hop, and includes diversion information.

Copy Code 
Test-ExchangeUMCallFlow -Mode Gateway -VoIPSecurity Secured -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b -NextHop gateway.contoso.com -HuntGroup 10000 -Diversion "History-Info: <sip:10001@10.176.10.194;user=phone?Reason=SIP%3Bcause%3D487%3Btext%3DTimeout>;index=1,<sip:10000@10.176.10.194;user=phone?Reason=SIP>;index=1.1"