target/mips: Simplify decode_opc_mxu() ifdef'ry
[qemu/ar7.git] / hmp-commands.hx
blobd4001f9c5dc6015cde83491fa253faa039527e0d
1 HXCOMM Use DEFHEADING() to define headings in both help text and rST.
2 HXCOMM Text between SRST and ERST is copied to the rST 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 rST 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 = "quit|q",
44 .args_type = "",
45 .params = "",
46 .help = "quit the emulator",
47 .cmd = hmp_quit,
48 .flags = "p",
51 SRST
52 ``quit`` or ``q``
53 Quit the emulator.
54 ERST
57 .name = "exit_preconfig",
58 .args_type = "",
59 .params = "",
60 .help = "exit the preconfig state",
61 .cmd = hmp_exit_preconfig,
62 .flags = "p",
65 SRST
66 ``exit_preconfig``
67 This command makes QEMU exit the preconfig state and proceed with
68 VM initialization using configuration data provided on the command line
69 and via the QMP monitor during the preconfig state. The command is only
70 available during the preconfig state (i.e. when the --preconfig command
71 line option was in use).
72 ERST
75 .name = "block_resize",
76 .args_type = "device:B,size:o",
77 .params = "device size",
78 .help = "resize a block image",
79 .cmd = hmp_block_resize,
80 .coroutine = true,
83 SRST
84 ``block_resize``
85 Resize a block image while a guest is running. Usually requires guest
86 action to see the updated size. Resize to a lower size is supported,
87 but should be used with extreme caution. Note that this command only
88 resizes image files, it can not resize block devices like LVM volumes.
89 ERST
92 .name = "block_stream",
93 .args_type = "device:B,speed:o?,base:s?",
94 .params = "device [speed [base]]",
95 .help = "copy data from a backing file into a block device",
96 .cmd = hmp_block_stream,
99 SRST
100 ``block_stream``
101 Copy data from a backing file into a block device.
102 ERST
105 .name = "block_job_set_speed",
106 .args_type = "device:B,speed:o",
107 .params = "device speed",
108 .help = "set maximum speed for a background block operation",
109 .cmd = hmp_block_job_set_speed,
112 SRST
113 ``block_job_set_speed``
114 Set maximum speed for a background block operation.
115 ERST
118 .name = "block_job_cancel",
119 .args_type = "force:-f,device:B",
120 .params = "[-f] device",
121 .help = "stop an active background block operation (use -f"
122 "\n\t\t\t if you want to abort the operation immediately"
123 "\n\t\t\t instead of keep running until data is in sync)",
124 .cmd = hmp_block_job_cancel,
127 SRST
128 ``block_job_cancel``
129 Stop an active background block operation (streaming, mirroring).
130 ERST
133 .name = "block_job_complete",
134 .args_type = "device:B",
135 .params = "device",
136 .help = "stop an active background block operation",
137 .cmd = hmp_block_job_complete,
140 SRST
141 ``block_job_complete``
142 Manually trigger completion of an active background block operation.
143 For mirroring, this will switch the device to the destination path.
144 ERST
147 .name = "block_job_pause",
148 .args_type = "device:B",
149 .params = "device",
150 .help = "pause an active background block operation",
151 .cmd = hmp_block_job_pause,
154 SRST
155 ``block_job_pause``
156 Pause an active block streaming operation.
157 ERST
160 .name = "block_job_resume",
161 .args_type = "device:B",
162 .params = "device",
163 .help = "resume a paused background block operation",
164 .cmd = hmp_block_job_resume,
167 SRST
168 ``block_job_resume``
169 Resume a paused block streaming operation.
170 ERST
173 .name = "eject",
174 .args_type = "force:-f,device:B",
175 .params = "[-f] device",
176 .help = "eject a removable medium (use -f to force it)",
177 .cmd = hmp_eject,
180 SRST
181 ``eject [-f]`` *device*
182 Eject a removable medium (use -f to force it).
183 ERST
186 .name = "drive_del",
187 .args_type = "id:B",
188 .params = "device",
189 .help = "remove host block device",
190 .cmd = hmp_drive_del,
193 SRST
194 ``drive_del`` *device*
195 Remove host block device. The result is that guest generated IO is no longer
196 submitted against the host device underlying the disk. Once a drive has
197 been deleted, the QEMU Block layer returns -EIO which results in IO
198 errors in the guest for applications that are reading/writing to the device.
199 These errors are always reported to the guest, regardless of the drive's error
200 actions (drive options rerror, werror).
201 ERST
204 .name = "change",
205 .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
206 .params = "device filename [format [read-only-mode]]",
207 .help = "change a removable medium, optional format",
208 .cmd = hmp_change,
211 SRST
212 ``change`` *device* *setting*
213 Change the configuration of a device.
215 ``change`` *diskdevice* *filename* [*format* [*read-only-mode*]]
216 Change the medium for a removable disk device to point to *filename*. eg::
218 (qemu) change ide1-cd0 /path/to/some.iso
220 *format* is optional.
222 *read-only-mode* may be used to change the read-only status of the device.
223 It accepts the following values:
225 retain
226 Retains the current status; this is the default.
228 read-only
229 Makes the device read-only.
231 read-write
232 Makes the device writable.
234 ``change vnc password`` [*password*]
236 Change the password associated with the VNC server. If the new password
237 is not supplied, the monitor will prompt for it to be entered. VNC
238 passwords are only significant up to 8 letters. eg::
240 (qemu) change vnc password
241 Password: ********
243 ERST
246 .name = "screendump",
247 .args_type = "filename:F,device:s?,head:i?",
248 .params = "filename [device [head]]",
249 .help = "save screen from head 'head' of display device 'device' "
250 "into PPM image 'filename'",
251 .cmd = hmp_screendump,
252 .coroutine = true,
255 SRST
256 ``screendump`` *filename*
257 Save screen into PPM image *filename*.
258 ERST
261 .name = "logfile",
262 .args_type = "filename:F",
263 .params = "filename",
264 .help = "output logs to 'filename'",
265 .cmd = hmp_logfile,
268 SRST
269 ``logfile`` *filename*
270 Output logs to *filename*.
271 ERST
274 .name = "trace-event",
275 .args_type = "name:s,option:b,vcpu:i?",
276 .params = "name on|off [vcpu]",
277 .help = "changes status of a specific trace event "
278 "(vcpu: vCPU to set, default is all)",
279 .cmd = hmp_trace_event,
280 .command_completion = trace_event_completion,
283 SRST
284 ``trace-event``
285 changes status of a trace event
286 ERST
288 #if defined(CONFIG_TRACE_SIMPLE)
290 .name = "trace-file",
291 .args_type = "op:s?,arg:F?",
292 .params = "on|off|flush|set [arg]",
293 .help = "open, close, or flush trace file, or set a new file name",
294 .cmd = hmp_trace_file,
297 SRST
298 ``trace-file on|off|flush``
299 Open, close, or flush the trace file. If no argument is given, the
300 status of the trace file is displayed.
301 ERST
302 #endif
305 .name = "log",
306 .args_type = "items:s",
307 .params = "item1[,...]",
308 .help = "activate logging of the specified items",
309 .cmd = hmp_log,
312 SRST
313 ``log`` *item1*\ [,...]
314 Activate logging of the specified items.
315 ERST
318 .name = "savevm",
319 .args_type = "name:s?",
320 .params = "tag",
321 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
322 .cmd = hmp_savevm,
325 SRST
326 ``savevm`` *tag*
327 Create a snapshot of the whole virtual machine. If *tag* is
328 provided, it is used as human readable identifier. If there is already
329 a snapshot with the same tag, it is replaced. More info at
330 :ref:`vm_005fsnapshots`.
332 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
333 only *tag* as parameter.
334 ERST
337 .name = "loadvm",
338 .args_type = "name:s",
339 .params = "tag",
340 .help = "restore a VM snapshot from its tag",
341 .cmd = hmp_loadvm,
342 .command_completion = loadvm_completion,
345 SRST
346 ``loadvm`` *tag*
347 Set the whole virtual machine to the snapshot identified by the tag
348 *tag*.
350 Since 4.0, loadvm stopped accepting snapshot id as parameter.
351 ERST
354 .name = "delvm",
355 .args_type = "name:s",
356 .params = "tag",
357 .help = "delete a VM snapshot from its tag",
358 .cmd = hmp_delvm,
359 .command_completion = delvm_completion,
362 SRST
363 ``delvm`` *tag*
364 Delete the snapshot identified by *tag*.
366 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
367 only *tag* as parameter.
368 ERST
371 .name = "singlestep",
372 .args_type = "option:s?",
373 .params = "[on|off]",
374 .help = "run emulation in singlestep mode or switch to normal mode",
375 .cmd = hmp_singlestep,
378 SRST
379 ``singlestep [off]``
380 Run the emulation in single step mode.
381 If called with option off, the emulation returns to normal mode.
382 ERST
385 .name = "stop",
386 .args_type = "",
387 .params = "",
388 .help = "stop emulation",
389 .cmd = hmp_stop,
392 SRST
393 ``stop``
394 Stop emulation.
395 ERST
398 .name = "cont|c",
399 .args_type = "",
400 .params = "",
401 .help = "resume emulation",
402 .cmd = hmp_cont,
405 SRST
406 ``cont`` or ``c``
407 Resume emulation.
408 ERST
411 .name = "system_wakeup",
412 .args_type = "",
413 .params = "",
414 .help = "wakeup guest from suspend",
415 .cmd = hmp_system_wakeup,
418 SRST
419 ``system_wakeup``
420 Wakeup guest from suspend.
421 ERST
424 .name = "gdbserver",
425 .args_type = "device:s?",
426 .params = "[device]",
427 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
428 .cmd = hmp_gdbserver,
431 SRST
432 ``gdbserver`` [*port*]
433 Start gdbserver session (default *port*\=1234)
434 ERST
437 .name = "x",
438 .args_type = "fmt:/,addr:l",
439 .params = "/fmt addr",
440 .help = "virtual memory dump starting at 'addr'",
441 .cmd = hmp_memory_dump,
444 SRST
445 ``x/``\ *fmt* *addr*
446 Virtual memory dump starting at *addr*.
447 ERST
450 .name = "xp",
451 .args_type = "fmt:/,addr:l",
452 .params = "/fmt addr",
453 .help = "physical memory dump starting at 'addr'",
454 .cmd = hmp_physical_memory_dump,
457 SRST
458 ``xp /``\ *fmt* *addr*
459 Physical memory dump starting at *addr*.
461 *fmt* is a format which tells the command how to format the
462 data. Its syntax is: ``/{count}{format}{size}``
464 *count*
465 is the number of items to be dumped.
466 *format*
467 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
468 c (char) or i (asm instruction).
469 *size*
470 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
471 ``h`` or ``w`` can be specified with the ``i`` format to
472 respectively select 16 or 32 bit code instruction size.
474 Examples:
476 Dump 10 instructions at the current instruction pointer::
478 (qemu) x/10i $eip
479 0x90107063: ret
480 0x90107064: sti
481 0x90107065: lea 0x0(%esi,1),%esi
482 0x90107069: lea 0x0(%edi,1),%edi
483 0x90107070: ret
484 0x90107071: jmp 0x90107080
485 0x90107073: nop
486 0x90107074: nop
487 0x90107075: nop
488 0x90107076: nop
490 Dump 80 16 bit values at the start of the video memory::
492 (qemu) xp/80hx 0xb8000
493 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
494 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
495 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
496 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
497 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
498 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
499 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
500 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
501 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
502 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
504 ERST
507 .name = "gpa2hva",
508 .args_type = "addr:l",
509 .params = "addr",
510 .help = "print the host virtual address corresponding to a guest physical address",
511 .cmd = hmp_gpa2hva,
514 SRST
515 ``gpa2hva`` *addr*
516 Print the host virtual address at which the guest's physical address *addr*
517 is mapped.
518 ERST
520 #ifdef CONFIG_LINUX
522 .name = "gpa2hpa",
523 .args_type = "addr:l",
524 .params = "addr",
525 .help = "print the host physical address corresponding to a guest physical address",
526 .cmd = hmp_gpa2hpa,
528 #endif
530 SRST
531 ``gpa2hpa`` *addr*
532 Print the host physical address at which the guest's physical address *addr*
533 is mapped.
534 ERST
537 .name = "gva2gpa",
538 .args_type = "addr:l",
539 .params = "addr",
540 .help = "print the guest physical address corresponding to a guest virtual address",
541 .cmd = hmp_gva2gpa,
544 SRST
545 ``gva2gpa`` *addr*
546 Print the guest physical address at which the guest's virtual address *addr*
547 is mapped based on the mapping for the current CPU.
548 ERST
551 .name = "print|p",
552 .args_type = "fmt:/,val:l",
553 .params = "/fmt expr",
554 .help = "print expression value (use $reg for CPU register access)",
555 .cmd = do_print,
558 SRST
559 ``print`` or ``p/``\ *fmt* *expr*
560 Print expression value. Only the *format* part of *fmt* is
561 used.
562 ERST
565 .name = "i",
566 .args_type = "fmt:/,addr:i,index:i.",
567 .params = "/fmt addr",
568 .help = "I/O port read",
569 .cmd = hmp_ioport_read,
572 SRST
573 ``i/``\ *fmt* *addr* [.\ *index*\ ]
574 Read I/O port.
575 ERST
578 .name = "o",
579 .args_type = "fmt:/,addr:i,val:i",
580 .params = "/fmt addr value",
581 .help = "I/O port write",
582 .cmd = hmp_ioport_write,
585 SRST
586 ``o/``\ *fmt* *addr* *val*
587 Write to I/O port.
588 ERST
591 .name = "sendkey",
592 .args_type = "keys:s,hold-time:i?",
593 .params = "keys [hold_ms]",
594 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
595 .cmd = hmp_sendkey,
596 .command_completion = sendkey_completion,
599 SRST
600 ``sendkey`` *keys*
601 Send *keys* to the guest. *keys* could be the name of the
602 key or the raw value in hexadecimal format. Use ``-`` to press
603 several keys simultaneously. Example::
605 sendkey ctrl-alt-f1
607 This command is useful to send keys that your graphical user interface
608 intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
609 ERST
611 .name = "sync-profile",
612 .args_type = "op:s?",
613 .params = "[on|off|reset]",
614 .help = "enable, disable or reset synchronization profiling. "
615 "With no arguments, prints whether profiling is on or off.",
616 .cmd = hmp_sync_profile,
619 SRST
620 ``sync-profile [on|off|reset]``
621 Enable, disable or reset synchronization profiling. With no arguments, prints
622 whether profiling is on or off.
623 ERST
626 .name = "system_reset",
627 .args_type = "",
628 .params = "",
629 .help = "reset the system",
630 .cmd = hmp_system_reset,
633 SRST
634 ``system_reset``
635 Reset the system.
636 ERST
639 .name = "system_powerdown",
640 .args_type = "",
641 .params = "",
642 .help = "send system power down event",
643 .cmd = hmp_system_powerdown,
646 SRST
647 ``system_powerdown``
648 Power down the system (if supported).
649 ERST
652 .name = "sum",
653 .args_type = "start:i,size:i",
654 .params = "addr size",
655 .help = "compute the checksum of a memory region",
656 .cmd = hmp_sum,
659 SRST
660 ``sum`` *addr* *size*
661 Compute the checksum of a memory region.
662 ERST
665 .name = "device_add",
666 .args_type = "device:O",
667 .params = "driver[,prop=value][,...]",
668 .help = "add device, like -device on the command line",
669 .cmd = hmp_device_add,
670 .command_completion = device_add_completion,
673 SRST
674 ``device_add`` *config*
675 Add device.
676 ERST
679 .name = "device_del",
680 .args_type = "id:s",
681 .params = "device",
682 .help = "remove device",
683 .cmd = hmp_device_del,
684 .command_completion = device_del_completion,
687 SRST
688 ``device_del`` *id*
689 Remove device *id*. *id* may be a short ID
690 or a QOM object path.
691 ERST
694 .name = "cpu",
695 .args_type = "index:i",
696 .params = "index",
697 .help = "set the default CPU",
698 .cmd = hmp_cpu,
701 SRST
702 ``cpu`` *index*
703 Set the default CPU.
704 ERST
707 .name = "mouse_move",
708 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
709 .params = "dx dy [dz]",
710 .help = "send mouse move events",
711 .cmd = hmp_mouse_move,
714 SRST
715 ``mouse_move`` *dx* *dy* [*dz*]
716 Move the active mouse to the specified coordinates *dx* *dy*
717 with optional scroll axis *dz*.
718 ERST
721 .name = "mouse_button",
722 .args_type = "button_state:i",
723 .params = "state",
724 .help = "change mouse button state (1=L, 2=M, 4=R)",
725 .cmd = hmp_mouse_button,
728 SRST
729 ``mouse_button`` *val*
730 Change the active mouse button state *val* (1=L, 2=M, 4=R).
731 ERST
734 .name = "mouse_set",
735 .args_type = "index:i",
736 .params = "index",
737 .help = "set which mouse device receives events",
738 .cmd = hmp_mouse_set,
741 SRST
742 ``mouse_set`` *index*
743 Set which mouse device receives events at given *index*, index
744 can be obtained with::
746 info mice
748 ERST
751 .name = "wavcapture",
752 .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
753 .params = "path audiodev [frequency [bits [channels]]]",
754 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
755 .cmd = hmp_wavcapture,
757 SRST
758 ``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
759 Capture audio into *filename* from *audiodev*, using sample rate
760 *frequency* bits per sample *bits* and number of channels
761 *channels*.
763 Defaults:
765 - Sample rate = 44100 Hz - CD quality
766 - Bits = 16
767 - Number of channels = 2 - Stereo
768 ERST
771 .name = "stopcapture",
772 .args_type = "n:i",
773 .params = "capture index",
774 .help = "stop capture",
775 .cmd = hmp_stopcapture,
777 SRST
778 ``stopcapture`` *index*
779 Stop capture with a given *index*, index can be obtained with::
781 info capture
783 ERST
786 .name = "memsave",
787 .args_type = "val:l,size:i,filename:s",
788 .params = "addr size file",
789 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
790 .cmd = hmp_memsave,
793 SRST
794 ``memsave`` *addr* *size* *file*
795 save to disk virtual memory dump starting at *addr* of size *size*.
796 ERST
799 .name = "pmemsave",
800 .args_type = "val:l,size:i,filename:s",
801 .params = "addr size file",
802 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
803 .cmd = hmp_pmemsave,
806 SRST
807 ``pmemsave`` *addr* *size* *file*
808 save to disk physical memory dump starting at *addr* of size *size*.
809 ERST
812 .name = "boot_set",
813 .args_type = "bootdevice:s",
814 .params = "bootdevice",
815 .help = "define new values for the boot device list",
816 .cmd = hmp_boot_set,
819 SRST
820 ``boot_set`` *bootdevicelist*
821 Define new values for the boot device list. Those values will override
822 the values specified on the command line through the ``-boot`` option.
824 The values that can be specified here depend on the machine type, but are
825 the same that can be specified in the ``-boot`` command line option.
826 ERST
829 .name = "nmi",
830 .args_type = "",
831 .params = "",
832 .help = "inject an NMI",
833 .cmd = hmp_nmi,
835 SRST
836 ``nmi`` *cpu*
837 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
838 ERST
841 .name = "ringbuf_write",
842 .args_type = "device:s,data:s",
843 .params = "device data",
844 .help = "Write to a ring buffer character device",
845 .cmd = hmp_ringbuf_write,
846 .command_completion = ringbuf_write_completion,
849 SRST
850 ``ringbuf_write`` *device* *data*
851 Write *data* to ring buffer character device *device*.
852 *data* must be a UTF-8 string.
853 ERST
856 .name = "ringbuf_read",
857 .args_type = "device:s,size:i",
858 .params = "device size",
859 .help = "Read from a ring buffer character device",
860 .cmd = hmp_ringbuf_read,
861 .command_completion = ringbuf_write_completion,
864 SRST
865 ``ringbuf_read`` *device*
866 Read and print up to *size* bytes from ring buffer character
867 device *device*.
868 Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
869 character code in hexadecimal. Character ``\`` is printed ``\\``.
870 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
871 NUL characters, after the ring buffer lost data, and when reading
872 stops because the size limit is reached.
873 ERST
876 .name = "announce_self",
877 .args_type = "interfaces:s?,id:s?",
878 .params = "[interfaces] [id]",
879 .help = "Trigger GARP/RARP announcements",
880 .cmd = hmp_announce_self,
883 SRST
884 ``announce_self``
885 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
886 updating the network infrastructure after a reconfiguration or some forms
887 of migration. The timings of the round are set by the migration announce
888 parameters. An optional comma separated *interfaces* list restricts the
889 announce to the named set of interfaces. An optional *id* can be used to
890 start a separate announce timer and to change the parameters of it later.
891 ERST
894 .name = "migrate",
895 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
896 .params = "[-d] [-b] [-i] [-r] uri",
897 .help = "migrate to URI (using -d to not wait for completion)"
898 "\n\t\t\t -b for migration without shared storage with"
899 " full copy of disk\n\t\t\t -i for migration without "
900 "shared storage with incremental copy of disk "
901 "(base image shared between src and destination)"
902 "\n\t\t\t -r to resume a paused migration",
903 .cmd = hmp_migrate,
907 SRST
908 ``migrate [-d] [-b] [-i]`` *uri*
909 Migrate to *uri* (using -d to not wait for completion).
911 ``-b``
912 for migration with full copy of disk
913 ``-i``
914 for migration with incremental copy of disk (base image is shared)
915 ERST
918 .name = "migrate_cancel",
919 .args_type = "",
920 .params = "",
921 .help = "cancel the current VM migration",
922 .cmd = hmp_migrate_cancel,
925 SRST
926 ``migrate_cancel``
927 Cancel the current VM migration.
928 ERST
931 .name = "migrate_continue",
932 .args_type = "state:s",
933 .params = "state",
934 .help = "Continue migration from the given paused state",
935 .cmd = hmp_migrate_continue,
937 SRST
938 ``migrate_continue`` *state*
939 Continue migration from the paused state *state*
940 ERST
943 .name = "migrate_incoming",
944 .args_type = "uri:s",
945 .params = "uri",
946 .help = "Continue an incoming migration from an -incoming defer",
947 .cmd = hmp_migrate_incoming,
950 SRST
951 ``migrate_incoming`` *uri*
952 Continue an incoming migration using the *uri* (that has the same syntax
953 as the ``-incoming`` option).
954 ERST
957 .name = "migrate_recover",
958 .args_type = "uri:s",
959 .params = "uri",
960 .help = "Continue a paused incoming postcopy migration",
961 .cmd = hmp_migrate_recover,
964 SRST
965 ``migrate_recover`` *uri*
966 Continue a paused incoming postcopy migration using the *uri*.
967 ERST
970 .name = "migrate_pause",
971 .args_type = "",
972 .params = "",
973 .help = "Pause an ongoing migration (postcopy-only)",
974 .cmd = hmp_migrate_pause,
977 SRST
978 ``migrate_pause``
979 Pause an ongoing migration. Currently it only supports postcopy.
980 ERST
983 .name = "migrate_set_cache_size",
984 .args_type = "value:o",
985 .params = "value",
986 .help = "set cache size (in bytes) for XBZRLE migrations,"
987 "the cache size will be rounded down to the nearest "
988 "power of 2.\n"
989 "The cache size affects the number of cache misses."
990 "In case of a high cache miss ratio you need to increase"
991 " the cache size",
992 .cmd = hmp_migrate_set_cache_size,
995 SRST
996 ``migrate_set_cache_size`` *value*
997 Set cache size to *value* (in bytes) for xbzrle migrations.
998 ERST
1001 .name = "migrate_set_speed",
1002 .args_type = "value:o",
1003 .params = "value",
1004 .help = "set maximum speed (in bytes) for migrations. "
1005 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
1006 .cmd = hmp_migrate_set_speed,
1009 SRST
1010 ``migrate_set_speed`` *value*
1011 Set maximum speed to *value* (in bytes) for migrations.
1012 ERST
1015 .name = "migrate_set_downtime",
1016 .args_type = "value:T",
1017 .params = "value",
1018 .help = "set maximum tolerated downtime (in seconds) for migrations",
1019 .cmd = hmp_migrate_set_downtime,
1022 SRST
1023 ``migrate_set_downtime`` *second*
1024 Set maximum tolerated downtime (in seconds) for migration.
1025 ERST
1028 .name = "migrate_set_capability",
1029 .args_type = "capability:s,state:b",
1030 .params = "capability state",
1031 .help = "Enable/Disable the usage of a capability for migration",
1032 .cmd = hmp_migrate_set_capability,
1033 .command_completion = migrate_set_capability_completion,
1036 SRST
1037 ``migrate_set_capability`` *capability* *state*
1038 Enable/Disable the usage of a capability *capability* for migration.
1039 ERST
1042 .name = "migrate_set_parameter",
1043 .args_type = "parameter:s,value:s",
1044 .params = "parameter value",
1045 .help = "Set the parameter for migration",
1046 .cmd = hmp_migrate_set_parameter,
1047 .command_completion = migrate_set_parameter_completion,
1050 SRST
1051 ``migrate_set_parameter`` *parameter* *value*
1052 Set the parameter *parameter* for migration.
1053 ERST
1056 .name = "migrate_start_postcopy",
1057 .args_type = "",
1058 .params = "",
1059 .help = "Followup to a migration command to switch the migration"
1060 " to postcopy mode. The postcopy-ram capability must "
1061 "be set on both source and destination before the "
1062 "original migration command .",
1063 .cmd = hmp_migrate_start_postcopy,
1066 SRST
1067 ``migrate_start_postcopy``
1068 Switch in-progress migration to postcopy mode. Ignored after the end of
1069 migration (or once already in postcopy).
1070 ERST
1073 .name = "x_colo_lost_heartbeat",
1074 .args_type = "",
1075 .params = "",
1076 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1077 "a failover or takeover is needed.",
1078 .cmd = hmp_x_colo_lost_heartbeat,
1081 SRST
1082 ``x_colo_lost_heartbeat``
1083 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1084 ERST
1087 .name = "client_migrate_info",
1088 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1089 .params = "protocol hostname port tls-port cert-subject",
1090 .help = "set migration information for remote display",
1091 .cmd = hmp_client_migrate_info,
1094 SRST
1095 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1096 Set migration information for remote display. This makes the server
1097 ask the client to automatically reconnect using the new parameters
1098 once migration finished successfully. Only implemented for SPICE.
1099 ERST
1102 .name = "dump-guest-memory",
1103 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
1104 .params = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
1105 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1106 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1107 "-d: return immediately (do not wait for completion).\n\t\t\t"
1108 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1109 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1110 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1111 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1112 " for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"
1113 "begin: the starting physical address.\n\t\t\t"
1114 "length: the memory size, in bytes.",
1115 .cmd = hmp_dump_guest_memory,
1118 SRST
1119 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1121 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1122 Dump guest memory to *protocol*. The file can be processed with crash or
1123 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1125 ``-p``
1126 do paging to get guest's memory mapping.
1127 ``-z``
1128 dump in kdump-compressed format, with zlib compression.
1129 ``-l``
1130 dump in kdump-compressed format, with lzo compression.
1131 ``-s``
1132 dump in kdump-compressed format, with snappy compression.
1133 ``-w``
1134 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1135 for Windows x64 guests with vmcoreinfo driver only
1136 *filename*
1137 dump file name.
1138 *begin*
1139 the starting physical address. It's optional, and should be
1140 specified together with *length*.
1141 *length*
1142 the memory size, in bytes. It's optional, and should be specified
1143 together with *begin*.
1145 ERST
1147 #if defined(TARGET_S390X)
1149 .name = "dump-skeys",
1150 .args_type = "filename:F",
1151 .params = "",
1152 .help = "Save guest storage keys into file 'filename'.\n",
1153 .cmd = hmp_dump_skeys,
1155 #endif
1157 SRST
1158 ``dump-skeys`` *filename*
1159 Save guest storage keys to a file.
1160 ERST
1162 #if defined(TARGET_S390X)
1164 .name = "migration_mode",
1165 .args_type = "mode:i",
1166 .params = "mode",
1167 .help = "Enables or disables migration mode\n",
1168 .cmd = hmp_migrationmode,
1170 #endif
1172 SRST
1173 ``migration_mode`` *mode*
1174 Enables or disables migration mode.
1175 ERST
1178 .name = "snapshot_blkdev",
1179 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1180 .params = "[-n] device [new-image-file] [format]",
1181 .help = "initiates a live snapshot\n\t\t\t"
1182 "of device. If a new image file is specified, the\n\t\t\t"
1183 "new image file will become the new root image.\n\t\t\t"
1184 "If format is specified, the snapshot file will\n\t\t\t"
1185 "be created in that format.\n\t\t\t"
1186 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1187 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1188 "recreating it from scratch.",
1189 .cmd = hmp_snapshot_blkdev,
1192 SRST
1193 ``snapshot_blkdev``
1194 Snapshot device, using snapshot file as target if provided
1195 ERST
1198 .name = "snapshot_blkdev_internal",
1199 .args_type = "device:B,name:s",
1200 .params = "device name",
1201 .help = "take an internal snapshot of device.\n\t\t\t"
1202 "The format of the image used by device must\n\t\t\t"
1203 "support it, such as qcow2.\n\t\t\t",
1204 .cmd = hmp_snapshot_blkdev_internal,
1207 SRST
1208 ``snapshot_blkdev_internal``
1209 Take an internal snapshot on device if it support
1210 ERST
1213 .name = "snapshot_delete_blkdev_internal",
1214 .args_type = "device:B,name:s,id:s?",
1215 .params = "device name [id]",
1216 .help = "delete an internal snapshot of device.\n\t\t\t"
1217 "If id is specified, qemu will try delete\n\t\t\t"
1218 "the snapshot matching both id and name.\n\t\t\t"
1219 "The format of the image used by device must\n\t\t\t"
1220 "support it, such as qcow2.\n\t\t\t",
1221 .cmd = hmp_snapshot_delete_blkdev_internal,
1224 SRST
1225 ``snapshot_delete_blkdev_internal``
1226 Delete an internal snapshot on device if it support
1227 ERST
1230 .name = "drive_mirror",
1231 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1232 .params = "[-n] [-f] device target [format]",
1233 .help = "initiates live storage\n\t\t\t"
1234 "migration for a device. The device's contents are\n\t\t\t"
1235 "copied to the new image file, including data that\n\t\t\t"
1236 "is written after the command is started.\n\t\t\t"
1237 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1238 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1239 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1240 "so that the result does not need a backing file.\n\t\t\t",
1241 .cmd = hmp_drive_mirror,
1243 SRST
1244 ``drive_mirror``
1245 Start mirroring a block device's writes to a new destination,
1246 using the specified target.
1247 ERST
1250 .name = "drive_backup",
1251 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1252 .params = "[-n] [-f] [-c] device target [format]",
1253 .help = "initiates a point-in-time\n\t\t\t"
1254 "copy for a device. The device's contents are\n\t\t\t"
1255 "copied to the new image file, excluding data that\n\t\t\t"
1256 "is written after the command is started.\n\t\t\t"
1257 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1258 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1259 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1260 "so that the result does not need a backing file.\n\t\t\t"
1261 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1262 "(if the target format supports it).\n\t\t\t",
1263 .cmd = hmp_drive_backup,
1265 SRST
1266 ``drive_backup``
1267 Start a point-in-time copy of a block device to a specified target.
1268 ERST
1271 .name = "drive_add",
1272 .args_type = "node:-n,pci_addr:s,opts:s",
1273 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1274 "[file=file][,if=type][,bus=n]\n"
1275 "[,unit=m][,media=d][,index=i]\n"
1276 "[,snapshot=on|off][,cache=on|off]\n"
1277 "[,readonly=on|off][,copy-on-read=on|off]",
1278 .help = "add drive to PCI storage controller",
1279 .cmd = hmp_drive_add,
1282 SRST
1283 ``drive_add``
1284 Add drive to PCI storage controller.
1285 ERST
1288 .name = "pcie_aer_inject_error",
1289 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1290 "id:s,error_status:s,"
1291 "header0:i?,header1:i?,header2:i?,header3:i?,"
1292 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1293 .params = "[-a] [-c] id "
1294 "<error_status> [<tlp header> [<tlp header prefix>]]",
1295 .help = "inject pcie aer error\n\t\t\t"
1296 " -a for advisory non fatal error\n\t\t\t"
1297 " -c for correctable error\n\t\t\t"
1298 "<id> = qdev device id\n\t\t\t"
1299 "<error_status> = error string or 32bit\n\t\t\t"
1300 "<tlp header> = 32bit x 4\n\t\t\t"
1301 "<tlp header prefix> = 32bit x 4",
1302 .cmd = hmp_pcie_aer_inject_error,
1305 SRST
1306 ``pcie_aer_inject_error``
1307 Inject PCIe AER error
1308 ERST
1311 .name = "netdev_add",
1312 .args_type = "netdev:O",
1313 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
1314 .help = "add host network device",
1315 .cmd = hmp_netdev_add,
1316 .command_completion = netdev_add_completion,
1319 SRST
1320 ``netdev_add``
1321 Add host network device.
1322 ERST
1325 .name = "netdev_del",
1326 .args_type = "id:s",
1327 .params = "id",
1328 .help = "remove host network device",
1329 .cmd = hmp_netdev_del,
1330 .command_completion = netdev_del_completion,
1333 SRST
1334 ``netdev_del``
1335 Remove host network device.
1336 ERST
1339 .name = "object_add",
1340 .args_type = "object:O",
1341 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1342 .help = "create QOM object",
1343 .cmd = hmp_object_add,
1344 .command_completion = object_add_completion,
1347 SRST
1348 ``object_add``
1349 Create QOM object.
1350 ERST
1353 .name = "object_del",
1354 .args_type = "id:s",
1355 .params = "id",
1356 .help = "destroy QOM object",
1357 .cmd = hmp_object_del,
1358 .command_completion = object_del_completion,
1361 SRST
1362 ``object_del``
1363 Destroy QOM object.
1364 ERST
1366 #ifdef CONFIG_SLIRP
1368 .name = "hostfwd_add",
1369 .args_type = "arg1:s,arg2:s?",
1370 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1371 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1372 .cmd = hmp_hostfwd_add,
1374 #endif
1375 SRST
1376 ``hostfwd_add``
1377 Redirect TCP or UDP connections from host to guest (requires -net user).
1378 ERST
1380 #ifdef CONFIG_SLIRP
1382 .name = "hostfwd_remove",
1383 .args_type = "arg1:s,arg2:s?",
1384 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1385 .help = "remove host-to-guest TCP or UDP redirection",
1386 .cmd = hmp_hostfwd_remove,
1389 #endif
1390 SRST
1391 ``hostfwd_remove``
1392 Remove host-to-guest TCP or UDP redirection.
1393 ERST
1396 .name = "balloon",
1397 .args_type = "value:M",
1398 .params = "target",
1399 .help = "request VM to change its memory allocation (in MB)",
1400 .cmd = hmp_balloon,
1403 SRST
1404 ``balloon`` *value*
1405 Request VM to change its memory allocation to *value* (in MB).
1406 ERST
1409 .name = "set_link",
1410 .args_type = "name:s,up:b",
1411 .params = "name on|off",
1412 .help = "change the link status of a network adapter",
1413 .cmd = hmp_set_link,
1414 .command_completion = set_link_completion,
1417 SRST
1418 ``set_link`` *name* ``[on|off]``
1419 Switch link *name* on (i.e. up) or off (i.e. down).
1420 ERST
1423 .name = "watchdog_action",
1424 .args_type = "action:s",
1425 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1426 .help = "change watchdog action",
1427 .cmd = hmp_watchdog_action,
1428 .command_completion = watchdog_action_completion,
1431 SRST
1432 ``watchdog_action``
1433 Change watchdog action.
1434 ERST
1437 .name = "acl_show",
1438 .args_type = "aclname:s",
1439 .params = "aclname",
1440 .help = "list rules in the access control list",
1441 .cmd = hmp_acl_show,
1444 SRST
1445 ``acl_show`` *aclname*
1446 List all the matching rules in the access control list, and the default
1447 policy. There are currently two named access control lists,
1448 *vnc.x509dname* and *vnc.username* matching on the x509 client
1449 certificate distinguished name, and SASL username respectively.
1450 ERST
1453 .name = "acl_policy",
1454 .args_type = "aclname:s,policy:s",
1455 .params = "aclname allow|deny",
1456 .help = "set default access control list policy",
1457 .cmd = hmp_acl_policy,
1460 SRST
1461 ``acl_policy`` *aclname* ``allow|deny``
1462 Set the default access control list policy, used in the event that
1463 none of the explicit rules match. The default policy at startup is
1464 always ``deny``.
1465 ERST
1468 .name = "acl_add",
1469 .args_type = "aclname:s,match:s,policy:s,index:i?",
1470 .params = "aclname match allow|deny [index]",
1471 .help = "add a match rule to the access control list",
1472 .cmd = hmp_acl_add,
1475 SRST
1476 ``acl_add`` *aclname* *match* ``allow|deny`` [*index*]
1477 Add a match rule to the access control list, allowing or denying access.
1478 The match will normally be an exact username or x509 distinguished name,
1479 but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to
1480 allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will
1481 normally be appended to the end of the ACL, but can be inserted
1482 earlier in the list if the optional *index* parameter is supplied.
1483 ERST
1486 .name = "acl_remove",
1487 .args_type = "aclname:s,match:s",
1488 .params = "aclname match",
1489 .help = "remove a match rule from the access control list",
1490 .cmd = hmp_acl_remove,
1493 SRST
1494 ``acl_remove`` *aclname* *match*
1495 Remove the specified match rule from the access control list.
1496 ERST
1499 .name = "acl_reset",
1500 .args_type = "aclname:s",
1501 .params = "aclname",
1502 .help = "reset the access control list",
1503 .cmd = hmp_acl_reset,
1506 SRST
1507 ``acl_reset`` *aclname*
1508 Remove all matches from the access control list, and set the default
1509 policy back to ``deny``.
1510 ERST
1513 .name = "nbd_server_start",
1514 .args_type = "all:-a,writable:-w,uri:s",
1515 .params = "nbd_server_start [-a] [-w] host:port",
1516 .help = "serve block devices on the given host and port",
1517 .cmd = hmp_nbd_server_start,
1519 SRST
1520 ``nbd_server_start`` *host*:*port*
1521 Start an NBD server on the given host and/or port. If the ``-a``
1522 option is included, all of the virtual machine's block devices that
1523 have an inserted media on them are automatically exported; in this case,
1524 the ``-w`` option makes the devices writable too.
1525 ERST
1528 .name = "nbd_server_add",
1529 .args_type = "writable:-w,device:B,name:s?",
1530 .params = "nbd_server_add [-w] device [name]",
1531 .help = "export a block device via NBD",
1532 .cmd = hmp_nbd_server_add,
1534 SRST
1535 ``nbd_server_add`` *device* [ *name* ]
1536 Export a block device through QEMU's NBD server, which must be started
1537 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1538 exported device writable too. The export name is controlled by *name*,
1539 defaulting to *device*.
1540 ERST
1543 .name = "nbd_server_remove",
1544 .args_type = "force:-f,name:s",
1545 .params = "nbd_server_remove [-f] name",
1546 .help = "remove an export previously exposed via NBD",
1547 .cmd = hmp_nbd_server_remove,
1549 SRST
1550 ``nbd_server_remove [-f]`` *name*
1551 Stop exporting a block device through QEMU's NBD server, which was
1552 previously started with ``nbd_server_add``. The ``-f``
1553 option forces the server to drop the export immediately even if
1554 clients are connected; otherwise the command fails unless there are no
1555 clients.
1556 ERST
1559 .name = "nbd_server_stop",
1560 .args_type = "",
1561 .params = "nbd_server_stop",
1562 .help = "stop serving block devices using the NBD protocol",
1563 .cmd = hmp_nbd_server_stop,
1565 SRST
1566 ``nbd_server_stop``
1567 Stop the QEMU embedded NBD server.
1568 ERST
1571 #if defined(TARGET_I386)
1574 .name = "mce",
1575 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1576 .params = "[-b] cpu bank status mcgstatus addr misc",
1577 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1578 .cmd = hmp_mce,
1581 #endif
1582 SRST
1583 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1584 Inject an MCE on the given CPU (x86 only).
1585 ERST
1588 .name = "getfd",
1589 .args_type = "fdname:s",
1590 .params = "getfd name",
1591 .help = "receive a file descriptor via SCM rights and assign it a name",
1592 .cmd = hmp_getfd,
1595 SRST
1596 ``getfd`` *fdname*
1597 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1598 mechanism on unix sockets, it is stored using the name *fdname* for
1599 later use by other monitor commands.
1600 ERST
1603 .name = "closefd",
1604 .args_type = "fdname:s",
1605 .params = "closefd name",
1606 .help = "close a file descriptor previously passed via SCM rights",
1607 .cmd = hmp_closefd,
1610 SRST
1611 ``closefd`` *fdname*
1612 Close the file descriptor previously assigned to *fdname* using the
1613 ``getfd`` command. This is only needed if the file descriptor was never
1614 used by another monitor command.
1615 ERST
1618 .name = "block_passwd",
1619 .args_type = "device:B,password:s",
1620 .params = "block_passwd device password",
1621 .help = "set the password of encrypted block devices",
1622 .cmd = hmp_block_passwd,
1625 SRST
1626 ``block_passwd`` *device* *password*
1627 Set the encrypted device *device* password to *password*
1629 This command is now obsolete and will always return an error since 2.10
1630 ERST
1633 .name = "block_set_io_throttle",
1634 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1635 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1636 .help = "change I/O throttle limits for a block drive",
1637 .cmd = hmp_block_set_io_throttle,
1640 SRST
1641 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1642 Change I/O throttle limits for a block drive to
1643 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1644 *device* can be a block device name, a qdev ID or a QOM path.
1645 ERST
1648 .name = "set_password",
1649 .args_type = "protocol:s,password:s,connected:s?",
1650 .params = "protocol password action-if-connected",
1651 .help = "set spice/vnc password",
1652 .cmd = hmp_set_password,
1655 SRST
1656 ``set_password [ vnc | spice ] password [ action-if-connected ]``
1657 Change spice/vnc password. Use zero to make the password stay valid
1658 forever. *action-if-connected* specifies what should happen in
1659 case a connection is established: *fail* makes the password change
1660 fail. *disconnect* changes the password and disconnects the
1661 client. *keep* changes the password and keeps the connection up.
1662 *keep* is the default.
1663 ERST
1666 .name = "expire_password",
1667 .args_type = "protocol:s,time:s",
1668 .params = "protocol time",
1669 .help = "set spice/vnc password expire-time",
1670 .cmd = hmp_expire_password,
1673 SRST
1674 ``expire_password [ vnc | spice ]`` *expire-time*
1675 Specify when a password for spice/vnc becomes
1676 invalid. *expire-time* accepts:
1678 ``now``
1679 Invalidate password instantly.
1680 ``never``
1681 Password stays valid forever.
1682 ``+``\ *nsec*
1683 Password stays valid for *nsec* seconds starting now.
1684 *nsec*
1685 Password is invalidated at the given time. *nsec* are the seconds
1686 passed since 1970, i.e. unix epoch.
1688 ERST
1691 .name = "chardev-add",
1692 .args_type = "args:s",
1693 .params = "args",
1694 .help = "add chardev",
1695 .cmd = hmp_chardev_add,
1696 .command_completion = chardev_add_completion,
1699 SRST
1700 ``chardev-add`` *args*
1701 chardev-add accepts the same parameters as the -chardev command line switch.
1702 ERST
1705 .name = "chardev-change",
1706 .args_type = "id:s,args:s",
1707 .params = "id args",
1708 .help = "change chardev",
1709 .cmd = hmp_chardev_change,
1712 SRST
1713 ``chardev-change`` *args*
1714 chardev-change accepts existing chardev *id* and then the same arguments
1715 as the -chardev command line switch (except for "id").
1716 ERST
1719 .name = "chardev-remove",
1720 .args_type = "id:s",
1721 .params = "id",
1722 .help = "remove chardev",
1723 .cmd = hmp_chardev_remove,
1724 .command_completion = chardev_remove_completion,
1727 SRST
1728 ``chardev-remove`` *id*
1729 Removes the chardev *id*.
1730 ERST
1733 .name = "chardev-send-break",
1734 .args_type = "id:s",
1735 .params = "id",
1736 .help = "send a break on chardev",
1737 .cmd = hmp_chardev_send_break,
1738 .command_completion = chardev_remove_completion,
1741 SRST
1742 ``chardev-send-break`` *id*
1743 Send a break on the chardev *id*.
1744 ERST
1747 .name = "qemu-io",
1748 .args_type = "qdev:-d,device:B,command:s",
1749 .params = "[-d] [device] \"[command]\"",
1750 .help = "run a qemu-io command on a block device\n\t\t\t"
1751 "-d: [device] is a device ID rather than a "
1752 "drive ID or node name",
1753 .cmd = hmp_qemu_io,
1756 SRST
1757 ``qemu-io`` *device* *command*
1758 Executes a qemu-io command on the given block device.
1759 ERST
1762 .name = "qom-list",
1763 .args_type = "path:s?",
1764 .params = "path",
1765 .help = "list QOM properties",
1766 .cmd = hmp_qom_list,
1767 .flags = "p",
1770 SRST
1771 ``qom-list`` [*path*]
1772 Print QOM properties of object at location *path*
1773 ERST
1776 .name = "qom-get",
1777 .args_type = "path:s,property:s",
1778 .params = "path property",
1779 .help = "print QOM property",
1780 .cmd = hmp_qom_get,
1781 .flags = "p",
1784 SRST
1785 ``qom-get`` *path* *property*
1786 Print QOM property *property* of object at location *path*
1787 ERST
1790 .name = "qom-set",
1791 .args_type = "json:-j,path:s,property:s,value:S",
1792 .params = "[-j] path property value",
1793 .help = "set QOM property.\n\t\t\t"
1794 "-j: the value is specified in json format.",
1795 .cmd = hmp_qom_set,
1796 .flags = "p",
1799 SRST
1800 ``qom-set`` *path* *property* *value*
1801 Set QOM property *property* of object at location *path* to value *value*
1802 ERST
1805 .name = "replay_break",
1806 .args_type = "icount:i",
1807 .params = "icount",
1808 .help = "set breakpoint at the specified instruction count",
1809 .cmd = hmp_replay_break,
1812 SRST
1813 ``replay_break`` *icount*
1814 Set replay breakpoint at instruction count *icount*.
1815 Execution stops when the specified instruction is reached.
1816 There can be at most one breakpoint. When breakpoint is set, any prior
1817 one is removed. The breakpoint may be set only in replay mode and only
1818 "in the future", i.e. at instruction counts greater than the current one.
1819 The current instruction count can be observed with ``info replay``.
1820 ERST
1823 .name = "replay_delete_break",
1824 .args_type = "",
1825 .params = "",
1826 .help = "remove replay breakpoint",
1827 .cmd = hmp_replay_delete_break,
1830 SRST
1831 ``replay_delete_break``
1832 Remove replay breakpoint which was previously set with ``replay_break``.
1833 The command is ignored when there are no replay breakpoints.
1834 ERST
1837 .name = "replay_seek",
1838 .args_type = "icount:i",
1839 .params = "icount",
1840 .help = "replay execution to the specified instruction count",
1841 .cmd = hmp_replay_seek,
1844 SRST
1845 ``replay_seek`` *icount*
1846 Automatically proceed to the instruction count *icount*, when
1847 replaying the execution. The command automatically loads nearest
1848 snapshot and replays the execution to find the desired instruction.
1849 When there is no preceding snapshot or the execution is not replayed,
1850 then the command fails.
1851 *icount* for the reference may be observed with ``info replay`` command.
1852 ERST
1855 .name = "info",
1856 .args_type = "item:s?",
1857 .params = "[subcommand]",
1858 .help = "show various information about the system state",
1859 .cmd = hmp_info_help,
1860 .sub_table = hmp_info_cmds,
1861 .flags = "p",