Files
apple_device-management/mdm/commands/device.restart.yaml
T
2026-06-22 15:55:19 -04:00

94 lines
2.8 KiB
YAML

title: Restart Device Command
description: Remotely and immediately restart a device.
payload:
requesttype: RestartDevice
supportedOS:
iOS:
introduced: '10.3'
accessrights: AllowPasscodeRemovalAndLock
supervised: true
requiresdep: false
sharedipad:
mode: allowed
devicechannel: true
userchannel: false
userenrollment:
mode: forbidden
macOS:
introduced: '10.13'
accessrights: AllowPasscodeRemovalAndLock
devicechannel: true
userchannel: false
supervised: false
requiresdep: false
userenrollment:
mode: forbidden
tvOS:
introduced: '10.2'
accessrights: AllowPasscodeRemovalAndLock
supervised: true
visionOS:
introduced: n/a
watchOS:
introduced: n/a
content: This command requires the Device Lock access right. The device will restart
immediately.
payloadkeys:
- key: RebuildKernelCache
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '11.0'
tvOS:
introduced: n/a
type: <boolean>
presence: optional
default: false
content: If `true`, the system rebuilds the kernel cache during a device restart.
If `BootstrapTokenAllowedForAuthentication` is `true` in the `SecurityInfo` response,
the device requests the bootstrap token from the MDM server prior to executing
this command.
- key: KextPaths
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '11.0'
tvOS:
introduced: n/a
type: <array>
presence: optional
content: If `RebuildKernelCache` is `true`, this value specifies the paths to kexts
to add to the auxiliary kernel cache since the last kernel cache rebuild. If not
present, the system only adds previously discovered kexts to the kernel cache.
subkeys:
- key: KextPathsItem
type: <string>
- key: NotifyUser
supportedOS:
iOS:
introduced: n/a
macOS:
introduced: '11.4'
tvOS:
introduced: n/a
type: <boolean>
presence: optional
default: false
content: If `true`, notifies the user to restart the device at their convenience.
No forced restart occurs unless the device is at `loginwindow` with no logged-in
users. The user can dismiss the notification and ignore the request. No further
notifications display unless you resend the command.
notes:
- title: ''
content: |-
A passcode-locked iOS device doesn't rejoin a Wi-Fi network after restarting, so it may not be able to communicate with the server.
Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
examples:
- title: Example request and response
files:
- request-file: examples/mdm/commands/device.restart/example1.plist
response-file: examples/mdm/commands/device.restart/example2.plist