Get-ActiveSyncDeviceStatistics

Get-ActiveSyncDeviceStatistics

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 Topic Last Modified: 2007-06-28

The Get-ActiveSyncDeviceStatistics cmdlet lets you retrieve the list of devices that are configured to synchronize with a specified user's mailbox and return a list of statistics about the devices.

Syntax


Get-ActiveSyncDeviceStatistics -Identity <MobileDeviceIdParameter> [-DomainController <Fqdn>] [-GetMailboxLog <$true | $false>] [-NotificationEmailAddresses <MultiValuedProperty>] [-OutputPath <String>] [-ShowRecoveryPassword <$true | $false>]


Get-ActiveSyncDeviceStatistics -Mailbox <MailboxIdParameter> [-DomainController <Fqdn>] [-GetMailboxLog <$true | $false>] [-NotificationEmailAddresses <MultiValuedProperty>] [-OutputPath <String>] [-ShowRecoveryPassword <$true | $false>]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Management.Tasks.MobileDeviceIdParameter	If the Mailbox parameter is specified, the Identity parameter is disabled.
Mailbox	Required	Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter	This parameter specifies the user mailbox for which you want to retrieve the mobile device statistics.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	This parameter specifies the domain controller to connect to for Active Directory validation.
GetMailboxLog	Optional	System.Boolean	If set to `$true`, the cmdlet sends the mailbox logs via e-mail to the administrator running the task. The default value of this parameter is `$false`.
NotificationEmailAddresses	Optional	Microsoft.Exchange.Data.MultiValuedProperty	This parameter specifies an optional list of comma separated aliases or e-mail addresses where the mailbox logs will be sent. If the -GetMailboxLog parameter is `$false`, this parameter is ignored.
OutputPath	Optional	System.String	This parameter specifies an optional filesystem path where mailbox logs will be created. If the -GetMailboxLog parameter is `$false`, this parameter is ignored.
ShowRecoveryPassword	Optional	System.Boolean	If set to `$true`, the cmdlet returns the recovery password for the device as one of the displayed statistics.

Detailed Description

The Get-ActiveSyncDeviceStatistics cmdlet lets you retrieve the list of devices that are synchronizing with a specified user's mailbox. The Get-ActiveSyncDeviceStatistics cmdlet returns a list of statistics about each device. Additionally, it allows you to retrieve device logs and e-mail those logs to a recipient.

To run the Get-ActiveSyncDeviceStatistics cmdlet, the account you use must be delegated the following:

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.

Input Types

Return Types

Parameter	Description
FirstSyncTime	The date on which the mobile device first synchronized with the user's mailbox.
LastPingHeartbeat	The length of the last heartbeat interval.
LastPolicyUpdateTime	The time at which the mobile device was last successfully updated.
LastPolicyUpdateRequestTime	The last time the mobile device requested a policy update from the server.
LastSyncAttemptTime	The last time the mobile device tried to synchronize with the user's mailbox.
LastSuccessSync	The last time the mobile device successfully synchronized with the user's mailbox.
LastSyncResponseStatus	The last status code sent to the mobile device during the most recent synchronization.
DeviceFriendlyName	The display name of the partnership that is configured on the mobile device. After the display name is configured, the device stores this name in the user's mailbox.
DeviceId	The string ID of the device that is stored in the user's mailbox.
DeviceModel	The model of the device. This information is stored in the user's mailbox.
DeviceOperatorNetwork	The mobile operator that is being used by the device. The device stores this information in the user's mailbox.
DeviceOSAgent	The client operating system that is running on the device. The device stores this information in the user's mailbox.
DeviceOSLanguage	The language of the operating system on the device.
LastPingHeartbeat	The length of time that has elapsed since the last response from the device, also known as a heartbeat, was received.
DeviceWipeSentTime	The time at which the last device wipe command was sent from the server.
DeviceWipeRequestTime	The time at which the RemoteWipe setting was enabled on the mobile device.
DeviceWipeAckTime	The time at which the server received the last wipe acknowledgement that was sent by the client.
RecoveryPassword	The recovery password for the device.

Errors

Error	Description

Exceptions

Exceptions	Description

Example

The following code example retrieves the statistics for the mobile device configured to synchronize with the mailbox that belongs to a user named Wilson Pais.

Get-ActiveSyncDeviceStatistics -Mailbox WilsonPais