mirror of
https://github.com/apple/device-management.git
synced 2026-08-09 02:06:00 +02:00
127 lines
3.6 KiB
YAML
127 lines
3.6 KiB
YAML
title: OS Update Status Command
|
|
description: Queries the device for the status of software updates.
|
|
payload:
|
|
requesttype: OSUpdateStatus
|
|
supportedOS:
|
|
iOS:
|
|
introduced: '9.0'
|
|
accessrights: AllowAppInstallation
|
|
supervised: true
|
|
requiresdep: false
|
|
sharedipad:
|
|
mode: allowed
|
|
devicechannel: true
|
|
userchannel: false
|
|
userenrollment:
|
|
mode: forbidden
|
|
macOS:
|
|
introduced: 10.11.5
|
|
accessrights: None
|
|
devicechannel: true
|
|
userchannel: false
|
|
supervised: true
|
|
requiresdep: false
|
|
userenrollment:
|
|
mode: forbidden
|
|
tvOS:
|
|
introduced: '12.0'
|
|
accessrights: AllowAppInstallation
|
|
devicechannel: true
|
|
supervised: true
|
|
requiresdep: false
|
|
visionOS:
|
|
introduced: n/a
|
|
watchOS:
|
|
introduced: n/a
|
|
content: Queries the device for the status of software updates.
|
|
responsekeys:
|
|
- key: OSUpdateStatus
|
|
type: <array>
|
|
presence: required
|
|
content: An array of dictionaries that describes the statuses of software updates.
|
|
This command only returns the status for System Applications and Configuration
|
|
Data updates if a Software Update is actively managed via a Declarative Device
|
|
Management 'Software Update Enforcement Policy' configuration.
|
|
subkeys:
|
|
- key: OSUpdateStatusItem
|
|
type: <dictionary>
|
|
presence: required
|
|
subkeys:
|
|
- key: ProductKey
|
|
type: <string>
|
|
presence: required
|
|
content: The product key that represents the update.
|
|
- key: IsDownloaded
|
|
type: <boolean>
|
|
presence: required
|
|
content: If 'true', the update has finished downloading.
|
|
- key: DownloadPercentComplete
|
|
type: <real>
|
|
presence: required
|
|
content: A floating-point number between '0.0' and '1.0' that indicates the
|
|
download progress as a percentage.
|
|
- key: Status
|
|
type: <string>
|
|
presence: required
|
|
content: |-
|
|
The status of the update, which is one of the following values:
|
|
* 'Idle': The update is idle.
|
|
* 'Downloading': The software update is downloading and subsequently preparing.
|
|
* 'Installing': The software update is installing.
|
|
- key: MaxDeferrals
|
|
supportedOS:
|
|
iOS:
|
|
introduced: n/a
|
|
macOS:
|
|
introduced: '12.3'
|
|
tvOS:
|
|
introduced: n/a
|
|
type: <integer>
|
|
presence: optional
|
|
content: |-
|
|
The number of times a user can defer this OS update.
|
|
Available in macOS 12.3 and later.
|
|
- key: DeferralsRemaining
|
|
supportedOS:
|
|
iOS:
|
|
introduced: n/a
|
|
macOS:
|
|
introduced: '12.3'
|
|
tvOS:
|
|
introduced: n/a
|
|
type: <integer>
|
|
presence: optional
|
|
content: |-
|
|
The number of remaining user deferrals for this OS update.
|
|
Available in macOS 12.3 and later.
|
|
- key: NextScheduledInstall
|
|
supportedOS:
|
|
iOS:
|
|
introduced: n/a
|
|
macOS:
|
|
introduced: '12.3'
|
|
tvOS:
|
|
introduced: n/a
|
|
type: <date>
|
|
presence: optional
|
|
content: |-
|
|
The date of the next attempt at installing this OS update.
|
|
Available in macOS 12.3 and later.
|
|
- key: PastNotifications
|
|
supportedOS:
|
|
iOS:
|
|
introduced: n/a
|
|
macOS:
|
|
introduced: '12.3'
|
|
tvOS:
|
|
introduced: n/a
|
|
type: <array>
|
|
presence: optional
|
|
content: |-
|
|
The dates/times when the OS notified the user about installing this OS update.
|
|
Available in macOS 12.3 and later.
|
|
subkeys:
|
|
- key: PastNotificationDate
|
|
title: Past Notification Date
|
|
type: <date>
|