[libvirt] [PATCH] docs: clarify that virsh setvcpus and setmem only work on active domains

Addresses BZ # 622534: https://bugzilla.redhat.com/show_bug.cgi?id=622534 --- tools/virsh.pod | 28 ++++++++++++++++++---------- 1 files changed, 18 insertions(+), 10 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 0e03d68..b4c6ff7 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -568,13 +568,16 @@ XEN_CREDIT scheduler and are now I<DEPRECATED>. =item B<setmem> I<domain-id> B<kilobytes> -Change the current memory allocation in the guest domain. This should take -effect immediately. The memory limit is specified in -kilobytes. +Change the current memory allocation in an B<active> guest domain. This +should take effect immediately. The memory limit is specified in kilobytes. For Xen, you can only adjust the memory of a running domain if the domain is paravirtualized or running the PV balloon driver. +B<Note>, this command only works on active guest domains. To change the +number of virtual CPUs in a inactive guest domain, use the virsh B<edit> +command to update the XML <memory> element. + =item B<setmaxmem> I<domain-id> B<kilobytes> Change the maximum memory allocation limit in the guest domain. This should @@ -593,24 +596,29 @@ QEMU/KVM supports I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>. =item B<setvcpus> I<domain-id> I<count> optional I<--maximum> I<--config> I<--live> -Change the number of virtual CPUs active in the guest domain. Note that -I<count> may be limited by host, hypervisor or limit coming from the -original description of domain. +Change the number of virtual CPUs active in an B<active> guest domain. + +The I<count> value may be limited by host, hypervisor or limit coming from +the original description of the guest domain. For Xen, you can only adjust the virtual CPUs of a running domain if the domain is paravirtualized. If I<--config> is specified, the change will only affect the next boot of a domain. If I<--live> is specified, the domain must be -running, and the change takes place immediately. Both flags may be -specified, if supported by the hypervisor. If neither flag is given, -then I<--live> is implied and it is up to the hypervisor whether -I<--config> is also implied. +running, and the change takes place immediately. Both I<--config> and +I<--live> flags may be specified, if supported by the hypervisor. If +neither flag is given, then I<--live> is implied and it is up to the +hypervisor whether I<--config> is also implied. If I<--maximum> is specified, then you must use I<--config> and avoid I<--live>; this flag controls the maximum limit of vcpus that can be hot-plugged the next time the domain is booted. +B<Note>, this command only works on active guest domains. To change the +number of virtual CPUs in a inactive guest domain, use the virsh B<edit> +command to update the XML <vcpu> element. + =item B<shutdown> I<domain-id> Gracefully shuts down a domain. This coordinates with the domain OS -- 1.7.3.2