2009-06-06 16:22:04 +08:00
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "help|?",
|
|
|
|
.args_type = "name:s?",
|
|
|
|
.params = "[cmd]",
|
|
|
|
.help = "show the help",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_help_cmd,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item help or ? [@var{cmd}]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex help
|
2009-06-06 16:22:04 +08:00
|
|
|
Show the help for all commands or just for command @var{cmd}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "commit",
|
|
|
|
.args_type = "device:B",
|
|
|
|
.params = "device|all",
|
|
|
|
.help = "commit changes to the disk images (if -snapshot is used) or backing files",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_commit,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item commit
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex commit
|
2009-06-06 16:22:04 +08:00
|
|
|
Commit changes to the disk images (if -snapshot is used) or backing files.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "q|quit",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "quit the emulator",
|
2009-10-08 00:41:56 +08:00
|
|
|
.user_print = monitor_user_noop,
|
2011-09-16 01:20:28 +08:00
|
|
|
.mhandler.cmd = hmp_quit,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item q or quit
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex quit
|
2009-06-06 16:22:04 +08:00
|
|
|
Quit the emulator.
|
|
|
|
ETEXI
|
|
|
|
|
2011-01-24 20:32:33 +08:00
|
|
|
{
|
|
|
|
.name = "block_resize",
|
|
|
|
.args_type = "device:B,size:o",
|
|
|
|
.params = "device size",
|
|
|
|
.help = "resize a block image",
|
2011-11-26 00:57:10 +08:00
|
|
|
.mhandler.cmd = hmp_block_resize,
|
2011-01-24 20:32:33 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
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
|
|
|
|
|
2012-01-18 22:40:46 +08:00
|
|
|
{
|
|
|
|
.name = "block_stream",
|
2012-04-25 23:51:03 +08:00
|
|
|
.args_type = "device:B,speed:o?,base:s?",
|
|
|
|
.params = "device [speed [base]]",
|
2012-01-18 22:40:46 +08:00
|
|
|
.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.
|
2012-01-18 22:40:47 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_set_speed",
|
2012-04-25 23:51:02 +08:00
|
|
|
.args_type = "device:B,speed:o",
|
|
|
|
.params = "device speed",
|
2012-01-18 22:40:47 +08:00
|
|
|
.help = "set maximum speed for a background block operation",
|
|
|
|
.mhandler.cmd = hmp_block_job_set_speed,
|
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
2012-04-13 18:03:46 +08:00
|
|
|
@item block_job_set_speed
|
|
|
|
@findex block_job_set_speed
|
2012-01-18 22:40:47 +08:00
|
|
|
Set maximum speed for a background block operation.
|
2012-01-18 22:40:48 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_cancel",
|
2012-09-28 23:22:51 +08:00
|
|
|
.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)",
|
2012-01-18 22:40:48 +08:00
|
|
|
.mhandler.cmd = hmp_block_job_cancel,
|
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item block_job_cancel
|
|
|
|
@findex block_job_cancel
|
|
|
|
Stop an active block streaming operation.
|
2012-09-28 23:22:51 +08:00
|
|
|
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.
|
2012-01-18 22:40:46 +08:00
|
|
|
ETEXI
|
2011-01-24 20:32:33 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "eject",
|
2009-12-15 04:53:21 +08:00
|
|
|
.args_type = "force:-f,device:B",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "[-f] device",
|
|
|
|
.help = "eject a removable medium (use -f to force it)",
|
2011-12-08 02:02:36 +08:00
|
|
|
.mhandler.cmd = hmp_eject,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item eject [-f] @var{device}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex eject
|
2009-06-06 16:22:04 +08:00
|
|
|
Eject a removable medium (use -f to force it).
|
2010-11-13 01:07:13 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "drive_del",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.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.
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "change",
|
|
|
|
.args_type = "device:B,target:F,arg:s?",
|
|
|
|
.params = "device filename [format]",
|
|
|
|
.help = "change a removable medium, optional format",
|
2011-12-08 21:13:50 +08:00
|
|
|
.mhandler.cmd = hmp_change,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item change @var{device} @var{setting}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex change
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "screendump",
|
|
|
|
.args_type = "filename:F",
|
|
|
|
.params = "filename",
|
|
|
|
.help = "save screen into PPM image 'filename'",
|
2012-05-25 00:48:23 +08:00
|
|
|
.mhandler.cmd = hmp_screen_dump,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item screendump @var{filename}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex screendump
|
2009-06-06 16:22:04 +08:00
|
|
|
Save screen into PPM image @var{filename}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "logfile",
|
|
|
|
.args_type = "filename:F",
|
|
|
|
.params = "filename",
|
|
|
|
.help = "output logs to 'filename'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_logfile,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item logfile @var{filename}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex logfile
|
2009-06-06 16:22:04 +08:00
|
|
|
Output logs to @var{filename}.
|
|
|
|
ETEXI
|
|
|
|
|
2010-06-24 19:34:53 +08:00
|
|
|
{
|
|
|
|
.name = "trace-event",
|
|
|
|
.args_type = "name:s,option:b",
|
|
|
|
.params = "name on|off",
|
|
|
|
.help = "changes status of a specific trace event",
|
2011-09-01 02:31:18 +08:00
|
|
|
.mhandler.cmd = do_trace_event_set_state,
|
2010-06-24 19:34:53 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item trace-event
|
|
|
|
@findex trace-event
|
|
|
|
changes status of a trace event
|
2010-07-13 16:26:33 +08:00
|
|
|
ETEXI
|
|
|
|
|
2011-10-02 21:44:37 +08:00
|
|
|
#if defined(CONFIG_TRACE_SIMPLE)
|
2010-07-13 16:26:33 +08:00
|
|
|
{
|
|
|
|
.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.
|
2010-06-24 19:34:53 +08:00
|
|
|
ETEXI
|
|
|
|
#endif
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "log",
|
|
|
|
.args_type = "items:s",
|
|
|
|
.params = "item1[,...]",
|
|
|
|
.help = "activate logging of the specified items to '/tmp/qemu.log'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_log,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item log @var{item1}[,...]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex log
|
2009-06-06 16:22:04 +08:00
|
|
|
Activate logging of the specified items to @file{/tmp/qemu.log}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_savevm,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item savevm [@var{tag}|@var{id}]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex savevm
|
2009-06-06 16:22:04 +08:00
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "loadvm",
|
|
|
|
.args_type = "name:s",
|
|
|
|
.params = "tag|id",
|
|
|
|
.help = "restore a VM snapshot from its tag or id",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_loadvm,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item loadvm @var{tag}|@var{id}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex loadvm
|
2009-06-06 16:22:04 +08:00
|
|
|
Set the whole virtual machine to the snapshot identified by the tag
|
|
|
|
@var{tag} or the unique snapshot ID @var{id}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "delvm",
|
|
|
|
.args_type = "name:s",
|
|
|
|
.params = "tag|id",
|
|
|
|
.help = "delete a VM snapshot from its tag or id",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_delvm,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item delvm @var{tag}|@var{id}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex delvm
|
2009-06-06 16:22:04 +08:00
|
|
|
Delete the snapshot identified by @var{tag} or @var{id}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "singlestep",
|
|
|
|
.args_type = "option:s?",
|
|
|
|
.params = "[on|off]",
|
|
|
|
.help = "run emulation in singlestep mode or switch to normal mode",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_singlestep,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item singlestep [off]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex singlestep
|
2009-06-06 16:22:04 +08:00
|
|
|
Run the emulation in single step mode.
|
|
|
|
If called with option off, the emulation returns to normal mode.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "stop",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "stop emulation",
|
2011-09-16 01:34:39 +08:00
|
|
|
.mhandler.cmd = hmp_stop,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item stop
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex stop
|
2009-06-06 16:22:04 +08:00
|
|
|
Stop emulation.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "c|cont",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "resume emulation",
|
2011-11-23 03:58:31 +08:00
|
|
|
.mhandler.cmd = hmp_cont,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item c or cont
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex cont
|
2009-06-06 16:22:04 +08:00
|
|
|
Resume emulation.
|
2012-02-23 20:45:21 +08:00
|
|
|
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.
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "gdbserver",
|
|
|
|
.args_type = "device:s?",
|
|
|
|
.params = "[device]",
|
|
|
|
.help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_gdbserver,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item gdbserver [@var{port}]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex gdbserver
|
2009-06-06 16:22:04 +08:00
|
|
|
Start gdbserver session (default @var{port}=1234)
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "x",
|
|
|
|
.args_type = "fmt:/,addr:l",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "virtual memory dump starting at 'addr'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_memory_dump,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item x/fmt @var{addr}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex x
|
2009-06-06 16:22:04 +08:00
|
|
|
Virtual memory dump starting at @var{addr}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "xp",
|
|
|
|
.args_type = "fmt:/,addr:l",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "physical memory dump starting at 'addr'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_physical_memory_dump,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item xp /@var{fmt} @var{addr}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex xp
|
2009-06-06 16:22:04 +08:00
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "p|print",
|
|
|
|
.args_type = "fmt:/,val:l",
|
|
|
|
.params = "/fmt expr",
|
|
|
|
.help = "print expression value (use $reg for CPU register access)",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_print,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item p or print/@var{fmt} @var{expr}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex print
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
Print expression value. Only the @var{format} part of @var{fmt} is
|
|
|
|
used.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "i",
|
|
|
|
.args_type = "fmt:/,addr:i,index:i.",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "I/O port read",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_ioport_read,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
Read I/O port.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "o",
|
|
|
|
.args_type = "fmt:/,addr:i,val:i",
|
|
|
|
.params = "/fmt addr value",
|
|
|
|
.help = "I/O port write",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_ioport_write,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-07-14 16:20:11 +08:00
|
|
|
STEXI
|
|
|
|
Write to I/O port.
|
|
|
|
ETEXI
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "sendkey",
|
2012-08-31 10:56:22 +08:00
|
|
|
.args_type = "keys:s,hold-time:i?",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "keys [hold_ms]",
|
|
|
|
.help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
|
2012-08-31 10:56:26 +08:00
|
|
|
.mhandler.cmd = hmp_send_key,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item sendkey @var{keys}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex sendkey
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2012-08-31 10:56:20 +08:00
|
|
|
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:
|
2009-06-06 16:22:04 +08:00
|
|
|
@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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "system_reset",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "reset the system",
|
2011-09-16 01:41:46 +08:00
|
|
|
.mhandler.cmd = hmp_system_reset,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item system_reset
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex system_reset
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
Reset the system.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "system_powerdown",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "send system power down event",
|
2011-09-28 22:06:15 +08:00
|
|
|
.mhandler.cmd = hmp_system_powerdown,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item system_powerdown
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex system_powerdown
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
Power down the system (if supported).
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "sum",
|
|
|
|
.args_type = "start:i,size:i",
|
|
|
|
.params = "addr size",
|
|
|
|
.help = "compute the checksum of a memory region",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_sum,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item sum @var{addr} @var{size}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex sum
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
Compute the checksum of a memory region.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "usb_add",
|
|
|
|
.args_type = "devname:s",
|
|
|
|
.params = "device",
|
|
|
|
.help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_usb_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item usb_add @var{devname}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex usb_add
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
Add the USB device @var{devname}. For details of available devices see
|
|
|
|
@ref{usb_devices}
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "usb_del",
|
|
|
|
.args_type = "devname:s",
|
|
|
|
.params = "device",
|
|
|
|
.help = "remove USB device 'bus.addr'",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_usb_del,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item usb_del @var{devname}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex usb_del
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "device_add",
|
2010-02-11 03:47:28 +08:00
|
|
|
.args_type = "device:O",
|
|
|
|
.params = "driver[,prop=value][,...]",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "add device, like -device on the command line",
|
2010-02-11 03:52:01 +08:00
|
|
|
.user_print = monitor_user_noop,
|
|
|
|
.mhandler.cmd_new = do_device_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-09-26 03:42:41 +08:00
|
|
|
STEXI
|
|
|
|
@item device_add @var{config}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex device_add
|
2009-09-26 03:42:41 +08:00
|
|
|
|
|
|
|
Add device.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "device_del",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "device",
|
|
|
|
.help = "remove device",
|
2012-03-29 23:38:50 +08:00
|
|
|
.mhandler.cmd = hmp_device_del,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-09-26 03:42:41 +08:00
|
|
|
STEXI
|
|
|
|
@item device_del @var{id}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex device_del
|
2009-09-26 03:42:41 +08:00
|
|
|
|
|
|
|
Remove device @var{id}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "cpu",
|
|
|
|
.args_type = "index:i",
|
|
|
|
.params = "index",
|
|
|
|
.help = "set the default CPU",
|
2011-10-07 01:31:39 +08:00
|
|
|
.mhandler.cmd = hmp_cpu,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-09-26 03:42:41 +08:00
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
2010-05-04 19:20:32 +08:00
|
|
|
@item cpu @var{index}
|
|
|
|
@findex cpu
|
2009-06-06 16:22:04 +08:00
|
|
|
Set the default CPU.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_move",
|
|
|
|
.args_type = "dx_str:s,dy_str:s,dz_str:s?",
|
|
|
|
.params = "dx dy [dz]",
|
|
|
|
.help = "send mouse move events",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_mouse_move,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item mouse_move @var{dx} @var{dy} [@var{dz}]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex mouse_move
|
2009-06-06 16:22:04 +08:00
|
|
|
Move the active mouse to the specified coordinates @var{dx} @var{dy}
|
|
|
|
with optional scroll axis @var{dz}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_button",
|
|
|
|
.args_type = "button_state:i",
|
|
|
|
.params = "state",
|
|
|
|
.help = "change mouse button state (1=L, 2=M, 4=R)",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_mouse_button,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item mouse_button @var{val}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex mouse_button
|
2009-06-06 16:22:04 +08:00
|
|
|
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_set",
|
|
|
|
.args_type = "index:i",
|
|
|
|
.params = "index",
|
|
|
|
.help = "set which mouse device receives events",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_mouse_set,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item mouse_set @var{index}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex mouse_set
|
2009-06-06 16:22:04 +08:00
|
|
|
Set which mouse device receives events at given @var{index}, index
|
|
|
|
can be obtained with
|
|
|
|
@example
|
|
|
|
info mice
|
|
|
|
@end example
|
|
|
|
ETEXI
|
|
|
|
|
|
|
|
#ifdef HAS_AUDIO
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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)",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_wav_capture,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
|
|
|
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex wavcapture
|
2009-06-06 16:22:04 +08:00
|
|
|
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
|
|
|
|
|
|
|
|
#ifdef HAS_AUDIO
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "stopcapture",
|
|
|
|
.args_type = "n:i",
|
|
|
|
.params = "capture index",
|
|
|
|
.help = "stop capture",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_stop_capture,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
|
|
|
@item stopcapture @var{index}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex stopcapture
|
2009-06-06 16:22:04 +08:00
|
|
|
Stop capture with a given @var{index}, index can be obtained with
|
|
|
|
@example
|
|
|
|
info capture
|
|
|
|
@end example
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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'",
|
2011-11-23 02:32:37 +08:00
|
|
|
.mhandler.cmd = hmp_memsave,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item memsave @var{addr} @var{size} @var{file}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex memsave
|
2009-06-06 16:22:04 +08:00
|
|
|
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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'",
|
2011-11-23 03:26:46 +08:00
|
|
|
.mhandler.cmd = hmp_pmemsave,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item pmemsave @var{addr} @var{size} @var{file}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex pmemsave
|
2009-06-06 16:22:04 +08:00
|
|
|
save to disk physical memory dump starting at @var{addr} of size @var{size}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "boot_set",
|
|
|
|
.args_type = "bootdevice:s",
|
|
|
|
.params = "bootdevice",
|
|
|
|
.help = "define new values for the boot device list",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_boot_set,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item boot_set @var{bootdevicelist}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex boot_set
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
#if defined(TARGET_I386)
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "nmi",
|
2011-04-29 23:11:50 +08:00
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "inject an NMI on all guest's CPUs",
|
2011-11-23 22:55:53 +08:00
|
|
|
.mhandler.cmd = hmp_inject_nmi,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
|
|
|
@item nmi @var{cpu}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex nmi
|
2009-06-06 16:22:04 +08:00
|
|
|
Inject an NMI on the given CPU (x86 only).
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate",
|
2009-11-02 21:41:13 +08:00
|
|
|
.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)",
|
2011-12-06 00:48:01 +08:00
|
|
|
.mhandler.cmd = hmp_migrate,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-11-02 21:41:13 +08:00
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
2009-11-02 21:41:13 +08:00
|
|
|
@item migrate [-d] [-b] [-i] @var{uri}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex migrate
|
2009-06-06 16:22:04 +08:00
|
|
|
Migrate to @var{uri} (using -d to not wait for completion).
|
2009-11-02 21:41:13 +08:00
|
|
|
-b for migration with full copy of disk
|
|
|
|
-i for migration with incremental copy of disk (base image is shared)
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_cancel",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "cancel the current VM migration",
|
2011-11-28 08:54:09 +08:00
|
|
|
.mhandler.cmd = hmp_migrate_cancel,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item migrate_cancel
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex migrate_cancel
|
2009-06-06 16:22:04 +08:00
|
|
|
Cancel the current VM migration.
|
2012-08-07 02:42:54 +08:00
|
|
|
|
|
|
|
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.
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_set_speed",
|
2010-10-21 23:15:48 +08:00
|
|
|
.args_type = "value:o",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "value",
|
2010-10-21 23:15:48 +08:00
|
|
|
.help = "set maximum speed (in bytes) for migrations. "
|
|
|
|
"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
|
2011-11-28 21:59:37 +08:00
|
|
|
.mhandler.cmd = hmp_migrate_set_speed,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item migrate_set_speed @var{value}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex migrate_set_speed
|
2009-06-06 16:22:04 +08:00
|
|
|
Set maximum speed to @var{value} (in bytes) for migrations.
|
2009-05-29 03:22:58 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_set_downtime",
|
2010-01-25 21:23:07 +08:00
|
|
|
.args_type = "value:T",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "value",
|
|
|
|
.help = "set maximum tolerated downtime (in seconds) for migrations",
|
2011-11-28 09:18:01 +08:00
|
|
|
.mhandler.cmd = hmp_migrate_set_downtime,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-05-29 03:22:58 +08:00
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item migrate_set_downtime @var{second}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex migrate_set_downtime
|
2009-05-29 03:22:58 +08:00
|
|
|
Set maximum tolerated downtime (in seconds) for migration.
|
2012-08-07 02:42:48 +08:00
|
|
|
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,
|
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item migrate_set_capability @var{capability} @var{state}
|
|
|
|
@findex migrate_set_capability
|
|
|
|
Enable/Disable the usage of a capability @var{capability} for migration.
|
2010-12-16 20:52:16 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
2011-03-09 23:54:34 +08:00
|
|
|
.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,
|
2011-10-17 16:03:18 +08:00
|
|
|
.mhandler.cmd_async = client_migrate_info,
|
|
|
|
.flags = MONITOR_CMD_ASYNC,
|
2010-12-16 20:52:16 +08:00
|
|
|
},
|
|
|
|
|
2010-04-23 19:28:21 +08:00
|
|
|
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
|
|
|
|
|
2012-05-07 12:10:47 +08:00
|
|
|
#if defined(CONFIG_HAVE_CORE_DUMP)
|
|
|
|
{
|
|
|
|
.name = "dump-guest-memory",
|
2012-09-22 00:53:00 +08:00
|
|
|
.args_type = "paging:-p,filename:F,begin:i?,length:i?",
|
|
|
|
.params = "[-p] filename [begin] [length]",
|
2012-05-07 12:10:47 +08:00
|
|
|
.help = "dump guest memory to file"
|
|
|
|
"\n\t\t\t begin(optional): the starting physical address"
|
|
|
|
"\n\t\t\t length(optional): the memory size, in bytes",
|
|
|
|
.mhandler.cmd = hmp_dump_guest_memory,
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
|
|
|
|
@findex dump-guest-memory
|
|
|
|
Dump guest memory to @var{protocol}. The file can be processed with crash or
|
|
|
|
gdb.
|
2012-09-22 00:53:00 +08:00
|
|
|
filename: dump file name
|
2012-05-07 12:10:47 +08:00
|
|
|
paging: do paging to get guest's memory mapping
|
|
|
|
begin: the starting physical address. It's optional, and should be
|
|
|
|
specified with length together.
|
|
|
|
length: the memory size, in bytes. It's optional, and should be specified
|
|
|
|
with begin together.
|
|
|
|
ETEXI
|
|
|
|
#endif
|
|
|
|
|
2010-04-23 19:28:21 +08:00
|
|
|
{
|
2011-03-09 23:54:34 +08:00
|
|
|
.name = "snapshot_blkdev",
|
2012-03-07 01:55:59 +08:00
|
|
|
.args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
|
|
|
|
.params = "[-n] device [new-image-file] [format]",
|
2011-03-09 23:54:34 +08:00
|
|
|
.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"
|
|
|
|
"be created in that format. Otherwise the\n\t\t\t"
|
2012-03-07 01:55:59 +08:00
|
|
|
"snapshot will be internal! (currently unsupported).\n\t\t\t"
|
|
|
|
"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.",
|
2011-11-26 02:15:19 +08:00
|
|
|
.mhandler.cmd = hmp_snapshot_blkdev,
|
2010-04-23 19:28:21 +08:00
|
|
|
},
|
|
|
|
|
2010-12-16 20:52:16 +08:00
|
|
|
STEXI
|
|
|
|
@item snapshot_blkdev
|
|
|
|
@findex snapshot_blkdev
|
|
|
|
Snapshot device, using snapshot file as target if provided
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "drive_add",
|
|
|
|
.args_type = "pci_addr:s,opts:s",
|
|
|
|
.params = "[[<domain>:]<bus>:]<slot>\n"
|
|
|
|
"[file=file][,if=type][,bus=n]\n"
|
2011-11-17 21:40:32 +08:00
|
|
|
"[,unit=m][,media=d][,index=i]\n"
|
2009-10-08 00:41:50 +08:00
|
|
|
"[,cyls=c,heads=h,secs=s[,trans=t]]\n"
|
2011-11-17 21:40:32 +08:00
|
|
|
"[,snapshot=on|off][,cache=on|off]\n"
|
|
|
|
"[,readonly=on|off][,copy-on-read=on|off]",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "add drive to PCI storage controller",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = drive_hot_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item drive_add
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex drive_add
|
2009-06-06 16:22:04 +08:00
|
|
|
Add drive to PCI storage controller.
|
|
|
|
ETEXI
|
|
|
|
|
|
|
|
#if defined(TARGET_I386)
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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",
|
2010-05-12 16:53:00 +08:00
|
|
|
.mhandler.cmd = pci_device_hot_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
2009-10-08 00:41:50 +08:00
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item pci_add
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex pci_add
|
2009-06-06 16:22:04 +08:00
|
|
|
Hot-add PCI device.
|
|
|
|
ETEXI
|
|
|
|
|
|
|
|
#if defined(TARGET_I386)
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "pci_del",
|
|
|
|
.args_type = "pci_addr:s",
|
|
|
|
.params = "[[<domain>:]<bus>:]<slot>",
|
|
|
|
.help = "hot remove PCI device",
|
2010-05-12 16:53:01 +08:00
|
|
|
.mhandler.cmd = do_pci_device_hot_remove,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
2009-10-08 00:41:50 +08:00
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item pci_del
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex pci_del
|
2009-06-06 16:22:04 +08:00
|
|
|
Hot remove PCI device.
|
2010-12-24 11:14:14 +08:00
|
|
|
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,
|
2011-11-30 12:39:47 +08:00
|
|
|
.mhandler.cmd_new = do_pcie_aer_inject_error,
|
2010-12-24 11:14:14 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item pcie_aer_inject_error
|
|
|
|
@findex pcie_aer_inject_error
|
|
|
|
Inject PCIe AER error
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "host_net_add",
|
|
|
|
.args_type = "device:s,opts:s?",
|
|
|
|
.params = "tap|user|socket|vde|dump [options]",
|
|
|
|
.help = "add host VLAN client",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = net_host_device_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item host_net_add
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex host_net_add
|
2009-06-06 16:22:04 +08:00
|
|
|
Add host VLAN client.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "host_net_remove",
|
|
|
|
.args_type = "vlan_id:i,device:s",
|
|
|
|
.params = "vlan_id name",
|
|
|
|
.help = "remove host VLAN client",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = net_host_device_remove,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item host_net_remove
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex host_net_remove
|
2009-06-06 16:22:04 +08:00
|
|
|
Remove host VLAN client.
|
2010-03-26 00:22:40 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "netdev_add",
|
|
|
|
.args_type = "netdev:O",
|
|
|
|
.params = "[user|tap|socket],id=str[,prop=value][,...]",
|
|
|
|
.help = "add host network device",
|
2012-04-19 04:34:15 +08:00
|
|
|
.mhandler.cmd = hmp_netdev_add,
|
2010-03-26 00:22:40 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
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",
|
2012-04-17 01:36:32 +08:00
|
|
|
.mhandler.cmd = hmp_netdev_del,
|
2010-03-26 00:22:40 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
STEXI
|
|
|
|
@item netdev_del
|
|
|
|
@findex netdev_del
|
|
|
|
Remove host network device.
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
#ifdef CONFIG_SLIRP
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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)",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = net_slirp_hostfwd_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2010-05-04 19:20:30 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
|
|
|
@item hostfwd_add
|
|
|
|
@findex hostfwd_add
|
|
|
|
Redirect TCP or UDP connections from host to guest (requires -net user).
|
|
|
|
ETEXI
|
2009-10-08 00:41:50 +08:00
|
|
|
|
2010-05-04 19:20:30 +08:00
|
|
|
#ifdef CONFIG_SLIRP
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = net_slirp_hostfwd_remove,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
2010-05-04 19:20:30 +08:00
|
|
|
@item hostfwd_remove
|
|
|
|
@findex hostfwd_remove
|
|
|
|
Remove host-to-guest TCP or UDP redirection.
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "balloon",
|
2009-12-18 23:25:05 +08:00
|
|
|
.args_type = "value:M",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "target",
|
2010-05-20 00:49:28 +08:00
|
|
|
.help = "request VM to change its memory allocation (in MB)",
|
2011-11-26 00:38:09 +08:00
|
|
|
.mhandler.cmd = hmp_balloon,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item balloon @var{value}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex balloon
|
2009-06-06 16:22:04 +08:00
|
|
|
Request VM to change its memory allocation to @var{value} (in MB).
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "set_link",
|
2010-03-26 16:07:10 +08:00
|
|
|
.args_type = "name:s,up:b",
|
|
|
|
.params = "name on|off",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "change the link status of a network adapter",
|
2011-11-23 23:11:55 +08:00
|
|
|
.mhandler.cmd = hmp_set_link,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
2010-03-26 16:07:10 +08:00
|
|
|
@item set_link @var{name} [on|off]
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex set_link
|
2010-03-26 16:07:10 +08:00
|
|
|
Switch link @var{name} on (i.e. up) or off (i.e. down).
|
2009-06-06 16:22:04 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "watchdog_action",
|
|
|
|
.args_type = "action:s",
|
|
|
|
.params = "[reset|shutdown|poweroff|pause|debug|none]",
|
|
|
|
.help = "change watchdog action",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_watchdog_action,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@item watchdog_action
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex watchdog_action
|
2009-06-06 16:22:04 +08:00
|
|
|
Change watchdog action.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "acl_show",
|
|
|
|
.args_type = "aclname:s",
|
|
|
|
.params = "aclname",
|
|
|
|
.help = "list rules in the access control list",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_acl_show,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
2009-06-25 14:22:08 +08:00
|
|
|
@item acl_show @var{aclname}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex acl_show
|
2009-06-25 14:22:08 +08:00
|
|
|
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
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "acl_policy",
|
|
|
|
.args_type = "aclname:s,policy:s",
|
|
|
|
.params = "aclname allow|deny",
|
|
|
|
.help = "set default access control list policy",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_acl_policy,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-25 14:22:08 +08:00
|
|
|
STEXI
|
2009-07-03 14:46:05 +08:00
|
|
|
@item acl_policy @var{aclname} @code{allow|deny}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex acl_policy
|
2009-06-25 14:22:08 +08:00
|
|
|
Set the default access control list policy, used in the event that
|
2009-06-06 16:22:04 +08:00
|
|
|
none of the explicit rules match. The default policy at startup is
|
2009-06-25 14:22:08 +08:00
|
|
|
always @code{deny}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.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",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_acl_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-25 14:22:08 +08:00
|
|
|
STEXI
|
2010-05-04 19:20:31 +08:00
|
|
|
@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
|
|
|
|
@findex acl_add
|
2009-06-25 14:22:08 +08:00
|
|
|
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
|
2009-06-06 16:22:04 +08:00
|
|
|
normally be appended to the end of the ACL, but can be inserted
|
2009-06-25 14:22:08 +08:00
|
|
|
earlier in the list if the optional @var{index} parameter is supplied.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "acl_remove",
|
|
|
|
.args_type = "aclname:s,match:s",
|
|
|
|
.params = "aclname match",
|
|
|
|
.help = "remove a match rule from the access control list",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_acl_remove,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-25 14:22:08 +08:00
|
|
|
STEXI
|
|
|
|
@item acl_remove @var{aclname} @var{match}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex acl_remove
|
2009-06-25 14:22:08 +08:00
|
|
|
Remove the specified match rule from the access control list.
|
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "acl_reset",
|
|
|
|
.args_type = "aclname:s",
|
|
|
|
.params = "aclname",
|
|
|
|
.help = "reset the access control list",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_acl_reset,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-25 14:22:08 +08:00
|
|
|
STEXI
|
2010-05-04 19:20:31 +08:00
|
|
|
@item acl_reset @var{aclname}
|
|
|
|
@findex acl_reset
|
2009-06-25 14:22:08 +08:00
|
|
|
Remove all matches from the access control list, and set the default
|
2009-06-06 16:22:04 +08:00
|
|
|
policy back to @code{deny}.
|
|
|
|
ETEXI
|
|
|
|
|
2009-06-23 10:05:14 +08:00
|
|
|
#if defined(TARGET_I386)
|
2009-10-08 00:41:50 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "mce",
|
2010-12-10 16:21:02 +08:00
|
|
|
.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]",
|
2009-10-08 00:41:52 +08:00
|
|
|
.mhandler.cmd = do_inject_mce,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-23 10:05:14 +08:00
|
|
|
#endif
|
|
|
|
STEXI
|
|
|
|
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex mce (x86)
|
2009-06-23 10:05:14 +08:00
|
|
|
Inject an MCE on the given CPU (x86 only).
|
2009-07-22 16:11:40 +08:00
|
|
|
ETEXI
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "getfd",
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
.params = "getfd name",
|
|
|
|
.help = "receive a file descriptor via SCM rights and assign it a name",
|
2012-06-23 02:36:09 +08:00
|
|
|
.mhandler.cmd = hmp_getfd,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-07-22 16:11:40 +08:00
|
|
|
STEXI
|
|
|
|
@item getfd @var{fdname}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex getfd
|
2009-07-22 16:11:40 +08:00
|
|
|
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
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "closefd",
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
.params = "closefd name",
|
|
|
|
.help = "close a file descriptor previously passed via SCM rights",
|
2012-06-23 02:36:09 +08:00
|
|
|
.mhandler.cmd = hmp_closefd,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-07-22 16:11:40 +08:00
|
|
|
STEXI
|
|
|
|
@item closefd @var{fdname}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex closefd
|
2009-07-22 16:11:40 +08:00
|
|
|
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.
|
2009-12-05 01:24:09 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_passwd",
|
|
|
|
.args_type = "device:B,password:s",
|
|
|
|
.params = "block_passwd device password",
|
|
|
|
.help = "set the password of encrypted block devices",
|
2011-11-23 23:28:21 +08:00
|
|
|
.mhandler.cmd = hmp_block_passwd,
|
2009-12-05 01:24:09 +08:00
|
|
|
},
|
|
|
|
|
2011-11-08 13:00:31 +08:00
|
|
|
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",
|
2011-12-15 02:49:14 +08:00
|
|
|
.mhandler.cmd = hmp_block_set_io_throttle,
|
2011-11-08 13:00:31 +08:00
|
|
|
},
|
|
|
|
|
2009-12-05 01:24:09 +08:00
|
|
|
STEXI
|
|
|
|
@item block_passwd @var{device} @var{password}
|
2010-02-06 06:52:04 +08:00
|
|
|
@findex block_passwd
|
2009-12-05 01:24:09 +08:00
|
|
|
Set the encrypted device @var{device} password to @var{password}
|
2010-10-07 18:22:54 +08:00
|
|
|
ETEXI
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "set_password",
|
|
|
|
.args_type = "protocol:s,password:s,connected:s?",
|
|
|
|
.params = "protocol password action-if-connected",
|
|
|
|
.help = "set spice/vnc password",
|
2011-12-07 21:17:51 +08:00
|
|
|
.mhandler.cmd = hmp_set_password,
|
2010-10-07 18:22:54 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
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",
|
2011-12-07 21:47:57 +08:00
|
|
|
.mhandler.cmd = hmp_expire_password,
|
2010-10-07 18:22:54 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
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
|
2010-02-05 04:10:05 +08:00
|
|
|
ETEXI
|
2010-06-01 01:43:31 +08:00
|
|
|
|
2010-06-01 01:43:30 +08:00
|
|
|
{
|
|
|
|
.name = "info",
|
|
|
|
.args_type = "item:s?",
|
|
|
|
.params = "[subcommand]",
|
|
|
|
.help = "show various information about the system state",
|
2010-09-13 23:15:26 +08:00
|
|
|
.mhandler.cmd = do_info,
|
2010-06-01 01:43:30 +08:00
|
|
|
},
|
|
|
|
|
|
|
|
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
|
2012-01-08 00:02:40 +08:00
|
|
|
show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
|
2010-06-01 01:43:30 +08:00
|
|
|
@item info mem
|
|
|
|
show the active virtual memory mappings (i386 only)
|
|
|
|
@item info jit
|
|
|
|
show dynamic compiler info
|
|
|
|
@item info numa
|
|
|
|
show NUMA information
|
2010-06-01 01:43:31 +08:00
|
|
|
@item info kvm
|
|
|
|
show KVM information
|
2010-06-01 01:43:30 +08:00
|
|
|
@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
|
2012-08-07 02:42:47 +08:00
|
|
|
@item info migrate_capabilities
|
|
|
|
show current migration capabilities
|
2012-08-07 02:42:54 +08:00
|
|
|
@item info migrate_cache_size
|
|
|
|
show current migration XBZRLE cache size
|
2010-06-01 01:43:30 +08:00
|
|
|
@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
|
|
|
|
@end table
|
|
|
|
ETEXI
|
|
|
|
|
2011-09-01 02:30:43 +08:00
|
|
|
#ifdef CONFIG_TRACE_SIMPLE
|
2010-06-24 19:34:53 +08:00
|
|
|
STEXI
|
|
|
|
@item info trace
|
|
|
|
show contents of trace buffer
|
2011-09-01 02:31:24 +08:00
|
|
|
ETEXI
|
|
|
|
#endif
|
|
|
|
|
|
|
|
STEXI
|
2010-06-24 19:34:53 +08:00
|
|
|
@item info trace-events
|
|
|
|
show available trace events and their state
|
|
|
|
ETEXI
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
STEXI
|
|
|
|
@end table
|
|
|
|
ETEXI
|