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