block.c: adding bdrv_co_delete_file
[qemu.git] / hmp-commands.hx
blobf12263e071f29be8847a84dca2d08e5d2313ead4
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
10 .name = "help|?",
11 .args_type = "name:S?",
12 .params = "[cmd]",
13 .help = "show the help",
14 .cmd = do_help_cmd,
15 .flags = "p",
18 SRST
19 ``help`` or ``?`` [*cmd*]
20 Show the help for all commands or just for command *cmd*.
21 ERST
24 .name = "commit",
25 .args_type = "device:B",
26 .params = "device|all",
27 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
28 .cmd = hmp_commit,
31 SRST
32 ``commit``
33 Commit changes to the disk images (if -snapshot is used) or backing files.
34 If the backing file is smaller than the snapshot, then the backing file
35 will be resized to be the same size as the snapshot. If the snapshot is
36 smaller than the backing file, the backing file will not be truncated.
37 If you want the backing file to match the size of the smaller snapshot,
38 you can safely truncate it yourself once the commit operation successfully
39 completes.
40 ERST
43 .name = "q|quit",
44 .args_type = "",
45 .params = "",
46 .help = "quit the emulator",
47 .cmd = hmp_quit,
50 SRST
51 ``q`` or ``quit``
52 Quit the emulator.
53 ERST
56 .name = "exit_preconfig",
57 .args_type = "",
58 .params = "",
59 .help = "exit the preconfig state",
60 .cmd = hmp_exit_preconfig,
61 .flags = "p",
64 SRST
65 ``exit_preconfig``
66 This command makes QEMU exit the preconfig state and proceed with
67 VM initialization using configuration data provided on the command line
68 and via the QMP monitor during the preconfig state. The command is only
69 available during the preconfig state (i.e. when the --preconfig command
70 line option was in use).
71 ERST
74 .name = "block_resize",
75 .args_type = "device:B,size:o",
76 .params = "device size",
77 .help = "resize a block image",
78 .cmd = hmp_block_resize,
81 SRST
82 ``block_resize``
83 Resize a block image while a guest is running. Usually requires guest
84 action to see the updated size. Resize to a lower size is supported,
85 but should be used with extreme caution. Note that this command only
86 resizes image files, it can not resize block devices like LVM volumes.
87 ERST
90 .name = "block_stream",
91 .args_type = "device:B,speed:o?,base:s?",
92 .params = "device [speed [base]]",
93 .help = "copy data from a backing file into a block device",
94 .cmd = hmp_block_stream,
97 SRST
98 ``block_stream``
99 Copy data from a backing file into a block device.
100 ERST
103 .name = "block_job_set_speed",
104 .args_type = "device:B,speed:o",
105 .params = "device speed",
106 .help = "set maximum speed for a background block operation",
107 .cmd = hmp_block_job_set_speed,
110 SRST
111 ``block_job_set_speed``
112 Set maximum speed for a background block operation.
113 ERST
116 .name = "block_job_cancel",
117 .args_type = "force:-f,device:B",
118 .params = "[-f] device",
119 .help = "stop an active background block operation (use -f"
120 "\n\t\t\t if you want to abort the operation immediately"
121 "\n\t\t\t instead of keep running until data is in sync)",
122 .cmd = hmp_block_job_cancel,
125 SRST
126 ``block_job_cancel``
127 Stop an active background block operation (streaming, mirroring).
128 ERST
131 .name = "block_job_complete",
132 .args_type = "device:B",
133 .params = "device",
134 .help = "stop an active background block operation",
135 .cmd = hmp_block_job_complete,
138 SRST
139 ``block_job_complete``
140 Manually trigger completion of an active background block operation.
141 For mirroring, this will switch the device to the destination path.
142 ERST
145 .name = "block_job_pause",
146 .args_type = "device:B",
147 .params = "device",
148 .help = "pause an active background block operation",
149 .cmd = hmp_block_job_pause,
152 SRST
153 ``block_job_pause``
154 Pause an active block streaming operation.
155 ERST
158 .name = "block_job_resume",
159 .args_type = "device:B",
160 .params = "device",
161 .help = "resume a paused background block operation",
162 .cmd = hmp_block_job_resume,
165 SRST
166 ``block_job_resume``
167 Resume a paused block streaming operation.
168 ERST
171 .name = "eject",
172 .args_type = "force:-f,device:B",
173 .params = "[-f] device",
174 .help = "eject a removable medium (use -f to force it)",
175 .cmd = hmp_eject,
178 SRST
179 ``eject [-f]`` *device*
180 Eject a removable medium (use -f to force it).
181 ERST
184 .name = "drive_del",
185 .args_type = "id:B",
186 .params = "device",
187 .help = "remove host block device",
188 .cmd = hmp_drive_del,
191 SRST
192 ``drive_del`` *device*
193 Remove host block device. The result is that guest generated IO is no longer
194 submitted against the host device underlying the disk. Once a drive has
195 been deleted, the QEMU Block layer returns -EIO which results in IO
196 errors in the guest for applications that are reading/writing to the device.
197 These errors are always reported to the guest, regardless of the drive's error
198 actions (drive options rerror, werror).
199 ERST
202 .name = "change",
203 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
204 .params = "device filename [format [read-only-mode]]",
205 .help = "change a removable medium, optional format",
206 .cmd = hmp_change,
209 SRST
210 ``change`` *device* *setting*
211 Change the configuration of a device.
213 ``change`` *diskdevice* *filename* [*format* [*read-only-mode*]]
214 Change the medium for a removable disk device to point to *filename*. eg::
216 (qemu) change ide1-cd0 /path/to/some.iso
218 *format* is optional.
220 *read-only-mode* may be used to change the read-only status of the device.
221 It accepts the following values:
223 retain
224 Retains the current status; this is the default.
226 read-only
227 Makes the device read-only.
229 read-write
230 Makes the device writable.
232 ``change vnc`` *display*,\ *options*
233 Change the configuration of the VNC server. The valid syntax for *display*
234 and *options* are described at :ref:`sec_005finvocation`. eg::
236 (qemu) change vnc localhost:1
238 ``change vnc password`` [*password*]
240 Change the password associated with the VNC server. If the new password
241 is not supplied, the monitor will prompt for it to be entered. VNC
242 passwords are only significant up to 8 letters. eg::
244 (qemu) change vnc password
245 Password: ********
247 ERST
250 .name = "screendump",
251 .args_type = "filename:F,device:s?,head:i?",
252 .params = "filename [device [head]]",
253 .help = "save screen from head 'head' of display device 'device' "
254 "into PPM image 'filename'",
255 .cmd = hmp_screendump,
258 SRST
259 ``screendump`` *filename*
260 Save screen into PPM image *filename*.
261 ERST
264 .name = "logfile",
265 .args_type = "filename:F",
266 .params = "filename",
267 .help = "output logs to 'filename'",
268 .cmd = hmp_logfile,
271 SRST
272 ``logfile`` *filename*
273 Output logs to *filename*.
274 ERST
277 .name = "trace-event",
278 .args_type = "name:s,option:b,vcpu:i?",
279 .params = "name on|off [vcpu]",
280 .help = "changes status of a specific trace event "
281 "(vcpu: vCPU to set, default is all)",
282 .cmd = hmp_trace_event,
283 .command_completion = trace_event_completion,
286 SRST
287 ``trace-event``
288 changes status of a trace event
289 ERST
291 #if defined(CONFIG_TRACE_SIMPLE)
293 .name = "trace-file",
294 .args_type = "op:s?,arg:F?",
295 .params = "on|off|flush|set [arg]",
296 .help = "open, close, or flush trace file, or set a new file name",
297 .cmd = hmp_trace_file,
300 SRST
301 ``trace-file on|off|flush``
302 Open, close, or flush the trace file. If no argument is given, the
303 status of the trace file is displayed.
304 ERST
305 #endif
308 .name = "log",
309 .args_type = "items:s",
310 .params = "item1[,...]",
311 .help = "activate logging of the specified items",
312 .cmd = hmp_log,
315 SRST
316 ``log`` *item1*\ [,...]
317 Activate logging of the specified items.
318 ERST
321 .name = "savevm",
322 .args_type = "name:s?",
323 .params = "tag",
324 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
325 .cmd = hmp_savevm,
328 SRST
329 ``savevm`` *tag*
330 Create a snapshot of the whole virtual machine. If *tag* is
331 provided, it is used as human readable identifier. If there is already
332 a snapshot with the same tag, it is replaced. More info at
333 :ref:`vm_005fsnapshots`.
335 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
336 only *tag* as parameter.
337 ERST
340 .name = "loadvm",
341 .args_type = "name:s",
342 .params = "tag",
343 .help = "restore a VM snapshot from its tag",
344 .cmd = hmp_loadvm,
345 .command_completion = loadvm_completion,
348 SRST
349 ``loadvm`` *tag*
350 Set the whole virtual machine to the snapshot identified by the tag
351 *tag*.
353 Since 4.0, loadvm stopped accepting snapshot id as parameter.
354 ERST
357 .name = "delvm",
358 .args_type = "name:s",
359 .params = "tag",
360 .help = "delete a VM snapshot from its tag",
361 .cmd = hmp_delvm,
362 .command_completion = delvm_completion,
365 SRST
366 ``delvm`` *tag*
367 Delete the snapshot identified by *tag*.
369 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
370 only *tag* as parameter.
371 ERST
374 .name = "singlestep",
375 .args_type = "option:s?",
376 .params = "[on|off]",
377 .help = "run emulation in singlestep mode or switch to normal mode",
378 .cmd = hmp_singlestep,
381 SRST
382 ``singlestep [off]``
383 Run the emulation in single step mode.
384 If called with option off, the emulation returns to normal mode.
385 ERST
388 .name = "stop",
389 .args_type = "",
390 .params = "",
391 .help = "stop emulation",
392 .cmd = hmp_stop,
395 SRST
396 ``stop``
397 Stop emulation.
398 ERST
401 .name = "c|cont",
402 .args_type = "",
403 .params = "",
404 .help = "resume emulation",
405 .cmd = hmp_cont,
408 SRST
409 ``c`` or ``cont``
410 Resume emulation.
411 ERST
414 .name = "system_wakeup",
415 .args_type = "",
416 .params = "",
417 .help = "wakeup guest from suspend",
418 .cmd = hmp_system_wakeup,
421 SRST
422 ``system_wakeup``
423 Wakeup guest from suspend.
424 ERST
427 .name = "gdbserver",
428 .args_type = "device:s?",
429 .params = "[device]",
430 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
431 .cmd = hmp_gdbserver,
434 SRST
435 ``gdbserver`` [*port*]
436 Start gdbserver session (default *port*\=1234)
437 ERST
440 .name = "x",
441 .args_type = "fmt:/,addr:l",
442 .params = "/fmt addr",
443 .help = "virtual memory dump starting at 'addr'",
444 .cmd = hmp_memory_dump,
447 SRST
448 ``x/``\ *fmt* *addr*
449 Virtual memory dump starting at *addr*.
450 ERST
453 .name = "xp",
454 .args_type = "fmt:/,addr:l",
455 .params = "/fmt addr",
456 .help = "physical memory dump starting at 'addr'",
457 .cmd = hmp_physical_memory_dump,
460 SRST
461 ``xp /``\ *fmt* *addr*
462 Physical memory dump starting at *addr*.
464 *fmt* is a format which tells the command how to format the
465 data. Its syntax is: ``/{count}{format}{size}``
467 *count*
468 is the number of items to be dumped.
469 *format*
470 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
471 c (char) or i (asm instruction).
472 *size*
473 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
474 ``h`` or ``w`` can be specified with the ``i`` format to
475 respectively select 16 or 32 bit code instruction size.
477 Examples:
479 Dump 10 instructions at the current instruction pointer::
481 (qemu) x/10i $eip
482 0x90107063: ret
483 0x90107064: sti
484 0x90107065: lea 0x0(%esi,1),%esi
485 0x90107069: lea 0x0(%edi,1),%edi
486 0x90107070: ret
487 0x90107071: jmp 0x90107080
488 0x90107073: nop
489 0x90107074: nop
490 0x90107075: nop
491 0x90107076: nop
493 Dump 80 16 bit values at the start of the video memory::
495 (qemu) xp/80hx 0xb8000
496 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
497 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
498 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
499 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
500 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
501 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
502 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
503 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
504 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
505 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
507 ERST
510 .name = "gpa2hva",
511 .args_type = "addr:l",
512 .params = "addr",
513 .help = "print the host virtual address corresponding to a guest physical address",
514 .cmd = hmp_gpa2hva,
517 SRST
518 ``gpa2hva`` *addr*
519 Print the host virtual address at which the guest's physical address *addr*
520 is mapped.
521 ERST
523 #ifdef CONFIG_LINUX
525 .name = "gpa2hpa",
526 .args_type = "addr:l",
527 .params = "addr",
528 .help = "print the host physical address corresponding to a guest physical address",
529 .cmd = hmp_gpa2hpa,
531 #endif
533 SRST
534 ``gpa2hpa`` *addr*
535 Print the host physical address at which the guest's physical address *addr*
536 is mapped.
537 ERST
540 .name = "gva2gpa",
541 .args_type = "addr:l",
542 .params = "addr",
543 .help = "print the guest physical address corresponding to a guest virtual address",
544 .cmd = hmp_gva2gpa,
547 SRST
548 ``gva2gpa`` *addr*
549 Print the guest physical address at which the guest's virtual address *addr*
550 is mapped based on the mapping for the current CPU.
551 ERST
554 .name = "p|print",
555 .args_type = "fmt:/,val:l",
556 .params = "/fmt expr",
557 .help = "print expression value (use $reg for CPU register access)",
558 .cmd = do_print,
561 SRST
562 ``p`` or ``print/``\ *fmt* *expr*
563 Print expression value. Only the *format* part of *fmt* is
564 used.
565 ERST
568 .name = "i",
569 .args_type = "fmt:/,addr:i,index:i.",
570 .params = "/fmt addr",
571 .help = "I/O port read",
572 .cmd = hmp_ioport_read,
575 SRST
576 ``i/``\ *fmt* *addr* [.\ *index*\ ]
577 Read I/O port.
578 ERST
581 .name = "o",
582 .args_type = "fmt:/,addr:i,val:i",
583 .params = "/fmt addr value",
584 .help = "I/O port write",
585 .cmd = hmp_ioport_write,
588 SRST
589 ``o/``\ *fmt* *addr* *val*
590 Write to I/O port.
591 ERST
594 .name = "sendkey",
595 .args_type = "keys:s,hold-time:i?",
596 .params = "keys [hold_ms]",
597 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
598 .cmd = hmp_sendkey,
599 .command_completion = sendkey_completion,
602 SRST
603 ``sendkey`` *keys*
604 Send *keys* to the guest. *keys* could be the name of the
605 key or the raw value in hexadecimal format. Use ``-`` to press
606 several keys simultaneously. Example::
608 sendkey ctrl-alt-f1
610 This command is useful to send keys that your graphical user interface
611 intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
612 ERST
614 .name = "sync-profile",
615 .args_type = "op:s?",
616 .params = "[on|off|reset]",
617 .help = "enable, disable or reset synchronization profiling. "
618 "With no arguments, prints whether profiling is on or off.",
619 .cmd = hmp_sync_profile,
622 SRST
623 ``sync-profile [on|off|reset]``
624 Enable, disable or reset synchronization profiling. With no arguments, prints
625 whether profiling is on or off.
626 ERST
629 .name = "system_reset",
630 .args_type = "",
631 .params = "",
632 .help = "reset the system",
633 .cmd = hmp_system_reset,
636 SRST
637 ``system_reset``
638 Reset the system.
639 ERST
642 .name = "system_powerdown",
643 .args_type = "",
644 .params = "",
645 .help = "send system power down event",
646 .cmd = hmp_system_powerdown,
649 SRST
650 ``system_powerdown``
651 Power down the system (if supported).
652 ERST
655 .name = "sum",
656 .args_type = "start:i,size:i",
657 .params = "addr size",
658 .help = "compute the checksum of a memory region",
659 .cmd = hmp_sum,
662 SRST
663 ``sum`` *addr* *size*
664 Compute the checksum of a memory region.
665 ERST
668 .name = "device_add",
669 .args_type = "device:O",
670 .params = "driver[,prop=value][,...]",
671 .help = "add device, like -device on the command line",
672 .cmd = hmp_device_add,
673 .command_completion = device_add_completion,
676 SRST
677 ``device_add`` *config*
678 Add device.
679 ERST
682 .name = "device_del",
683 .args_type = "id:s",
684 .params = "device",
685 .help = "remove device",
686 .cmd = hmp_device_del,
687 .command_completion = device_del_completion,
690 SRST
691 ``device_del`` *id*
692 Remove device *id*. *id* may be a short ID
693 or a QOM object path.
694 ERST
697 .name = "cpu",
698 .args_type = "index:i",
699 .params = "index",
700 .help = "set the default CPU",
701 .cmd = hmp_cpu,
704 SRST
705 ``cpu`` *index*
706 Set the default CPU.
707 ERST
710 .name = "mouse_move",
711 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
712 .params = "dx dy [dz]",
713 .help = "send mouse move events",
714 .cmd = hmp_mouse_move,
717 SRST
718 ``mouse_move`` *dx* *dy* [*dz*]
719 Move the active mouse to the specified coordinates *dx* *dy*
720 with optional scroll axis *dz*.
721 ERST
724 .name = "mouse_button",
725 .args_type = "button_state:i",
726 .params = "state",
727 .help = "change mouse button state (1=L, 2=M, 4=R)",
728 .cmd = hmp_mouse_button,
731 SRST
732 ``mouse_button`` *val*
733 Change the active mouse button state *val* (1=L, 2=M, 4=R).
734 ERST
737 .name = "mouse_set",
738 .args_type = "index:i",
739 .params = "index",
740 .help = "set which mouse device receives events",
741 .cmd = hmp_mouse_set,
744 SRST
745 ``mouse_set`` *index*
746 Set which mouse device receives events at given *index*, index
747 can be obtained with::
749 info mice
751 ERST
754 .name = "wavcapture",
755 .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
756 .params = "path audiodev [frequency [bits [channels]]]",
757 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
758 .cmd = hmp_wavcapture,
760 SRST
761 ``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
762 Capture audio into *filename* from *audiodev*, using sample rate
763 *frequency* bits per sample *bits* and number of channels
764 *channels*.
766 Defaults:
768 - Sample rate = 44100 Hz - CD quality
769 - Bits = 16
770 - Number of channels = 2 - Stereo
771 ERST
774 .name = "stopcapture",
775 .args_type = "n:i",
776 .params = "capture index",
777 .help = "stop capture",
778 .cmd = hmp_stopcapture,
780 SRST
781 ``stopcapture`` *index*
782 Stop capture with a given *index*, index can be obtained with::
784 info capture
786 ERST
789 .name = "memsave",
790 .args_type = "val:l,size:i,filename:s",
791 .params = "addr size file",
792 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
793 .cmd = hmp_memsave,
796 SRST
797 ``memsave`` *addr* *size* *file*
798 save to disk virtual memory dump starting at *addr* of size *size*.
799 ERST
802 .name = "pmemsave",
803 .args_type = "val:l,size:i,filename:s",
804 .params = "addr size file",
805 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
806 .cmd = hmp_pmemsave,
809 SRST
810 ``pmemsave`` *addr* *size* *file*
811 save to disk physical memory dump starting at *addr* of size *size*.
812 ERST
815 .name = "boot_set",
816 .args_type = "bootdevice:s",
817 .params = "bootdevice",
818 .help = "define new values for the boot device list",
819 .cmd = hmp_boot_set,
822 SRST
823 ``boot_set`` *bootdevicelist*
824 Define new values for the boot device list. Those values will override
825 the values specified on the command line through the ``-boot`` option.
827 The values that can be specified here depend on the machine type, but are
828 the same that can be specified in the ``-boot`` command line option.
829 ERST
832 .name = "nmi",
833 .args_type = "",
834 .params = "",
835 .help = "inject an NMI",
836 .cmd = hmp_nmi,
838 SRST
839 ``nmi`` *cpu*
840 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
841 ERST
844 .name = "ringbuf_write",
845 .args_type = "device:s,data:s",
846 .params = "device data",
847 .help = "Write to a ring buffer character device",
848 .cmd = hmp_ringbuf_write,
849 .command_completion = ringbuf_write_completion,
852 SRST
853 ``ringbuf_write`` *device* *data*
854 Write *data* to ring buffer character device *device*.
855 *data* must be a UTF-8 string.
856 ERST
859 .name = "ringbuf_read",
860 .args_type = "device:s,size:i",
861 .params = "device size",
862 .help = "Read from a ring buffer character device",
863 .cmd = hmp_ringbuf_read,
864 .command_completion = ringbuf_write_completion,
867 SRST
868 ``ringbuf_read`` *device*
869 Read and print up to *size* bytes from ring buffer character
870 device *device*.
871 Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
872 character code in hexadecimal. Character ``\`` is printed ``\\``.
873 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
874 NUL characters, after the ring buffer lost data, and when reading
875 stops because the size limit is reached.
876 ERST
879 .name = "announce_self",
880 .args_type = "interfaces:s?,id:s?",
881 .params = "[interfaces] [id]",
882 .help = "Trigger GARP/RARP announcements",
883 .cmd = hmp_announce_self,
886 SRST
887 ``announce_self``
888 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
889 updating the network infrastructure after a reconfiguration or some forms
890 of migration. The timings of the round are set by the migration announce
891 parameters. An optional comma separated *interfaces* list restricts the
892 announce to the named set of interfaces. An optional *id* can be used to
893 start a separate announce timer and to change the parameters of it later.
894 ERST
897 .name = "migrate",
898 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
899 .params = "[-d] [-b] [-i] [-r] uri",
900 .help = "migrate to URI (using -d to not wait for completion)"
901 "\n\t\t\t -b for migration without shared storage with"
902 " full copy of disk\n\t\t\t -i for migration without "
903 "shared storage with incremental copy of disk "
904 "(base image shared between src and destination)"
905 "\n\t\t\t -r to resume a paused migration",
906 .cmd = hmp_migrate,
910 SRST
911 ``migrate [-d] [-b] [-i]`` *uri*
912 Migrate to *uri* (using -d to not wait for completion).
914 ``-b``
915 for migration with full copy of disk
916 ``-i``
917 for migration with incremental copy of disk (base image is shared)
918 ERST
921 .name = "migrate_cancel",
922 .args_type = "",
923 .params = "",
924 .help = "cancel the current VM migration",
925 .cmd = hmp_migrate_cancel,
928 SRST
929 ``migrate_cancel``
930 Cancel the current VM migration.
931 ERST
934 .name = "migrate_continue",
935 .args_type = "state:s",
936 .params = "state",
937 .help = "Continue migration from the given paused state",
938 .cmd = hmp_migrate_continue,
940 SRST
941 ``migrate_continue`` *state*
942 Continue migration from the paused state *state*
943 ERST
946 .name = "migrate_incoming",
947 .args_type = "uri:s",
948 .params = "uri",
949 .help = "Continue an incoming migration from an -incoming defer",
950 .cmd = hmp_migrate_incoming,
953 SRST
954 ``migrate_incoming`` *uri*
955 Continue an incoming migration using the *uri* (that has the same syntax
956 as the ``-incoming`` option).
957 ERST
960 .name = "migrate_recover",
961 .args_type = "uri:s",
962 .params = "uri",
963 .help = "Continue a paused incoming postcopy migration",
964 .cmd = hmp_migrate_recover,
967 SRST
968 ``migrate_recover`` *uri*
969 Continue a paused incoming postcopy migration using the *uri*.
970 ERST
973 .name = "migrate_pause",
974 .args_type = "",
975 .params = "",
976 .help = "Pause an ongoing migration (postcopy-only)",
977 .cmd = hmp_migrate_pause,
980 SRST
981 ``migrate_pause``
982 Pause an ongoing migration. Currently it only supports postcopy.
983 ERST
986 .name = "migrate_set_cache_size",
987 .args_type = "value:o",
988 .params = "value",
989 .help = "set cache size (in bytes) for XBZRLE migrations,"
990 "the cache size will be rounded down to the nearest "
991 "power of 2.\n"
992 "The cache size affects the number of cache misses."
993 "In case of a high cache miss ratio you need to increase"
994 " the cache size",
995 .cmd = hmp_migrate_set_cache_size,
998 SRST
999 ``migrate_set_cache_size`` *value*
1000 Set cache size to *value* (in bytes) for xbzrle migrations.
1001 ERST
1004 .name = "migrate_set_speed",
1005 .args_type = "value:o",
1006 .params = "value",
1007 .help = "set maximum speed (in bytes) for migrations. "
1008 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1009 .cmd = hmp_migrate_set_speed,
1012 SRST
1013 ``migrate_set_speed`` *value*
1014 Set maximum speed to *value* (in bytes) for migrations.
1015 ERST
1018 .name = "migrate_set_downtime",
1019 .args_type = "value:T",
1020 .params = "value",
1021 .help = "set maximum tolerated downtime (in seconds) for migrations",
1022 .cmd = hmp_migrate_set_downtime,
1025 SRST
1026 ``migrate_set_downtime`` *second*
1027 Set maximum tolerated downtime (in seconds) for migration.
1028 ERST
1031 .name = "migrate_set_capability",
1032 .args_type = "capability:s,state:b",
1033 .params = "capability state",
1034 .help = "Enable/Disable the usage of a capability for migration",
1035 .cmd = hmp_migrate_set_capability,
1036 .command_completion = migrate_set_capability_completion,
1039 SRST
1040 ``migrate_set_capability`` *capability* *state*
1041 Enable/Disable the usage of a capability *capability* for migration.
1042 ERST
1045 .name = "migrate_set_parameter",
1046 .args_type = "parameter:s,value:s",
1047 .params = "parameter value",
1048 .help = "Set the parameter for migration",
1049 .cmd = hmp_migrate_set_parameter,
1050 .command_completion = migrate_set_parameter_completion,
1053 SRST
1054 ``migrate_set_parameter`` *parameter* *value*
1055 Set the parameter *parameter* for migration.
1056 ERST
1059 .name = "migrate_start_postcopy",
1060 .args_type = "",
1061 .params = "",
1062 .help = "Followup to a migration command to switch the migration"
1063 " to postcopy mode. The postcopy-ram capability must "
1064 "be set on both source and destination before the "
1065 "original migration command .",
1066 .cmd = hmp_migrate_start_postcopy,
1069 SRST
1070 ``migrate_start_postcopy``
1071 Switch in-progress migration to postcopy mode. Ignored after the end of
1072 migration (or once already in postcopy).
1073 ERST
1076 .name = "x_colo_lost_heartbeat",
1077 .args_type = "",
1078 .params = "",
1079 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1080 "a failover or takeover is needed.",
1081 .cmd = hmp_x_colo_lost_heartbeat,
1084 SRST
1085 ``x_colo_lost_heartbeat``
1086 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1087 ERST
1090 .name = "client_migrate_info",
1091 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1092 .params = "protocol hostname port tls-port cert-subject",
1093 .help = "set migration information for remote display",
1094 .cmd = hmp_client_migrate_info,
1097 SRST
1098 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1099 Set migration information for remote display. This makes the server
1100 ask the client to automatically reconnect using the new parameters
1101 once migration finished successfully. Only implemented for SPICE.
1102 ERST
1105 .name = "dump-guest-memory",
1106 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1107 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1108 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1109 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1110 "-d: return immediately (do not wait for completion).\n\t\t\t"
1111 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1112 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1113 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1114 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1115 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1116 "begin: the starting physical address.\n\t\t\t"
1117 "length: the memory size, in bytes.",
1118 .cmd = hmp_dump_guest_memory,
1121 SRST
1122 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1124 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1125 Dump guest memory to *protocol*. The file can be processed with crash or
1126 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1128 ``-p``
1129 do paging to get guest's memory mapping.
1130 ``-z``
1131 dump in kdump-compressed format, with zlib compression.
1132 ``-l``
1133 dump in kdump-compressed format, with lzo compression.
1134 ``-s``
1135 dump in kdump-compressed format, with snappy compression.
1136 ``-w``
1137 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1138 for Windows x64 guests with vmcoreinfo driver only
1139 *filename*
1140 dump file name.
1141 *begin*
1142 the starting physical address. It's optional, and should be
1143 specified together with *length*.
1144 *length*
1145 the memory size, in bytes. It's optional, and should be specified
1146 together with *begin*.
1148 ERST
1150 #if defined(TARGET_S390X)
1152 .name = "dump-skeys",
1153 .args_type = "filename:F",
1154 .params = "",
1155 .help = "Save guest storage keys into file 'filename'.\n",
1156 .cmd = hmp_dump_skeys,
1158 #endif
1160 SRST
1161 ``dump-skeys`` *filename*
1162 Save guest storage keys to a file.
1163 ERST
1165 #if defined(TARGET_S390X)
1167 .name = "migration_mode",
1168 .args_type = "mode:i",
1169 .params = "mode",
1170 .help = "Enables or disables migration mode\n",
1171 .cmd = hmp_migrationmode,
1173 #endif
1175 SRST
1176 ``migration_mode`` *mode*
1177 Enables or disables migration mode.
1178 ERST
1181 .name = "snapshot_blkdev",
1182 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1183 .params = "[-n] device [new-image-file] [format]",
1184 .help = "initiates a live snapshot\n\t\t\t"
1185 "of device. If a new image file is specified, the\n\t\t\t"
1186 "new image file will become the new root image.\n\t\t\t"
1187 "If format is specified, the snapshot file will\n\t\t\t"
1188 "be created in that format.\n\t\t\t"
1189 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1190 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1191 "recreating it from scratch.",
1192 .cmd = hmp_snapshot_blkdev,
1195 SRST
1196 ``snapshot_blkdev``
1197 Snapshot device, using snapshot file as target if provided
1198 ERST
1201 .name = "snapshot_blkdev_internal",
1202 .args_type = "device:B,name:s",
1203 .params = "device name",
1204 .help = "take an internal snapshot of device.\n\t\t\t"
1205 "The format of the image used by device must\n\t\t\t"
1206 "support it, such as qcow2.\n\t\t\t",
1207 .cmd = hmp_snapshot_blkdev_internal,
1210 SRST
1211 ``snapshot_blkdev_internal``
1212 Take an internal snapshot on device if it support
1213 ERST
1216 .name = "snapshot_delete_blkdev_internal",
1217 .args_type = "device:B,name:s,id:s?",
1218 .params = "device name [id]",
1219 .help = "delete an internal snapshot of device.\n\t\t\t"
1220 "If id is specified, qemu will try delete\n\t\t\t"
1221 "the snapshot matching both id and name.\n\t\t\t"
1222 "The format of the image used by device must\n\t\t\t"
1223 "support it, such as qcow2.\n\t\t\t",
1224 .cmd = hmp_snapshot_delete_blkdev_internal,
1227 SRST
1228 ``snapshot_delete_blkdev_internal``
1229 Delete an internal snapshot on device if it support
1230 ERST
1233 .name = "drive_mirror",
1234 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1235 .params = "[-n] [-f] device target [format]",
1236 .help = "initiates live storage\n\t\t\t"
1237 "migration for a device. The device's contents are\n\t\t\t"
1238 "copied to the new image file, including data that\n\t\t\t"
1239 "is written after the command is started.\n\t\t\t"
1240 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1241 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1242 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1243 "so that the result does not need a backing file.\n\t\t\t",
1244 .cmd = hmp_drive_mirror,
1246 SRST
1247 ``drive_mirror``
1248 Start mirroring a block device's writes to a new destination,
1249 using the specified target.
1250 ERST
1253 .name = "drive_backup",
1254 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1255 .params = "[-n] [-f] [-c] device target [format]",
1256 .help = "initiates a point-in-time\n\t\t\t"
1257 "copy for a device. The device's contents are\n\t\t\t"
1258 "copied to the new image file, excluding data that\n\t\t\t"
1259 "is written after the command is started.\n\t\t\t"
1260 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1261 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1262 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1263 "so that the result does not need a backing file.\n\t\t\t"
1264 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1265 "(if the target format supports it).\n\t\t\t",
1266 .cmd = hmp_drive_backup,
1268 SRST
1269 ``drive_backup``
1270 Start a point-in-time copy of a block device to a specificed target.
1271 ERST
1274 .name = "drive_add",
1275 .args_type = "node:-n,pci_addr:s,opts:s",
1276 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1277 "[file=file][,if=type][,bus=n]\n"
1278 "[,unit=m][,media=d][,index=i]\n"
1279 "[,snapshot=on|off][,cache=on|off]\n"
1280 "[,readonly=on|off][,copy-on-read=on|off]",
1281 .help = "add drive to PCI storage controller",
1282 .cmd = hmp_drive_add,
1285 SRST
1286 ``drive_add``
1287 Add drive to PCI storage controller.
1288 ERST
1291 .name = "pcie_aer_inject_error",
1292 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1293 "id:s,error_status:s,"
1294 "header0:i?,header1:i?,header2:i?,header3:i?,"
1295 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1296 .params = "[-a] [-c] id "
1297 "<error_status> [<tlp header> [<tlp header prefix>]]",
1298 .help = "inject pcie aer error\n\t\t\t"
1299 " -a for advisory non fatal error\n\t\t\t"
1300 " -c for correctable error\n\t\t\t"
1301 "<id> = qdev device id\n\t\t\t"
1302 "<error_status> = error string or 32bit\n\t\t\t"
1303 "<tlb header> = 32bit x 4\n\t\t\t"
1304 "<tlb header prefix> = 32bit x 4",
1305 .cmd = hmp_pcie_aer_inject_error,
1308 SRST
1309 ``pcie_aer_inject_error``
1310 Inject PCIe AER error
1311 ERST
1314 .name = "netdev_add",
1315 .args_type = "netdev:O",
1316 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1317 .help = "add host network device",
1318 .cmd = hmp_netdev_add,
1319 .command_completion = netdev_add_completion,
1322 SRST
1323 ``netdev_add``
1324 Add host network device.
1325 ERST
1328 .name = "netdev_del",
1329 .args_type = "id:s",
1330 .params = "id",
1331 .help = "remove host network device",
1332 .cmd = hmp_netdev_del,
1333 .command_completion = netdev_del_completion,
1336 SRST
1337 ``netdev_del``
1338 Remove host network device.
1339 ERST
1342 .name = "object_add",
1343 .args_type = "object:O",
1344 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1345 .help = "create QOM object",
1346 .cmd = hmp_object_add,
1347 .command_completion = object_add_completion,
1350 SRST
1351 ``object_add``
1352 Create QOM object.
1353 ERST
1356 .name = "object_del",
1357 .args_type = "id:s",
1358 .params = "id",
1359 .help = "destroy QOM object",
1360 .cmd = hmp_object_del,
1361 .command_completion = object_del_completion,
1364 SRST
1365 ``object_del``
1366 Destroy QOM object.
1367 ERST
1369 #ifdef CONFIG_SLIRP
1371 .name = "hostfwd_add",
1372 .args_type = "arg1:s,arg2:s?",
1373 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1374 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1375 .cmd = hmp_hostfwd_add,
1377 #endif
1378 SRST
1379 ``hostfwd_add``
1380 Redirect TCP or UDP connections from host to guest (requires -net user).
1381 ERST
1383 #ifdef CONFIG_SLIRP
1385 .name = "hostfwd_remove",
1386 .args_type = "arg1:s,arg2:s?",
1387 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1388 .help = "remove host-to-guest TCP or UDP redirection",
1389 .cmd = hmp_hostfwd_remove,
1392 #endif
1393 SRST
1394 ``hostfwd_remove``
1395 Remove host-to-guest TCP or UDP redirection.
1396 ERST
1399 .name = "balloon",
1400 .args_type = "value:M",
1401 .params = "target",
1402 .help = "request VM to change its memory allocation (in MB)",
1403 .cmd = hmp_balloon,
1406 SRST
1407 ``balloon`` *value*
1408 Request VM to change its memory allocation to *value* (in MB).
1409 ERST
1412 .name = "set_link",
1413 .args_type = "name:s,up:b",
1414 .params = "name on|off",
1415 .help = "change the link status of a network adapter",
1416 .cmd = hmp_set_link,
1417 .command_completion = set_link_completion,
1420 SRST
1421 ``set_link`` *name* ``[on|off]``
1422 Switch link *name* on (i.e. up) or off (i.e. down).
1423 ERST
1426 .name = "watchdog_action",
1427 .args_type = "action:s",
1428 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1429 .help = "change watchdog action",
1430 .cmd = hmp_watchdog_action,
1431 .command_completion = watchdog_action_completion,
1434 SRST
1435 ``watchdog_action``
1436 Change watchdog action.
1437 ERST
1440 .name = "acl_show",
1441 .args_type = "aclname:s",
1442 .params = "aclname",
1443 .help = "list rules in the access control list",
1444 .cmd = hmp_acl_show,
1447 SRST
1448 ``acl_show`` *aclname*
1449 List all the matching rules in the access control list, and the default
1450 policy. There are currently two named access control lists,
1451 *vnc.x509dname* and *vnc.username* matching on the x509 client
1452 certificate distinguished name, and SASL username respectively.
1453 ERST
1456 .name = "acl_policy",
1457 .args_type = "aclname:s,policy:s",
1458 .params = "aclname allow|deny",
1459 .help = "set default access control list policy",
1460 .cmd = hmp_acl_policy,
1463 SRST
1464 ``acl_policy`` *aclname* ``allow|deny``
1465 Set the default access control list policy, used in the event that
1466 none of the explicit rules match. The default policy at startup is
1467 always ``deny``.
1468 ERST
1471 .name = "acl_add",
1472 .args_type = "aclname:s,match:s,policy:s,index:i?",
1473 .params = "aclname match allow|deny [index]",
1474 .help = "add a match rule to the access control list",
1475 .cmd = hmp_acl_add,
1478 SRST
1479 ``acl_add`` *aclname* *match* ``allow|deny`` [*index*]
1480 Add a match rule to the access control list, allowing or denying access.
1481 The match will normally be an exact username or x509 distinguished name,
1482 but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to
1483 allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will
1484 normally be appended to the end of the ACL, but can be inserted
1485 earlier in the list if the optional *index* parameter is supplied.
1486 ERST
1489 .name = "acl_remove",
1490 .args_type = "aclname:s,match:s",
1491 .params = "aclname match",
1492 .help = "remove a match rule from the access control list",
1493 .cmd = hmp_acl_remove,
1496 SRST
1497 ``acl_remove`` *aclname* *match*
1498 Remove the specified match rule from the access control list.
1499 ERST
1502 .name = "acl_reset",
1503 .args_type = "aclname:s",
1504 .params = "aclname",
1505 .help = "reset the access control list",
1506 .cmd = hmp_acl_reset,
1509 SRST
1510 ``acl_reset`` *aclname*
1511 Remove all matches from the access control list, and set the default
1512 policy back to ``deny``.
1513 ERST
1516 .name = "nbd_server_start",
1517 .args_type = "all:-a,writable:-w,uri:s",
1518 .params = "nbd_server_start [-a] [-w] host:port",
1519 .help = "serve block devices on the given host and port",
1520 .cmd = hmp_nbd_server_start,
1522 SRST
1523 ``nbd_server_start`` *host*:*port*
1524 Start an NBD server on the given host and/or port. If the ``-a``
1525 option is included, all of the virtual machine's block devices that
1526 have an inserted media on them are automatically exported; in this case,
1527 the ``-w`` option makes the devices writable too.
1528 ERST
1531 .name = "nbd_server_add",
1532 .args_type = "writable:-w,device:B,name:s?",
1533 .params = "nbd_server_add [-w] device [name]",
1534 .help = "export a block device via NBD",
1535 .cmd = hmp_nbd_server_add,
1537 SRST
1538 ``nbd_server_add`` *device* [ *name* ]
1539 Export a block device through QEMU's NBD server, which must be started
1540 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1541 exported device writable too. The export name is controlled by *name*,
1542 defaulting to *device*.
1543 ERST
1546 .name = "nbd_server_remove",
1547 .args_type = "force:-f,name:s",
1548 .params = "nbd_server_remove [-f] name",
1549 .help = "remove an export previously exposed via NBD",
1550 .cmd = hmp_nbd_server_remove,
1552 SRST
1553 ``nbd_server_remove [-f]`` *name*
1554 Stop exporting a block device through QEMU's NBD server, which was
1555 previously started with ``nbd_server_add``. The ``-f``
1556 option forces the server to drop the export immediately even if
1557 clients are connected; otherwise the command fails unless there are no
1558 clients.
1559 ERST
1562 .name = "nbd_server_stop",
1563 .args_type = "",
1564 .params = "nbd_server_stop",
1565 .help = "stop serving block devices using the NBD protocol",
1566 .cmd = hmp_nbd_server_stop,
1568 SRST
1569 ``nbd_server_stop``
1570 Stop the QEMU embedded NBD server.
1571 ERST
1574 #if defined(TARGET_I386)
1577 .name = "mce",
1578 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1579 .params = "[-b] cpu bank status mcgstatus addr misc",
1580 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1581 .cmd = hmp_mce,
1584 #endif
1585 SRST
1586 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1587 Inject an MCE on the given CPU (x86 only).
1588 ERST
1591 .name = "getfd",
1592 .args_type = "fdname:s",
1593 .params = "getfd name",
1594 .help = "receive a file descriptor via SCM rights and assign it a name",
1595 .cmd = hmp_getfd,
1598 SRST
1599 ``getfd`` *fdname*
1600 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1601 mechanism on unix sockets, it is stored using the name *fdname* for
1602 later use by other monitor commands.
1603 ERST
1606 .name = "closefd",
1607 .args_type = "fdname:s",
1608 .params = "closefd name",
1609 .help = "close a file descriptor previously passed via SCM rights",
1610 .cmd = hmp_closefd,
1613 SRST
1614 ``closefd`` *fdname*
1615 Close the file descriptor previously assigned to *fdname* using the
1616 ``getfd`` command. This is only needed if the file descriptor was never
1617 used by another monitor command.
1618 ERST
1621 .name = "block_passwd",
1622 .args_type = "device:B,password:s",
1623 .params = "block_passwd device password",
1624 .help = "set the password of encrypted block devices",
1625 .cmd = hmp_block_passwd,
1628 SRST
1629 ``block_passwd`` *device* *password*
1630 Set the encrypted device *device* password to *password*
1632 This command is now obsolete and will always return an error since 2.10
1633 ERST
1636 .name = "block_set_io_throttle",
1637 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1638 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1639 .help = "change I/O throttle limits for a block drive",
1640 .cmd = hmp_block_set_io_throttle,
1643 SRST
1644 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1645 Change I/O throttle limits for a block drive to
1646 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1647 *device* can be a block device name, a qdev ID or a QOM path.
1648 ERST
1651 .name = "set_password",
1652 .args_type = "protocol:s,password:s,connected:s?",
1653 .params = "protocol password action-if-connected",
1654 .help = "set spice/vnc password",
1655 .cmd = hmp_set_password,
1658 SRST
1659 ``set_password [ vnc | spice ] password [ action-if-connected ]``
1660 Change spice/vnc password. Use zero to make the password stay valid
1661 forever. *action-if-connected* specifies what should happen in
1662 case a connection is established: *fail* makes the password change
1663 fail. *disconnect* changes the password and disconnects the
1664 client. *keep* changes the password and keeps the connection up.
1665 *keep* is the default.
1666 ERST
1669 .name = "expire_password",
1670 .args_type = "protocol:s,time:s",
1671 .params = "protocol time",
1672 .help = "set spice/vnc password expire-time",
1673 .cmd = hmp_expire_password,
1676 SRST
1677 ``expire_password [ vnc | spice ]`` *expire-time*
1678 Specify when a password for spice/vnc becomes
1679 invalid. *expire-time* accepts:
1681 ``now``
1682 Invalidate password instantly.
1683 ``never``
1684 Password stays valid forever.
1685 ``+``\ *nsec*
1686 Password stays valid for *nsec* seconds starting now.
1687 *nsec*
1688 Password is invalidated at the given time. *nsec* are the seconds
1689 passed since 1970, i.e. unix epoch.
1691 ERST
1694 .name = "chardev-add",
1695 .args_type = "args:s",
1696 .params = "args",
1697 .help = "add chardev",
1698 .cmd = hmp_chardev_add,
1699 .command_completion = chardev_add_completion,
1702 SRST
1703 ``chardev-add`` *args*
1704 chardev-add accepts the same parameters as the -chardev command line switch.
1705 ERST
1708 .name = "chardev-change",
1709 .args_type = "id:s,args:s",
1710 .params = "id args",
1711 .help = "change chardev",
1712 .cmd = hmp_chardev_change,
1715 SRST
1716 ``chardev-change`` *args*
1717 chardev-change accepts existing chardev *id* and then the same arguments
1718 as the -chardev command line switch (except for "id").
1719 ERST
1722 .name = "chardev-remove",
1723 .args_type = "id:s",
1724 .params = "id",
1725 .help = "remove chardev",
1726 .cmd = hmp_chardev_remove,
1727 .command_completion = chardev_remove_completion,
1730 SRST
1731 ``chardev-remove`` *id*
1732 Removes the chardev *id*.
1733 ERST
1736 .name = "chardev-send-break",
1737 .args_type = "id:s",
1738 .params = "id",
1739 .help = "send a break on chardev",
1740 .cmd = hmp_chardev_send_break,
1741 .command_completion = chardev_remove_completion,
1744 SRST
1745 ``chardev-send-break`` *id*
1746 Send a break on the chardev *id*.
1747 ERST
1750 .name = "qemu-io",
1751 .args_type = "qdev:-d,device:B,command:s",
1752 .params = "[-d] [device] \"[command]\"",
1753 .help = "run a qemu-io command on a block device\n\t\t\t"
1754 "-d: [device] is a device ID rather than a "
1755 "drive ID or node name",
1756 .cmd = hmp_qemu_io,
1759 SRST
1760 ``qemu-io`` *device* *command*
1761 Executes a qemu-io command on the given block device.
1762 ERST
1765 .name = "cpu-add",
1766 .args_type = "id:i",
1767 .params = "id",
1768 .help = "add cpu (deprecated, use device_add instead)",
1769 .cmd = hmp_cpu_add,
1772 SRST
1773 ``cpu-add`` *id*
1774 Add CPU with id *id*. This command is deprecated, please
1775 +use ``device_add`` instead. For details, refer to
1776 'docs/cpu-hotplug.rst'.
1777 ERST
1780 .name = "qom-list",
1781 .args_type = "path:s?",
1782 .params = "path",
1783 .help = "list QOM properties",
1784 .cmd = hmp_qom_list,
1785 .flags = "p",
1788 SRST
1789 ``qom-list`` [*path*]
1790 Print QOM properties of object at location *path*
1791 ERST
1794 .name = "qom-set",
1795 .args_type = "path:s,property:s,value:s",
1796 .params = "path property value",
1797 .help = "set QOM property",
1798 .cmd = hmp_qom_set,
1799 .flags = "p",
1802 SRST
1803 ``qom-set`` *path* *property* *value*
1804 Set QOM property *property* of object at location *path* to value *value*
1805 ERST
1808 .name = "info",
1809 .args_type = "item:s?",
1810 .params = "[subcommand]",
1811 .help = "show various information about the system state",
1812 .cmd = hmp_info_help,
1813 .sub_table = hmp_info_cmds,
1814 .flags = "p",