summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAgeFilesLines
* man/virt-install: Add a note about different behavior of --boot on s390xThomas Huth2023-03-221-0/+2
| | | | | | | | | | | | | | | | It is common on x86 and other architectures to install a guest from network by using "--boot hd,network" with virt-install - as long as the hard disk is not bootable yet, the installation will be started via network, and once it finished, the guest can boot from hd during the next reboot. However, this does not work on s390x since this architecture only supports one single boot device to be passed to the guest. Thus add a note to the documentation to avoid that people are running again into this common pitfall. Buglink: https://bugzilla.redhat.com/show_bug.cgi?id=2032472 Signed-off-by: Thomas Huth <thuth@redhat.com>
* virt-install: Document Secure Boot setupsAndrea Bolognani2023-02-091-2/+15
| | | | | | | | | | | | | | | Provide ready to use recipes for explicitly enabling and explicitly disabling Secure Boot, as well as a pointer to the more extensive information found on the libvirt website. Setting loader_secure=yes is only one part of a proper Secure Boot setup, so stop documenting it in the section about manual firmware selection to avoid confusion. https://bugzilla.redhat.com/show_bug.cgi?id=2112154 https://bugzilla.redhat.com/show_bug.cgi?id=2149971 Signed-off-by: Andrea Bolognani <abologna@redhat.com>
* virt-install: Recommend '--boot uefi'Andrea Bolognani2023-02-091-2/+2
| | | | | | | | Firmware autoselection is the way to go in most cases, so recommend that instead of telling users that they should provide all information manually. Signed-off-by: Andrea Bolognani <abologna@redhat.com>
* virt-install: add support for qemu-vdagent channelJonathon Jongsma2022-06-131-0/+9
| | | | | | | | | | | | | | This allows support for host/guest clipboard sharing when using vnc guests (and possibly other graphics types in the future). This channel is similar to the spicevmc channel, but it contains a couple additional options to enable/disable clipboard sharing and specify the mouse mode. In the case of spice, these settings are specified on the 'graphics' element, but for qemu-vdagent, they are specified on the channel. For example: --channel=qemu-vdagent,source.clipboard.copypaste=on,source.mouse.mode=client Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
* virt-install: Add --cloud-init clouduser-ssh-key=Cole Robinson2022-03-011-0/+6
| | | | | | | | This sets the sshkey for the default cloud-init username Resolves: https://github.com/virt-manager/virt-manager/issues/307 Signed-off-by: Cole Robinson <crobinso@redhat.com>
* virt-install: Rename --cloud-init ssh-key -> root-ssh-keyCole Robinson2022-03-011-2/+2
| | | | | | | | Originally we thought it would be for the clouduser, but then we changed it, and now it's ambiguous. Rename it to make the usage clear, and add an alias to keep any users working Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add xpath.* subargs to XML optionsCole Robinson2022-02-271-0/+18
| | | | | | | | This adds the power of --xml to individual device options. For example this makes it easier to make custom XML changes for a single --disk device from both virt-install and virt-xml Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add --boot refresh-machine-type=yesCole Robinson2022-02-261-0/+11
| | | | | | | | | | | | | This is a virt-xml option to refresh a VM to use the latest machine type version for the machine type it's currently using. Ex: pseries-2.11 -> pseries pc-q35-5.0 -> q35 This is useful for when qemu deprecates and removes the machine type out from under you, or to pick up bug fixes. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* Use pcie_root_ports for arm and riscv machvirtCole Robinson2022-02-261-2/+2
| | | | | | | | | Libvirt defaults to PCIe for arm32/aarch64 and riscv -M virt too. Rename q35_pcie_root_ports to num_pcie_root_ports and extend the logic to those archs too Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add basic --audio type=XXX,id=Y supportCole Robinson2022-02-242-0/+11
| | | | | | Closes: #264 Signed-off-by: Cole Robinson <crobinso@redhat.com>
* virt-install: Require --osinfo for non-x86 HVM case tooCole Robinson2022-02-201-2/+2
| | | | | | | | | It's generally not as valuable for non-x86 where we don't have the history of supporting non-virtio OSes, but as time goes on it will likely become more relevant for non-x86 arches, so let's make this change now to get ahead of it. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: virt-install: Update --controller docsCole Robinson2022-02-201-11/+16
| | | | | | | Drop type value lists, add example invocations, document q35_pcie_root_ports Signed-off-by: Cole Robinson <crobinso@redhat.com>
* devices: tpm: Rework defaultsCole Robinson2022-02-191-0/+3
| | | | | | | | | | | | The code previously was just encoding the same defaults as libvirt, which doesn't really add anything. Instead, let's prefer type='emulator' model='tpm-crb', which gives the most modern virtualization friendly config. When we don't know if that will work, we mostly leave things up to libvirt to fill in. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* virt-install: Make missing --osinfo fatal for most casesCole Robinson2022-02-161-13/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was previously discussed here: https://listman.redhat.com/archives/virt-tools-list/2020-September/msg00017.html For the x86 + hvm case, failure to specify an --osinfo/--os-variant OS, and failure to detect an OS from install media, will now throw a big error: ``` --os-variant/--osinfo OS name is required, but no value was set or detected. This is now a fatal error. Specifying an OS name is required for modern, performant, and secure virtual machine defaults. If you expected virt-install to detect an OS name from the install media, you can set a fallback OS name with: --osinfo detect=on,name=OSNAME You can see a full list of possible OS name values with: virt-install --osinfo list If your Linux distro is not listed, try one of generic values such as: linux2020, linux2018, linux2016 If you just need to get the old behavior back, you can use: --osinfo detect=on,require=off Or export VIRTINSTALL_OSINFO_DISABLE_REQUIRE=1 ``` The thread goes into more detail, but basically, for x86 VMs at least, it's unlikely you will _ever_ want the default 'generic' behavior, which gives gives no virtio, no PCIe, no usb3, IDE disks, slow network devices, etc. Many people use virt-install in scripts and CI, and this may now cause breakage. The environment variable is there to help them get things back to normal as quick as possible, but it will still noisy up their logs with the warning to hopefully get them to make a useful change to their virt-install invocations. This is limited to x86, since that's where most of our defaults historically differ, and where we can depend on libosinfo to give the most accurate device info. This may be relevant to change for other KVM architectures in the future. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Recommend --osinfo more over --os-variantCole Robinson2022-02-122-17/+16
| | | | | | | | We are about to change the some defaults around os handling. Let's start recommending the nicer named --osinfo more, since new error messages are going to promote it a bit as well Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add `--os-variant list` option to print OS name valuesCole Robinson2022-02-122-4/+4
| | | | | | | | | | | The canonical tool for this is `osinfo-query os`, which we still reference in the man pages and in the list output. However, we are about to make missing --os-variant fatal for common usage, and I don't want to force users to install an extra tool just to figure out what an acceptable --os-variant value is. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: virt-install: Use osuosl.org for debian URL exampleCole Robinson2022-02-091-1/+1
| | | | | | | | | https:// needs to link to the exact site, not the debian.org redirect, otherwise we get browser cert warnings Fixes: #360 Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: fix default value for filesystem accessmode optionJonathon Jongsma2022-02-091-1/+1
| | | | | | | | Commit 85307b9bd2971cfc972c976c78e411f018647861 changed the default value for 'accessmode' from 'passthrough' to 'mapped', but forgot to update the documentation in the man page. Signed-off-by: Jonathon Jongsma <jjongsma@redhat.com>
* virtinst: prefer cores when exposing topology to the guestDaniel P. Berrangé2022-01-201-2/+4
| | | | | | | | | | | | | | | | | | | | | In real world silicon though it is rare to have high socket/die counts, but common to have huge core counts. Some OS will even refuse to use sockets over a certain count. Thus we prefer to expose cores to the guest rather than sockets as the default for missing fields. This matches a recent change made in QEMU for new machine types commit 4a0af2930a4e4f64ce551152fdb4b9e7be106408 Author: Yanan Wang <wangyanan55@huawei.com> Date: Wed Sep 29 10:58:09 2021 +0800 machine: Prefer cores over sockets in smp parsing since 6.2 Closes: https://github.com/virt-manager/virt-manager/issues/155 Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
* virtinst: add missing 'dies' parameter for --vcpusDaniel P. Berrangé2022-01-201-1/+1
| | | | | | | | Although using --cpu topology.XXX is the preferred way to set topology, it is still possible via the --vcpus parameter. For consistency, this should support the full set of parameters, so dies needs to be added. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
* Fix typoMatt Graham2022-01-121-1/+1
|
* cli: --cloud-init add network-config optionlisongmin2021-10-041-0/+3
|
* misc: trim excess whitespacea13460542021-10-041-1/+1
|
* misc: fix spellinga13460542021-10-043-5/+5
|
* cli: --shmem: added support for shared memory devicesHugues Fafard2021-07-272-0/+14
| | | | | | | | | | | | This includes support for the following suboptions: * name (<shmem name=X>) * role (<shmem role=X>) * model.type (<shmem><model type=X/>) * size (<shmem><size>X) * size.unit (<shmem><size unit=X/>) * server.path (<shmem><server path=X/>) * msi.vectors (<shmem><msi vectors=X/>) * msi.ioeventfd (<shmem><msi ioeventfd=X/>)
* urlfetcher: Add xorriso ISOReader implementationCole Robinson2021-05-221-1/+1
| | | | | | | | xorisso is the still maintained isoinfo alternative, and may be the only iso reading tool in RHEL9, so we need to support it. Make it the default for our spec file and test suite too Signed-off-by: Cole Robinson <crobinso@redhat.com>
* Remove use of problematic terminologyCole Robinson2020-09-231-1/+1
| | | | | | | Following kernel recommendation here: https://lkml.org/lkml/2020/7/4/229 Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add --os-variant require=on|offCole Robinson2020-09-141-1/+23
| | | | | | | | | If specified, this errors if no OS name was detected or manually set. So --os-variant detect=on,require=on will error if no OS is detected. name= can be used as a fallback, so test and document this case Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: --os-variant: add explicit suboptionsCole Robinson2020-09-142-6/+21
| | | | | | | | | | | | | This adds the following --os-variant suboptions * name=, short-id= * id= * detect=on|off Functionally this does not change behavior, just adds explicit sub options for behavior we already support Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add --osinfo as alternate name for --os-variantCole Robinson2020-09-142-3/+3
| | | | | | | | | | | | The --os-variant option naming is pretty crappy and mostly a historical artifact. Ideally this would be named just `--os` but I'm afraid that would cause confusion with libvirt's <os> XML Add --osinfo as an alternate commandline naming. If we ever want to transition documented use of --os-variant it will help to have the alternative around for a few releases Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: Convert .pod files to .rstCole Robinson2020-09-138-2824/+2935
| | | | | | | Used pod2rst for the initial conversion but a lot of manual fixup afterwards. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add --xml xpath option for virt-install and virt-xmlCole Robinson2020-09-112-0/+44
| | | | | | | | | | | | | | | | | | | The --xml option allows users to request raw XML edits to virt-install or virt-xml generated XML. This gives users a bit of a workaround incase we don't have proper support for some XML property. The --xml option can gain more features in the future if it makes sense, like setting XML namespaces for example. Basic usage is like: virt-install --xml ./@foo=bar ... Which will change the generated <domain> XML to have <domain foo='bar' ... virt-xml works similarly. It can only be combined with --edit currently. This only works with xpaths rooted against the entire document. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Add --graphics websocket= supportPetr Benes2020-07-161-0/+8
| | | | | | | Add a --graphics websocket option to configure VNC WebSocket port as described in https://libvirt.org/formatdomain.html#elementsGraphics Reviewed-by: Cole Robinson <crobinso@redhat.com>
* virtinst: add support for configuring the IOMMUMenno Lageman2020-07-121-0/+6
| | | | | | | | | | | | | | | | | Add a --iommu option to configure IOMMU parameters as described in https://libvirt.org/formatdomain.html#elementsIommu E.g. 'virt-install --iommu model=intel,driver.aw_bits=48,driver.iotlb=on ...' will generate the following domain XML: <devices> <iommu model="intel"> <driver aw_bits="48" iotlb="on"/> </iommu> </devices> Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Menno Lageman <menno.lageman@oracle.com>
* docs: Add disk io mode io_uringHan Han2020-07-041-1/+1
| | | | | | | Support the io_uring io mode, introduced since Libvirt v6.3.0. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Han Han <hhan@redhat.com>
* Fix typo in virt-install man pageTony James2020-05-271-1/+1
|
* rng: add builtin rng backend modelHan Han2020-04-211-1/+7
| | | | | | | | The builtin rng backend uses getrandom syscall to generate random, no external rng source needed, introduced from libvirt v6.1.0. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Han Han <hhan@redhat.com>
* virt-install: Add --reinstall=DOMAIN optionCole Robinson2020-02-031-0/+14
| | | | | | This allows using virt-install's install logic on an existing VM Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cloner: Drop ability to clone a paused VMCole Robinson2020-01-291-2/+1
| | | | | | | | | | Generally this doesn't work with qemu metadata locking nowadays, and it was never a safe idea to begin with, because disk contents could be in an inconsistent state. https://bugzilla.redhat.com/show_bug.cgi?id=1725330 Signed-off-by: Cole Robinson <crobinso@redhat.com>
* setup: Run codespell on more filesCole Robinson2020-01-281-2/+2
| | | | | | And fix the results Signed-off-by: Cole Robinson <crobinso@redhat.com>
* cli: Clarify that --controller address= is not the preferred patternCole Robinson2020-01-251-5/+0
| | | | | | Remove it from the man page, and add a local comment to the code Signed-off-by: Cole Robinson <crobinso@redhat.com>
* Remove virt-convertCole Robinson2020-01-241-144/+0
| | | | | | | | | | | | | | | | | | | | | | | | | This was raised here: https://www.redhat.com/archives/virt-tools-list/2019-June/msg00117.html Quoting from that: """ virt-convert takes an ovf/ova or vmx file and spits out libvirt XML. It started as a code drop a long time ago that could translate back and forth between vmx, ovf, and virt-image, a long dead appliance format. In 2014 I converted it to do vmx -> libvirt and ovf -> libvirt which was a CLI breaking change, but I never heard a peep of a complaint. It doesn't seem to do a particularly thorough job at its intended goal, I've seen 2-3 bug reports in the past 5 years and generally it doesn't seem to have any users. Let's kill it. If anyone has the desire to keep it alive it could live as a separate project that's a wrapper around virt-install but there's no compelling reason to keep it in virt-manager.git IMO """ Nothing has changed since then, so here is the removal. Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: virt-install: Improve --tpm docsCole Robinson2020-01-181-15/+4
| | | | | | | | | | * Stop listing sub options, since there's multiple, and most won't need to be specified. * Give an example for type=emulator Reported-by: Junqin Zhou <juzhou@redhat.com> Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: Document --autoconsoleCole Robinson2019-11-251-4/+27
| | | | Signed-off-by: Cole Robinson <crobinso@redhat.com>
* man: Document --cloud-init optionCole Robinson2019-11-251-0/+57
| | | | Signed-off-by: Cole Robinson <crobinso@redhat.com>
* unattended: Never use "root" as user-loginFabiano Fidêncio2019-11-201-0/+1
| | | | | | | | | | | When running virt-install as root, user-login would be automatically set to "root", causing an installation failure in the most part of the distros (if not all of them). In order to avoid such failures, let's raise a runtime error in case the user-login used is "root". Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
* unattended: Add option to set the user-loginFabiano Fidêncio2019-11-121-1/+7
| | | | | | | | | | | Let's allow setting the login of the guest user. Using the user from the system is a quite good fallback, but would break unattended installations when running virt-install as root. Thus, for those cases, it makes sense to have the option of setting the user login. Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
* man: virt-install: Fix a couple of launchSecurity related typosErik Skultety2019-08-141-3/+3
| | | | | Signed-off-by: Erik Skultety <eskultet@redhat.com> Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
* man: Document the --keywrap optionCole Robinson2019-07-282-0/+9
|
* unattended: Read the passwords from a fileFabiano Fidêncio2019-07-031-7/+17
| | | | | | | | | | | Let's not expose the user/root password in the CLI and, instead, let's rely on a file passed by the admin and read the password from there. 'CVE-2019-10183' has been assigned to the virt-install --unattended admin-password=xxx disclosure issue. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Fabiano Fidêncio <fidencio@redhat.com>
View Lorry Controller Status