Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-10-22
The Clear-ActiveSyncDevice cmdlet enables you to delete all data from a mobile device.
Syntax
Clear-ActiveSyncDevice -Identity
<MobileDeviceIdParameter> [-Cancel <$true | $false>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-NotificationEmailAddresses
<MultiValuedProperty>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.Tasks.MobileDeviceIdParameter |
This parameter specifies the identity of the device that you want to reset. |
|
Cancel |
Optional |
System.Boolean |
This parameter specifies whether the Clear-ActiveSyncDevice cmdlet should be canceled. If you use the Cancel parameter with the Clear-ActiveSyncDevice cmdlet, a cancellation request will be issued for the remote device wipe. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter specifies whether confirmation is required for
the remote device wipe. If set to |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the domain controller to connect to for Active Directory validation. |
|
NotificationEmailAddresses |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the notification e-mail address for the remote device wipe confirmation. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the cmdlet to simulate the actions that
it would take on an object. By using the WhatIf parameter,
you can view the changes that would occur without having to apply
any of those changes. The default value is |
Detailed Description
The Clear-ActiveSyncDevice cmdlet enables you to
delete all data from a mobile device the next time that the device
receives data from the server that is running
Microsoft Exchange Server 2007. This cmdlet sets the
DeviceWipeStatus parameter to $true. The mobile
device will acknowledge the cmdlet and record the time stamp in the
DeviceWipeAckTime parameter.
After you run this cmdlet, you will receive a warning that states: "This command will force all the data on the device to be permanently deleted. Do you want to continue?" You must respond to the warning for the cmdlet to run on the mobile device.
To run the Clear-ActiveSyncDevice 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 Exchange 2007, see Permission Considerations.
Input Types
Return Types
| Parameter | Type | Description |
|---|---|---|
|
DeviceWipeSetTime |
System.DateTime |
This is the time stamp that indicates when the remote wipe task was set. |
Errors
| Error | Description |
|---|---|
|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
|
Example
The following code sample clears all data from the mobile device WM_JeffHay.
 Copy Code |
|
|---|---|
Clear-ActiveSyncDevice -Identity WM_JeffHay |
|