1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(command
, args
, callback, arg_string
, help
) is used to construct
5 HXCOMM monitor commands
6 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
14 .args_type
= "name:s?",
16 .help
= "show the help",
17 .mhandler
.cmd
= do_help_cmd
,
21 @item help or ?
[@
var{cmd
}]
23 Show the help
for all commands or just
for command @
var{cmd
}.
28 .args_type
= "device:B",
29 .params
= "device|all",
30 .help
= "commit changes to the disk images (if -snapshot is used) or backing files",
31 .mhandler
.cmd
= do_commit
,
37 Commit changes to the disk
images (if -snapshot is used
) or backing files
.
44 .help
= "quit the emulator",
45 .user_print
= monitor_user_noop
,
46 .mhandler
.cmd
= hmp_quit
,
56 .name
= "block_resize",
57 .args_type
= "device:B,size:o",
58 .params
= "device size",
59 .help
= "resize a block image",
60 .mhandler
.cmd
= hmp_block_resize
,
66 Resize a block image
while a guest is running
. Usually requires guest
67 action to see the updated size
. Resize to a lower size is supported
,
68 but should be used with extreme caution
. Note that
this command only
69 resizes image files
, it can not resize block devices like LVM volumes
.
73 .name
= "block_stream",
74 .args_type
= "device:B,speed:o?,base:s?",
75 .params
= "device [speed [base]]",
76 .help
= "copy data from a backing file into a block device",
77 .mhandler
.cmd
= hmp_block_stream
,
83 Copy data from a backing file into a block device
.
87 .name
= "block_job_set_speed",
88 .args_type
= "device:B,speed:o",
89 .params
= "device speed",
90 .help
= "set maximum speed for a background block operation",
91 .mhandler
.cmd
= hmp_block_job_set_speed
,
95 @item block_job_set_speed
96 @findex block_job_set_speed
97 Set maximum speed
for a background block operation
.
101 .name
= "block_job_cancel",
102 .args_type
= "device:B",
104 .help
= "stop an active background block operation",
105 .mhandler
.cmd
= hmp_block_job_cancel
,
109 @item block_job_cancel
110 @findex block_job_cancel
111 Stop an active block streaming operation
.
116 .args_type
= "force:-f,device:B",
117 .params
= "[-f] device",
118 .help
= "eject a removable medium (use -f to force it)",
119 .mhandler
.cmd
= hmp_eject
,
123 @item eject
[-f
] @
var{device
}
125 Eject a removable
medium (use
-f to force it
).
132 .help
= "remove host block device",
133 .user_print
= monitor_user_noop
,
134 .mhandler
.cmd_new
= do_drive_del
,
138 @item drive_del @
var{device
}
140 Remove host block device
. The result is that guest generated IO is no longer
141 submitted against the host device underlying the disk
. Once a drive has
142 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
143 errors
in the guest
for applications that are reading
/writing to the device
.
148 .args_type
= "device:B,target:F,arg:s?",
149 .params
= "device filename [format]",
150 .help
= "change a removable medium, optional format",
151 .mhandler
.cmd
= hmp_change
,
155 @item change @
var{device
} @
var{setting
}
158 Change the configuration of a device
.
161 @item change @
var{diskdevice
} @
var{filename
} [@
var{format
}]
162 Change the medium
for a removable disk device to point to @
var{filename
}. eg
165 (qemu
) change ide1
-cd0
/path
/to
/some
.iso
168 @
var{format
} is optional
.
170 @item change vnc @
var{display
},@
var{options
}
171 Change the configuration of the VNC server
. The valid syntax
for @
var{display
}
172 and @
var{options
} are described at @ref
{sec_invocation
}. eg
175 (qemu
) change vnc localhost
:1
178 @item change vnc password
[@
var{password
}]
180 Change the password associated with the VNC server
. If the
new password is not
181 supplied
, the monitor will prompt
for it to be entered
. VNC passwords are only
182 significant up to
8 letters
. eg
185 (qemu
) change vnc password
193 .name
= "screendump",
194 .args_type
= "filename:F",
195 .params
= "filename",
196 .help
= "save screen into PPM image 'filename'",
197 .mhandler
.cmd
= hmp_screen_dump
,
201 @item screendump @
var{filename
}
203 Save screen into PPM image @
var{filename
}.
208 .args_type
= "filename:F",
209 .params
= "filename",
210 .help
= "output logs to 'filename'",
211 .mhandler
.cmd
= do_logfile
,
215 @item logfile @
var{filename
}
217 Output logs to @
var{filename
}.
221 .name
= "trace-event",
222 .args_type
= "name:s,option:b",
223 .params
= "name on|off",
224 .help
= "changes status of a specific trace event",
225 .mhandler
.cmd
= do_trace_event_set_state
,
231 changes status of a
trace event
234 #
if defined(CONFIG_TRACE_SIMPLE
)
236 .name
= "trace-file",
237 .args_type
= "op:s?,arg:F?",
238 .params
= "on|off|flush|set [arg]",
239 .help
= "open, close, or flush trace file, or set a new file name",
240 .mhandler
.cmd
= do_trace_file
,
244 @item
trace-file on|off|flush
246 Open
, close
, or flush the
trace file
. If no argument is given
, the status of the
trace file is displayed
.
252 .args_type
= "items:s",
253 .params
= "item1[,...]",
254 .help
= "activate logging of the specified items to '/tmp/qemu.log'",
255 .mhandler
.cmd
= do_log
,
259 @item log @
var{item1
}[,...]
261 Activate logging of the specified items to @file
{/tmp
/qemu
.log
}.
266 .args_type
= "name:s?",
267 .params
= "[tag|id]",
268 .help
= "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
269 .mhandler
.cmd
= do_savevm
,
273 @item savevm
[@
var{tag
}|@
var{id
}]
275 Create a snapshot of the whole virtual machine
. If @
var{tag
} is
276 provided
, it is used as human readable identifier
. If there is already
277 a snapshot with the same tag or ID
, it is replaced
. More info at
283 .args_type
= "name:s",
285 .help
= "restore a VM snapshot from its tag or id",
286 .mhandler
.cmd
= do_loadvm
,
290 @item loadvm @
var{tag
}|@
var{id
}
292 Set the whole virtual machine to the snapshot identified by the tag
293 @
var{tag
} or the unique snapshot ID @
var{id
}.
298 .args_type
= "name:s",
300 .help
= "delete a VM snapshot from its tag or id",
301 .mhandler
.cmd
= do_delvm
,
305 @item delvm @
var{tag
}|@
var{id
}
307 Delete the snapshot identified by @
var{tag
} or @
var{id
}.
311 .name
= "singlestep",
312 .args_type
= "option:s?",
313 .params
= "[on|off]",
314 .help
= "run emulation in singlestep mode or switch to normal mode",
315 .mhandler
.cmd
= do_singlestep
,
319 @item singlestep
[off
]
321 Run the emulation
in single step mode
.
322 If called with option off
, the emulation returns to normal mode
.
329 .help
= "stop emulation",
330 .mhandler
.cmd
= hmp_stop
,
343 .help
= "resume emulation",
344 .mhandler
.cmd
= hmp_cont
,
354 .name
= "system_wakeup",
357 .help
= "wakeup guest from suspend",
358 .mhandler
.cmd
= hmp_system_wakeup
,
363 @findex system_wakeup
364 Wakeup guest from suspend
.
369 .args_type
= "device:s?",
370 .params
= "[device]",
371 .help
= "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
372 .mhandler
.cmd
= do_gdbserver
,
376 @item gdbserver
[@
var{port
}]
378 Start gdbserver
session (default @
var{port
}=1234)
383 .args_type
= "fmt:/,addr:l",
384 .params
= "/fmt addr",
385 .help
= "virtual memory dump starting at 'addr'",
386 .mhandler
.cmd
= do_memory_dump
,
390 @item x
/fmt @
var{addr
}
392 Virtual memory dump starting at @
var{addr
}.
397 .args_type
= "fmt:/,addr:l",
398 .params
= "/fmt addr",
399 .help
= "physical memory dump starting at 'addr'",
400 .mhandler
.cmd
= do_physical_memory_dump
,
404 @item xp
/@
var{fmt
} @
var{addr
}
406 Physical memory dump starting at @
var{addr
}.
408 @
var{fmt
} is a format which tells the command how to format the
409 data
. Its syntax is
: @option
{/@
{count@
}@
{format@
}@
{size@
}}
413 is the number of items to be dumped
.
416 can be
x (hex
), d (signed decimal
), u (unsigned decimal
), o (octal
),
417 c (char
) or
i (asm instruction
).
420 can be
b (8 bits
), h (16 bits
), w (32 bits
) or
g (64 bits
). On x86
,
421 @code
{h
} or @code
{w
} can be specified with the @code
{i
} format to
422 respectively select
16 or
32 bit code instruction size
.
429 Dump
10 instructions at the current instruction pointer
:
434 0x90107065: lea
0x0(%esi
,1),%esi
435 0x90107069: lea
0x0(%edi
,1),%edi
437 0x90107071: jmp
0x90107080
445 Dump
80 16 bit values at the start of the video memory
.
447 (qemu
) xp
/80hx
0xb8000
448 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
449 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
450 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
451 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
452 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
453 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
454 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
455 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
456 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
457 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
464 .args_type
= "fmt:/,val:l",
465 .params
= "/fmt expr",
466 .help
= "print expression value (use $reg for CPU register access)",
467 .mhandler
.cmd
= do_print
,
471 @item p or print
/@
var{fmt
} @
var{expr
}
474 Print expression value
. Only the @
var{format
} part of @
var{fmt
} is
480 .args_type
= "fmt:/,addr:i,index:i.",
481 .params
= "/fmt addr",
482 .help
= "I/O port read",
483 .mhandler
.cmd
= do_ioport_read
,
492 .args_type
= "fmt:/,addr:i,val:i",
493 .params
= "/fmt addr value",
494 .help
= "I/O port write",
495 .mhandler
.cmd
= do_ioport_write
,
504 .args_type
= "keys:s,hold-time:i?",
505 .params
= "keys [hold_ms]",
506 .help
= "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
507 .mhandler
.cmd
= hmp_send_key
,
511 @item sendkey @
var{keys
}
514 Send @
var{keys
} to the guest
. @
var{keys
} could be the name of the
515 key or the raw value
in hexadecimal format
. Use @code
{-} to press
516 several keys simultaneously
. Example
:
521 This command is useful to send keys that your graphical user
interface
522 intercepts at low level
, such as @code
{ctrl
-alt
-f1
} in X Window
.
526 .name
= "system_reset",
529 .help
= "reset the system",
530 .mhandler
.cmd
= hmp_system_reset
,
541 .name
= "system_powerdown",
544 .help
= "send system power down event",
545 .mhandler
.cmd
= hmp_system_powerdown
,
549 @item system_powerdown
550 @findex system_powerdown
552 Power down the
system (if supported
).
557 .args_type
= "start:i,size:i",
558 .params
= "addr size",
559 .help
= "compute the checksum of a memory region",
560 .mhandler
.cmd
= do_sum
,
564 @item sum @
var{addr
} @
var{size
}
567 Compute the checksum of a memory region
.
572 .args_type
= "devname:s",
574 .help
= "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
575 .mhandler
.cmd
= do_usb_add
,
579 @item usb_add @
var{devname
}
582 Add the USB device @
var{devname
}. For details of available devices see
588 .args_type
= "devname:s",
590 .help
= "remove USB device 'bus.addr'",
591 .mhandler
.cmd
= do_usb_del
,
595 @item usb_del @
var{devname
}
598 Remove the USB device @
var{devname
} from the QEMU virtual USB
599 hub
. @
var{devname
} has the syntax @code
{bus
.addr
}. Use the monitor
600 command @code
{info usb
} to see the devices you can remove
.
604 .name
= "device_add",
605 .args_type
= "device:O",
606 .params
= "driver[,prop=value][,...]",
607 .help
= "add device, like -device on the command line",
608 .user_print
= monitor_user_noop
,
609 .mhandler
.cmd_new
= do_device_add
,
613 @item device_add @
var{config
}
620 .name
= "device_del",
623 .help
= "remove device",
624 .mhandler
.cmd
= hmp_device_del
,
628 @item device_del @
var{id
}
631 Remove device @
var{id
}.
636 .args_type
= "index:i",
638 .help
= "set the default CPU",
639 .mhandler
.cmd
= hmp_cpu
,
643 @item cpu @
var{index
}
649 .name
= "mouse_move",
650 .args_type
= "dx_str:s,dy_str:s,dz_str:s?",
651 .params
= "dx dy [dz]",
652 .help
= "send mouse move events",
653 .mhandler
.cmd
= do_mouse_move
,
657 @item mouse_move @
var{dx
} @
var{dy
} [@
var{dz
}]
659 Move the active mouse to the specified coordinates @
var{dx
} @
var{dy
}
660 with optional scroll axis @
var{dz
}.
664 .name
= "mouse_button",
665 .args_type
= "button_state:i",
667 .help
= "change mouse button state (1=L, 2=M, 4=R)",
668 .mhandler
.cmd
= do_mouse_button
,
672 @item mouse_button @
var{val
}
674 Change the active mouse button state @
var{val
} (1=L
, 2=M
, 4=R
).
679 .args_type
= "index:i",
681 .help
= "set which mouse device receives events",
682 .mhandler
.cmd
= do_mouse_set
,
686 @item mouse_set @
var{index
}
688 Set which mouse device receives events at given @
var{index
}, index
697 .name
= "wavcapture",
698 .args_type
= "path:F,freq:i?,bits:i?,nchannels:i?",
699 .params
= "path [frequency [bits [channels]]]",
700 .help
= "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
701 .mhandler
.cmd
= do_wav_capture
,
705 @item wavcapture @
var{filename
} [@
var{frequency
} [@
var{bits
} [@
var{channels
}]]]
707 Capture audio into @
var{filename
}. Using sample rate @
var{frequency
}
708 bits per sample @
var{bits
} and number of channels @
var{channels
}.
712 @item Sample rate
= 44100 Hz
- CD quality
714 @item Number of channels
= 2 - Stereo
720 .name
= "stopcapture",
722 .params
= "capture index",
723 .help
= "stop capture",
724 .mhandler
.cmd
= do_stop_capture
,
728 @item stopcapture @
var{index
}
730 Stop capture with a given @
var{index
}, index can be obtained with
738 .args_type
= "val:l,size:i,filename:s",
739 .params
= "addr size file",
740 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
741 .mhandler
.cmd
= hmp_memsave
,
745 @item memsave @
var{addr
} @
var{size
} @
var{file
}
747 save to disk virtual memory dump starting at @
var{addr
} of size @
var{size
}.
752 .args_type
= "val:l,size:i,filename:s",
753 .params
= "addr size file",
754 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
755 .mhandler
.cmd
= hmp_pmemsave
,
759 @item pmemsave @
var{addr
} @
var{size
} @
var{file
}
761 save to disk physical memory dump starting at @
var{addr
} of size @
var{size
}.
766 .args_type
= "bootdevice:s",
767 .params
= "bootdevice",
768 .help
= "define new values for the boot device list",
769 .mhandler
.cmd
= do_boot_set
,
773 @item boot_set @
var{bootdevicelist
}
776 Define
new values
for the boot device list
. Those values will
override
777 the values specified on the command line through the @code
{-boot
} option
.
779 The values that can be specified
here depend on the machine type
, but are
780 the same that can be specified
in the @code
{-boot
} command line option
.
783 #
if defined(TARGET_I386
)
788 .help
= "inject an NMI on all guest's CPUs",
789 .mhandler
.cmd
= hmp_inject_nmi
,
795 Inject an NMI on the given
CPU (x86 only
).
800 .args_type
= "detach:-d,blk:-b,inc:-i,uri:s",
801 .params
= "[-d] [-b] [-i] uri",
802 .help
= "migrate to URI (using -d to not wait for completion)"
803 "\n\t\t\t -b for migration without shared storage with"
804 " full copy of disk\n\t\t\t -i for migration without "
805 "shared storage with incremental copy of disk "
806 "(base image shared between src and destination)",
807 .mhandler
.cmd
= hmp_migrate
,
812 @item migrate
[-d
] [-b
] [-i
] @
var{uri
}
814 Migrate to @
var{uri
} (using -d to not wait
for completion
).
815 -b
for migration with full copy of disk
816 -i
for migration with incremental copy of
disk (base image is shared
)
820 .name
= "migrate_cancel",
823 .help
= "cancel the current VM migration",
824 .mhandler
.cmd
= hmp_migrate_cancel
,
829 @findex migrate_cancel
830 Cancel the current VM migration
.
835 .name
= "migrate_set_cache_size",
836 .args_type
= "value:o",
838 .help
= "set cache size (in bytes) for XBZRLE migrations,"
839 "the cache size will be rounded down to the nearest "
841 "The cache size affects the number of cache misses."
842 "In case of a high cache miss ratio you need to increase"
844 .mhandler
.cmd
= hmp_migrate_set_cache_size
,
848 @item migrate_set_cache_size @
var{value
}
849 @findex migrate_set_cache_size
850 Set cache size to @
var{value
} (in bytes
) for xbzrle migrations
.
854 .name
= "migrate_set_speed",
855 .args_type
= "value:o",
857 .help
= "set maximum speed (in bytes) for migrations. "
858 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
859 .mhandler
.cmd
= hmp_migrate_set_speed
,
863 @item migrate_set_speed @
var{value
}
864 @findex migrate_set_speed
865 Set maximum speed to @
var{value
} (in bytes
) for migrations
.
869 .name
= "migrate_set_downtime",
870 .args_type
= "value:T",
872 .help
= "set maximum tolerated downtime (in seconds) for migrations",
873 .mhandler
.cmd
= hmp_migrate_set_downtime
,
877 @item migrate_set_downtime @
var{second
}
878 @findex migrate_set_downtime
879 Set maximum tolerated
downtime (in seconds
) for migration
.
883 .name
= "migrate_set_capability",
884 .args_type
= "capability:s,state:b",
885 .params
= "capability state",
886 .help
= "Enable/Disable the usage of a capability for migration",
887 .mhandler
.cmd
= hmp_migrate_set_capability
,
891 @item migrate_set_capability @
var{capability
} @
var{state
}
892 @findex migrate_set_capability
893 Enable
/Disable the usage of a capability @
var{capability
} for migration
.
897 .name
= "client_migrate_info",
898 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
899 .params
= "protocol hostname port tls-port cert-subject",
900 .help
= "send migration info to spice/vnc client",
901 .user_print
= monitor_user_noop
,
902 .mhandler
.cmd_async
= client_migrate_info
,
903 .flags
= MONITOR_CMD_ASYNC
,
907 @item client_migrate_info @
var{protocol
} @
var{hostname
} @
var{port
} @
var{tls
-port
} @
var{cert
-subject
}
908 @findex client_migrate_info
909 Set the spice
/vnc connection info
for the migration target
. The spice
/vnc
910 server will ask the spice
/vnc client to automatically reconnect
using the
911 new parameters (if specified
) once the vm migration finished successfully
.
914 #
if defined(CONFIG_HAVE_CORE_DUMP
)
916 .name
= "dump-guest-memory",
917 .args_type
= "paging:-p,filename:F,begin:i?,length:i?",
918 .params
= "[-p] filename [begin] [length]",
919 .help
= "dump guest memory to file"
920 "\n\t\t\t begin(optional): the starting physical address"
921 "\n\t\t\t length(optional): the memory size, in bytes",
922 .mhandler
.cmd
= hmp_dump_guest_memory
,
927 @item dump
-guest
-memory
[-p
] @
var{protocol
} @
var{begin
} @
var{length
}
928 @findex dump
-guest
-memory
929 Dump guest memory to @
var{protocol
}. The file can be processed with crash or
931 filename
: dump file name
932 paging
: do paging to get guest
's memory mapping
933 begin: the starting physical address. It's optional
, and should be
934 specified with length together
.
935 length
: the memory size
, in bytes
. It
's optional, and should be specified
941 .name = "snapshot_blkdev",
942 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
943 .params = "[-n] device [new-image-file] [format]",
944 .help = "initiates a live snapshot\n\t\t\t"
945 "of device. If a new image file is specified, the\n\t\t\t"
946 "new image file will become the new root image.\n\t\t\t"
947 "If format is specified, the snapshot file will\n\t\t\t"
948 "be created in that format. Otherwise the\n\t\t\t"
949 "snapshot will be internal! (currently unsupported).\n\t\t\t"
950 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
951 "to reuse the image found in new-image-file, instead of\n\t\t\t"
952 "recreating it from scratch.",
953 .mhandler.cmd = hmp_snapshot_blkdev,
957 @item snapshot_blkdev
958 @findex snapshot_blkdev
959 Snapshot device, using snapshot file as target if provided
964 .args_type = "pci_addr:s,opts:s",
965 .params = "[[<domain>:]<bus>:]<slot>\n"
966 "[file=file][,if=type][,bus=n]\n"
967 "[,unit=m][,media=d][,index=i]\n"
968 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
969 "[,snapshot=on|off][,cache=on|off]\n"
970 "[,readonly=on|off][,copy-on-read=on|off]",
971 .help = "add drive to PCI storage controller",
972 .mhandler.cmd = drive_hot_add,
978 Add drive to PCI storage controller.
981 #if defined(TARGET_I386)
984 .args_type = "pci_addr:s,type:s,opts:s?",
985 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
986 .help = "hot-add PCI device",
987 .mhandler.cmd = pci_device_hot_add,
997 #if defined(TARGET_I386)
1000 .args_type = "pci_addr:s",
1001 .params = "[[<domain>:]<bus>:]<slot>",
1002 .help = "hot remove PCI device",
1003 .mhandler.cmd = do_pci_device_hot_remove,
1010 Hot remove PCI device.
1014 .name = "pcie_aer_inject_error",
1015 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1016 "id:s,error_status:s,"
1017 "header0:i?,header1:i?,header2:i?,header3:i?,"
1018 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1019 .params = "[-a] [-c] id "
1020 "<error_status> [<tlp header> [<tlp header prefix>]]",
1021 .help = "inject pcie aer error\n\t\t\t"
1022 " -a for advisory non fatal error\n\t\t\t"
1023 " -c for correctable error\n\t\t\t"
1024 "<id> = qdev device id\n\t\t\t"
1025 "<error_status> = error string or 32bit\n\t\t\t"
1026 "<tlb header> = 32bit x 4\n\t\t\t"
1027 "<tlb header prefix> = 32bit x 4",
1028 .user_print = pcie_aer_inject_error_print,
1029 .mhandler.cmd_new = do_pcie_aer_inject_error,
1033 @item pcie_aer_inject_error
1034 @findex pcie_aer_inject_error
1035 Inject PCIe AER error
1039 .name = "host_net_add",
1040 .args_type = "device:s,opts:s?",
1041 .params = "tap|user|socket|vde|dump [options]",
1042 .help = "add host VLAN client",
1043 .mhandler.cmd = net_host_device_add,
1048 @findex host_net_add
1049 Add host VLAN client.
1053 .name = "host_net_remove",
1054 .args_type = "vlan_id:i,device:s",
1055 .params = "vlan_id name",
1056 .help = "remove host VLAN client",
1057 .mhandler.cmd = net_host_device_remove,
1061 @item host_net_remove
1062 @findex host_net_remove
1063 Remove host VLAN client.
1067 .name = "netdev_add",
1068 .args_type = "netdev:O",
1069 .params = "[user|tap|socket],id=str[,prop=value][,...]",
1070 .help = "add host network device",
1071 .mhandler.cmd = hmp_netdev_add,
1077 Add host network device.
1081 .name = "netdev_del",
1082 .args_type = "id:s",
1084 .help = "remove host network device",
1085 .mhandler.cmd = hmp_netdev_del,
1091 Remove host network device.
1096 .name = "hostfwd_add",
1097 .args_type = "arg1:s,arg2:s?,arg3:s?",
1098 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1099 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1100 .mhandler.cmd = net_slirp_hostfwd_add,
1106 Redirect TCP or UDP connections from host to guest (requires -net user).
1111 .name = "hostfwd_remove",
1112 .args_type = "arg1:s,arg2:s?,arg3:s?",
1113 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1114 .help = "remove host-to-guest TCP or UDP redirection",
1115 .mhandler.cmd = net_slirp_hostfwd_remove,
1120 @item hostfwd_remove
1121 @findex hostfwd_remove
1122 Remove host-to-guest TCP or UDP redirection.
1127 .args_type = "value:M",
1129 .help = "request VM to change its memory allocation (in MB)",
1130 .mhandler.cmd = hmp_balloon,
1134 @item balloon @var{value}
1136 Request VM to change its memory allocation to @var{value} (in MB).
1141 .args_type = "name:s,up:b",
1142 .params = "name on|off",
1143 .help = "change the link status of a network adapter",
1144 .mhandler.cmd = hmp_set_link,
1148 @item set_link @var{name} [on|off]
1150 Switch link @var{name} on (i.e. up) or off (i.e. down).
1154 .name = "watchdog_action",
1155 .args_type = "action:s",
1156 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1157 .help = "change watchdog action",
1158 .mhandler.cmd = do_watchdog_action,
1162 @item watchdog_action
1163 @findex watchdog_action
1164 Change watchdog action.
1169 .args_type = "aclname:s",
1170 .params = "aclname",
1171 .help = "list rules in the access control list",
1172 .mhandler.cmd = do_acl_show,
1176 @item acl_show @var{aclname}
1178 List all the matching rules in the access control list, and the default
1179 policy. There are currently two named access control lists,
1180 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1181 certificate distinguished name, and SASL username respectively.
1185 .name = "acl_policy",
1186 .args_type = "aclname:s,policy:s",
1187 .params = "aclname allow|deny",
1188 .help = "set default access control list policy",
1189 .mhandler.cmd = do_acl_policy,
1193 @item acl_policy @var{aclname} @code{allow|deny}
1195 Set the default access control list policy, used in the event that
1196 none of the explicit rules match. The default policy at startup is
1202 .args_type = "aclname:s,match:s,policy:s,index:i?",
1203 .params = "aclname match allow|deny [index]",
1204 .help = "add a match rule to the access control list",
1205 .mhandler.cmd = do_acl_add,
1209 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1211 Add a match rule to the access control list, allowing or denying access.
1212 The match will normally be an exact username or x509 distinguished name,
1213 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1214 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1215 normally be appended to the end of the ACL, but can be inserted
1216 earlier in the list if the optional @var{index} parameter is supplied.
1220 .name = "acl_remove",
1221 .args_type = "aclname:s,match:s",
1222 .params = "aclname match",
1223 .help = "remove a match rule from the access control list",
1224 .mhandler.cmd = do_acl_remove,
1228 @item acl_remove @var{aclname} @var{match}
1230 Remove the specified match rule from the access control list.
1234 .name = "acl_reset",
1235 .args_type = "aclname:s",
1236 .params = "aclname",
1237 .help = "reset the access control list",
1238 .mhandler.cmd = do_acl_reset,
1242 @item acl_reset @var{aclname}
1244 Remove all matches from the access control list, and set the default
1245 policy back to @code{deny}.
1248 #if defined(TARGET_I386)
1252 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1253 .params = "[-b] cpu bank status mcgstatus addr misc",
1254 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1255 .mhandler.cmd = do_inject_mce,
1260 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1262 Inject an MCE on the given CPU (x86 only).
1267 .args_type = "fdname:s",
1268 .params = "getfd name",
1269 .help = "receive a file descriptor via SCM rights and assign it a name",
1270 .mhandler.cmd = hmp_getfd,
1274 @item getfd @var{fdname}
1276 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1277 mechanism on unix sockets, it is stored using the name @var{fdname} for
1278 later use by other monitor commands.
1283 .args_type = "fdname:s",
1284 .params = "closefd name",
1285 .help = "close a file descriptor previously passed via SCM rights",
1286 .mhandler.cmd = hmp_closefd,
1290 @item closefd @var{fdname}
1292 Close the file descriptor previously assigned to @var{fdname} using the
1293 @code{getfd} command. This is only needed if the file descriptor was never
1294 used by another monitor command.
1298 .name = "block_passwd",
1299 .args_type = "device:B,password:s",
1300 .params = "block_passwd device password",
1301 .help = "set the password of encrypted block devices",
1302 .mhandler.cmd = hmp_block_passwd,
1306 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1307 @findex block_set_io_throttle
1308 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}
1312 .name = "block_set_io_throttle",
1313 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1314 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1315 .help = "change I/O throttle limits for a block drive",
1316 .mhandler.cmd = hmp_block_set_io_throttle,
1320 @item block_passwd @var{device} @var{password}
1321 @findex block_passwd
1322 Set the encrypted device @var{device} password to @var{password}
1326 .name = "set_password",
1327 .args_type = "protocol:s,password:s,connected:s?",
1328 .params = "protocol password action-if-connected",
1329 .help = "set spice/vnc password",
1330 .mhandler.cmd = hmp_set_password,
1334 @item set_password [ vnc | spice ] password [ action-if-connected ]
1335 @findex set_password
1337 Change spice/vnc password. Use zero to make the password stay valid
1338 forever. @var{action-if-connected} specifies what should happen in
1339 case a connection is established: @var{fail} makes the password change
1340 fail. @var{disconnect} changes the password and disconnects the
1341 client. @var{keep} changes the password and keeps the connection up.
1342 @var{keep} is the default.
1346 .name = "expire_password",
1347 .args_type = "protocol:s,time:s",
1348 .params = "protocol time",
1349 .help = "set spice/vnc password expire-time",
1350 .mhandler.cmd = hmp_expire_password,
1354 @item expire_password [ vnc | spice ] expire-time
1355 @findex expire_password
1357 Specify when a password for spice/vnc becomes
1358 invalid. @var{expire-time} accepts:
1362 Invalidate password instantly.
1365 Password stays valid forever.
1368 Password stays valid for @var{nsec} seconds starting now.
1371 Password is invalidated at the given time. @var{nsec} are the seconds
1372 passed since 1970, i.e. unix epoch.
1379 .args_type = "item:s?",
1380 .params = "[subcommand]",
1381 .help = "show various information about the system state",
1382 .mhandler.cmd = do_info,
1386 @item info @var{subcommand}
1388 Show various information about the system state.
1392 show the version of QEMU
1394 show the various VLANs and the associated devices
1396 show the character devices
1398 show the block devices
1399 @item info blockstats
1400 show block device statistics
1401 @item info registers
1402 show the cpu registers
1404 show infos for each CPU
1406 show the command line history
1408 show the interrupts statistics (if available)
1410 show i8259 (PIC) state
1412 show emulated PCI device info
1414 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1416 show the active virtual memory mappings (i386 only)
1418 show dynamic compiler info
1420 show NUMA information
1422 show KVM information
1424 show USB devices plugged on the virtual USB hub
1426 show all USB host devices
1428 show profiling information
1430 show information about active capturing
1431 @item info snapshots
1432 show list of VM snapshots
1434 show the current VM status (running|paused)
1436 show guest PCMCIA status
1438 show which guest mouse is receiving events
1440 show the vnc server status
1442 show the current VM name
1444 show the current VM UUID
1448 show user network stack connection states
1450 show migration status
1451 @item info migrate_capabilities
1452 show current migration capabilities
1453 @item info migrate_cache_size
1454 show current migration XBZRLE cache size
1456 show balloon information
1460 show qdev device model list
1466 #ifdef CONFIG_TRACE_SIMPLE
1469 show contents of trace buffer
1474 @item info trace-events
1475 show available trace events and their state