]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
virsh: Enhance documentation of commands starting jobs
authorJiri Denemark <jdenemar@redhat.com>
Mon, 26 Sep 2011 12:55:22 +0000 (14:55 +0200)
committerJiri Denemark <jdenemar@redhat.com>
Tue, 27 Sep 2011 13:41:55 +0000 (15:41 +0200)
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.

tools/virsh.pod

index 43ed1eae0d9826ffbde505e7841ff8987264a869..fbde57f530ffdaaf62aea0516d7792d306eb47e5 100644 (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.