Archipelago » qemu

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 Text between SQMP and EQMP is copied to the QMP documention file and

HXCOMM does not show up in the other formats.

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

SQMP

                        QMP Supported Commands

                        ----------------------

This document describes all commands currently supported by QMP.

Most of the time their usage is exactly the same as in the user Monitor, this

means that any other document which also describe commands (the manpage,

QEMU's manual, etc) can and should be consulted.

QMP has two types of commands: regular and query commands. Regular commands

usually change the Virtual Machine's state someway, while query commands just

return information. The sections below are divided accordingly.

It's important to observe that all communication examples are formatted in

a reader-friendly way, so that they're easier to understand. However, in real

protocol usage, they're emitted as a single line.

Also, the following notation is used to denote data flow:

-> data issued by the Client

<- Server data response

Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed

information on the Server command and response formats.

NOTE: This document is temporary and will be replaced soon.

1. Stability Considerations

===========================

The current QMP command set (described in this file) may be useful for a

number of use cases, however it's limited and several commands have bad

defined semantics, specially with regard to command completion.

These problems are going to be solved incrementally in the next QEMU releases

and we're going to establish a deprecation policy for badly defined commands.

If you're planning to adopt QMP, please observe the following:

    1. The deprecation policy will take efect and be documented soon, please

       check the documentation of each used command as soon as a new release of

       QEMU is available

    2. DO NOT rely on anything which is not explicit documented

    3. Errors, in special, are not documented. Applications should NOT check

       for specific errors classes or data (it's strongly recommended to only

       check for the "error" key)

2. Regular Commands

===================

Server's responses in the examples below are always a success response, please

refer to the QMP specification for more details on error responses.

EQMP

STEXI

@table @option

ETEXI

    {

        .name       = "help|?",

        .args_type  = "name:s?",

        .params     = "[cmd]",

        .help       = "show the help",

        .mhandler.cmd = do_help_cmd,

    },

STEXI

@item help or ? [@var{cmd}]

@findex help

Show the help for all commands or just for command @var{cmd}.

ETEXI

    {

        .name       = "commit",

        .args_type  = "device:B",

        .params     = "device|all",

        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",

        .mhandler.cmd = do_commit,

    },

STEXI

@item commit

@findex commit

Commit changes to the disk images (if -snapshot is used) or backing files.

ETEXI

    {

        .name       = "q|quit",

        .args_type  = "",

        .params     = "",

        .help       = "quit the emulator",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_quit,

    },

STEXI

@item q or quit

@findex quit

Quit the emulator.

ETEXI

SQMP

quit

----

Quit the emulator.

Arguments: None.

Example:

-> { "execute": "quit" }

<- { "return": {} }

EQMP

    {

        .name       = "eject",

        .args_type  = "force:-f,device:B",

        .params     = "[-f] device",

        .help       = "eject a removable medium (use -f to force it)",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_eject,

    },

STEXI

@item eject [-f] @var{device}

@findex eject

Eject a removable medium (use -f to force it).

ETEXI

SQMP

eject

-----

Eject a removable medium.

Arguments: 

- force: force ejection (json-bool, optional)

- device: device name (json-string)

Example:

-> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }

<- { "return": {} }

Note: The "force" argument defaults to false.

EQMP

    {

        .name       = "change",

        .args_type  = "device:B,target:F,arg:s?",

        .params     = "device filename [format]",

        .help       = "change a removable medium, optional format",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_change,

    },

STEXI

@item change @var{device} @var{setting}

@findex change

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

SQMP

change

------

Change a removable medium or VNC configuration.

Arguments:

- "device": device name (json-string)

- "target": filename or item (json-string)

- "arg": additional argument (json-string, optional)

Examples:

1. Change a removable medium

-> { "execute": "change",

             "arguments": { "device": "ide1-cd0",

                            "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }

<- { "return": {} }

2. Change VNC password

-> { "execute": "change",

             "arguments": { "device": "vnc", "target": "password",

                            "arg": "foobar1" } }

<- { "return": {} }

EQMP

    {

        .name       = "screendump",

        .args_type  = "filename:F",

        .params     = "filename",

        .help       = "save screen into PPM image 'filename'",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_screen_dump,

    },

STEXI

@item screendump @var{filename}

@findex screendump

Save screen into PPM image @var{filename}.

ETEXI

SQMP

screendump

----------

Save screen into PPM image.

Arguments:

- "filename": file path (json-string)

Example:

-> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }

<- { "return": {} }

EQMP

    {

        .name       = "logfile",

        .args_type  = "filename:F",

        .params     = "filename",

        .help       = "output logs to 'filename'",

        .mhandler.cmd = do_logfile,

    },

STEXI

@item logfile @var{filename}

@findex logfile

Output logs to @var{filename}.

ETEXI

#ifdef CONFIG_SIMPLE_TRACE

    {

        .name       = "trace-event",

        .args_type  = "name:s,option:b",

        .params     = "name on|off",

        .help       = "changes status of a specific trace event",

        .mhandler.cmd = do_change_trace_event_state,

    },

STEXI

@item trace-event

@findex trace-event

changes status of a trace event

ETEXI

    {

        .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.

ETEXI

#endif

    {

        .name       = "log",

        .args_type  = "items:s",

        .params     = "item1[,...]",

        .help       = "activate logging of the specified items to '/tmp/qemu.log'",

        .mhandler.cmd = do_log,

    },

STEXI

@item log @var{item1}[,...]

@findex log

Activate logging of the specified items to @file{/tmp/qemu.log}.

ETEXI

    {

        .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",

        .mhandler.cmd = do_savevm,

    },

STEXI

@item savevm [@var{tag}|@var{id}]

@findex savevm

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

    {

        .name       = "loadvm",

        .args_type  = "name:s",

        .params     = "tag|id",

        .help       = "restore a VM snapshot from its tag or id",

        .mhandler.cmd = do_loadvm,

    },

STEXI

@item loadvm @var{tag}|@var{id}

@findex loadvm

Set the whole virtual machine to the snapshot identified by the tag

@var{tag} or the unique snapshot ID @var{id}.

ETEXI

    {

        .name       = "delvm",

        .args_type  = "name:s",

        .params     = "tag|id",

        .help       = "delete a VM snapshot from its tag or id",

        .mhandler.cmd = do_delvm,

    },

STEXI

@item delvm @var{tag}|@var{id}

@findex delvm

Delete the snapshot identified by @var{tag} or @var{id}.

ETEXI

    {

        .name       = "singlestep",

        .args_type  = "option:s?",

        .params     = "[on|off]",

        .help       = "run emulation in singlestep mode or switch to normal mode",

        .mhandler.cmd = do_singlestep,

    },

STEXI

@item singlestep [off]

@findex singlestep

Run the emulation in single step mode.

If called with option off, the emulation returns to normal mode.

ETEXI

    {

        .name       = "stop",

        .args_type  = "",

        .params     = "",

        .help       = "stop emulation",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_stop,

    },

STEXI

@item stop

@findex stop

Stop emulation.

ETEXI

SQMP

stop

----

Stop the emulator.

Arguments: None.

Example:

-> { "execute": "stop" }

<- { "return": {} }

EQMP

    {

        .name       = "c|cont",

        .args_type  = "",

        .params     = "",

        .help       = "resume emulation",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_cont,

    },

STEXI

@item c or cont

@findex cont

Resume emulation.

ETEXI

SQMP

cont

----

Resume emulation.

Arguments: None.

Example:

-> { "execute": "cont" }

<- { "return": {} }

EQMP

    {

        .name       = "gdbserver",

        .args_type  = "device:s?",

        .params     = "[device]",

        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",

        .mhandler.cmd = do_gdbserver,

    },

STEXI

@item gdbserver [@var{port}]

@findex gdbserver

Start gdbserver session (default @var{port}=1234)

ETEXI

    {

        .name       = "x",

        .args_type  = "fmt:/,addr:l",

        .params     = "/fmt addr",

        .help       = "virtual memory dump starting at 'addr'",

        .mhandler.cmd = do_memory_dump,

    },

STEXI

@item x/fmt @var{addr}

@findex x

Virtual memory dump starting at @var{addr}.

ETEXI

    {

        .name       = "xp",

        .args_type  = "fmt:/,addr:l",

        .params     = "/fmt addr",

        .help       = "physical memory dump starting at 'addr'",

        .mhandler.cmd = do_physical_memory_dump,

    },

STEXI

@item xp /@var{fmt} @var{addr}

@findex xp

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

    {

        .name       = "p|print",

        .args_type  = "fmt:/,val:l",

        .params     = "/fmt expr",

        .help       = "print expression value (use $reg for CPU register access)",

        .mhandler.cmd = do_print,

    },

STEXI

@item p or print/@var{fmt} @var{expr}

@findex print

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

used.

ETEXI

    {

        .name       = "i",

        .args_type  = "fmt:/,addr:i,index:i.",

        .params     = "/fmt addr",

        .help       = "I/O port read",

        .mhandler.cmd = do_ioport_read,

    },

STEXI

Read I/O port.

ETEXI

    {

        .name       = "o",

        .args_type  = "fmt:/,addr:i,val:i",

        .params     = "/fmt addr value",

        .help       = "I/O port write",

        .mhandler.cmd = do_ioport_write,

    },

STEXI

Write to I/O port.

ETEXI

    {

        .name       = "sendkey",

        .args_type  = "string:s,hold_time:i?",

        .params     = "keys [hold_ms]",

        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",

        .mhandler.cmd = do_sendkey,

    },

STEXI

@item sendkey @var{keys}

@findex sendkey

Send @var{keys} to the emulator. @var{keys} could be the name of the

key or @code{#} followed by the raw value in either decimal or hexadecimal

format. Use @code{-} to press several keys simultaneously. Example:

@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

    {

        .name       = "system_reset",

        .args_type  = "",

        .params     = "",

        .help       = "reset the system",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_system_reset,

    },

STEXI

@item system_reset

@findex system_reset

Reset the system.

ETEXI

SQMP

system_reset

------------

Reset the system.

Arguments: None.

Example:

-> { "execute": "system_reset" }

<- { "return": {} }

EQMP

    {

        .name       = "system_powerdown",

        .args_type  = "",

        .params     = "",

        .help       = "send system power down event",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_system_powerdown,

    },

STEXI

@item system_powerdown

@findex system_powerdown

Power down the system (if supported).

ETEXI

SQMP

system_powerdown

----------------

Send system power down event.

Arguments: None.

Example:

-> { "execute": "system_powerdown" }

<- { "return": {} }

EQMP

    {

        .name       = "sum",

        .args_type  = "start:i,size:i",

        .params     = "addr size",

        .help       = "compute the checksum of a memory region",

        .mhandler.cmd = do_sum,

    },

STEXI

@item sum @var{addr} @var{size}

@findex sum

Compute the checksum of a memory region.

ETEXI

    {

        .name       = "usb_add",

        .args_type  = "devname:s",

        .params     = "device",

        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",

        .mhandler.cmd = do_usb_add,

    },

STEXI

@item usb_add @var{devname}

@findex usb_add

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

@ref{usb_devices}

ETEXI

    {

        .name       = "usb_del",

        .args_type  = "devname:s",

        .params     = "device",

        .help       = "remove USB device 'bus.addr'",

        .mhandler.cmd = do_usb_del,

    },

STEXI

@item usb_del @var{devname}

@findex usb_del

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

    {

        .name       = "device_add",

        .args_type  = "device:O",

        .params     = "driver[,prop=value][,...]",

        .help       = "add device, like -device on the command line",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_device_add,

    },

STEXI

@item device_add @var{config}

@findex device_add

Add device.

ETEXI

SQMP

device_add

----------

Add a device.

Arguments:

- "driver": the name of the new device's driver (json-string)

- "bus": the device's parent bus (device tree path, json-string, optional)

- "id": the device's ID, must be unique (json-string)

- device properties

Example:

-> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }

<- { "return": {} }

Notes:

(1) For detailed information about this command, please refer to the

    'docs/qdev-device-use.txt' file.

(2) It's possible to list device properties by running QEMU with the

    "-device DEVICE,\?" command-line argument, where DEVICE is the device's name

EQMP

    {

        .name       = "device_del",

        .args_type  = "id:s",

        .params     = "device",

        .help       = "remove device",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_device_del,

    },

STEXI

@item device_del @var{id}

@findex device_del

Remove device @var{id}.

ETEXI

SQMP

device_del

----------

Remove a device.

Arguments:

- "id": the device's ID (json-string)

Example:

-> { "execute": "device_del", "arguments": { "id": "net1" } }

<- { "return": {} }

EQMP

    {

        .name       = "cpu",

        .args_type  = "index:i",

        .params     = "index",

        .help       = "set the default CPU",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_cpu_set,

    },

STEXI

@item cpu @var{index}

@findex cpu

Set the default CPU.

ETEXI

SQMP

cpu

---

Set the default CPU.

Arguments:

- "index": the CPU's index (json-int)

Example:

-> { "execute": "cpu", "arguments": { "index": 0 } }

<- { "return": {} }

Note: CPUs' indexes are obtained with the 'query-cpus' command.

EQMP

    {

        .name       = "mouse_move",

        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",

        .params     = "dx dy [dz]",

        .help       = "send mouse move events",

        .mhandler.cmd = do_mouse_move,

    },

STEXI

@item mouse_move @var{dx} @var{dy} [@var{dz}]

@findex mouse_move

Move the active mouse to the specified coordinates @var{dx} @var{dy}

with optional scroll axis @var{dz}.

ETEXI

    {

        .name       = "mouse_button",

        .args_type  = "button_state:i",

        .params     = "state",

        .help       = "change mouse button state (1=L, 2=M, 4=R)",

        .mhandler.cmd = do_mouse_button,

    },

STEXI

@item mouse_button @var{val}

@findex mouse_button

Change the active mouse button state @var{val} (1=L, 2=M, 4=R).

ETEXI

    {

        .name       = "mouse_set",

        .args_type  = "index:i",

        .params     = "index",

        .help       = "set which mouse device receives events",

        .mhandler.cmd = do_mouse_set,

    },

STEXI

@item mouse_set @var{index}

@findex mouse_set

Set which mouse device receives events at given @var{index}, index

can be obtained with

@example

info mice

@end example

ETEXI

#ifdef HAS_AUDIO

    {

        .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)",

        .mhandler.cmd = do_wav_capture,

    },

#endif

STEXI

@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]

@findex wavcapture

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

    {

        .name       = "stopcapture",

        .args_type  = "n:i",

        .params     = "capture index",

        .help       = "stop capture",

        .mhandler.cmd = do_stop_capture,

    },

#endif

STEXI

@item stopcapture @var{index}

@findex stopcapture

Stop capture with a given @var{index}, index can be obtained with

@example

info capture

@end example

ETEXI

    {

        .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'",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_memory_save,

    },

STEXI

@item memsave @var{addr} @var{size} @var{file}

@findex memsave

save to disk virtual memory dump starting at @var{addr} of size @var{size}.

ETEXI

SQMP

memsave

-------

Save to disk virtual memory dump starting at 'val' of size 'size'.

Arguments:

- "val": the starting address (json-int)

- "size": the memory size, in bytes (json-int)

- "filename": file path (json-string)

Example:

-> { "execute": "memsave",

             "arguments": { "val": 10,

                            "size": 100,

                            "filename": "/tmp/virtual-mem-dump" } }

<- { "return": {} }

Note: Depends on the current CPU.

EQMP

    {

        .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'",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_physical_memory_save,

    },

STEXI

@item pmemsave @var{addr} @var{size} @var{file}

@findex pmemsave

save to disk physical memory dump starting at @var{addr} of size @var{size}.

ETEXI

SQMP

pmemsave

--------

Save to disk physical memory dump starting at 'val' of size 'size'.

Arguments:

- "val": the starting address (json-int)

- "size": the memory size, in bytes (json-int)

- "filename": file path (json-string)

Example:

-> { "execute": "pmemsave",

             "arguments": { "val": 10,

                            "size": 100,

                            "filename": "/tmp/physical-mem-dump" } }

<- { "return": {} }

EQMP

    {

        .name       = "boot_set",

        .args_type  = "bootdevice:s",

        .params     = "bootdevice",

        .help       = "define new values for the boot device list",

        .mhandler.cmd = do_boot_set,

    },

STEXI

@item boot_set @var{bootdevicelist}

@findex boot_set

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)

    {

        .name       = "nmi",

        .args_type  = "cpu_index:i",

        .params     = "cpu",

        .help       = "inject an NMI on the given CPU",

        .mhandler.cmd = do_inject_nmi,

    },

#endif

STEXI

@item nmi @var{cpu}

@findex nmi

Inject an NMI on the given CPU (x86 only).

ETEXI

    {

        .name       = "migrate",

        .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)",

        .user_print = monitor_user_noop,	

	.mhandler.cmd_new = do_migrate,

    },

STEXI

@item migrate [-d] [-b] [-i] @var{uri}

@findex migrate

Migrate to @var{uri} (using -d to not wait for completion).

	-b for migration with full copy of disk

	-i for migration with incremental copy of disk (base image is shared)

ETEXI

SQMP

migrate

-------

Migrate to URI.

Arguments:

- "blk": block migration, full disk copy (json-bool, optional)

- "inc": incremental disk copy (json-bool, optional)

- "uri": Destination URI (json-string)

Example:

-> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }

<- { "return": {} }

Notes:

(1) The 'query-migrate' command should be used to check migration's progress

    and final result (this information is provided by the 'status' member)

(2) All boolean arguments default to false

(3) The user Monitor's "detach" argument is invalid in QMP and should not

    be used

EQMP

    {

        .name       = "migrate_cancel",

        .args_type  = "",

        .params     = "",

        .help       = "cancel the current VM migration",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_migrate_cancel,

    },

STEXI

@item migrate_cancel

@findex migrate_cancel

Cancel the current VM migration.

ETEXI

SQMP

migrate_cancel

--------------

Cancel the current migration.

Arguments: None.

Example:

-> { "execute": "migrate_cancel" }

<- { "return": {} }

EQMP

    {

        .name       = "migrate_set_speed",

        .args_type  = "value:f",

        .params     = "value",

        .help       = "set maximum speed (in bytes) for migrations",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_migrate_set_speed,

    },

STEXI

@item migrate_set_speed @var{value}

@findex migrate_set_speed

Set maximum speed to @var{value} (in bytes) for migrations.

ETEXI

SQMP

migrate_set_speed

-----------------

Set maximum speed for migrations.

Arguments:

- "value": maximum speed, in bytes per second (json-number)

Example:

-> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }

<- { "return": {} }

EQMP

    {

        .name       = "migrate_set_downtime",

        .args_type  = "value:T",

        .params     = "value",

        .help       = "set maximum tolerated downtime (in seconds) for migrations",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_migrate_set_downtime,

    },

STEXI

@item migrate_set_downtime @var{second}

@findex migrate_set_downtime

Set maximum tolerated downtime (in seconds) for migration.

ETEXI

SQMP

migrate_set_downtime

--------------------

Set maximum tolerated downtime (in seconds) for migrations.

Arguments:

- "value": maximum downtime (json-number)

Example:

-> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }

<- { "return": {} }

EQMP

#if defined(TARGET_I386)

    {

        .name       = "drive_add",

        .args_type  = "pci_addr:s,opts:s",

        .params     = "[[<domain>:]<bus>:]<slot>\n"

                      "[file=file][,if=type][,bus=n]\n"

                      "[,unit=m][,media=d][index=i]\n"

                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"

                      "[snapshot=on|off][,cache=on|off]",

        .help       = "add drive to PCI storage controller",

        .mhandler.cmd = drive_hot_add,

    },

#endif

STEXI

@item drive_add

@findex drive_add

Add drive to PCI storage controller.

ETEXI

#if defined(TARGET_I386)

    {

        .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",

        .mhandler.cmd = pci_device_hot_add,

    },

#endif

STEXI

@item pci_add

@findex pci_add

Hot-add PCI device.

ETEXI

#if defined(TARGET_I386)

    {

        .name       = "pci_del",

        .args_type  = "pci_addr:s",

        .params     = "[[<domain>:]<bus>:]<slot>",

        .help       = "hot remove PCI device",

        .mhandler.cmd = do_pci_device_hot_remove,

    },

#endif

STEXI

@item pci_del

@findex pci_del

Hot remove PCI device.

ETEXI

    {

        .name       = "host_net_add",

        .args_type  = "device:s,opts:s?",

        .params     = "tap|user|socket|vde|dump [options]",

        .help       = "add host VLAN client",

        .mhandler.cmd = net_host_device_add,

    },

STEXI

@item host_net_add

@findex host_net_add

Add host VLAN client.

ETEXI

    {

        .name       = "host_net_remove",

        .args_type  = "vlan_id:i,device:s",

        .params     = "vlan_id name",

        .help       = "remove host VLAN client",

        .mhandler.cmd = net_host_device_remove,

    },

STEXI

@item host_net_remove

@findex host_net_remove

Remove host VLAN client.

ETEXI

    {

        .name       = "netdev_add",

        .args_type  = "netdev:O",

        .params     = "[user|tap|socket],id=str[,prop=value][,...]",

        .help       = "add host network device",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_netdev_add,

    },

STEXI

@item netdev_add

@findex netdev_add

Add host network device.

ETEXI

SQMP

netdev_add

----------

Add host network device.

Arguments:

- "type": the device type, "tap", "user", ... (json-string)

- "id": the device's ID, must be unique (json-string)

- device options

Example:

-> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }

<- { "return": {} }

Note: The supported device options are the same ones supported by the '-net'

      command-line argument, which are listed in the '-help' output or QEMU's

      manual

EQMP

    {

        .name       = "netdev_del",

        .args_type  = "id:s",

        .params     = "id",

        .help       = "remove host network device",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_netdev_del,

    },

STEXI

@item netdev_del

@findex netdev_del

Remove host network device.

ETEXI

SQMP

netdev_del

----------

Remove host network device.

Arguments:

- "id": the device's ID, must be unique (json-string)

Example:

-> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }

<- { "return": {} }

EQMP

#ifdef CONFIG_SLIRP

    {

        .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)",

        .mhandler.cmd = net_slirp_hostfwd_add,

    },

#endif

STEXI

@item hostfwd_add

@findex hostfwd_add

Redirect TCP or UDP connections from host to guest (requires -net user).

ETEXI

#ifdef CONFIG_SLIRP

    {

        .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",

        .mhandler.cmd = net_slirp_hostfwd_remove,

    },

#endif

STEXI

@item hostfwd_remove

@findex hostfwd_remove

Remove host-to-guest TCP or UDP redirection.

ETEXI

    {

        .name       = "balloon",

        .args_type  = "value:M",

        .params     = "target",

        .help       = "request VM to change its memory allocation (in MB)",

        .user_print = monitor_user_noop,

        .mhandler.cmd_async = do_balloon,

        .flags      = MONITOR_CMD_ASYNC,

    },

STEXI

@item balloon @var{value}

@findex balloon

Request VM to change its memory allocation to @var{value} (in MB).

ETEXI

SQMP

balloon

-------

Request VM to change its memory allocation (in bytes).

Arguments:

- "value": New memory allocation (json-int)

Example:

-> { "execute": "balloon", "arguments": { "value": 536870912 } }

<- { "return": {} }

EQMP

    {

        .name       = "set_link",

        .args_type  = "name:s,up:b",

        .params     = "name on|off",

        .help       = "change the link status of a network adapter",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_set_link,

    },

STEXI

@item set_link @var{name} [on|off]

@findex set_link

Switch link @var{name} on (i.e. up) or off (i.e. down).

ETEXI

SQMP

set_link

--------

Change the link status of a network adapter.

Arguments:

- "name": network device name (json-string)

- "up": status is up (json-bool)

Example:

-> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }

<- { "return": {} }

EQMP

    {

        .name       = "watchdog_action",

        .args_type  = "action:s",

        .params     = "[reset|shutdown|poweroff|pause|debug|none]",

        .help       = "change watchdog action",

        .mhandler.cmd = do_watchdog_action,

    },

STEXI

@item watchdog_action

@findex watchdog_action

Change watchdog action.

ETEXI

    {

        .name       = "acl_show",

        .args_type  = "aclname:s",

        .params     = "aclname",

        .help       = "list rules in the access control list",

        .mhandler.cmd = do_acl_show,

    },

STEXI

@item acl_show @var{aclname}

@findex acl_show

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

    {

        .name       = "acl_policy",

        .args_type  = "aclname:s,policy:s",

        .params     = "aclname allow|deny",

        .help       = "set default access control list policy",

        .mhandler.cmd = do_acl_policy,

    },

STEXI

@item acl_policy @var{aclname} @code{allow|deny}

@findex acl_policy

Set the default access control list policy, used in the event that

none of the explicit rules match. The default policy at startup is

always @code{deny}.

ETEXI

    {

        .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",

        .mhandler.cmd = do_acl_add,

    },

STEXI

@item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]

@findex acl_add

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

normally be appended to the end of the ACL, but can be inserted

earlier in the list if the optional @var{index} parameter is supplied.

ETEXI

    {

        .name       = "acl_remove",

        .args_type  = "aclname:s,match:s",

        .params     = "aclname match",

        .help       = "remove a match rule from the access control list",

        .mhandler.cmd = do_acl_remove,

    },

STEXI

@item acl_remove @var{aclname} @var{match}

@findex acl_remove

Remove the specified match rule from the access control list.

ETEXI

    {

        .name       = "acl_reset",

        .args_type  = "aclname:s",

        .params     = "aclname",

        .help       = "reset the access control list",

        .mhandler.cmd = do_acl_reset,

    },

STEXI

@item acl_reset @var{aclname}

@findex acl_reset

Remove all matches from the access control list, and set the default

policy back to @code{deny}.

ETEXI

#if defined(TARGET_I386)

    {

        .name       = "mce",

        .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",

        .params     = "cpu bank status mcgstatus addr misc",

        .help       = "inject a MCE on the given CPU",

        .mhandler.cmd = do_inject_mce,

    },

#endif

STEXI

@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}

@findex mce (x86)

Inject an MCE on the given CPU (x86 only).

ETEXI

    {

        .name       = "getfd",

        .args_type  = "fdname:s",

        .params     = "getfd name",

        .help       = "receive a file descriptor via SCM rights and assign it a name",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_getfd,

    },

STEXI

@item getfd @var{fdname}

@findex getfd

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

SQMP

getfd

-----

Receive a file descriptor via SCM rights and assign it a name.

Arguments:

- "fdname": file descriptor name (json-string)

Example:

-> { "execute": "getfd", "arguments": { "fdname": "fd1" } }

<- { "return": {} }

EQMP

    {

        .name       = "closefd",

        .args_type  = "fdname:s",

        .params     = "closefd name",

        .help       = "close a file descriptor previously passed via SCM rights",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_closefd,

    },

STEXI

@item closefd @var{fdname}

@findex closefd

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.

ETEXI

SQMP

closefd

-------

Close a file descriptor previously passed via SCM rights.

Arguments:

- "fdname": file descriptor name (json-string)

Example:

-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }

<- { "return": {} }

EQMP

    {

        .name       = "block_passwd",

        .args_type  = "device:B,password:s",

        .params     = "block_passwd device password",

        .help       = "set the password of encrypted block devices",

        .user_print = monitor_user_noop,

        .mhandler.cmd_new = do_block_set_passwd,

    },

STEXI