Schedule OS Update
Schedule an update of the operating system on a device.
URL
PUT https://yourmdmhost.example.com/mdm#ScheduleOSUpdateCommandResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/xml | ScheduleOSUpdateResponse | The response object the system returns for the Schedule OS Update Command. |
Discussion
Only supervised iOS, macOS, and tvOS devices are eligible for software update management.
This command can only schedule operating-system updates in iOS and tvOS, however, it can also schedule a variety of system software updates in macOS.
Downloading and installing updates in iOS and tvOS is a two-step process. Send a ScheduleOSUpdate command with Default for InstallAction to download the updates. Then send another ScheduleOSUpdate command with a Default InstallAction to install the updates. Software updates may require a restart, which prevents the device from responding. When this happens, the MDM server resends the ScheduleOSUpdate command when the device checks in again, however, the device won’t return a value for UpdateResults.
This command uses the ScheduleOSUpdateCommand.Command.UpdatesItem InstallAction values to offer varying degrees of control to the user of a device. The user can control the update with the NotifyOnly and DownloadOnly actions, which don’t initiate the update process at all. The InstallASAP and InstallForceRestart actions attempt to install the update as soon as possible. On iOS devices with a passcode, the user must authorize the update by entering their passcode, allowing them to defer the update a limited number of times. After the user reaches that limit, the system prompts to update every time the device returns to the Home Screen. This makes the device virtually unusable until the user approves the software update. On macOS devices, the InstallLater action provides a similar behavior, which specifies how many times the user may defer the update before it’s forced.
A device may return a different InstallAction than requested.
Refer to the following sections to determine supported channels and requirements, and to see an example request and response.
Command availability
Device channel | iOS, macOS, Shared iPad, tvOS |
User channel | NA |
Requires supervision | iOS, macOS, tvOS |
Allowed in user enrollment | NA |
Required access right | AllowAppInstallation |
Example request and response
HTTP Body
The request object the server returns for the Schedule OS Update Command.