Contents

EraseDeviceCommand.Command

The command to remotely and immediately erase a device.

Declaration

object EraseDeviceCommand.Command

Properties

NameTypeDescription
DisallowProximitySetupboolean

If true, disable Proximity Setup on the next reboot and skip the pane in Setup Assistant. Prior to iOS 14, don’t use this option with any other option.

Available: iOS 11.3+ | iPadOS 11.3+

ObliterationBehaviorstring

This key defines the fallback behavior for erasing a device.

In macOS 12 and later, this command uses Erase All Content and Settings (EACS) on Mac computers with the Apple M1 chip or the Apple T2 Security Chip. On those devices, if EACS can’t run, the device can use obliteration (macOS 11.x behavior). This key has no effect on machines prior to the T2 chip. For a list of supported macs, see Mac models with the Apple T2 Security Chip.

Upon receiving this command, the device performs preflight checks to determine if the device is in a state that allows EACS. The status of the EraseDeviceResponse is either Acknowledged or Error.

The following values define the device’s fallback behavior:

  • DoNotObliterate: If EACS preflight fails, the device responds to the server with an Error status and doesn’t attempt to erase itself. If EACS preflight succeeds, but EACS fails, the device doesn’t attempt to erase itself.

  • ObliterateWithWarning: If EACS preflight fails, the device responds with an Acknowledged status and then attempts to erase itself. If EACS preflight succeeds, but EACS fails, the device attempts to erase itself.

  • Always: The system doesn’t attempt EACS. T2 and later devices always obliterate.

  • Default: If EACS preflight fails, the device responds to the server with an Error status and then attempts to erase itself. If EACS preflight succeeds, but EACS fails, the device attempts to erase itself.

Available: macOS 12+

PINstring

The six-character PIN for Find My.

Available: macOS 10.8+

PreserveDataPlanboolean

If true, preserve the data plan on an iPhone or iPad with eSIM functionality, if one exists.

Available: iOS 11+ | iPadOS 11+ | watchOS 10+

RequestRequiresNetworkTetherboolean

If true, the device needs to be network-tethered to run the command.

RequestType Requiredstring

The request type for this command.

ReturnToServiceEraseDeviceCommand.Command.ReturnToService

The configuration settings for return to service.

Available: iOS 17+ | iPadOS 17+ | tvOS 18+ | visionOS 26+

Topics

Objects