Applies to: Exchange Server 2013

Topic Last Modified: 2012-09-17

Use the Test-ActiveSyncConnectivity cmdlet to perform a full synchronization against a specified mailbox to test the configuration of Microsoft Exchange ActiveSync.

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

Syntax

Test-ActiveSyncConnectivity [-AllowUnsecureAccess <SwitchParameter>] [-ClientAccessServer <ServerIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-LightMode <SwitchParameter>] [-MailboxCredential <PSCredential>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext <SwitchParameter>] [-MonitoringInstance <String>] [-ResetTestAccountCredentials <SwitchParameter>] [-Timeout <UInt32>] [-TrustAnySSLCertificate <SwitchParameter>] [-URL <String>] [-UseAutodiscoverForClientAccessServer <SwitchParameter>] [-UserType <LEGACY | EDU | BPOS>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example tests the Exchange ActiveSync connectivity for the mailbox PaulS on the Client Access server computer CAS01.

Copy Code
Test-ActiveSyncConnectivity -ClientAccessServer contoso\CAS01 -URL "http://contoso.com/mail" -MailboxCredential "PaulS"

EXAMPLE 2

This example tests the Exchange ActiveSync connectivity for the mailbox PaulS using the Autodiscover URL.

Copy Code
Test-ActiveSyncConnectivity -UseAutodiscoverForClientAccessServer $true -URL "http://contoso.com/mail" -MailboxCredential "pauls@contoso.com"

EXAMPLE 3

This example tests the Exchange ActiveSync connectivity for the mailbox PaulS.

Copy Code
Test-ActiveSyncConnectivity -AllowUnsecureAccess $true -URL "http://contoso.com/mail" -MailboxCredential "contoso\pauls"

Detailed Description

The Test-ActiveSyncConnectivity cmdlet performs a full synchronization between a mobile device and a specified mailbox to test the functionality of Exchange ActiveSync. If the synchronization fails, a message is displayed in 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 "Exchange ActiveSync server settings" entry in the Clients and Mobile Devices Permissions topic.

Parameters

Parameter Required Type Description

AllowUnsecureAccess

Optional

System.Management.Automation.SwitchParameter

The AllowUnsecureAccess parameter allows the test to continue 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 computer that the device uses to synchronize.

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. The tests performed are the Options and FolderSync commands.

MailboxCredential

Optional

System.Management.Automation.PSCredential

The MailboxCredential parameter specifies the mailbox that the device synchronizes with.

MailboxServer

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The MailboxServer parameter specifies the Mailbox server computer that contains the associated mailbox.

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.

MonitoringInstance

Optional

System.String

The MonitoringInstance parameter specifies whether the task is to be run against the mailbox of the user currently running the task. It's only used when this task is run from System Center Operations Manager 2007 or Operations Manager.

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 a response from the command.

TrustAnySSLCertificate

Optional

System.Management.Automation.SwitchParameter

The TrustAnySSLCertificate parameter specifies whether the test uses any available SSL certificate to run the test.

URL

Optional

System.String

The URL parameter specifies the external URL for Exchange ActiveSync.

UseAutodiscoverForClientAccessServer

Optional

System.Management.Automation.SwitchParameter

The UseAutodiscoverForClientAccessServer parameter specifies whether the test should use the Autodiscover service to locate the Client Access server.

UserType

Optional

Microsoft.Exchange.Monitoring.DatacenterUserType

The UserType parameter specifies whether the user is an on-premise or online user.

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.