hmp-commands.hx 49.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
HXCOMM Use DEFHEADING() to define headings in both help text and texi
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
HXCOMM HXCOMM can be used for comments, discarded from both texi and C

STEXI
@table @option
ETEXI

12 13
    {
        .name       = "help|?",
14
        .args_type  = "name:S?",
15 16
        .params     = "[cmd]",
        .help       = "show the help",
17
        .mhandler.cmd = do_help_cmd,
18 19
    },

20 21
STEXI
@item help or ? [@var{cmd}]
22
@findex help
23 24 25
Show the help for all commands or just for command @var{cmd}.
ETEXI

26 27 28 29 30
    {
        .name       = "commit",
        .args_type  = "device:B",
        .params     = "device|all",
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
31
        .mhandler.cmd = do_commit,
32 33
    },

34 35
STEXI
@item commit
36
@findex commit
37
Commit changes to the disk images (if -snapshot is used) or backing files.
38 39 40 41 42
If the backing file is smaller than the snapshot, then the backing file will be
resized to be the same size as the snapshot.  If the snapshot is smaller than
the backing file, the backing file will not be truncated.  If you want the
backing file to match the size of the smaller snapshot, you can safely truncate
it yourself once the commit operation successfully completes.
43 44
ETEXI

45 46 47 48 49
    {
        .name       = "q|quit",
        .args_type  = "",
        .params     = "",
        .help       = "quit the emulator",
50
        .user_print = monitor_user_noop,
L
Luiz Capitulino 已提交
51
        .mhandler.cmd = hmp_quit,
52 53
    },

54 55
STEXI
@item q or quit
56
@findex quit
57 58 59
Quit the emulator.
ETEXI

60 61 62 63 64
    {
        .name       = "block_resize",
        .args_type  = "device:B,size:o",
        .params     = "device size",
        .help       = "resize a block image",
65
        .mhandler.cmd = hmp_block_resize,
66 67 68 69 70 71 72 73 74 75 76
    },

STEXI
@item block_resize
@findex block_resize
Resize a block image while a guest is running.  Usually requires guest
action to see the updated size.  Resize to a lower size is supported,
but should be used with extreme caution.  Note that this command only
resizes image files, it can not resize block devices like LVM volumes.
ETEXI

77 78
    {
        .name       = "block_stream",
79 80
        .args_type  = "device:B,speed:o?,base:s?",
        .params     = "device [speed [base]]",
81 82 83 84 85 86 87 88
        .help       = "copy data from a backing file into a block device",
        .mhandler.cmd = hmp_block_stream,
    },

STEXI
@item block_stream
@findex block_stream
Copy data from a backing file into a block device.
89 90 91 92
ETEXI

    {
        .name       = "block_job_set_speed",
93 94
        .args_type  = "device:B,speed:o",
        .params     = "device speed",
95 96 97 98 99
        .help       = "set maximum speed for a background block operation",
        .mhandler.cmd = hmp_block_job_set_speed,
    },

STEXI
100 101
@item block_job_set_speed
@findex block_job_set_speed
102
Set maximum speed for a background block operation.
103 104 105 106
ETEXI

    {
        .name       = "block_job_cancel",
107 108 109 110
        .args_type  = "force:-f,device:B",
        .params     = "[-f] device",
        .help       = "stop an active background block operation (use -f"
                      "\n\t\t\t if the operation is currently paused)",
111 112 113 114 115 116
        .mhandler.cmd = hmp_block_job_cancel,
    },

STEXI
@item block_job_cancel
@findex block_job_cancel
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
Stop an active background block operation (streaming, mirroring).
ETEXI

    {
        .name       = "block_job_complete",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "stop an active background block operation",
        .mhandler.cmd = hmp_block_job_complete,
    },

STEXI
@item block_job_complete
@findex block_job_complete
Manually trigger completion of an active background block operation.
For mirroring, this will switch the device to the destination path.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
ETEXI

    {
        .name       = "block_job_pause",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "pause an active background block operation",
        .mhandler.cmd = hmp_block_job_pause,
    },

STEXI
@item block_job_pause
@findex block_job_pause
Pause an active block streaming operation.
ETEXI

    {
        .name       = "block_job_resume",
        .args_type  = "device:B",
        .params     = "device",
        .help       = "resume a paused background block operation",
        .mhandler.cmd = hmp_block_job_resume,
    },

STEXI
@item block_job_resume
@findex block_job_resume
Resume a paused block streaming operation.
161
ETEXI
162

163 164
    {
        .name       = "eject",
165
        .args_type  = "force:-f,device:B",
166 167
        .params     = "[-f] device",
        .help       = "eject a removable medium (use -f to force it)",
L
Luiz Capitulino 已提交
168
        .mhandler.cmd = hmp_eject,
169 170
    },

171 172
STEXI
@item eject [-f] @var{device}
173
@findex eject
174
Eject a removable medium (use -f to force it).
175 176 177 178
ETEXI

    {
        .name       = "drive_del",
179
        .args_type  = "id:B",
180 181 182 183 184 185 186 187 188 189 190 191 192
        .params     = "device",
        .help       = "remove host block device",
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_drive_del,
    },

STEXI
@item drive_del @var{device}
@findex drive_del
Remove host block device.  The result is that guest generated IO is no longer
submitted against the host device underlying the disk.  Once a drive has
been deleted, the QEMU Block layer returns -EIO which results in IO
errors in the guest for applications that are reading/writing to the device.
193 194
These errors are always reported to the guest, regardless of the drive's error
actions (drive options rerror, werror).
195 196
ETEXI

197 198 199 200 201
    {
        .name       = "change",
        .args_type  = "device:B,target:F,arg:s?",
        .params     = "device filename [format]",
        .help       = "change a removable medium, optional format",
L
Luiz Capitulino 已提交
202
        .mhandler.cmd = hmp_change,
203 204
    },

205 206
STEXI
@item change @var{device} @var{setting}
207
@findex change
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

Change the configuration of a device.

@table @option
@item change @var{diskdevice} @var{filename} [@var{format}]
Change the medium for a removable disk device to point to @var{filename}. eg

@example
(qemu) change ide1-cd0 /path/to/some.iso
@end example

@var{format} is optional.

@item change vnc @var{display},@var{options}
Change the configuration of the VNC server. The valid syntax for @var{display}
and @var{options} are described at @ref{sec_invocation}. eg

@example
(qemu) change vnc localhost:1
@end example

@item change vnc password [@var{password}]

Change the password associated with the VNC server. If the new password is not
supplied, the monitor will prompt for it to be entered. VNC passwords are only
significant up to 8 letters. eg

@example
(qemu) change vnc password
Password: ********
@end example

@end table
ETEXI

243 244 245 246 247
    {
        .name       = "screendump",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "save screen into PPM image 'filename'",
248
        .mhandler.cmd = hmp_screen_dump,
249 250
    },

251 252
STEXI
@item screendump @var{filename}
253
@findex screendump
254 255 256
Save screen into PPM image @var{filename}.
ETEXI

257 258 259 260 261
    {
        .name       = "logfile",
        .args_type  = "filename:F",
        .params     = "filename",
        .help       = "output logs to 'filename'",
262
        .mhandler.cmd = do_logfile,
263 264
    },

265 266
STEXI
@item logfile @var{filename}
267
@findex logfile
268 269 270
Output logs to @var{filename}.
ETEXI

271 272 273 274 275
    {
        .name       = "trace-event",
        .args_type  = "name:s,option:b",
        .params     = "name on|off",
        .help       = "changes status of a specific trace event",
276
        .mhandler.cmd = do_trace_event_set_state,
277 278 279 280 281 282
    },

STEXI
@item trace-event
@findex trace-event
changes status of a trace event
283 284
ETEXI

285
#if defined(CONFIG_TRACE_SIMPLE)
286 287 288 289 290 291 292 293 294 295 296 297
    {
        .name       = "trace-file",
        .args_type  = "op:s?,arg:F?",
        .params     = "on|off|flush|set [arg]",
        .help       = "open, close, or flush trace file, or set a new file name",
        .mhandler.cmd = do_trace_file,
    },

STEXI
@item trace-file on|off|flush
@findex trace-file
Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
298 299 300
ETEXI
#endif

301 302 303 304
    {
        .name       = "log",
        .args_type  = "items:s",
        .params     = "item1[,...]",
305
        .help       = "activate logging of the specified items",
306
        .mhandler.cmd = do_log,
307 308
    },

309 310
STEXI
@item log @var{item1}[,...]
311
@findex log
312
Activate logging of the specified items.
313 314
ETEXI

315 316 317 318 319
    {
        .name       = "savevm",
        .args_type  = "name:s?",
        .params     = "[tag|id]",
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
320
        .mhandler.cmd = do_savevm,
321 322
    },

323 324
STEXI
@item savevm [@var{tag}|@var{id}]
325
@findex savevm
326 327 328 329 330 331
Create a snapshot of the whole virtual machine. If @var{tag} is
provided, it is used as human readable identifier. If there is already
a snapshot with the same tag or ID, it is replaced. More info at
@ref{vm_snapshots}.
ETEXI

332 333 334 335 336
    {
        .name       = "loadvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "restore a VM snapshot from its tag or id",
337
        .mhandler.cmd = do_loadvm,
338 339
    },

340 341
STEXI
@item loadvm @var{tag}|@var{id}
342
@findex loadvm
343 344 345 346
Set the whole virtual machine to the snapshot identified by the tag
@var{tag} or the unique snapshot ID @var{id}.
ETEXI

347 348 349 350 351
    {
        .name       = "delvm",
        .args_type  = "name:s",
        .params     = "tag|id",
        .help       = "delete a VM snapshot from its tag or id",
352
        .mhandler.cmd = do_delvm,
353 354
    },

355 356
STEXI
@item delvm @var{tag}|@var{id}
357
@findex delvm
358 359 360
Delete the snapshot identified by @var{tag} or @var{id}.
ETEXI

361 362 363 364 365
    {
        .name       = "singlestep",
        .args_type  = "option:s?",
        .params     = "[on|off]",
        .help       = "run emulation in singlestep mode or switch to normal mode",
366
        .mhandler.cmd = do_singlestep,
367 368
    },

369 370
STEXI
@item singlestep [off]
371
@findex singlestep
372 373 374 375
Run the emulation in single step mode.
If called with option off, the emulation returns to normal mode.
ETEXI

376 377 378 379 380
    {
        .name       = "stop",
        .args_type  = "",
        .params     = "",
        .help       = "stop emulation",
L
Luiz Capitulino 已提交
381
        .mhandler.cmd = hmp_stop,
382 383
    },

384 385
STEXI
@item stop
386
@findex stop
387 388 389
Stop emulation.
ETEXI

390 391 392 393 394
    {
        .name       = "c|cont",
        .args_type  = "",
        .params     = "",
        .help       = "resume emulation",
L
Luiz Capitulino 已提交
395
        .mhandler.cmd = hmp_cont,
396 397
    },

398 399
STEXI
@item c or cont
400
@findex cont
401
Resume emulation.
402 403 404 405 406 407 408 409 410 411 412 413 414 415
ETEXI

    {
        .name       = "system_wakeup",
        .args_type  = "",
        .params     = "",
        .help       = "wakeup guest from suspend",
        .mhandler.cmd = hmp_system_wakeup,
    },

STEXI
@item system_wakeup
@findex system_wakeup
Wakeup guest from suspend.
416 417
ETEXI

418 419 420 421 422
    {
        .name       = "gdbserver",
        .args_type  = "device:s?",
        .params     = "[device]",
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
423
        .mhandler.cmd = do_gdbserver,
424 425
    },

426 427
STEXI
@item gdbserver [@var{port}]
428
@findex gdbserver
429 430 431
Start gdbserver session (default @var{port}=1234)
ETEXI

432 433 434 435 436
    {
        .name       = "x",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "virtual memory dump starting at 'addr'",
437
        .mhandler.cmd = do_memory_dump,
438 439
    },

440 441
STEXI
@item x/fmt @var{addr}
442
@findex x
443 444 445
Virtual memory dump starting at @var{addr}.
ETEXI

446 447 448 449 450
    {
        .name       = "xp",
        .args_type  = "fmt:/,addr:l",
        .params     = "/fmt addr",
        .help       = "physical memory dump starting at 'addr'",
451
        .mhandler.cmd = do_physical_memory_dump,
452 453
    },

454 455
STEXI
@item xp /@var{fmt} @var{addr}
456
@findex xp
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
Physical memory dump starting at @var{addr}.

@var{fmt} is a format which tells the command how to format the
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}

@table @var
@item count
is the number of items to be dumped.

@item format
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
c (char) or i (asm instruction).

@item size
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
@code{h} or @code{w} can be specified with the @code{i} format to
respectively select 16 or 32 bit code instruction size.

@end table

Examples:
@itemize
@item
Dump 10 instructions at the current instruction pointer:
@example
(qemu) x/10i $eip
0x90107063:  ret
0x90107064:  sti
0x90107065:  lea    0x0(%esi,1),%esi
0x90107069:  lea    0x0(%edi,1),%edi
0x90107070:  ret
0x90107071:  jmp    0x90107080
0x90107073:  nop
0x90107074:  nop
0x90107075:  nop
0x90107076:  nop
@end example

@item
Dump 80 16 bit values at the start of the video memory.
@smallexample
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
@end smallexample
@end itemize
ETEXI

513 514 515 516 517
    {
        .name       = "p|print",
        .args_type  = "fmt:/,val:l",
        .params     = "/fmt expr",
        .help       = "print expression value (use $reg for CPU register access)",
518
        .mhandler.cmd = do_print,
519 520
    },

521 522
STEXI
@item p or print/@var{fmt} @var{expr}
523
@findex print
524 525 526 527 528

Print expression value. Only the @var{format} part of @var{fmt} is
used.
ETEXI

529 530 531 532 533
    {
        .name       = "i",
        .args_type  = "fmt:/,addr:i,index:i.",
        .params     = "/fmt addr",
        .help       = "I/O port read",
534
        .mhandler.cmd = do_ioport_read,
535 536
    },

537 538 539 540
STEXI
Read I/O port.
ETEXI

541 542 543 544 545
    {
        .name       = "o",
        .args_type  = "fmt:/,addr:i,val:i",
        .params     = "/fmt addr value",
        .help       = "I/O port write",
546
        .mhandler.cmd = do_ioport_write,
547 548
    },

549 550 551
STEXI
Write to I/O port.
ETEXI
552

553 554
    {
        .name       = "sendkey",
A
Amos Kong 已提交
555
        .args_type  = "keys:s,hold-time:i?",
556 557
        .params     = "keys [hold_ms]",
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
A
Amos Kong 已提交
558
        .mhandler.cmd = hmp_send_key,
559
        .command_completion = sendkey_completion,
560 561
    },

562 563
STEXI
@item sendkey @var{keys}
564
@findex sendkey
565

566 567 568
Send @var{keys} to the guest. @var{keys} could be the name of the
key or the raw value in hexadecimal format. Use @code{-} to press
several keys simultaneously. Example:
569 570 571 572 573 574 575 576
@example
sendkey ctrl-alt-f1
@end example

This command is useful to send keys that your graphical user interface
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
ETEXI

577 578 579 580 581
    {
        .name       = "system_reset",
        .args_type  = "",
        .params     = "",
        .help       = "reset the system",
582
        .mhandler.cmd = hmp_system_reset,
583 584
    },

585 586
STEXI
@item system_reset
587
@findex system_reset
588 589 590 591

Reset the system.
ETEXI

592 593 594 595 596
    {
        .name       = "system_powerdown",
        .args_type  = "",
        .params     = "",
        .help       = "send system power down event",
597
        .mhandler.cmd = hmp_system_powerdown,
598 599
    },

600 601
STEXI
@item system_powerdown
602
@findex system_powerdown
603 604 605 606

Power down the system (if supported).
ETEXI

607 608 609 610 611
    {
        .name       = "sum",
        .args_type  = "start:i,size:i",
        .params     = "addr size",
        .help       = "compute the checksum of a memory region",
612
        .mhandler.cmd = do_sum,
613 614
    },

615 616
STEXI
@item sum @var{addr} @var{size}
617
@findex sum
618 619 620 621

Compute the checksum of a memory region.
ETEXI

622 623 624 625 626
    {
        .name       = "usb_add",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
627
        .mhandler.cmd = do_usb_add,
628 629
    },

630 631
STEXI
@item usb_add @var{devname}
632
@findex usb_add
633 634 635 636 637

Add the USB device @var{devname}.  For details of available devices see
@ref{usb_devices}
ETEXI

638 639 640 641 642
    {
        .name       = "usb_del",
        .args_type  = "devname:s",
        .params     = "device",
        .help       = "remove USB device 'bus.addr'",
643
        .mhandler.cmd = do_usb_del,
644 645
    },

646 647
STEXI
@item usb_del @var{devname}
648
@findex usb_del
649 650 651 652 653 654

Remove the USB device @var{devname} from the QEMU virtual USB
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
command @code{info usb} to see the devices you can remove.
ETEXI

655 656
    {
        .name       = "device_add",
657 658
        .args_type  = "device:O",
        .params     = "driver[,prop=value][,...]",
659
        .help       = "add device, like -device on the command line",
660 661
        .user_print = monitor_user_noop,
        .mhandler.cmd_new = do_device_add,
662
        .command_completion = device_add_completion,
663 664
    },

665 666
STEXI
@item device_add @var{config}
667
@findex device_add
668 669 670 671

Add device.
ETEXI

672 673 674 675 676
    {
        .name       = "device_del",
        .args_type  = "id:s",
        .params     = "device",
        .help       = "remove device",
677
        .mhandler.cmd = hmp_device_del,
678
        .command_completion = device_del_completion,
679 680
    },

681 682
STEXI
@item device_del @var{id}
683
@findex device_del
684 685 686 687

Remove device @var{id}.
ETEXI

688 689 690 691 692
    {
        .name       = "cpu",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set the default CPU",
693
        .mhandler.cmd = hmp_cpu,
694
    },
695

696
STEXI
697 698
@item cpu @var{index}
@findex cpu
699 700 701
Set the default CPU.
ETEXI

702 703 704 705 706
    {
        .name       = "mouse_move",
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
        .params     = "dx dy [dz]",
        .help       = "send mouse move events",
707
        .mhandler.cmd = do_mouse_move,
708 709
    },

710 711
STEXI
@item mouse_move @var{dx} @var{dy} [@var{dz}]
712
@findex mouse_move
713 714 715 716
Move the active mouse to the specified coordinates @var{dx} @var{dy}
with optional scroll axis @var{dz}.
ETEXI

717 718 719 720 721
    {
        .name       = "mouse_button",
        .args_type  = "button_state:i",
        .params     = "state",
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
722
        .mhandler.cmd = do_mouse_button,
723 724
    },

725 726
STEXI
@item mouse_button @var{val}
727
@findex mouse_button
728 729 730
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
ETEXI

731 732 733 734 735
    {
        .name       = "mouse_set",
        .args_type  = "index:i",
        .params     = "index",
        .help       = "set which mouse device receives events",
736
        .mhandler.cmd = do_mouse_set,
737 738
    },

739 740
STEXI
@item mouse_set @var{index}
741
@findex mouse_set
742 743 744 745 746 747 748
Set which mouse device receives events at given @var{index}, index
can be obtained with
@example
info mice
@end example
ETEXI

749 750 751 752 753
    {
        .name       = "wavcapture",
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
        .params     = "path [frequency [bits [channels]]]",
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
754
        .mhandler.cmd = do_wav_capture,
755
    },
756 757
STEXI
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
758
@findex wavcapture
759 760 761 762 763 764 765 766 767 768 769
Capture audio into @var{filename}. Using sample rate @var{frequency}
bits per sample @var{bits} and number of channels @var{channels}.

Defaults:
@itemize @minus
@item Sample rate = 44100 Hz - CD quality
@item Bits = 16
@item Number of channels = 2 - Stereo
@end itemize
ETEXI

770 771 772 773 774
    {
        .name       = "stopcapture",
        .args_type  = "n:i",
        .params     = "capture index",
        .help       = "stop capture",
775
        .mhandler.cmd = do_stop_capture,
776
    },
777 778
STEXI
@item stopcapture @var{index}
779
@findex stopcapture
780 781 782 783 784 785
Stop capture with a given @var{index}, index can be obtained with
@example
info capture
@end example
ETEXI

786 787 788 789 790
    {
        .name       = "memsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
L
Luiz Capitulino 已提交
791
        .mhandler.cmd = hmp_memsave,
792 793
    },

794 795
STEXI
@item memsave @var{addr} @var{size} @var{file}
796
@findex memsave
797 798 799
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
ETEXI

800 801 802 803 804
    {
        .name       = "pmemsave",
        .args_type  = "val:l,size:i,filename:s",
        .params     = "addr size file",
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
L
Luiz Capitulino 已提交
805
        .mhandler.cmd = hmp_pmemsave,
806 807
    },

808 809
STEXI
@item pmemsave @var{addr} @var{size} @var{file}
810
@findex pmemsave
811 812 813
save to disk physical memory dump starting at @var{addr} of size @var{size}.
ETEXI

814 815 816 817 818
    {
        .name       = "boot_set",
        .args_type  = "bootdevice:s",
        .params     = "bootdevice",
        .help       = "define new values for the boot device list",
819
        .mhandler.cmd = do_boot_set,
820 821
    },

822 823
STEXI
@item boot_set @var{bootdevicelist}
824
@findex boot_set
825 826 827 828 829 830 831 832

Define new values for the boot device list. Those values will override
the values specified on the command line through the @code{-boot} option.

The values that can be specified here depend on the machine type, but are
the same that can be specified in the @code{-boot} command line option.
ETEXI

833
#if defined(TARGET_I386) || defined(TARGET_S390X)
834 835
    {
        .name       = "nmi",
836 837 838
        .args_type  = "",
        .params     = "",
        .help       = "inject an NMI on all guest's CPUs",
839
        .mhandler.cmd = hmp_inject_nmi,
840
    },
841 842 843
#endif
STEXI
@item nmi @var{cpu}
844
@findex nmi
845
Inject an NMI (x86) or RESTART (s390x) on the given CPU.
846 847 848 849

ETEXI

    {
850
        .name       = "ringbuf_write",
851 852
        .args_type  = "device:s,data:s",
        .params     = "device data",
853 854
        .help       = "Write to a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_write,
855
        .command_completion = ringbuf_write_completion,
856 857 858
    },

STEXI
859 860 861 862
@item ringbuf_write @var{device} @var{data}
@findex ringbuf_write
Write @var{data} to ring buffer character device @var{device}.
@var{data} must be a UTF-8 string.
863

864 865 866
ETEXI

    {
867
        .name       = "ringbuf_read",
868 869
        .args_type  = "device:s,size:i",
        .params     = "device size",
870 871
        .help       = "Read from a ring buffer character device",
        .mhandler.cmd = hmp_ringbuf_read,
872
        .command_completion = ringbuf_write_completion,
873 874 875
    },

STEXI
876 877 878 879
@item ringbuf_read @var{device}
@findex ringbuf_read
Read and print up to @var{size} bytes from ring buffer character
device @var{device}.
880 881
Certain non-printable characters are printed \uXXXX, where XXXX is the
character code in hexadecimal.  Character \ is printed \\.
882 883 884
Bug: can screw up when the buffer contains invalid UTF-8 sequences,
NUL characters, after the ring buffer lost data, and when reading
stops because the size limit is reached.
885

886 887
ETEXI

888 889
    {
        .name       = "migrate",
890 891 892 893 894 895 896
        .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
        .params     = "[-d] [-b] [-i] uri",
        .help       = "migrate to URI (using -d to not wait for completion)"
		      "\n\t\t\t -b for migration without shared storage with"
		      " full copy of disk\n\t\t\t -i for migration without "
		      "shared storage with incremental copy of disk "
		      "(base image shared between src and destination)",
L
Luiz Capitulino 已提交
897
        .mhandler.cmd = hmp_migrate,
898 899
    },

900

901
STEXI
902
@item migrate [-d] [-b] [-i] @var{uri}
903
@findex migrate
904
Migrate to @var{uri} (using -d to not wait for completion).
905 906
	-b for migration with full copy of disk
	-i for migration with incremental copy of disk (base image is shared)
907 908
ETEXI

909 910 911 912 913
    {
        .name       = "migrate_cancel",
        .args_type  = "",
        .params     = "",
        .help       = "cancel the current VM migration",
914
        .mhandler.cmd = hmp_migrate_cancel,
915 916
    },

917 918
STEXI
@item migrate_cancel
919
@findex migrate_cancel
920
Cancel the current VM migration.
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940

ETEXI

    {
        .name       = "migrate_set_cache_size",
        .args_type  = "value:o",
        .params     = "value",
        .help       = "set cache size (in bytes) for XBZRLE migrations,"
                      "the cache size will be rounded down to the nearest "
                      "power of 2.\n"
                      "The cache size affects the number of cache misses."
                      "In case of a high cache miss ratio you need to increase"
                      " the cache size",
        .mhandler.cmd = hmp_migrate_set_cache_size,
    },

STEXI
@item migrate_set_cache_size @var{value}
@findex migrate_set_cache_size
Set cache size to @var{value} (in bytes) for xbzrle migrations.
941 942
ETEXI

943 944
    {
        .name       = "migrate_set_speed",
945
        .args_type  = "value:o",
946
        .params     = "value",
947 948
        .help       = "set maximum speed (in bytes) for migrations. "
	"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
949
        .mhandler.cmd = hmp_migrate_set_speed,
950 951
    },

952 953
STEXI
@item migrate_set_speed @var{value}
954
@findex migrate_set_speed
955
Set maximum speed to @var{value} (in bytes) for migrations.
956 957
ETEXI

958 959
    {
        .name       = "migrate_set_downtime",
960
        .args_type  = "value:T",
961 962
        .params     = "value",
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
963
        .mhandler.cmd = hmp_migrate_set_downtime,
964
    },
965 966 967

STEXI
@item migrate_set_downtime @var{second}
968
@findex migrate_set_downtime
969
Set maximum tolerated downtime (in seconds) for migration.
970 971 972 973 974 975 976 977
ETEXI

    {
        .name       = "migrate_set_capability",
        .args_type  = "capability:s,state:b",
        .params     = "capability state",
        .help       = "Enable/Disable the usage of a capability for migration",
        .mhandler.cmd = hmp_migrate_set_capability,
978
        .command_completion = migrate_set_capability_completion,
979 980 981 982 983 984
    },

STEXI
@item migrate_set_capability @var{capability} @var{state}
@findex migrate_set_capability
Enable/Disable the usage of a capability @var{capability} for migration.
985 986 987
ETEXI

    {
988 989 990 991 992
        .name       = "client_migrate_info",
        .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
        .params     = "protocol hostname port tls-port cert-subject",
        .help       = "send migration info to spice/vnc client",
        .user_print = monitor_user_noop,
993 994
        .mhandler.cmd_async = client_migrate_info,
        .flags      = MONITOR_CMD_ASYNC,
995 996
    },

997 998 999 1000 1001 1002 1003 1004
STEXI
@item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
@findex client_migrate_info
Set the spice/vnc connection info for the migration target.  The spice/vnc
server will ask the spice/vnc client to automatically reconnect using the
new parameters (if specified) once the vm migration finished successfully.
ETEXI

1005 1006
    {
        .name       = "dump-guest-memory",
1007 1008
        .args_type  = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
        .params     = "[-p] [-z|-l|-s] filename [begin length]",
1009 1010
        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
                      "-p: do paging to get guest's memory mapping.\n\t\t\t"
1011 1012 1013
                      "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
                      "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
                      "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1014 1015
                      "begin: the starting physical address.\n\t\t\t"
                      "length: the memory size, in bytes.",
1016 1017 1018 1019 1020
        .mhandler.cmd = hmp_dump_guest_memory,
    },


STEXI
1021
@item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
1022
@item dump-guest-memory [-z|-l|-s] @var{filename}
1023 1024
@findex dump-guest-memory
Dump guest memory to @var{protocol}. The file can be processed with crash or
1025
gdb. Without -z|-l|-s, the dump format is ELF.
1026
        -p: do paging to get guest's memory mapping.
1027 1028 1029
        -z: dump in kdump-compressed format, with zlib compression.
        -l: dump in kdump-compressed format, with lzo compression.
        -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.
1035 1036
ETEXI

1037
    {
1038
        .name       = "snapshot_blkdev",
1039 1040
        .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
        .params     = "[-n] device [new-image-file] [format]",
1041 1042 1043 1044
        .help       = "initiates a live snapshot\n\t\t\t"
                      "of device. If a new image file is specified, the\n\t\t\t"
                      "new image file will become the new root image.\n\t\t\t"
                      "If format is specified, the snapshot file will\n\t\t\t"
1045
                      "be created in that format.\n\t\t\t"
1046 1047 1048
                      "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
                      "to reuse the image found in new-image-file, instead of\n\t\t\t"
                      "recreating it from scratch.",
1049
        .mhandler.cmd = hmp_snapshot_blkdev,
1050 1051
    },

1052 1053 1054 1055
STEXI
@item snapshot_blkdev
@findex snapshot_blkdev
Snapshot device, using snapshot file as target if provided
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
ETEXI

    {
        .name       = "snapshot_blkdev_internal",
        .args_type  = "device:B,name:s",
        .params     = "device name",
        .help       = "take an internal snapshot of device.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
        .mhandler.cmd = hmp_snapshot_blkdev_internal,
    },

STEXI
@item snapshot_blkdev_internal
@findex snapshot_blkdev_internal
Take an internal snapshot on device if it support
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
ETEXI

    {
        .name       = "snapshot_delete_blkdev_internal",
        .args_type  = "device:B,name:s,id:s?",
        .params     = "device name [id]",
        .help       = "delete an internal snapshot of device.\n\t\t\t"
                      "If id is specified, qemu will try delete\n\t\t\t"
                      "the snapshot matching both id and name.\n\t\t\t"
                      "The format of the image used by device must\n\t\t\t"
                      "support it, such as qcow2.\n\t\t\t",
        .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
    },

STEXI
@item snapshot_delete_blkdev_internal
@findex snapshot_delete_blkdev_internal
Delete an internal snapshot on device if it support
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
ETEXI

    {
        .name       = "drive_mirror",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .help       = "initiates live storage\n\t\t\t"
                      "migration for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, including data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
                      "so that the result does not need a backing file.\n\t\t\t",
        .mhandler.cmd = hmp_drive_mirror,
    },
STEXI
@item drive_mirror
@findex drive_mirror
Start mirroring a block device's writes to a new destination,
using the specified target.
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
ETEXI

    {
        .name       = "drive_backup",
        .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
        .params     = "[-n] [-f] device target [format]",
        .help       = "initiates a point-in-time\n\t\t\t"
                      "copy for a device. The device's contents are\n\t\t\t"
                      "copied to the new image file, excluding data that\n\t\t\t"
                      "is written after the command is started.\n\t\t\t"
                      "The -n flag requests QEMU to reuse the image found\n\t\t\t"
                      "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
                      "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
                      "so that the result does not need a backing file.\n\t\t\t",
        .mhandler.cmd = hmp_drive_backup,
    },
STEXI
@item drive_backup
@findex drive_backup
Start a point-in-time copy of a block device to a specificed target.
1131 1132
ETEXI

1133 1134 1135 1136 1137
    {
        .name       = "drive_add",
        .args_type  = "pci_addr:s,opts:s",
        .params     = "[[<domain>:]<bus>:]<slot>\n"
                      "[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 1141
                      "[,snapshot=on|off][,cache=on|off]\n"
                      "[,readonly=on|off][,copy-on-read=on|off]",
1142
        .help       = "add drive to PCI storage controller",
1143
        .mhandler.cmd = drive_hot_add,
1144 1145
    },

1146 1147
STEXI
@item drive_add
1148
@findex drive_add
1149 1150 1151
Add drive to PCI storage controller.
ETEXI

1152
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1153 1154 1155 1156 1157
    {
        .name       = "pci_add",
        .args_type  = "pci_addr:s,type:s,opts:s?",
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
        .help       = "hot-add PCI device",
1158
        .mhandler.cmd = pci_device_hot_add,
1159
    },
1160
#endif
1161

1162 1163
STEXI
@item pci_add
1164
@findex pci_add
1165 1166 1167
Hot-add PCI device.
ETEXI

1168
#if defined(CONFIG_PCI_HOTPLUG_OLD)
1169 1170 1171 1172 1173
    {
        .name       = "pci_del",
        .args_type  = "pci_addr:s",
        .params     = "[[<domain>:]<bus>:]<slot>",
        .help       = "hot remove PCI device",
1174
        .mhandler.cmd = do_pci_device_hot_remove,
1175
    },
1176
#endif
1177

1178 1179
STEXI
@item pci_del
1180
@findex pci_del
1181
Hot remove PCI device.
1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
ETEXI

    {
        .name       = "pcie_aer_inject_error",
        .args_type  = "advisory_non_fatal:-a,correctable:-c,"
	              "id:s,error_status:s,"
	              "header0:i?,header1:i?,header2:i?,header3:i?,"
	              "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
        .params     = "[-a] [-c] id "
                      "<error_status> [<tlp header> [<tlp header prefix>]]",
        .help       = "inject pcie aer error\n\t\t\t"
	              " -a for advisory non fatal error\n\t\t\t"
	              " -c for correctable error\n\t\t\t"
                      "<id> = qdev device id\n\t\t\t"
                      "<error_status> = error string or 32bit\n\t\t\t"
                      "<tlb header> = 32bit x 4\n\t\t\t"
                      "<tlb header prefix> = 32bit x 4",
        .user_print  = pcie_aer_inject_error_print,
1200
        .mhandler.cmd_new = do_pcie_aer_inject_error,
1201 1202 1203 1204 1205 1206
    },

STEXI
@item pcie_aer_inject_error
@findex pcie_aer_inject_error
Inject PCIe AER error
1207 1208
ETEXI

1209 1210 1211
    {
        .name       = "host_net_add",
        .args_type  = "device:s,opts:s?",
1212
        .params     = "tap|user|socket|vde|netmap|bridge|dump [options]",
1213
        .help       = "add host VLAN client",
1214
        .mhandler.cmd = net_host_device_add,
1215
        .command_completion = host_net_add_completion,
1216 1217
    },

1218 1219
STEXI
@item host_net_add
1220
@findex host_net_add
1221 1222 1223
Add host VLAN client.
ETEXI

1224 1225 1226 1227 1228
    {
        .name       = "host_net_remove",
        .args_type  = "vlan_id:i,device:s",
        .params     = "vlan_id name",
        .help       = "remove host VLAN client",
1229
        .mhandler.cmd = net_host_device_remove,
1230 1231
    },

1232 1233
STEXI
@item host_net_remove
1234
@findex host_net_remove
1235
Remove host VLAN client.
1236 1237 1238 1239 1240
ETEXI

    {
        .name       = "netdev_add",
        .args_type  = "netdev:O",
1241
        .params     = "[user|tap|socket|vde|bridge|hubport|netmap],id=str[,prop=value][,...]",
1242
        .help       = "add host network device",
1243
        .mhandler.cmd = hmp_netdev_add,
1244
        .command_completion = netdev_add_completion,
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
    },

STEXI
@item netdev_add
@findex netdev_add
Add host network device.
ETEXI

    {
        .name       = "netdev_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "remove host network device",
1258
        .mhandler.cmd = hmp_netdev_del,
1259
        .command_completion = netdev_del_completion,
1260 1261 1262 1263 1264 1265
    },

STEXI
@item netdev_del
@findex netdev_del
Remove host network device.
1266 1267 1268 1269 1270 1271 1272 1273
ETEXI

    {
        .name       = "object_add",
        .args_type  = "object:O",
        .params     = "[qom-type=]type,id=str[,prop=value][,...]",
        .help       = "create QOM object",
        .mhandler.cmd = hmp_object_add,
1274
        .command_completion = object_add_completion,
1275 1276 1277 1278 1279 1280
    },

STEXI
@item object_add
@findex object_add
Create QOM object.
1281 1282 1283 1284 1285 1286 1287 1288
ETEXI

    {
        .name       = "object_del",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "destroy QOM object",
        .mhandler.cmd = hmp_object_del,
1289
        .command_completion = object_del_completion,
1290 1291 1292 1293 1294 1295
    },

STEXI
@item object_del
@findex object_del
Destroy QOM object.
1296 1297 1298
ETEXI

#ifdef CONFIG_SLIRP
1299 1300 1301 1302 1303
    {
        .name       = "hostfwd_add",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1304
        .mhandler.cmd = net_slirp_hostfwd_add,
1305
    },
1306 1307 1308 1309 1310 1311
#endif
STEXI
@item hostfwd_add
@findex hostfwd_add
Redirect TCP or UDP connections from host to guest (requires -net user).
ETEXI
1312

1313
#ifdef CONFIG_SLIRP
1314 1315 1316 1317 1318
    {
        .name       = "hostfwd_remove",
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
        .help       = "remove host-to-guest TCP or UDP redirection",
1319
        .mhandler.cmd = net_slirp_hostfwd_remove,
1320 1321
    },

1322 1323
#endif
STEXI
1324 1325 1326
@item hostfwd_remove
@findex hostfwd_remove
Remove host-to-guest TCP or UDP redirection.
1327 1328
ETEXI

1329 1330
    {
        .name       = "balloon",
1331
        .args_type  = "value:M",
1332
        .params     = "target",
1333
        .help       = "request VM to change its memory allocation (in MB)",
L
Luiz Capitulino 已提交
1334
        .mhandler.cmd = hmp_balloon,
1335 1336
    },

1337 1338
STEXI
@item balloon @var{value}
1339
@findex balloon
1340 1341 1342
Request VM to change its memory allocation to @var{value} (in MB).
ETEXI

1343 1344
    {
        .name       = "set_link",
1345 1346
        .args_type  = "name:s,up:b",
        .params     = "name on|off",
1347
        .help       = "change the link status of a network adapter",
L
Luiz Capitulino 已提交
1348
        .mhandler.cmd = hmp_set_link,
1349
        .command_completion = set_link_completion,
1350 1351
    },

1352
STEXI
1353
@item set_link @var{name} [on|off]
1354
@findex set_link
1355
Switch link @var{name} on (i.e. up) or off (i.e. down).
1356 1357
ETEXI

1358 1359 1360 1361 1362
    {
        .name       = "watchdog_action",
        .args_type  = "action:s",
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
        .help       = "change watchdog action",
1363
        .mhandler.cmd = do_watchdog_action,
1364
        .command_completion = watchdog_action_completion,
1365 1366
    },

1367 1368
STEXI
@item watchdog_action
1369
@findex watchdog_action
1370 1371 1372
Change watchdog action.
ETEXI

1373 1374 1375 1376 1377
    {
        .name       = "acl_show",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "list rules in the access control list",
1378
        .mhandler.cmd = do_acl_show,
1379 1380
    },

1381
STEXI
1382
@item acl_show @var{aclname}
1383
@findex acl_show
1384 1385 1386 1387 1388
List all the matching rules in the access control list, and the default
policy. There are currently two named access control lists,
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
certificate distinguished name, and SASL username respectively.
ETEXI
1389

1390 1391 1392 1393 1394
    {
        .name       = "acl_policy",
        .args_type  = "aclname:s,policy:s",
        .params     = "aclname allow|deny",
        .help       = "set default access control list policy",
1395
        .mhandler.cmd = do_acl_policy,
1396 1397
    },

1398
STEXI
1399
@item acl_policy @var{aclname} @code{allow|deny}
1400
@findex acl_policy
1401
Set the default access control list policy, used in the event that
1402
none of the explicit rules match. The default policy at startup is
1403 1404 1405
always @code{deny}.
ETEXI

1406 1407 1408 1409 1410
    {
        .name       = "acl_add",
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
        .params     = "aclname match allow|deny [index]",
        .help       = "add a match rule to the access control list",
1411
        .mhandler.cmd = do_acl_add,
1412 1413
    },

1414
STEXI
1415 1416
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
@findex acl_add
1417 1418 1419 1420
Add a match rule to the access control list, allowing or denying access.
The match will normally be an exact username or x509 distinguished name,
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1421
normally be appended to the end of the ACL, but can be inserted
1422 1423 1424
earlier in the list if the optional @var{index} parameter is supplied.
ETEXI

1425 1426 1427 1428 1429
    {
        .name       = "acl_remove",
        .args_type  = "aclname:s,match:s",
        .params     = "aclname match",
        .help       = "remove a match rule from the access control list",
1430
        .mhandler.cmd = do_acl_remove,
1431 1432
    },

1433 1434
STEXI
@item acl_remove @var{aclname} @var{match}
1435
@findex acl_remove
1436 1437 1438
Remove the specified match rule from the access control list.
ETEXI

1439 1440 1441 1442 1443
    {
        .name       = "acl_reset",
        .args_type  = "aclname:s",
        .params     = "aclname",
        .help       = "reset the access control list",
1444
        .mhandler.cmd = do_acl_reset,
1445 1446
    },

1447
STEXI
1448 1449
@item acl_reset @var{aclname}
@findex acl_reset
1450
Remove all matches from the access control list, and set the default
1451 1452 1453
policy back to @code{deny}.
ETEXI

1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
    {
        .name       = "nbd_server_start",
        .args_type  = "all:-a,writable:-w,uri:s",
        .params     = "nbd_server_start [-a] [-w] host:port",
        .help       = "serve block devices on the given host and port",
        .mhandler.cmd = hmp_nbd_server_start,
    },
STEXI
@item nbd_server_start @var{host}:@var{port}
@findex nbd_server_start
Start an NBD server on the given host and/or port.  If the @option{-a}
option is included, all of the virtual machine's block devices that
have an inserted media on them are automatically exported; in this case,
the @option{-w} option makes the devices writable too.
ETEXI

    {
        .name       = "nbd_server_add",
        .args_type  = "writable:-w,device:B",
        .params     = "nbd_server_add [-w] device",
        .help       = "export a block device via NBD",
        .mhandler.cmd = hmp_nbd_server_add,
    },
STEXI
@item nbd_server_add @var{device}
@findex nbd_server_add
Export a block device through QEMU's NBD server, which must be started
beforehand with @command{nbd_server_start}.  The @option{-w} option makes the
exported device writable too.
ETEXI

    {
        .name       = "nbd_server_stop",
        .args_type  = "",
        .params     = "nbd_server_stop",
        .help       = "stop serving block devices using the NBD protocol",
        .mhandler.cmd = hmp_nbd_server_stop,
    },
STEXI
@item nbd_server_stop
@findex nbd_server_stop
Stop the QEMU embedded NBD server.
ETEXI


1499
#if defined(TARGET_I386)
1500 1501 1502

    {
        .name       = "mce",
1503 1504 1505
        .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
        .params     = "[-b] cpu bank status mcgstatus addr misc",
        .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1506
        .mhandler.cmd = do_inject_mce,
1507 1508
    },

1509 1510 1511
#endif
STEXI
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1512
@findex mce (x86)
1513
Inject an MCE on the given CPU (x86 only).
1514 1515
ETEXI

1516 1517 1518 1519 1520
    {
        .name       = "getfd",
        .args_type  = "fdname:s",
        .params     = "getfd name",
        .help       = "receive a file descriptor via SCM rights and assign it a name",
1521
        .mhandler.cmd = hmp_getfd,
1522 1523
    },

1524 1525
STEXI
@item getfd @var{fdname}
1526
@findex getfd
1527 1528 1529 1530 1531
If a file descriptor is passed alongside this command using the SCM_RIGHTS
mechanism on unix sockets, it is stored using the name @var{fdname} for
later use by other monitor commands.
ETEXI

1532 1533 1534 1535 1536
    {
        .name       = "closefd",
        .args_type  = "fdname:s",
        .params     = "closefd name",
        .help       = "close a file descriptor previously passed via SCM rights",
1537
        .mhandler.cmd = hmp_closefd,
1538 1539
    },

1540 1541
STEXI
@item closefd @var{fdname}
1542
@findex closefd
1543 1544 1545
Close the file descriptor previously assigned to @var{fdname} using the
@code{getfd} command. This is only needed if the file descriptor was never
used by another monitor command.
1546 1547 1548 1549 1550 1551 1552
ETEXI

    {
        .name       = "block_passwd",
        .args_type  = "device:B,password:s",
        .params     = "block_passwd device password",
        .help       = "set the password of encrypted block devices",
1553
        .mhandler.cmd = hmp_block_passwd,
1554 1555
    },

1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
STEXI
@item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
@findex block_set_io_throttle
Change 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}
ETEXI

    {
        .name       = "block_set_io_throttle",
        .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
        .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
        .help       = "change I/O throttle limits for a block drive",
1567
        .mhandler.cmd = hmp_block_set_io_throttle,
1568 1569
    },

1570 1571
STEXI
@item block_passwd @var{device} @var{password}
1572
@findex block_passwd
1573
Set the encrypted device @var{device} password to @var{password}
1574 1575 1576 1577 1578 1579 1580
ETEXI

    {
        .name       = "set_password",
        .args_type  = "protocol:s,password:s,connected:s?",
        .params     = "protocol password action-if-connected",
        .help       = "set spice/vnc password",
1581
        .mhandler.cmd = hmp_set_password,
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
    },

STEXI
@item set_password [ vnc | spice ] password [ action-if-connected ]
@findex set_password

Change spice/vnc password.  Use zero to make the password stay valid
forever.  @var{action-if-connected} specifies what should happen in
case a connection is established: @var{fail} makes the password change
fail.  @var{disconnect} changes the password and disconnects the
client.  @var{keep} changes the password and keeps the connection up.
@var{keep} is the default.
ETEXI

    {
        .name       = "expire_password",
        .args_type  = "protocol:s,time:s",
        .params     = "protocol time",
        .help       = "set spice/vnc password expire-time",
1601
        .mhandler.cmd = hmp_expire_password,
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
    },

STEXI
@item expire_password [ vnc | spice ] expire-time
@findex expire_password

Specify when a password for spice/vnc becomes
invalid. @var{expire-time} accepts:

@table @var
@item now
Invalidate password instantly.

@item never
Password stays valid forever.

@item +nsec
Password stays valid for @var{nsec} seconds starting now.

@item nsec
Password is invalidated at the given time.  @var{nsec} are the seconds
passed since 1970, i.e. unix epoch.

@end table
1626 1627
ETEXI

1628 1629 1630 1631 1632 1633
    {
        .name       = "chardev-add",
        .args_type  = "args:s",
        .params     = "args",
        .help       = "add chardev",
        .mhandler.cmd = hmp_chardev_add,
1634
        .command_completion = chardev_add_completion,
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
    },

STEXI
@item chardev_add args
@findex chardev_add

chardev_add accepts the same parameters as the -chardev command line switch.

ETEXI

    {
        .name       = "chardev-remove",
        .args_type  = "id:s",
        .params     = "id",
        .help       = "remove chardev",
        .mhandler.cmd = hmp_chardev_remove,
1651
        .command_completion = chardev_remove_completion,
1652 1653 1654 1655 1656 1657 1658 1659
    },

STEXI
@item chardev_remove id
@findex chardev_remove

Removes the chardev @var{id}.

1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
ETEXI

    {
        .name       = "qemu-io",
        .args_type  = "device:B,command:s",
        .params     = "[device] \"[command]\"",
        .help       = "run a qemu-io command on a block device",
        .mhandler.cmd = hmp_qemu_io,
    },

STEXI
@item qemu-io @var{device} @var{command}
@findex qemu-io

Executes a qemu-io command on the given block device.

1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
ETEXI

    {
        .name       = "cpu-add",
        .args_type  = "id:i",
        .params     = "id",
        .help       = "add cpu",
        .mhandler.cmd  = hmp_cpu_add,
    },

STEXI
@item cpu-add @var{id}
Add CPU with id @var{id}
1689
ETEXI
1690

1691 1692 1693 1694 1695
    {
        .name       = "info",
        .args_type  = "item:s?",
        .params     = "[subcommand]",
        .help       = "show various information about the system state",
1696 1697
        .mhandler.cmd = do_info_help,
        .sub_table = info_cmds,
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
    },

STEXI
@item info @var{subcommand}
@findex info
Show various information about the system state.

@table @option
@item info version
show the version of QEMU
@item info network
show the various VLANs and the associated devices
@item info chardev
show the character devices
@item info block
show the block devices
@item info blockstats
show block device statistics
@item info registers
show the cpu registers
@item info cpus
show infos for each CPU
@item info history
show the command line history
@item info irq
show the interrupts statistics (if available)
@item info pic
show i8259 (PIC) state
@item info pci
show emulated PCI device info
@item info tlb
1729
show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1730 1731 1732 1733 1734 1735
@item info mem
show the active virtual memory mappings (i386 only)
@item info jit
show dynamic compiler info
@item info numa
show NUMA information
1736 1737
@item info kvm
show KVM information
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765
@item info usb
show USB devices plugged on the virtual USB hub
@item info usbhost
show all USB host devices
@item info profile
show profiling information
@item info capture
show information about active capturing
@item info snapshots
show list of VM snapshots
@item info status
show the current VM status (running|paused)
@item info pcmcia
show guest PCMCIA status
@item info mice
show which guest mouse is receiving events
@item info vnc
show the vnc server status
@item info name
show the current VM name
@item info uuid
show the current VM UUID
@item info cpustats
show CPU statistics
@item info usernet
show user network stack connection states
@item info migrate
show migration status
1766 1767
@item info migrate_capabilities
show current migration capabilities
1768 1769
@item info migrate_cache_size
show current migration XBZRLE cache size
1770 1771 1772 1773 1774 1775 1776 1777
@item info balloon
show balloon information
@item info qtree
show device tree
@item info qdm
show qdev device model list
@item info roms
show roms
1778 1779
@item info tpm
show the TPM device
1780 1781 1782
@end table
ETEXI

1783
STEXI
1784 1785 1786 1787
@item info trace-events
show available trace events and their state
ETEXI

1788 1789 1790
STEXI
@end table
ETEXI
新手
引导
客服 返回
顶部