Test-UMConnectivity
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Test-UMConnectivity cmdlet can be used to test the operation of a computer that has the Unified Messaging server role installed.
Syntax
test-UMConnectivity [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Fax <$true | $false>] [-ListenPort <Int32>] [-MediaSecured <$true | $false>] [-MonitoringContext <$true | $false>] [-RemotePort <Int32>] [-Secured <$true | $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]
test-UMConnectivity -TUILogonAll <$true | $false> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MediaSecured <$true | $false>] [-MonitoringContext <$true | $false>] [-RemotePort <Int32>] [-Secured <$true | $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]
test-UMConnectivity -ResetPIN <$true | $false> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-MonitoringContext <$true | $false>] [-WhatIf [<SwitchParameter>]]
test-UMConnectivity -Phone <String> -UMIPGateway <UMIPGatewayIdParameter> [-Confirm [<SwitchParameter>]] [-DiagDtmfDurationInMilisecs <Int32>] [-DiagDtmfSequence <String>] [-DiagInitialSilenceInMilisecs <Int32>] [-DiagInterDtmfDiffGapInMilisecs <String>] [-DiagInterDtmfGapInMilisecs <Int32>] [-DomainController <Fqdn>] [-Fax <$true | $false>] [-From <String>] [-ListenPort <Int32>] [-MediaSecured <$true | $false>] [-MonitoringContext <$true | $false>] [-Secured <$true | $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]
test-UMConnectivity -Phone <String> -PIN <String> -TUILogon <$true | $false> -UMDialPlan <UMDialPlanIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ListenPort <Int32>] [-MediaSecured <$true | $false>] [-MonitoringContext <$true | $false>] [-RemotePort <Int32>] [-Secured <$true | $false>] [-Timeout <Int32>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The two diagnostic tests are designed to test the operation of the Microsoft Exchange Server 2007 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 (UM) server and related connected telephony equipment. When an administrator runs this cmdlet and includes the UMIPGateway parameter, the Unified Messaging server tests the full end-to-end operation of the UM system. This includes the telephony components that are connected to the Unified Messaging server, such as IP gateways, Private Branch eXchanges (PBXs), and cabling. If the IPGateway parameter is not specified, the Unified Messaging server will test only the operation of the UM components that are installed and configured on the server.
To run the Test-UMConnectivity cmdlet, the account you use must be delegated the Exchange Server Administrator role and local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Phone |
Required |
System.String |
This parameter specifies the telephone number or SIP URI that will be used when the test call is redirected. The extension number should be configured in the PBX to call forward to the UM hunt group. |
PIN |
Required |
System.String |
This parameter lets you specify the PIN that is associated with the UM-enabled mailbox. |
ResetPIN |
Required |
System.Boolean |
This parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site. |
TUILogon |
Required |
System.Boolean |
This parameter specifies whether you want the cmdlet to 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 |
This parameter specifies whether to test all mailboxes in the current Active Directory site then test connectivity to each UM-enabled mailbox. The default setting is false. |
UMDialPlan |
Required |
Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter |
This parameter specifies the UM dial plan that will be tested. It must be used with the TUILogin parameter. |
UMIPGateway |
Required |
Microsoft.Exchange.Configuration.Tasks.UMIPGatewayIdParameter |
This parameter specifies the name of the UM IP gateway or IP PBX to use for the outgoing test call. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true. |
DiagDtmfDurationInMilisecs |
Optional |
System.Int32 |
This parameter specifies the duration of each digit that is sent. |
DiagDtmfSequence |
Optional |
System.String |
This parameter specifies the sequence of digits that are sent. |
DiagInitialSilenceInMilisecs |
Optional |
System.Int32 |
This parameter specifies the time period (milliseconds) that the cmdlet will pause before the digit sequence is sent. |
DiagInterDtmfDiffGapInMilisecs |
Optional |
System.String |
This parameter is used 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 |
This parameter specifies the time in milliseconds between each digit that is sent in the digit sequence. This is a single value. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service. |
Fax |
Optional |
System.Boolean |
This parameter specifies that the call being tested is a fax call. The default setting is |
From |
Optional |
System.String |
This parameter specifies the SIP URI or SIP address that the call originated from. It is used only when you use the -Phone parameter. The default setting is the SIP URI that is specified when you use the -Phone parameter. |
ListenPort |
Optional |
System.Int32 |
This parameter specifies the IP port number on which to listen. If not specified, IP port 9000 will be used. |
MediaSecured |
Optional |
System.Boolean |
This parameter specifies whether to use Secure RTP or unsecured mode. |
MonitoringContext |
Optional |
System.Boolean |
This parameter specifies whether the cmdlet will run at a command line or whether the output object will be passed to Microsoft Operations Manager. By default, the cmdlet will run from the command line. |
RemotePort |
Optional |
System.Int32 |
This parameter specifies the port that will be used for the call. If not specified, the default is port 5060 for TCP and 5061 for MTLS. |
Secured |
Optional |
System.Boolean |
This parameter specifies whether the test will be run in secured mode. |
Timeout |
Optional |
System.Int32 |
This parameter specifies the length of time to wait for the test operation to finish (in seconds). The default is 180 seconds. You can set this parameter with a value of less than 5 seconds. However, we recommend that you always configure this parameter with a value of 5 seconds or more. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $true. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example performs connectivity and operational tests on the local Unified Messaging server and then displays the Voice over IP (VoIP) connectivity information.
The second example tests the ability of the local Unified Messaging server to use an unsecured Transmission Control Protocol (TCP) connection instead of a secured Mutual Transport Layer Security (MTLS) connection to place a call through a UM IP gateway named MyUMIPGateway by using the telephone number 56780.
The third example tests the subscriber access number on a dial plan by using a SIP URI. This example can be used in an environment that includes Microsoft Office Communications Server 2007.
The fourth example tests an auto attendant using a SIP URI. This is used in an environment that contains Communications Server 2007.
Test-UMConnectivity
Test-UMConnectivity -UMIPGateway MyUMIPGateway -Phone 56780 -Secured $false
Test-UMConnectivity -UMIPGateway OCSGateway1 -Phone "sip:SIPdialplan.contoso.com@contoso.com"
Test-UMConnectivity -UMIPGateway OCSGateway1 -Phone "sip:SIPAutoAttendant.SIPDialPlan.contoso.com@contoso.com"