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
= "force:-f,device:B",
103 .params
= "[-f] device",
104 .help
= "stop an active background block operation (use -f"
105 "\n\t\t\t if the operation is currently paused)",
106 .mhandler
.cmd
= hmp_block_job_cancel
,
110 @item block_job_cancel
111 @findex block_job_cancel
112 Stop an active block streaming operation
.
116 .name
= "block_job_pause",
117 .args_type
= "device:B",
119 .help
= "pause an active background block operation",
120 .mhandler
.cmd
= hmp_block_job_pause
,
124 @item block_job_pause
125 @findex block_job_pause
126 Pause an active block streaming operation
.
130 .name
= "block_job_resume",
131 .args_type
= "device:B",
133 .help
= "resume a paused background block operation",
134 .mhandler
.cmd
= hmp_block_job_resume
,
138 @item block_job_resume
139 @findex block_job_resume
140 Resume a paused block streaming operation
.
145 .args_type
= "force:-f,device:B",
146 .params
= "[-f] device",
147 .help
= "eject a removable medium (use -f to force it)",
148 .mhandler
.cmd
= hmp_eject
,
152 @item eject
[-f
] @
var{device
}
154 Eject a removable
medium (use
-f to force it
).
161 .help
= "remove host block device",
162 .user_print
= monitor_user_noop
,
163 .mhandler
.cmd_new
= do_drive_del
,
167 @item drive_del @
var{device
}
169 Remove host block device
. The result is that guest generated IO is no longer
170 submitted against the host device underlying the disk
. Once a drive has
171 been deleted
, the QEMU Block layer returns
-EIO which results
in IO
172 errors
in the guest
for applications that are reading
/writing to the device
.
177 .args_type
= "device:B,target:F,arg:s?",
178 .params
= "device filename [format]",
179 .help
= "change a removable medium, optional format",
180 .mhandler
.cmd
= hmp_change
,
184 @item change @
var{device
} @
var{setting
}
187 Change the configuration of a device
.
190 @item change @
var{diskdevice
} @
var{filename
} [@
var{format
}]
191 Change the medium
for a removable disk device to point to @
var{filename
}. eg
194 (qemu
) change ide1
-cd0
/path
/to
/some
.iso
197 @
var{format
} is optional
.
199 @item change vnc @
var{display
},@
var{options
}
200 Change the configuration of the VNC server
. The valid syntax
for @
var{display
}
201 and @
var{options
} are described at @ref
{sec_invocation
}. eg
204 (qemu
) change vnc localhost
:1
207 @item change vnc password
[@
var{password
}]
209 Change the password associated with the VNC server
. If the
new password is not
210 supplied
, the monitor will prompt
for it to be entered
. VNC passwords are only
211 significant up to
8 letters
. eg
214 (qemu
) change vnc password
222 .name
= "screendump",
223 .args_type
= "filename:F",
224 .params
= "filename",
225 .help
= "save screen into PPM image 'filename'",
226 .mhandler
.cmd
= hmp_screen_dump
,
230 @item screendump @
var{filename
}
232 Save screen into PPM image @
var{filename
}.
237 .args_type
= "filename:F",
238 .params
= "filename",
239 .help
= "output logs to 'filename'",
240 .mhandler
.cmd
= do_logfile
,
244 @item logfile @
var{filename
}
246 Output logs to @
var{filename
}.
250 .name
= "trace-event",
251 .args_type
= "name:s,option:b",
252 .params
= "name on|off",
253 .help
= "changes status of a specific trace event",
254 .mhandler
.cmd
= do_trace_event_set_state
,
260 changes status of a
trace event
263 #
if defined(CONFIG_TRACE_SIMPLE
)
265 .name
= "trace-file",
266 .args_type
= "op:s?,arg:F?",
267 .params
= "on|off|flush|set [arg]",
268 .help
= "open, close, or flush trace file, or set a new file name",
269 .mhandler
.cmd
= do_trace_file
,
273 @item
trace-file on|off|flush
275 Open
, close
, or flush the
trace file
. If no argument is given
, the status of the
trace file is displayed
.
281 .args_type
= "items:s",
282 .params
= "item1[,...]",
283 .help
= "activate logging of the specified items to '/tmp/qemu.log'",
284 .mhandler
.cmd
= do_log
,
288 @item log @
var{item1
}[,...]
290 Activate logging of the specified items to @file
{/tmp
/qemu
.log
}.
295 .args_type
= "name:s?",
296 .params
= "[tag|id]",
297 .help
= "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
298 .mhandler
.cmd
= do_savevm
,
302 @item savevm
[@
var{tag
}|@
var{id
}]
304 Create a snapshot of the whole virtual machine
. If @
var{tag
} is
305 provided
, it is used as human readable identifier
. If there is already
306 a snapshot with the same tag or ID
, it is replaced
. More info at
312 .args_type
= "name:s",
314 .help
= "restore a VM snapshot from its tag or id",
315 .mhandler
.cmd
= do_loadvm
,
319 @item loadvm @
var{tag
}|@
var{id
}
321 Set the whole virtual machine to the snapshot identified by the tag
322 @
var{tag
} or the unique snapshot ID @
var{id
}.
327 .args_type
= "name:s",
329 .help
= "delete a VM snapshot from its tag or id",
330 .mhandler
.cmd
= do_delvm
,
334 @item delvm @
var{tag
}|@
var{id
}
336 Delete the snapshot identified by @
var{tag
} or @
var{id
}.
340 .name
= "singlestep",
341 .args_type
= "option:s?",
342 .params
= "[on|off]",
343 .help
= "run emulation in singlestep mode or switch to normal mode",
344 .mhandler
.cmd
= do_singlestep
,
348 @item singlestep
[off
]
350 Run the emulation
in single step mode
.
351 If called with option off
, the emulation returns to normal mode
.
358 .help
= "stop emulation",
359 .mhandler
.cmd
= hmp_stop
,
372 .help
= "resume emulation",
373 .mhandler
.cmd
= hmp_cont
,
383 .name
= "system_wakeup",
386 .help
= "wakeup guest from suspend",
387 .mhandler
.cmd
= hmp_system_wakeup
,
392 @findex system_wakeup
393 Wakeup guest from suspend
.
398 .args_type
= "device:s?",
399 .params
= "[device]",
400 .help
= "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
401 .mhandler
.cmd
= do_gdbserver
,
405 @item gdbserver
[@
var{port
}]
407 Start gdbserver
session (default @
var{port
}=1234)
412 .args_type
= "fmt:/,addr:l",
413 .params
= "/fmt addr",
414 .help
= "virtual memory dump starting at 'addr'",
415 .mhandler
.cmd
= do_memory_dump
,
419 @item x
/fmt @
var{addr
}
421 Virtual memory dump starting at @
var{addr
}.
426 .args_type
= "fmt:/,addr:l",
427 .params
= "/fmt addr",
428 .help
= "physical memory dump starting at 'addr'",
429 .mhandler
.cmd
= do_physical_memory_dump
,
433 @item xp
/@
var{fmt
} @
var{addr
}
435 Physical memory dump starting at @
var{addr
}.
437 @
var{fmt
} is a format which tells the command how to format the
438 data
. Its syntax is
: @option
{/@
{count@
}@
{format@
}@
{size@
}}
442 is the number of items to be dumped
.
445 can be
x (hex
), d (signed decimal
), u (unsigned decimal
), o (octal
),
446 c (char
) or
i (asm instruction
).
449 can be
b (8 bits
), h (16 bits
), w (32 bits
) or
g (64 bits
). On x86
,
450 @code
{h
} or @code
{w
} can be specified with the @code
{i
} format to
451 respectively select
16 or
32 bit code instruction size
.
458 Dump
10 instructions at the current instruction pointer
:
463 0x90107065: lea
0x0(%esi
,1),%esi
464 0x90107069: lea
0x0(%edi
,1),%edi
466 0x90107071: jmp
0x90107080
474 Dump
80 16 bit values at the start of the video memory
.
476 (qemu
) xp
/80hx
0xb8000
477 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
478 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
479 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
480 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
481 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
482 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
483 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
484 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
485 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
486 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
493 .args_type
= "fmt:/,val:l",
494 .params
= "/fmt expr",
495 .help
= "print expression value (use $reg for CPU register access)",
496 .mhandler
.cmd
= do_print
,
500 @item p or print
/@
var{fmt
} @
var{expr
}
503 Print expression value
. Only the @
var{format
} part of @
var{fmt
} is
509 .args_type
= "fmt:/,addr:i,index:i.",
510 .params
= "/fmt addr",
511 .help
= "I/O port read",
512 .mhandler
.cmd
= do_ioport_read
,
521 .args_type
= "fmt:/,addr:i,val:i",
522 .params
= "/fmt addr value",
523 .help
= "I/O port write",
524 .mhandler
.cmd
= do_ioport_write
,
533 .args_type
= "keys:s,hold-time:i?",
534 .params
= "keys [hold_ms]",
535 .help
= "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
536 .mhandler
.cmd
= hmp_send_key
,
540 @item sendkey @
var{keys
}
543 Send @
var{keys
} to the guest
. @
var{keys
} could be the name of the
544 key or the raw value
in hexadecimal format
. Use @code
{-} to press
545 several keys simultaneously
. Example
:
550 This command is useful to send keys that your graphical user
interface
551 intercepts at low level
, such as @code
{ctrl
-alt
-f1
} in X Window
.
555 .name
= "system_reset",
558 .help
= "reset the system",
559 .mhandler
.cmd
= hmp_system_reset
,
570 .name
= "system_powerdown",
573 .help
= "send system power down event",
574 .mhandler
.cmd
= hmp_system_powerdown
,
578 @item system_powerdown
579 @findex system_powerdown
581 Power down the
system (if supported
).
586 .args_type
= "start:i,size:i",
587 .params
= "addr size",
588 .help
= "compute the checksum of a memory region",
589 .mhandler
.cmd
= do_sum
,
593 @item sum @
var{addr
} @
var{size
}
596 Compute the checksum of a memory region
.
601 .args_type
= "devname:s",
603 .help
= "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
604 .mhandler
.cmd
= do_usb_add
,
608 @item usb_add @
var{devname
}
611 Add the USB device @
var{devname
}. For details of available devices see
617 .args_type
= "devname:s",
619 .help
= "remove USB device 'bus.addr'",
620 .mhandler
.cmd
= do_usb_del
,
624 @item usb_del @
var{devname
}
627 Remove the USB device @
var{devname
} from the QEMU virtual USB
628 hub
. @
var{devname
} has the syntax @code
{bus
.addr
}. Use the monitor
629 command @code
{info usb
} to see the devices you can remove
.
633 .name
= "device_add",
634 .args_type
= "device:O",
635 .params
= "driver[,prop=value][,...]",
636 .help
= "add device, like -device on the command line",
637 .user_print
= monitor_user_noop
,
638 .mhandler
.cmd_new
= do_device_add
,
642 @item device_add @
var{config
}
649 .name
= "device_del",
652 .help
= "remove device",
653 .mhandler
.cmd
= hmp_device_del
,
657 @item device_del @
var{id
}
660 Remove device @
var{id
}.
665 .args_type
= "index:i",
667 .help
= "set the default CPU",
668 .mhandler
.cmd
= hmp_cpu
,
672 @item cpu @
var{index
}
678 .name
= "mouse_move",
679 .args_type
= "dx_str:s,dy_str:s,dz_str:s?",
680 .params
= "dx dy [dz]",
681 .help
= "send mouse move events",
682 .mhandler
.cmd
= do_mouse_move
,
686 @item mouse_move @
var{dx
} @
var{dy
} [@
var{dz
}]
688 Move the active mouse to the specified coordinates @
var{dx
} @
var{dy
}
689 with optional scroll axis @
var{dz
}.
693 .name
= "mouse_button",
694 .args_type
= "button_state:i",
696 .help
= "change mouse button state (1=L, 2=M, 4=R)",
697 .mhandler
.cmd
= do_mouse_button
,
701 @item mouse_button @
var{val
}
703 Change the active mouse button state @
var{val
} (1=L
, 2=M
, 4=R
).
708 .args_type
= "index:i",
710 .help
= "set which mouse device receives events",
711 .mhandler
.cmd
= do_mouse_set
,
715 @item mouse_set @
var{index
}
717 Set which mouse device receives events at given @
var{index
}, index
726 .name
= "wavcapture",
727 .args_type
= "path:F,freq:i?,bits:i?,nchannels:i?",
728 .params
= "path [frequency [bits [channels]]]",
729 .help
= "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
730 .mhandler
.cmd
= do_wav_capture
,
734 @item wavcapture @
var{filename
} [@
var{frequency
} [@
var{bits
} [@
var{channels
}]]]
736 Capture audio into @
var{filename
}. Using sample rate @
var{frequency
}
737 bits per sample @
var{bits
} and number of channels @
var{channels
}.
741 @item Sample rate
= 44100 Hz
- CD quality
743 @item Number of channels
= 2 - Stereo
749 .name
= "stopcapture",
751 .params
= "capture index",
752 .help
= "stop capture",
753 .mhandler
.cmd
= do_stop_capture
,
757 @item stopcapture @
var{index
}
759 Stop capture with a given @
var{index
}, index can be obtained with
767 .args_type
= "val:l,size:i,filename:s",
768 .params
= "addr size file",
769 .help
= "save to disk virtual memory dump starting at 'addr' of size 'size'",
770 .mhandler
.cmd
= hmp_memsave
,
774 @item memsave @
var{addr
} @
var{size
} @
var{file
}
776 save to disk virtual memory dump starting at @
var{addr
} of size @
var{size
}.
781 .args_type
= "val:l,size:i,filename:s",
782 .params
= "addr size file",
783 .help
= "save to disk physical memory dump starting at 'addr' of size 'size'",
784 .mhandler
.cmd
= hmp_pmemsave
,
788 @item pmemsave @
var{addr
} @
var{size
} @
var{file
}
790 save to disk physical memory dump starting at @
var{addr
} of size @
var{size
}.
795 .args_type
= "bootdevice:s",
796 .params
= "bootdevice",
797 .help
= "define new values for the boot device list",
798 .mhandler
.cmd
= do_boot_set
,
802 @item boot_set @
var{bootdevicelist
}
805 Define
new values
for the boot device list
. Those values will
override
806 the values specified on the command line through the @code
{-boot
} option
.
808 The values that can be specified
here depend on the machine type
, but are
809 the same that can be specified
in the @code
{-boot
} command line option
.
812 #
if defined(TARGET_I386
)
817 .help
= "inject an NMI on all guest's CPUs",
818 .mhandler
.cmd
= hmp_inject_nmi
,
824 Inject an NMI on the given
CPU (x86 only
).
829 .args_type
= "detach:-d,blk:-b,inc:-i,uri:s",
830 .params
= "[-d] [-b] [-i] uri",
831 .help
= "migrate to URI (using -d to not wait for completion)"
832 "\n\t\t\t -b for migration without shared storage with"
833 " full copy of disk\n\t\t\t -i for migration without "
834 "shared storage with incremental copy of disk "
835 "(base image shared between src and destination)",
836 .mhandler
.cmd
= hmp_migrate
,
841 @item migrate
[-d
] [-b
] [-i
] @
var{uri
}
843 Migrate to @
var{uri
} (using -d to not wait
for completion
).
844 -b
for migration with full copy of disk
845 -i
for migration with incremental copy of
disk (base image is shared
)
849 .name
= "migrate_cancel",
852 .help
= "cancel the current VM migration",
853 .mhandler
.cmd
= hmp_migrate_cancel
,
858 @findex migrate_cancel
859 Cancel the current VM migration
.
864 .name
= "migrate_set_cache_size",
865 .args_type
= "value:o",
867 .help
= "set cache size (in bytes) for XBZRLE migrations,"
868 "the cache size will be rounded down to the nearest "
870 "The cache size affects the number of cache misses."
871 "In case of a high cache miss ratio you need to increase"
873 .mhandler
.cmd
= hmp_migrate_set_cache_size
,
877 @item migrate_set_cache_size @
var{value
}
878 @findex migrate_set_cache_size
879 Set cache size to @
var{value
} (in bytes
) for xbzrle migrations
.
883 .name
= "migrate_set_speed",
884 .args_type
= "value:o",
886 .help
= "set maximum speed (in bytes) for migrations. "
887 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
888 .mhandler
.cmd
= hmp_migrate_set_speed
,
892 @item migrate_set_speed @
var{value
}
893 @findex migrate_set_speed
894 Set maximum speed to @
var{value
} (in bytes
) for migrations
.
898 .name
= "migrate_set_downtime",
899 .args_type
= "value:T",
901 .help
= "set maximum tolerated downtime (in seconds) for migrations",
902 .mhandler
.cmd
= hmp_migrate_set_downtime
,
906 @item migrate_set_downtime @
var{second
}
907 @findex migrate_set_downtime
908 Set maximum tolerated
downtime (in seconds
) for migration
.
912 .name
= "migrate_set_capability",
913 .args_type
= "capability:s,state:b",
914 .params
= "capability state",
915 .help
= "Enable/Disable the usage of a capability for migration",
916 .mhandler
.cmd
= hmp_migrate_set_capability
,
920 @item migrate_set_capability @
var{capability
} @
var{state
}
921 @findex migrate_set_capability
922 Enable
/Disable the usage of a capability @
var{capability
} for migration
.
926 .name
= "client_migrate_info",
927 .args_type
= "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
928 .params
= "protocol hostname port tls-port cert-subject",
929 .help
= "send migration info to spice/vnc client",
930 .user_print
= monitor_user_noop
,
931 .mhandler
.cmd_async
= client_migrate_info
,
932 .flags
= MONITOR_CMD_ASYNC
,
936 @item client_migrate_info @
var{protocol
} @
var{hostname
} @
var{port
} @
var{tls
-port
} @
var{cert
-subject
}
937 @findex client_migrate_info
938 Set the spice
/vnc connection info
for the migration target
. The spice
/vnc
939 server will ask the spice
/vnc client to automatically reconnect
using the
940 new parameters (if specified
) once the vm migration finished successfully
.
943 #
if defined(CONFIG_HAVE_CORE_DUMP
)
945 .name
= "dump-guest-memory",
946 .args_type
= "paging:-p,filename:F,begin:i?,length:i?",
947 .params
= "[-p] filename [begin] [length]",
948 .help
= "dump guest memory to file"
949 "\n\t\t\t begin(optional): the starting physical address"
950 "\n\t\t\t length(optional): the memory size, in bytes",
951 .mhandler
.cmd
= hmp_dump_guest_memory
,
956 @item dump
-guest
-memory
[-p
] @
var{protocol
} @
var{begin
} @
var{length
}
957 @findex dump
-guest
-memory
958 Dump guest memory to @
var{protocol
}. The file can be processed with crash or
960 filename
: dump file name
961 paging
: do paging to get guest
's memory mapping
962 begin: the starting physical address. It's optional
, and should be
963 specified with length together
.
964 length
: the memory size
, in bytes
. It
's optional, and should be specified
970 .name = "snapshot_blkdev",
971 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
972 .params = "[-n] device [new-image-file] [format]",
973 .help = "initiates a live snapshot\n\t\t\t"
974 "of device. If a new image file is specified, the\n\t\t\t"
975 "new image file will become the new root image.\n\t\t\t"
976 "If format is specified, the snapshot file will\n\t\t\t"
977 "be created in that format. Otherwise the\n\t\t\t"
978 "snapshot will be internal! (currently unsupported).\n\t\t\t"
979 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
980 "to reuse the image found in new-image-file, instead of\n\t\t\t"
981 "recreating it from scratch.",
982 .mhandler.cmd = hmp_snapshot_blkdev,
986 @item snapshot_blkdev
987 @findex snapshot_blkdev
988 Snapshot device, using snapshot file as target if provided
993 .args_type = "pci_addr:s,opts:s",
994 .params = "[[<domain>:]<bus>:]<slot>\n"
995 "[file=file][,if=type][,bus=n]\n"
996 "[,unit=m][,media=d][,index=i]\n"
997 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
998 "[,snapshot=on|off][,cache=on|off]\n"
999 "[,readonly=on|off][,copy-on-read=on|off]",
1000 .help = "add drive to PCI storage controller",
1001 .mhandler.cmd = drive_hot_add,
1007 Add drive to PCI storage controller.
1010 #if defined(TARGET_I386)
1013 .args_type = "pci_addr:s,type:s,opts:s?",
1014 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1015 .help = "hot-add PCI device",
1016 .mhandler.cmd = pci_device_hot_add,
1026 #if defined(TARGET_I386)
1029 .args_type = "pci_addr:s",
1030 .params = "[[<domain>:]<bus>:]<slot>",
1031 .help = "hot remove PCI device",
1032 .mhandler.cmd = do_pci_device_hot_remove,
1039 Hot remove PCI device.
1043 .name = "pcie_aer_inject_error",
1044 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1045 "id:s,error_status:s,"
1046 "header0:i?,header1:i?,header2:i?,header3:i?,"
1047 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1048 .params = "[-a] [-c] id "
1049 "<error_status> [<tlp header> [<tlp header prefix>]]",
1050 .help = "inject pcie aer error\n\t\t\t"
1051 " -a for advisory non fatal error\n\t\t\t"
1052 " -c for correctable error\n\t\t\t"
1053 "<id> = qdev device id\n\t\t\t"
1054 "<error_status> = error string or 32bit\n\t\t\t"
1055 "<tlb header> = 32bit x 4\n\t\t\t"
1056 "<tlb header prefix> = 32bit x 4",
1057 .user_print = pcie_aer_inject_error_print,
1058 .mhandler.cmd_new = do_pcie_aer_inject_error,
1062 @item pcie_aer_inject_error
1063 @findex pcie_aer_inject_error
1064 Inject PCIe AER error
1068 .name = "host_net_add",
1069 .args_type = "device:s,opts:s?",
1070 .params = "tap|user|socket|vde|dump [options]",
1071 .help = "add host VLAN client",
1072 .mhandler.cmd = net_host_device_add,
1077 @findex host_net_add
1078 Add host VLAN client.
1082 .name = "host_net_remove",
1083 .args_type = "vlan_id:i,device:s",
1084 .params = "vlan_id name",
1085 .help = "remove host VLAN client",
1086 .mhandler.cmd = net_host_device_remove,
1090 @item host_net_remove
1091 @findex host_net_remove
1092 Remove host VLAN client.
1096 .name = "netdev_add",
1097 .args_type = "netdev:O",
1098 .params = "[user|tap|socket],id=str[,prop=value][,...]",
1099 .help = "add host network device",
1100 .mhandler.cmd = hmp_netdev_add,
1106 Add host network device.
1110 .name = "netdev_del",
1111 .args_type = "id:s",
1113 .help = "remove host network device",
1114 .mhandler.cmd = hmp_netdev_del,
1120 Remove host network device.
1125 .name = "hostfwd_add",
1126 .args_type = "arg1:s,arg2:s?,arg3:s?",
1127 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1128 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1129 .mhandler.cmd = net_slirp_hostfwd_add,
1135 Redirect TCP or UDP connections from host to guest (requires -net user).
1140 .name = "hostfwd_remove",
1141 .args_type = "arg1:s,arg2:s?,arg3:s?",
1142 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1143 .help = "remove host-to-guest TCP or UDP redirection",
1144 .mhandler.cmd = net_slirp_hostfwd_remove,
1149 @item hostfwd_remove
1150 @findex hostfwd_remove
1151 Remove host-to-guest TCP or UDP redirection.
1156 .args_type = "value:M",
1158 .help = "request VM to change its memory allocation (in MB)",
1159 .mhandler.cmd = hmp_balloon,
1163 @item balloon @var{value}
1165 Request VM to change its memory allocation to @var{value} (in MB).
1170 .args_type = "name:s,up:b",
1171 .params = "name on|off",
1172 .help = "change the link status of a network adapter",
1173 .mhandler.cmd = hmp_set_link,
1177 @item set_link @var{name} [on|off]
1179 Switch link @var{name} on (i.e. up) or off (i.e. down).
1183 .name = "watchdog_action",
1184 .args_type = "action:s",
1185 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1186 .help = "change watchdog action",
1187 .mhandler.cmd = do_watchdog_action,
1191 @item watchdog_action
1192 @findex watchdog_action
1193 Change watchdog action.
1198 .args_type = "aclname:s",
1199 .params = "aclname",
1200 .help = "list rules in the access control list",
1201 .mhandler.cmd = do_acl_show,
1205 @item acl_show @var{aclname}
1207 List all the matching rules in the access control list, and the default
1208 policy. There are currently two named access control lists,
1209 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1210 certificate distinguished name, and SASL username respectively.
1214 .name = "acl_policy",
1215 .args_type = "aclname:s,policy:s",
1216 .params = "aclname allow|deny",
1217 .help = "set default access control list policy",
1218 .mhandler.cmd = do_acl_policy,
1222 @item acl_policy @var{aclname} @code{allow|deny}
1224 Set the default access control list policy, used in the event that
1225 none of the explicit rules match. The default policy at startup is
1231 .args_type = "aclname:s,match:s,policy:s,index:i?",
1232 .params = "aclname match allow|deny [index]",
1233 .help = "add a match rule to the access control list",
1234 .mhandler.cmd = do_acl_add,
1238 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1240 Add a match rule to the access control list, allowing or denying access.
1241 The match will normally be an exact username or x509 distinguished name,
1242 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1243 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1244 normally be appended to the end of the ACL, but can be inserted
1245 earlier in the list if the optional @var{index} parameter is supplied.
1249 .name = "acl_remove",
1250 .args_type = "aclname:s,match:s",
1251 .params = "aclname match",
1252 .help = "remove a match rule from the access control list",
1253 .mhandler.cmd = do_acl_remove,
1257 @item acl_remove @var{aclname} @var{match}
1259 Remove the specified match rule from the access control list.
1263 .name = "acl_reset",
1264 .args_type = "aclname:s",
1265 .params = "aclname",
1266 .help = "reset the access control list",
1267 .mhandler.cmd = do_acl_reset,
1271 @item acl_reset @var{aclname}
1273 Remove all matches from the access control list, and set the default
1274 policy back to @code{deny}.
1277 #if defined(TARGET_I386)
1281 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1282 .params = "[-b] cpu bank status mcgstatus addr misc",
1283 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1284 .mhandler.cmd = do_inject_mce,
1289 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1291 Inject an MCE on the given CPU (x86 only).
1296 .args_type = "fdname:s",
1297 .params = "getfd name",
1298 .help = "receive a file descriptor via SCM rights and assign it a name",
1299 .mhandler.cmd = hmp_getfd,
1303 @item getfd @var{fdname}
1305 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1306 mechanism on unix sockets, it is stored using the name @var{fdname} for
1307 later use by other monitor commands.
1312 .args_type = "fdname:s",
1313 .params = "closefd name",
1314 .help = "close a file descriptor previously passed via SCM rights",
1315 .mhandler.cmd = hmp_closefd,
1319 @item closefd @var{fdname}
1321 Close the file descriptor previously assigned to @var{fdname} using the
1322 @code{getfd} command. This is only needed if the file descriptor was never
1323 used by another monitor command.
1327 .name = "block_passwd",
1328 .args_type = "device:B,password:s",
1329 .params = "block_passwd device password",
1330 .help = "set the password of encrypted block devices",
1331 .mhandler.cmd = hmp_block_passwd,
1335 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1336 @findex block_set_io_throttle
1337 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}
1341 .name = "block_set_io_throttle",
1342 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1343 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1344 .help = "change I/O throttle limits for a block drive",
1345 .mhandler.cmd = hmp_block_set_io_throttle,
1349 @item block_passwd @var{device} @var{password}
1350 @findex block_passwd
1351 Set the encrypted device @var{device} password to @var{password}
1355 .name = "set_password",
1356 .args_type = "protocol:s,password:s,connected:s?",
1357 .params = "protocol password action-if-connected",
1358 .help = "set spice/vnc password",
1359 .mhandler.cmd = hmp_set_password,
1363 @item set_password [ vnc | spice ] password [ action-if-connected ]
1364 @findex set_password
1366 Change spice/vnc password. Use zero to make the password stay valid
1367 forever. @var{action-if-connected} specifies what should happen in
1368 case a connection is established: @var{fail} makes the password change
1369 fail. @var{disconnect} changes the password and disconnects the
1370 client. @var{keep} changes the password and keeps the connection up.
1371 @var{keep} is the default.
1375 .name = "expire_password",
1376 .args_type = "protocol:s,time:s",
1377 .params = "protocol time",
1378 .help = "set spice/vnc password expire-time",
1379 .mhandler.cmd = hmp_expire_password,
1383 @item expire_password [ vnc | spice ] expire-time
1384 @findex expire_password
1386 Specify when a password for spice/vnc becomes
1387 invalid. @var{expire-time} accepts:
1391 Invalidate password instantly.
1394 Password stays valid forever.
1397 Password stays valid for @var{nsec} seconds starting now.
1400 Password is invalidated at the given time. @var{nsec} are the seconds
1401 passed since 1970, i.e. unix epoch.
1408 .args_type = "item:s?",
1409 .params = "[subcommand]",
1410 .help = "show various information about the system state",
1411 .mhandler.cmd = do_info,
1415 @item info @var{subcommand}
1417 Show various information about the system state.
1421 show the version of QEMU
1423 show the various VLANs and the associated devices
1425 show the character devices
1427 show the block devices
1428 @item info blockstats
1429 show block device statistics
1430 @item info registers
1431 show the cpu registers
1433 show infos for each CPU
1435 show the command line history
1437 show the interrupts statistics (if available)
1439 show i8259 (PIC) state
1441 show emulated PCI device info
1443 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1445 show the active virtual memory mappings (i386 only)
1447 show dynamic compiler info
1449 show NUMA information
1451 show KVM information
1453 show USB devices plugged on the virtual USB hub
1455 show all USB host devices
1457 show profiling information
1459 show information about active capturing
1460 @item info snapshots
1461 show list of VM snapshots
1463 show the current VM status (running|paused)
1465 show guest PCMCIA status
1467 show which guest mouse is receiving events
1469 show the vnc server status
1471 show the current VM name
1473 show the current VM UUID
1477 show user network stack connection states
1479 show migration status
1480 @item info migrate_capabilities
1481 show current migration capabilities
1482 @item info migrate_cache_size
1483 show current migration XBZRLE cache size
1485 show balloon information
1489 show qdev device model list
1495 #ifdef CONFIG_TRACE_SIMPLE
1498 show contents of trace buffer
1503 @item info trace-events
1504 show available trace events and their state