NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-20 11:48:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

virsh: Enhance documentation of commands starting jobs

Browse Source 
Some virsh commands start a (long-running) job that can be monitored
using domjobinfo and aborted with domjobabort. Let's be explicit about
this in virsh man page.
This commit is contained in:
Jiri Denemark 2011-09-26 14:55:22 +02:00
parent 62cb8ad7ff
commit d82ce38415
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tools/virsh.pod
View File

@ -639,6 +639,11 @@ rather than merely left in a paused state.
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
The progress may be monitored using B<domjobinfo> virsh command and canceled
with B<domjobabort> command (sent by another virsh instance). Interrupting
(usually with C<Ctrl-C>) the virsh process which runs B<dump> command is not
enough to actually cancel the operation.
NOTE: Some hypervisors may require the user to manually ensure proper
permissions on file and path specified by argument I<corefilepath>.
@ -684,6 +689,11 @@ the domain, it will automatically be started from this saved state.
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
The progress may be monitored using B<domjobinfo> virsh command and canceled
with B<domjobabort> command (sent by another virsh instance). Interrupting
(usually with C<Ctrl-C>) the virsh process which runs B<managedsave> command
is not enough to actually cancel the operation.
Normally, starting a managed save will decide between running or paused
based on the state the domain was in when the save was done; passing
either the I<--running> or I<--paused> flag will allow overriding which
@ -736,6 +746,9 @@ I<--timeout> B<seconds> forces guest to suspend when live migration exceeds
that many seconds, and
then the migration will complete offline. It can only be used with I<--live>.
Running migration can be canceled by interrupting virsh (usually using
C<Ctrl-C>) or by B<domjobabort> command sent from another virsh instance.
B<Note>: The I<desturi> parameter for normal migration and peer2peer migration
has different semantics:
@ -809,6 +822,11 @@ other domains to use. B<virsh restore> restores from this state file.
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
The progress may be monitored using B<domjobinfo> virsh command and canceled
with B<domjobabort> command (sent by another virsh instance). Interrupting
(usually with C<Ctrl-C>) the virsh process which runs B<save> command is not
enough to actually cancel the operation.
This is roughly equivalent to doing a hibernate on a running computer,
with all the same limitations. Open network connections may be
severed upon restore, as TCP timeouts may have expired.