New-WipeRequest
2/9/2009
The New-WipeRequest cmdlet creates a new wipe request that deletes all content on the specified managed Windows Mobile device.
The wipe request is sent to the managed device as soon as possible. If the managed device is unreachable, the wipe request remains active until the managed device retrieves it or the wipe request fails or expires. When the device retrieves the wipe request, it formats the external storage card and restores the factory default settings on the device. After the wipe, the device can no longer connect to the network through Mobile Device Manager Gateway Server, it is no longer enrolled in MDM, and MDM no longer manages the device.
There can only be one outstanding wipe request per device.
Syntax
New-WipeRequest [-DeviceId] <DeviceIdParameter> [-confirm] [-whatif] [<CommonParameters>]
New-WipeRequest -Owner <OwnerIdParameter> [-confirm] [-whatif] [<CommonParameters>]
Parameters
The following describes the New-WipeRequest cmdlet parameters.
- DeviceId <DeviceIdParameter>
Specifies the identity of the managed device to be wiped. This parameter can be a device common name, the distinguished name, the fully qualified domain name (FQDN), or the security ID (SID). If the value contains a space or other special characters, enclose the string in quotation marks.
- Owner <OwnerIdParameter>
Identifies the managed device to be wiped based on the device owner. If multiple managed devices are found for this owner, an error message is displayed. This parameter can be a common name, e-mail address, distinguished name, SID, or Logon ID. If the value contains a space or other special characters, enclose the string in quotation marks.
- WhatIf
Informs you of what changes would be made if the action were to be performed (the cmdlet is not executed).
- Confirm
Prompts you for confirmation before the cmdlet executes.
- CommonParameters
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, at the MDM Shell prompt, type get-help about_commonparameters.
Input Type
The New-WipeRequest cmdlet accepts a string through the pipeline that identifies a managed device or an object that has the property, deviceId.
Output Type
The New-WipeRequest cmdlet returns a WipeRequest object. To see all the properties for this object, at the MDM Shell prompt, type Get-WipeRequest | Get-Member.
Examples
This New-WipeRequest command example creates a wipe request for the managed device that has the deviceId, device1.
C:\PS>New-WipeRequest -DeviceId device1
This New-WipeRequest command example creates a wipe request for the managed device owned by Mikael Sandberg. If this owner has multiple devices, an error is returned and no devices are wiped.
C:\PS>New-WipeRequest -Owner "Mikael Sandberg"
Cmdlet Help
To view this information online, at the MDM Shell prompt, type:
get-help New-WipeRequest -detailed, or get-help New-WipeRequest -full