Contents

OSUpdateStatusResponse

A response from the device after it processes the command to get the status of operating-system updates on a device.

Declaration

object OSUpdateStatusResponse

Properties

NameTypeDescription
CommandUUIDstring

The unique identifier of the command for this response.

EnrollmentID Requiredstring

The per-enrollment identifier for the device. The system requires this value if the enrollment type is a user enrollment.

Available in iOS 13 and later, macOS 10.15 and later, and visionOS 2 and later.

EnrollmentUserID Requiredstring

The per-enrollment identifier for the user. The system requires this value if the enrollment type is a user enrollment on the user channel.

Available in macOS 10.15 and later.

ErrorChain[OSUpdateStatusResponse.ErrorChainItem]

An array of dictionaries that describes any errors that occur.

NotOnConsole Requiredboolean

If true, the device isn’t on-console.

OSUpdateStatus Required[OSUpdateStatusResponse.OSUpdateStatusItem]

An array of dictionaries that describes the statuses of software updates. The array is empty if there are no software updates currently in progress. This command only returns the status for System Applications and Configuration Data updates when a software update is managed by a Declarative Device Management SoftwareUpdateEnforcementSpecific configuration.

Status Requiredstring

The status of the response, which is one of the following values:

  • Acknowledged: The device processed the command successfully.

  • Error: An error occurred. See the ErrorChain for more details.

  • CommandFormatError: A protocol error occurred, which can result from a malformed command.

  • Idle: The device is idle; there’s no status.

  • NotNow: The device received the command, but can’t run it.

UDID Requiredstring

The device’s UDID (unique device identifier). The system requires this value if the enrollment type is a device enrollment.

UserIDstring

For macOS, this value is the ID of the user.

For Shared iPad, this value is FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF to indicate that authentication doesn’t occur.

UserLongName Requiredstring

The full name of the user.

UserShortNamestring

For macOS, this value is the short name of the user.

For Shared iPad, this value is the Managed Apple Account identifier of the user on Shared iPad. It indicates that the token is for the user channel.

Topics

Objects

See Also

Commands and responses