Test-ActiveSyncConnectivity
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Test-ActiveSyncConnectivity cmdlet lets you 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>] [-Site <AdSiteIdParameter>] [-Timeout <UInt32>] [-TrustAnySSLCertificate <SwitchParameter>] [-UseAutodiscoverForClientAccessServer <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
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.
To run the Test-ActiveSyncConnectivity cmdlet, the account you use must be delegated the Exchange Server 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 Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
AllowUnsecureAccess |
Optional |
System.Management.Automation.SwitchParameter |
This parameter allows the test to continue 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 computer the device uses to synchronize. |
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 |
This parameter specifies the domain controller to connect to for Active Directory directory service validation. |
LightMode |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the cmdlet to perform only a subset of the connectivity tests. The tests that are performed are the Options and FolderSync commands. |
MailboxCredential |
Optional |
System.Management.Automation.PSCredential |
This parameter specifies the mailbox the device synchronizes with. |
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the Mailbox server computer that contains the associated mailbox. |
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 |
MonitoringInstance |
Optional |
System.String |
This parameter specifies whether the task is to be run against the mailbox of the user currently running the task. It is only used when this task is run from MOM. |
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 |
This parameter specifies the amount of time (in seconds) to wait for a response from the cmdlet. |
TrustAnySSLCertificate |
Optional |
System.Management.Automation.SwitchParameter |
This parameter allows the test to use any available SSL certificate to run the test. |
URL |
Optional |
System.String |
This parameter specifies the external URL for Exchange ActiveSync. |
UseAutodiscoverForClientAccessServer |
Optional |
System.Management.Automation.SwitchParameter |
This parameter specifies whether the test should use the Autodiscover service to locate the Client Access server computer. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using this 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 this parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code example tests the Exchange ActiveSync connectivity for the mailbox PaulA.
Test-ActiveSyncConnectivity -MailboxCredential "PaulA"