Skip to content

Commit cd8733c

Browse files
committed
Cleanup
1 parent 7d8349c commit cd8733c

File tree

1 file changed

+12
-103
lines changed

1 file changed

+12
-103
lines changed

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

Lines changed: 12 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@ schema: 2.0.0
66
# Test-OutlookConnectivity
77

88
## SYNOPSIS
9-
!!! Exchange Server 2010
10-
11-
Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange Server 2010 organization. This includes testing for Outlook Anywhere (RPC/HTTP) and TCP-based connections.
12-
13-
!!! Exchange Server 2013
14-
15-
This cmdlet is available only in on-premises Exchange.
16-
17-
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.
18-
19-
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
20-
21-
!!! Exchange Server 2016
22-
239
This cmdlet is available only in on-premises Exchange.
2410

2511
Use the Test-OutlookConnectivity cmdlet to test end-to-end Microsoft Outlook client connectivity in the Microsoft Exchange organization. This includes testing for both Outlook Anywhere (RPC over HTTP) and MAPI over HTTP connections.
@@ -77,36 +63,6 @@ Test-OutlookConnectivity [-ProbeIdentity] <String> [-Credential <PSCredential>]
7763
```
7864

7965
## DESCRIPTION
80-
!!! Exchange Server 2010
81-
82-
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 both types of client connections, TCP/IP and Outlook Anywhere. If the cmdlet fails, the output notes the step that failed.
83-
84-
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 Client Access Permissions topic.
85-
86-
!!! Exchange Server 2013
87-
88-
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.
89-
90-
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 (https://go.microsoft.com/fwlink/p/?LinkId=510841) cmdlet to see what probes are active.
91-
92-
This example lists the probes running on a mailbox server: Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook.protocol | ?{$\_.Name -like '\*probe'}.
93-
94-
This example lists the probes running on a client access server: Get-MonitoringItemIdentity -Server MailboxServer1 -Identity outlook | ?{$\_.Name -like '\*probe'}.
95-
96-
For more information on probes and the monitoring framework, see Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510838), Managed Availability and Server Health (https://go.microsoft.com/fwlink/p/?LinkId=510839), and Customizing Managed Availability (https://go.microsoft.com/fwlink/p/?LinkId=510840)
97-
98-
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.
99-
100-
- MailboxId and Credential are not specified: Generic connectivity test against a test mailbox using the system's test credentials.
101-
102-
- MailboxId is specified, Credential is not: Connectivity test to the specific mailbox using the system's test credentials.
103-
104-
- 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
105-
106-
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.
107-
108-
!!! Exchange Server 2016
109-
11066
Running the Test-OutlookConnectivity cmdlet validates an Outlook connection defined by the provided parameters. The command is able to validate a single mailbox.
11167

11268
The 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 need to select one of the Outlook probe identities to run the test. Use the Get-MonitoringItemIdentity (https://go.microsoft.com/fwlink/p/?LinkId=510841) cmdlet to see what probes are active.
@@ -129,77 +85,50 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
12985

13086
## EXAMPLES
13187

132-
### Example 1 -------------------------- (Exchange Server 2010)
88+
### Example 1
13389
```
13490
Test-OutlookConnectivity -Protocol:HTTP -GetDefaultsFromAutoDiscover:$true
13591
```
13692

137-
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.
93+
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.
13894

139-
### Example 1 -------------------------- (Exchange Server 2013)
95+
### Example 2
14096
```
14197
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcSelfTestProbe"
14298
```
14399

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

146-
### Example 1 -------------------------- (Exchange Server 2016)
147-
```
148-
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcSelfTestProbe"
149-
```
150-
151-
This example runs an OutlookRpcSelfTestProbe on the mailbox server that you're currently connected to.
152-
153-
### Example 2 -------------------------- (Exchange Server 2010)
102+
### Example 3
154103
```
155104
Test-OutlookConnectivity -RpcProxyTestType:Internal -RpcTestType:Server
156105
```
157106

158-
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.
159-
160-
### Example 2 -------------------------- (Exchange Server 2013)
161-
```
162-
Test-OutlookConnectivity "OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId [email protected]
163-
```
164-
165-
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.
107+
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.
166108

167-
### Example 2 -------------------------- (Exchange Server 2016)
109+
### Example 4
168110
```
169111
Test-OutlookConnectivity "OutlookRpcDeepTestProbe\Mailbox Database 1234512345" -RunFromServerId PrimaryMailbox -MailboxId [email protected]
170112
```
171113

172114
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.
173115

174-
### Example 3 -------------------------- (Exchange Server 2010)
116+
### Example 5
175117
```
176118
Test-OutlookConnectivity -RpcProxyServer:RpcProxySrv01 -RpcProxyAuthenticationType:Basic -RpcClientAccessServer:CAS01 -RpcAuthenticationType:NTLM
177119
```
178120

179-
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.
121+
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.
180122

181-
### Example 3 -------------------------- (Exchange Server 2013)
123+
### Example 6
182124
```
183-
$TestCredentials = Get-Credential; Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId [email protected] -Credential $TestCredentials
125+
$TestCredentials = Get-Credential;
126+
Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId [email protected] -Credential $TestCredentials
184127
```
185128

186129
This example runs the OutlookRpcCtpProbe and verifies the log-on credentials for the "[email protected]" mailbox.
187130

188-
### Example 3 -------------------------- (Exchange Server 2016)
189-
```
190-
$TestCredentials = Get-Credential; Test-OutlookConnectivity -ProbeIdentity OutlookRpcCtpProbe -MailboxId [email protected] -Credential $TestCredentials
191-
```
192-
193-
This example runs the OutlookRpcCtpProbe and verifies the log-on credentials for the "[email protected]" mailbox.
194-
195-
### Example 4 -------------------------- (Exchange Server 2013)
196-
```
197-
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcCTPProbe" -MailboxID [email protected]
198-
```
199-
200-
This example runs a logon test from a Client Access server for the mailbox [email protected].
201-
202-
### Example 4 -------------------------- (Exchange Server 2016)
131+
### Example 7
203132
```
204133
Test-OutlookConnectivity -ProbeIdentity "OutlookRpcCTPProbe" -MailboxID [email protected]
205134
```
@@ -521,18 +450,9 @@ Accept wildcard characters: False
521450
```
522451
523452
### -Credential
524-
!!! Exchange Server 2013
525-
526-
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 (https://go.microsoft.com/fwlink/p/?linkId=142122).
527-
528-
529-
530-
!!! Exchange Server 2016
531-
532453
The Credential parameter specifies the credential used by the probe. The system's test credentials are used by default. This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122).
533454
534455
535-
536456
```yaml
537457
Type: PSCredential
538458
Parameter Sets: (All)
@@ -547,18 +467,8 @@ Accept wildcard characters: False
547467
```
548468
549469
### -Hostname
550-
!!! Exchange Server 2013
551-
552-
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.
553-
554-
555-
556-
!!! Exchange Server 2016
557-
558470
TheHostname parameter specifies the protocol endpoint target of the probe. You can use a specific Mailbox server or route through Distributed Name Service server.
559471
560-
561-
562472
```yaml
563473
Type: String
564474
Parameter Sets: (All)
@@ -638,4 +548,3 @@ To see the return types, which are also known as output types, that this cmdlet
638548
## RELATED LINKS
639549
640550
[Online Version](https://technet.microsoft.com/library/09d810f1-0550-4cd3-8feb-f524018a5d6b.aspx)
641-

0 commit comments

Comments
 (0)