mirror of
https://github.com/apple/device-management.git
synced 2026-07-10 21:13:42 +02:00
Cyrus Daboo
69 lines
4.2 KiB
YAML
69 lines
4.2 KiB
YAML
title: Trigger Enhanced Log Collection Command
|
|
description: Trigger enhanced log collection on the device.
|
|
payload:
|
|
requesttype: TriggerEnhancedLogCollection
|
|
supportedOS:
|
|
iOS:
|
|
introduced: '27.0'
|
|
supervised: true
|
|
requiresdep: false
|
|
sharedipad:
|
|
mode: allowed
|
|
devicechannel: true
|
|
userchannel: false
|
|
userenrollment:
|
|
mode: forbidden
|
|
macOS:
|
|
introduced: '27.0'
|
|
devicechannel: false
|
|
userchannel: true
|
|
supervised: true
|
|
requiresdep: false
|
|
userenrollment:
|
|
mode: forbidden
|
|
tvOS:
|
|
introduced: '27.0'
|
|
supervised: true
|
|
requiresdep: false
|
|
visionOS:
|
|
introduced: n/a
|
|
watchOS:
|
|
introduced: n/a
|
|
content: This command allows supervised devices to collect enhanced log and upload
|
|
it to a remote server.
|
|
payloadkeys:
|
|
- key: AppleCareToken
|
|
type: <string>
|
|
presence: required
|
|
content: The AppleCare token the device uses for authorizing the enhanced log collection
|
|
session.
|
|
notes:
|
|
- title: ''
|
|
content: |-
|
|
When the organization's IT support reports a problem to AppleCare, AppleCare may request that the device runs enhanced log collection. AppleCare provides a token to IT support, and they send the `TriggerEnhancedLogCollection` command to the device, with the token, to initiate the enhanced log collection procedure.
|
|
|
|
When the device processes the command it starts the enhanced log collection operation. There are two modes:
|
|
|
|
* `interactive`: the device shows the user a notification that allows the user to initiate the enhanced log collection. The device prompts the user to consent to both log collection and log upload at the appropriate times. The user can decline to proceed with enhanced log collection or upload. This mode is required for macOS devices. This mode isn't available on tvOS devices or Shared iPad.
|
|
* `non-interactive`: the device shows a notification that enhanced log collection is in progress. The device collects and uploads the logs in the background without any user intervention. This mode is always available for tvOS devices and Shared iPad. This mode is only available for iOS devices when all these conditions are met:
|
|
* There's no passcode on the device.
|
|
* There are no accounts on the device. For example, iCloud, App Store, mail, calendar, or contacts accounts.
|
|
|
|
AppleCare, in conjunction with IT support, determines the mode and the token encodes the mode.
|
|
|
|
You can cancel an active enhanced log collection session by sending the `Cancel-Enhanced-Log-Collection-Command` to the device.
|
|
- title: Declarative status
|
|
content: |-
|
|
The enhanced log collection process reports declarative status to the device management service using the following status items:
|
|
|
|
* `enhanced-logging.status`: Reports the device's enhanced log collection session state. See `StatusEnhancedLoggingStatus`.
|
|
* `enhanced-logging.applecare-token`: Reports the device's enhanced log collection session AppleCare token. See `StatusEnhancedLoggingAppleCareToken`.
|
|
* `enhanced-logging.timestamp`: Reports the device's enhanced log collection session timestamp. See `StatusEnhancedLoggingTimestamp`.
|
|
- title: Tokens for testing
|
|
content: |-
|
|
You can use a set of test tokens to verify correct operation of your device management service product. The set of tokens are:
|
|
|
|
* `test-token-normal`: This token activates an interactive enhanced log collection session that results in the device reporting the `finished` declarative state if all parts of the flow succeed. Any failure, cancellation, or decline, result in the device reporting the corresponding state.
|
|
* `test-token-normal-headless`: This token activates a non-interactive enhanced log collection session that results in the device reporting the `finished` declarative state if all parts of the flow succeed. Any failure, cancellation, or decline, result in the device reporting the corresponding state.
|
|
* `test-token-failed`: This token activates an interactive enhanced log collection session that results in the device reporting the `failed` declarative state if all parts of the flow succeed. Any failure, cancellation, or decline, result in the device reporting the corresponding state.
|