Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-18
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 Outlook Anywhere (RPC/HTTP) connections.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Test-OutlookConnectivity -ProbeIdentity <String>
[-Credential <PSCredential>] [-Hostname <String>]
[-MailboxId <MailboxIdParameter>] [-RunFromServerId
<ServerIdParameter>] [-TimeOutSeconds <String>]
|
Examples
EXAMPLE 1
This example tests the most common end-to-end Outlook connectivity scenario for Outlook Anywhere. This includes testing for connectivity through the Autodiscover service, creating a user profile, and logging on to the user mailbox. All of the required values are retrieved from the Autodiscover service. Because the Identity parameter isn't specified, the command uses the temporary test user that you've created using the New-TestCasConnectivityUser.ps1 script.
 Copy Code |
|
|---|---|
Test-OutlookConnectivity -GetDefaultsFromAutoDiscover:$true |
|
EXAMPLE 2
This example tests for Outlook Anywhere connectivity
using the local server as the RpcProxy endpoint as well as the RPC
endpoint. Because the Identity parameter isn't specified,
the command uses the temporary test user that you've created using
the New-TestCasConnectivityUser.ps1 script. Modify this example to
use the public external URL by setting the RpcProxyTestType
parameter to External. Additionally, the example
command can use the Client Access server array as the RPC endpoint
by setting the RpcTestType parameter to
Array.
| Copy Code |
|
|---|---|
Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server |
|
EXAMPLE 3
This example validates Outlook connectivity through
RpcProxy on one server to a different server with Basic for the
outer authentication layer and NTLM for the inner authentication
layer. Using these parameters allows you to validate most types of
Outlook connectivity configurations. This command can also be used
with the GetDefaultsFromAutoDiscover parameter set to
$true if you only need to override one or two
parameters. The following command is similar to running a
connectivity test using the RPC Ping utility but provides stronger
validation.
| Copy Code |
|
|---|---|
Test-OutlookConnectivity -RpcTestType:Server -RpcProxyAuthenticationType:Basic -RpcClientAccessServer:CAS01 -RpcAuthenticationType:NTLM |
|
Detailed Description
Running the Test-OutlookConnectivity cmdlet validates a user's Outlook connection. End-to-end verification includes testing for Autodiscover connectivity, creating a user profile, and logging on to the user's primary mailbox, or primary and on-premises archive mailbox. This cmdlet can validate Outlook Anywhere connections. If the cmdlet fails, the output notes the step that failed.
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 Anywhere connectivity" entry in the Clients and Mobile Devices Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
ProbeIdentity |
Required |
System.String |
The ProbeIdentity parameter specifies the type of probe to call. |
|
Credential |
Optional |
System.Management.Automation.PSCredential |
The Credential parameter specifies the credential used by the probe. 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. |
|
MailboxId |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The MailboxID parameter specifies the mailbox that is the target of the probe. |
|
RunFromServerId |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The RunFromServerID parameter specifies the server on which the probe should be executed. |
|
TimeOutSeconds |
Optional |
System.String |
The TimeOutSeconds parameter specifies the timeout period in seconds before the probe is abandoned. |
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.