External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-22 04:25:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

virsh: document attach-disk better

Browse Source 
http://bugzilla.redhat.com/601143, part 1 - document existing
behavior.  Ever since Mar 2010 (commit ced154cb), the use of
'attach-disk' or 'attach-device' to change cdrom/floppy media has been
documented but deprecated, but the replacement to use 'update-device'
was not documented.

* tools/virsh.c (cmdAttachInterface, cmdAttachDisk): Fix bad error
message.
* tools/virsh.pod (attach-device, attach-disk): Refer to
update-device for cdrom and floppy behavior.
(update-device): Add documentation.
This commit is contained in:
Eric Blake 2010-06-09 09:12:56 -06:00
parent 4efaf77b19
commit 4cc2b6d676
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tools/virsh.c
View File

@ -7364,7 +7364,8 @@ cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
} else if (STREQ(type, "bridge")) { } else if (STREQ(type, "bridge")) {
typ = 2; typ = 2;
} else { } else {
vshError(ctl, _("No support %s in command 'attach-interface'"), type); vshError(ctl, _("No support for %s in command 'attach-interface'"),
type);
goto cleanup; goto cleanup;
} }
@ -7626,14 +7627,16 @@ cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
if (STREQ(driver, "file") || STREQ(driver, "tap")) { if (STREQ(driver, "file") || STREQ(driver, "tap")) {
isFile = 1; isFile = 1;
} else if (STRNEQ(driver, "phy")) { } else if (STRNEQ(driver, "phy")) {
vshError(ctl, _("No support %s in command 'attach-disk'"), driver); vshError(ctl, _("No support for %s in command 'attach-disk'"),
driver);
goto cleanup; goto cleanup;
} }
} }
if (mode) { if (mode) {
if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) { if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
vshError(ctl, _("No support %s in command 'attach-disk'"), mode); vshError(ctl, _("No support for %s in command 'attach-disk'"),
mode);
goto cleanup; goto cleanup;
} }
} }

13
tools/virsh.pod
View File

@ -528,13 +528,17 @@ format of the device sections to get the most accurate set of accepted values.
Attach a device to the domain, using a device definition in an XML file. Attach a device to the domain, using a device definition in an XML file.
See the documentation to learn about libvirt XML format for a device. See the documentation to learn about libvirt XML format for a device.
For cdrom and floppy devices, this command only replaces the media within
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> =item B<attach-disk> I<domain-id> I<source> I<target> optional I<--driver driver> I<--subdriver subdriver> I<--type type> I<--mode mode>
Attach a new disk device to the domain. Attach a new disk device to the domain.
I<source> and I<target> are paths for the files and devices. I<source> and I<target> are paths for the files and devices.
I<driver> can be I<file>, I<tap> or I<phy> depending on the kind of access. I<driver> can be I<file>, I<tap> or I<phy> depending on the kind of access.
I<type> can indicate I<cdrom> or I<floppy> as alternative to the disk default. 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<mode> can specify the two specific mode I<readonly> or I<shareable>.
=item B<attach-interface> I<domain-id> I<type> I<source> optional I<--target target> I<--mac mac> I<--script script> =item B<attach-interface> I<domain-id> I<type> I<source> optional I<--target target> I<--mac mac> I<--script script>
@ -564,6 +568,13 @@ I<type> can be either I<network> to indicate a physical network device or I<brid
It is recommended to use the I<mac> option to distinguish between the interfaces It is recommended to use the I<mac> option to distinguish between the interfaces
if more than one are present on the domain. if more than one are present on the domain.
=item B<update-device> I<domain-id> I<file> optional I<--persistent>
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.
See the documentation to learn about libvirt XML format for a device.
=back =back
=head1 VIRTUAL NETWORK COMMANDS =head1 VIRTUAL NETWORK COMMANDS