Set-WipeConfig
2/9/2009
The Set-WipeConfig cmdlet configures the properties of the wipe service.
You can configure how many times to retry wipe requests, whether they expire, when, and whether the wipe service should revoke the enrollment of a device if a wipe request is unsuccessful.
Note
All properties are global and affect all wipe requests submitted after the property changes. This cmdlet does not affect previously submitted wipe requests. Previously submitted wipe requests keep the configuration settings that existed when they were created. To modify the configuration of a specific wipe request to an updated configuration, you must remove the wipe request and then resubmit it.
Syntax
Set-WipeConfig [[-Config] <WipeConfig>] [-DisenrollUnsuccessful <Boolean>] [-EnableExpiration <Boolean>] [-ExpirationInterval <TimeSpan>] [-Force] [-Retry <int>] [-confirm] [-whatif] [<CommonParameters>]
Parameters
The following describes the Set-WipeConfig cmdlet parameters.
- Config <WipeConfig>
Accepts a WipeConfig object.
- DisenrollUnsuccessful <Boolean>
Specifies whether the wipe service should revoke the enrollment of managed devices for which the wipe request was unsuccessful, either failed or expired. This prevents an unsuccessfully wiped managed device from accessing company resources. However, after a managed device enrollment is revoked, a wipe request can no longer be submitted for that device. Successful wipe requests always revoke the enrollment of a device. The default value is $true.
- EnableExpiration <Boolean>
Specifies whether wipe requests will expire. If set to $true, the expiration time will be enforced. If set to $false, the expiration time will not be used and wipe requests will never expire. The default value is $true.
- ExpirationInterval <TimeSpan>
Specifies the time before a wipe request expires. The time may range from one day to two years. The default value is fourteen days. If the value contains a space or other special characters, enclose the string in quotation marks.
- Force
Suppresses the warning prompt that displays when Set-WipeConfig discovers an invalid wipe service setting on the server. If you specify Force, Set-WipeConfig automatically replaces the invalid setting with the default value without waiting for user confirmation.
- Retry <Int32>
Specifies the number of times that the wipe service retries wipe request submissions after a wipe request failure on a device. The accepted values for this parameter are any integer value between 0 and 5. If the retry value is set to a non-integer between 0 and 5, the wipe service rounds this value to the closest integer. The default value is 3.
- 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 Set-WipeConfig cmdlet accepts a WipeConfig object. To see all the properties for this object, at the MDM Shell prompt type, Get-WipeConfig | Get-Member.
Output Type
None
Examples
This sequence of commands example uses the Get-WipeConfig cmdlet, together with the Set-WipeConfig cmdlet, to change the expiration period to 180 days.
C:\PS>$a = Get-WipeConfig
C:\PS>$a.ExpirationInterval = New-TimeSpan -days 180
C:\PS>Set-WipeConfig $a
This Set-WipeConfig command example performs the same function as the previous example, but directly uses the ExpirationInterval parameter.
C:\PS>Set-WipeConfig -ExpirationInterval (New-TimeSpan -days 180)
This Set-WipeConfig command example sets the retry value to 5, and disables the wipe request expiration.
C:\PS>Set-WipeConfig -Retry 5 -EnableExpiration $false
Cmdlet Help
To view this information online, at the MDM Shell prompt, type:
get-help Set-WipeConfig -detailed, or get-help Set-WipeConfig -full