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

Topic Last Modified: 2012-11-19

Use the Test-UMConnectivity cmdlet to test the operation of a computer that has the Unified Messaging (UM) server role installed.

Syntax


`Test-UMConnectivity [-CertificateThumbprint <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MediaSecured <$true \| $false>] [-MonitoringContext <$true \| $false>] [-RemotePort <Int32>] [-Secured <$true \| $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]`


`Test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <$true \| $false> -UMDialPlan <UMDialPlanIdParameter> [-CertificateThumbprint <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MediaSecured <$true \| $false>] [-MonitoringContext <$true \| $false>] [-RemotePort <Int32>] [-Secured <$true \| $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]`


`Test-UMConnectivity -TUILogonAll <$true \| $false> [-CertificateThumbprint <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MediaSecured <$true \| $false>] [-MonitoringContext <$true \| $false>] [-RemotePort <Int32>] [-Secured <$true \| $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]`


Test-UMConnectivity -Phone <String> -UMIPGateway <UMIPGatewayIdParameter> [-CertificateThumbprint <String>] [-Confirm [<SwitchParameter>]] [-DiagDtmfDurationInMilisecs <Int32>] [-DiagDtmfSequence <String>] [-DiagInitialSilenceInMilisecs <Int32>] [-DiagInterDtmfDiffGapInMilisecs <String>] [-DiagInterDtmfGapInMilisecs <Int32>] [-DomainController <Fqdn>] [-From <String>] [-ListenPort <Int32>] [-MediaSecured <$true \| $false>] [-MonitoringContext <$true \| $false>] [-Secured <$true \| $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]

Test-UMConnectivity -Phone <String> -UMIPGateway
<UMIPGatewayIdParameter> [-CertificateThumbprint
<String>] [-Confirm [<SwitchParameter>]]
[-DiagDtmfDurationInMilisecs <Int32>] [-DiagDtmfSequence
<String>] [-DiagInitialSilenceInMilisecs <Int32>]
[-DiagInterDtmfDiffGapInMilisecs <String>]
[-DiagInterDtmfGapInMilisecs <Int32>] [-DomainController
<Fqdn>] [-From <String>] [-ListenPort <Int32>]
[-MediaSecured <$true | $false>] [-MonitoringContext
<$true | $false>] [-Secured <$true | $false>] [-Timeout
<Int32>] [-WhatIf [<SwitchParameter>]]


`Test-UMConnectivity -ResetPIN <$true \| $false> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-MonitoringContext <$true \| $false>] [-WhatIf [<SwitchParameter>]]`

Detailed Description

Two diagnostic tests are designed to test the operation of the Microsoft Exchange Server 2010 Unified Messaging server software (mode 1) and the operation of the whole system that includes the connected telephony components (mode 2).

The Test-UMConnectivity cmdlet can be used to test the operation of a Unified Messaging server and related connected telephony equipment. When you run this cmdlet and include the UMIPGateway parameter, the Unified Messaging server tests the full end-to-end operation of the Unified Messaging system. This test includes the telephony components connected to the Unified Messaging server, such as IP gateways, Private Branch eXchanges (PBXs), and cabling. If the UMIPGateway parameter isn't specified, the Unified Messaging server tests only the operation of the Unified Messaging components that are installed and configured on the server.

When you run this cmdlet in an on-premises Unified Messaging deployment, you need to create a UM IP gateway object for the computer or server that the cmdlet is testing. When you create the UM IP gateway object, you must configure it with a fully qualified domain name (FQDN) and that FQDN must match the name of the computer that will be running this cmdlet.

After this task is complete, the cmdlet will have tested the operation of the Unified Messaging server and related telephony components.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM server" entry in the Unified Messaging Permissions topic.

Parameters

Parameter	Required	Type	Description
Phone	Required	System.String	The Phone parameter specifies the telephone number or Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) used when the test call is redirected. The extension number should be configured in the PBX to forward calls to the UM hunt group.
PIN	Required	System.String	The PIN parameter specifies the PIN associated with the UM-enabled mailbox.
ResetPIN	Required	System.Boolean	The ResetPIN parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site.
TUILogon	Required	System.Boolean	The TUILogon parameter specifies whether the cmdlet will try to log on to one or more UM-enabled mailboxes. The mailboxes must be UM-enabled and associated with the UM dial plan to which the Unified Messaging server belongs. The default setting is `$false`.
TUILogonAll	Required	System.Boolean	The TUILogonAll parameter specifies whether to try to connect to all test mailboxes in the current Active Directory site. The default setting is `$false`. The accounts that are tested must be generated by calling the New-TestCasConnectivityUser.ps1 script, and the corresponding mailboxes must be UM-enabled. Otherwise, no action will be taken.
UMDialPlan	Required	Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter	The UMDialPlan parameter specifies the UM dial plan to be tested. This parameter must be used with the TUILogon parameter.
UMIPGateway	Required	Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter	The UMIPGateway parameter specifies the name of the UM IP gateway or IP PBX to use for the outgoing test call.
CertificateThumbprint	Optional	System.String	The CertificateThumbprint parameter specifies the certificate thumbprint used for SIP Secured and Secured mode.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.
DiagDtmfDurationInMilisecs	Optional	System.Int32	The DiagDtmfDurationInMilisecs parameter specifies the duration of each digit sent.
DiagDtmfSequence	Optional	System.String	The DiagDtmfSequence parameter specifies the sequence of digits sent.
DiagInitialSilenceInMilisecs	Optional	System.Int32	The DiagInitialSilenceInMilisecs parameter specifies the time period in milliseconds that the cmdlet pauses before the digit sequence is sent.
DiagInterDtmfDiffGapInMilisecs	Optional	System.String	The DiagInterDtmfDiffGapInMilisecs parameter specifies whether to customize the time between the digits in the diagnostic sequence. This is a comma-delimited list that can accept null entries. This should include multiple values.
DiagInterDtmfGapInMilisecs	Optional	System.Int32	The DiagInterDtmfGapInMilisecs parameter specifies the time in milliseconds between each digit sent in the digit sequence. This is a single value.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.
From	Optional	System.String	The From parameter specifies the SIP URI or SIP address that the call originated from. It's used only when you use the Phone parameter. The default setting is the SIP URI specified when you use the Phone parameter.
ListenPort	Optional	System.Int32	The ListenPort parameter specifies the IP port number on which to listen. If not specified, IP port 9000 is used.
MediaSecured	Optional	System.Boolean	The MediaSecured parameter specifies whether to use Secure RTP or RTP (unsecured) mode.
MonitoringContext	Optional	System.Boolean	The MonitoringContext parameter specifies whether you run the cmdlet at a command prompt or whether the output object is passed to Microsoft System Center Operations Manager 2007. By default, you run the cmdlet from a command prompt.
RemotePort	Optional	System.Int32	The RemotePort parameter specifies the port used for the call. If not specified, the default is port 5060 for Transmission Control Protocol (TCP) and 5061 for mutual Transport Layer Security (TLS).
Secured	Optional	System.Boolean	The Secured parameter specifies whether the test is run in SIP Secured mode.
Timeout	Optional	System.Int32	The Timeout parameter specifies the length of time in seconds to wait for the test operation to finish. The default is 600 seconds. You can't set this parameter with a value of less than 60 seconds. However, we recommend that you always configure this parameter with a value of 60 seconds or more. The maximum value for this parameter is 1800 seconds.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

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.

Examples

EXAMPLE 1

This example performs connectivity and operational tests on the local Unified Messaging server, and then displays the Voice over IP (VoIP) connectivity information.

	Copy Code
Test-UMConnectivity

EXAMPLE 2

This example tests the ability of the local Unified Messaging server to use an unsecured TCP connection instead of a secured mutual TLS connection to place a call through a UM IP gateway named MyUMIPGateway by using the telephone number 56780.

	Copy Code
Test-UMConnectivity -UMIPGateway MyUMIPGateway -Phone 56780 -Secured $false

EXAMPLE 3

This example tests a SIP dial plan by using a SIP URI. This example can be used in an environment that includes Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010.

	Copy Code
Test-UMConnectivity -Phone sip:sipdp.contoso.com@contoso.com -UMIPGateway MyUMIPGateway -Secured $true -From sip:user1@contoso.com -MediaSecured $true