Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-11
Use the Clear-ActiveSyncDevice cmdlet to delete all data from a mobile phone.
For information about the parameter sets in the Syntax section below, see Syntax.
 Warning: |
|---|
| The Clear-ActiveSyncDevice cmdlet will be removed in a future version of Exchange. Use the Clear-MobileDevice cmdlet instead. If you have any scripts that use the Clear-ActiveSyncDevice cmdlet, update them to use the Clear-MobileDevice cmdlet. |
Syntax
Clear-ActiveSyncDevice -Identity
<MobileDeviceIdParameter> [-Cancel <SwitchParameter>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-NotificationEmailAddresses
<MultiValuedProperty>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example clears all data from the mobile device with the identity WM_JeffHay.
 Copy Code |
|
|---|---|
Clear-ActiveSyncDevice -Identity WM_JeffHay |
|
EXAMPLE 2
This example clears all data from the mobile device for Tony Smith and sends a confirmation email message to tony@contoso.com.
| Copy Code |
|
|---|---|
Clear-ActiveSyncDevice -Identity WM_TonySmith -NotificationEmailAddresses "tony@contoso.com" |
|
EXAMPLE 3
This example cancels a previously sent Clear-ActiveSyncDevice command request for Tony Smith's mobile device.
| Copy Code |
|
|---|---|
Clear-ActiveSyncDevice -Identity WM_TonySmith -Cancel $true |
|
Detailed Description
The Clear-ActiveSyncDevice cmdlet deletes all
user data from a mobile device the next time the device receives
data from the server running Microsoft Exchange Server 2013. This
cmdlet sets the DeviceWipeStatus parameter to
$true. The mobile device acknowledges the cmdlet and
records the time stamp in the DeviceWipeAckTime
parameter.
After you run this cmdlet, you 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 phone.
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 user settings" entry in the Clients and Mobile Devices Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MobileDeviceIdParameter |
The Identity parameter specifies the identity of the device that you want to reset. |
|
Cancel |
Optional |
System.Management.Automation.SwitchParameter |
The Cancel switch specifies whether the command should be canceled. If you use the Cancel switch, a cancellation request is issued for the remote device wipe. |
|
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 writes this configuration change to Active Directory. |
|
NotificationEmailAddresses |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The NotificationEmailAddresses parameter specifies the notification email address for the remote device wipe confirmation. |
|
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.