.args_type = "name:S?",
.params = "[cmd]",
.help = "show the help",
- .mhandler.cmd = do_help_cmd,
+ .cmd = do_help_cmd,
},
STEXI
.args_type = "device:B",
.params = "device|all",
.help = "commit changes to the disk images (if -snapshot is used) or backing files",
- .mhandler.cmd = hmp_commit,
+ .cmd = hmp_commit,
},
STEXI
.args_type = "",
.params = "",
.help = "quit the emulator",
- .user_print = monitor_user_noop,
- .mhandler.cmd = hmp_quit,
+ .cmd = hmp_quit,
},
STEXI
.args_type = "device:B,size:o",
.params = "device size",
.help = "resize a block image",
- .mhandler.cmd = hmp_block_resize,
+ .cmd = hmp_block_resize,
},
STEXI
.args_type = "device:B,speed:o?,base:s?",
.params = "device [speed [base]]",
.help = "copy data from a backing file into a block device",
- .mhandler.cmd = hmp_block_stream,
+ .cmd = hmp_block_stream,
},
STEXI
.args_type = "device:B,speed:o",
.params = "device speed",
.help = "set maximum speed for a background block operation",
- .mhandler.cmd = hmp_block_job_set_speed,
+ .cmd = hmp_block_job_set_speed,
},
STEXI
.params = "[-f] device",
.help = "stop an active background block operation (use -f"
"\n\t\t\t if the operation is currently paused)",
- .mhandler.cmd = hmp_block_job_cancel,
+ .cmd = hmp_block_job_cancel,
},
STEXI
.args_type = "device:B",
.params = "device",
.help = "stop an active background block operation",
- .mhandler.cmd = hmp_block_job_complete,
+ .cmd = hmp_block_job_complete,
},
STEXI
.args_type = "device:B",
.params = "device",
.help = "pause an active background block operation",
- .mhandler.cmd = hmp_block_job_pause,
+ .cmd = hmp_block_job_pause,
},
STEXI
.args_type = "device:B",
.params = "device",
.help = "resume a paused background block operation",
- .mhandler.cmd = hmp_block_job_resume,
+ .cmd = hmp_block_job_resume,
},
STEXI
.args_type = "force:-f,device:B",
.params = "[-f] device",
.help = "eject a removable medium (use -f to force it)",
- .mhandler.cmd = hmp_eject,
+ .cmd = hmp_eject,
},
STEXI
.args_type = "id:B",
.params = "device",
.help = "remove host block device",
- .user_print = monitor_user_noop,
- .mhandler.cmd_new = hmp_drive_del,
+ .cmd = hmp_drive_del,
},
STEXI
{
.name = "change",
- .args_type = "device:B,target:F,arg:s?",
- .params = "device filename [format]",
+ .args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
+ .params = "device filename [format [read-only-mode]]",
.help = "change a removable medium, optional format",
- .mhandler.cmd = hmp_change,
+ .cmd = hmp_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}]
+@item change @var{diskdevice} @var{filename} [@var{format} [@var{read-only-mode}]]
Change the medium for a removable disk device to point to @var{filename}. eg
@example
@var{format} is optional.
+@var{read-only-mode} may be used to change the read-only status of the device.
+It accepts the following values:
+
+@table @var
+@item retain
+Retains the current status; this is the default.
+
+@item read-only
+Makes the device read-only.
+
+@item read-write
+Makes the device writable.
+@end table
+
@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
.args_type = "filename:F",
.params = "filename",
.help = "save screen into PPM image 'filename'",
- .mhandler.cmd = hmp_screendump,
+ .cmd = hmp_screendump,
},
STEXI
.args_type = "filename:F",
.params = "filename",
.help = "output logs to 'filename'",
- .mhandler.cmd = hmp_logfile,
+ .cmd = hmp_logfile,
},
STEXI
{
.name = "trace-event",
- .args_type = "name:s,option:b",
- .params = "name on|off",
- .help = "changes status of a specific trace event",
- .mhandler.cmd = hmp_trace_event,
+ .args_type = "name:s,option:b,vcpu:i?",
+ .params = "name on|off [vcpu]",
+ .help = "changes status of a specific trace event "
+ "(vcpu: vCPU to set, default is all)",
+ .cmd = hmp_trace_event,
+ .command_completion = trace_event_completion,
},
STEXI
.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 = hmp_trace_file,
+ .cmd = hmp_trace_file,
},
STEXI
.args_type = "items:s",
.params = "item1[,...]",
.help = "activate logging of the specified items",
- .mhandler.cmd = hmp_log,
+ .cmd = hmp_log,
},
STEXI
.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 = hmp_savevm,
+ .cmd = hmp_savevm,
},
STEXI
.args_type = "name:s",
.params = "tag|id",
.help = "restore a VM snapshot from its tag or id",
- .mhandler.cmd = hmp_loadvm,
+ .cmd = hmp_loadvm,
.command_completion = loadvm_completion,
},
.args_type = "name:s",
.params = "tag|id",
.help = "delete a VM snapshot from its tag or id",
- .mhandler.cmd = hmp_delvm,
+ .cmd = hmp_delvm,
.command_completion = delvm_completion,
},
.args_type = "option:s?",
.params = "[on|off]",
.help = "run emulation in singlestep mode or switch to normal mode",
- .mhandler.cmd = hmp_singlestep,
+ .cmd = hmp_singlestep,
},
STEXI
.args_type = "",
.params = "",
.help = "stop emulation",
- .mhandler.cmd = hmp_stop,
+ .cmd = hmp_stop,
},
STEXI
.args_type = "",
.params = "",
.help = "resume emulation",
- .mhandler.cmd = hmp_cont,
+ .cmd = hmp_cont,
},
STEXI
.args_type = "",
.params = "",
.help = "wakeup guest from suspend",
- .mhandler.cmd = hmp_system_wakeup,
+ .cmd = hmp_system_wakeup,
},
STEXI
.args_type = "device:s?",
.params = "[device]",
.help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
- .mhandler.cmd = hmp_gdbserver,
+ .cmd = hmp_gdbserver,
},
STEXI
.args_type = "fmt:/,addr:l",
.params = "/fmt addr",
.help = "virtual memory dump starting at 'addr'",
- .mhandler.cmd = hmp_memory_dump,
+ .cmd = hmp_memory_dump,
},
STEXI
.args_type = "fmt:/,addr:l",
.params = "/fmt addr",
.help = "physical memory dump starting at 'addr'",
- .mhandler.cmd = hmp_physical_memory_dump,
+ .cmd = hmp_physical_memory_dump,
},
STEXI
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
@end smallexample
@end itemize
+ETEXI
+
+ {
+ .name = "gpa2hva",
+ .args_type = "addr:l",
+ .params = "addr",
+ .help = "print the host virtual address corresponding to a guest physical address",
+ .cmd = hmp_gpa2hva,
+ },
+
+STEXI
+@item gpa2hva @var{addr}
+@findex gpa2hva
+Print the host virtual address at which the guest's physical address @var{addr}
+is mapped.
+ETEXI
+
+#ifdef CONFIG_LINUX
+ {
+ .name = "gpa2hpa",
+ .args_type = "addr:l",
+ .params = "addr",
+ .help = "print the host physical address corresponding to a guest physical address",
+ .cmd = hmp_gpa2hpa,
+ },
+#endif
+
+STEXI
+@item gpa2hpa @var{addr}
+@findex gpa2hpa
+Print the host physical address at which the guest's physical address @var{addr}
+is mapped.
ETEXI
{
.args_type = "fmt:/,val:l",
.params = "/fmt expr",
.help = "print expression value (use $reg for CPU register access)",
- .mhandler.cmd = do_print,
+ .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
.args_type = "fmt:/,addr:i,index:i.",
.params = "/fmt addr",
.help = "I/O port read",
- .mhandler.cmd = hmp_ioport_read,
+ .cmd = hmp_ioport_read,
},
STEXI
+@item i/@var{fmt} @var{addr} [.@var{index}]
+@findex i
Read I/O port.
ETEXI
.args_type = "fmt:/,addr:i,val:i",
.params = "/fmt addr value",
.help = "I/O port write",
- .mhandler.cmd = hmp_ioport_write,
+ .cmd = hmp_ioport_write,
},
STEXI
+@item o/@var{fmt} @var{addr} @var{val}
+@findex o
Write to I/O port.
ETEXI
.args_type = "keys: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 = hmp_sendkey,
+ .cmd = hmp_sendkey,
.command_completion = sendkey_completion,
},
STEXI
@item sendkey @var{keys}
@findex sendkey
-
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:
.args_type = "",
.params = "",
.help = "reset the system",
- .mhandler.cmd = hmp_system_reset,
+ .cmd = hmp_system_reset,
},
STEXI
@item system_reset
@findex system_reset
-
Reset the system.
ETEXI
.args_type = "",
.params = "",
.help = "send system power down event",
- .mhandler.cmd = hmp_system_powerdown,
+ .cmd = hmp_system_powerdown,
},
STEXI
@item system_powerdown
@findex system_powerdown
-
Power down the system (if supported).
ETEXI
.args_type = "start:i,size:i",
.params = "addr size",
.help = "compute the checksum of a memory region",
- .mhandler.cmd = hmp_sum,
+ .cmd = hmp_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 = hmp_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 = hmp_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
{
.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,
+ .cmd = hmp_device_add,
.command_completion = device_add_completion,
},
STEXI
@item device_add @var{config}
@findex device_add
-
Add device.
ETEXI
.args_type = "id:s",
.params = "device",
.help = "remove device",
- .mhandler.cmd = hmp_device_del,
+ .cmd = hmp_device_del,
.command_completion = device_del_completion,
},
STEXI
@item device_del @var{id}
@findex device_del
-
-Remove device @var{id}.
+Remove device @var{id}. @var{id} may be a short ID
+or a QOM object path.
ETEXI
{
.args_type = "index:i",
.params = "index",
.help = "set the default CPU",
- .mhandler.cmd = hmp_cpu,
+ .cmd = hmp_cpu,
},
STEXI
.args_type = "dx_str:s,dy_str:s,dz_str:s?",
.params = "dx dy [dz]",
.help = "send mouse move events",
- .mhandler.cmd = hmp_mouse_move,
+ .cmd = hmp_mouse_move,
},
STEXI
.args_type = "button_state:i",
.params = "state",
.help = "change mouse button state (1=L, 2=M, 4=R)",
- .mhandler.cmd = hmp_mouse_button,
+ .cmd = hmp_mouse_button,
},
STEXI
.args_type = "index:i",
.params = "index",
.help = "set which mouse device receives events",
- .mhandler.cmd = hmp_mouse_set,
+ .cmd = hmp_mouse_set,
},
STEXI
.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 = hmp_wavcapture,
+ .cmd = hmp_wavcapture,
},
STEXI
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
.args_type = "n:i",
.params = "capture index",
.help = "stop capture",
- .mhandler.cmd = hmp_stopcapture,
+ .cmd = hmp_stopcapture,
},
STEXI
@item stopcapture @var{index}
.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'",
- .mhandler.cmd = hmp_memsave,
+ .cmd = hmp_memsave,
},
STEXI
.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'",
- .mhandler.cmd = hmp_pmemsave,
+ .cmd = hmp_pmemsave,
},
STEXI
.args_type = "bootdevice:s",
.params = "bootdevice",
.help = "define new values for the boot device list",
- .mhandler.cmd = hmp_boot_set,
+ .cmd = hmp_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.
.args_type = "",
.params = "",
.help = "inject an NMI",
- .mhandler.cmd = hmp_nmi,
+ .cmd = hmp_nmi,
},
STEXI
@item nmi @var{cpu}
.args_type = "device:s,data:s",
.params = "device data",
.help = "Write to a ring buffer character device",
- .mhandler.cmd = hmp_ringbuf_write,
+ .cmd = hmp_ringbuf_write,
.command_completion = ringbuf_write_completion,
},
.args_type = "device:s,size:i",
.params = "device size",
.help = "Read from a ring buffer character device",
- .mhandler.cmd = hmp_ringbuf_read,
+ .cmd = hmp_ringbuf_read,
.command_completion = ringbuf_write_completion,
},
" 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)",
- .mhandler.cmd = hmp_migrate,
+ .cmd = hmp_migrate,
},
.args_type = "",
.params = "",
.help = "cancel the current VM migration",
- .mhandler.cmd = hmp_migrate_cancel,
+ .cmd = hmp_migrate_cancel,
},
STEXI
@item migrate_cancel
@findex migrate_cancel
Cancel the current VM migration.
+ETEXI
+ {
+ .name = "migrate_continue",
+ .args_type = "state:s",
+ .params = "state",
+ .help = "Continue migration from the given paused state",
+ .cmd = hmp_migrate_continue,
+ },
+STEXI
+@item migrate_continue @var{state}
+@findex migrate_continue
+Continue migration from the paused state @var{state}
ETEXI
{
.args_type = "uri:s",
.params = "uri",
.help = "Continue an incoming migration from an -incoming defer",
- .mhandler.cmd = hmp_migrate_incoming,
+ .cmd = hmp_migrate_incoming,
},
STEXI
"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,
+ .cmd = hmp_migrate_set_cache_size,
},
STEXI
.params = "value",
.help = "set maximum speed (in bytes) for migrations. "
"Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
- .mhandler.cmd = hmp_migrate_set_speed,
+ .cmd = hmp_migrate_set_speed,
},
STEXI
.args_type = "value:T",
.params = "value",
.help = "set maximum tolerated downtime (in seconds) for migrations",
- .mhandler.cmd = hmp_migrate_set_downtime,
+ .cmd = hmp_migrate_set_downtime,
},
STEXI
.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,
+ .cmd = hmp_migrate_set_capability,
.command_completion = migrate_set_capability_completion,
},
@item migrate_set_capability @var{capability} @var{state}
@findex migrate_set_capability
Enable/Disable the usage of a capability @var{capability} for migration.
+ETEXI
+
+ {
+ .name = "migrate_set_parameter",
+ .args_type = "parameter:s,value:s",
+ .params = "parameter value",
+ .help = "Set the parameter for migration",
+ .cmd = hmp_migrate_set_parameter,
+ .command_completion = migrate_set_parameter_completion,
+ },
+
+STEXI
+@item migrate_set_parameter @var{parameter} @var{value}
+@findex migrate_set_parameter
+Set the parameter @var{parameter} for migration.
+ETEXI
+
+ {
+ .name = "migrate_start_postcopy",
+ .args_type = "",
+ .params = "",
+ .help = "Followup to a migration command to switch the migration"
+ " to postcopy mode. The postcopy-ram capability must "
+ "be set before the original migration command.",
+ .cmd = hmp_migrate_start_postcopy,
+ },
+
+STEXI
+@item migrate_start_postcopy
+@findex migrate_start_postcopy
+Switch in-progress migration to postcopy mode. Ignored after the end of
+migration (or once already in postcopy).
+ETEXI
+
+ {
+ .name = "x_colo_lost_heartbeat",
+ .args_type = "",
+ .params = "",
+ .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
+ "a failover or takeover is needed.",
+ .cmd = hmp_x_colo_lost_heartbeat,
+ },
+
+STEXI
+@item x_colo_lost_heartbeat
+@findex x_colo_lost_heartbeat
+Tell COLO that heartbeat is lost, a failover or takeover is needed.
ETEXI
{
.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,
- .mhandler.cmd_async = client_migrate_info,
- .flags = MONITOR_CMD_ASYNC,
+ .help = "set migration information for remote display",
+ .cmd = hmp_client_migrate_info,
},
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.
+Set migration information for remote display. This makes the server
+ask the client to automatically reconnect using the new parameters
+once migration finished successfully. Only implemented for SPICE.
ETEXI
{
.name = "dump-guest-memory",
- .args_type = "paging:-p,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
- .params = "[-p] [-z|-l|-s] filename [begin length]",
+ .args_type = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:i?,length:i?",
+ .params = "[-p] [-d] [-z|-l|-s] filename [begin length]",
.help = "dump guest memory into file 'filename'.\n\t\t\t"
"-p: do paging to get guest's memory mapping.\n\t\t\t"
+ "-d: return immediately (do not wait for completion).\n\t\t\t"
"-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
"-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
"-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
"begin: the starting physical address.\n\t\t\t"
"length: the memory size, in bytes.",
- .mhandler.cmd = hmp_dump_guest_memory,
+ .cmd = hmp_dump_guest_memory,
},
together with begin.
ETEXI
+#if defined(TARGET_S390X)
+ {
+ .name = "dump-skeys",
+ .args_type = "filename:F",
+ .params = "",
+ .help = "Save guest storage keys into file 'filename'.\n",
+ .cmd = hmp_dump_skeys,
+ },
+#endif
+
+STEXI
+@item dump-skeys @var{filename}
+@findex dump-skeys
+Save guest storage keys to a file.
+ETEXI
+
+#if defined(TARGET_S390X)
+ {
+ .name = "migration_mode",
+ .args_type = "mode:i",
+ .params = "mode",
+ .help = "Enables or disables migration mode\n",
+ .cmd = hmp_migrationmode,
+ },
+#endif
+
+STEXI
+@item migration_mode @var{mode}
+@findex migration_mode
+Enables or disables migration mode.
+ETEXI
+
{
.name = "snapshot_blkdev",
.args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
"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.",
- .mhandler.cmd = hmp_snapshot_blkdev,
+ .cmd = hmp_snapshot_blkdev,
},
STEXI
.help = "take an internal snapshot of device.\n\t\t\t"
"The format of the image used by device must\n\t\t\t"
"support it, such as qcow2.\n\t\t\t",
- .mhandler.cmd = hmp_snapshot_blkdev_internal,
+ .cmd = hmp_snapshot_blkdev_internal,
},
STEXI
"the snapshot matching both id and name.\n\t\t\t"
"The format of the image used by device must\n\t\t\t"
"support it, such as qcow2.\n\t\t\t",
- .mhandler.cmd = hmp_snapshot_delete_blkdev_internal,
+ .cmd = hmp_snapshot_delete_blkdev_internal,
},
STEXI
"in new-image-file, instead of recreating it from scratch.\n\t\t\t"
"The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
"so that the result does not need a backing file.\n\t\t\t",
- .mhandler.cmd = hmp_drive_mirror,
+ .cmd = hmp_drive_mirror,
},
STEXI
@item drive_mirror
{
.name = "drive_backup",
- .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
- .params = "[-n] [-f] device target [format]",
+ .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
+ .params = "[-n] [-f] [-c] device target [format]",
.help = "initiates a point-in-time\n\t\t\t"
"copy for a device. The device's contents are\n\t\t\t"
"copied to the new image file, excluding data that\n\t\t\t"
"The -n flag requests QEMU to reuse the image found\n\t\t\t"
"in new-image-file, instead of recreating it from scratch.\n\t\t\t"
"The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
- "so that the result does not need a backing file.\n\t\t\t",
- .mhandler.cmd = hmp_drive_backup,
+ "so that the result does not need a backing file.\n\t\t\t"
+ "The -c flag requests QEMU to compress backup data\n\t\t\t"
+ "(if the target format supports it).\n\t\t\t",
+ .cmd = hmp_drive_backup,
},
STEXI
@item drive_backup
{
.name = "drive_add",
- .args_type = "pci_addr:s,opts:s",
- .params = "[[<domain>:]<bus>:]<slot>\n"
+ .args_type = "node:-n,pci_addr:s,opts:s",
+ .params = "[-n] [[<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]\n"
"[,readonly=on|off][,copy-on-read=on|off]",
.help = "add drive to PCI storage controller",
- .mhandler.cmd = hmp_drive_add,
+ .cmd = hmp_drive_add,
},
STEXI
"<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,
- .mhandler.cmd_new = hmp_pcie_aer_inject_error,
+ .cmd = hmp_pcie_aer_inject_error,
},
STEXI
.name = "host_net_add",
.args_type = "device:s,opts:s?",
.params = "tap|user|socket|vde|netmap|bridge|vhost-user|dump [options]",
- .help = "add host VLAN client",
- .mhandler.cmd = hmp_host_net_add,
+ .help = "add host VLAN client (deprecated, use netdev_add instead)",
+ .cmd = hmp_host_net_add,
.command_completion = host_net_add_completion,
},
STEXI
@item host_net_add
@findex host_net_add
-Add host VLAN client.
+Add host VLAN client. Deprecated, please use @code{netdev_add} instead.
ETEXI
{
.name = "host_net_remove",
.args_type = "vlan_id:i,device:s",
.params = "vlan_id name",
- .help = "remove host VLAN client",
- .mhandler.cmd = hmp_host_net_remove,
+ .help = "remove host VLAN client (deprecated, use netdev_del instead)",
+ .cmd = hmp_host_net_remove,
.command_completion = host_net_remove_completion,
},
STEXI
@item host_net_remove
@findex host_net_remove
-Remove host VLAN client.
+Remove host VLAN client. Deprecated, please use @code{netdev_del} instead.
ETEXI
{
.args_type = "netdev:O",
.params = "[user|tap|socket|vde|bridge|hubport|netmap|vhost-user],id=str[,prop=value][,...]",
.help = "add host network device",
- .mhandler.cmd = hmp_netdev_add,
+ .cmd = hmp_netdev_add,
.command_completion = netdev_add_completion,
},
.args_type = "id:s",
.params = "id",
.help = "remove host network device",
- .mhandler.cmd = hmp_netdev_del,
+ .cmd = hmp_netdev_del,
.command_completion = netdev_del_completion,
},
.args_type = "object:O",
.params = "[qom-type=]type,id=str[,prop=value][,...]",
.help = "create QOM object",
- .mhandler.cmd = hmp_object_add,
+ .cmd = hmp_object_add,
.command_completion = object_add_completion,
},
.args_type = "id:s",
.params = "id",
.help = "destroy QOM object",
- .mhandler.cmd = hmp_object_del,
+ .cmd = hmp_object_del,
.command_completion = object_del_completion,
},
{
.name = "hostfwd_add",
.args_type = "arg1:s,arg2:s?,arg3:s?",
- .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
+ .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
.help = "redirect TCP or UDP connections from host to guest (requires -net user)",
- .mhandler.cmd = hmp_hostfwd_add,
+ .cmd = hmp_hostfwd_add,
},
#endif
STEXI
{
.name = "hostfwd_remove",
.args_type = "arg1:s,arg2:s?,arg3:s?",
- .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
+ .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
.help = "remove host-to-guest TCP or UDP redirection",
- .mhandler.cmd = hmp_hostfwd_remove,
+ .cmd = hmp_hostfwd_remove,
},
#endif
.args_type = "value:M",
.params = "target",
.help = "request VM to change its memory allocation (in MB)",
- .mhandler.cmd = hmp_balloon,
+ .cmd = hmp_balloon,
},
STEXI
.args_type = "name:s,up:b",
.params = "name on|off",
.help = "change the link status of a network adapter",
- .mhandler.cmd = hmp_set_link,
+ .cmd = hmp_set_link,
.command_completion = set_link_completion,
},
.args_type = "action:s",
.params = "[reset|shutdown|poweroff|pause|debug|none]",
.help = "change watchdog action",
- .mhandler.cmd = hmp_watchdog_action,
+ .cmd = hmp_watchdog_action,
.command_completion = watchdog_action_completion,
},
.args_type = "aclname:s",
.params = "aclname",
.help = "list rules in the access control list",
- .mhandler.cmd = hmp_acl_show,
+ .cmd = hmp_acl_show,
},
STEXI
.args_type = "aclname:s,policy:s",
.params = "aclname allow|deny",
.help = "set default access control list policy",
- .mhandler.cmd = hmp_acl_policy,
+ .cmd = hmp_acl_policy,
},
STEXI
.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 = hmp_acl_add,
+ .cmd = hmp_acl_add,
},
STEXI
.args_type = "aclname:s,match:s",
.params = "aclname match",
.help = "remove a match rule from the access control list",
- .mhandler.cmd = hmp_acl_remove,
+ .cmd = hmp_acl_remove,
},
STEXI
.args_type = "aclname:s",
.params = "aclname",
.help = "reset the access control list",
- .mhandler.cmd = hmp_acl_reset,
+ .cmd = hmp_acl_reset,
},
STEXI
.args_type = "all:-a,writable:-w,uri:s",
.params = "nbd_server_start [-a] [-w] host:port",
.help = "serve block devices on the given host and port",
- .mhandler.cmd = hmp_nbd_server_start,
+ .cmd = hmp_nbd_server_start,
},
STEXI
@item nbd_server_start @var{host}:@var{port}
{
.name = "nbd_server_add",
- .args_type = "writable:-w,device:B",
- .params = "nbd_server_add [-w] device",
+ .args_type = "writable:-w,device:B,name:s?",
+ .params = "nbd_server_add [-w] device [name]",
.help = "export a block device via NBD",
- .mhandler.cmd = hmp_nbd_server_add,
+ .cmd = hmp_nbd_server_add,
},
STEXI
-@item nbd_server_add @var{device}
+@item nbd_server_add @var{device} [ @var{name} ]
@findex nbd_server_add
Export a block device through QEMU's NBD server, which must be started
beforehand with @command{nbd_server_start}. The @option{-w} option makes the
-exported device writable too.
+exported device writable too. The export name is controlled by @var{name},
+defaulting to @var{device}.
+ETEXI
+
+ {
+ .name = "nbd_server_remove",
+ .args_type = "force:-f,name:s",
+ .params = "nbd_server_remove [-f] name",
+ .help = "remove an export previously exposed via NBD",
+ .cmd = hmp_nbd_server_remove,
+ },
+STEXI
+@item nbd_server_remove [-f] @var{name}
+@findex nbd_server_remove
+Stop exporting a block device through QEMU's NBD server, which was
+previously started with @command{nbd_server_add}. The @option{-f}
+option forces the server to drop the export immediately even if
+clients are connected; otherwise the command fails unless there are no
+clients.
ETEXI
{
.args_type = "",
.params = "nbd_server_stop",
.help = "stop serving block devices using the NBD protocol",
- .mhandler.cmd = hmp_nbd_server_stop,
+ .cmd = hmp_nbd_server_stop,
},
STEXI
@item nbd_server_stop
.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]",
- .mhandler.cmd = hmp_mce,
+ .cmd = hmp_mce,
},
#endif
.args_type = "fdname:s",
.params = "getfd name",
.help = "receive a file descriptor via SCM rights and assign it a name",
- .mhandler.cmd = hmp_getfd,
+ .cmd = hmp_getfd,
},
STEXI
.args_type = "fdname:s",
.params = "closefd name",
.help = "close a file descriptor previously passed via SCM rights",
- .mhandler.cmd = hmp_closefd,
+ .cmd = hmp_closefd,
},
STEXI
.args_type = "device:B,password:s",
.params = "block_passwd device password",
.help = "set the password of encrypted block devices",
- .mhandler.cmd = hmp_block_passwd,
+ .cmd = hmp_block_passwd,
},
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}
+@item block_passwd @var{device} @var{password}
+@findex block_passwd
+Set the encrypted device @var{device} password to @var{password}
+
+This command is now obsolete and will always return an error since 2.10
ETEXI
{
.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",
- .mhandler.cmd = hmp_block_set_io_throttle,
+ .cmd = hmp_block_set_io_throttle,
},
STEXI
-@item block_passwd @var{device} @var{password}
-@findex block_passwd
-Set the encrypted device @var{device} password to @var{password}
+@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
{
.args_type = "protocol:s,password:s,connected:s?",
.params = "protocol password action-if-connected",
.help = "set spice/vnc password",
- .mhandler.cmd = hmp_set_password,
+ .cmd = hmp_set_password,
},
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
.args_type = "protocol:s,time:s",
.params = "protocol time",
.help = "set spice/vnc password expire-time",
- .mhandler.cmd = hmp_expire_password,
+ .cmd = hmp_expire_password,
},
STEXI
@item expire_password [ vnc | spice ] expire-time
@findex expire_password
-
Specify when a password for spice/vnc becomes
invalid. @var{expire-time} accepts:
.args_type = "args:s",
.params = "args",
.help = "add chardev",
- .mhandler.cmd = hmp_chardev_add,
+ .cmd = hmp_chardev_add,
.command_completion = chardev_add_completion,
},
STEXI
-@item chardev_add args
-@findex chardev_add
+@item chardev-add args
+@findex chardev-add
+chardev-add accepts the same parameters as the -chardev command line switch.
-chardev_add accepts the same parameters as the -chardev command line switch.
+ETEXI
+
+ {
+ .name = "chardev-change",
+ .args_type = "id:s,args:s",
+ .params = "id args",
+ .help = "change chardev",
+ .cmd = hmp_chardev_change,
+ },
+
+STEXI
+@item chardev-change args
+@findex chardev-change
+chardev-change accepts existing chardev @var{id} and then the same arguments
+as the -chardev command line switch (except for "id").
ETEXI
.args_type = "id:s",
.params = "id",
.help = "remove chardev",
- .mhandler.cmd = hmp_chardev_remove,
+ .cmd = hmp_chardev_remove,
.command_completion = chardev_remove_completion,
},
STEXI
-@item chardev_remove id
-@findex chardev_remove
-
+@item chardev-remove id
+@findex chardev-remove
Removes the chardev @var{id}.
+ETEXI
+
+ {
+ .name = "chardev-send-break",
+ .args_type = "id:s",
+ .params = "id",
+ .help = "send a break on chardev",
+ .cmd = hmp_chardev_send_break,
+ .command_completion = chardev_remove_completion,
+ },
+
+STEXI
+@item chardev-send-break id
+@findex chardev-send-break
+Send a break on the chardev @var{id}.
+
ETEXI
{
.args_type = "device:B,command:s",
.params = "[device] \"[command]\"",
.help = "run a qemu-io command on a block device",
- .mhandler.cmd = hmp_qemu_io,
+ .cmd = hmp_qemu_io,
},
STEXI
@item qemu-io @var{device} @var{command}
@findex qemu-io
-
Executes a qemu-io command on the given block device.
ETEXI
.args_type = "id:i",
.params = "id",
.help = "add cpu",
- .mhandler.cmd = hmp_cpu_add,
+ .cmd = hmp_cpu_add,
},
STEXI
@item cpu-add @var{id}
+@findex cpu-add
Add CPU with id @var{id}
ETEXI
.args_type = "path:s?",
.params = "path",
.help = "list QOM properties",
- .mhandler.cmd = hmp_qom_list,
+ .cmd = hmp_qom_list,
},
STEXI
.args_type = "path:s,property:s,value:s",
.params = "path property value",
.help = "set QOM property",
- .mhandler.cmd = hmp_qom_set,
+ .cmd = hmp_qom_set,
},
STEXI
.args_type = "item:s?",
.params = "[subcommand]",
.help = "show various information about the system state",
- .mhandler.cmd = hmp_info_help,
- .sub_table = info_cmds,
+ .cmd = hmp_info_help,
+ .sub_table = info_cmds,
},
-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
-show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
-@item info mem
-show the active virtual memory mappings (i386 only)
-@item info jit
-show dynamic compiler info
-@item info numa
-show NUMA information
-@item info kvm
-show KVM information
-@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 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
-@item info migrate_capabilities
-show current migration capabilities
-@item info migrate_cache_size
-show current migration XBZRLE cache size
-@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
-@item info tpm
-show the TPM device
-@item info memory-devices
-show the memory devices
-@end table
-ETEXI
-
-STEXI
-@item info trace-events
-show available trace events and their state
-ETEXI
-
STEXI
@end table
ETEXI
projects / qemu.git / blobdiff