Export (0) Print
Expand All
Expand Minimize

Test-OutlookConnectivity

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-11-04

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange Server 2013 organization. This includes testing for both Outlook Anywhere (RPC/HTTP) and MAPI/HTTP connections.

For information about the parameter sets in the Syntax section below, see Syntax.

Test-OutlookConnectivity -ProbeIdentity <String> [-Credential <PSCredential>] [-Hostname <String>] [-MailboxId <MailboxIdParameter>] [-RunFromServerId <ServerIdParameter>] [-TimeOutSeconds <String>]

This example runs an OutlookRpcSelfTestProbe on the mailbox server that you're currently connected to.

Test-OutlookConnectivity -ProbeIdentity "OutlookRpcSelfTestProbe"

This example runs the OutlookRpcDeepTestProbe from the "PrimaryMailbox" server for the mailbox "johnd@contoso.com" mounted on "Mailbox Database 1234512345". Because the Credential parameter is not specified, the probe will use the default testing credentials.

Test-OutlookConnectivity "OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId johnd@contoso.com

This example runs the OutlookRpcCtpProbe and verifies the log-on credentials for the "johnd@contoso.com" mailbox.

$TestCredentials = Get-Credential
Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId johnd@contoso.com -Credential $TestCredentials

This example runs a logon test from a Client Access server for the mailbox johnd@contoso.com.

Test-OutlookConnectivity -ProbeIdentity "OutlookRpcCTPProbe" -MailboxID johnd@contoso.com

Running the Test-OutlookConnectivity cmdlet validates an Outlook connection defined by the provided parameters. The command has been simplified in Exchange Server 2013 to validate a single mailbox.

Test-OutlookConnectivity cmdlet runs the same process as the monitoring probes. The Microsoft Exchange Health Manager (MSExchangeHM) service must be running and have created the Outlook probes on the machine that will be tested. You must select one of the Outlook probe identities to run the test. Use the Get-MonitoringItemIdentity cmdlet to see what probes are active.

This example lists the probes running on a mailbox server.

Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook.protocol | ?{$_.Name -like '*probe'}

This example lists the probes running on a client access server.

Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook | ?{$_.Name -like '*probe'}

For more information on probes and the monitoring framework, see Managed Availability, Managed Availability and Server Health, and Customizing Managed Availability

By default, the cmdlet uses the test monitoring account attached to the specifed probe. You may enter a different mailbox instead via the MailboxId parameter. The options and results follow.

  • MailboxId and Credential are not specified: Generic connectivity test against a test mailbox using the system’s test credentials.

  • MailboxId is specified, Credential is not: Connectivity test to the specific mailbox using the system’s test credentials.

  • MailboxId and Credential are both specified: You get a connectivity test to the specific mailbox, and also a test that the credentials provided are valid for that mailbox

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 "Test Outlook connectivity" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

ProbeIdentity

Required

System.String

The ProbeIdentity parameter specifies the probe to use.

  • RPC over HTTP (Outlook Anywhere) probes

    • OutlookRpcSelfTestProbe:   Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log onto a mailbox. It is a high level check of connectivity.

    • OutlookRpcDeepTestProbe:   Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log onto the mailbox. Since no database is specified, it will attempt to connect to the first database listed by the Get-Mailboxdatabase cmdlet.

    • OutlookRpcDeepTestProbe/<Database name>:   Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log onto the mailbox in the specified database.

    • OutlookRpcCtpProbe:   Validates that the RPC/HTTP endpoint is working on the Client Access server. Since no database is specified, it will attempt to connect to the first database listed by the Get-Mailboxdatabase cmdlet.

    • OutlookRpcCtpProbe/<database name>:   Validates that the RPC/HTTP endpoint is working on the Client Access server. It will attempt to route the connection to the correct back end Mailbox server, and connect and log onto a mailbox in the database.

  • MAPI over HTTP probes

    • OutlookMapiHttpSelfTestProbe:   Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log onto a mailbox. It is a high level check of connectivity.

    • OutlookMapiHttpDeepTestProbe:   Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log onto the mailbox. Since no database is specified, it will attempt to connect to the first database listed by the Get-Mailboxdatabase cmdlet.

    • OutlookMapiHttpDeepTestProbe/<Database name>:   Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log onto the mailbox in the specified database.

    • OutlookMapiHttpCtpProbe:   Validates that the MAPI/HTTP endpoint is working on the Client Access server. Since no database is specified, it will attempt to connect to the first database listed by the Get-Mailboxdatabase cmdlet.

    • OutlookMapiHttpCtpProbe/<database name>:   Validates that the MAPI/HTTP endpoint is working on the Client Access server. It will attempt to route the connection to the correct back end Mailbox server, and connect and log onto a mailbox in the database.

Credential

Optional

System.Management.Automation.PSCredential

The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

Hostname

Optional

System.String

The Hostname parameter specifies the protocol endpoint target of the probe. You can use a specific Client Access server or route through Distributed Name Service server.

MailboxId

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The MailboxID parameter specifies the target mailbox. IF not specified, this uses the test account.

RunFromServerId

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The RunFromServerID parameter specifies the server on which the probe should be run.

TimeOutSeconds

Optional

System.String

The TimeOutSeconds parameter specifies the timeout period in seconds before the probe is ended. The default value is 30 seconds. The digits can be entered with or with the use of quotation marks. Either 10 or “10” will work. Any input error will default back to 30 seconds.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft