Get-WipeRequest
2/9/2009
The Get-WipeRequest cmdlet returns a WipeRequest object that represents the wipe requests for the specified managed Windows Mobile device.
If you specify a device, the wipe request for that managed device, if the request exists, is returned. If you specify an owner, any existing wipe requests for all managed devices associated with that owner are returned. If you do not specify any parameters, all existing wipe requests are returned.
The Status property of a WipeRequest object has one of the following values: Pending, Failed, Expired, Retrying, and Succeeded.
Syntax
Get-WipeRequest [[-DeviceId] <DeviceIdParameter[]>] [<CommonParameters>]
Get-WipeRequest [-Owner <OwnerIdParameter[]>] [<CommonParameters>]
Parameters
The following describes the Get-WipeRequest cmdlet parameters.
- DeviceId <DeviceIdParameter[]>
Identifies the wipe request by managed device. 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 all managed devices for the specified owner and returns any unprocessed wipe requests for those managed devices. 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.
- 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
None
Output Type
The Get-WipeRequest cmdlet returns a collection of WipeRequest objects. To see all the properties for this object, at the MDM Shell prompt, type Get-WipeRequest | Get-Member.
Examples
This Get-WipeRequest command example returns all outstanding wipe requests.
C:\PS>Get-WipeRequest
This Get-WipeRequest command example returns the pending wipe requests for all the managed devices associated with the owner, Mikael Sandberg.
C:\PS>Get-WipeRequest -Owner "Mikael Sandberg"
This Get-WipeRequest command example returns all the failed wipe requests. It uses the Get-WipeRequest cmdlet to return all wipe requests. The pipeline operator (|) passes the process objects to the Where-Object cmdlet. This selects only the objects that have Failed as the status property.
C:\PS>Get-WipeRequest | Where-Object {$_.Status -eq "Failed"}
Cmdlet Help
To view this information online, at the MDM Shell prompt, type:
get-help Get-WipeRequest -detailed, or get-help Get-WipeRequest -full