Applies to: Exchange Server 2007
Topic Last Modified: 2007-10-02
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 [-DomainController <Fqdn>]
[-Fax <$true | $false>] [-ListenPort <Int32>]
[-MonitoringContext <$true | $false>] [-Secured <$true |
$false>] [-Timeout <Int32>]
|
test-UMConnectivity -ResetPIN <$true | $false>
[-DomainController <Fqdn>] [-MonitoringContext <$true |
$false>]
|
test-UMConnectivity -Phone <String> -UMIPGateway
<UMIPGatewayIdParameter> [-DomainController <Fqdn>]
[-Fax <$true | $false>] [-ListenPort <Int32>]
[-MonitoringContext <$true | $false>] [-Secured <$true |
$false>] [-Timeout <Int32>]
|
test-UMConnectivity -TUILogonAll <$true | $false>
[-DomainController <Fqdn>] [-ListenPort <Int32>]
[-MonitoringContext <$true | $false>] [-Secured <$true |
$false>] [-Timeout <Int32>]
|
test-UMConnectivity -Phone <String> -PIN
<String> -TUILogon <$true | $false> -UMDialPlan
<UMDialPlanIdParameter> [-DomainController <Fqdn>]
[-ListenPort <Int32>] [-MonitoringContext <$true |
$false>] [-Secured <$true | $false>] [-Timeout
<Int32>]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Phone |
Required |
System.String |
This parameter specifies the telephone number 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. |
|
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. |
|
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. |
|
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. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
|
Fax |
Optional |
System.Boolean |
This parameter specifies that the call being tested is a fax
call. The default setting is |
|
ListenPort |
Optional |
System.Int32 |
This parameter specifies the IP port number on which to listen. If not specified, IP port 9000 will be used. |
|
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. |
|
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. |
|
ResetPIN |
Required |
System.Boolean |
This parameter specifies whether to generate or regenerate a new PIN for all the test mailboxes in the current site. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
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 following:
- 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 Server 2007, see Permission Considerations.
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.
 Copy Code |
|
|---|---|
Test-UMConnectivity Test-UMConnectivity -UMIPGateway MyUMIPGateway -Phone 56780 -Secured $false |
|