Skip to content

Commit dfb7d65

Browse files
committed
Cleanup
1 parent 51dc99b commit dfb7d65

File tree

1 file changed

+3
-198
lines changed

1 file changed

+3
-198
lines changed

exchange/exchange-ps/exchange/Test-WebServicesConnectivity.md

Lines changed: 3 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,6 @@ schema: 2.0.0
66
# Test-WebServicesConnectivity
77

88
## SYNOPSIS
9-
!!! Exchange Server 2010
10-
11-
Use the Test-WebServicesConnectivity cmdlet to perform basic operations to verify the functionality of Exchange Web Services on a server running Microsoft Exchange Server 2010 that has the Client Access server role installed.
12-
13-
!!! Exchange Server 2013
14-
15-
This cmdlet is available only in on-premises Exchange.
16-
17-
Use the Test-WebServicesConnectivity cmdlet to perform basic operations to verify the functionality of Exchange Web Services on a server running Microsoft Exchange Server 2013.
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-WebServicesConnectivity cmdlet to test client connectivity to Exchange Web Services virtual directories.
@@ -57,34 +43,6 @@ Test-WebServicesConnectivity [[-Identity] <MailboxIdParameter>]
5743
```
5844

5945
## DESCRIPTION
60-
!!! Exchange Server 2010
61-
62-
The Test-WebServicesConnectivity cmdlet tests the functionality of Exchange Web Services. The Test-WebServicesConnectivity cmdlet performs basic operations to verify the functionality of Outlook Anywhere. The operations tested by default are GetFolder, CreateItem, DeleteItem, and SyncFolderItems. The results of each test are returned by the Exchange Management Shell.
63-
64-
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 Exchange Web Services" entry in the Client Access Permissions topic.
65-
66-
!!! Exchange Server 2013
67-
68-
To use most of the features of this cmdlet, you need to create a test user by running the following command: & $env:ExchangeInstallPath\\Scripts\\New-TestCasConnectivityUser.ps1
69-
70-
The Test-WebServicesConnectivity results are displayed on-screen. The cmdlet returns the following information.
71-
72-
- Source Source server.
73-
74-
- ServiceEndpoint Destination server.
75-
76-
- Scenario The operations that are tested. Values are Autodiscover: SOAP Provider and EWS: GetFolder or EWS: ConvertID.
77-
78-
- Result The values returned are typically Success or \*FAILURE\*.
79-
80-
- Latency (MS) The time required to complete the test in milliseconds
81-
82-
You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding "\> \<filename\>" to the command. For example: Test-WebServicesConnectivity -ClientAccessServer CAS01 | ConvertTo-Html \> "C:\\My Documents\\EWS Test.html"
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 Exchange Web Services" entry in the Clients and mobile devices permissions topic.
85-
86-
!!! Exchange Server 2016
87-
8846
The Test-WebServicesConnectivity cmdlet tests Exchange Web Services connectivity by connecting to a specified Exchange Web Services virtual directory, to any Exchange Web Services virtual directories on a specified Exchange server, or to any Exchange Web Services virtual directories that are available in the local Active Directory site.
8947

9048
The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command.
@@ -107,25 +65,17 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
10765

10866
## EXAMPLES
10967

110-
### Example 1 -------------------------- (Exchange Server 2010)
68+
### Example 1
11169
```
11270
Test-WebServicesConnectivity -AllowUnsecureAccess
11371
```
11472

115-
This example tests Exchange Web Services on the local Client Access server and allows the test to use an unsecured connection that doesn't require SSL. A default test account is used.
116-
117-
### Example 1 -------------------------- (Exchange Server 2013)
118-
```
119-
Test-WebServicesConnectivity -ClientAccessServer CAS01
120-
```
121-
122-
This example tests the connection to Exchange Web Services on the Client Access server named CAS01. The test account that was created by running the New-TestCasConnectivityUser.ps1 script is used.
73+
In Exchange 2010, this example tests Exchange Web Services on the local Client Access server and allows the test to use an unsecured connection that doesn't require SSL. A default test account is used.
12374

124-
### Example 1 -------------------------- (Exchange Server 2016)
75+
### Example 2
12576
```
12677
Test-WebServicesConnectivity -ClientAccessServer MBX01
12778
```
128-
12979
This example tests the client connection to Exchange Web Services on the server named MBX01.
13080

13181
## PARAMETERS
@@ -147,30 +97,6 @@ Accept wildcard characters: False
14797
```
14898
14999
### -ClientAccessServer
150-
!!! Exchange Server 2010
151-
152-
The ClientAccessServer parameter specifies the Client Access server to use when the command is run.
153-
154-
155-
156-
!!! Exchange Server 2013
157-
158-
The ClientAccessServer parameter specifies the Client Access server to use when the command is run.
159-
160-
You can use any value that uniquely identifies the server. For example:
161-
162-
- Name (for example, Exchange01)
163-
164-
- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com)
165-
166-
- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01)
167-
168-
- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942)
169-
170-
171-
172-
!!! Exchange Server 2016
173-
174100
The ClientAccessServer parameter specifies the Exchange server to test. This server has the Client Access server role installed, and is responsible for accepting client connections.
175101
176102
You can use any value that uniquely identifies the server. For example:
@@ -185,8 +111,6 @@ You can use any value that uniquely identifies the server. For example:
185111
186112
You can't use this parameter with the AutoDiscoverServer parameter.
187113
188-
189-
190114
```yaml
191115
Type: ServerIdParameter
192116
Parameter Sets: (All)
@@ -250,26 +174,10 @@ Accept wildcard characters: False
250174
```
251175
252176
### -LightMode
253-
!!! Exchange Server 2010
254-
255-
The LightMode parameter instructs the command to perform only a subset of the connectivity tests. When you use this parameter, only the GetFolder operation is tested.
256-
257-
258-
259-
!!! Exchange Server 2013
260-
261-
The LightMode switch instructs the command to perform only a subset of the connectivity tests. When you use this parameter, the EWS: ConvertId operation is tested instead of the EWS: GetFolder operation.
262-
263-
264-
265-
!!! Exchange Server 2016
266-
267177
The LightMode switch tells the command to perform only a subset of the tests. You don't need to specify a value with this switch.
268178
269179
When you use this switch, the EWS: ConvertId test is run instead of the EWS: GetFolder test.
270180
271-
272-
273181
```yaml
274182
Type: SwitchParameter
275183
Parameter Sets: (All)
@@ -284,30 +192,12 @@ Accept wildcard characters: False
284192
```
285193
286194
### -MailboxCredential
287-
!!! Exchange Server 2010
288-
289-
The MailboxCredential parameter specifies the mailbox to use when the command is run.
290-
291-
292-
293-
!!! Exchange Server 2013
294-
295-
The MailboxCredential parameter specifies the mailbox credentials to use when the command is run. This parameter is required when you use the Identity parameter.
296-
297-
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).
298-
299-
300-
301-
!!! Exchange Server 2016
302-
303195
The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test.
304196
305197
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).
306198
307199
This parameter is required when you use the Identity parameter.
308200
309-
310-
311201
```yaml
312202
Type: PSCredential
313203
Parameter Sets: (All)
@@ -338,24 +228,8 @@ Accept wildcard characters: False
338228
```
339229
340230
### -MonitoringContext
341-
!!! Exchange Server 2010
342-
343-
The MonitoringContext parameter specifies whether the test result is passed to Microsoft System Center Operations Manager 2007. If this parameter is set to $true, the test result is passed to Operations Manager 2007. If this parameter is set to $false, the test result appears only on the command line.
344-
345-
346-
347-
!!! Exchange Server 2013
348-
349-
The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager 2007 or System Center 2012 - Operations Manager.
350-
351-
352-
353-
!!! Exchange Server 2016
354-
355231
The MonitoringContext switch includes the associated monitoring events and performance counters in the results. Typically, you include the monitoring events and performance counters in the results when the output is passed to MicrosoftSystem Center Operations Manager (SCOM). You don't need to specify a value with this switch.
356232
357-
358-
359233
```yaml
360234
Type: SwitchParameter
361235
Parameter Sets: (All)
@@ -415,26 +289,10 @@ Accept wildcard characters: False
415289
```
416290
417291
### -TrustAnySSLCertificate
418-
!!! Exchange Server 2010
419-
420-
The TrustAnySSLCertificate parameter allows the test to use any SSL certificate available.
421-
422-
423-
424-
!!! Exchange Server 2013
425-
426-
The TrustAnySSLCertificate switch allows the test to use any SSL certificate that's available.
427-
428-
429-
430-
!!! Exchange Server 2016
431-
432292
The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch.
433293
434294
This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL.
435295
436-
437-
438296
```yaml
439297
Type: SwitchParameter
440298
Parameter Sets: (All)
@@ -481,24 +339,6 @@ Accept wildcard characters: False
481339
```
482340
483341
### -AutoDiscoverServer
484-
!!! Exchange Server 2013
485-
486-
The AutoDiscoverServer parameter specifies the Client Access server to use to test Autodiscover connectivity.
487-
488-
You can use any value that uniquely identifies the server. For example:
489-
490-
- Name (for example, Exchange01)
491-
492-
- Distinguished name (DN) (for example, CN=Exchange01,CN=Servers,CN=Exchange Administrative Group (FYDIBOHF23SPDLT),CN=Administrative Groups,CN=First Organization,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=contoso,DC=com)
493-
494-
- Exchange Legacy DN (for example, /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01)
495-
496-
- GUID (for example, bc014a0d-1509-4ecc-b569-f077eec54942)
497-
498-
499-
500-
!!! Exchange Server 2016
501-
502342
The AutoDiscoverServer parameter specifies the server with the Client Access server role installed that's used for Autodiscover.
503343
504344
You can use any value that uniquely identifies the server. For example:
@@ -513,8 +353,6 @@ You can use any value that uniquely identifies the server. For example:
513353
514354
You can't use this parameter with the ClientAccessServer parameter.
515355
516-
517-
518356
```yaml
519357
Type: ClientAccessServerIdParameter
520358
Parameter Sets: Set3
@@ -529,36 +367,6 @@ Accept wildcard characters: False
529367
```
530368
531369
### -Identity
532-
!!! Exchange Server 2013
533-
534-
The Identity parameter specifies the mailbox to use for the test. When you use this parameter, you also need to use the MailboxCredential parameter.
535-
536-
This parameter accepts the following values:
537-
538-
- Alias (for example, JPhillips)
539-
540-
- Canonical DN (for example, Atlanta.Corp.Contoso.Com/Users/JPhillips)
541-
542-
- Display Name (for example, Jeff Phillips)
543-
544-
- Distinguished Name (DN) (for example, CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com)
545-
546-
- Domain\\Account (for example, Atlanta\\JPhillips)
547-
548-
- GUID (for example, fb456636-fe7d-4d58-9d15-5af57d0354c2)
549-
550-
- Immutable ID (for example, [email protected])
551-
552-
- Legacy Exchange DN (for example, /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips)
553-
554-
- SMTP Address (for example, [email protected])
555-
556-
- User Principal Name (for example, [email protected])
557-
558-
559-
560-
!!! Exchange Server 2016
561-
562370
The Identity parameter specifies the mailbox to use for the test. You can use any value that uniquely identifies the mailbox.
563371
564372
For example:
@@ -587,8 +395,6 @@ For example:
587395
588396
When you use this parameter, you also need to use the MailboxCredential parameter.
589397
590-
591-
592398
```yaml
593399
Type: MailboxIdParameter
594400
Parameter Sets: Set3, Set2, Set1
@@ -620,4 +426,3 @@ To see the return types, which are also known as output types, that this cmdlet
620426
## RELATED LINKS
621427
622428
[Online Version](https://technet.microsoft.com/library/5e1b2b06-f24e-4f33-8ddc-fdb1c5bb7eb2.aspx)
623-

0 commit comments

Comments
 (0)