Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-16
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.
Syntax
Test-WebServicesConnectivity [-ClientAccessServer
<ServerIdParameter>] [-AllowUnsecureAccess
<SwitchParameter>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-LightMode
<SwitchParameter>] [-MailboxCredential <PSCredential>]
[-MailboxServer <ServerIdParameter>] [-MonitoringContext
<SwitchParameter>] [-ResetTestAccountCredentials
<SwitchParameter>] [-Timeout <UInt32>]
[-TrustAnySSLCertificate <SwitchParameter>]
[-UseAutodiscoverForClientAccessServer <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]
|
Detailed Description
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.
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
AllowUnsecureAccess |
Optional |
System.Management.Automation.SwitchParameter |
The AllowUnsecureAccess switch specifies whether to enable the command to continue to run over an unsecured channel that doesn't require Secure Sockets Layer (SSL). |
|
ClientAccessServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The ClientAccessServer parameter specifies the Client Access server to use when the command is run. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
LightMode |
Optional |
System.Management.Automation.SwitchParameter |
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. |
|
MailboxCredential |
Optional |
System.Management.Automation.PSCredential |
The MailboxCredential parameter specifies the mailbox to use when the command is run. |
|
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The MailboxServer parameter specifies the identity of the Exchange Mailbox server on which the test is run. |
|
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
The MonitoringContext parameter specifies whether the
test result is passed to Microsoft System Center Operations Manager
2007. If this parameter is set to |
|
ResetTestAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The ResetTestAccountCredentials parameter resets the password for the test account used to perform this command. The password for the test account is typically reset every seven days if you're using Microsoft System Center Operations Manager to manage your Exchange environment. Use of this flag forces a password reset at any time if it's required for security reasons. |
|
Timeout |
Optional |
System.UInt32 |
The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 300 seconds. You must specify a time-out value greater than 0 seconds. We recommend that you always configure this parameter with a value of 5 seconds or more. |
|
TrustAnySSLCertificate |
Optional |
System.Management.Automation.SwitchParameter |
The TrustAnySSLCertificate parameter allows the test to use any SSL certificate available. |
|
UseAutodiscoverForClientAccessServer |
Optional |
System.Management.Automation.SwitchParameter |
The UseAutodiscoverForClientAccessServer parameter specifies whether the test should use the Autodiscover service to locate the Client Access server. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.
Examples
EXAMPLE 1
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.
 Copy Code |
|
|---|---|
Test-WebServicesConnectivity -AllowUnsecureAccess |
|