- Devel - libvirt List Archives

[libvirt] [PATCH v2] virsh man page - domain-id consistency
by Jan Tomko 25 Jul '12

25 Jul '12

Using 'domain' to represent domain name, domain id or uuid all over the man page, to be consistent with virsh help. --- diff to v1: I used domain-id instead of domain, per Eric's review comments. tools/virsh.pod | 145 +++++++++++++++++++++++++++---------------------------- 1 files changed, 72 insertions(+), 73 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 4bddf15..a5a2297 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -24,15 +24,14 @@ KVM, LXC, OpenVZ, VirtualBox and VMware ESX. The basic structure of most virsh usage is: - virsh [OPTION]... <command> <domain-id> [ARG]... + virsh [OPTION]... <command> <domain> [ARG]... -Where I<command> is one of the commands listed below, I<domain-id> -is the numeric domain id, or the domain name (which will be internally -translated to domain id), and I<ARGS> are command specific -options. There are a few exceptions to this rule in the cases where -the command in question acts on all domains, the entire machine, -or directly on the xen hypervisor. Those exceptions will be clear for -each of those commands. +Where I<command> is one of the commands listed below, I<domain> is the numeric +domain id, or the domain name, or the domain UUID and I<ARGS> are command +specific options. There are a few exceptions to this rule in the cases where +the command in question acts on all domains, the entire machine, or directly +on the xen hypervisor. Those exceptions will be clear for each of those +commands. The B<virsh> program can be used either to run one I<COMMAND> by giving the command and its arguments on the shell command line, or a I<COMMAND_STRING> @@ -302,7 +301,7 @@ description see: L<http://libvirt.org/formatcaps.html> The XML also show the NUMA topology information if available. -=item B<inject-nmi> I<domain-id> +=item B<inject-nmi> I<domain> Inject NMI to the guest. @@ -492,18 +491,18 @@ specified, then the output will be escaped for use in XML. =head1 DOMAIN COMMANDS The following commands manipulate domains directly, as stated -previously most commands take domain-id as the first parameter. The -I<domain-id> can be specified as a short integer, a name or a full UUID. +previously most commands take domain as the first parameter. The +I<domain> can be specified as a short integer, a name or a full UUID. =over 4 -=item B<autostart> [I<--disable>] I<domain-id> +=item B<autostart> [I<--disable>] I<domain> Configure a domain to be automatically started at boot. The option I<--disable> disables autostarting. -=item B<console> I<domain-id> [I<devname>] [I<--safe>] [I<--force>] +=item B<console> I<domain> [I<devname>] [I<--safe>] [I<--force>] Connect the virtual serial console for the guest. The optional I<devname> parameter refers to the device alias of an alternate @@ -529,7 +528,7 @@ exits. B<Example> - virsh dumpxml <domain-id> > domain.xml + virsh dumpxml <domain> > domain.xml vi domain.xml (or make changes with your other text editor) virsh create < domain.xml @@ -539,7 +538,7 @@ Define a domain from an XML <file>. The domain definition is registered but not started. If domain is already running, the changes will take effect on the next boot. -=item B<desc> I<domain-id> [[I<--live>] [I<--config>] | +=item B<desc> I<domain> [[I<--live>] [I<--config>] | [I<--current>]] [I<--title>] [I<--edit>] [I<--new-desc> New description or title message] @@ -562,16 +561,16 @@ Flag I<--title> selects operation on the title field instead of description. If neither of I<--edit> and I<--new-desc> are specified the note or description is displayed instead of being modified. -=item B<destroy> I<domain-id> [I<--graceful>] +=item B<destroy> I<domain> [I<--graceful>] -Immediately terminate the domain domain-id. This doesn't give the domain +Immediately terminate the domain I<domain>. This doesn't give the domain OS any chance to react, and it's the equivalent of ripping the power cord out on a physical machine. In most cases you will want to use the B<shutdown> command instead. However, this does not delete any storage volumes used by the guest, and if the domain is persistent, it can be restarted later. -If I<domain-id> is transient, then the metadata of any snapshots will +If I<domain> is transient, then the metadata of any snapshots will be lost once the guest stops running, but the snapshot contents still exist, and a new domain with the same name and UUID can restore the snapshot metadata with B<snapshot-create>. @@ -650,7 +649,7 @@ on hypervisor. Get memory stats for a running domain. -=item B<domblkerror> I<domain-id> +=item B<domblkerror> I<domain> Show errors on block devices. This command usually comes handy when B<domstate> command says that a domain was paused due to I/O error. @@ -820,13 +819,13 @@ I<size> is a scaled integer (see B<NOTES> above) which defaults to KiB "B" to get bytes (note that for historical reasons, this differs from B<vol-resize> which defaults to bytes without a suffix). -=item B<domdisplay> I<domain-id> [I<--include-password>] +=item B<domdisplay> I<domain> [I<--include-password>] Output a URI which can be used to connect to the graphical display of the domain via VNC, SPICE or RDP. If I<--include-password> is specified, the SPICE channel password will be included in the URI. -=item B<dominfo> I<domain-id> +=item B<dominfo> I<domain> Returns basic information about the domain. @@ -838,11 +837,11 @@ Convert a domain name or id to domain UUID Convert a domain name (or UUID) to a domain id -=item B<domjobabort> I<domain-id-or-uuid> +=item B<domjobabort> I<domain> Abort the currently running domain job. -=item B<domjobinfo> I<domain-id-or-uuid> +=item B<domjobinfo> I<domain> Returns information about jobs running on a domain. @@ -850,12 +849,12 @@ Returns information about jobs running on a domain. Convert a domain Id (or UUID) to domain name -=item B<domstate> I<domain-id> [I<--reason>] +=item B<domstate> I<domain> [I<--reason>] Returns state about a domain. I<--reason> tells virsh to also print reason for the state. -=item B<domcontrol> I<domain-id> +=item B<domcontrol> I<domain> Returns state of an interface to VMM used to control a domain. For states other than "ok" or "error" the command also prints number of @@ -875,7 +874,7 @@ configuration format named by I<format>. For QEMU/KVM hypervisor, the I<format> argument must be B<qemu-argv>. For Xen hypervisor, the I<format> argument may be B<xen-xm> or B<xen-sxpr>. -=item B<dump> I<domain-id> I<corefilepath> [I<--bypass-cache>] +=item B<dump> I<domain> I<corefilepath> [I<--bypass-cache>] { [I<--live>] | [I<--crash>] | [I<--reset>] } [I<--verbose>] [I<--memory-only>] Dumps the core of a domain to a file for analysis. @@ -899,7 +898,7 @@ B<dump> command. I<--verbose> displays the progress of dump. NOTE: Some hypervisors may require the user to manually ensure proper permissions on file and path specified by argument I<corefilepath>. -=item B<dumpxml> I<domain-id> [I<--inactive>] [I<--security-info>] +=item B<dumpxml> I<domain> [I<--inactive>] [I<--security-info>] [I<--update-cpu>] Output the domain information as an XML dump to stdout, this format can be used @@ -910,7 +909,7 @@ Using I<--security-info> will also include security sensitive information in the XML dump. I<--update-cpu> updates domain CPU requirements according to host CPU. -=item B<edit> I<domain-id> +=item B<edit> I<domain> Edit the XML configuration file for a domain, which will affect the next boot of the guest. @@ -926,7 +925,7 @@ except that it does some error checking. The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment variables, and defaults to C<vi>. -=item B<managedsave> I<domain-id> [I<--bypass-cache>] +=item B<managedsave> I<domain> [I<--bypass-cache>] [{I<--running> | I<--paused>}] [I<--verbose>] Save and destroy (stop) a running domain, so it can be restarted from the same @@ -948,7 +947,7 @@ state the B<start> should use. The B<dominfo> command can be used to query whether a domain currently has any managed save image. -=item B<managedsave-remove> I<domain-id> +=item B<managedsave-remove> I<domain> Remove the B<managedsave> state file for a domain, if it exists. This ensures the domain will do a full boot the next time it is started. @@ -970,7 +969,7 @@ stats. =item B<migrate> [I<--live>] [I<--direct>] [I<--p2p> [I<--tunnelled>]] [I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>] [I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>] -I<domain-id> I<desturi> [I<migrateuri>] [I<dname>] +I<domain> I<desturi> [I<migrateuri>] [I<dname>] [I<--timeout> B<seconds>] [I<--xml> B<file>] Migrate domain to another host. Add I<--live> for live migration; I<--p2p> @@ -1030,18 +1029,18 @@ seen from the source machine. =back -=item B<migrate-setmaxdowntime> I<domain-id> I<downtime> +=item B<migrate-setmaxdowntime> I<domain> I<downtime> Set maximum tolerable downtime for a domain which is being live-migrated to another host. The I<downtime> is a number of milliseconds the guest is allowed to be down at the end of live migration. -=item B<migrate-setspeed> I<domain-id> I<bandwidth> +=item B<migrate-setspeed> I<domain> I<bandwidth> Set the maximum migration bandwidth (in Mbps) for a domain which is being migrated to another host. -=item B<migrate-getspeed> I<domain-id> +=item B<migrate-getspeed> I<domain> Get the maximum migration bandwidth (in Mbps) for a domain. @@ -1064,7 +1063,7 @@ If I<--live> is specified, set scheduler information of 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. -=item B<reboot> I<domain-id> [I<--mode acpi|agent>] +=item B<reboot> I<domain> [I<--mode acpi|agent>] Reboot a domain. This acts just as if the domain had the B<reboot> command run from the console. The command returns as soon as it has @@ -1078,7 +1077,7 @@ By default the hypervisor will try to pick a suitable shutdown method. To specify an alternative method, the I<--mode> parameter can specify C<acpi> or C<agent>. -=item B<reset> I<domain-id> +=item B<reset> I<domain> Reset a domain immediately without any guest shutdown. B<reset> emulates the power reset button on a machine, where all guest @@ -1110,7 +1109,7 @@ should not reuse the saved state file for a second B<restore> unless you have also reverted all storage volumes back to the same contents as when the state file was created. -=item B<save> I<domain-id> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>] +=item B<save> I<domain> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>] [{I<--running> | I<--paused>}] [I<--verbose>] Saves a running domain (RAM, but not disk state) to a state file so that @@ -1187,11 +1186,11 @@ except that it does some error checking. The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment variables, and defaults to C<vi>. -=item B<schedinfo> [I<--set> B<parameter=value>] I<domain-id> [[I<--config>] +=item B<schedinfo> [I<--set> B<parameter=value>] I<domain> [[I<--config>] [I<--live>] | [I<--current>]] =item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>] -I<domain-id> +I<domain> Allows you to show (and set) the domain scheduler parameters. The parameters available for each hypervisor are: @@ -1221,7 +1220,7 @@ B<Note>: The vcpu_period parameter has a valid value range of 1000-1000000 or 1000-18446744073709551 or less than 0. The value 0 for either parameter is the same as not specifying that parameter. -=item B<screenshot> I<domain-id> [I<imagefilepath>] [I<--screen> B<screenID>] +=item B<screenshot> I<domain> [I<imagefilepath>] [I<--screen> B<screenID>] Takes a screenshot of a current domain console and stores it into a file. Optionally, if hypervisor supports more displays for a domain, I<screenID> @@ -1230,10 +1229,10 @@ of screen. In case of multiple graphics cards, heads are enumerated before devices, e.g. having two graphics cards, both with four heads, screen ID 5 addresses the second head on the second card. -=item B<send-key> I<domain-id> [I<--codeset> B<codeset>] +=item B<send-key> I<domain> [I<--codeset> B<codeset>] [I<--holdtime> B<holdtime>] I<keycode>... -Parse the I<keycode> sequence as keystrokes to send to I<domain-id>. +Parse the I<keycode> sequence as keystrokes to send to I<domain>. Each I<keycode> can either be a numeric value or a symbolic name from the corresponding codeset. If I<--holdtime> is given, each keystroke will be held for that many milliseconds. The default codeset is @@ -1311,7 +1310,7 @@ B<Examples> # send a tab, held for 1 second virsh send-key --holdtime 1000 0xf -=item B<setmem> I<domain-id> B<size> [[I<--config>] [I<--live>] | +=item B<setmem> I<domain> B<size> [[I<--config>] [I<--live>] | [I<--current>]] Change the memory allocation for a guest domain. @@ -1332,7 +1331,7 @@ For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes). For Xen, you can only adjust the memory of a running domain if the domain is paravirtualized or running the PV balloon driver. -=item B<setmaxmem> I<domain-id> B<size> [[I<--config>] [I<--live>] | +=item B<setmaxmem> I<domain> B<size> [[I<--config>] [I<--live>] | [I<--current>]] Change the maximum memory allocation limit for a guest domain. @@ -1352,7 +1351,7 @@ up to the nearest kibibyte. Some hypervisors require a larger granularity than KiB, and requests that are not an even multiple will be rounded up. For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes). -=item B<memtune> I<domain-id> [I<--hard-limit> B<size>] +=item B<memtune> I<domain> [I<--hard-limit> B<size>] [I<--soft-limit> B<size>] [I<--swap-hard-limit> B<size>] [I<--min-guarantee> B<size>] [[I<--config>] [I<--live>] | [I<--current>]] @@ -1399,7 +1398,7 @@ The guaranteed minimum memory allocation for the guest. Specifying -1 as a value for these limits is interpreted as unlimited. -=item B<blkiotune> I<domain-id> [I<--weight> B<weight>] +=item B<blkiotune> I<domain> [I<--weight> B<weight>] [I<--device-weights> B<device-weights>] [[I<--config>] [I<--live>] | [I<--current>]] @@ -1420,7 +1419,7 @@ 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<setvcpus> I<domain-id> I<count> [I<--maximum>] [[I<--config>] +=item B<setvcpus> I<domain> I<count> [I<--maximum>] [[I<--config>] [I<--live>] | [I<--current>]] Change the number of virtual CPUs active in a guest domain. By default, @@ -1451,7 +1450,7 @@ The I<--maximum> flag controls the maximum number of virtual cpus that can be hot-plugged the next time the domain is booted. As such, it must only be used with the I<--config> flag, and not with the I<--live> flag. -=item B<shutdown> I<domain-id> [I<--mode acpi|agent>] +=item B<shutdown> I<domain> [I<--mode acpi|agent>] Gracefully shuts down a domain. This coordinates with the domain OS to perform graceful shutdown, so there is no guarantee that it will @@ -1461,7 +1460,7 @@ services must be shutdown in the domain. The exact behavior of a domain when it shuts down is set by the I<on_shutdown> parameter in the domain's XML definition. -If I<domain-id> is transient, then the metadata of any snapshots will +If I<domain> is transient, then the metadata of any snapshots will be lost once the guest stops running, but the snapshot contents still exist, and a new domain with the same name and UUID can restore the snapshot metadata with B<snapshot-create>. @@ -1470,8 +1469,8 @@ By default the hypervisor will try to pick a suitable shutdown method. To specify an alternative method, the I<--mode> parameter can specify C<acpi> or C<agent>. -=item B<start> I<domain-name> [I<--console>] [I<--paused>] [I<--autodestroy>] -[I<--bypass-cache>] [I<--force-boot>] +=item B<start> I<domain-name-or-uuid> [I<--console>] [I<--paused>] +[I<--autodestroy>] [I<--bypass-cache>] [I<--force-boot>] Start a (previously defined) inactive domain, either from the last B<managedsave> state, or via a fresh boot if no managedsave state is @@ -1485,18 +1484,18 @@ the restore will avoid the file system cache, although this may slow down the operation. If I<--force-boot> is specified, then any managedsave state is discarded and a fresh boot occurs. -=item B<suspend> I<domain-id> +=item B<suspend> I<domain> Suspend a running domain. It is kept in memory but won't be scheduled anymore. -=item B<resume> I<domain-id> +=item B<resume> I<domain> Moves a domain out of the suspended state. This will allow a previously suspended domain to now be eligible for scheduling by the underlying hypervisor. -=item B<dompmsuspend> I<domain-id> I<target> [I<--duration>] +=item B<dompmsuspend> I<domain> I<target> [I<--duration>] Suspend a running domain into one of these states (possible I<target> values): @@ -1512,18 +1511,18 @@ hypervisor driver and 0 should be used.). Note that this command requires a guest agent configured and running in the domain's guest OS. -=item B<dompmwakeup> I<domain-id> +=item B<dompmwakeup> I<domain> Wakeup a domain suspended by dompmsuspend command. Injects a wakeup into the guest that previously used dompmsuspend, rather than waiting for the previously requested duration (if any) to elapse. -=item B<ttyconsole> I<domain-id> +=item B<ttyconsole> I<domain> Output the device used for the TTY console of the domain. If the information is not available the processes will provide an exit code of 1. -=item B<undefine> I<domain-id> [I<--managed-save>] [I<--snapshots-metadata>] +=item B<undefine> I<domain> [I<--managed-save>] [I<--snapshots-metadata>] [ {I<--storage> B<volumes> | I<--remove-all-storage>} I<--wipe-storage>] Undefine a domain. If the domain is running, this converts it to a @@ -1558,13 +1557,13 @@ The flag I<--wipe-storage> specifies that the storage volumes should be wiped before removal. NOTE: For an inactive domain, the domain name or UUID must be used as the -I<domain-id>. +I<domain>. -=item B<vcpucount> I<domain-id> [{I<--maximum> | I<--active>} +=item B<vcpucount> I<domain> [{I<--maximum> | I<--active>} {I<--config> | I<--live> | I<--current>}] Print information about the virtual cpu counts of the given -I<domain-id>. If no flags are specified, all possible counts are +I<domain>. If no flags are specified, all possible counts are listed in a table; otherwise, the output is limited to just the numeric value requested. For historical reasons, the table lists the label "current" on the rows that can be queried in isolation @@ -1580,12 +1579,12 @@ state of the domain (corresponding to I<--live> if running, or I<--config> if inactive); these three flags are mutually exclusive. Thus, this command always takes exactly zero or two flags. -=item B<vcpuinfo> I<domain-id> +=item B<vcpuinfo> I<domain> Returns basic information about the domain virtual CPUs, like the number of vCPUs, the running time, the affinity to physical processors. -=item B<vcpupin> I<domain-id> [I<vcpu>] [I<cpulist>] [[I<--live>] +=item B<vcpupin> I<domain> [I<vcpu>] [I<cpulist>] [[I<--live>] [I<--config>] | [I<--current>]] Query or change the pinning of domain VCPUs to host physical CPUs. To @@ -1607,7 +1606,7 @@ If no flag is specified, behavior is different depending on hypervisor. B<Note>: The expression is sequentially evaluated, so "0-15,^8" is identical to "9-14,0-7,15" but not identical to "^8,0-15". -=item B<vncdisplay> I<domain-id> +=item B<vncdisplay> I<domain> Output the IP address and port number for the VNC display. If the information is not available the processes will provide an exit code of 1. @@ -1617,14 +1616,14 @@ is not available the processes will provide an exit code of 1. =head1 DEVICE COMMANDS The following commands manipulate devices associated to domains. -The domain-id can be specified as a short integer, a name or a full UUID. +The I<domain> can be specified as a short integer, a name or a full UUID. To better understand the values allowed as options for the command reading the documentation at L<http://libvirt.org/formatdomain.html> on the format of the device sections to get the most accurate set of accepted values. =over 4 -=item B<attach-device> I<domain-id> I<FILE> [I<--config>] +=item B<attach-device> I<domain> I<FILE> [I<--config>] Attach a device to the domain, using a device definition in an XML file using a device definition element such as <disk> or <interface> @@ -1639,7 +1638,7 @@ within an existing device; consider using B<update-device> for this usage. For passthrough host devices, see also B<nodedev-detach>, needed if the device does not use managed mode. -=item B<attach-disk> I<domain-id> I<source> I<target> +=item B<attach-disk> I<domain> I<source> I<target> [I<--driver driver>] [I<--subdriver subdriver>] [I<--cache cache>] [I<--type type>] [I<--mode mode>] [I<--config>] [I<--sourcetype soucetype>] [I<--serial serial>] [I<--shareable>] [I<--rawio>] [I<--address address>] @@ -1667,7 +1666,7 @@ scsi:controller.bus.unit or ide:controller.bus.unit. I<multifunction> indicates specified pci address is a multifunction pci device address. -=item B<attach-interface> I<domain-id> I<type> I<source> +=item B<attach-interface> I<domain> I<type> I<source> [I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>] [I<--config>] [I<--inbound average,peak,burst>] [I<--outbound average,peak,burst>] @@ -1691,7 +1690,7 @@ B<Note>: the optional target value is the name of a device to be created as the back-end on the node. If not provided a device named "vnetN" or "vifN" will be created automatically. -=item B<detach-device> I<domain-id> I<FILE> [I<--config>] +=item B<detach-device> I<domain> I<FILE> [I<--config>] Detach a device from the domain, takes the same kind of XML descriptions as command B<attach-device>. @@ -1701,7 +1700,7 @@ I<--config>. For passthrough host devices, see also B<nodedev-reattach>, needed if the device does not use managed mode. -=item B<detach-disk> I<domain-id> I<target> [I<--config>] +=item B<detach-disk> I<domain> I<target> [I<--config>] Detach a disk device from a domain. The I<target> is the device as seen from the domain. @@ -1709,7 +1708,7 @@ If I<--config> is specified, alter persistent configuration, effect observed on next boot, for compatibility purposes, I<--persistent> is alias of I<--config>. -=item B<detach-interface> I<domain-id> I<type> [I<--mac mac>] [I<--config>] +=item B<detach-interface> I<domain> I<type> [I<--mac mac>] [I<--config>] Detach a network interface from a domain. I<type> can be either I<network> to indicate a physical network device or @@ -1720,9 +1719,9 @@ If I<--config> is specified, alter persistent configuration, effect observed on next boot, for compatibility purposes, I<--persistent> is alias of I<--config>. -=item B<update-device> I<domain-id> I<file> [I<--config>] [I<--force>] +=item B<update-device> I<domain> I<file> [I<--config>] [I<--force>] -Update the characteristics of a device associated with I<domain-id>, +Update the characteristics of a device associated with I<domain>, based on the device definition in an XML I<file>. If the I<--config> option is used, the changes will take affect the next time libvirt starts the domain. For compatibility purposes, I<--persistent> is @@ -1732,7 +1731,7 @@ the domain. See the documentation at L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about libvirt XML format for a device. -=item B<change-media> I<domain-id> I<path> [I<--eject>] [I<--insert>] +=item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>] [I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]] Change media of CDROM or floppy drive. I<path> can be the fully-qualified path -- 1.7.8.6

3 2

[libvirt] [PATCH] Fixup manpage names and copyright dates
by Laine Stump 25 Jul '12

25 Jul '12

The copyright dates in the manpages haven't been updated in awhile. Also, when pod2man converts a pod file into a manpage, it will only remove the extension from the filename if it is ".pod". Some of the libvirt pod files are named *.pod.in, and that filename is placed unchanged into the manpage. This patch uses pod2man's --name option to fix that. Believe it or not, there's even a BZ for this: https://bugzilla.redhat.com/show_bug.cgi?id=819364 --- daemon/Makefile.am | 2 +- daemon/libvirtd.pod.in | 2 +- tools/Makefile.am | 8 ++++---- tools/virt-pki-validate.in | 2 +- tools/virt-xml-validate.in | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/daemon/Makefile.am b/daemon/Makefile.am index 74250f6..4c72b7b 100644 --- a/daemon/Makefile.am +++ b/daemon/Makefile.am @@ -376,7 +376,7 @@ POD2MAN = pod2man -c "Virtualization Support" \ -r "$(PACKAGE)-$(VERSION)" -s 8 $(srcdir)/libvirtd.8.in: libvirtd.pod.in - $(AM_V_GEN)$(POD2MAN) $< $@ + $(AM_V_GEN)$(POD2MAN) --name LIBVIRTD $< $@ # This is needed for clients too, so can't wrap in # the WITH_LIBVIRTD conditional diff --git a/daemon/libvirtd.pod.in b/daemon/libvirtd.pod.in index ea6c37d..3ada67c 100644 --- a/daemon/libvirtd.pod.in +++ b/daemon/libvirtd.pod.in @@ -150,7 +150,7 @@ Please refer to the AUTHORS file distributed with libvirt. =head1 COPYRIGHT -Copyright (C) 2006-2010 Red Hat, Inc., and the authors listed in the +Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the libvirt AUTHORS file. =head1 LICENSE diff --git a/tools/Makefile.am b/tools/Makefile.am index c82a2fb..723db8e 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -52,17 +52,17 @@ virt-xml-validate: virt-xml-validate.in Makefile || (rm $@ && exit 1) && chmod +x $@ virt-xml-validate.1: virt-xml-validate.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-XML-VALIDATE $< $(srcdir)/$@ virt-pki-validate: virt-pki-validate.in Makefile $(AM_V_GEN)sed -e 's,[@]SYSCONFDIR@,$(sysconfdir),' < $< > $@ \ || (rm $@ && exit 1) && chmod +x $@ virt-pki-validate.1: virt-pki-validate.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-PKI-VALIDATE $< $(srcdir)/$@ virt-host-validate.1: virt-host-validate.c - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-HOST-VALIDATE $< $(srcdir)/$@ virt-sanlock-cleanup: virt-sanlock-cleanup.in Makefile $(AM_V_GEN)sed -e 's,[@]SYSCONFDIR@,$(sysconfdir),' \ @@ -70,7 +70,7 @@ virt-sanlock-cleanup: virt-sanlock-cleanup.in Makefile || (rm $@ && exit 1) && chmod +x $@ virt-sanlock-cleanup.8: virt-sanlock-cleanup.in - $(AM_V_GEN)$(POD2MAN) $< $(srcdir)/$@ + $(AM_V_GEN)$(POD2MAN) --name VIRT-SANLOCK-CLEANUP $< $(srcdir)/$@ virt_host_validate_SOURCES = \ virt-host-validate.c \ diff --git a/tools/virt-pki-validate.in b/tools/virt-pki-validate.in index 4164758..866a235 100755 --- a/tools/virt-pki-validate.in +++ b/tools/virt-pki-validate.in @@ -310,7 +310,7 @@ Alternatively report bugs to your software distributor / vendor. =head1 COPYRIGHT -Copyright (C) 2006-2010 by Red Hat, Inc. +Copyright (C) 2006-2012 by Red Hat, Inc. =head1 LICENSE diff --git a/tools/virt-xml-validate.in b/tools/virt-xml-validate.in index 1959261..9ba3a0a 100644 --- a/tools/virt-xml-validate.in +++ b/tools/virt-xml-validate.in @@ -134,7 +134,7 @@ Alternatively report bugs to your software distributor / vendor. =head1 COPYRIGHT -Copyright (C) 2009-2010 by Red Hat, Inc. +Copyright (C) 2009-2012 by Red Hat, Inc. Copyright (C) 2009 by Daniel P. Berrange =head1 LICENSE -- 1.7.11.2

2 4

[libvirt] [PATCH] conf: Fix typo in virDomainHostdevSubsys comment
by Jiri Denemark 25 Jul '12

25 Jul '12

--- Pushed under trivial rule. src/conf/domain_conf.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index 469d3b6..bc02caf 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -366,7 +366,7 @@ enum virDomainHostdevSubsysType { typedef struct _virDomainHostdevSubsys virDomainHostdevSubsys; typedef virDomainHostdevSubsys *virDomainHostdevSubsysPtr; struct _virDomainHostdevSubsys { - int type; /* enum virDomainHostdevBusType */ + int type; /* enum virDomainHostdevSubsysType */ union { struct { unsigned bus; -- 1.7.11.1

1 0

[libvirt] Remove "-S" option in libvirt generated argv
by B Veera-B37207 25 Jul '12

25 Jul '12

Hi Daniel, How can remove "-S" option in libvirt generated command from xml file. Regards, Veera.

2 1

[libvirt] [PATCH] selinux: Do not automatically label images of unconfined domains
by Jiri Denemark 25 Jul '12

25 Jul '12

When an unconfined domain is begin started, it doesn't make any sense to automatically relabel its disk images with the default label. Morever, doing so would fail because the generated label would be generated without the "s0" sensitivity (since mcs is NULL in this case). --- src/security/security_selinux.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/security/security_selinux.c b/src/security/security_selinux.c index ca19b70..02808a4 100644 --- a/src/security/security_selinux.c +++ b/src/security/security_selinux.c @@ -370,8 +370,13 @@ virSecuritySELinuxGenSecurityLabel(virSecurityManagerPtr mgr, goto cleanup; } - if (!def->seclabel.norelabel) { - def->seclabel.imagelabel = virSecuritySELinuxGenNewContext(data->file_context, mcs); + /* Generating image label does not make any sense if the domain itself + * will not be labeled. + */ + if (def->seclabel.type != VIR_DOMAIN_SECLABEL_NONE && + !def->seclabel.norelabel) { + def->seclabel.imagelabel = + virSecuritySELinuxGenNewContext(data->file_context, mcs); if (!def->seclabel.imagelabel) { virReportError(VIR_ERR_INTERNAL_ERROR, _("cannot generate selinux context for %s"), mcs); -- 1.7.11.1

2 2

[libvirt] [PATCH] util: fix a typo on return value
by Guannan Ren 25 Jul '12

25 Jul '12

virNetDevTapCreateInBridgePort returns 0 in case of success or -1 on failure --- src/util/virnetdevtap.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/virnetdevtap.c b/src/util/virnetdevtap.c index 6ccc380..83f2ecd 100644 --- a/src/util/virnetdevtap.c +++ b/src/util/virnetdevtap.c @@ -341,5 +341,5 @@ int virNetDevTapCreateInBridgePort(const char *brname, if (tapfd) VIR_FORCE_CLOSE(*tapfd); - return errno; + return -1; } -- 1.7.7.5

2 6

[libvirt] [PATCH] virsh: Clean up and refactor cmdDomDisplay() and fix some possible leaks
by Peter Krempa 25 Jul '12

25 Jul '12

This patch refactors cmdDomDisplay to update coding style and remove some possible memory leaks on error paths. This patch also fixes flag variable type to unsigned. --- tools/virsh.c | 76 ++++++++++++++++++++++++++------------------------------ 1 files changed, 35 insertions(+), 41 deletions(-) diff --git a/tools/virsh.c b/tools/virsh.c index 6d65036..eea580d 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -13861,16 +13861,15 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) virDomainPtr dom; virBuffer buf = VIR_BUFFER_INITIALIZER; bool ret = false; - char *doc; - char *xpath; - char *listen_addr; + char *doc = NULL; + char *xpath = NULL; + char *listen_addr = NULL; int port, tls_port = 0; char *passwd = NULL; char *output = NULL; const char *scheme[] = { "vnc", "spice", "rdp", NULL }; int iter = 0; - int tmp; - int flags = 0; + unsigned int flags = 0; if (!vshConnectionUsability(ctl, ctl->conn)) return false; @@ -13886,40 +13885,34 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) if (vshCommandOptBool(cmd, "include-password")) flags |= VIR_DOMAIN_XML_SECURE; - doc = virDomainGetXMLDesc(dom, flags); - - if (!doc) + if (!(doc = virDomainGetXMLDesc(dom, flags))) goto cleanup; - xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt); - VIR_FREE(doc); - if (!xml) + if (!(xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt))) goto cleanup; /* Attempt to grab our display info */ for (iter = 0; scheme[iter] != NULL; iter++) { /* Create our XPATH lookup for the current display's port */ - virAsprintf(&xpath, "string(/domain/devices/graphics[@type='%s']" - "/@port)", scheme[iter]); - if (!xpath) { + VIR_FREE(xpath); + if (virAsprintf(&xpath, + "string(/domain/devices/graphics[@type='%s']/@port)", + scheme[iter]) < 0) { virReportOOMError(); goto cleanup; } - /* Attempt to get the port number for the current graphics scheme */ - tmp = virXPathInt(xpath, ctxt, &port); - VIR_FREE(xpath); - - /* If there is no port number for this type, then jump to the next - * scheme + /* Attempt to get the port number for the current graphics scheme. + * If there is no port number for this type, then jump to the next scheme. */ - if (tmp) + if (virXPathInt(xpath, ctxt, &port) < 0) continue; /* Create our XPATH lookup for the current display's address */ - virAsprintf(&xpath, "string(/domain/devices/graphics[@type='%s']" - "/@listen)", scheme[iter]); - if (!xpath) { + VIR_FREE(xpath); + if (virAsprintf(&xpath, + "string(/domain/devices/graphics[@type='%s']/@listen)", + scheme[iter]) < 0) { virReportOOMError(); goto cleanup; } @@ -13928,7 +13921,6 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) * graphics scheme */ listen_addr = virXPathString(xpath, ctxt); - VIR_FREE(xpath); /* Per scheme data mangling */ if (STREQ(scheme[iter], "vnc")) { @@ -13936,31 +13928,32 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) port -= 5900; } else if (STREQ(scheme[iter], "spice")) { /* Create our XPATH lookup for the SPICE TLS Port */ - virAsprintf(&xpath, "string(/domain/devices/graphics[@type='%s']" - "/@tlsPort)", scheme[iter]); - if (!xpath) { + VIR_FREE(xpath); + if (virAsprintf(&xpath, + "string(/domain/devices/graphics[@type='%s']" + "/@tlsPort)", + scheme[iter]) < 0) { virReportOOMError(); goto cleanup; } /* Attempt to get the TLS port number for SPICE */ - tmp = virXPathInt(xpath, ctxt, &tls_port); - VIR_FREE(xpath); - if (tmp) + if (virXPathInt(xpath, ctxt, &tls_port) < 0) tls_port = 0; if (vshCommandOptBool(cmd, "include-password")) { /* Create our XPATH lookup for the SPICE password */ - virAsprintf(&xpath, "string(/domain/devices/graphics" - "[@type='%s']/@passwd)", scheme[iter]); - if (!xpath) { + VIR_FREE(xpath); + if (virAsprintf(&xpath, + "string(/domain/devices/graphics" + "[@type='%s']/@passwd)", + scheme[iter]) < 0) { virReportOOMError(); goto cleanup; } /* Attempt to get the SPICE password */ passwd = virXPathString(xpath, ctxt); - VIR_FREE(xpath); } } @@ -13968,12 +13961,11 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) virBufferAsprintf(&buf, "%s://", scheme[iter]); /* Then host name or IP */ - if (!listen_addr || STREQ((const char *)listen_addr, "0.0.0.0")) + if (!listen_addr || STREQ(listen_addr, "0.0.0.0")) virBufferAddLit(&buf, "localhost"); else virBufferAsprintf(&buf, "%s", listen_addr); - VIR_FREE(listen_addr); /* Add the port */ if (STREQ(scheme[iter], "spice")) @@ -13986,10 +13978,8 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) virBufferAsprintf(&buf, "&tls-port=%d", tls_port); /* Password */ - if (passwd) { + if (passwd) virBufferAsprintf(&buf, "&password=%s", passwd); - VIR_FREE(passwd); - } /* Ensure we can print our URI */ if (virBufferError(&buf)) { @@ -14000,7 +13990,6 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) /* Print out our full URI */ output = virBufferContentAndReset(&buf); vshPrint(ctl, "%s", output); - VIR_FREE(output); /* We got what we came for so return successfully */ ret = true; @@ -14008,6 +13997,11 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) } cleanup: + VIR_FREE(doc); + VIR_FREE(xpath); + VIR_FREE(listen_addr); + VIR_FREE(passwd); + VIR_FREE(output); xmlXPathFreeContext(ctxt); xmlFreeDoc(xml); virDomainFree(dom); -- 1.7.8.6

2 1

[libvirt] [PATCH v2] fixed SegFault in virauth
by Martin Kletzander 25 Jul '12

25 Jul '12

No check for conn->uri being NULL in virAuthGetConfigFilePath (valid state) made the client segfault. This happens for example with these settings: - no virtualbox driver installed (modifies conn->uri) - no default URI set (VIRSH_DEFAULT_CONNECT_URI="", LIBVIRT_DEFAULT_URI="", uri_default="") - auth_sock_rw="sasl" - virsh run as root That are unfortunately the settings with fresh Fedora 17 installation with VDSM. The check ought to be enough as conn->uri being NULL is valid in later code and is handled properly. --- v2: - copyright modified properly this time src/util/virauth.c | 19 +++++++++++-------- 1 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/util/virauth.c b/src/util/virauth.c index e6b1db0..5539c3c 100644 --- a/src/util/virauth.c +++ b/src/util/virauth.c @@ -1,6 +1,7 @@ /* * virauth.c: authentication related utility functions * + * Copyright (C) 2012 Red Hat, Inc. * Copyright (C) 2010 Matthias Bolte <matthias.bolte(a)googlemail.com> * * This library is free software; you can redistribute it and/or @@ -54,14 +55,16 @@ int virAuthGetConfigFilePath(virConnectPtr conn, return 0; } - for (i = 0 ; i < conn->uri->paramsCount ; i++) { - if (STREQ_NULLABLE(conn->uri->params[i].name, "authfile") && - conn->uri->params[i].value) { - VIR_DEBUG("Using path from URI '%s'", - conn->uri->params[i].value); - if (!(*path = strdup(conn->uri->params[i].value))) - goto no_memory; - return 0; + if (conn && conn->uri) { + for (i = 0 ; i < conn->uri->paramsCount ; i++) { + if (STREQ_NULLABLE(conn->uri->params[i].name, "authfile") && + conn->uri->params[i].value) { + VIR_DEBUG("Using path from URI '%s'", + conn->uri->params[i].value); + if (!(*path = strdup(conn->uri->params[i].value))) + goto no_memory; + return 0; + } } } -- 1.7.8.6

2 2

[libvirt] [PATCH v2] virsh: fixed domdisplay command
by Martin Kletzander 25 Jul '12

25 Jul '12

The 'domdisplay' command didn't properly evaluate '--include-password' option. --- v2: - switched to using 'flags' - kept the second condition in place - fixed indentation after virAsprintf tools/virsh.c | 11 ++++++++--- 1 files changed, 8 insertions(+), 3 deletions(-) diff --git a/tools/virsh.c b/tools/virsh.c index 5888d6c..5f96445 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -13870,6 +13870,7 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) const char *scheme[] = { "vnc", "spice", "rdp", NULL }; int iter = 0; int tmp; + int flags = 0; if (!vshConnectionUsability(ctl, ctl->conn)) return false; @@ -13882,7 +13883,11 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) goto cleanup; } - doc = virDomainGetXMLDesc(dom, 0); + if (vshCommandOptBool(cmd, "include-password")) + flags |= VIR_DOMAIN_XML_SECURE; + + doc = virDomainGetXMLDesc(dom, flags); + if (!doc) goto cleanup; @@ -13944,10 +13949,10 @@ cmdDomDisplay(vshControl *ctl, const vshCmd *cmd) if (tmp) tls_port = 0; - if (vshCommandOptBool(cmd, "daemon")) { + if (vshCommandOptBool(cmd, "include-password")) { /* Create our XPATH lookup for the SPICE password */ virAsprintf(&xpath, "string(/domain/devices/graphics" - "[@type='%s']/@passwd)", scheme[iter]); + "[@type='%s']/@passwd)", scheme[iter]); if (!xpath) { virReportOOMError(); goto cleanup; -- 1.7.8.6

3 4

[libvirt] [PATCH v2][TCK] add test case for block job lifecycle testing
by Kyla Zhang 25 Jul '12

25 Jul '12

From: Xiaoqiang Hu <xhu(a)redhat.com> v2: Add skip block for qemu only and 120s timeout for test v1: Add tests for block job lifecyle and the test flow is as follows: create 50M qed img with qed backing img-> block pull->abort block job->resume block pull->set block job speed-> wait to finish --- scripts/qemu/300-blockjob-lifecycle.t | 142 +++++++++++++++++++++++++++++++++ 1 files changed, 142 insertions(+), 0 deletions(-) create mode 100644 scripts/qemu/300-blockjob-lifecycle.t diff --git a/scripts/qemu/300-blockjob-lifecycle.t b/scripts/qemu/300-blockjob-lifecycle.t new file mode 100644 index 0000000..7840d43 --- /dev/null +++ b/scripts/qemu/300-blockjob-lifecycle.t @@ -0,0 +1,142 @@ +# -*- perl -*- +# +# Copyright (C) 2011-2012 Red Hat, Inc. +# Copyright (C) 2011 Xiaoqiang Hu <xhu redhat com> +# +# This program is free software; You can redistribute it and/or modify +# it under the GNU General Public License as published by the Free +# Software Foundation; either version 2, or (at your option) any +# later version +# +# The file "LICENSE" distributed along with this file provides full +# details of the terms and conditions +# + +=pod + +=head1 NAME + +qemu/300-blockjob-lifecycle.t - verify the lifecycle of block job: +block pull, set block job speed, get block job info and abort block job + +=head1 DESCRIPTION + +The test case validates that it is possible to block pull, set block job +speed, get block job info and abort block job for domain using qed img +with qed backing img + +=cut + +use strict; +use warnings; + +use Test::More tests => 16; + +use Sys::Virt::TCK; +use Test::Exception; +use File::Spec::Functions qw(catfile); +use File::stat; + +my $tck = Sys::Virt::TCK->new(); +my $conn = eval { $tck->setup(); }; +BAIL_OUT "failed to setup test harness: $@" if $@; +END { + $tck->cleanup if $tck; +} + +SKIP:{ + skip "Only relevant to QEMU driver", 16 unless $conn->get_type() eq "QEMU"; + my $xml = $tck->generic_pool("dir") + ->mode("0755")->as_xml; + + diag "Defining transient storage pool $xml"; + my $pool; + + ok_pool(sub { $pool = $conn->define_storage_pool($xml) }, "define transient storage pool"); + lives_ok(sub { $pool->build(0) }, "built storage pool"); + lives_ok(sub { $pool->create }, "started storage pool"); + + my $volbackxml = $tck->generic_volume("tck-back", "qed", 1024*1024*50)->allocation(0)->as_xml; + + my ($volback, $pathback); + diag "back $volbackxml"; + ok_volume(sub { $volback = $pool->create_volume($volbackxml) }, "create qed backing file volume"); + + my $st; + $pathback = xpath($volback, "string(/volume/target/path)"); + $st = stat($pathback); + + ok($st, "path $pathback exists"); + + ok($st->size < 1024*1024, "size is < 1M"); + + my $volmainxml = $tck->generic_volume("tck-main", "qed", 1024*1024*50) + ->backing_file($pathback) + ->backing_format("qed") + ->allocation(0)->as_xml; + + my ($volmain, $pathmain); + diag "main $volmainxml"; + ok_volume(sub { $volmain = $pool->create_volume($volmainxml) }, "create qed backing file volume"); + + $pathmain = xpath($volmain, "string(/volume/target/path)"); + $st = stat($pathmain); + + ok($st, "path $pathmain exists"); + + ok($st->size < 1024*1024, "size is < 1M"); + + # define the guest at a qed image + # and the backing store in this qed image. + $xml = $tck->generic_domain("tck") + ->disk(format => { name => "qemu", type => "qed" }, + type => "file", + src => $pathmain, + dst => "vdb") + ->as_xml; + + diag "Defining an inactive domain config $xml"; + my $dom; + ok_domain(sub { $dom = $conn->define_domain($xml) }, "defined persistent domain config"); + + diag "Starting inactive domain config"; + $dom->create; + ok($dom->get_id() > 0, "running domain has an ID > 0"); + + # start to block pull and bandwidth is 1MB/S + my ($bandwidth, $flags, $jobinfo, $timeout); + # 1MB/S + $bandwidth = 1; + $flags=0; + $dom->block_pull($pathmain, $bandwidth, $flags); + # $jobinfo is a hash reference summarising the execution state of the block job + # and it has four keys:cur, end, bandwidth, type + $jobinfo = $dom->get_block_job_info($pathmain, $flags); + ok($jobinfo->{bandwidth} == $bandwidth, "start to block pull and block job bandwidth is $bandwidth"."MB/S"); + + $dom->abort_block_job($pathmain, $flags); + $jobinfo = $dom->get_block_job_info($pathmain, $flags); + ok($jobinfo->{type} == 0, "abort block job"); + + $dom->block_pull($pathmain, $bandwidth, $flags); + $jobinfo = $dom->get_block_job_info($pathmain, $flags); + ok($jobinfo->{bandwidth} == $bandwidth, "continue to block pull and block job bandwidth is $bandwidth"."MB/S"); + + # set block job bandwidth to 2MB/S + $bandwidth = 2; + $dom->set_block_job_speed($pathmain, $bandwidth, $flags); + $jobinfo = $dom->get_block_job_info($pathmain, $flags); + ok($jobinfo->{bandwidth} == $bandwidth, "block job bandwidth is set to $bandwidth"."MB/S"); + + # wait for the end of block pull and timeout is 120s + $timeout = 120; + while($jobinfo->{cur} < $jobinfo->{end} && $jobinfo->{type} == 1 && $timeout > 0) { + sleep(1); + $jobinfo = $dom->get_block_job_info($pathmain, $flags); + $timeout--; + } + + diag "block pull is not finished in 120S" if $jobinfo->{type} == 1 && $timeout == 0; + ok($jobinfo->{type} == 0, "block pull is finished"); +} +# end -- 1.7.3

2 1