[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

[libvirt] [PATCH 2/2] doc: Update docs for the changed commands



Mainly documents the new options (--live, --current, --config).
Affected commands are:
    attach-device
    attach-disk
    attach-interface
    detach-device
    detach-disk
    detach-interface
    update-device
---
 tools/virsh.pod |   60 +++++++++++++++++++++++++++++++++++++++++-------------
 1 files changed, 45 insertions(+), 15 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index e7dcd41..1fbc27c 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -873,7 +873,8 @@ the single existing device; consider using B<update-device> for this usage.
 
 =item B<attach-disk> I<domain-id> I<source> I<target> optional
 I<--driver driver> I<--subdriver subdriver> I<--type type>
-I<--mode mode> I<--persistent> I<--sourcetype soucetype>
+I<--mode mode> I<--sourcetype soucetype> I<--live> I<--config>
+I<--current>
 
 Attach a new disk device to the domain.
 I<source> and I<target> are paths for the files and devices.
@@ -882,12 +883,16 @@ I<type> can indicate I<cdrom> or I<floppy> as alternative to the disk default,
 although this use only replaces the media within the existing virtual cdrom or
 floppy device; consider using B<update-device> for this usage instead.
 I<mode> can specify the two specific mode I<readonly> or I<shareable>.
-I<persistent> indicates the changes will affect the next boot of the domain.
 I<sourcetype> can indicate the type of source (block|file)
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
 =item B<attach-interface> I<domain-id> I<type> I<source> optional
 I<--target target> I<--mac mac> I<--script script> I<--model model>
-I<--persistent>
+I<--live> I<--config> I<--current>
 
 Attach a new network interface to the domain.
 I<type> can be either I<network> to indicate a physical network device or I<bridge> to indicate a bridge to a device.
@@ -897,33 +902,58 @@ I<mac> allows to specify the MAC address of the network interface.
 I<script> allows to specify a path to a script handling a bridge instead of
 the default one.
 I<model> allows to specify the model type.
-I<persistent> indicates the changes will affect the next boot of the domain.
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
-=item B<detach-device> I<domain-id> I<FILE>
+=item B<detach-device> I<domain-id> I<FILE> I<--live> I<--config> I<--current>
 
 Detach a device from the domain, takes the same kind of XML descriptions
 as command B<attach-device>.
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
-=item B<detach-disk> I<domain-id> I<target>
+=item B<detach-disk> I<domain-id> I<target> I<--live> I<--config> I<--current>
 
 Detach a disk device from a domain. The I<target> is the device as seen
 from the domain.
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
 =item B<detach-interface> I<domain-id> I<type> optional I<--mac mac>
+I<--live> I<--config> I<--current>
 
 Detach a network interface from a domain.
-I<type> can be either I<network> to indicate a physical network device or I<bridge> to indicate a bridge to a device.
-It is recommended to use the I<mac> option to distinguish between the interfaces
-if more than one are present on the domain.
+I<type> can be either I<network> to indicate a physical network device or
+I<bridge> to indicate a bridge to a device. It is recommended to use the
+I<mac> option to distinguish between the interfaces if more than one are
+present on the domain.
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
-=item B<update-device> I<domain-id> I<file> optional I<--persistent> I<--force>
+=item B<update-device> I<domain-id> I<file> optional I<--force> I<--live>
+I<--config> I<--current>
 
 Update the characteristics of a device associated with I<domain-id>, based on
-the device definition in an XML I<file>.  If the I<--persistent> option is
-used, the changes will affect the next boot of the domain. The I<--force>
-option can be used to force device update, e.g., to eject a CD-ROM even if it
-is locked/mounted in the domain. See the documentation to learn about libvirt
-XML format for a device.
+the device definition in an XML I<file>. The I<--force> option can be used to
+force device update, e.g., to eject a CD-ROM even if it is locked/mounted in
+the domain. See the documentation to learn about libvirt XML format for a device.
+If I<--live> is specified, affect a running guest.
+If I<--config> is specified, affect the next boot of a persistent guest.
+If I<--current> is specified, affect the current guest state.
+Both I<--live> and I<--config> flags may be given, but I<--current> is exclusive.
+If no flag is specified, behavior is different depending on hypervisor.
 
 =back
 
-- 
1.7.4


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]