Test-ActiveSyncConnectivity: Exchange 2010 Help

Test-ActiveSyncConnectivity

[This topic's current status is: Content Complete.]

Applies to: Exchange Server 2010 Topic Last Modified: 2009-07-13

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

Syntax


test-ActiveSyncConnectivity [-ClientAccessServer <ServerIdParameter>] [-URL <String>] [-AllowUnsecureAccess <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-LightMode <SwitchParameter>] [-MailboxCredential <PSCredential>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext <SwitchParameter>] [-MonitoringInstance <String>] [-ResetTestAccountCredentials <SwitchParameter>] [-Timeout <UInt32>] [-TrustAnySSLCertificate <SwitchParameter>] [-UseAutodiscoverForClientAccessServer <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

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 parameter specifies whether the test result is passed to Microsoft System Center Operations Manager 2007. If this parameter is set to `$true`, the test result is passed to System Center Operations Manager 2007. If this parameter is set to `$false`, the test result appears only on the command line.
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.
ResetTestAccountCredentials	Optional	System.Management.Automation.SwitchParameter	The ResetTestAccountCredentials switch resets the password for the test account used to perform this command. The password for the test account is typically reset every seven days. 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 allows the test to use 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.
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.

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 Client Access Permissions topic.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Examples

EXAMPLE 1

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

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.

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.

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