1HXCOMM Use DEFHEADING() to define headings in both help text and texi 2HXCOMM Text between STEXI and ETEXI are copied to texi version and 3HXCOMM discarded from C version 4HXCOMM DEF(command, args, callback, arg_string, help) is used to construct 5HXCOMM monitor commands 6HXCOMM HXCOMM can be used for comments, discarded from both texi and C 7 8STEXI 9@table @option 10ETEXI 11 12 { 13 .name = "help|?", 14 .args_type = "name:S?", 15 .params = "[cmd]", 16 .help = "show the help", 17 .mhandler.cmd = do_help_cmd, 18 }, 19 20STEXI 21@item help or ? [@var{cmd}] 22@findex help 23Show the help for all commands or just for command @var{cmd}. 24ETEXI 25 26 { 27 .name = "commit", 28 .args_type = "device:B", 29 .params = "device|all", 30 .help = "commit changes to the disk images (if -snapshot is used) or backing files", 31 .mhandler.cmd = do_commit, 32 }, 33 34STEXI 35@item commit 36@findex commit 37Commit changes to the disk images (if -snapshot is used) or backing files. 38If the backing file is smaller than the snapshot, then the backing file will be 39resized to be the same size as the snapshot. If the snapshot is smaller than 40the backing file, the backing file will not be truncated. If you want the 41backing file to match the size of the smaller snapshot, you can safely truncate 42it yourself once the commit operation successfully completes. 43ETEXI 44 45 { 46 .name = "q|quit", 47 .args_type = "", 48 .params = "", 49 .help = "quit the emulator", 50 .user_print = monitor_user_noop, 51 .mhandler.cmd = hmp_quit, 52 }, 53 54STEXI 55@item q or quit 56@findex quit 57Quit the emulator. 58ETEXI 59 60 { 61 .name = "block_resize", 62 .args_type = "device:B,size:o", 63 .params = "device size", 64 .help = "resize a block image", 65 .mhandler.cmd = hmp_block_resize, 66 }, 67 68STEXI 69@item block_resize 70@findex block_resize 71Resize a block image while a guest is running. Usually requires guest 72action to see the updated size. Resize to a lower size is supported, 73but should be used with extreme caution. Note that this command only 74resizes image files, it can not resize block devices like LVM volumes. 75ETEXI 76 77 { 78 .name = "block_stream", 79 .args_type = "device:B,speed:o?,base:s?", 80 .params = "device [speed [base]]", 81 .help = "copy data from a backing file into a block device", 82 .mhandler.cmd = hmp_block_stream, 83 }, 84 85STEXI 86@item block_stream 87@findex block_stream 88Copy data from a backing file into a block device. 89ETEXI 90 91 { 92 .name = "block_job_set_speed", 93 .args_type = "device:B,speed:o", 94 .params = "device speed", 95 .help = "set maximum speed for a background block operation", 96 .mhandler.cmd = hmp_block_job_set_speed, 97 }, 98 99STEXI 100@item block_job_set_speed 101@findex block_job_set_speed 102Set maximum speed for a background block operation. 103ETEXI 104 105 { 106 .name = "block_job_cancel", 107 .args_type = "force:-f,device:B", 108 .params = "[-f] device", 109 .help = "stop an active background block operation (use -f" 110 "\n\t\t\t if the operation is currently paused)", 111 .mhandler.cmd = hmp_block_job_cancel, 112 }, 113 114STEXI 115@item block_job_cancel 116@findex block_job_cancel 117Stop an active background block operation (streaming, mirroring). 118ETEXI 119 120 { 121 .name = "block_job_complete", 122 .args_type = "device:B", 123 .params = "device", 124 .help = "stop an active background block operation", 125 .mhandler.cmd = hmp_block_job_complete, 126 }, 127 128STEXI 129@item block_job_complete 130@findex block_job_complete 131Manually trigger completion of an active background block operation. 132For mirroring, this will switch the device to the destination path. 133ETEXI 134 135 { 136 .name = "block_job_pause", 137 .args_type = "device:B", 138 .params = "device", 139 .help = "pause an active background block operation", 140 .mhandler.cmd = hmp_block_job_pause, 141 }, 142 143STEXI 144@item block_job_pause 145@findex block_job_pause 146Pause an active block streaming operation. 147ETEXI 148 149 { 150 .name = "block_job_resume", 151 .args_type = "device:B", 152 .params = "device", 153 .help = "resume a paused background block operation", 154 .mhandler.cmd = hmp_block_job_resume, 155 }, 156 157STEXI 158@item block_job_resume 159@findex block_job_resume 160Resume a paused block streaming operation. 161ETEXI 162 163 { 164 .name = "eject", 165 .args_type = "force:-f,device:B", 166 .params = "[-f] device", 167 .help = "eject a removable medium (use -f to force it)", 168 .mhandler.cmd = hmp_eject, 169 }, 170 171STEXI 172@item eject [-f] @var{device} 173@findex eject 174Eject a removable medium (use -f to force it). 175ETEXI 176 177 { 178 .name = "drive_del", 179 .args_type = "id:B", 180 .params = "device", 181 .help = "remove host block device", 182 .user_print = monitor_user_noop, 183 .mhandler.cmd_new = do_drive_del, 184 }, 185 186STEXI 187@item drive_del @var{device} 188@findex drive_del 189Remove host block device. The result is that guest generated IO is no longer 190submitted against the host device underlying the disk. Once a drive has 191been deleted, the QEMU Block layer returns -EIO which results in IO 192errors in the guest for applications that are reading/writing to the device. 193These errors are always reported to the guest, regardless of the drive's error 194actions (drive options rerror, werror). 195ETEXI 196 197 { 198 .name = "change", 199 .args_type = "device:B,target:F,arg:s?", 200 .params = "device filename [format]", 201 .help = "change a removable medium, optional format", 202 .mhandler.cmd = hmp_change, 203 }, 204 205STEXI 206@item change @var{device} @var{setting} 207@findex change 208 209Change the configuration of a device. 210 211@table @option 212@item change @var{diskdevice} @var{filename} [@var{format}] 213Change the medium for a removable disk device to point to @var{filename}. eg 214 215@example 216(qemu) change ide1-cd0 /path/to/some.iso 217@end example 218 219@var{format} is optional. 220 221@item change vnc @var{display},@var{options} 222Change the configuration of the VNC server. The valid syntax for @var{display} 223and @var{options} are described at @ref{sec_invocation}. eg 224 225@example 226(qemu) change vnc localhost:1 227@end example 228 229@item change vnc password [@var{password}] 230 231Change the password associated with the VNC server. If the new password is not 232supplied, the monitor will prompt for it to be entered. VNC passwords are only 233significant up to 8 letters. eg 234 235@example 236(qemu) change vnc password 237Password: ******** 238@end example 239 240@end table 241ETEXI 242 243 { 244 .name = "screendump", 245 .args_type = "filename:F", 246 .params = "filename", 247 .help = "save screen into PPM image 'filename'", 248 .mhandler.cmd = hmp_screen_dump, 249 }, 250 251STEXI 252@item screendump @var{filename} 253@findex screendump 254Save screen into PPM image @var{filename}. 255ETEXI 256 257 { 258 .name = "logfile", 259 .args_type = "filename:F", 260 .params = "filename", 261 .help = "output logs to 'filename'", 262 .mhandler.cmd = do_logfile, 263 }, 264 265STEXI 266@item logfile @var{filename} 267@findex logfile 268Output logs to @var{filename}. 269ETEXI 270 271 { 272 .name = "trace-event", 273 .args_type = "name:s,option:b", 274 .params = "name on|off", 275 .help = "changes status of a specific trace event", 276 .mhandler.cmd = do_trace_event_set_state, 277 }, 278 279STEXI 280@item trace-event 281@findex trace-event 282changes status of a trace event 283ETEXI 284 285#if defined(CONFIG_TRACE_SIMPLE) 286 { 287 .name = "trace-file", 288 .args_type = "op:s?,arg:F?", 289 .params = "on|off|flush|set [arg]", 290 .help = "open, close, or flush trace file, or set a new file name", 291 .mhandler.cmd = do_trace_file, 292 }, 293 294STEXI 295@item trace-file on|off|flush 296@findex trace-file 297Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed. 298ETEXI 299#endif 300 301 { 302 .name = "log", 303 .args_type = "items:s", 304 .params = "item1[,...]", 305 .help = "activate logging of the specified items", 306 .mhandler.cmd = do_log, 307 }, 308 309STEXI 310@item log @var{item1}[,...] 311@findex log 312Activate logging of the specified items. 313ETEXI 314 315 { 316 .name = "savevm", 317 .args_type = "name:s?", 318 .params = "[tag|id]", 319 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created", 320 .mhandler.cmd = do_savevm, 321 }, 322 323STEXI 324@item savevm [@var{tag}|@var{id}] 325@findex savevm 326Create a snapshot of the whole virtual machine. If @var{tag} is 327provided, it is used as human readable identifier. If there is already 328a snapshot with the same tag or ID, it is replaced. More info at 329@ref{vm_snapshots}. 330ETEXI 331 332 { 333 .name = "loadvm", 334 .args_type = "name:s", 335 .params = "tag|id", 336 .help = "restore a VM snapshot from its tag or id", 337 .mhandler.cmd = do_loadvm, 338 .command_completion = loadvm_completion, 339 }, 340 341STEXI 342@item loadvm @var{tag}|@var{id} 343@findex loadvm 344Set the whole virtual machine to the snapshot identified by the tag 345@var{tag} or the unique snapshot ID @var{id}. 346ETEXI 347 348 { 349 .name = "delvm", 350 .args_type = "name:s", 351 .params = "tag|id", 352 .help = "delete a VM snapshot from its tag or id", 353 .mhandler.cmd = do_delvm, 354 .command_completion = delvm_completion, 355 }, 356 357STEXI 358@item delvm @var{tag}|@var{id} 359@findex delvm 360Delete the snapshot identified by @var{tag} or @var{id}. 361ETEXI 362 363 { 364 .name = "singlestep", 365 .args_type = "option:s?", 366 .params = "[on|off]", 367 .help = "run emulation in singlestep mode or switch to normal mode", 368 .mhandler.cmd = do_singlestep, 369 }, 370 371STEXI 372@item singlestep [off] 373@findex singlestep 374Run the emulation in single step mode. 375If called with option off, the emulation returns to normal mode. 376ETEXI 377 378 { 379 .name = "stop", 380 .args_type = "", 381 .params = "", 382 .help = "stop emulation", 383 .mhandler.cmd = hmp_stop, 384 }, 385 386STEXI 387@item stop 388@findex stop 389Stop emulation. 390ETEXI 391 392 { 393 .name = "c|cont", 394 .args_type = "", 395 .params = "", 396 .help = "resume emulation", 397 .mhandler.cmd = hmp_cont, 398 }, 399 400STEXI 401@item c or cont 402@findex cont 403Resume emulation. 404ETEXI 405 406 { 407 .name = "system_wakeup", 408 .args_type = "", 409 .params = "", 410 .help = "wakeup guest from suspend", 411 .mhandler.cmd = hmp_system_wakeup, 412 }, 413 414STEXI 415@item system_wakeup 416@findex system_wakeup 417Wakeup guest from suspend. 418ETEXI 419 420 { 421 .name = "gdbserver", 422 .args_type = "device:s?", 423 .params = "[device]", 424 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", 425 .mhandler.cmd = do_gdbserver, 426 }, 427 428STEXI 429@item gdbserver [@var{port}] 430@findex gdbserver 431Start gdbserver session (default @var{port}=1234) 432ETEXI 433 434 { 435 .name = "x", 436 .args_type = "fmt:/,addr:l", 437 .params = "/fmt addr", 438 .help = "virtual memory dump starting at 'addr'", 439 .mhandler.cmd = do_memory_dump, 440 }, 441 442STEXI 443@item x/fmt @var{addr} 444@findex x 445Virtual memory dump starting at @var{addr}. 446ETEXI 447 448 { 449 .name = "xp", 450 .args_type = "fmt:/,addr:l", 451 .params = "/fmt addr", 452 .help = "physical memory dump starting at 'addr'", 453 .mhandler.cmd = do_physical_memory_dump, 454 }, 455 456STEXI 457@item xp /@var{fmt} @var{addr} 458@findex xp 459Physical memory dump starting at @var{addr}. 460 461@var{fmt} is a format which tells the command how to format the 462data. Its syntax is: @option{/@{count@}@{format@}@{size@}} 463 464@table @var 465@item count 466is the number of items to be dumped. 467 468@item format 469can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), 470c (char) or i (asm instruction). 471 472@item size 473can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, 474@code{h} or @code{w} can be specified with the @code{i} format to 475respectively select 16 or 32 bit code instruction size. 476 477@end table 478 479Examples: 480@itemize 481@item 482Dump 10 instructions at the current instruction pointer: 483@example 484(qemu) x/10i $eip 4850x90107063: ret 4860x90107064: sti 4870x90107065: lea 0x0(%esi,1),%esi 4880x90107069: lea 0x0(%edi,1),%edi 4890x90107070: ret 4900x90107071: jmp 0x90107080 4910x90107073: nop 4920x90107074: nop 4930x90107075: nop 4940x90107076: nop 495@end example 496 497@item 498Dump 80 16 bit values at the start of the video memory. 499@smallexample 500(qemu) xp/80hx 0xb8000 5010x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 5020x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 5030x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 5040x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 5050x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 5060x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 5070x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 5080x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 5090x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 5100x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 511@end smallexample 512@end itemize 513ETEXI 514 515 { 516 .name = "p|print", 517 .args_type = "fmt:/,val:l", 518 .params = "/fmt expr", 519 .help = "print expression value (use $reg for CPU register access)", 520 .mhandler.cmd = do_print, 521 }, 522 523STEXI 524@item p or print/@var{fmt} @var{expr} 525@findex print 526 527Print expression value. Only the @var{format} part of @var{fmt} is 528used. 529ETEXI 530 531 { 532 .name = "i", 533 .args_type = "fmt:/,addr:i,index:i.", 534 .params = "/fmt addr", 535 .help = "I/O port read", 536 .mhandler.cmd = do_ioport_read, 537 }, 538 539STEXI 540Read I/O port. 541ETEXI 542 543 { 544 .name = "o", 545 .args_type = "fmt:/,addr:i,val:i", 546 .params = "/fmt addr value", 547 .help = "I/O port write", 548 .mhandler.cmd = do_ioport_write, 549 }, 550 551STEXI 552Write to I/O port. 553ETEXI 554 555 { 556 .name = "sendkey", 557 .args_type = "keys:s,hold-time:i?", 558 .params = "keys [hold_ms]", 559 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", 560 .mhandler.cmd = hmp_send_key, 561 .command_completion = sendkey_completion, 562 }, 563 564STEXI 565@item sendkey @var{keys} 566@findex sendkey 567 568Send @var{keys} to the guest. @var{keys} could be the name of the 569key or the raw value in hexadecimal format. Use @code{-} to press 570several keys simultaneously. Example: 571@example 572sendkey ctrl-alt-f1 573@end example 574 575This command is useful to send keys that your graphical user interface 576intercepts at low level, such as @code{ctrl-alt-f1} in X Window. 577ETEXI 578 579 { 580 .name = "system_reset", 581 .args_type = "", 582 .params = "", 583 .help = "reset the system", 584 .mhandler.cmd = hmp_system_reset, 585 }, 586 587STEXI 588@item system_reset 589@findex system_reset 590 591Reset the system. 592ETEXI 593 594 { 595 .name = "system_powerdown", 596 .args_type = "", 597 .params = "", 598 .help = "send system power down event", 599 .mhandler.cmd = hmp_system_powerdown, 600 }, 601 602STEXI 603@item system_powerdown 604@findex system_powerdown 605 606Power down the system (if supported). 607ETEXI 608 609 { 610 .name = "sum", 611 .args_type = "start:i,size:i", 612 .params = "addr size", 613 .help = "compute the checksum of a memory region", 614 .mhandler.cmd = do_sum, 615 }, 616 617STEXI 618@item sum @var{addr} @var{size} 619@findex sum 620 621Compute the checksum of a memory region. 622ETEXI 623 624 { 625 .name = "usb_add", 626 .args_type = "devname:s", 627 .params = "device", 628 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')", 629 .mhandler.cmd = do_usb_add, 630 }, 631 632STEXI 633@item usb_add @var{devname} 634@findex usb_add 635 636Add the USB device @var{devname}. For details of available devices see 637@ref{usb_devices} 638ETEXI 639 640 { 641 .name = "usb_del", 642 .args_type = "devname:s", 643 .params = "device", 644 .help = "remove USB device 'bus.addr'", 645 .mhandler.cmd = do_usb_del, 646 }, 647 648STEXI 649@item usb_del @var{devname} 650@findex usb_del 651 652Remove the USB device @var{devname} from the QEMU virtual USB 653hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor 654command @code{info usb} to see the devices you can remove. 655ETEXI 656 657 { 658 .name = "device_add", 659 .args_type = "device:O", 660 .params = "driver[,prop=value][,...]", 661 .help = "add device, like -device on the command line", 662 .user_print = monitor_user_noop, 663 .mhandler.cmd_new = do_device_add, 664 .command_completion = device_add_completion, 665 }, 666 667STEXI 668@item device_add @var{config} 669@findex device_add 670 671Add device. 672ETEXI 673 674 { 675 .name = "device_del", 676 .args_type = "id:s", 677 .params = "device", 678 .help = "remove device", 679 .mhandler.cmd = hmp_device_del, 680 .command_completion = device_del_completion, 681 }, 682 683STEXI 684@item device_del @var{id} 685@findex device_del 686 687Remove device @var{id}. 688ETEXI 689 690 { 691 .name = "cpu", 692 .args_type = "index:i", 693 .params = "index", 694 .help = "set the default CPU", 695 .mhandler.cmd = hmp_cpu, 696 }, 697 698STEXI 699@item cpu @var{index} 700@findex cpu 701Set the default CPU. 702ETEXI 703 704 { 705 .name = "mouse_move", 706 .args_type = "dx_str:s,dy_str:s,dz_str:s?", 707 .params = "dx dy [dz]", 708 .help = "send mouse move events", 709 .mhandler.cmd = do_mouse_move, 710 }, 711 712STEXI 713@item mouse_move @var{dx} @var{dy} [@var{dz}] 714@findex mouse_move 715Move the active mouse to the specified coordinates @var{dx} @var{dy} 716with optional scroll axis @var{dz}. 717ETEXI 718 719 { 720 .name = "mouse_button", 721 .args_type = "button_state:i", 722 .params = "state", 723 .help = "change mouse button state (1=L, 2=M, 4=R)", 724 .mhandler.cmd = do_mouse_button, 725 }, 726 727STEXI 728@item mouse_button @var{val} 729@findex mouse_button 730Change the active mouse button state @var{val} (1=L, 2=M, 4=R). 731ETEXI 732 733 { 734 .name = "mouse_set", 735 .args_type = "index:i", 736 .params = "index", 737 .help = "set which mouse device receives events", 738 .mhandler.cmd = do_mouse_set, 739 }, 740 741STEXI 742@item mouse_set @var{index} 743@findex mouse_set 744Set which mouse device receives events at given @var{index}, index 745can be obtained with 746@example 747info mice 748@end example 749ETEXI 750 751 { 752 .name = "wavcapture", 753 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?", 754 .params = "path [frequency [bits [channels]]]", 755 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)", 756 .mhandler.cmd = do_wav_capture, 757 }, 758STEXI 759@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]] 760@findex wavcapture 761Capture audio into @var{filename}. Using sample rate @var{frequency} 762bits per sample @var{bits} and number of channels @var{channels}. 763 764Defaults: 765@itemize @minus 766@item Sample rate = 44100 Hz - CD quality 767@item Bits = 16 768@item Number of channels = 2 - Stereo 769@end itemize 770ETEXI 771 772 { 773 .name = "stopcapture", 774 .args_type = "n:i", 775 .params = "capture index", 776 .help = "stop capture", 777 .mhandler.cmd = do_stop_capture, 778 }, 779STEXI 780@item stopcapture @var{index} 781@findex stopcapture 782Stop capture with a given @var{index}, index can be obtained with 783@example 784info capture 785@end example 786ETEXI 787 788 { 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 .mhandler.cmd = hmp_memsave, 794 }, 795 796STEXI 797@item memsave @var{addr} @var{size} @var{file} 798@findex memsave 799save to disk virtual memory dump starting at @var{addr} of size @var{size}. 800ETEXI 801 802 { 803 .name = "pmemsave", 804 .args_type = "val:l,size:i,filename:s", 805 .params = "addr size file", 806 .help = "save to disk physical memory dump starting at 'addr' of size 'size'", 807 .mhandler.cmd = hmp_pmemsave, 808 }, 809 810STEXI 811@item pmemsave @var{addr} @var{size} @var{file} 812@findex pmemsave 813save to disk physical memory dump starting at @var{addr} of size @var{size}. 814ETEXI 815 816 { 817 .name = "boot_set", 818 .args_type = "bootdevice:s", 819 .params = "bootdevice", 820 .help = "define new values for the boot device list", 821 .mhandler.cmd = do_boot_set, 822 }, 823 824STEXI 825@item boot_set @var{bootdevicelist} 826@findex boot_set 827 828Define new values for the boot device list. Those values will override 829the values specified on the command line through the @code{-boot} option. 830 831The values that can be specified here depend on the machine type, but are 832the same that can be specified in the @code{-boot} command line option. 833ETEXI 834 835 { 836 .name = "nmi", 837 .args_type = "", 838 .params = "", 839 .help = "inject an NMI", 840 .mhandler.cmd = hmp_inject_nmi, 841 }, 842STEXI 843@item nmi @var{cpu} 844@findex nmi 845Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64). 846 847ETEXI 848 849 { 850 .name = "ringbuf_write", 851 .args_type = "device:s,data:s", 852 .params = "device data", 853 .help = "Write to a ring buffer character device", 854 .mhandler.cmd = hmp_ringbuf_write, 855 .command_completion = ringbuf_write_completion, 856 }, 857 858STEXI 859@item ringbuf_write @var{device} @var{data} 860@findex ringbuf_write 861Write @var{data} to ring buffer character device @var{device}. 862@var{data} must be a UTF-8 string. 863 864ETEXI 865 866 { 867 .name = "ringbuf_read", 868 .args_type = "device:s,size:i", 869 .params = "device size", 870 .help = "Read from a ring buffer character device", 871 .mhandler.cmd = hmp_ringbuf_read, 872 .command_completion = ringbuf_write_completion, 873 }, 874 875STEXI 876@item ringbuf_read @var{device} 877@findex ringbuf_read 878Read and print up to @var{size} bytes from ring buffer character 879device @var{device}. 880Certain non-printable characters are printed \uXXXX, where XXXX is the 881character code in hexadecimal. Character \ is printed \\. 882Bug: can screw up when the buffer contains invalid UTF-8 sequences, 883NUL characters, after the ring buffer lost data, and when reading 884stops because the size limit is reached. 885 886ETEXI 887 888 { 889 .name = "migrate", 890 .args_type = "detach:-d,blk:-b,inc:-i,uri:s", 891 .params = "[-d] [-b] [-i] uri", 892 .help = "migrate to URI (using -d to not wait for completion)" 893 "\n\t\t\t -b for migration without shared storage with" 894 " full copy of disk\n\t\t\t -i for migration without " 895 "shared storage with incremental copy of disk " 896 "(base image shared between src and destination)", 897 .mhandler.cmd = hmp_migrate, 898 }, 899 900 901STEXI 902@item migrate [-d] [-b] [-i] @var{uri} 903@findex migrate 904Migrate to @var{uri} (using -d to not wait for completion). 905 -b for migration with full copy of disk 906 -i for migration with incremental copy of disk (base image is shared) 907ETEXI 908 909 { 910 .name = "migrate_cancel", 911 .args_type = "", 912 .params = "", 913 .help = "cancel the current VM migration", 914 .mhandler.cmd = hmp_migrate_cancel, 915 }, 916 917STEXI 918@item migrate_cancel 919@findex migrate_cancel 920Cancel the current VM migration. 921 922ETEXI 923 924 { 925 .name = "migrate_set_cache_size", 926 .args_type = "value:o", 927 .params = "value", 928 .help = "set cache size (in bytes) for XBZRLE migrations," 929 "the cache size will be rounded down to the nearest " 930 "power of 2.\n" 931 "The cache size affects the number of cache misses." 932 "In case of a high cache miss ratio you need to increase" 933 " the cache size", 934 .mhandler.cmd = hmp_migrate_set_cache_size, 935 }, 936 937STEXI 938@item migrate_set_cache_size @var{value} 939@findex migrate_set_cache_size 940Set cache size to @var{value} (in bytes) for xbzrle migrations. 941ETEXI 942 943 { 944 .name = "migrate_set_speed", 945 .args_type = "value:o", 946 .params = "value", 947 .help = "set maximum speed (in bytes) for migrations. " 948 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T", 949 .mhandler.cmd = hmp_migrate_set_speed, 950 }, 951 952STEXI 953@item migrate_set_speed @var{value} 954@findex migrate_set_speed 955Set maximum speed to @var{value} (in bytes) for migrations. 956ETEXI 957 958 { 959 .name = "migrate_set_downtime", 960 .args_type = "value:T", 961 .params = "value", 962 .help = "set maximum tolerated downtime (in seconds) for migrations", 963 .mhandler.cmd = hmp_migrate_set_downtime, 964 }, 965 966STEXI 967@item migrate_set_downtime @var{second} 968@findex migrate_set_downtime 969Set maximum tolerated downtime (in seconds) for migration. 970ETEXI 971 972 { 973 .name = "migrate_set_capability", 974 .args_type = "capability:s,state:b", 975 .params = "capability state", 976 .help = "Enable/Disable the usage of a capability for migration", 977 .mhandler.cmd = hmp_migrate_set_capability, 978 .command_completion = migrate_set_capability_completion, 979 }, 980 981STEXI 982@item migrate_set_capability @var{capability} @var{state} 983@findex migrate_set_capability 984Enable/Disable the usage of a capability @var{capability} for migration. 985ETEXI 986 987 { 988 .name = "client_migrate_info", 989 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?", 990 .params = "protocol hostname port tls-port cert-subject", 991 .help = "send migration info to spice/vnc client", 992 .user_print = monitor_user_noop, 993 .mhandler.cmd_async = client_migrate_info, 994 .flags = MONITOR_CMD_ASYNC, 995 }, 996 997STEXI 998@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject} 999@findex client_migrate_info 1000Set the spice/vnc connection info for the migration target. The spice/vnc 1001server will ask the spice/vnc client to automatically reconnect using the 1002new parameters (if specified) once the vm migration finished successfully. 1003ETEXI 1004 1005 { 1006 .name = "dump-guest-memory", 1007 .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?", 1008 .params = "[-p] [-z|-l|-s] filename [begin length]", 1009 .help = "dump guest memory into file 'filename'.\n\t\t\t" 1010 "-p: do paging to get guest's memory mapping.\n\t\t\t" 1011 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t" 1012 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t" 1013 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t" 1014 "begin: the starting physical address.\n\t\t\t" 1015 "length: the memory size, in bytes.", 1016 .mhandler.cmd = hmp_dump_guest_memory, 1017 }, 1018 1019 1020STEXI 1021@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length} 1022@item dump-guest-memory [-z|-l|-s] @var{filename} 1023@findex dump-guest-memory 1024Dump guest memory to @var{protocol}. The file can be processed with crash or 1025gdb. Without -z|-l|-s, the dump format is ELF. 1026 -p: do paging to get guest's memory mapping. 1027 -z: dump in kdump-compressed format, with zlib compression. 1028 -l: dump in kdump-compressed format, with lzo compression. 1029 -s: dump in kdump-compressed format, with snappy compression. 1030 filename: dump file name. 1031 begin: the starting physical address. It's optional, and should be 1032 specified together with length. 1033 length: the memory size, in bytes. It's optional, and should be specified 1034 together with begin. 1035ETEXI 1036 1037 { 1038 .name = "snapshot_blkdev", 1039 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?", 1040 .params = "[-n] device [new-image-file] [format]", 1041 .help = "initiates a live snapshot\n\t\t\t" 1042 "of device. If a new image file is specified, the\n\t\t\t" 1043 "new image file will become the new root image.\n\t\t\t" 1044 "If format is specified, the snapshot file will\n\t\t\t" 1045 "be created in that format.\n\t\t\t" 1046 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t" 1047 "to reuse the image found in new-image-file, instead of\n\t\t\t" 1048 "recreating it from scratch.", 1049 .mhandler.cmd = hmp_snapshot_blkdev, 1050 }, 1051 1052STEXI 1053@item snapshot_blkdev 1054@findex snapshot_blkdev 1055Snapshot device, using snapshot file as target if provided 1056ETEXI 1057 1058 { 1059 .name = "snapshot_blkdev_internal", 1060 .args_type = "device:B,name:s", 1061 .params = "device name", 1062 .help = "take an internal snapshot of device.\n\t\t\t" 1063 "The format of the image used by device must\n\t\t\t" 1064 "support it, such as qcow2.\n\t\t\t", 1065 .mhandler.cmd = hmp_snapshot_blkdev_internal, 1066 }, 1067 1068STEXI 1069@item snapshot_blkdev_internal 1070@findex snapshot_blkdev_internal 1071Take an internal snapshot on device if it support 1072ETEXI 1073 1074 { 1075 .name = "snapshot_delete_blkdev_internal", 1076 .args_type = "device:B,name:s,id:s?", 1077 .params = "device name [id]", 1078 .help = "delete an internal snapshot of device.\n\t\t\t" 1079 "If id is specified, qemu will try delete\n\t\t\t" 1080 "the snapshot matching both id and name.\n\t\t\t" 1081 "The format of the image used by device must\n\t\t\t" 1082 "support it, such as qcow2.\n\t\t\t", 1083 .mhandler.cmd = hmp_snapshot_delete_blkdev_internal, 1084 }, 1085 1086STEXI 1087@item snapshot_delete_blkdev_internal 1088@findex snapshot_delete_blkdev_internal 1089Delete an internal snapshot on device if it support 1090ETEXI 1091 1092 { 1093 .name = "drive_mirror", 1094 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?", 1095 .params = "[-n] [-f] device target [format]", 1096 .help = "initiates live storage\n\t\t\t" 1097 "migration for a device. The device's contents are\n\t\t\t" 1098 "copied to the new image file, including data that\n\t\t\t" 1099 "is written after the command is started.\n\t\t\t" 1100 "The -n flag requests QEMU to reuse the image found\n\t\t\t" 1101 "in new-image-file, instead of recreating it from scratch.\n\t\t\t" 1102 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" 1103 "so that the result does not need a backing file.\n\t\t\t", 1104 .mhandler.cmd = hmp_drive_mirror, 1105 }, 1106STEXI 1107@item drive_mirror 1108@findex drive_mirror 1109Start mirroring a block device's writes to a new destination, 1110using the specified target. 1111ETEXI 1112 1113 { 1114 .name = "drive_backup", 1115 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?", 1116 .params = "[-n] [-f] device target [format]", 1117 .help = "initiates a point-in-time\n\t\t\t" 1118 "copy for a device. The device's contents are\n\t\t\t" 1119 "copied to the new image file, excluding data that\n\t\t\t" 1120 "is written after the command is started.\n\t\t\t" 1121 "The -n flag requests QEMU to reuse the image found\n\t\t\t" 1122 "in new-image-file, instead of recreating it from scratch.\n\t\t\t" 1123 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" 1124 "so that the result does not need a backing file.\n\t\t\t", 1125 .mhandler.cmd = hmp_drive_backup, 1126 }, 1127STEXI 1128@item drive_backup 1129@findex drive_backup 1130Start a point-in-time copy of a block device to a specificed target. 1131ETEXI 1132 1133 { 1134 .name = "drive_add", 1135 .args_type = "pci_addr:s,opts:s", 1136 .params = "[[<domain>:]<bus>:]<slot>\n" 1137 "[file=file][,if=type][,bus=n]\n" 1138 "[,unit=m][,media=d][,index=i]\n" 1139 "[,cyls=c,heads=h,secs=s[,trans=t]]\n" 1140 "[,snapshot=on|off][,cache=on|off]\n" 1141 "[,readonly=on|off][,copy-on-read=on|off]", 1142 .help = "add drive to PCI storage controller", 1143 .mhandler.cmd = drive_hot_add, 1144 }, 1145 1146STEXI 1147@item drive_add 1148@findex drive_add 1149Add drive to PCI storage controller. 1150ETEXI 1151 1152#if defined(CONFIG_PCI_HOTPLUG_OLD) 1153 { 1154 .name = "pci_add", 1155 .args_type = "pci_addr:s,type:s,opts:s?", 1156 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...", 1157 .help = "hot-add PCI device", 1158 .mhandler.cmd = pci_device_hot_add, 1159 }, 1160#endif 1161 1162STEXI 1163@item pci_add 1164@findex pci_add 1165Hot-add PCI device. 1166ETEXI 1167 1168#if defined(CONFIG_PCI_HOTPLUG_OLD) 1169 { 1170 .name = "pci_del", 1171 .args_type = "pci_addr:s", 1172 .params = "[[<domain>:]<bus>:]<slot>", 1173 .help = "hot remove PCI device", 1174 .mhandler.cmd = do_pci_device_hot_remove, 1175 }, 1176#endif 1177 1178STEXI 1179@item pci_del 1180@findex pci_del 1181Hot remove PCI device. 1182ETEXI 1183 1184 { 1185 .name = "pcie_aer_inject_error", 1186 .args_type = "advisory_non_fatal:-a,correctable:-c," 1187 "id:s,error_status:s," 1188 "header0:i?,header1:i?,header2:i?,header3:i?," 1189 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?", 1190 .params = "[-a] [-c] id " 1191 "<error_status> [<tlp header> [<tlp header prefix>]]", 1192 .help = "inject pcie aer error\n\t\t\t" 1193 " -a for advisory non fatal error\n\t\t\t" 1194 " -c for correctable error\n\t\t\t" 1195 "<id> = qdev device id\n\t\t\t" 1196 "<error_status> = error string or 32bit\n\t\t\t" 1197 "<tlb header> = 32bit x 4\n\t\t\t" 1198 "<tlb header prefix> = 32bit x 4", 1199 .user_print = pcie_aer_inject_error_print, 1200 .mhandler.cmd_new = do_pcie_aer_inject_error, 1201 }, 1202 1203STEXI 1204@item pcie_aer_inject_error 1205@findex pcie_aer_inject_error 1206Inject PCIe AER error 1207ETEXI 1208 1209 { 1210 .name = "host_net_add", 1211 .args_type = "device:s,opts:s?", 1212 .params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]", 1213 .help = "add host VLAN client", 1214 .mhandler.cmd = net_host_device_add, 1215 .command_completion = host_net_add_completion, 1216 }, 1217 1218STEXI 1219@item host_net_add 1220@findex host_net_add 1221Add host VLAN client. 1222ETEXI 1223 1224 { 1225 .name = "host_net_remove", 1226 .args_type = "vlan_id:i,device:s", 1227 .params = "vlan_id name", 1228 .help = "remove host VLAN client", 1229 .mhandler.cmd = net_host_device_remove, 1230 .command_completion = host_net_remove_completion, 1231 }, 1232 1233STEXI 1234@item host_net_remove 1235@findex host_net_remove 1236Remove host VLAN client. 1237ETEXI 1238 1239 { 1240 .name = "netdev_add", 1241 .args_type = "netdev:O", 1242 .params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]", 1243 .help = "add host network device", 1244 .mhandler.cmd = hmp_netdev_add, 1245 .command_completion = netdev_add_completion, 1246 }, 1247 1248STEXI 1249@item netdev_add 1250@findex netdev_add 1251Add host network device. 1252ETEXI 1253 1254 { 1255 .name = "netdev_del", 1256 .args_type = "id:s", 1257 .params = "id", 1258 .help = "remove host network device", 1259 .mhandler.cmd = hmp_netdev_del, 1260 .command_completion = netdev_del_completion, 1261 }, 1262 1263STEXI 1264@item netdev_del 1265@findex netdev_del 1266Remove host network device. 1267ETEXI 1268 1269 { 1270 .name = "object_add", 1271 .args_type = "object:O", 1272 .params = "[qom-type=]type,id=str[,prop=value][,...]", 1273 .help = "create QOM object", 1274 .mhandler.cmd = hmp_object_add, 1275 .command_completion = object_add_completion, 1276 }, 1277 1278STEXI 1279@item object_add 1280@findex object_add 1281Create QOM object. 1282ETEXI 1283 1284 { 1285 .name = "object_del", 1286 .args_type = "id:s", 1287 .params = "id", 1288 .help = "destroy QOM object", 1289 .mhandler.cmd = hmp_object_del, 1290 .command_completion = object_del_completion, 1291 }, 1292 1293STEXI 1294@item object_del 1295@findex object_del 1296Destroy QOM object. 1297ETEXI 1298 1299#ifdef CONFIG_SLIRP 1300 { 1301 .name = "hostfwd_add", 1302 .args_type = "arg1:s,arg2:s?,arg3:s?", 1303 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport", 1304 .help = "redirect TCP or UDP connections from host to guest (requires -net user)", 1305 .mhandler.cmd = net_slirp_hostfwd_add, 1306 }, 1307#endif 1308STEXI 1309@item hostfwd_add 1310@findex hostfwd_add 1311Redirect TCP or UDP connections from host to guest (requires -net user). 1312ETEXI 1313 1314#ifdef CONFIG_SLIRP 1315 { 1316 .name = "hostfwd_remove", 1317 .args_type = "arg1:s,arg2:s?,arg3:s?", 1318 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport", 1319 .help = "remove host-to-guest TCP or UDP redirection", 1320 .mhandler.cmd = net_slirp_hostfwd_remove, 1321 }, 1322 1323#endif 1324STEXI 1325@item hostfwd_remove 1326@findex hostfwd_remove 1327Remove host-to-guest TCP or UDP redirection. 1328ETEXI 1329 1330 { 1331 .name = "balloon", 1332 .args_type = "value:M", 1333 .params = "target", 1334 .help = "request VM to change its memory allocation (in MB)", 1335 .mhandler.cmd = hmp_balloon, 1336 }, 1337 1338STEXI 1339@item balloon @var{value} 1340@findex balloon 1341Request VM to change its memory allocation to @var{value} (in MB). 1342ETEXI 1343 1344 { 1345 .name = "set_link", 1346 .args_type = "name:s,up:b", 1347 .params = "name on|off", 1348 .help = "change the link status of a network adapter", 1349 .mhandler.cmd = hmp_set_link, 1350 .command_completion = set_link_completion, 1351 }, 1352 1353STEXI 1354@item set_link @var{name} [on|off] 1355@findex set_link 1356Switch link @var{name} on (i.e. up) or off (i.e. down). 1357ETEXI 1358 1359 { 1360 .name = "watchdog_action", 1361 .args_type = "action:s", 1362 .params = "[reset|shutdown|poweroff|pause|debug|none]", 1363 .help = "change watchdog action", 1364 .mhandler.cmd = do_watchdog_action, 1365 .command_completion = watchdog_action_completion, 1366 }, 1367 1368STEXI 1369@item watchdog_action 1370@findex watchdog_action 1371Change watchdog action. 1372ETEXI 1373 1374 { 1375 .name = "acl_show", 1376 .args_type = "aclname:s", 1377 .params = "aclname", 1378 .help = "list rules in the access control list", 1379 .mhandler.cmd = do_acl_show, 1380 }, 1381 1382STEXI 1383@item acl_show @var{aclname} 1384@findex acl_show 1385List all the matching rules in the access control list, and the default 1386policy. There are currently two named access control lists, 1387@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client 1388certificate distinguished name, and SASL username respectively. 1389ETEXI 1390 1391 { 1392 .name = "acl_policy", 1393 .args_type = "aclname:s,policy:s", 1394 .params = "aclname allow|deny", 1395 .help = "set default access control list policy", 1396 .mhandler.cmd = do_acl_policy, 1397 }, 1398 1399STEXI 1400@item acl_policy @var{aclname} @code{allow|deny} 1401@findex acl_policy 1402Set the default access control list policy, used in the event that 1403none of the explicit rules match. The default policy at startup is 1404always @code{deny}. 1405ETEXI 1406 1407 { 1408 .name = "acl_add", 1409 .args_type = "aclname:s,match:s,policy:s,index:i?", 1410 .params = "aclname match allow|deny [index]", 1411 .help = "add a match rule to the access control list", 1412 .mhandler.cmd = do_acl_add, 1413 }, 1414 1415STEXI 1416@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}] 1417@findex acl_add 1418Add a match rule to the access control list, allowing or denying access. 1419The match will normally be an exact username or x509 distinguished name, 1420but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to 1421allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will 1422normally be appended to the end of the ACL, but can be inserted 1423earlier in the list if the optional @var{index} parameter is supplied. 1424ETEXI 1425 1426 { 1427 .name = "acl_remove", 1428 .args_type = "aclname:s,match:s", 1429 .params = "aclname match", 1430 .help = "remove a match rule from the access control list", 1431 .mhandler.cmd = do_acl_remove, 1432 }, 1433 1434STEXI 1435@item acl_remove @var{aclname} @var{match} 1436@findex acl_remove 1437Remove the specified match rule from the access control list. 1438ETEXI 1439 1440 { 1441 .name = "acl_reset", 1442 .args_type = "aclname:s", 1443 .params = "aclname", 1444 .help = "reset the access control list", 1445 .mhandler.cmd = do_acl_reset, 1446 }, 1447 1448STEXI 1449@item acl_reset @var{aclname} 1450@findex acl_reset 1451Remove all matches from the access control list, and set the default 1452policy back to @code{deny}. 1453ETEXI 1454 1455 { 1456 .name = "nbd_server_start", 1457 .args_type = "all:-a,writable:-w,uri:s", 1458 .params = "nbd_server_start [-a] [-w] host:port", 1459 .help = "serve block devices on the given host and port", 1460 .mhandler.cmd = hmp_nbd_server_start, 1461 }, 1462STEXI 1463@item nbd_server_start @var{host}:@var{port} 1464@findex nbd_server_start 1465Start an NBD server on the given host and/or port. If the @option{-a} 1466option is included, all of the virtual machine's block devices that 1467have an inserted media on them are automatically exported; in this case, 1468the @option{-w} option makes the devices writable too. 1469ETEXI 1470 1471 { 1472 .name = "nbd_server_add", 1473 .args_type = "writable:-w,device:B", 1474 .params = "nbd_server_add [-w] device", 1475 .help = "export a block device via NBD", 1476 .mhandler.cmd = hmp_nbd_server_add, 1477 }, 1478STEXI 1479@item nbd_server_add @var{device} 1480@findex nbd_server_add 1481Export a block device through QEMU's NBD server, which must be started 1482beforehand with @command{nbd_server_start}. The @option{-w} option makes the 1483exported device writable too. 1484ETEXI 1485 1486 { 1487 .name = "nbd_server_stop", 1488 .args_type = "", 1489 .params = "nbd_server_stop", 1490 .help = "stop serving block devices using the NBD protocol", 1491 .mhandler.cmd = hmp_nbd_server_stop, 1492 }, 1493STEXI 1494@item nbd_server_stop 1495@findex nbd_server_stop 1496Stop the QEMU embedded NBD server. 1497ETEXI 1498 1499 1500#if defined(TARGET_I386) 1501 1502 { 1503 .name = "mce", 1504 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", 1505 .params = "[-b] cpu bank status mcgstatus addr misc", 1506 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]", 1507 .mhandler.cmd = do_inject_mce, 1508 }, 1509 1510#endif 1511STEXI 1512@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc} 1513@findex mce (x86) 1514Inject an MCE on the given CPU (x86 only). 1515ETEXI 1516 1517 { 1518 .name = "getfd", 1519 .args_type = "fdname:s", 1520 .params = "getfd name", 1521 .help = "receive a file descriptor via SCM rights and assign it a name", 1522 .mhandler.cmd = hmp_getfd, 1523 }, 1524 1525STEXI 1526@item getfd @var{fdname} 1527@findex getfd 1528If a file descriptor is passed alongside this command using the SCM_RIGHTS 1529mechanism on unix sockets, it is stored using the name @var{fdname} for 1530later use by other monitor commands. 1531ETEXI 1532 1533 { 1534 .name = "closefd", 1535 .args_type = "fdname:s", 1536 .params = "closefd name", 1537 .help = "close a file descriptor previously passed via SCM rights", 1538 .mhandler.cmd = hmp_closefd, 1539 }, 1540 1541STEXI 1542@item closefd @var{fdname} 1543@findex closefd 1544Close the file descriptor previously assigned to @var{fdname} using the 1545@code{getfd} command. This is only needed if the file descriptor was never 1546used by another monitor command. 1547ETEXI 1548 1549 { 1550 .name = "block_passwd", 1551 .args_type = "device:B,password:s", 1552 .params = "block_passwd device password", 1553 .help = "set the password of encrypted block devices", 1554 .mhandler.cmd = hmp_block_passwd, 1555 }, 1556 1557STEXI 1558@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} 1559@findex block_set_io_throttle 1560Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr} 1561ETEXI 1562 1563 { 1564 .name = "block_set_io_throttle", 1565 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l", 1566 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr", 1567 .help = "change I/O throttle limits for a block drive", 1568 .mhandler.cmd = hmp_block_set_io_throttle, 1569 }, 1570 1571STEXI 1572@item block_passwd @var{device} @var{password} 1573@findex block_passwd 1574Set the encrypted device @var{device} password to @var{password} 1575ETEXI 1576 1577 { 1578 .name = "set_password", 1579 .args_type = "protocol:s,password:s,connected:s?", 1580 .params = "protocol password action-if-connected", 1581 .help = "set spice/vnc password", 1582 .mhandler.cmd = hmp_set_password, 1583 }, 1584 1585STEXI 1586@item set_password [ vnc | spice ] password [ action-if-connected ] 1587@findex set_password 1588 1589Change spice/vnc password. Use zero to make the password stay valid 1590forever. @var{action-if-connected} specifies what should happen in 1591case a connection is established: @var{fail} makes the password change 1592fail. @var{disconnect} changes the password and disconnects the 1593client. @var{keep} changes the password and keeps the connection up. 1594@var{keep} is the default. 1595ETEXI 1596 1597 { 1598 .name = "expire_password", 1599 .args_type = "protocol:s,time:s", 1600 .params = "protocol time", 1601 .help = "set spice/vnc password expire-time", 1602 .mhandler.cmd = hmp_expire_password, 1603 }, 1604 1605STEXI 1606@item expire_password [ vnc | spice ] expire-time 1607@findex expire_password 1608 1609Specify when a password for spice/vnc becomes 1610invalid. @var{expire-time} accepts: 1611 1612@table @var 1613@item now 1614Invalidate password instantly. 1615 1616@item never 1617Password stays valid forever. 1618 1619@item +nsec 1620Password stays valid for @var{nsec} seconds starting now. 1621 1622@item nsec 1623Password is invalidated at the given time. @var{nsec} are the seconds 1624passed since 1970, i.e. unix epoch. 1625 1626@end table 1627ETEXI 1628 1629 { 1630 .name = "chardev-add", 1631 .args_type = "args:s", 1632 .params = "args", 1633 .help = "add chardev", 1634 .mhandler.cmd = hmp_chardev_add, 1635 .command_completion = chardev_add_completion, 1636 }, 1637 1638STEXI 1639@item chardev_add args 1640@findex chardev_add 1641 1642chardev_add accepts the same parameters as the -chardev command line switch. 1643 1644ETEXI 1645 1646 { 1647 .name = "chardev-remove", 1648 .args_type = "id:s", 1649 .params = "id", 1650 .help = "remove chardev", 1651 .mhandler.cmd = hmp_chardev_remove, 1652 .command_completion = chardev_remove_completion, 1653 }, 1654 1655STEXI 1656@item chardev_remove id 1657@findex chardev_remove 1658 1659Removes the chardev @var{id}. 1660 1661ETEXI 1662 1663 { 1664 .name = "qemu-io", 1665 .args_type = "device:B,command:s", 1666 .params = "[device] \"[command]\"", 1667 .help = "run a qemu-io command on a block device", 1668 .mhandler.cmd = hmp_qemu_io, 1669 }, 1670 1671STEXI 1672@item qemu-io @var{device} @var{command} 1673@findex qemu-io 1674 1675Executes a qemu-io command on the given block device. 1676 1677ETEXI 1678 1679 { 1680 .name = "cpu-add", 1681 .args_type = "id:i", 1682 .params = "id", 1683 .help = "add cpu", 1684 .mhandler.cmd = hmp_cpu_add, 1685 }, 1686 1687STEXI 1688@item cpu-add @var{id} 1689Add CPU with id @var{id} 1690ETEXI 1691 1692 { 1693 .name = "info", 1694 .args_type = "item:s?", 1695 .params = "[subcommand]", 1696 .help = "show various information about the system state", 1697 .mhandler.cmd = do_info_help, 1698 .sub_table = info_cmds, 1699 }, 1700 1701STEXI 1702@item info @var{subcommand} 1703@findex info 1704Show various information about the system state. 1705 1706@table @option 1707@item info version 1708show the version of QEMU 1709@item info network 1710show the various VLANs and the associated devices 1711@item info chardev 1712show the character devices 1713@item info block 1714show the block devices 1715@item info blockstats 1716show block device statistics 1717@item info registers 1718show the cpu registers 1719@item info cpus 1720show infos for each CPU 1721@item info history 1722show the command line history 1723@item info irq 1724show the interrupts statistics (if available) 1725@item info pic 1726show i8259 (PIC) state 1727@item info pci 1728show emulated PCI device info 1729@item info tlb 1730show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only) 1731@item info mem 1732show the active virtual memory mappings (i386 only) 1733@item info jit 1734show dynamic compiler info 1735@item info numa 1736show NUMA information 1737@item info kvm 1738show KVM information 1739@item info usb 1740show USB devices plugged on the virtual USB hub 1741@item info usbhost 1742show all USB host devices 1743@item info profile 1744show profiling information 1745@item info capture 1746show information about active capturing 1747@item info snapshots 1748show list of VM snapshots 1749@item info status 1750show the current VM status (running|paused) 1751@item info mice 1752show which guest mouse is receiving events 1753@item info vnc 1754show the vnc server status 1755@item info name 1756show the current VM name 1757@item info uuid 1758show the current VM UUID 1759@item info cpustats 1760show CPU statistics 1761@item info usernet 1762show user network stack connection states 1763@item info migrate 1764show migration status 1765@item info migrate_capabilities 1766show current migration capabilities 1767@item info migrate_cache_size 1768show current migration XBZRLE cache size 1769@item info balloon 1770show balloon information 1771@item info qtree 1772show device tree 1773@item info qdm 1774show qdev device model list 1775@item info roms 1776show roms 1777@item info tpm 1778show the TPM device 1779@item info memory-devices 1780show the memory devices 1781@end table 1782ETEXI 1783 1784STEXI 1785@item info trace-events 1786show available trace events and their state 1787ETEXI 1788 1789STEXI 1790@end table 1791ETEXI 1792