External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-23 14:15:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

virsh: man: Document quirks of device-detach and friends

Browse Source 
Mention that successful return does not equal to device being detached
similarly as we do at the API level.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Peter Krempa 2019-03-18 08:08:04 +01:00
parent bb1f41c075
commit e95a66349a
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
tools/virsh.pod
View File

@ -3264,6 +3264,16 @@ or attempting to detach a device that is not present in the domain XML,
but shares some specific attributes with one that is present, but shares some specific attributes with one that is present,
may lead to unexpected results. may lead to unexpected results.
B<Quirk>: Device unplug is asynchronous in most cases and requires guest
cooperation. This means that it's up to the discretion of the guest to disallow
or delay the unplug arbitrarily. As the libvirt API used in this command was
designed as synchronous it returns success after some timeout even if the device
was not unplugged yet to allow further interactions with the domain e.g. if the
guest is unresponsive. Callers which need to make sure that the
device was unplugged can use libvirt events (see virsh event) to be notified
when the device is removed. Note that the event may arrive before the command
returns.
If I<--live> is specified, affect a running domain. If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain. If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state. If I<--current> is specified, affect the current domain state.
@ -3311,6 +3321,8 @@ I<--persistent>.
If B<--print-xml> is specified, then the XML which would be used to detach the If B<--print-xml> is specified, then the XML which would be used to detach the
disk is printed instead. disk is printed instead.
Please see documentation for B<detach-device> for known quirks.
=item B<detach-interface> I<domain> I<type> [I<--mac mac>] =item B<detach-interface> I<domain> I<type> [I<--mac mac>]
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]] [[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
@ -3333,6 +3345,8 @@ an offline domain, and like I<--live> I<--config> for a running domain.
Note that older versions of virsh used I<--config> as an alias for Note that older versions of virsh used I<--config> as an alias for
I<--persistent>. I<--persistent>.
Please see documentation for B<detach-device> for known quirks.
=item B<update-device> I<domain> I<file> [I<--force>] =item B<update-device> I<domain> I<file> [I<--force>]
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]] [[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]