]> xenbits.xensource.com Git - libvirt.git/commitdiff
doc: Add doc for blockpull and blockjob commands
authorOsier Yang <jyang@redhat.com>
Wed, 27 Jul 2011 02:48:28 +0000 (10:48 +0800)
committerOsier Yang <jyang@redhat.com>
Wed, 27 Jul 2011 02:48:28 +0000 (10:48 +0800)
Commit b31abc6f0 introduce commands blockpull and blockjob, but
forgot to add the docs meanwhile.

tools/virsh.pod

index 05ce3e216bb80e0b82db15c1a9a9b68c7115d091..e9aaa800ceaf6df0a57ab42fbea23e6a239df5ed 100644 (file)
@@ -430,6 +430,27 @@ Get memory stats for a running domain.
 
 Get block device size info for a domain.
 
+=item B<blockpull> I<domain> I<path> [I<bandwidth>]
+
+Populate a disk from its backing image. Once all data from its backing
+image has been pulled, the disk no longer depends on the backing image.
+It pulls data for the entire disk in the background, the process of the
+operation can be checked with B<blockjob>.
+
+I<path> specifies fully-qualified path of the disk.
+I<bandwidth> specifies copying bandwidth limit in Mbps.
+
+=item B<blockjob> I<domain> I<path> [I<--abort>] [I<--info>] [I<bandwidth>]
+
+Manage active block operations.
+
+I<path> specifies fully-qualified path of the disk.
+If I<--live> is specified, the active job on the specified disk will
+be aborted.
+If I<--info> is specified, the active job information on the specified
+disk will be printed.
+I<bandwidth> can be used to set bandwidth limit for the active job.
+
 =item B<dominfo> I<domain-id>
 
 Returns basic information about the domain.