qemu/qapi/job.json

11 # Type of a background job.
13 # @commit: block commit job type, see "block-commit"
15 # @stream: block stream job type, see "block-stream"
17 # @mirror: drive mirror job type, see "drive-mirror"
19 # @backup: drive backup job type, see "drive-backup"
21 # @create: image creation job type, see "blockdev-create" (since 3.0)
23 # @amend: image options amend job type, see "x-blockdev-amend" (since
26 # @snapshot-load: snapshot load job type, see "snapshot-load" (since
29 # @snapshot-save: snapshot save job type, see "snapshot-save" (since
32 # @snapshot-delete: snapshot delete job type, see "snapshot-delete"
44 # Indicates the present state of a given job in its lifetime.
48 # @created: The job has been created, but not yet started.
50 # @running: The job is currently running.
52 # @paused: The job is running, but paused.  The pause may be requested
55 # @ready: The job is running, but is ready for the user to signal
59 # @standby: The job is ready, but paused.  This is nearly identical to
60 #     @paused.  The job may return to @ready or otherwise be canceled.
62 # @waiting: The job is waiting for other jobs in the transaction to
64 #     visible for the last job in a transaction.
66 # @pending: The job has finished its work, but has finalization steps
68 #     require manual intervention via @job-finalize if auto-finalize
71 # @aborting: The job is in the process of being aborted, and will
72 #     finish with an error.  The job will afterwards report that it is
76 # @concluded: The job has finished all work.  If auto-dismiss was set
77 #     to false, the job will remain in the query list until it is
78 #     dismissed via @job-dismiss.
80 # @null: The job is in the process of being dismantled.  This state
92 # Represents command verbs that can be applied to a job.
94 # @cancel: see @job-cancel
96 # @pause: see @job-pause
98 # @resume: see @job-resume
100 # @set-speed: see @block-job-set-speed
102 # @complete: see @job-complete
104 # @dismiss: see @job-dismiss
106 # @finalize: see @job-finalize
108 # @change: see @block-job-change (since 8.2)
119 # Emitted when a job transitions to a different status.
121 # @id: The job identifier
123 # @status: The new job status
132 # @job-pause:
134 # Pause an active job.
136 # This command returns immediately after marking the active job for
137 # pausing.  Pausing an already paused job is an error.
139 # The job will pause as soon as possible, which means transitioning
143 # Cancelling a paused job automatically resumes it.
145 # @id: The job identifier.
149 { 'command': 'job-pause', 'data': { 'id': 'str' } }
152 # @job-resume:
154 # Resume a paused job.
156 # This command returns immediately after resuming a paused job.
157 # Resuming an already running job is an error.
159 # @id: The job identifier.
163 { 'command': 'job-resume', 'data': { 'id': 'str' } }
166 # @job-cancel:
168 # Instruct an active background job to cancel at the next opportunity.
169 # This command returns immediately after marking the active job for
172 # The job will cancel as soon as possible and then emit a
174 # ABORTING, but it is possible that a job successfully completes (e.g.
176 # earlier than completing the job) and transitions to PENDING instead.
178 # @id: The job identifier.
182 { 'command': 'job-cancel', 'data': { 'id': 'str' } }
185 # @job-complete:
187 # Manually trigger completion of an active job in the READY state.
189 # @id: The job identifier.
193 { 'command': 'job-complete', 'data': { 'id': 'str' } }
196 # @job-dismiss:
198 # Deletes a job that is in the CONCLUDED state.  This command only
202 # This command will refuse to operate on any job that has not yet
204 # make use of JOB_READY event, job-cancel or job-complete will still
207 # @id: The job identifier.
211 { 'command': 'job-dismiss', 'data': { 'id': 'str' } }
214 # @job-finalize:
216 # Instructs all jobs in a transaction (or a single job if it is not
221 # For jobs in a transaction, instructing one job to finalize will
223 # necessary to instruct a single member job to finalize.
225 # @id: The identifier of any job in the transaction, or of a job that
230 { 'command': 'job-finalize', 'data': { 'id': 'str' } }
235 # Information about a job.
237 # @id: The job identifier
239 # @type: The kind of job that is being performed
241 # @status: Current job state/status
249 #     of the job.  This value can arbitrarily change while the job is
252 # @error: If this field is present, the job failed; if it is still
257 #     reason for the job failure.  It should not be parsed by
272 # Returns: a list with a @JobInfo for each active job