Contents

ScheduleOSUpdateCommand.Command.UpdatesItem

A dictionary that describes the available operating-system updates item.

Declaration

object ScheduleOSUpdateCommand.Command.UpdatesItem

Properties

NameTypeDescription
InstallAction Requiredstring

The install action, which is one of the following values:

* Default: Download or install the update, depending on the current state. You can check the UpdateResults dictionary to review scheduled updates. This value is available in iOS 9 and later, macOS 10.11 and later, and tvOS 12 and later. * DownloadOnly: Download the software update without installing it. This value is available in iOS 9 and later, macOS 11 and later, and tvOS 12 and later. * InstallASAP: In iOS and tvOS, install a previously downloaded software update. In macOS, download the software update and trigger the restart countdown notification. This value is available in iOS 9 and later, macOS 10.11 and later, and tvOS 12 and later. * NotifyOnly: Download the software update and notify the user through the App Store. This value is available in macOS 10.11 and later. * InstallLater: Download the software update and install it at a later time. This value is available in macOS 10.11 and later. * InstallForceRestart: Perform the Default action, and then force a restart if the update requires it. This value is available in macOS 11 and later.

> Warning: > InstallForceRestart may result in data loss.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

MaxUserDeferralsinteger

The maximum number of times the system allows the user to postpone an update before it’s installed. The system prompts the user once a day.

This key is only supported when InstallAction is InstallLater and only supported for minor OS updates (for example, macOS 12.x to 12.y).

Available: macOS 12+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

Prioritystring

The scheduling priority for downloading and preparing the requested update. This is only supported for minor OS updates (macOS 12.x to 12.y).

~~ Prior versions of macOS used a priority of Low.~~

Available: macOS 12.3+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

ProductKeystring

The product key that represents the update.

Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+

ProductVersionstring

The version of the update, which the system requires if ProductKey isn’t present.

> Note: > This value isn’t available for use with Background Security Improvement updates.

Available: iOS 11.3+ | iPadOS 11.3+ | macOS 12+ | tvOS 12.2+ Deprecated: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ Removed: iOS 27+ | iPadOS 27+ | macOS 27+ | tvOS 27+