Test-WebServicesConnectivity
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Test-WebServicesConnectivity cmdlet performs basic operations to verify the functionality of Exchange Web Services on a Microsoft Exchange Server 2007 computer 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>] [-Site <AdSiteIdParameter>] [-Timeout <UInt32>] [-TrustAnySSLCertificate <SwitchParameter>] [-UseAutodiscoverForClientAccessServer <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Test-WebServicesConnectivity cmdlet lets you test the functionality of Exchange Web Services. If the test fails, a message is displayed in the Exchange Management Shell.
To run the Test-WebServicesConnectivity cmdlet, the account you use must be delegated the Exchange Administrator role and local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
AllowUnsecureAccess |
Optional |
System.Management.Automation.SwitchParameter |
This parameter enables the Test-WebServicesConnectivity cmdlet to continue to run over an unsecured channel that does not require Secure Sockets Layer (SSL). |
ClientAccessServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the Client Access server to use when the Test-WebServicesConnectivity cmdlet is run. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to the Active Directory directory service. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
LightMode |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is not implemented for the Test-PopConnectivity diagnostic cmdlet. Using this parameter does not change the behavior of the cmdlet. Note This cmdlet is implemented for other Exchange 2007 diagnostic cmdlets. Specifically, it is used when you want to run a less intensive version of a cmdlet. |
MailboxCredential |
Optional |
System.Management.Automation.PSCredential |
This parameter specifies the mailbox to use when the Test-WebServicesConnectivity cmdlet is run. |
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the identity of the Exchange 2007 Mailbox server on which the test will be run. |
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
This parameter specifies whether the test result is passed to Microsoft Operations Manager (MOM). 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. |
Site |
Optional |
Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter |
The Site parameter is used to specify the Active Directory site. |
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 |
This parameter allows the test to use any SSL certificate that is available. |
UseAutodiscoverForClientAccessServer |
Optional |
System.Management.Automation.SwitchParameter |
This parameter specifies whether the test should use the Autodiscover service to locate the Client Access server. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code example tests the Exchange Web Services on the local Client Access server and allows the test to use an unsecured connection that does not require SSL. A default test account will be used.
Test-WebServicesConnectivity -AllowUnsecureAccess