Skip to content

Commit 16e0e66

Browse files
committed
Update Test-OutlookConnectivity.md
Per Issue #1736
1 parent 960e054 commit 16e0e66

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

exchange/exchange-ps/exchange/client-access/Test-OutlookConnectivity.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -110,54 +110,39 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
110110

111111
### -------------------------- Example 1 --------------------------
112112
```
113-
Test-OutlookConnectivity -Protocol:HTTP -GetDefaultsFromAutoDiscover:$true
113+
Test-OutlookConnectivity -ProbeIdentity OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe
114114
```
115115

116-
In Exchange 2010, 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. This example command can be run to test TCP/IP connectivity by setting the Protocol parameter to RPC.
116+
In Exchange 2013 or later, this example runs an MAPI over HTTP OutlookRpcSelfTestProbe on the Mailbox server that you're currently connected to.
117117

118118
### -------------------------- Example 2 --------------------------
119119
```
120-
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcSelfTestProbe"
120+
Test-OutlookConnectivity "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId [email protected]
121121
```
122122

123-
In Exchange 2013 or later, this example runs an OutlookRpcSelfTestProbe on the mailbox server that you're currently connected to.
123+
In Exchange 2013 or later, this example runs the OutlookRpcDeepTestProbe from the "PrimaryMailbox" server for the mailbox "[email protected]" mounted on "Mailbox Database 1234512345". Because the Credential parameter is not specified, the probe will use the default testing credentials.
124124

125125
### -------------------------- Example 3 --------------------------
126126
```
127-
Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server
127+
Test-OutlookConnectivity -Protocol HTTP -GetDefaultsFromAutoDiscover $true
128128
```
129129

130-
In Exchange 2010, 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. To only validate TCP/IP connectivity, omit the RpcProxyTestType parameter.
130+
In Exchange 2010, 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. This example command can be run to test TCP/IP connectivity by setting the Protocol parameter to RPC.
131131

132132
### -------------------------- Example 4 --------------------------
133133
```
134-
Test-OutlookConnectivity "OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId [email protected]
134+
Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server
135135
```
136136

137-
In Exchange 2013 or later, this example runs the OutlookRpcDeepTestProbe from the "PrimaryMailbox" server for the mailbox "[email protected]" mounted on "Mailbox Database 1234512345". Because the Credential parameter is not specified, the probe will use the default testing credentials.
137+
In Exchange 2010, 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. To only validate TCP/IP connectivity, omit the RpcProxyTestType parameter.
138138

139139
### -------------------------- Example 5 --------------------------
140140
```
141-
Test-OutlookConnectivity -RpcProxyServer:RpcProxySrv01 -RpcProxyAuthenticationType:Basic -RpcClientAccessServer:CAS01 -RpcAuthenticationType:NTLM
141+
Test-OutlookConnectivity -RpcProxyServer RpcProxySrv01 -RpcProxyAuthenticationType Basic -RpcClientAccessServer CAS01 -RpcAuthenticationType NTLM
142142
```
143143

144144
In Exchange 2010, this example validates Outlook connectivity through RpcProxy on one server to a different server running the Client Access server role with Basic for the outer authentication layer and NTLM for the inner authentication layer. Using these parameters should allow 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. This following command is similar to running a connectivity test using the RPC Ping utility but provides stronger validation.
145145

146-
### -------------------------- Example 6 --------------------------
147-
```
148-
$TestCredentials = Get-Credential;
149-
Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId [email protected] -Credential $TestCredentials
150-
```
151-
152-
In Exchange 2013 or later, this example runs the OutlookRpcCtpProbe and verifies the log-on credentials for the "[email protected]" mailbox.
153-
154-
### -------------------------- Example 7 --------------------------
155-
```
156-
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcCTPProbe" -MailboxID [email protected]
157-
```
158-
159-
In Exchange 2013 or later, this example runs a logon test from the client access services on a Mailbox server for the mailbox [email protected].
160-
161146
## PARAMETERS
162147

163148
### -Identity
@@ -356,7 +341,7 @@ Accept wildcard characters: False
356341
### -MonitoringContext
357342
This parameter is available or functional only in Exchange Server 2010.
358343
359-
The MonitoringContext parameter specifies whether the command returns additional information that can be used with Microsoft System Center Operations Manager 2007. The default value is $false.
344+
The MonitoringContext switch specifies whether the command returns additional information that can be used with Microsoft System Center Operations Manager 2007. You don't need to specify a value with this switch.
360345
361346
```yaml
362347
Type: SwitchParameter
@@ -371,11 +356,23 @@ Accept wildcard characters: False
371356
```
372357
373358
### -ProbeIdentity
374-
The ProbeIdentity parameter specifies the probe to use.
359+
The ProbeIdentity parameter specifies the probe to use. Valid values are:
360+
361+
Outlook Anywhere (RPC over HTTP) probes:
362+
363+
- Outlook.Protocol\OutlookRpcSelfTestProbe: Validates that the RPC/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity.
364+
365+
- Outlook.Protocol\OutlookRpcDeepTestProbe: Validates that the RPC/HTTP endpoint is working on the Mailbox server. It will attempt to connect to and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet.
366+
367+
- Outlook.Protocol\OutlookRpcDeepTestProbe\<Case-sensitive Mailbox Database Name>: Validates that the RPC/HTTP endpoint is working on the Mailbox Server. It will attempt to connect to and log in to the mailbox in the specified mailbox database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530").
368+
369+
MAPI over HTTP probes:
370+
371+
- OutlookMapiHttp.Protocol\OutlookMapiHttpSelfTestProbe: Validates that the MAPI/HTTP endpoint is able to receive traffic on the Mailbox server. It does not attempt to log in to a mailbox. It is a high level check of connectivity.
375372
376-
- RPC over HTTP (Outlook Anywhere) probes
373+
- OutlookMapiHttp.Protocol\OutlookMapiHttpDeepTestProbe: Validates that the MAPI/HTTP endpoint is working on the Mailbox server. It will attempt to connect and log in to the mailbox. Since no database is specified, it will attempt to connect to the first database returned by the Get-MailboxDatabase cmdlet.
377374
378-
- MAPI over HTTP probes
375+
- OutlookMapiHttp.Protocol\OutlookRpcDeepTestProbe\<Case-sensitive Mailbox Database Name>: Validates that the MAPI/HTTP endpoint is working on the Mailbox Server. It will attempt to connect and log in to the mailbox in the specified database. If the mailbox database name contains spaces, enclose the entire value in quotation marks (for example, "Outlook.Protocol\OutlookRpcDeepTestProbe\Mailbox Database 0352791530").
379376
380377
```yaml
381378
Type: String

0 commit comments

Comments
 (0)