Commands › Exchange Online

Test-UMConnectivity

Exchange Online ExchangeOnlineManagement Test-*

Test the operation of Unified Messaging (UM) servers. **Note**: This cmdlet works best in Exchange 2010. In later versions of Exchange, the functionality of this cmdlet is replaced by Managed Availability. For the best results, use the Invoke-MonitoringProbe cmdlet and specify the relevant active monitor probe instead of using this cmdlet.

Quick start script

# Test-UMConnectivity — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Test-UMConnectivity -Phone <String> -PIN <String> -ResetPIN <Boolean> | Format-List

# 3. Export for evidence / drift tracking
Test-UMConnectivity | Export-Clixml .\UMConnectivity-$(Get-Date -Format yyyyMMdd).xml

Syntax — 5 parameter sets

TuiLogonSpecific

Test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <Boolean> -UMDialPlan <UMDialPlanIdParameter>
 [-CertificateThumbprint <String>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-ListenPort <Int32>]
 [-MediaSecured <Boolean>]
 [-MonitoringContext <Boolean>]
 [-RemotePort <Int32>]
 [-Secured <Boolean>]
 [-Timeout <Int32>]
 [-WhatIf]
 [<CommonParameters>]

EndToEnd

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

PinReset

Test-UMConnectivity -ResetPIN <Boolean>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-MonitoringContext <Boolean>]
 [-WhatIf]
 [<CommonParameters>]

TuiLogonGeneral

Test-UMConnectivity -TUILogonAll <Boolean>
 [-CertificateThumbprint <String>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-ListenPort <Int32>]
 [-MediaSecured <Boolean>]
 [-MonitoringContext <Boolean>]
 [-RemotePort <Int32>]
 [-Secured <Boolean>]
 [-Timeout <Int32>]
 [-WhatIf]
 [<CommonParameters>]

1 more parameter sets — see the parameter table below.

Parameters (24)

Parameter	Type	Required	What it controls
-Phone	String	yes	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...
-PIN	String	yes	The PIN parameter specifies the PIN associated with the UM-enabled mailbox.
-ResetPIN	Boolean	yes	The ResetPIN parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site.
-TUILogon	Boolean	yes	The TUILogon parameter specifies whether the cmdlet tries 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 Mailbox server running the...
-TUILogonAll	Boolean	yes	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...
-UMDialPlan	UMDialPlanIdParameter	yes	The UMDialPlan parameter specifies the UM dial plan to be tested. This parameter must be used with the TUILogon parameter.
-UMIPGateway	UMIPGatewayIdParameter	yes	The UMIPGateway parameter specifies the name of the UM IP gateway or IP PBX to use for the outgoing test call.
-CallRouter	SwitchParameter		The CallRouter switch specifies whether to test the Microsoft Exchange Unified Messaging Call Router service (front-end). You don't need to specify a value with this switch.
-CertificateThumbprint	String		The CertificateThumbprint parameter specifies the certificate thumbprint used for SIP Secured and Secured mode.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DiagDtmfDurationInMilisecs	Int32		The DiagDtmfDurationInMilisecs parameter specifies the duration of each digit sent.
-DiagDtmfSequence	String		The DiagDtmfSequence parameter specifies the sequence of digits sent.
-DiagInitialSilenceInMilisecs	Int32		The DiagInitialSilenceInMilisecs parameter specifies the time period in milliseconds that the cmdlet pauses before the digit sequence is sent.
-DiagInterDtmfDiffGapInMilisecs	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...
-DiagInterDtmfGapInMilisecs	Int32		The DiagInterDtmfGapInMilisecs parameter specifies the time in milliseconds between each digit sent in the digit sequence. This is a single value.
-DomainController	Fqdn		The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name...
-From	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	Int32		The ListenPort parameter specifies the IP port number on which to listen. If not specified, IP port 9000 is used.
-MediaSecured	Boolean		The MediaSecured parameter specifies whether to use Secure RTP or RTP (unsecured) mode.
-MonitoringContext	Boolean		The MonitoringContext parameter specifies whether to include the associated monitoring events and performance counters in the results. Valid values are:
-RemotePort	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	Boolean		The Secured parameter specifies whether the test is run in SIP Secured mode.
-Timeout	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...
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.