Export (0) Print
Expand All
Expand Minimize

Test-WebServicesConnectivity

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-05-19

This cmdlet is available only in on-premises Exchange Server 2013.

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.

For information about the parameter sets in the Syntax section below, see Syntax.

Test-WebServicesConnectivity -MonitoringContext <SwitchParameter> <COMMON PARAMETERS>
Test-WebServicesConnectivity [-ClientAccessServer <ClientAccessServerIdParameter>] <COMMON PARAMETERS>
Test-WebServicesConnectivity -AutoDiscoverServer <ClientAccessServerIdParameter> <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Identity <MailboxIdParameter>] [-LightMode <SwitchParameter>] [-MailboxCredential <PSCredential>] [-TrustAnySSLCertificate <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

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.

Test-WebServicesConnectivity -ClientAccessServer CAS01

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

The Test-WebServicesConnectivity results are displayed on-screen. The cmdlet returns the following information.

  • Source   Source server.

  • ServiceEndpoint   Destination server.

  • Scenario   The operations that are tested. Values are Autodiscover: SOAP Provider and EWS: GetFolder or EWS: ConvertID.

  • Result   The values returned are typically Success or *FAILURE*.

  • Latency (MS)   The time required to complete the test in milliseconds

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"

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.

 

Parameter Required Type Description

AutoDiscoverServer

Required

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter

The AutoDiscoverServer parameter specifies the Client Access server to use to test Autodiscover connectivity.

You can use any value that uniquely identifies the server. For example:

  • Name

    Example: Exchange01

  • Distinguished name (DN)

    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

  • Exchange Legacy DN

    Example: /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01

  • GUID

    Example: bc014a0d-1509-4ecc-b569-f077eec54942

MonitoringContext

Required

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.

ClientAccessServer

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerIdParameter

The ClientAccessServer parameter specifies the Client Access server to use when the command is run.

You can use any value that uniquely identifies the server. For example:

  • Name

    Example: Exchange01

  • Distinguished name (DN)

    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

  • Exchange Legacy DN

    Example: /o=First Organization/ou=Exchange Administrative Group (FYDIBOHF23SPDLT)/cn=Configuration/cn=Servers/cn=Exchange01

  • GUID

    Example: bc014a0d-1509-4ecc-b569-f077eec54942

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.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox to use for the test. When you use this parameter, you also need to use the MailboxCredential parameter.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

LightMode

Optional

System.Management.Automation.SwitchParameter

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.

MailboxCredential

Optional

System.Management.Automation.PSCredential

The MailboxCredential parameter specifies the mailbox credentials to use when the command is run. This parameter is required when you use the Identity parameter.

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.

TrustAnySSLCertificate

Optional

System.Management.Automation.SwitchParameter

The TrustAnySSLCertificate switch allows the test to use any SSL certificate that's available.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft