Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-17
Use the Test-EcpConnectivity cmdlet to verify that the Exchange Administration Center is running as expected.
 Warning: |
|---|
| The Exchange Control Panel (ECP) is the web-based user interface developed for Microsoft Exchange Server 2010. The Exchange Server 2013 Exchange Administration Center cmdlets for virtual directory still use ECP in the name, and the ECP cmdlets can be used to manage Exchange 2010 and Exchange 2013 ECP virtual directories. |
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Test-EcpConnectivity [-ClientAccessServer
<ServerIdParameter>] [-RSTEndpoint <String>] [-TestType
<Internal | External>] [-VirtualDirectoryName <String>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-LightMode <SwitchParameter>] [-MailboxServer
<ServerIdParameter>] [-MonitoringContext
<SwitchParameter>] [-ResetTestAccountCredentials
<SwitchParameter>] [-Timeout <UInt32>]
[-TrustAnySSLCertificate <SwitchParameter>] [-UserType
<LEGACY | EDU | BPOS>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example tests user connectivity to the Exchange Administration Center on Server01.
 Copy Code |
|
|---|---|
Test-EcpConnectivity -ClientAccessServer Server01 |
|
Detailed Description
The Test-EcpConnectivity cmdlet can be used to test Exchange Administration Center connectivity for all ECP virtual directories on a specified Client Access server for all mailboxes on servers running Exchange in the same Active Directory site. The Test-EcpConnectivity cmdlet can also be used to test the connectivity for an individual Exchange Administration Center URL.
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 "Exchange Administration Center connectivity" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
ClientAccessServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The ClientAccessServer parameter specifies the name of the Client Access server to test. If this parameter is included, all Exchange ECP virtual directories on the Client Access server are tested against all Exchange Mailbox servers in the local Active Directory site. Mailboxes that aren't on Exchange Mailbox servers are tested. |
||
|
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 isn't implemented for this diagnostic command. Using this parameter doesn't change the behavior of the command.
|
||
|
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The MailboxServer parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site are tested. |
||
|
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
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. |
||
|
ResetTestAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The ResetTestAccountCredentials parameter resets the password for the test account used to run this command. The password for the test account is usually reset every 7 days. Use this parameter to force a password reset any time that a password reset is required for security reasons. |
||
|
RSTEndpoint |
Optional |
System.String |
This parameter is reserved for internal Microsoft use. |
||
|
TestType |
Optional |
Microsoft.Exchange.Monitoring.OwaConnectivityTestType |
The TestType parameter determines whether the command
tests internal or external URLs. Values are |
||
|
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 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 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 specifies whether Secure Sockets Layer (SSL) certificate validation failures are reported. If the TrustAnySSLCertificate parameter is used, SSL certificate validation failures aren't reported. This is useful for testing internal URLs because Internet Information Services (IIS) doesn't support assigning multiple certificates for a single virtual directory. If a directory has different URLs for internal and external access and has a certificate, that certificate is usually for the external URL. This parameter lets the task check an internal URL without generating an error when the certificate doesn't match the URL. |
||
|
UserType |
Optional |
Microsoft.Exchange.Monitoring.DatacenterUserType |
This parameter is reserved for internal Microsoft use. |
||
|
VirtualDirectoryName |
Optional |
System.String |
The VirtualDirectoryName parameter specifies the name of the virtual directory to test on a particular Client Access server. If this parameter isn't included, all Exchange Control Panel virtual directories that support Exchange mailboxes are tested. |
||
|
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. |
Note: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.