diff options
| author | Cole Robinson <crobinso@redhat.com> | 2020-09-11 15:15:17 -0400 |
|---|---|---|
| committer | Cole Robinson <crobinso@redhat.com> | 2020-09-13 09:58:39 -0400 |
| commit | 65a39a74950722eecaf165a42bd743ec86b4ef63 (patch) | |
| tree | 35026c83e3e67d4b45d1a051780e218b4f962f74 /man | |
| parent | 8560138cf2269b8bc8f3cf657ed282a2ac9d499f (diff) | |
| download | virt-manager-65a39a74950722eecaf165a42bd743ec86b4ef63.tar.gz | |
man: Convert .pod files to .rst
Used pod2rst for the initial conversion but a lot of manual fixup
afterwards.
Signed-off-by: Cole Robinson <crobinso@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/virt-clone.pod | 227 | ||||
| -rw-r--r-- | man/virt-clone.rst | 241 | ||||
| -rw-r--r-- | man/virt-install.pod | 2053 | ||||
| -rw-r--r-- | man/virt-install.rst | 2143 | ||||
| -rw-r--r-- | man/virt-manager.pod | 107 | ||||
| -rw-r--r-- | man/virt-manager.rst | 110 | ||||
| -rw-r--r-- | man/virt-xml.pod | 437 | ||||
| -rw-r--r-- | man/virt-xml.rst | 441 |
8 files changed, 2935 insertions, 2824 deletions
diff --git a/man/virt-clone.pod b/man/virt-clone.pod deleted file mode 100644 index 01c414e2..00000000 --- a/man/virt-clone.pod +++ /dev/null @@ -1,227 +0,0 @@ -=pod - -=head1 NAME - -virt-clone - clone existing virtual machine images - -=head1 SYNOPSIS - -B<virt-clone> [OPTION]... - -=head1 DESCRIPTION - -B<virt-clone> is a command line tool for cloning existing virtual machine -images using the C<libvirt> hypervisor management library. It will copy -the disk images of any existing virtual machine, and define a new guest -with an identical virtual hardware configuration. Elements which require -uniqueness will be updated to avoid a clash between old and new guests. - -By default, virt-clone will show an error if the necessary information to -clone the guest is not provided. The --auto-clone option will generate -all needed input, aside from the source guest to clone. - -Please note, virt-clone does not change anything _inside_ the guest OS, it only duplicates disks and does host side changes. So things like changing passwords, changing static IP address, etc are outside the scope of this tool. For these types of changes, please see B<virt-sysprep>. - -=head1 GENERAL OPTIONS - -Most options are not required. Minimum requirements are --original or ---original-xml (to specify the guest to clone), --name, and appropriate -storage options via -file. - -=over 4 - -=item B<--connect> URI - -Connect to a non-default hypervisor. See L<virt-install(1)> for details - -=item B<-o> ORIGINAL_GUEST - -=item B<--original> ORIGINAL_GUEST - -Name of the original guest to be cloned. This guest must be shut off. - -=item B<--original-xml> ORIGINAL_XML - -Libvirt guest xml file to use as the original guest. The guest does not need to -be defined on the libvirt connection. This takes the place of the -C<--original> parameter. - -=item B<--auto-clone> - -Generate a new guest name, and paths for new storage. - -An example or possible generated output: - - Original name : MyVM - Generated clone name : MyVM-clone - - Original disk path : /home/user/foobar.img - Generated disk path : /home/user/foobar-clone.img - -If generated names collide with existing VMs or storage, a number is appended, -such as foobar-clone-1.img, or MyVM-clone-3. - -=item B<-n> NAME - -=item B<--name> NAME - -Name of the new guest virtual machine instance. This must be unique amongst -all guests known to the hypervisor connection, including those not -currently active. - -=item B<-u> UUID - -=item B<--uuid> UUID - -UUID for the guest; if none is given a random UUID will be generated. If you -specify UUID, you should use a 32-digit hexadecimal number. UUID are intended -to be unique across the entire data center, and indeed world. Bear this in -mind if manually specifying a UUID - -=item B<-f> DISKFILE - -=item B<--file> DISKFILE - -Path to the file, disk partition, or logical volume to use as the backing store -for the new guest's virtual disk. If the original guest has multiple disks, -this parameter must be repeated multiple times, once per disk in the original -virtual machine. - -=item B<--nvram> NVRAMFILE - -Optional path to the new nvram VARS file, if no path is specified and the -guest has nvram the new nvram path will be auto-generated. If the guest -doesn't have nvram this option will be ignored. - -=item B<--force-copy> TARGET - -Force cloning the passed disk target ('hdc', 'sda', etc.). By default, -C<virt-clone> will skip certain disks, such as those marked 'readonly' or -'shareable'. - -=item B<--skip-copy> TARGET - -Skip cloning the passed disk target ('hdc', 'sda', etc.). By default, -C<virt-clone> will clone certain disk images, typically read/write -devices. Use this to skip copying of a specific device, so the new -VM uses the same storage path as the original VM. - -=item B<--nonsparse> - -Fully allocate the new storage if the path being cloned is a sparse file. -See L<virt-install(1)> for more details on sparse vs. nonsparse. - -=item B<--preserve-data> - -No storage is cloned: disk images specific by --file are preserved as is, -and referenced in the new clone XML. This is useful if you want to clone -a VM XML template, but not the storage contents. - -=item B<--reflink> - -When --reflink is specified, perform a lightweight copy. This is much faster -if source images and destination images are all on the same btrfs filesystem. -If COW copy is not possible, then virt-clone fails. - -=item B<-m> MAC - -=item B<--mac> MAC - -Fixed MAC address for the guest; If this parameter is omitted, or the value -C<RANDOM> is specified a suitable address will be randomly generated. Addresses -are applied sequentially to the networks as they are listed in the original -guest XML. - -=item B<--print-xml> - -Print the generated clone XML and exit without cloning. - -=item B<--replace> - -Shutdown and remove any existing guest with the passed C<--name> before -cloning the original guest. - -=item B<-h> - -=item B<--help> - -Show the help message and exit - -=item B<--version> - -Show program's version number and exit - -=item B<--check> - -Enable or disable some validation checks. See L<virt-install(1)> for more details. - -=item B<-q> - -=item B<--quiet> - -Suppress non-error output. - -=item B<-d> - -=item B<--debug> - -Print debugging information to the terminal when running the install process. -The debugging information is also stored in -C<~/.cache/virt-manager/virt-clone.log> even if this parameter is omitted. - -=back - -=head1 EXAMPLES - -Clone the guest called C<demo> on the default connection, auto generating -a new name and disk clone path. - - # virt-clone \ - --original demo \ - --auto-clone - -Clone the guest called C<demo> which has a single disk to copy - - # virt-clone \ - --original demo \ - --name newdemo \ - --file /var/lib/xen/images/newdemo.img - -Clone a QEMU guest with multiple disks - - # virt-clone \ - --connect qemu:///system \ - --original demo \ - --name newdemo \ - --file /var/lib/xen/images/newdemo.img \ - --file /var/lib/xen/images/newdata.img - -Clone a guest to a physical device which is at least as big as the -original guests disks. If the destination device is bigger, the -new guest can do a filesystem resize when it boots. - - # virt-clone \ - --connect qemu:///system \ - --original demo \ - --name newdemo \ - --file /dev/HostVG/DemoVM \ - --mac 52:54:00:34:11:54 - -=head1 BUGS - -Please see L<https://virt-manager.org/bugs> - -=head1 COPYRIGHT - -Copyright (C) Fujitsu Limited, Copyright (C) Red Hat, Inc, -and various contributors. -This is free software. You may redistribute copies of it under the terms -of the GNU General Public License C<https://www.gnu.org/licenses/gpl.html>. -There is NO WARRANTY, to the extent permitted by law. - -=head1 SEE ALSO - -C<virt-sysprep(1)>, C<virsh(1)>, C<virt-install(1)>, C<virt-manager(1)>, the project website C<https://virt-manager.org> - -=cut - diff --git a/man/virt-clone.rst b/man/virt-clone.rst new file mode 100644 index 00000000..1d5d128c --- /dev/null +++ b/man/virt-clone.rst @@ -0,0 +1,241 @@ +========== +virt-clone +========== + +------------------------------------- +clone existing virtual machine images +------------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + + +SYNOPSIS +======== + + +``virt-clone`` [OPTION]... + + +DESCRIPTION +=========== + + +``virt-clone`` is a command line tool for cloning existing virtual machine +images using the ``libvirt`` hypervisor management library. It will copy +the disk images of any existing virtual machine, and define a new guest +with an identical virtual hardware configuration. Elements which require +uniqueness will be updated to avoid a clash between old and new guests. + +By default, virt-clone will show an error if the necessary information to +clone the guest is not provided. The --auto-clone option will generate +all needed input, aside from the source guest to clone. + +Please note, virt-clone does not change anything _inside_ the guest OS, it +only duplicates disks and does host side changes. So things like changing +passwords, changing static IP address, etc are outside the scope of this +tool. For these types of changes, please see ``virt-sysprep``. + + +GENERAL OPTIONS +=============== + +Most options are not required. Minimum requirements are --original or +--original-xml (to specify the guest to clone), --name, and appropriate +storage options via -file. + + +``--connect`` URI + Connect to a non-default hypervisor. See virt-install(1) for details + + +``-o``, ``--original`` ORIGINAL_GUEST + Name of the original guest to be cloned. This guest must be shut off. + + +``--original-xml`` ORIGINAL_XML + Libvirt guest xml file to use as the original guest. The guest does not need to + be defined on the libvirt connection. This takes the place of the + ``--original`` parameter. + + +``--auto-clone`` + Generate a new guest name, and paths for new storage. + + An example of possible generated output: + + .. code-block:: + + Original name : MyVM + Generated clone name : MyVM-clone + + Original disk path : /home/user/foobar.img + Generated disk path : /home/user/foobar-clone.img + + + If generated names collide with existing VMs or storage, a number is appended, + such as foobar-clone-1.img, or MyVM-clone-3. + + +``-n``, ``--name`` NAME + Name of the new guest virtual machine instance. This must be unique amongst + all guests known to the hypervisor connection, including those not + currently active. + + +``-u``, ``--uuid`` UUID + UUID for the guest; if none is given a random UUID will be generated. If you + specify UUID, you should use a 32-digit hexadecimal number. UUID are intended + to be unique across the entire data center, and indeed world. Bear this in + mind if manually specifying a UUID + + +``-f``, ``--file`` PATH + Path to the file, disk partition, or logical volume to use as the backing store + for the new guest's virtual disk. If the original guest has multiple disks, + this parameter must be repeated multiple times, once per disk in the original + virtual machine. + + +``--nvram`` NVRAMFILE + Optional path to the new nvram VARS file, if no path is specified and the + guest has nvram the new nvram path will be auto-generated. If the guest + doesn't have nvram this option will be ignored. + +``--force-copy`` TARGET + Force cloning the passed disk target ('hdc', 'sda', etc.). By default, + ``virt-clone`` will skip certain disks, such as those marked 'readonly' or + 'shareable'. + + +``--skip-copy`` TARGET + Skip cloning the passed disk target ('hdc', 'sda', etc.). By default, + ``virt-clone`` will clone certain disk images, typically read/write + devices. Use this to skip copying of a specific device, so the new + VM uses the same storage path as the original VM. + + +``--nonsparse`` + Fully allocate the new storage if the path being cloned is a sparse file. + See virt-install(1) for more details on sparse vs. nonsparse. + + +``--preserve-data`` + No storage is cloned: disk images specific by --file are preserved as is, + and referenced in the new clone XML. This is useful if you want to clone + a VM XML template, but not the storage contents. + + +``--reflink`` + When --reflink is specified, perform a lightweight copy. This is much faster + if source images and destination images are all on the same btrfs filesystem. + If COW copy is not possible, then virt-clone fails. + + +``-m``, ``--mac`` MAC + Fixed MAC address for the guest; If this parameter is omitted, or the value + ``RANDOM`` is specified a suitable address will be randomly generated. Addresses + are applied sequentially to the networks as they are listed in the original + guest XML. + + +``--print-xml`` + Print the generated clone XML and exit without cloning. + + +``--replace`` + Shutdown and remove any existing guest with the passed ``--name`` before + cloning the original guest. + + +``-h``, ``--help`` + Show the help message and exit + + +``--version`` + Show program's version number and exit + + +``--check`` + Enable or disable some validation checks. See virt-install(1) for more details. + + +``-q``, ``--quiet`` + Suppress non-error output. + + +``-d``, ``--debug`` + Print debugging information to the terminal when running the install process. + The debugging information is also stored in + ``~/.cache/virt-manager/virt-clone.log`` even if this parameter is omitted. + + +EXAMPLES +======== + +Clone the guest called ``demo`` on the default connection, auto generating +a new name and disk clone path. + +.. code-block:: + + # virt-clone \ + --original demo \ + --auto-clone + + +Clone the guest called ``demo`` which has a single disk to copy + +.. code-block:: + + # virt-clone \ + --original demo \ + --name newdemo \ + --file /var/lib/xen/images/newdemo.img + + +Clone a QEMU guest with multiple disks + +.. code-block:: + + # virt-clone \ + --connect qemu:///system \ + --original demo \ + --name newdemo \ + --file /var/lib/xen/images/newdemo.img \ + --file /var/lib/xen/images/newdata.img + + +Clone a guest to a physical device which is at least as big as the +original guests disks. If the destination device is bigger, the +new guest can do a filesystem resize when it boots. + +.. code-block:: + + # virt-clone \ + --connect qemu:///system \ + --original demo \ + --name newdemo \ + --file /dev/HostVG/DemoVM \ + --mac 52:54:00:34:11:54 + + +BUGS +==== + +Please see https://virt-manager.org/bugs + + +COPYRIGHT +========= + +Copyright (C) Fujitsu Limited, Copyright (C) Red Hat, Inc, +and various contributors. +This is free software. You may redistribute copies of it under the terms +of the GNU General Public License https://www.gnu.org/licenses/gpl.html. +There is NO WARRANTY, to the extent permitted by law. + + +SEE ALSO +======== + +``virt-sysprep(1)``, ``virsh(1)``, ``virt-install(1)``, ``virt-manager(1)``, the project website https://virt-manager.org diff --git a/man/virt-install.pod b/man/virt-install.pod deleted file mode 100644 index 5153e5a0..00000000 --- a/man/virt-install.pod +++ /dev/null @@ -1,2053 +0,0 @@ -=pod - -=head1 NAME - -virt-install - provision new virtual machines - -=head1 SYNOPSIS - -B<virt-install> [OPTION]... - -=head1 DESCRIPTION - -B<virt-install> is a command line tool for creating new KVM, Xen, or Linux -container guests using the C<libvirt> hypervisor management library. -See the EXAMPLES section at the end of this document to quickly get started. - -B<virt-install> tool supports graphical installations using (for example) -VNC or SPICE, as well as text mode installs over serial console. The guest -can be configured to use one or more virtual disks, network interfaces, -audio devices, physical USB or PCI devices, among others. - -The installation media can be local ISO or CDROM media, or a distro install -tree hosted remotely over HTTP, FTP, or in a local directory. In the install -tree case C<virt-install> will fetch the minimal files -necessary to kick off the installation process, allowing the guest -to fetch the rest of the OS distribution as needed. PXE booting, and importing -an existing disk image (thus skipping the install phase) are also supported. - -Given suitable command line arguments, C<virt-install> is capable of running -completely unattended, with the guest 'kickstarting' itself too. This allows -for easy automation of guest installs. This can be done manually, or more -simply with the --unattended option. - -Many arguments have sub options, specified like opt1=foo,opt2=bar, etc. Try ---option=? to see a complete list of sub options associated with that -argument, example: virt-install --disk=? - -Most options are not required. If a suitable --os-variant value is specified -or detected, all defaults will be filled in and reported in the terminal -output. If an --os-variant is not specified. minimum required options, --memory, -guest storage (--disk or --filesystem), and an install method choice. - - -=head1 CONNECTING TO LIBVIRT - -=over 4 - -=item B<--connect> URI - -Connect to a non-default hypervisor. If this isn't specified, libvirt -will try and choose the most suitable default. - -Some valid options here are: - -=over 4 - -=item qemu:///system - -For creating KVM and QEMU guests to be run by the system libvirtd instance. -This is the default mode that virt-manager uses, and what most KVM users -want. - -=item qemu:///session - -For creating KVM and QEMU guests for libvirtd running as the regular user. - -=item xen:/// - -For connecting to Xen. - -=item lxc:/// - -For creating linux containers - -=back - -=back - - - - -=head1 GENERAL OPTIONS - -General configuration parameters that apply to all types of guest installs. - -=over 4 - -=item B<-n> NAME - -=item B<--name> NAME - -Name of the new guest virtual machine instance. This must be unique amongst -all guests known to the hypervisor on the connection, including those not -currently active. To re-define an existing guest, use the C<virsh(1)> tool -to shut it down ('virsh shutdown') & delete ('virsh undefine') it prior to -running C<virt-install>. - -=item B<--memory> OPTIONS - -Memory to allocate for the guest, in MiB. This deprecates the -r/--ram option. -Sub options are available, like 'memory', 'currentMemory', 'maxMemory' -and 'maxMemory.slots', which all map to the identically named XML values. - -Back compat values 'memory' maps to the <currentMemory> element, and maxmemory -maps to the <memory> element. - -To configure memory modules which can be hotunplugged see B<--memdev> description. - -Use --memory=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMemoryAllocation> - -=item B<--memorybacking> OPTIONS - -This option will influence how virtual memory pages are backed by host pages. - -Use --memorybacking=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMemoryBacking> - -=item B<--arch> ARCH - -Request a non-native CPU architecture for the guest virtual machine. -If omitted, the host CPU architecture will be used in the guest. - -=item B<--machine> MACHINE - -The machine type to emulate. This will typically not need to be specified -for Xen or KVM, but is useful for choosing machine types of more exotic -architectures. - -=item B<--metadata> OPT=VAL,[...] - -Specify metadata values for the guest. Possible options include name, uuid, title, and description. This option deprecates -u/--uuid and --description. - -Use --metadata=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMetadata> - -=item B<--events> OPT=VAL,[...] - -Specify events values for the guest. Possible options include on_poweroff, on_reboot, and on_crash. - -Use --events=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsEvents> - -=item B<--resource> OPT=VAL,[...] - -Specify resource partitioning for the guest. - -Use --resource=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#resPartition> - -=item B<--sysinfo> OPT=VAL,[...] - -Configure sysinfo/SMBIOS values exposed to the VM OS. - -Some examples: - -=over 4 - -=item B<--sysinfo host> - -Special type that exposes the host's SMBIOS info into the VM. - -=item B<--sysinfo emulate> - -Special type where hypervisor will generate SMBIOS info into the VM. - -=item B<--sysinfo bios.vendor=custom> or B<--sysinfo smbios,bios.vendor=custom> - -The default type is B<smbios> and allows users to specify SMBIOS info manually. - -=back - -Use --sysinfo=? to see a list of all available sub options. - -Complete details at L<https://libvirt.org/formatdomain.html#elementsSysinfo> -and L<https://libvirt.org/formatdomain.html#elementsOSBIOS> for B<smbios> XML element. - -=item B<--xml> ARGS - -Make direct edits to the generated XML using XPath syntax. Take an example like - - virt-install --xml ./@foo=bar --xml ./newelement/subelement=1 - -This will alter the generated XML to contain: - - <domain foo='bar' ...> - ... - <newelement> - <subelement>1</subelement> - </newelement> - </domain> - -The --xml option has 4 sub options: - -=over 2 - -=item --xml xpath.set=XPATH[=VALUE] - -The default behavior if no explicit suboption is set. Takes the form XPATH=VALUE -unless paired with B<xpath.value>. See below for how value is interpreted. - -=item --xml xpath.value=VALUE - -B<xpath.set> will be interpreted only as the XPath string, and B<xpath.value> will -be used as the value to set. May help sidestep problems if the string you need to -set contains a '=' equals sign. - -If value is empty, it's treated as unsetting that particular node. - -=item --xml xpath.create=XPATH - -Create the node as an empty element. Needed for boolean elements like <readonly/> - -=item --xml xpath.delete=XPATH - -Delete the entire node specified by the xpath, and all its children - -=back - -=item B<--qemu-commandline> ARGS - -Pass options directly to the qemu emulator. Only works for the libvirt qemu driver. The option can take a string of arguments, for example: - - --qemu-commandline="-display gtk,gl=on" - -Environment variables are specified with 'env', for example: - - --qemu-commandline=env=DISPLAY=:0.1 - -Complete details about the libvirt feature: L<https://libvirt.org/drvqemu.html#qemucommand> - -=item B<--vcpus> OPTIONS - -Number of virtual cpus to configure for the guest. If 'maxvcpus' is specified, -the guest will be able to hotplug up to MAX vcpus while the guest is running, -but will startup with VCPUS. - -CPU topology can additionally be specified with sockets, cores, and threads. -If values are omitted, the rest will be autofilled preferring sockets over -cores over threads. - -'cpuset' sets which physical cpus the guest can use. C<CPUSET> is a comma separated list of numbers, which can also be specified in ranges or cpus to exclude. Example: - - 0,2,3,5 : Use processors 0,2,3 and 5 - 1-5,^3,8 : Use processors 1,2,4,5 and 8 - -If the value 'auto' is passed, virt-install attempts to automatically determine -an optimal cpu pinning using NUMA data, if available. - -Use --vcpus=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCPUAllocation> - -=item B<--numatune> OPTIONS - -Tune NUMA policy for the domain process. Example invocations - - --numatune 1,2,3,4-7 - --numatune 1-3,5,memory.mode=preferred - -Specifies the numa nodes to allocate memory from. This has the same syntax -as C<--vcpus cpuset=> option. mode can be one of 'interleave', 'preferred', or -'strict' (the default). See 'man 8 numactl' for information about each -mode. - -Use --numatune=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsNUMATuning> - -=item B<--memtune> OPTIONS - -Tune memory policy for the domain process. Example invocations - - --memtune 1000 - --memtune hard_limit=100,soft_limit=60,swap_hard_limit=150,min_guarantee=80 - -Use --memtune=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMemoryTuning> - -=item B<--blkiotune> OPTIONS - -Tune blkio policy for the domain process. Example invocations - - --blkiotune 100 - --blkiotune weight=100,device.path=/dev/sdc,device.weight=200 - -Use --blkiotune=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsBlockTuning> - -=item B<--cpu> MODEL[,+feature][,-feature][,match=MATCH][,vendor=VENDOR],... - -Configure the CPU model and CPU features exposed to the guest. The only -required value is MODEL, which is a valid CPU model as known to libvirt. - -Libvirt's feature policy values force, require, optional, disable, or forbid, -or with the shorthand '+feature' and '-feature', which equal 'force=feature' -and 'disable=feature' respectively. - -If exact CPU model is specified virt-install will automatically copy CPU -features available on the host to mitigate recent CPU speculative execution -side channel and Microarchitectural Store Buffer Data security vulnerabilities. -This however will have some impact on performance and will break migration -to hosts without security patches. In order to control this behavior there -is a B<secure> parameter. Possible values are I<on> and I<off>, with I<on> -as the default. It is highly recommended to leave this enabled and ensure all -virtualization hosts have fully up to date microcode, kernel & virtualization -software installed. - -Some examples: - -=over 4 - -=item B<--cpu core2duo,+x2apic,disable=vmx> - -Expose the core2duo CPU model, force enable x2apic, but do not expose vmx - -=item B<--cpu host> - -Expose the host CPUs configuration to the guest. This enables the guest to -take advantage of many of the host CPUs features (better performance), but -may cause issues if migrating the guest to a host without an identical CPU. - -=item B<--cpu host-model-only> - -Expose the nearest host CPU model configuration to the guest. -It is the best CPU which can be used for a guest on any of the hosts. - -=item B<--cpu numa.cell0.memory=1234,numa.cell0.cpus=0-3,numa.cell1.memory=5678,numa.cell1.cpus=4-7> - -Example of specifying two NUMA cells. This will generate XML like: - - <cpu> - <numa> - <cell cpus="0-3" memory="1234"/> - <cell cpus="4-7" memory="5678"/> - </numa> - </cpu> - -=item B<--cpu host-passthrough,cache.mode=passthrough> - -Example of passing through the host cpu's cache information. - -=back - -Use --cpu=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCPU> - -=item B<--cputune> OPTIONS - -Tune CPU parameters for the guest. - -Configure which of the host's physical CPUs the domain VCPU will be pinned to. Example invocation - - --cputune vcpupin0.vcpu=0,vcpupin0.cpuset=0-3,vcpupin1.vcpu=1,vcpupin1.cpuset=4-7 - -Use --cputune=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCPUTuning> - -=item B<--security>/B<--seclabel> type=TYPE[,label=LABEL][,relabel=yes|no],... - -Configure domain seclabel domain settings. Type can be either 'static' or -'dynamic'. 'static' configuration requires a security LABEL. Specifying -LABEL without TYPE implies static configuration. - -Use --security=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#seclabel> - - -=item B<--keywrap> OPTIONS - -Specify domain <keywrap> XML, used for S390 cryptographic key management operations. - -Use --keywrap=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#keywrap> - - -=item B<--iothreads> OPTIONS - -Specify domain <iothreads> and/or <iothreadids> XML. For example, to configure <iothreads>4</iothreads>, do: - - --iothreads 4 - -Use --iothreads=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsIOThreadsAllocation> - - -=item B<--features> FEAT=on|off,... - -Set elements in the guests <features> XML on or off. Examples include acpi, -apic, eoi, privnet, and hyperv features. Some examples: - -=over 4 - -=item B<--features apic.eoi=on> - -Enable APIC PV EOI - -=item B<--features hyperv.vapic.state=on,hyperv.spinlocks.state=off> - -Enable hypver VAPIC, but disable spinlocks - -=item B<--features kvm.hidden.state=on> - -Allow the KVM hypervisor signature to be hidden from the guest - -=item B<--features pvspinlock=on> - -Notify the guest that the host supports paravirtual spinlocks for example by exposing the pvticketlocks mechanism. - -=item B<--features gic.version=2> - -This is relevant only for ARM architectures. Possible values are "host" or -version number. - -=item B<--features smm.state=on> - -This enables System Management Mode of hypervisor. Some UEFI firmwares may -require this feature to be present. (QEMU supports SMM only with q35 machine -type.) - -=back - -Use --features=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsFeatures> - -=item B<--clock> offset=OFFSET,TIMER_OPT=VAL,... - -Configure the guest's <clock> XML. Some supported options: - -=over 4 - -=item B<--clock offset=OFFSET> - -Set the clock offset, ex. 'utc' or 'localtime' - -=item B<--clock TIMER_present=no> - -Disable a boolean timer. TIMER here might be hpet, kvmclock, etc. - -=item B<--clock TIMER_tickpolicy=VAL> - -Set a timer's tickpolicy value. TIMER here might be rtc, pit, etc. VAL -might be catchup, delay, etc. Refer to the libvirt docs for all values. - -=back - -Use --clock=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsTime> - - -=item B<--pm> OPTIONS - -Configure guest power management features. Example: - - --pm suspend_to_memi.enabled=on,suspend_to_disk.enabled=off - -Use --pm=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsPowerManagement> - -=item B<--launchSecurity> TYPE[,OPTS] - -Enable launch security for the guest, e.g. AMD SEV. - -Use --launchSecurity=? to see a list of all available sub options. Complete -details at L<https://libvirt.org/formatdomain.html#launchSecurity>. Example -invocations: - # This will use a default policy 0x03 - # No dhCert provided, so no data can be exchanged with the SEV firmware - --launchSecurity sev - - # Explicit policy 0x01 - disables debugging, allows guest key sharing - --launchSecurity sev,policy=0x01 - - # Provide the session blob obtained from the SEV firmware - # Provide dhCert to open a secure communication channel with SEV firmware - --launchSecurity sev,session=BASE64SESSIONSTRING,dhCert=BASE64DHCERTSTRING - -SEV has further implications on usage of virtio devices, so refer to EXAMPLES -section to see a full invocation of virt-install with --launchSecurity. - -=back - -=head1 INSTALLATION OPTIONS - -=over 4 - -=item B<-c>, B<--cdrom> PATH - -ISO file or CDROM device to use for VM install media. After install, -the the virtual CDROM device will remain attached to the VM, but with -the ISO or host path media ejected. - -=item B<-l>, B<--location> OPTIONS - -Distribution tree installation source. virt-install can recognize -certain distribution trees and fetches a bootable kernel/initrd pair to -launch the install. - ---location allows things like --extra-args for kernel arguments, -and using --initrd-inject. If you want to use those options with CDROM media, -you can pass the ISO to --location as well which works for some, but not -all, CDROM media. - -The C<LOCATION> can take one of the following forms: - -=over 4 - -=item https://host/path - -An HTTP server location containing an installable distribution image. - -=item ftp://host/path - -An FTP server location containing an installable distribution image. - -=item ISO - -Probe the ISO and extract files using 'isoinfo' - -=item DIRECTORY - -Path to a local directory containing an installable distribution image. Note that the directory will not be accessible by the guest after initial boot, so the OS installer will need another way to access the rest of the install media. - -=back - -Some distro specific url samples: - -=over 4 - -=item Fedora/Red Hat Based - -https://download.fedoraproject.org/pub/fedora/linux/releases/29/Server/x86_64/os - -=item Debian - -https://ftp.us.debian.org/debian/dists/stable/main/installer-amd64/ - -=item Ubuntu - -https://us.archive.ubuntu.com/ubuntu/dists/wily/main/installer-amd64/ - -=item Suse - -https://download.opensuse.org/pub/opensuse/distribution/leap/42.3/repo/oss/ - -=back - -Additionally, --location can take 'kernel' and 'initrd' sub options. These paths -relative to the specified location URL/ISO that allow selecting specific files -for kernel/initrd within the install tree. This can be useful if virt-install/ -libosinfo doesn't know where to find the kernel in the specified --location. - -For example, if you have an ISO that libosinfo doesn't know about called -my-unknown.iso, with a kernel at 'kernel/fookernel' and initrd at -'kernel/fooinitrd', you can make this work with: - - --location my-unknown.iso,kernel=kernel/fookernel,initrd=kernel/fooinitrd - -=item B<--pxe> - -Install from PXE. This just tells the VM to boot off the network -for the first boot. - -=item B<--import> - -Skip the OS installation process, and build a guest around an existing -disk image. The device used for booting is the first device specified via -C<--disk> or C<--filesystem>. - -=item B<-x>, B<--extra-args> KERNELARGS - -Additional kernel command line arguments to pass to the installer when -performing a guest install from C<--location>. One common usage is specifying -an anaconda kickstart file for automated installs, such as ---extra-args "ks=https://myserver/my.ks" - -=item B<--initrd-inject> PATH - -Add PATH to the root of the initrd fetched with C<--location>. This can be -used to run an automated install without requiring a network hosted kickstart -file: - ---initrd-inject=/path/to/my.ks --extra-args "ks=file:/my.ks" - - - -=item B<--install> - -This is a larger entry point for various types of install operations. The -command has multiple subarguments, similar to --disk and friends. This -option is strictly for VM install operations, essentially configuring the -first boot. - -The simplest usage to ex: install fedora29 is: - - --install fedora29 - -And virt-install will fetch a --location URL from libosinfo, and populate -defaults from there. - -Available suboptions: - -=over 4 - -=item B<os=> - -This is os install option described above. The explicit way to specify that -would be B<--install os=fedora29>. os= is the default option if none is -specified - -=item B<kernel=>, B<initrd=> - -Specify a kernel and initrd pair to use as install media. They are copied -into a temporary location before booting the VM, so they can be combined -with --initrd-inject and your source media will not be altered. Media -will be uploaded to a remote connection if required. - -Example case using local filesystem paths: - --install kernel=/path/to/kernel,initrd=/path/to/initrd - -Example using network paths. Kernel/initrd will be downloaded locally first, -then passed to the VM as local filesystem paths - --install kernel=https://127.0.0.1/tree/kernel,initrd=https://127.0.0.1/tree/initrd - -Note, these are just for install time booting. If you want to set the kernel -used for permanent VM booting, use the B<--boot> option. - -=item B<kernel_args=>, B<kernel_args_overwrite=yes|no> - -Specify install time kernel arguments (libvirt <cmdline> XML). These can -be combine with ex: kernel/initrd options, or B<--location> media. By -default, kernel_args is just like --extra-args, and will _append_ to -the arguments that virt-install will try to set by default for most ---location installs. If you want to override the virt-install default, -additionally specify kernel_args_overwrite=yes - -=item B<bootdev=> - -Specify the install bootdev (hd, cdrom, floppy, network) to boot off of -for the install phase. This maps to libvirt <os><boot dev=X> XML. - -If you want to install off a cdrom or network, it's probably simpler -and more backwards compatible to just use B<--cdrom> or B<--pxe>, but -this options gives fine grained control over the install process if -needed. - -=item B<no_install=yes|no> - -Tell virt-install that there isn't actually any install happening, -and you just want to create the VM. B<--import> is just an alias -for this, as is specifying B<--boot> without any other install -options. The deprecated B<--live> option is the same as -'--cdrom $ISO --install no_install=yes' - -=back - - -=item B<--reinstall DOMAIN> - -Reinstall an existing VM. DOMAIN can be a VM name, UUID, or ID number. -virt-install will fetch the domain XML from libvirt, apply the specified -install config changes, boot the VM for the install process, and then -revert to roughly the same starting XML. - -Only install related options are processed, all other VM configuration -options like --name, --disk, etc. are completely ignored. - -If --reinstall is used with --cdrom, an existing CDROM attached to -the VM will be used if one is available, otherwise a permanent CDROM -device will be added. - - -=item B<--unattended> [OPTIONS] - -Perform an unattended install using libosinfo's install script support. -This is essentially a database of auto install scripts for various -distros: Red Hat kickstarts, Debian installer scripting, Windows -unattended installs, and potentially others. The simplest invocation -is to combine it with --install like: - - --install fedora29 --unattended - -A Windows install will look like - - --cdrom /path/to/my/windows.iso --unattended - -Sub options are: - -=over 4 - -=item B<profile=> - -Choose which libosinfo unattended profile to use. Most distros have -a 'desktop' and a 'jeos' profile. virt-install will default to 'desktop' -if this is unspecified. - -=item B<admin-password-file=> - -A file used to set the VM OS admin/root password from. This option can -be used either as "admin-password-file=/path/to/password-file" or as -"admin-password-file=/dev/fd/n", being n the file descriptor of the -password-file. -Note that only the first line of the file will be considered, including -any whitespace characters and excluding new-line. - -=item B<user-login=> - -The user login name to be used in th VM. virt-install will default to your -current host username if this is unspecified. -Note that when running virt-install as "root", this option must be specified. - -=item B<user-password-file=> - -A file used to set the VM user password. This option can be used either as -"user-password-file=/path/to/password-file" or as -"user-password-file=/dev/fd/n", being n the file descriptor of the -password-file. The username is either the user-login specified or your current -host username. -Note that only the first line of the file will be considered, including -any whitespace characters and excluding new-line. - -=item B<product-key=> - -Set a Windows product key - -=back - - -=item B<--cloud-init> - -Pass cloud-init metadata to the VM. A cloud-init NoCloud ISO file is generated, -and attached to the VM as a CDROM device. The device is only attached for the -first boot. This option is particularly useful for distro cloud images, which -have locked login accounts by default; --cloud-init provides the means to -initialize those login accounts, like setting a root password. - -The simplest invocation is just plain B<--cloud-init> with no suboptions; -this maps to `--cloud-init root-password-generate=on,disable=on`. See those -suboptions for explanation of how they work. - -Use --cloud-init=? to see a list of all available sub options. - -Sub options are: - -=over 4 - -=item B<root-password-generate=on> - -Generate a new root password for the VM. When used, virt-install will -print the generated password to the console, and pause for 10 seconds -to give the user a chance to notice it and copy it. - -=item B<disable=on> - -Disable cloud-init in the VM for subsequent boots. Without this, -cloud-init may reset auth on each boot. - -=item B<root-password-file=> - -A file used to set the VM root password from. This option can -be used either as "root-password-file=/path/to/password-file" or as -"root-password-file=/dev/fd/n", being n the file descriptor of the -password-file. -Note that only the first line of the file will be considered, including -any whitespace characters and excluding new-line. - -=item B<meta-data=> - -Specify a cloud-init meta-data file to add directly to the iso. All other -meta-data configuration options on the --cloud-init command line are ignored. - -=item B<user-data=> - -Specify a cloud-init user-data file to add directly to the iso. All other -user-data configuration options on the --cloud-init command line are ignored. - -=item B<ssh-key=> - -Specify a public key to inject into the guest, providing ssh access to the -unprivileged account. Example: ssh-key=/home/user/.ssh/id_rsa.pub - -=back - - - - -=item B<--boot> BOOTOPTS - -Optionally specify the post-install VM boot configuration. This option allows -specifying a boot device order, permanently booting off kernel/initrd with -option kernel arguments, and enabling a BIOS boot menu (requires libvirt -0.8.3 or later) - ---boot can be specified in addition to other install options -(such as --location, --cdrom, etc.) or can be specified on its own. In -the latter case, behavior is similar to the --import install option: there -is no 'install' phase, the guest is just created and launched as specified. - -Some examples: - -=over 4 - -=item B<--boot cdrom,fd,hd,network> - -Set the boot device priority as first cdrom, first floppy, first harddisk, -network PXE boot. - -=item B<--boot kernel=KERNEL,initrd=INITRD,kernel_args="console=/dev/ttyS0"> - -Have guest permanently boot off a local kernel/initrd pair, with the -specified kernel options. - -=item B<--boot kernel=KERNEL,initrd=INITRD,dtb=DTB> - -Have guest permanently boot off a local kernel/initrd pair with an -external device tree binary. DTB can be required for some non-x86 -configurations like ARM or PPC - -=item B<--boot loader=BIOSPATH> - -Use BIOSPATH as the virtual machine BIOS. - -=item B<--boot bootmenu.enable=on,bios.useserial=on> - -Enable the bios boot menu, and enable sending bios text output over -serial console. - -=item B<--boot init=INITPATH> - -Path to a binary that the container guest will init. If a root C<--filesystem> -has been specified, virt-install will default to /sbin/init, otherwise -will default to /bin/sh. - -=item B<--boot uefi> - -Configure the VM to boot from UEFI. In order for virt-install to know the -correct UEFI parameters, libvirt needs to be advertising known UEFI binaries -via domcapabilities XML, so this will likely only work if using properly -configured distro packages. - -=item B<--boot loader=/.../OVMF_CODE.fd,loader.readonly=yes,loader.type=pflash,nvram.template=/.../OVMF_VARS.fd,loader_secure=no> - -Specify that the virtual machine use the custom OVMF binary as boot firmware, -mapped as a virtual flash chip. In addition, request that libvirt instantiate -the VM-specific UEFI varstore from the custom "/.../OVMF_VARS.fd" varstore -template. This is the recommended UEFI setup, and should be used if ---boot uefi doesn't know about your UEFI binaries. If your UEFI firmware -supports Secure boot feature you can enable it via loader_secure. - -=back - -Use --boot=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsOS> - -=item B<--idmap> OPTIONS - -If the guest configuration declares a UID or GID mapping, -the 'user' namespace will be enabled to apply these. -A suitably configured UID/GID mapping is a pre-requisite to -make containers secure, in the absence of sVirt confinement. - ---idmap can be specified to enable user namespace for LXC containers. Example: - - --idmap uid.start=0,uid.target=1000,uid.count=10,gid.start=0,gid.target=1000,gid.count=10 - -Use --idmap=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsOSContainer> - -=back - - - - -=head1 GUEST OS OPTIONS - -=over 4 - -=item B<--os-variant> OS_VARIANT - -Optimize the guest configuration for a specific operating system (ex. -'fedora29', 'rhel7', 'win10'). While not required, specifying this -options is HIGHLY RECOMMENDED, as it can greatly increase performance -by specifying virtio among other guest tweaks. - -By default, virt-install will attempt to auto detect this value from -the install media (currently only supported for URL installs). Autodetection -can be disabled with the special value 'none'. Autodetection can be -forced with the special value 'auto'. - -Use the command "osinfo-query os" to get the list of the accepted OS -variants. - -=back - - - - -=head1 STORAGE OPTIONS - -=over 4 - -=item B<--disk> OPTIONS - -Specifies media to use as storage for the guest, with various options. The -general format of a disk string is - - --disk opt1=val1,opt2=val2,... - -The simplest invocation to create a new 10G disk image and associated disk device: - - --disk size=10 - -virt-install will generate a path name, and place it in the default image location for the hypervisor. To specify media, the command can either be: - - --disk /some/storage/path[,opt1=val1]... - -or explicitly specify one of the following arguments: - -=over 4 - -=item B<path> - -A path to some storage media to use, existing or not. Existing media can be -a file or block device. - -Specifying a non-existent path implies attempting to create the new storage, -and will require specifying a 'size' value. Even for remote hosts, virt-install -will try to use libvirt storage APIs to automatically create the given path. - -If the hypervisor supports it, B<path> can also be a network URL, like -https://example.com/some-disk.img . For network paths, they hypervisor will -directly access the storage, nothing is downloaded locally. - -=item B<pool> - -An existing libvirt storage pool name to create new storage on. Requires -specifying a 'size' value. - -=item B<vol> - -An existing libvirt storage volume to use. This is specified as -'poolname/volname'. - -=back - - - -Options that apply to storage creation: - -=over 4 - -=item B<size> - -size (in GiB) to use if creating new storage - -=item B<sparse> - -whether to skip fully allocating newly created storage. Value is 'yes' or -'no'. Default is 'yes' (do not fully allocate) unless it isn't -supported by the underlying storage type. - -The initial time taken to fully-allocate the guest virtual disk (sparse=no) -will be usually balanced by faster install times inside the guest. Thus -use of this option is recommended to ensure consistently high performance -and to avoid I/O errors in the guest should the host filesystem fill up. - -=item B<format> - -Disk image format. For file volumes, this can be 'raw', 'qcow2', 'vmdk', etc. See format types in L<https://libvirt.org/storage.html> for possible values. This is often mapped to the B<driver_type> value as well. - -If not specified when creating file images, this will default to 'qcow2'. - -If creating storage, this will be the format of the new image. If using an existing image, this overrides libvirt's format auto-detection. - -=item B<backing_store> - -Path to a disk to use as the backing store for the newly created image. - -=item B<backing_format> - -Disk image format of B<backing_store> - -=back - - - -Some example device configuration suboptions: - -=over 4 - -=item B<device> - -Disk device type. Example values are be 'cdrom', 'disk', 'lun' or 'floppy'. The default is 'disk'. - -=item B<boot.order> - -Guest installation with multiple disks will need this parameter to boot correctly after being installed. A boot.order parameter will take values 1,2,3,... Devices with lower value has higher priority. -This option applies to other bootable device types as well. - -=item B<target.bus> or B<bus> - -Disk bus type. Example values are be 'ide', 'sata', 'scsi', 'usb', 'virtio' or 'xen'. -The default is hypervisor dependent since not all hypervisors support all -bus types. - -=item B<readonly> - -Set drive as readonly (takes 'on' or 'off') - -=item B<shareable> - -Set drive as shareable (takes 'on' or 'off') - -=item B<cache> - -The cache mode to be used. The host pagecache provides cache memory. -The cache value can be 'none', 'writethrough', 'directsync', 'unsafe' -or 'writeback'. -'writethrough' provides read caching. 'writeback' provides -read and write caching. 'directsync' bypasses the host page -cache. 'unsafe' may cache all content and ignore flush requests from -the guest. - -=item B<driver.discard> - -Whether discard (also known as "trim" or "unmap") requests are ignored -or passed to the filesystem. The value can be either "unmap" (allow -the discard request to be passed) or "ignore" (ignore the discard -request). Since 1.0.6 (QEMU and KVM only) - -=item B<driver.name> - -Driver name the hypervisor should use when accessing the specified -storage. Typically does not need to be set by the user. - -=item B<driver.type> - -Driver format/type the hypervisor should use when accessing the specified -storage. Typically does not need to be set by the user. - -=item B<driver.io> - -Disk IO backend. Can be either "threads", "native" or "io_uring". - -=item B<driver.error_policy> - -How guest should react if a write error is encountered. Can be one of -"stop", "ignore", or "enospace" - -=item B<serial> - -Serial number of the emulated disk device. This is used in linux guests -to set /dev/disk/by-id symlinks. An example serial number might be: -WD-WMAP9A966149 - -=item B<source.startupPolicy> - -It defines what to do with the disk if the source file is not accessible. See -possible values in L<https://www.libvirt.org/formatdomain.html#elementsDisks>, "startupPolicy" attribute of the <disk> element - -=item B<snapshot> - -Defines default behavior of the disk during disk snapshots. See possible -values in L<https://www.libvirt.org/formatdomain.html#elementsDisks>, -"snapshot" attribute of the <disk> element. - -=back - -See the examples section for some uses. This option deprecates -f/--file, --s/--file-size, --nonsparse, and --nodisks. - -Use --disk=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsDisks> - - - - -=item B<--filesystem> - -Specifies a directory on the host to export to the guest. The most simple -invocation is: - - --filesystem /source/on/host,/target/point/in/guest - -Which will work for recent QEMU and linux guest OS or LXC containers. For -QEMU, the target point is just a mounting hint in sysfs, so will not be -automatically mounted. - -Some example suboptions: - -=over 4 - -=item B<type> - -The type or the source directory. Valid values are 'mount' (the default) or -'template' for OpenVZ templates. - -=item B<accessmode> or B<mode> - -The access mode for the source directory from the guest OS. Only used with -QEMU and type=mount. Valid modes are 'passthrough' (the default), 'mapped', -or 'squash'. See libvirt domain XML documentation for more info. - -=item B<source> - -The directory on the host to share. - -=item B<target> - -The mount location to use in the guest. - -=back - -Use --filesystem=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsFilesystems> - -=back - - - - - -=head1 NETWORKING OPTIONS - -=over 4 - -=item B<-w> OPTIONS - -=item B<--network> OPTIONS - -Connect the guest to the host network. The value for C<NETWORK> can take -one of 4 formats: - -=over 4 - -=item bridge=BRIDGE - -Connect to a bridge device in the host called C<BRIDGE>. Use this option if -the host has static networking config & the guest requires full outbound -and inbound connectivity to/from the LAN. Also use this if live migration -will be used with this guest. - -=item network=NAME - -Connect to a virtual network in the host called C<NAME>. Virtual networks -can be listed, created, deleted using the C<virsh> command line tool. In -an unmodified install of C<libvirt> there is usually a virtual network -with a name of C<default>. Use a virtual network if the host has dynamic -networking (eg NetworkManager), or using wireless. The guest will be -NATed to the LAN by whichever connection is active. - -=item type=direct,source=IFACE[,source.mode=MODE] - -Direct connect to host interface IFACE using macvtap. - -=item user - -Connect to the LAN using SLIRP. Only use this if running a QEMU guest as -an unprivileged user. This provides a very limited form of NAT. - -=item none - -Tell virt-install not to add any default network interface. - -=back - -If this option is omitted a single NIC will be created in the guest. If -there is a bridge device in the host with a physical interface enslaved, -that will be used for connectivity. Failing that, the virtual network -called C<default> will be used. This option can be specified multiple -times to setup more than one NIC. - -Some example suboptions: - -=over 4 - -=item B<model.type> or B<model> - -Network device model as seen by the guest. Value can be any nic model supported -by the hypervisor, e.g.: 'e1000', 'rtl8139', 'virtio', ... - -=item B<mac.address> or B<mac> - -Fixed MAC address for the guest; If this parameter is omitted, or the value -C<RANDOM> is specified a suitable address will be randomly generated. For -Xen virtual machines it is required that the first 3 pairs in the MAC address -be the sequence '00:16:3e', while for QEMU or KVM virtual machines it must -be '52:54:00'. - -=item B<filterref.filter> - -Controlling firewall and network filtering in libvirt. Value can be any nwfilter -defined by the C<virsh> 'nwfilter' subcommands. Available filters can be listed -by running 'virsh nwfilter-list', e.g.: 'clean-traffic', 'no-mac-spoofing', ... - -=item B<virtualport.*> options - -Configure the device virtual port profile. This is used for 802.Qbg, 802.Qbh, -midonet, and openvswitch config. Check for 'virtualport' references in the -libvirt documentation: C<https://libvirt.org/formatdomain.html#elementsNICS> - -=back - -Use --network=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsNICS> - -This option deprecates -m/--mac, -b/--bridge, and --nonetworks - -=back - - - - - -=head1 GRAPHICS OPTIONS - -If no graphics option is specified, C<virt-install> will try to select -the appropriate graphics if the DISPLAY environment variable is set, -otherwise '--graphics none' is used. - -=over 4 - -=item B<--graphics> TYPE,opt1=arg1,opt2=arg2,... - -Specifies the graphical display configuration. This does not configure any -virtual hardware, just how the guest's graphical display can be accessed. -Typically the user does not need to specify this option, virt-install will -try and choose a useful default, and launch a suitable connection. - -General format of a graphical string is - - --graphics TYPE,opt1=arg1,opt2=arg2,... - -For example: - - --graphics vnc,password=foobar - -Some supported options are: - -=over 4 - -=item B<type> - -The display type. This is one of: - -vnc - -Setup a virtual console in the guest and export it as a VNC server in -the host. Unless the C<port> parameter is also provided, the VNC -server will run on the first free port number at 5900 or above. The -actual VNC display allocated can be obtained using the C<vncdisplay> -command to C<virsh> (or L<virt-viewer(1)> can be used which handles this -detail for the use). - -spice - -Export the guest's console using the Spice protocol. Spice allows advanced -features like audio and USB device streaming, as well as improved graphical -performance. - -Using spice graphic type will work as if those arguments were given: - - --video qxl --channel spicevmc - -none - -No graphical console will be allocated for the guest. Guests will likely -need to have a text console configured on the first -serial port in the guest (this can be done via the --extra-args option). The -command 'virsh console NAME' can be used to connect to the serial device. - -=item B<port> - -Request a permanent, statically assigned port number for the guest -console. This is used by 'vnc' and 'spice' - -=item B<tlsPort> - -Specify the spice tlsport. - -=item B<websocket> - -Request a VNC WebSocket port for the guest console. - -If -1 is specified, the WebSocket port is auto-allocated. - -This is used by 'vnc' and 'spice' - -=item B<listen> - -Address to listen on for VNC/Spice connections. Default is typically 127.0.0.1 -(localhost only), but some hypervisors allow changing this globally (for -example, the qemu driver default can be changed in /etc/libvirt/qemu.conf). -Use 0.0.0.0 to allow access from other machines. - -Use 'none' to specify that the display server should not listen on any -port. The display server can be accessed only locally through -libvirt unix socket (virt-viewer with --attach for instance). - -Use 'socket' to have the VM listen on a libvirt generated unix socket -path on the host filesystem. - -This is used by 'vnc' and 'spice' - -=item B<password> - -Request a console password, required at connection time. Beware, this info may -end up in virt-install log files, so don't use an important password. This -is used by 'vnc' and 'spice' - -=item B<gl.enable> - -Whether to use OpenGL accelerated rendering. Value is 'yes' or 'no'. This is -used by 'spice'. - -=item B<gl.rendernode> - -DRM render node path to use. This is used when 'gl' is enabled. - -=back - -Use --graphics=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsGraphics> - -This deprecates the following options: --vnc, --vncport, --vnclisten, -k/--keymap, --sdl, --nographics - - -=item B<--autoconsole> OPTIONS - -Configure what interactive console virt-install will launch for the VM. This -option is not required; the default behavior is adaptive and dependent on -how the VM is configured. But you can use this option to override the default -choice. - -=over 4 - -=item B<--autoconsole graphical> - -Use the graphical L<virt-viewer(1)> as the interactive console - -=item B<--autoconsole text> - -Use the text mode B<virsh console> as the interactive console. - -=item B<--autoconsole none> - -This is the same as B<--noautoconsole> - -=back - - -=item B<--noautoconsole> - -Don't automatically try to connect to the guest console. Same as -B<--autoconsole none> - -Note, virt-install exits quickly when this option is specified. If your -command requested a multistep install, like --cdrom or --location, after -the install phase is complete the VM will be shutoff, regardless of -whether a reboot was requested in the VM. If you want the VM to be -rebooted, virt-install must remain running. You can use '--wait' to keep -virt-install alive even if --noautoconsole is specified. - -=back - - - - -=head1 VIRTUALIZATION OPTIONS - -Options to override the default virtualization type choices. - -=over 4 - -=item B<-v> - -=item B<--hvm> - -Request the use of full virtualization, if both para & full virtualization are -available on the host. This parameter may not be available if connecting to a -Xen hypervisor on a machine without hardware virtualization support. This -parameter is implied if connecting to a QEMU based hypervisor. - -=item B<-p> - -=item B<--paravirt> - -This guest should be a paravirtualized guest. If the host supports both -para & full virtualization, and neither this parameter nor the C<--hvm> -are specified, this will be assumed. - -=item B<--container> - -This guest should be a container type guest. This option is only required -if the hypervisor supports other guest types as well (so for example this -option is the default behavior for LXC and OpenVZ, but is provided for -completeness). - -=item B<--virt-type> - -The hypervisor to install on. Example choices are kvm, qemu, or xen. -Available options are listed via 'virsh capabilities' in the <domain> tags. - -This deprecates the --accelerate option, which is now the default behavior. To install a plain QEMU guest, use '--virt-type qemu' - -=back - - - - - -=head1 DEVICE OPTIONS - -All devices have a set of B<address.*> options for configuring the -particulars of the device's address on its parent controller or bus. -See C<https://libvirt.org/formatdomain.html#elementsAddress> for details. - -=over 4 - -=item B<--controller> OPTIONS - -Attach a controller device to the guest. TYPE is one of: -B<ide>, B<fdc>, B<scsi>, B<sata>, B<virtio-serial>, or B<usb>. - -Controller also supports the special values B<usb2> and B<usb3> to -specify which version of the USB controller should be used (version 2 -or 3). - -Some example suboptions: - -=over 4 - -=item B<model> - -Controller model. These may vary according to the hypervisor and its -version. Most commonly used models are e.g. B<auto>, B<virtio-scsi> -for the B<scsi> controller, B<ehci> or B<none> for the B<usb> -controller. For full list and further details on controllers/models, -see C<https://libvirt.org/formatdomain.html#elementsControllers>. - -=item B<index> - -A decimal integer describing in which order the bus controller is -encountered, and to reference the controller bus. - -=back - -Use --controller=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsControllers> - - -=item B<--input> OPTIONS - -Attach an input device to the guest. Example input device types are mouse, tablet, or keyboard. - -Use --input=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsInput> - - -=item B<--hostdev> OPTIONS - -=item B<--host-device> OPTIONS - -Attach a physical host device to the guest. Some example values for HOSTDEV: - -=over 4 - -=item B<--hostdev pci_0000_00_1b_0> - -A node device name via libvirt, as shown by 'virsh nodedev-list' - -=item B<--hostdev 001.003> - -USB by bus, device (via lsusb). - -=item B<--hostdev 0x1234:0x5678> - -USB by vendor, product (via lsusb). - -=item B<--hostdev 1f.01.02> - -PCI device (via lspci). - -=item B<--hostdev wlan0,type=net> - -Network device (in LXC container). - -=item B<--hostdev /dev/net/tun,type=misc> - -Character device (in LXC container). - -=item B<--hostdev /dev/sdf,type=storage> - -Block device (in LXC container). - -=back - -Use --hostdev=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsHostDev> - -=item B<--sound> MODEL - -Attach a virtual audio device to the guest. MODEL specifies the emulated -sound card model. Possible values are ich6, ich9, ac97, es1370, sb16, pcspk, -or default. 'default' will try to pick the best model that the specified -OS supports. - -This deprecates the old --soundhw option. - -Use --sound=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsSound> - -=item B<--watchdog> MODEL[,action=ACTION] - -Attach a virtual hardware watchdog device to the guest. This requires a -daemon and device driver in the guest. The watchdog fires a signal when -the virtual machine appears to hung. ACTION specifies what libvirt will do -when the watchdog fires. Values are - -=over 4 - -=item B<reset> - -Forcefully reset the guest (the default) - -=item B<poweroff> - -Forcefully power off the guest - -=item B<pause> - -Pause the guest - -=item B<none> - -Do nothing - -=item B<shutdown> - -Gracefully shutdown the guest (not recommended, since a hung guest probably -won't respond to a graceful shutdown) - -=back - -MODEL is the emulated device model: either i6300esb (the default) or ib700. -Some examples: - -Use the recommended settings: - ---watchdog default - -Use the i6300esb with the 'poweroff' action - ---watchdog i6300esb,action=poweroff - -Use --watchdog=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsWatchdog> - -=item B<--parallel> OPTIONS - -=item B<--serial> OPTIONS - -Specifies a serial device to attach to the guest, with various options. The -general format of a serial string is - - --serial type,opt1=val1,opt2=val2,... - ---serial and --parallel devices share all the same options, unless otherwise -noted. Some of the types of character device redirection are: - -=over 4 - -=item B<--serial pty> - -Pseudo TTY. The allocated pty will be listed in the running guests XML -description. - -=item B<--serial dev,path=HOSTPATH> - -Host device. For serial devices, this could be /dev/ttyS0. For parallel -devices, this could be /dev/parport0. - -=item B<--serial file,path=FILENAME> - -Write output to FILENAME. - -=item B<--serial tcp,host=HOST:PORT,source.mode=MODE,protocol.type=PROTOCOL> - -TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT) -or 'connect' (send output to HOST:PORT), default is 'bind'. HOST defaults -to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet' -(default 'raw'). If 'telnet', the port acts like a telnet server or client. -Some examples: - -Wait for connections on any address, port 4567: - ---serial tcp,host=0.0.0.0:4567 - -Connect to localhost, port 1234: - ---serial tcp,host=:1234,source.mode=connect - -Wait for telnet connection on localhost, port 2222. The user could then -connect interactively to this console via 'telnet localhost 2222': - ---serial tcp,host=:2222,source.mode=bind,source.protocol=telnet - -=item B<--serial udp,host=CONNECT_HOST:PORT,bind_host=BIND_HOST:BIND_PORT> - -UDP net console. HOST:PORT is the destination to send output to (default -HOST is '127.0.0.1', PORT is required). BIND_HOST:BIND_PORT is the optional -local address to bind to (default BIND_HOST is 127.0.0.1, but is only set if -BIND_PORT is specified). Some examples: - -Send output to default syslog port (may need to edit /etc/rsyslog.conf -accordingly): - ---serial udp,host=:514 - -Send output to remote host 192.168.10.20, port 4444 (this output can be -read on the remote host using 'nc -u -l 4444'): - ---serial udp,host=192.168.10.20:4444 - -=item B<--serial unix,path=UNIXPATH,mode=MODE> - -Unix socket, see unix(7). MODE has similar behavior and defaults as ---serial tcp,mode=MODE - -=back - -Use --serial=? or --parallel=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCharSerial> and L<https://libvirt.org/formatdomain.html#elementsCharParallel> - -=item B<--channel> - -Specifies a communication channel device to connect the guest and host -machine. This option uses the same options as --serial and --parallel -for specifying the host/source end of the channel. Extra 'target' options -are used to specify how the guest machine sees the channel. - -Some of the types of character device redirection are: - -=over 4 - -=item B<--channel SOURCE,target.type=guestfwd,target.address=HOST:PORT> - -Communication channel using QEMU usermode networking stack. The guest can -connect to the channel using the specified HOST:PORT combination. - -=item B<--channel SOURCE,target.type=virtio[,target.name=NAME]> - -Communication channel using virtio serial (requires 2.6.34 or later host and -guest). Each instance of a virtio --channel line is exposed in the -guest as /dev/vport0p1, /dev/vport0p2, etc. NAME is optional metadata, and -can be any string, such as org.linux-kvm.virtioport1. -If specified, this will be exposed in the guest at -/sys/class/virtio-ports/vport0p1/NAME - -=item B<--channel spicevmc,target.type=virtio[,target.name=NAME]> - -Communication channel for QEMU spice agent, using virtio serial -(requires 2.6.34 or later host and guest). NAME is optional metadata, -and can be any string, such as the default com.redhat.spice.0 that -specifies how the guest will see the channel. - -=back - -Use --channel=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCharChannel> - -=item B<--console> - -Connect a text console between the guest and host. Certain guest and -hypervisor combinations can automatically set up a getty in the guest, so -an out of the box text login can be provided (target_type=xen for xen -paravirt guests, and possibly target_type=virtio in the future). - -Example: - -=over 4 - -=item B<--console pty,target.type=virtio> - -Connect a virtio console to the guest, redirected to a PTY on the host. -For supported guests, this exposes /dev/hvc0 in the guest. See -https://fedoraproject.org/wiki/Features/VirtioSerial for more info. virtio -console requires libvirt 0.8.3 or later. - -=back - -Use --console=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsCharConsole> - -=item B<--video> OPTIONS - -Specify what video device model will be attached to the guest. Valid values -for VIDEO are hypervisor specific, but some options for recent kvm are -cirrus, vga, qxl, virtio, or vmvga (vmware). - -Use --video=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsVideo> - -=item B<--smartcard> MODE[,OPTIONS] - -Configure a virtual smartcard device. - -Mode is one of B<host>, B<host-certificates>, or B<passthrough>. Additional -options are: - -=over 4 - -=item B<type> - -Character device type to connect to on the host. This is only applicable -for B<passthrough> mode. - -=back - -An example invocation: - -=over 4 - -=item B<--smartcard passthrough,type=spicevmc> - -Use the smartcard channel of a SPICE graphics device to pass smartcard info -to the guest - -=back - -Use --smartcard=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsSmartcard> - -=item B<--redirdev> BUS[,OPTIONS] - -Add a redirected device. - -=over 4 - -=item B<type> - -The redirection type, currently supported is B<tcp> or B<spicevmc>. - -=item B<server> - -The TCP server connection details, of the form 'server:port'. - -=back - -Examples of invocation: - -=over 4 - -=item B<--redirdev usb,type=tcp,server=localhost:4000> - -Add a USB redirected device provided by the TCP server on 'localhost' -port 4000. - -=item B<--redirdev usb,type=spicevmc> - -Add a USB device redirected via a dedicated Spice channel. - -=back - -Use --redirdev=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsRedir> - -=item B<--memballoon> MODEL - -Attach a virtual memory balloon device to the guest. If the memballoon device -needs to be explicitly disabled, MODEL='none' is used. - -MODEL is the type of memballoon device provided. The value can be 'virtio', -'xen' or 'none'. -Some examples: - -Use the recommended settings: - ---memballoon virtio - -Do not use memballoon device: - ---memballoon none - -Use --memballoon=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMemBalloon> - -=item B<--tpm> TYPE[,OPTIONS] - -Configure a virtual TPM device. - -An example invocation: - -=over 4 - -=item B<--tpm /dev/tpm> - -Convenience option for passing through the hosts TPM. - -=item B<--tpm emulator> - -Request an emulated TPM device. - -=back - -Use --tpm=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsTpm> - -=item B<--rng> TYPE[,OPTIONS] - -Configure a virtual RNG device. - -Type can be B<random>, B<egd> or B<builtin>. - -If the specified type is B<random> then these values must -be specified: - -=over 4 - -=item B<backend> - -The device to use as a source of entropy. - -=back - -Whereas, when the type is B<egd>, these values must be provided: - -=over 4 - -=item B<backend.source.host> - -Specify the host of the Entropy Gathering Daemon to connect to. - -=item B<backend.source.service> - -Specify the port of the Entropy Gathering Daemon to connect to. - -=item B<backend.type> - -Specify the type of the connection: B<tcp> or B<udp>. - -=item B<backend.source.mode> - -Specify the mode of the connection. It is either 'bind' (wait for -connections on HOST:PORT) or 'connect' (send output to HOST:PORT). - -=item B<backend.connect_host> - -Specify the remote host to connect to when the specified backend_type is B<udp> -and backend_mode is B<bind>. - -=item B<backend.connect_service> - -Specify the remote service to connect to when the specified backend_type is -B<udp> and backend_mode is B<bind>. - -=back - -If the specified type is B<builtin>, B<backend> is not required. - -An example invocation: - -=over 4 - -=item B<--rng egd,backend.source.host=localhost,backend.source.service=8000,backend.type=tcp> - -Connect to localhost to the TCP port 8000 to get entropy data. - -=item B<--rng /dev/random> - -Use the /dev/random device to get entropy data, this form implicitly uses the -"random" model. - -=item B<--rng builtin> - -Use the builtin rng device to get entropy data. - -Use --rng=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsRng> - -=back - -=item B<--panic> MODEL[,OPTS] - -Attach a panic notifier device to the guest. For the recommended settings, use: - ---panic default - -Use --panic=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsPanic> - -=item B<--memdev> OPTS - -Add a memory module to a guest which can be hotunplugged. To add a memdev you need -to configure hotplugmemory and NUMA for a guest. - -Use --memdev=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#elementsMemory>. - -=item B<--vsock> OPTS - -Configure a vsock host/guest interface. A typical configuration would be - - --vsock cid.auto=yes - -Use --vsock=? to see a list of all available sub options. Complete details at L<https://libvirt.org/formatdomain.html#vsock>. - -=item B<--iommu> MODEL[,OPTS] - -Add an IOMMU device to the guest. - -Use --iommu=? to see a list of all available options. Complete details at L<https://libvirt.org/formatdomain.html#elementsIommu>. - - -=back - -=head1 MISCELLANEOUS OPTIONS - -=over 4 - -=item B<-h> - -=item B<--help> - -Show the help message and exit - -=item B<--version> - -Show program's version number and exit - -=item B<--autostart> - -Set the autostart flag for a domain. This causes the domain to be started -on host boot up. - -=item B<--transient> - -Use --import or --boot and --transient if you want a transient libvirt -VM. These VMs exist only until the domain is shut down or the host -server is restarted. Libvirt forgets the XML configuration of the VM -after either of these events. Note that the VM's disks will not be -deleted. See: -L<https://wiki.libvirt.org/page/VM_lifecycle#Transient_guest_domains_vs_Persistent_guest_domains> - -=item B<--destroy-on-exit> - -When the VM console window is exited, destroy (force poweroff) the VM. -If you combine this with --transient, this makes the virt-install command -work similar to qemu, where the VM is shutdown when the console window -is closed by the user. - -=item B<--print-xml> [STEP] - -Print the generated XML of the guest, instead of defining it. By default this WILL do storage creation (can be disabled with --dry-run). This option implies --quiet. - -If the VM install has multiple phases, by default this will print all generated XML. If you want to print a particular step, use --print-xml 2 (for the second phase XML). - -=item B<--noreboot> - -Prevent the domain from automatically rebooting after the install has -completed. - -=item B<--wait> WAIT - -Configure how virt-install will wait for the install to complete. -Without this option, virt-install will wait for the console to close (not -necessarily indicating the guest has shutdown), or in the case of ---noautoconsole, simply kick off the install and exit. - -Bare '--wait' or any negative value will make virt-install wait indefinitely. -Any positive number is the number of minutes virt-install will wait. If the -time limit is exceeded, virt-install simply exits, leaving the virtual machine -in its current state. - -=item B<--dry-run> - -Proceed through the guest creation process, but do NOT create storage devices, -change host device configuration, or actually teach libvirt about the guest. -virt-install may still fetch install media, since this is required to -properly detect the OS to install. - -=item B<--check> - -Enable or disable some validation checks. Some examples are warning about using a disk that's already assigned to another VM (--check path_in_use=on|off), or warning about potentially running out of space during disk allocation (--check disk_size=on|off). Most checks are performed by default. - -=item B<-q> - -=item B<--quiet> - -Only print fatal error messages. - -=item B<-d> - -=item B<--debug> - -Print debugging information to the terminal when running the install process. -The debugging information is also stored in -C<~/.cache/virt-manager/virt-install.log> even if this parameter is omitted. - -=back - -=head1 EXAMPLES - -The simplest invocation to interactively install a Fedora 29 KVM VM -with recommended defaults. L<virt-viewer(1)> will be launched to -graphically interact with the VM install - - # sudo virt-install --install fedora29 - -Similar, but use libosinfo's unattended install support, which will -perform the fedora29 install automatically without user intervention: - - # sudo virt-install --install fedora29 --unattended - -Install a Windows 10 VM, using 40GiB storage in the default location -and 4096MiB of ram, and ensure we are connecting to the system libvirtd -instance: - - # virt-install \ - --connect qemu:///system \ - --name my-win10-vm \ - --memory 4096 \ - --disk size=40 \ - --os-variant win10 \ - --cdrom /path/to/my/win10.iso - -Install a CentOS 7 KVM from a URL, with recommended device defaults and -default required storage, but specifically request VNC graphics instead -of the default SPICE, and request 8 virtual CPUs and 8192 MiB of memory: - - # virt-install \ - --connect qemu:///system \ - --memory 8192 \ - --vcpus 8 \ - --graphics vnc \ - --os-variant centos7.0 \ - --location http://mirror.centos.org/centos-7/7/os/x86_64/ - -Create a VM around an existing debian9 disk image: - - # virt-install \ - --import \ - --memory 512 \ - --disk /home/user/VMs/my-debian9.img \ - --os-variant debian9 - -Start serial QEMU ARM VM, which requires specifying a manual kernel. - - # virt-install \ - --name armtest \ - --memory 1024 \ - --arch armv7l --machine vexpress-a9 \ - --disk /home/user/VMs/myarmdisk.img \ - --boot kernel=/tmp/my-arm-kernel,initrd=/tmp/my-arm-initrd,dtb=/tmp/my-arm-dtb,kernel_args="console=ttyAMA0 rw root=/dev/mmcblk0p3" \ - --graphics none - -Start an SEV launch security VM with 4GB RAM, 4GB+256MiB of hard_limit, with a -couple of virtio devices: - -Note: The IOMMU flag needs to be turned on with driver.iommu for virtio -devices. Usage of --memtune is currently required because of SEV limitations, -refer to libvirt docs for a detailed explanation. - - # virt-install \ - --name foo \ - --memory 4096 \ - --boot uefi \ - --machine q35 \ - --memtune hard_limit=4563402 \ - --disk size=15,target.bus=scsi \ - --import \ - --controller type=scsi,model=virtio-scsi,driver.iommu=on \ - --controller type=virtio-serial,driver.iommu=on \ - --network network=default,model=virtio,driver.iommu=on \ - --rng /dev/random,driver.iommu=on \ - --memballoon driver.iommu=on \ - --launchSecurity sev - -=head1 BUGS - -Please see L<https://virt-manager.org/bugs> - -=head1 COPYRIGHT - -Copyright (C) Red Hat, Inc, and various contributors. -This is free software. You may redistribute copies of it under the terms of -the GNU General Public License C<https://www.gnu.org/licenses/gpl.html>. There -is NO WARRANTY, to the extent permitted by law. - -=head1 SEE ALSO - -C<virsh(1)>, C<virt-clone(1)>, C<virt-manager(1)>, the project website C<https://virt-manager.org> - -=cut diff --git a/man/virt-install.rst b/man/virt-install.rst new file mode 100644 index 00000000..307ae1ae --- /dev/null +++ b/man/virt-install.rst @@ -0,0 +1,2143 @@ +============ +virt-install +============ + +------------------------------ +provision new virtual machines +------------------------------ + +:Manual section: 1 +:Manual group: Virtualization Support + + + +SYNOPSIS +======== + +``virt-install`` [OPTION]... + + + +DESCRIPTION +=========== + +``virt-install`` is a command line tool for creating new KVM, Xen, or Linux +container guests using the ``libvirt`` hypervisor management library. +See the EXAMPLES section at the end of this document to quickly get started. + +``virt-install`` tool supports graphical installations using (for example) +VNC or SPICE, as well as text mode installs over serial console. The guest +can be configured to use one or more virtual disks, network interfaces, +audio devices, physical USB or PCI devices, among others. + +The installation media can be local ISO or CDROM media, or a distro install +tree hosted remotely over HTTP, FTP, or in a local directory. In the install +tree case ``virt-install`` will fetch the minimal files +necessary to kick off the installation process, allowing the guest +to fetch the rest of the OS distribution as needed. PXE booting, and importing +an existing disk image (thus skipping the install phase) are also supported. + +Given suitable command line arguments, ``virt-install`` is capable of running +completely unattended, with the guest 'kickstarting' itself too. This allows +for easy automation of guest installs. This can be done manually, or more +simply with the --unattended option. + +Many arguments have sub options, specified like opt1=foo,opt2=bar, etc. Try +--option=? to see a complete list of sub options associated with that +argument, example: virt-install --disk=? + +Most options are not required. If a suitable --os-variant value is specified +or detected, all defaults will be filled in and reported in the terminal +output. If an --os-variant is not specified. minimum required options, --memory, +guest storage (--disk or --filesystem), and an install method choice. + + + +CONNECTING TO LIBVIRT +===================== + + +``--connect`` +^^^^^^^^^^^^^ + +**Syntax:** ``--connect`` URI + +Connect to a non-default hypervisor. If this isn't specified, libvirt +will try and choose the most suitable default. + +Some valid options here are: + +qemu:///system + For creating KVM and QEMU guests to be run by the system libvirtd instance. + This is the default mode that virt-manager uses, and what most KVM users + want. + +qemu:///session + For creating KVM and QEMU guests for libvirtd running as the regular user. + +xen:/// + For connecting to Xen. + +lxc:/// + For creating linux containers + + +GENERAL OPTIONS +=============== + +General configuration parameters that apply to all types of guest installs. + + + +``-n``, ``--name`` +^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``-n``, ``--name`` NAME + +Name of the new guest virtual machine instance. This must be unique amongst +all guests known to the hypervisor on the connection, including those not +currently active. To re-define an existing guest, use the ``virsh(1)`` tool +to shut it down ('virsh shutdown') & delete ('virsh undefine') it prior to +running ``virt-install``. + + + +``--memory`` +^^^^^^^^^^^^ + +**Syntax:** ``--memory`` OPTIONS + +Memory to allocate for the guest, in MiB. This deprecates the -r/--ram option. +Sub options are available, like 'memory', 'currentMemory', 'maxMemory' +and 'maxMemory.slots', which all map to the identically named XML values. + +Back compat values 'memory' maps to the <currentMemory> element, and maxmemory +maps to the <memory> element. + +To configure memory modules which can be hotunplugged see ``--memdev`` description. + +Use --memory=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMemoryAllocation + + + +``--memorybacking`` +^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--memorybacking`` OPTIONS + +This option will influence how virtual memory pages are backed by host pages. + +Use --memorybacking=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMemoryBacking + + + +``--arch`` +^^^^^^^^^^ + +**Syntax:** ``--arch`` ARCH + +Request a non-native CPU architecture for the guest virtual machine. +If omitted, the host CPU architecture will be used in the guest. + + + +``--machine`` +^^^^^^^^^^^^^ + +**Syntax:** ``--machine`` MACHINE + +The machine type to emulate. This will typically not need to be specified +for Xen or KVM, but is useful for choosing machine types of more exotic +architectures. + + + +``--metadata`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--metadata`` OPT=VAL,[...] + +Specify metadata values for the guest. Possible options include name, uuid, +title, and description. This option deprecates -u/--uuid and --description. + +Use --metadata=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMetadata + + + +``--events`` +^^^^^^^^^^^^ + +**Syntax:** ``--events`` OPT=VAL,[...] + +Specify events values for the guest. Possible options include +on_poweroff, on_reboot, and on_crash. + +Use --events=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsEvents + + + +``--resource`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--resource`` OPT=VAL,[...] + +Specify resource partitioning for the guest. + +Use --resource=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#resPartition + + + +``--sysinfo`` +^^^^^^^^^^^^^ + +**Syntax:** ``--sysinfo`` OPT=VAL,[...] + +Configure sysinfo/SMBIOS values exposed to the VM OS. Examples: + +``--sysinfo host`` + Special type that exposes the host's SMBIOS info into the VM. + +``--sysinfo emulate`` + Special type where hypervisor will generate SMBIOS info into the VM. + +``--sysinfo bios.vendor=custom`` or ``--sysinfo smbios,bios.vendor=custom`` + The default type is ``smbios`` and allows users to specify SMBIOS info manually. + +Use --sysinfo=? to see a list of all available sub options. + +Complete details at https://libvirt.org/formatdomain.html#elementsSysinfo +and https://libvirt.org/formatdomain.html#elementsOSBIOS for ``smbios`` XML element. + + + +``--xml`` +^^^^^^^^^ + +**Syntax:** ``--xml`` ARGS + +Make direct edits to the generated XML using XPath syntax. Take an example like + +.. code-block:: + + virt-install --xml ./@foo=bar --xml ./newelement/subelement=1 + +This will alter the generated XML to contain: + +.. code-block:: + + <domain foo='bar' ...> + ... + <newelement> + <subelement>1</subelement> + </newelement> + </domain> + +The --xml option has 4 sub options: + +--xml xpath.set=XPATH[=VALUE] + The default behavior if no explicit suboption is set. Takes the form XPATH=VALUE + unless paired with ``xpath.value`` . See below for how value is interpreted. + +--xml xpath.value=VALUE + ``xpath.set`` will be interpreted only as the XPath string, and ``xpath.value`` will + be used as the value to set. May help sidestep problems if the string you need to + set contains a '=' equals sign. + + If value is empty, it's treated as unsetting that particular node. + +--xml xpath.create=XPATH + Create the node as an empty element. Needed for boolean elements like <readonly/> + +--xml xpath.delete=XPATH + Delete the entire node specified by the xpath, and all its children + + + +``--qemu-commandline`` +^^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--qemu-commandline`` ARGS + +Pass options directly to the qemu emulator. Only works for the libvirt +qemu driver. The option can take a string of arguments, for example: + +.. code-block:: + + --qemu-commandline="-display gtk,gl=on" + +Environment variables are specified with 'env', for example: + +.. code-block:: + + --qemu-commandline=env=DISPLAY=:0.1 + +Complete details about the libvirt feature: https://libvirt.org/drvqemu.html#qemucommand + + + +``--vcpus`` +^^^^^^^^^^^ + +**Syntax:** ``--vcpus`` OPTIONS + +Number of virtual cpus to configure for the guest. If 'maxvcpus' is specified, +the guest will be able to hotplug up to MAX vcpus while the guest is running, +but will startup with VCPUS. + +CPU topology can additionally be specified with sockets, cores, and threads. +If values are omitted, the rest will be autofilled preferring sockets over +cores over threads. + +'cpuset' sets which physical cpus the guest can use. ``CPUSET`` is a comma +separated list of numbers, which can also be specified in ranges or cpus +to exclude. Example: + +.. code-block:: + + 0,2,3,5 : Use processors 0,2,3 and 5 + 1-5,^3,8 : Use processors 1,2,4,5 and 8 + +If the value 'auto' is passed, virt-install attempts to automatically determine +an optimal cpu pinning using NUMA data, if available. + +Use --vcpus=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCPUAllocation + + + +``--numatune`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--numatune`` OPTIONS + +Tune NUMA policy for the domain process. Example invocations + +.. code-block:: + + --numatune 1,2,3,4-7 + --numatune 1-3,5,memory.mode=preferred + + +Specifies the numa nodes to allocate memory from. This has the same syntax +as ``--vcpus cpuset=`` option. mode can be one of 'interleave', 'preferred', or +'strict' (the default). See 'man 8 numactl' for information about each +mode. + +Use --numatune=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsNUMATuning + + + +``--memtune`` +^^^^^^^^^^^^^ + +**Syntax:** ``--memtune`` OPTIONS + +Tune memory policy for the domain process. Example invocations + +.. code-block:: + + --memtune 1000 + --memtune hard_limit=100,soft_limit=60,swap_hard_limit=150,min_guarantee=80 + +Use --memtune=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMemoryTuning + + + +``--blkiotune`` +^^^^^^^^^^^^^^^ + +**Syntax:** ``--blkiotune`` OPTIONS + +Tune blkio policy for the domain process. Example invocations + +.. code-block:: + + --blkiotune 100 + --blkiotune weight=100,device.path=/dev/sdc,device.weight=200 + +Use --blkiotune=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsBlockTuning + + + +``--cpu`` +^^^^^^^^^ + +**Syntax:** ``--cpu`` MODEL[,+feature][,-feature][,match=MATCH][,vendor=VENDOR],... + +Configure the CPU model and CPU features exposed to the guest. The only +required value is MODEL, which is a valid CPU model as known to libvirt. + +Libvirt's feature policy values force, require, optional, disable, or forbid, +or with the shorthand '+feature' and '-feature', which equal 'force=feature' +and 'disable=feature' respectively. + +If exact CPU model is specified virt-install will automatically copy CPU +features available on the host to mitigate recent CPU speculative execution +side channel and Microarchitectural Store Buffer Data security vulnerabilities. +This however will have some impact on performance and will break migration +to hosts without security patches. In order to control this behavior there +is a ``secure`` parameter. Possible values are ``on`` and ``off``, with ``on`` +as the default. It is highly recommended to leave this enabled and ensure all +virtualization hosts have fully up to date microcode, kernel & virtualization +software installed. + +Some examples: + +``--cpu core2duo,+x2apic,disable=vmx`` + Expose the core2duo CPU model, force enable x2apic, but do not expose vmx + +``--cpu host`` + Expose the host CPUs configuration to the guest. This enables the guest to + take advantage of many of the host CPUs features (better performance), but + may cause issues if migrating the guest to a host without an identical CPU. + +``--cpu numa.cell0.memory=1234,numa.cell0.cpus=0-3,numa.cell1.memory=5678,numa.cell1.cpus=4-7`` + Example of specifying two NUMA cells. This will generate XML like: + + .. code-block:: + + <cpu> + <numa> + <cell cpus="0-3" memory="1234"/> + <cell cpus="4-7" memory="5678"/> + </numa> + </cpu> + + +``--cpu host-passthrough,cache.mode=passthrough`` + Example of passing through the host cpu's cache information. + +Use --cpu=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCPU + + + +``--cputune`` +^^^^^^^^^^^^^ + +**Syntax:** ``--cputune`` OPTIONS + +Tune CPU parameters for the guest. + +Configure which of the host's physical CPUs the domain VCPU will be pinned to. +Example invocation + +.. code-block:: + + --cputune vcpupin0.vcpu=0,vcpupin0.cpuset=0-3,vcpupin1.vcpu=1,vcpupin1.cpuset=4-7 + +Use --cputune=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCPUTuning + + + +``--security``, ``--seclabel`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--security``, ``--seclabel`` type=TYPE[,label=LABEL][,relabel=yes|no],... + +Configure domain seclabel domain settings. Type can be either 'static' or +'dynamic'. 'static' configuration requires a security LABEL. Specifying +LABEL without TYPE implies static configuration. + +Use --security=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#seclabel + + + +``--keywrap`` +^^^^^^^^^^^^^ + +**Syntax:** ``--keywrap`` OPTIONS + +Specify domain <keywrap> XML, used for S390 cryptographic key management operations. + +Use --keywrap=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#keywrap + + + +``--iothreads`` +^^^^^^^^^^^^^^^ + +**Syntax:** ``--iothreads`` OPTIONS + +Specify domain <iothreads> and/or <iothreadids> XML. +For example, to configure ``<iothreads>4</iothreads>``, use ``--iothreads 4`` + +Use --iothreads=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsIOThreadsAllocation + + + +``--features`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--features`` FEAT=on|off,... + +Set elements in the guests <features> XML on or off. Examples include acpi, +apic, eoi, privnet, and hyperv features. Some examples: + +``--features apic.eoi=on`` + Enable APIC PV EOI + +``--features hyperv.vapic.state=on,hyperv.spinlocks.state=off`` + Enable hypver VAPIC, but disable spinlocks + +``--features kvm.hidden.state=on`` + Allow the KVM hypervisor signature to be hidden from the guest + +``--features pvspinlock=on`` + Notify the guest that the host supports paravirtual spinlocks for + example by exposing the pvticketlocks mechanism. + +``--features gic.version=2`` + This is relevant only for ARM architectures. Possible values are "host" or + version number. + +``--features smm.state=on`` + This enables System Management Mode of hypervisor. Some UEFI firmwares may + require this feature to be present. (QEMU supports SMM only with q35 machine + type.) + +Use --features=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsFeatures + + + +``--clock`` +^^^^^^^^^^^ + +**Syntax:** ``--clock`` offset=OFFSET,TIMER_OPT=VAL,... + +Configure the guest's <clock> XML. Some supported options: + +``--clock offset=OFFSET`` + Set the clock offset, ex. 'utc' or 'localtime' + +``--clock TIMER_present=no`` + Disable a boolean timer. TIMER here might be hpet, kvmclock, etc. + +``--clock TIMER_tickpolicy=VAL`` + Set a timer's tickpolicy value. TIMER here might be rtc, pit, etc. VAL + might be catchup, delay, etc. Refer to the libvirt docs for all values. + +Use --clock=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsTime + + + +``--pm`` +^^^^^^^^ + +**Syntax:** ``--pm`` OPTIONS + +Configure guest power management features. Example: + +.. code-block:: + + --pm suspend_to_memi.enabled=on,suspend_to_disk.enabled=off + +Use --pm=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsPowerManagement + + + +``--launchSecurity`` +^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--launchSecurity`` TYPE[,OPTS] + +Enable launch security for the guest, e.g. AMD SEV. Example invocations: + +.. code-block:: + + # This will use a default policy 0x03 + # No dhCert provided, so no data can be exchanged with the SEV firmware + --launchSecurity sev + + # Explicit policy 0x01 - disables debugging, allows guest key sharing + --launchSecurity sev,policy=0x01 + + # Provide the session blob obtained from the SEV firmware + # Provide dhCert to open a secure communication channel with SEV firmware + --launchSecurity sev,session=BASE64SESSIONSTRING,dhCert=BASE64DHCERTSTRING + + +SEV has further implications on usage of virtio devices, so refer to EXAMPLES +section to see a full invocation of virt-install with --launchSecurity. + +Use --launchSecurity=? to see a list of all available sub options. Complete +details at https://libvirt.org/formatdomain.html#launchSecurity + + + +INSTALLATION OPTIONS +==================== + +``-c``, ``--cdrom`` +^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--cdrom`` PATH + +ISO file or CDROM device to use for VM install media. After install, +the the virtual CDROM device will remain attached to the VM, but with +the ISO or host path media ejected. + + + +``-l``, ``--location`` +^^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``-l``, ``--location`` OPTIONS + +Distribution tree installation source. virt-install can recognize +certain distribution trees and fetches a bootable kernel/initrd pair to +launch the install. + +--location allows things like --extra-args for kernel arguments, +and using --initrd-inject. If you want to use those options with CDROM media, +you can pass the ISO to --location as well which works for some, but not +all, CDROM media. + +The ``LOCATION`` can take one of the following forms: + +https://host/path + An HTTP server location containing an installable distribution image. + +ftp://host/path + An FTP server location containing an installable distribution image. + +ISO + Probe the ISO and extract files using 'isoinfo' + +DIRECTORY + Path to a local directory containing an installable distribution image. + Note that the directory will not be accessible by the guest after initial + boot, so the OS installer will need another way to access the rest of the + install media. + +Some distro specific url samples: + +Fedora/Red Hat Based + https://download.fedoraproject.org/pub/fedora/linux/releases/29/Server/x86_64/os + +Debian + https://ftp.us.debian.org/debian/dists/stable/main/installer-amd64/ + +Ubuntu + https://us.archive.ubuntu.com/ubuntu/dists/wily/main/installer-amd64/ + +Suse + https://download.opensuse.org/pub/opensuse/distribution/leap/42.3/repo/oss/ + +Additionally, --location can take 'kernel' and 'initrd' sub options. These paths +relative to the specified location URL/ISO that allow selecting specific files +for kernel/initrd within the install tree. This can be useful if virt-install/ +libosinfo doesn't know where to find the kernel in the specified --location. + +For example, if you have an ISO that libosinfo doesn't know about called +my-unknown.iso, with a kernel at 'kernel/fookernel' and initrd at +'kernel/fooinitrd', you can make this work with: + +.. code-block:: + + --location my-unknown.iso,kernel=kernel/fookernel,initrd=kernel/fooinitrd + + + +``--pxe`` +^^^^^^^^^ + +Install from PXE. This just tells the VM to boot off the network +for the first boot. + + + +``--import`` +^^^^^^^^^^^^ + +Skip the OS installation process, and build a guest around an existing +disk image. The device used for booting is the first device specified via +``--disk`` or ``--filesystem``. + + + +``-x``, ``--extra-args`` +^^^^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``-x``, ``--extra-args`` KERNELARGS + +Additional kernel command line arguments to pass to the installer when +performing a guest install from ``--location``. One common usage is specifying +an anaconda kickstart file for automated installs, such as +--extra-args "ks=https://myserver/my.ks" + + + +``--initrd-inject`` +^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--initrd-inject`` PATH + +Add PATH to the root of the initrd fetched with ``--location``. This can be +used to run an automated install without requiring a network hosted kickstart +file: ``--initrd-inject=/path/to/my.ks --extra-args "ks=file:/my.ks"`` + + + +``--install`` +^^^^^^^^^^^^^ + +This is a larger entry point for various types of install operations. The +command has multiple subarguments, similar to --disk and friends. This +option is strictly for VM install operations, essentially configuring the +first boot. + +The simplest usage to ex: install fedora29 is: + +.. code-block:: + + --install fedora29 + +And virt-install will fetch a --location URL from libosinfo, and populate +defaults from there. + +Available suboptions: + +``os=`` + This is os install option described above. The explicit way to specify that + would be ``--install os=fedora29`` . os= is the default option if none is + specified + +``kernel=``, ``initrd=`` + Specify a kernel and initrd pair to use as install media. They are copied + into a temporary location before booting the VM, so they can be combined + with --initrd-inject and your source media will not be altered. Media + will be uploaded to a remote connection if required. + + Example case using local filesystem paths: + ``--install kernel=/path/to/kernel,initrd=/path/to/initrd`` + + Example using network paths. Kernel/initrd will be downloaded locally first, + then passed to the VM as local filesystem paths: + ``--install kernel=https://127.0.0.1/tree/kernel,initrd=https://127.0.0.1/tree/initrd`` + + Note, these are just for install time booting. If you want to set the kernel + used for permanent VM booting, use the ``--boot`` option. + +``kernel_args=``, ``kernel_args_overwrite=yes|no`` + Specify install time kernel arguments (libvirt <cmdline> XML). These can + be combine with ex: kernel/initrd options, or ``--location`` media. By + default, kernel_args is just like --extra-args, and will _append_ to + the arguments that virt-install will try to set by default for most + --location installs. If you want to override the virt-install default, + additionally specify kernel_args_overwrite=yes + +``bootdev=`` + Specify the install bootdev (hd, cdrom, floppy, network) to boot off of + for the install phase. This maps to libvirt <os><boot dev=X> XML. + + If you want to install off a cdrom or network, it's probably simpler + and more backwards compatible to just use ``--cdrom`` or ``--pxe`` , but + this options gives fine grained control over the install process if + needed. + +``no_install=yes|no`` + Tell virt-install that there isn't actually any install happening, + and you just want to create the VM. ``--import`` is just an alias + for this, as is specifying ``--boot`` without any other install + options. The deprecated ``--live`` option is the same as + '--cdrom $ISO --install no_install=yes' + + + +``--reinstall DOMAIN`` +^^^^^^^^^^^^^^^^^^^^^^ + +Reinstall an existing VM. DOMAIN can be a VM name, UUID, or ID number. +virt-install will fetch the domain XML from libvirt, apply the specified +install config changes, boot the VM for the install process, and then +revert to roughly the same starting XML. + +Only install related options are processed, all other VM configuration +options like --name, --disk, etc. are completely ignored. + +If --reinstall is used with --cdrom, an existing CDROM attached to +the VM will be used if one is available, otherwise a permanent CDROM +device will be added. + + + +``--unattended`` +^^^^^^^^^^^^^^^^ + +**Syntax:** ``--unattended`` [OPTIONS] + +Perform an unattended install using libosinfo's install script support. +This is essentially a database of auto install scripts for various +distros: Red Hat kickstarts, Debian installer scripting, Windows +unattended installs, and potentially others. The simplest invocation +is to combine it with --install like: + +.. code-block:: + + --install fedora29 --unattended + +A Windows install will look like + +.. code-block:: + + --cdrom /path/to/my/windows.iso --unattended + +Sub options are: + +``profile=`` + Choose which libosinfo unattended profile to use. Most distros have + a 'desktop' and a 'jeos' profile. virt-install will default to 'desktop' + if this is unspecified. + +``admin-password-file=`` + A file used to set the VM OS admin/root password from. This option can + be used either as "admin-password-file=/path/to/password-file" or as + "admin-password-file=/dev/fd/n", being n the file descriptor of the + password-file. + Note that only the first line of the file will be considered, including + any whitespace characters and excluding new-line. + +``user-login=`` + The user login name to be used in th VM. virt-install will default to your + current host username if this is unspecified. + Note that when running virt-install as "root", this option must be specified. + +``user-password-file=`` + A file used to set the VM user password. This option can be used either as + "user-password-file=/path/to/password-file" or as + "user-password-file=/dev/fd/n", being n the file descriptor of the + password-file. The username is either the user-login specified or your current + host username. + Note that only the first line of the file will be considered, including + any whitespace characters and excluding new-line. + +``product-key=`` + Set a Windows product key + + + +``--cloud-init`` +^^^^^^^^^^^^^^^^ + +Pass cloud-init metadata to the VM. A cloud-init NoCloud ISO file is generated, +and attached to the VM as a CDROM device. The device is only attached for the +first boot. This option is particularly useful for distro cloud images, which +have locked login accounts by default; --cloud-init provides the means to +initialize those login accounts, like setting a root password. + +The simplest invocation is just plain ``--cloud-init`` with no suboptions; +this maps to ``--cloud-init root-password-generate=on,disable=on``. See those +suboptions for explanation of how they work. + +Use --cloud-init=? to see a list of all available sub options. + +Sub options are: + +``root-password-generate=on`` + Generate a new root password for the VM. When used, virt-install will + print the generated password to the console, and pause for 10 seconds + to give the user a chance to notice it and copy it. + +``disable=on`` + Disable cloud-init in the VM for subsequent boots. Without this, + cloud-init may reset auth on each boot. + +``root-password-file=`` + A file used to set the VM root password from. This option can + be used either as "root-password-file=/path/to/password-file" or as + "root-password-file=/dev/fd/n", being n the file descriptor of the + password-file. + Note that only the first line of the file will be considered, including + any whitespace characters and excluding new-line. + +``meta-data=`` + Specify a cloud-init meta-data file to add directly to the iso. All other + meta-data configuration options on the --cloud-init command line are ignored. + +``user-data=`` + Specify a cloud-init user-data file to add directly to the iso. All other + user-data configuration options on the --cloud-init command line are ignored. + +``ssh-key=`` + Specify a public key to inject into the guest, providing ssh access to the + unprivileged account. Example: ssh-key=/home/user/.ssh/id_rsa.pub + + + +``--boot`` +^^^^^^^^^^ + +**Syntax:** ``--boot`` BOOTOPTS + +Optionally specify the post-install VM boot configuration. This option allows +specifying a boot device order, permanently booting off kernel/initrd with +option kernel arguments, and enabling a BIOS boot menu (requires libvirt +0.8.3 or later) + +--boot can be specified in addition to other install options +(such as --location, --cdrom, etc.) or can be specified on its own. In +the latter case, behavior is similar to the --import install option: there +is no 'install' phase, the guest is just created and launched as specified. + +Some examples: + +``--boot cdrom,fd,hd,network`` + Set the boot device priority as first cdrom, first floppy, first harddisk, + network PXE boot. + +``--boot kernel=KERNEL,initrd=INITRD,kernel_args="console=/dev/ttyS0"`` + Have guest permanently boot off a local kernel/initrd pair, with the + specified kernel options. + +``--boot kernel=KERNEL,initrd=INITRD,dtb=DTB`` + Have guest permanently boot off a local kernel/initrd pair with an + external device tree binary. DTB can be required for some non-x86 + configurations like ARM or PPC + +``--boot loader=BIOSPATH`` + Use BIOSPATH as the virtual machine BIOS. + +``--boot bootmenu.enable=on,bios.useserial=on`` + Enable the bios boot menu, and enable sending bios text output over + serial console. + +``--boot init=INITPATH`` + Path to a binary that the container guest will init. If a root ``--filesystem`` + has been specified, virt-install will default to /sbin/init, otherwise + will default to /bin/sh. + +``--boot uefi`` + Configure the VM to boot from UEFI. In order for virt-install to know the + correct UEFI parameters, libvirt needs to be advertising known UEFI binaries + via domcapabilities XML, so this will likely only work if using properly + configured distro packages. + +``--boot loader=/.../OVMF_CODE.fd,loader.readonly=yes,loader.type=pflash,nvram.template=/.../OVMF_VARS.fd,loader_secure=no`` + Specify that the virtual machine use the custom OVMF binary as boot firmware, + mapped as a virtual flash chip. In addition, request that libvirt instantiate + the VM-specific UEFI varstore from the custom "/.../OVMF_VARS.fd" varstore + template. This is the recommended UEFI setup, and should be used if + --boot uefi doesn't know about your UEFI binaries. If your UEFI firmware + supports Secure boot feature you can enable it via loader_secure. + +Use --boot=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsOS + + + +``--idmap`` +^^^^^^^^^^^ + +**Syntax:** ``--idmap`` OPTIONS + +If the guest configuration declares a UID or GID mapping, +the 'user' namespace will be enabled to apply these. +A suitably configured UID/GID mapping is a pre-requisite to +make containers secure, in the absence of sVirt confinement. + +--idmap can be specified to enable user namespace for LXC containers. Example: + +.. code-block:: + + --idmap uid.start=0,uid.target=1000,uid.count=10,gid.start=0,gid.target=1000,gid.count=10 + +Use --idmap=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsOSContainer + + + +GUEST OS OPTIONS +================ + + +``--os-variant`` +^^^^^^^^^^^^^^^^ + +**Syntax:** ``--os-variant`` OS_VARIANT + +Optimize the guest configuration for a specific operating system (ex. +'fedora29', 'rhel7', 'win10'). While not required, specifying this +options is HIGHLY RECOMMENDED, as it can greatly increase performance +by specifying virtio among other guest tweaks. + +By default, virt-install will attempt to auto detect this value from +the install media (currently only supported for URL installs). Autodetection +can be disabled with the special value 'none'. Autodetection can be +forced with the special value 'auto'. + +Use the command "osinfo-query os" to get the list of the accepted OS +variants. + + + +STORAGE OPTIONS +=============== + + +``--disk`` +^^^^^^^^^^ + +**Syntax:** ``--disk`` OPTIONS + +Specifies media to use as storage for the guest, with various options. The +general format of a disk string is + +.. code-block:: + + --disk opt1=val1,opt2=val2,... + +The simplest invocation to create a new 10G disk image and associated disk device: + +.. code-block:: + + --disk size=10 + +virt-install will generate a path name, and place it in the default image location for the hypervisor. To specify media, the command can either be: + +.. code-block:: + + --disk /some/storage/path[,opt1=val1]... + +or explicitly specify one of the following arguments: + +``path`` + A path to some storage media to use, existing or not. Existing media can be + a file or block device. + + Specifying a non-existent path implies attempting to create the new storage, + and will require specifying a 'size' value. Even for remote hosts, virt-install + will try to use libvirt storage APIs to automatically create the given path. + + If the hypervisor supports it, ``path`` can also be a network URL, like + https://example.com/some-disk.img . For network paths, they hypervisor will + directly access the storage, nothing is downloaded locally. + +``pool`` + An existing libvirt storage pool name to create new storage on. Requires + specifying a 'size' value. + +``vol`` + An existing libvirt storage volume to use. This is specified as + 'poolname/volname'. + + +Options that apply to storage creation: + +``size`` + size (in GiB) to use if creating new storage + +``sparse`` + whether to skip fully allocating newly created storage. Value is 'yes' or + 'no'. Default is 'yes' (do not fully allocate) unless it isn't + supported by the underlying storage type. + + The initial time taken to fully-allocate the guest virtual disk (sparse=no) + will be usually balanced by faster install times inside the guest. Thus + use of this option is recommended to ensure consistently high performance + and to avoid I/O errors in the guest should the host filesystem fill up. + +``format`` + Disk image format. For file volumes, this can be 'raw', 'qcow2', 'vmdk', etc. + See format types in https://libvirt.org/storage.html for possible values. + This is often mapped to the ``driver_type`` value as well. + + If not specified when creating file images, this will default to 'qcow2'. + + If creating storage, this will be the format of the new image. + If using an existing image, this overrides libvirt's format auto-detection. + +``backing_store`` + Path to a disk to use as the backing store for the newly created image. + +``backing_format`` + Disk image format of ``backing_store`` + +Some example device configuration suboptions: + +``device`` + Disk device type. Example values are be 'cdrom', 'disk', 'lun' or 'floppy'. + The default is 'disk'. + +``boot.order`` + Guest installation with multiple disks will need this parameter to boot + correctly after being installed. A boot.order parameter will take values 1,2,3,... + Devices with lower value has higher priority. + This option applies to other bootable device types as well. + +``target.bus** or *bus`` + Disk bus type. Example values are be 'ide', 'sata', 'scsi', 'usb', 'virtio' or 'xen'. + The default is hypervisor dependent since not all hypervisors support all + bus types. + +``readonly`` + Set drive as readonly (takes 'on' or 'off') + +``shareable`` + Set drive as shareable (takes 'on' or 'off') + +``cache`` + The cache mode to be used. The host pagecache provides cache memory. + The cache value can be 'none', 'writethrough', 'directsync', 'unsafe' + or 'writeback'. + 'writethrough' provides read caching. 'writeback' provides + read and write caching. 'directsync' bypasses the host page + cache. 'unsafe' may cache all content and ignore flush requests from + the guest. + +``driver.discard`` + Whether discard (also known as "trim" or "unmap") requests are ignored + or passed to the filesystem. The value can be either "unmap" (allow + the discard request to be passed) or "ignore" (ignore the discard + request). Since 1.0.6 (QEMU and KVM only) + +``driver.name`` + Driver name the hypervisor should use when accessing the specified + storage. Typically does not need to be set by the user. + +``driver.type`` + Driver format/type the hypervisor should use when accessing the specified + storage. Typically does not need to be set by the user. + +``driver.io`` + Disk IO backend. Can be either "threads", "native" or "io_uring". + +``driver.error_policy`` + How guest should react if a write error is encountered. Can be one of + "stop", "ignore", or "enospace" + +``serial`` + Serial number of the emulated disk device. This is used in linux guests + to set /dev/disk/by-id symlinks. An example serial number might be: + WD-WMAP9A966149 + +``source.startupPolicy`` + It defines what to do with the disk if the source file is not accessible. + +``snapshot`` + Defines default behavior of the disk during disk snapshots. + +See the examples section for some uses. This option deprecates -f/--file, +-s/--file-size, --nonsparse, and --nodisks. + +Use --disk=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsDisks + + + +``--filesystem`` +^^^^^^^^^^^^^^^^ + +Specifies a directory on the host to export to the guest. The most simple +invocation is: + +.. code-block:: + + --filesystem /source/on/host,/target/point/in/guest + +Which will work for recent QEMU and linux guest OS or LXC containers. For +QEMU, the target point is just a mounting hint in sysfs, so will not be +automatically mounted. + +Some example suboptions: + +``type`` + The type or the source directory. Valid values are 'mount' (the default) or + 'template' for OpenVZ templates. + +``accessmode`` or ``mode`` + The access mode for the source directory from the guest OS. Only used with + QEMU and type=mount. Valid modes are 'passthrough' (the default), 'mapped', + or 'squash'. See libvirt domain XML documentation for more info. + +``source`` + The directory on the host to share. + +``target`` + The mount location to use in the guest. + +Use --filesystem=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsFilesystems + + + +NETWORKING OPTIONS +================== + + +``-w``, ``--network`` +^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``-w``, ``--network`` OPTIONS + +Connect the guest to the host network. Examples for specifying the network type: + +``bridge=BRIDGE`` + Connect to a bridge device in the host called ``BRIDGE``. Use this option if + the host has static networking config & the guest requires full outbound + and inbound connectivity to/from the LAN. Also use this if live migration + will be used with this guest. + +``network=NAME`` + Connect to a virtual network in the host called ``NAME``. Virtual networks + can be listed, created, deleted using the ``virsh`` command line tool. In + an unmodified install of ``libvirt`` there is usually a virtual network + with a name of ``default``. Use a virtual network if the host has dynamic + networking (eg NetworkManager), or using wireless. The guest will be + NATed to the LAN by whichever connection is active. + +``type=direct,source=IFACE[,source.mode=MODE]`` + Direct connect to host interface IFACE using macvtap. + +``user`` + Connect to the LAN using SLIRP. Only use this if running a QEMU guest as + an unprivileged user. This provides a very limited form of NAT. + +``none`` + Tell virt-install not to add any default network interface. + +If ``--network`` is omitted a single NIC will be created in the guest. If +there is a bridge device in the host with a physical interface enslaved, +that will be used for connectivity. Failing that, the virtual network +called ``default`` will be used. This option can be specified multiple +times to setup more than one NIC. + +Some example suboptions: + +``model.type`` or ``model`` + Network device model as seen by the guest. Value can be any nic model supported + by the hypervisor, e.g.: 'e1000', 'rtl8139', 'virtio', ... + +``mac.address`` or ``mac`` + Fixed MAC address for the guest; If this parameter is omitted, or the value + ``RANDOM`` is specified a suitable address will be randomly generated. For + Xen virtual machines it is required that the first 3 pairs in the MAC address + be the sequence '00:16:3e', while for QEMU or KVM virtual machines it must + be '52:54:00'. + +``filterref.filter`` + Controlling firewall and network filtering in libvirt. Value can be any nwfilter + defined by the ``virsh`` 'nwfilter' subcommands. Available filters can be listed + by running 'virsh nwfilter-list', e.g.: 'clean-traffic', 'no-mac-spoofing', ... + +``virtualport.*`` options + Configure the device virtual port profile. This is used for 802.Qbg, 802.Qbh, + midonet, and openvswitch config. + + Use --network=? to see a list of all available sub options. + Complete details at https://libvirt.org/formatdomain.html#elementsNICS + + This option deprecates -m/--mac, -b/--bridge, and --nonetworks + + + +GRAPHICS OPTIONS +================ + +If no graphics option is specified, ``virt-install`` will try to select +the appropriate graphics if the DISPLAY environment variable is set, +otherwise '--graphics none' is used. + + + +``--graphics`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--graphics`` TYPE,opt1=arg1,opt2=arg2,... + +Specifies the graphical display configuration. This does not configure any +virtual hardware, just how the guest's graphical display can be accessed. +Typically the user does not need to specify this option, virt-install will +try and choose a useful default, and launch a suitable connection. + +General format of a graphical string is + +.. code-block:: + + --graphics TYPE,opt1=arg1,opt2=arg2,... + +For example: + +.. code-block:: + + --graphics vnc,password=foobar + +Some supported TYPE values: + +``vnc`` + Setup a virtual console in the guest and export it as a VNC server in + the host. Unless the ``port`` parameter is also provided, the VNC + server will run on the first free port number at 5900 or above. The + actual VNC display allocated can be obtained using the ``vncdisplay`` + command to ``virsh`` (or virt-viewer(1) can be used which handles this + detail for the use). + +``spice`` + Export the guest's console using the Spice protocol. Spice allows advanced + features like audio and USB device streaming, as well as improved graphical + performance. + + Using spice graphic type will work as if those arguments were given: + + .. code-block:: + + --video qxl --channel spicevmc + +``none`` + No graphical console will be allocated for the guest. Guests will likely + need to have a text console configured on the first + serial port in the guest (this can be done via the --extra-args option). The + command 'virsh console NAME' can be used to connect to the serial device. + + +Some supported suboptions: + +``port`` + Request a permanent, statically assigned port number for the guest + console. This is used by 'vnc' and 'spice' + +``tlsPort`` + Specify the spice tlsport. + +``websocket`` + Request a VNC WebSocket port for the guest console. + + If -1 is specified, the WebSocket port is auto-allocated. + + This is used by 'vnc' and 'spice' + +``listen`` + Address to listen on for VNC/Spice connections. Default is typically 127.0.0.1 + (localhost only), but some hypervisors allow changing this globally (for + example, the qemu driver default can be changed in /etc/libvirt/qemu.conf). + Use 0.0.0.0 to allow access from other machines. + + Use 'none' to specify that the display server should not listen on any + port. The display server can be accessed only locally through + libvirt unix socket (virt-viewer with --attach for instance). + + Use 'socket' to have the VM listen on a libvirt generated unix socket + path on the host filesystem. + + This is used by 'vnc' and 'spice' + +``password`` + Request a console password, required at connection time. Beware, this info may + end up in virt-install log files, so don't use an important password. This + is used by 'vnc' and 'spice' + +``gl.enable`` + Whether to use OpenGL accelerated rendering. Value is 'yes' or 'no'. This is + used by 'spice'. + +``gl.rendernode`` + DRM render node path to use. This is used when 'gl' is enabled. + +Use --graphics=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsGraphics + +This deprecates the following options: +--vnc, --vncport, --vnclisten, -k/--keymap, --sdl, --nographics + + + +``--autoconsole`` +^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--autoconsole`` OPTIONS + +Configure what interactive console virt-install will launch for the VM. This +option is not required; the default behavior is adaptive and dependent on +how the VM is configured. But you can use this option to override the default +choice. + +``--autoconsole graphical`` + Use the graphical virt-viewer(1) as the interactive console + +``--autoconsole text`` + Use the text mode ``virsh console`` as the interactive console. + +``--autoconsole none`` + This is the same as ``--noautoconsole`` + +``--noautoconsole`` + Don't automatically try to connect to the guest console. Same as + ``--autoconsole none`` + +Note, virt-install exits quickly when this option is specified. If your +command requested a multistep install, like --cdrom or --location, after +the install phase is complete the VM will be shutoff, regardless of +whether a reboot was requested in the VM. If you want the VM to be +rebooted, virt-install must remain running. You can use '--wait' to keep +virt-install alive even if --noautoconsole is specified. + + + +VIRTUALIZATION OPTIONS +====================== + +Options to override the default virtualization type choices. + + +``-v``, ``--hvm`` +^^^^^^^^^^^^^^^^^ + +Request the use of full virtualization, if both para & full virtualization are +available on the host. This parameter may not be available if connecting to a +Xen hypervisor on a machine without hardware virtualization support. This +parameter is implied if connecting to a QEMU based hypervisor. + + +``-p``, ``--paravirt`` +^^^^^^^^^^^^^^^^^^^^^^ + +This guest should be a paravirtualized guest. If the host supports both +para & full virtualization, and neither this parameter nor the ``--hvm`` +are specified, this will be assumed. + + +``--container`` +^^^^^^^^^^^^^^^ + +This guest should be a container type guest. This option is only required +if the hypervisor supports other guest types as well (so for example this +option is the default behavior for LXC and OpenVZ, but is provided for +completeness). + + +``--virt-type`` +^^^^^^^^^^^^^^^ + +The hypervisor to install on. Example choices are kvm, qemu, or xen. +Available options are listed via 'virsh capabilities' in the <domain> tags. + +This deprecates the --accelerate option, which is now the default behavior. +To install a plain QEMU guest, use '--virt-type qemu' + + + +DEVICE OPTIONS +============== + +All devices have a set of ``address.*`` options for configuring the +particulars of the device's address on its parent controller or bus. +See ``https://libvirt.org/formatdomain.html#elementsAddress`` for details. + + + +``--controller`` +^^^^^^^^^^^^^^^^ + +**Syntax:** ``--controller`` OPTIONS + +Attach a controller device to the guest. TYPE is one of: +``ide``, ``fdc``, ``scsi``, ``sata``, ``virtio-serial``, or ``usb`` . + +Controller also supports the special values ``usb2`` and ``usb3`` to +specify which version of the USB controller should be used (version 2 +or 3). + +Some example suboptions: + +``model`` + Controller model. These may vary according to the hypervisor and its + version. Most commonly used models are e.g. ``auto`` , ``virtio-scsi`` + for the ``scsi`` controller, ``ehci`` or ``none``for the ``usb`` + controller. + +Use --controller=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsControllers + + + +``--input`` +^^^^^^^^^^^ + +**Syntax:** ``--input`` OPTIONS + +Attach an input device to the guest. Example input device types are mouse, tablet, or keyboard. + +Use --input=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsInput + + + +``--hostdev``, ``--host-device`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Syntax:** ``--hostdev``, ``--host-device`` OPTIONS + +Attach a physical host device to the guest. Some example values for HOSTDEV: + +``--hostdev pci_0000_00_1b_0`` + A node device name via libvirt, as shown by 'virsh nodedev-list' + +``--hostdev 001.003`` + USB by bus, device (via lsusb). + +``--hostdev 0x1234:0x5678`` + USB by vendor, product (via lsusb). + +``--hostdev 1f.01.02`` + PCI device (via lspci). + +``--hostdev wlan0,type=net`` + Network device (in LXC container). + +``--hostdev /dev/net/tun,type=misc`` + Character device (in LXC container). + +``--hostdev /dev/sdf,type=storage`` + Block device (in LXC container). + +Use --hostdev=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsHostDev + + + +``--sound`` +^^^^^^^^^^^ + +**Syntax:** ``--sound`` MODEL + +Attach a virtual audio device to the guest. MODEL specifies the emulated +sound card model. Possible values are ich6, ich9, ac97, es1370, sb16, pcspk, +or default. 'default' will try to pick the best model that the specified +OS supports. + +This deprecates the old --soundhw option. +Use --sound=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsSound + + + +``--watchdog`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--watchdog`` MODEL[,action=ACTION] + +Attach a virtual hardware watchdog device to the guest. This requires a +daemon and device driver in the guest. The watchdog fires a signal when +the virtual machine appears to hung. ACTION specifies what libvirt will do +when the watchdog fires. Values are + +``reset`` + Forcefully reset the guest (the default) + +``poweroff`` + Forcefully power off the guest + +``pause`` + Pause the guest + +``none`` + Do nothing + +``shutdown`` + Gracefully shutdown the guest (not recommended, since a hung guest probably + won't respond to a graceful shutdown) + +MODEL is the emulated device model: either i6300esb (the default) or ib700. +Some examples: + +``--watchdog default`` + Use the recommended settings + +``--watchdog i6300esb,action=poweroff`` + Use the i6300esb with the 'poweroff' action + +Use --watchdog=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsWatchdog + + + +``--serial`` +^^^^^^^^^^^^ + +**Syntax:** ``--serial`` OPTIONS + +Specifies a serial device to attach to the guest, with various options. The +general format of a serial string is + +.. code-block:: + + --serial type,opt1=val1,opt2=val2,... + +--serial and --parallel devices share all the same options, unless otherwise +noted. Some of the types of character device redirection are: + +``--serial pty`` + Pseudo TTY. The allocated pty will be listed in the running guests XML + description. + +``--serial dev,path=HOSTPATH`` + Host device. For serial devices, this could be /dev/ttyS0. For parallel + devices, this could be /dev/parport0. + +``--serial file,path=FILENAME`` + Write output to FILENAME. + +``--serial tcp,host=HOST:PORT,source.mode=MODE,protocol.type=PROTOCOL`` + TCP net console. MODE is either 'bind' (wait for connections on HOST:PORT) + or 'connect' (send output to HOST:PORT), default is 'bind'. HOST defaults + to '127.0.0.1', but PORT is required. PROTOCOL can be either 'raw' or 'telnet' + (default 'raw'). If 'telnet', the port acts like a telnet server or client. + Some examples: + + Wait for connections on any address, port 4567: + + --serial tcp,host=0.0.0.0:4567 + + Connect to localhost, port 1234: + + --serial tcp,host=:1234,source.mode=connect + + Wait for telnet connection on localhost, port 2222. The user could then + connect interactively to this console via 'telnet localhost 2222': + + --serial tcp,host=:2222,source.mode=bind,source.protocol=telnet + +``--serial udp,host=CONNECT_HOST:PORT,bind_host=BIND_HOST:BIND_PORT`` + UDP net console. HOST:PORT is the destination to send output to (default + HOST is '127.0.0.1', PORT is required). BIND_HOST:BIND_PORT is the optional + local address to bind to (default BIND_HOST is 127.0.0.1, but is only set if + BIND_PORT is specified). Some examples: + + Send output to default syslog port (may need to edit /etc/rsyslog.conf + accordingly): + + --serial udp,host=:514 + + Send output to remote host 192.168.10.20, port 4444 (this output can be + read on the remote host using 'nc -u -l 4444'): + + --serial udp,host=192.168.10.20:4444 + +``--serial unix,path=UNIXPATH,mode=MODE`` + Unix socket, see unix(7). MODE has similar behavior and defaults as + --serial tcp,mode=MODE + +Use --serial=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCharSerial + + + +``--parallel`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--parallel`` OPTIONS + +Specify a parallel device. The format and options are largely identical +to ``serial`` + +Use --parallel=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCharParallel + + + +``--channel`` +^^^^^^^^^^^^^ + +Specifies a communication channel device to connect the guest and host +machine. This option uses the same options as --serial and --parallel +for specifying the host/source end of the channel. Extra 'target' options +are used to specify how the guest machine sees the channel. + +Some of the types of character device redirection are: + +``--channel SOURCE,target.type=guestfwd,target.address=HOST:PORT`` + Communication channel using QEMU usermode networking stack. The guest can + connect to the channel using the specified HOST:PORT combination. + +``--channel SOURCE,target.type=virtio[,target.name=NAME]`` + Communication channel using virtio serial (requires 2.6.34 or later host and + guest). Each instance of a virtio --channel line is exposed in the + guest as /dev/vport0p1, /dev/vport0p2, etc. NAME is optional metadata, and + can be any string, such as org.linux-kvm.virtioport1. + If specified, this will be exposed in the guest at + /sys/class/virtio-ports/vport0p1/NAME + +``--channel spicevmc,target.type=virtio[,target.name=NAME]`` + Communication channel for QEMU spice agent, using virtio serial + (requires 2.6.34 or later host and guest). NAME is optional metadata, + and can be any string, such as the default com.redhat.spice.0 that + specifies how the guest will see the channel. + + +Use --channel=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCharChannel + + + +``--console`` +^^^^^^^^^^^^^ + +Connect a text console between the guest and host. Certain guest and +hypervisor combinations can automatically set up a getty in the guest, so +an out of the box text login can be provided (target_type=xen for xen +paravirt guests, and possibly target_type=virtio in the future). + +Example: + +``--console pty,target.type=virtio`` + Connect a virtio console to the guest, redirected to a PTY on the host. + For supported guests, this exposes /dev/hvc0 in the guest. See + https://fedoraproject.org/wiki/Features/VirtioSerial for more info. virtio + console requires libvirt 0.8.3 or later. + + +Use --console=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsCharConsole + + + +``--video`` +^^^^^^^^^^^ + +**Syntax:** ``--video`` OPTIONS + +Specify what video device model will be attached to the guest. Valid values +for VIDEO are hypervisor specific, but some options for recent kvm are +cirrus, vga, qxl, virtio, or vmvga (vmware). +Use --video=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsVideo + + + +``--smartcard`` +^^^^^^^^^^^^^^^ + +**Syntax:** ``--smartcard`` MODE[,OPTIONS] + +Configure a virtual smartcard device. + +Example MODE values are ``host``, ``host-certificates``, or ``passthrough``. +Example suboptions include: + +``type`` + Character device type to connect to on the host. This is only applicable + for ``passthrough`` mode. + +An example invocation: + +``--smartcard passthrough,type=spicevmc`` + Use the smartcard channel of a SPICE graphics device to pass smartcard info + to the guest + +Use --smartcard=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsSmartcard + + + +``--redirdev`` +^^^^^^^^^^^^^^ + +**Syntax:** ``--redirdev`` BUS[,OPTIONS] + +Add a redirected device. Example suboptions: + +``type`` + The redirection type, currently supported is ``tcp`` or ``spicevmc`` . + +``server`` + The TCP server connection details, of the form 'server:port'. + +Examples invocations: + +``--redirdev usb,type=tcp,server=localhost:4000`` + Add a USB redirected device provided by the TCP server on 'localhost' + port 4000. + +``--redirdev usb,type=spicevmc`` + Add a USB device redirected via a dedicated Spice channel. + + +Use --redirdev=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsRedir + + + +``--memballoon`` +^^^^^^^^^^^^^^^^ + +**Syntax:** ``--memballoon`` MODEL[,OPTIONS] + +Attach a virtual memory balloon device to the guest. If the memballoon device +needs to be explicitly disabled, MODEL='none' is used. + +MODEL is the type of memballoon device provided. The value can be 'virtio', +'xen' or 'none'. Some examples: + +``--memballoon virtio`` + Explicitly create a 'virtio' memballoon device + +``--memballoon none`` + Disable the memballoon device + +Use --memballoon=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMemBalloon + + + +``--tpm`` +^^^^^^^^^ + +**Syntax:** ``--tpm`` TYPE[,OPTIONS] + +Configure a virtual TPM device. Examples: + +``--tpm /dev/tpm`` + Convenience option for passing through the hosts TPM. + +``--tpm emulator`` + Request an emulated TPM device. + +Use --tpm=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsTpm + + + +``--rng`` +^^^^^^^^^ + +**Syntax:** ``--rng`` TYPE[,OPTIONS] + +Configure a virtual RNG device. + +Example TYPE values include ``random``, ``egd`` or ``builtin``. + +Example invocations: + +``--rng /dev/urandom`` + Use the /dev/urandom device to get entropy data, this form implicitly uses the + "random" model. + +``--rng builtin`` + Use the builtin rng device to get entropy data. + +``--rng egd,backend.source.host=localhost,backend.source.service=8000,backend.type=tcp`` + Connect to localhost to the TCP port 8000 to get entropy data. + +Use --rng=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsRng + + + +``--panic`` +^^^^^^^^^^^ + +**Syntax:** ``--panic`` MODEL[,OPTS] + +Attach a panic notifier device to the guest. +For the recommended settings, use: ``--panic default`` + +Use --panic=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsPanic + + + +``--memdev`` +^^^^^^^^^^^^ + +**Syntax:** ``--memdev`` OPTS + +Add a memory module to a guest which can be hotunplugged. To add a memdev you need +to configure hotplugmemory and NUMA for a guest. + +Use --memdev=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#elementsMemory. + + + +``--vsock`` +^^^^^^^^^^^ + +**Syntax:** ``--vsock`` OPTS + +Configure a vsock host/guest interface. A typical configuration would be + +.. code-block:: + + --vsock cid.auto=yes + +Use --vsock=? to see a list of all available sub options. +Complete details at https://libvirt.org/formatdomain.html#vsock. + + + +``--iommu`` +^^^^^^^^^^^ + +**Syntax:** ``--iommu`` MODEL[,OPTS] + +Add an IOMMU device to the guest. + +Use --iommu=? to see a list of all available options. +Complete details at https://libvirt.org/formatdomain.html#elementsIommu. + + + + +MISCELLANEOUS OPTIONS +===================== + + +``-h``, ``--help`` +^^^^^^^^^^^^^^^^^^ + +Show the help message and exit + + + +``--version`` +^^^^^^^^^^^^^ + +Show program's version number and exit + + + +``--autostart`` +^^^^^^^^^^^^^^^ + +Set the autostart flag for a domain. This causes the domain to be started +on host boot up. + + + +``--transient`` +^^^^^^^^^^^^^^^ + +Use --import or --boot and --transient if you want a transient libvirt +VM. These VMs exist only until the domain is shut down or the host +server is restarted. Libvirt forgets the XML configuration of the VM +after either of these events. Note that the VM's disks will not be +deleted. See: +https://wiki.libvirt.org/page/VM_lifecycle#Transient_guest_domains_vs_Persistent_guest_domains + + + +``--destroy-on-exit`` +^^^^^^^^^^^^^^^^^^^^^ + +When the VM console window is exited, destroy (force poweroff) the VM. +If you combine this with --transient, this makes the virt-install command +work similar to qemu, where the VM is shutdown when the console window +is closed by the user. + + + +``--print-xml`` +^^^^^^^^^^^^^^^ + +**Syntax:** ``--print-xml`` [STEP] + +Print the generated XML of the guest, instead of defining it. By default this +WILL do storage creation (can be disabled with --dry-run). This option implies --quiet. + +If the VM install has multiple phases, by default this will print all +generated XML. If you want to print a particular step, use --print-xml 2 +(for the second phase XML). + + + +``--noreboot`` +^^^^^^^^^^^^^^ + +Prevent the domain from automatically rebooting after the install has +completed. + + + +``--wait`` +^^^^^^^^^^ + +**Syntax:** ``--wait`` WAIT + +Configure how virt-install will wait for the install to complete. +Without this option, virt-install will wait for the console to close (not +necessarily indicating the guest has shutdown), or in the case of +--noautoconsole, simply kick off the install and exit. + +Bare '--wait' or any negative value will make virt-install wait indefinitely. +Any positive number is the number of minutes virt-install will wait. If the +time limit is exceeded, virt-install simply exits, leaving the virtual machine +in its current state. + + + +``--dry-run`` +^^^^^^^^^^^^^ + +Proceed through the guest creation process, but do NOT create storage devices, +change host device configuration, or actually teach libvirt about the guest. +virt-install may still fetch install media, since this is required to +properly detect the OS to install. + + + +``--check`` +^^^^^^^^^^^ + +Enable or disable some validation checks. Some examples are warning about using a disk that's already assigned to another VM (--check path_in_use=on|off), or warning about potentially running out of space during disk allocation (--check disk_size=on|off). Most checks are performed by default. + + + +``-q``, ``--quiet`` +^^^^^^^^^^^^^^^^^^^ + +Only print fatal error messages. + + + +``-d``, ``--debug`` +^^^^^^^^^^^^^^^^^^^ + +Print debugging information to the terminal when running the install process. +The debugging information is also stored in +``~/.cache/virt-manager/virt-install.log`` even if this parameter is omitted. + + + + +EXAMPLES +======== + +The simplest invocation to interactively install a Fedora 29 KVM VM +with recommended defaults. virt-viewer(1) will be launched to +graphically interact with the VM install + +.. code-block:: + + # sudo virt-install --install fedora29 + + + +Similar, but use libosinfo's unattended install support, which will +perform the fedora29 install automatically without user intervention: + +.. code-block:: + + # sudo virt-install --install fedora29 --unattended + + + +Install a Windows 10 VM, using 40GiB storage in the default location +and 4096MiB of ram, and ensure we are connecting to the system libvirtd +instance: + +.. code-block:: + + # virt-install \ + --connect qemu:///system \ + --name my-win10-vm \ + --memory 4096 \ + --disk size=40 \ + --os-variant win10 \ + --cdrom /path/to/my/win10.iso + + + +Install a CentOS 7 KVM from a URL, with recommended device defaults and +default required storage, but specifically request VNC graphics instead +of the default SPICE, and request 8 virtual CPUs and 8192 MiB of memory: + +.. code-block:: + + # virt-install \ + --connect qemu:///system \ + --memory 8192 \ + --vcpus 8 \ + --graphics vnc \ + --os-variant centos7.0 \ + --location http://mirror.centos.org/centos-7/7/os/x86_64/ + + + +Create a VM around an existing debian9 disk image: + +.. code-block:: + + # virt-install \ + --import \ + --memory 512 \ + --disk /home/user/VMs/my-debian9.img \ + --os-variant debian9 + + + +Start serial QEMU ARM VM, which requires specifying a manual kernel. + +.. code-block:: + + # virt-install \ + --name armtest \ + --memory 1024 \ + --arch armv7l --machine vexpress-a9 \ + --disk /home/user/VMs/myarmdisk.img \ + --boot kernel=/tmp/my-arm-kernel,initrd=/tmp/my-arm-initrd,dtb=/tmp/my-arm-dtb,kernel_args="console=ttyAMA0 rw root=/dev/mmcblk0p3" \ + --graphics none + + + +Start an SEV launch security VM with 4GB RAM, 4GB+256MiB of hard_limit, with a +couple of virtio devices: + +Note: The IOMMU flag needs to be turned on with driver.iommu for virtio +devices. Usage of --memtune is currently required because of SEV limitations, +refer to libvirt docs for a detailed explanation. + +.. code-block:: + + # virt-install \ + --name foo \ + --memory 4096 \ + --boot uefi \ + --machine q35 \ + --memtune hard_limit=4563402 \ + --disk size=15,target.bus=scsi \ + --import \ + --controller type=scsi,model=virtio-scsi,driver.iommu=on \ + --controller type=virtio-serial,driver.iommu=on \ + --network network=default,model=virtio,driver.iommu=on \ + --rng /dev/random,driver.iommu=on \ + --memballoon driver.iommu=on \ + --launchSecurity sev + + + +BUGS +==== + +Please see https://virt-manager.org/bugs + + + +COPYRIGHT +========= + +Copyright (C) Red Hat, Inc, and various contributors. +This is free software. You may redistribute copies of it under the terms of +the GNU General Public License https://www.gnu.org/licenses/gpl.html. There +is NO WARRANTY, to the extent permitted by law. + + + +SEE ALSO +======== + +``virsh(1)``, ``virt-clone(1)``, ``virt-manager(1)``, the project website https://virt-manager.org diff --git a/man/virt-manager.pod b/man/virt-manager.pod deleted file mode 100644 index 387133f0..00000000 --- a/man/virt-manager.pod +++ /dev/null @@ -1,107 +0,0 @@ - -=head1 NAME - -virt-manager - display the virtual machine desktop management tool - -=head1 SYNOPSIS - -B<virt-manager> [OPTIONS] - -=head1 DESCRIPTION - -B<virt-manager> is a desktop tool for managing virtual machines. It -provides the ability to control the lifecycle of existing machines -(bootup/shutdown,pause/resume,suspend/restore), provision new virtual -machines and various types of store, manage virtual networks, -access the graphical console of virtual machines, and view performance -statistics, all done locally or remotely. - -=head1 OPTIONS - -The following options are accepted when running C<virt-manager>: - -=over 4 - -=item B<-h> - -=item B<--help> - -Display command line help summary - -=item B<--version> - -Show virt-manager's version number and exit - -=item B<-c> URI - -=item B<--connect>=URI - -Specify the hypervisor connection C<URI> - -=item B<--debug> - -List debugging output to the console (normally this is only logged in -~/.cache/virt-manager/virt-manager.log). This function implies --no-fork. - -=item B<--no-fork> - -Don't fork C<virt-manager> off into the background: run it blocking the -current terminal. Useful for seeing possible errors dumped to stdout/stderr. - -=item B<--show-DIALOG-WINDOW> - -Display the corresponding C<DIALOG-WINDOW> when launching C<virt-manager>. -Connection autostart is skipped, and the manager window will not be shown -at startup in this case. - -The following C<DIALOG-WINDOW> options are currently available: - -=over 4 - -=item B<--show-domain-creator> - -Display the wizard for creating new virtual machines - -=item B<--show-domain-editor> NAME|ID|UUID - -Display the dialog for editing properties of the virtual machine with -unique ID matching either the domain name, ID, or UUID - -=item B<--show-domain-performance> NAME|ID|UUID - -Display the dialog for monitoring performance of the virtual machine with -unique ID matching either the domain name, ID, or UUID - -=item B<--show-domain-console> NAME|ID|UUID - -Display the virtual console of the virtual machine with -unique ID matching either the domain name, ID, or UUID - -=item B<--show-host-summary> - -Display the main window summarizing performance for all virtual machines -on the host. - -=back - -=back - -Standard GTK options like --g-fatal-warnings are also accepted. - -=head1 BUGS - -Please see L<https://virt-manager.org/bugs/> - -=head1 COPYRIGHT - -Copyright (C) Red Hat, Inc, and various contributors. -This is free software. You may redistribute copies of it under the terms of the GNU General -Public License C<https://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent -permitted by law. - -=head1 SEE ALSO - -C<virsh(1)>, C<virt-viewer(1)>, the project website C<https://virt-manager.org> - -=cut - diff --git a/man/virt-manager.rst b/man/virt-manager.rst new file mode 100644 index 00000000..88ccedaa --- /dev/null +++ b/man/virt-manager.rst @@ -0,0 +1,110 @@ +============ +virt-manager +============ + +--------------------------------------- +Graphical tool for managing libvirt VMs +--------------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + + +SYNOPSIS +======== + +``virt-manager`` [OPTIONS] + + +DESCRIPTION +=========== + + +``virt-manager`` is a desktop tool for managing virtual machines. It +provides the ability to control the lifecycle of existing machines +(bootup/shutdown,pause/resume,suspend/restore), provision new virtual +machines and various types of store, manage virtual networks, +access the graphical console of virtual machines, and view performance +statistics, all done locally or remotely. + + +OPTIONS +======= + +Standard GTK options like ``--g-fatal-warnings`` are accepted. + +The following options are accepted when running ``virt-manager`` + + +``-h``, ``--help`` + Display command line help summary + + +``--version`` + Show virt-manager's version number and exit + + +``-c``, ``--connect`` + Specify the hypervisor connection **URI** + + +``--debug`` + List debugging output to the console (normally this is only logged in + ~/.cache/virt-manager/virt-manager.log). This function implies --no-fork. + + +``--no-fork`` + Don't fork ``virt-manager`` off into the background: run it blocking the + current terminal. Useful for seeing possible errors dumped to stdout/stderr. + + +DIALOG WINDOW OPTIONS +===================== + +For these options, only the requested window will be shown, the manaer +window will not be run in this case. Connection autostart will also +be disabled. All these options require specifying a manual ``--connect`` +URI. + +``--show-domain-creator`` + Display the wizard for creating new virtual machines + + +``--show-domain-editor`` NAME|ID|UUID + Display the dialog for editing properties of the virtual machine with + unique ID matching either the domain name, ID, or UUID + + +``--show-domain-performance`` NAME|ID|UUID + Display the dialog for monitoring performance of the virtual machine with + unique ID matching either the domain name, ID, or UUID + + +``--show-domain-console`` NAME|ID|UUID + Display the virtual console of the virtual machine with + unique ID matching either the domain name, ID, or UUID + + +``--show-host-summary`` + Display the host/connection details window. + + +BUGS +==== + +Please see https://virt-manager.org/bugs/ + + +COPYRIGHT +========= + +Copyright (C) Red Hat, Inc, and various contributors. +This is free software. You may redistribute copies of it under the terms of the GNU General +Public License https://www.gnu.org/licenses/gpl.html. There is NO WARRANTY, to the extent +permitted by law. + + +SEE ALSO +======== + +``virsh(1)``, ``virt-viewer(1)``, the project website https://virt-manager.org diff --git a/man/virt-xml.pod b/man/virt-xml.pod deleted file mode 100644 index 12f9a7b9..00000000 --- a/man/virt-xml.pod +++ /dev/null @@ -1,437 +0,0 @@ -=pod - -=head1 NAME - -virt-xml - Edit libvirt XML using command line options. - -=head1 SYNOPSIS - -B<virt-xml> DOMAIN XML-ACTION XML-OPTION [OUTPUT-OPTION] [MISC-OPTIONS] ... - -=head1 DESCRIPTION - -B<virt-xml> is a command line tool for editing libvirt XML using explicit command line options. See the EXAMPLES section at the end of this document to jump right in. - -Each B<virt-xml> invocation requires 3 things: name of an existing domain to alter (or XML passed on stdin), an action to on the XML, and an XML change to make. actions are one of: - ---add-device: Append a new device definition to the XML ---remove-device: Remove an existing device definition ---edit: Edit an existing XML block ---build-xml: Just build the requested XML block and print it. No domain or input are required here, but it's recommended to provide them, so virt-xml can fill in optimal defaults. - -An XML change is one instance of any of the XML options provided by virt-xml, for example --disk or --boot. - -B<virt-xml> only allows one action and XML pair per invocation. If you need to make multiple edits, invoke the command multiple times. - - - -=head1 OPTIONS - -=over 4 - -=item B<-c> URI - -=item B<--connect>=URI - -Connect to a non-default hypervisor. See L<virt-install(1)> for details - -=item B<domain> - -domain is the name, UUID, or ID of the existing VM. This can be omitted if -using --build-xml, or if XML is passed on stdin. - -When a domain is specified, the default output action is --define, even if the VM is running. To update the running VM configuration, add the --update option (but not all options/devices support updating the running VM configuration). - -If XML is passed on stdin, the default output is --print-xml. - -=back - - - -=head1 XML ACTIONS - -=over 4 - -=item B<--edit> [EDIT-OPTIONS] - -Edit the specified XML block. EDIT-OPTIONS tell B<virt-xml> which block to edit. The type of XML that we are editing is decided by XML option that is passed to B<virt-xml>. So if --disk is passed, EDIT-OPTIONS select which <disk> block to edit. - -Certain XML options only ever map to a single XML block, like --cpu, --security, --boot, --clock, and a few others. In those cases, B<virt-xml> will not complain if a corresponding XML block does not already exist, it will create it for you. - -Most XML options support a special value 'clearxml=yes'. When combined with --edit, it will completely blank out the XML block being edited before applying the requested changes. This allows completely rebuilding an XML block. See EXAMPLES for some usage. - -EDIT-OPTIONS examples: - -=over 4 - -=item B<--edit> - ---edit without any options implies 'edit the first block'. So '--edit --disk DISK-OPTIONS' means 'edit the first <disk>'. - -For the single XML block options mentioned above, plain '--edit' without any options is what you always want to use. - -=item B<--edit> # - -Select the specified XML block number. So '--edit 2 --disk DISK-OPTS' means 'edit the second <disk>'. This option only really applies for device XML. - -=item B<--edit> all - -Modify every XML block of the XML option type. So '--edit all --disk DISK-OPTS' means 'edit ever <disk> block'. This option only really applies for device XML. - -=item B<--edit> DEVICE-OPTIONS - -Modify every XML block that matches the passed device options. The device options are in the same format as would be passed to the XML option. - -So '--edit path=/tmp/foo --disk DISK-OPTS' means 'edit every <disk> with path /tmp/foo'. This option only really applies for device XML. - -=back - -=item B<--add-device> - -Append the specified XML options to the XML <devices> list. Example: '--add-device --disk DISK-OPTIONS' will create a new <disk> block and add it to the XML. - -This option will error if specified with a non-device XML option (see --edit section for a partial list). - -=item B<--remove-device> - -Remove the specified device from the XML. The device to remove is chosen by the XML option, which takes arguments in the same format as --edit. Examples - -=over 4 - -=item B<--remove-device> --disk 2 - -Remove the second disk device - -=item B<--remove-device> --network all - -Remove all network devices - -=item B<--remove-device> --sound pcspk - -Remove all sound devices with model='pcspk' - -=back - -This option will error if specified with a non-device XML option (see --edit section for a partial list). - -=item B<--build-xml> - -Just build the specified XML, and print it to stdout. No input domain or input XML is required. Example: '--build-xml --disk DISK-OPTIONS' will just print the new <disk> device. - -However if the generated XML is targeted for a specific domain, it's recommended to pass it to virt-xml, so the tool can set optimal defaults. - -This option will error if specified with an XML option that does not map cleanly to a specific XML block, like --vcpus or --memory. - -=back - - - - -=head1 OUTPUT OPTIONS - -These options decide what action to take after altering the XML. In the common case these do not need to be specified, as 'XML actions' will imply a default output action, described in detail above. These are only needed if you want to modify the default output. - -=over 4 - -=item B<--update> - -If the specified domain is running, attempt to alter the running VM configuration. If combined with --edit, this is an update operation. If combined with --add-device, this is a device hotplug. If combined with --remove-device, this is a device hotunplug. - -Keep in mind, most XML properties and devices do not support live update operations, so don't expect it to succeed in all cases. - -By default this also implies B<--define>. - -=item B<--define> - -Define the requested XML change. This is typically the default if no output option is specified, but if a --print option is specified, --define is required to force the change. - -=item B<--no-define> - -Explicitly do not define the XML. For example if you only want to alter the runtime state of a VM, combine this with B<--update>. - -=item B<--start> - -Start the VM after performing the requeseted changes. If combined with --no-define, this will create transient VM boot with the requested changes. - -=item B<--print-diff> - -Print the generated XML change in unified diff format. If only this output option is specified, all other output options are disabled and no persistent change is made. - -=item B<--print-xml> - -Print the generated XML in its entirety. If only this output option is specified, all other output options are disabled and no persistent change is made. - -=item B<--confirm> - -Before defining or updating the domain, show the generated XML diff and interactively request confirmation. - -=back - - - - -=head1 GUEST OS OPTIONS - -=over 4 - -=item B<--os-variant> OS_VARIANT - -Optimize the guest configuration for a specific operating system (ex. -'fedora29', 'rhel7', 'win10'). While not required, specifying this -options is HIGHLY RECOMMENDED, as it can greatly increase performance -by specifying virtio among other guest tweaks. - -If the guest has been installed using virt-manager version 2.0.0 or newer, -providing this information should not be necessary, as the OS variant will -have been stored in the guest configuration during installation and virt-xml -will retrieve it from there automatically. - -Use the command "osinfo-query os" to get the list of the accepted OS -variants. - -=back - - - - -=head1 XML OPTIONS - -=over 4 - -=item B<--disk> - -=item B<--network> - -=item B<--graphics> - -=item B<--metadata> - -=item B<--memory> - -=item B<--vcpus> - -=item B<--cpu> - -=item B<--iothreads> - -=item B<--seclabel> - -=item B<--keywrap> - -=item B<--cputune> - -=item B<--numatune> - -=item B<--memtune> - -=item B<--blkiotune> - -=item B<--memorybacking> - -=item B<--features> - -=item B<--clock> - -=item B<--pm> - -=item B<--events> - -=item B<--resources> - -=item B<--sysinfo> - -=item B<--xml> - -=item B<--qemu-commandline> - -=item B<--launchSecurity> - -=item B<--boot> - -=item B<--idmap> - -=item B<--controller> - -=item B<--input> - -=item B<--serial> - -=item B<--parallel> - -=item B<--channel> - -=item B<--console> - -=item B<--hostdev> - -=item B<--filesystem> - -=item B<--sound> - -=item B<--watchdog> - -=item B<--video> - -=item B<--smartcard> - -=item B<--redirdev> - -=item B<--memballoon> - -=item B<--tpm> - -=item B<--rng> - -=item B<--panic> - -=item B<--memdev> - -These options alter the XML for a single class of XML elements. More complete documentation is found in L<virt-install(1)>. - -Generally these options map pretty straightforwardly to the libvirt XML, documented at L<https://libvirt.org/formatdomain.html> - -Option strings are in the format of: --option opt=val,opt2=val2,... example: --disk path=/tmp/foo,shareable=on. Properties can be used with '--option opt=,', so to clear a disks cache setting you could use '--disk cache=,' - -For any option, use --option=? to see a list of all available sub options, example: --disk=? or --boot=? - ---help output also lists a few general examples. See the EXAMPLES section below for some common examples. - - -=back - - - - -=head1 MISCELLANEOUS OPTIONS - -=over 4 - -=item B<-h> - -=item B<--help> - -Show the help message and exit - -=item B<--version> - -Show program's version number and exit - -=item B<-q> - -=item B<--quiet> - -Avoid verbose output. - -=item B<-d> - -=item B<--debug> - -Print debugging information - -=back - - - -=head1 EXAMPLES - -See a list of all suboptions that --disk and --network take - - # virt-xml --disk=? --network=? - -Change the <description> of domain 'EXAMPLE': - - # virt-xml EXAMPLE --edit --metadata description="my new description" - -# Enable the boot device menu for domain 'EXAMPLE': - - # virt-xml EXAMPLE --edit --boot menu=on - -Clear the previous <cpu> definition of domain 'winxp', change it to 'host-model', but interactively confirm the diff before saving: - - # virt-xml winxp --edit --cpu host-model,clearxml=yes --confirm - -Change the second sound card to model=ich6 on 'fedora19', but only output the diff: - - # virt-xml fedora19 --edit 2 --sound model=ich6 --print-diff - -Update the every graphics device password to 'foo' of the running VM 'rhel6': - - # virt-xml rhel6 --edit all --graphics password=foo --update - -Remove the disk path from disk device hdc: - - # virt-xml rhel6 --edit target=hdc --disk path= - -Change all disk devices of type 'disk' to use cache=none, using XML from stdin, printing the new XML to stdout. - - # cat <xmlfile> | virt-xml --edit device=disk --disk cache=none - -Change disk 'hda' IO to native and use startup policy as 'optional'. - - # virt-xml fedora20 --edit target=hda \ - --disk io=native,startup_policy=optional - -Change all host devices to use driver_name=vfio for VM 'fedora20' on the remote connection - - # virt-xml --connect qemu+ssh://remotehost/system \ - fedora20 --edit all --hostdev driver_name=vfio - -Hotplug host USB device 001.003 to running domain 'fedora19': - - # virt-xml fedora19 --update --add-device --hostdev 001.003 - -Add a spicevmc channel to the domain 'winxp', that will be available after the next VM shutdown. - - # virt-xml winxp --add-device --channel spicevmc - -Create a 10G qcow2 disk image and attach it to 'fedora18' for the next VM startup: - - # virt-xml fedora18 --add-device \ - --disk /var/lib/libvirt/images/newimage.qcow2,format=qcow2,size=10 - -Same as above, but ensure the disk is attached to the most appropriate bus -for the guest OS by providing information about it on the command line: - - # virt-xml fedora18 --os-variant fedora18 --add-device \ - --disk /var/lib/libvirt/images/newimage.qcow2,format=qcow2,size=10 - -Hotunplug the disk vdb from the running domain 'rhel7': - - # virt-xml rhel7 --update --remove-device --disk target=vdb - -Remove all graphics devices from the VM 'rhel7' after the next shutdown: - - # virt-xml rhel7 --remove-device --graphics all - -Generate XML for a virtio console device and print it to stdout: - - # virt-xml --build-xml --console pty,target_type=virtio - -Add qemu command line passthrough: - - # virt-xml f25 --edit --confirm --qemu-commandline="-device FOO" - -Use boot device 'network' for a single transient boot: - - # virt-xml myvm --no-define --start --edit --boot network - -=head1 CAVEATS - -Virtualization hosts supported by libvirt may not permit all changes that might seem possible. Some edits made to a VM's definition may be ignored. For instance, QEMU does not allow the removal of certain devices once they've been defined. - -=head1 BUGS - -Please see L<https://virt-manager.org/bugs> - -=head1 COPYRIGHT - -Copyright (C) Red Hat, Inc, and various contributors. -This is free software. You may redistribute copies of it under the terms -of the GNU General Public License C<https://www.gnu.org/licenses/gpl.html>. -There is NO WARRANTY, to the extent permitted by law. - -=head1 SEE ALSO - -L<virt-install(1)>, the project website C<https://virt-manager.org> - -=cut diff --git a/man/virt-xml.rst b/man/virt-xml.rst new file mode 100644 index 00000000..52c7a9e9 --- /dev/null +++ b/man/virt-xml.rst @@ -0,0 +1,441 @@ +======== +virt-xml +======== + +-------------------------------------------- +Edit libvirt XML using command line options. +-------------------------------------------- + + +:Manual section: 1 +:Manual group: Virtualization Support + + +SYNOPSIS +======== + +``virt-xml`` DOMAIN XML-ACTION XML-OPTION [OUTPUT-OPTION] [MISC-OPTIONS] ... + + +DESCRIPTION +=========== + +``virt-xml`` is a command line tool for editing libvirt XML using explicit command line options. See the EXAMPLES section at the end of this document to jump right in. + +Each ``virt-xml`` invocation requires 3 things: name of an existing domain to alter (or XML passed on stdin), an action to on the XML, and an XML change to make. actions are one of: + +* ``--add-device``: Append a new device definition to the XML +* ``--remove-device``: Remove an existing device definition +* ``--edit``: Edit an existing XML block +* ``--build-xml``: Just build the requested XML block and print it. No domain or input are required here, but it's recommended to provide them, so virt-xml can fill in optimal defaults. + +An XML change is one instance of any of the XML options provided by virt-xml, for example --disk or --boot. + +``virt-xml`` only allows one action and XML pair per invocation. If you need to make multiple edits, invoke the command multiple times. + + +OPTIONS +======= + +``-c`` ``--connect`` URI + Connect to a non-default hypervisor. See virt-install(1) for details + + +``domain`` + domain is the name, UUID, or ID of the existing VM. This can be omitted if + using --build-xml, or if XML is passed on stdin. + + When a domain is specified, the default output action is --define, even if the + VM is running. To update the running VM configuration, add the --update option + (but not all options/devices support updating the running VM configuration). + + If XML is passed on stdin, the default output is --print-xml. + + +XML ACTIONS +=========== + +``--edit`` [EDIT-OPTIONS] + Edit the specified XML block. EDIT-OPTIONS tell ``virt-xml`` which block + to edit. The type of XML that we are editing is decided by XML option that + is passed to ``virt-xml`` . So if --disk is passed, EDIT-OPTIONS select + which <disk> block to edit. + + Certain XML options only ever map to a single XML block, like --cpu, + --security, --boot, --clock, and a few others. In those cases, + ``virt-xml`` will not complain if a corresponding XML block does not + already exist, it will create it for you. + + Most XML options support a special value 'clearxml=yes'. When combined + with --edit, it will completely blank out the XML block being edited + before applying the requested changes. This allows completely rebuilding + an XML block. See EXAMPLES for some usage. + + EDIT-OPTIONS examples: + + * ``--edit`` + --edit without any options implies 'edit the first block'. So + '--edit --disk DISK-OPTIONS' means 'edit the first <disk>'. + + For the single XML block options mentioned above, plain + '--edit' without any options is what you always want to use. + + * ``--edit`` # + Select the specified XML block number. So '--edit 2 --disk DISK-OPTS' + means 'edit the second <disk>'. This option only really applies for + device XML. + + * ``--edit`` all + Modify every XML block of the XML option type. So + '--edit all --disk DISK-OPTS' means 'edit ever <disk> block'. + This option only really applies for device XML. + + + * ``--edit`` DEVICE-OPTIONS + Modify every XML block that matches the passed device options. + The device options are in the same format as would be passed to + the XML option. + + So `--edit path=/tmp/foo --disk DISK-OPTS` means 'edit every <disk> with + path /tmp/foo'. This option only really applies for device XML. + + +``--add-device`` + Append the specified XML options to the XML <devices> list. Example: + '--add-device --disk DISK-OPTIONS' will create a new <disk> block and + add it to the XML. + + This option will error if specified with a non-device XML option + (see --edit section for a partial list). + + +``--remove-device`` + Remove the specified device from the XML. The device to remove is chosen + by the XML option, which takes arguments in the same format as --edit. + Examples: + + * ``--remove-device --disk 2`` + Remove the second disk device + + * ``--remove-device --network all`` + Remove all network devices + + * ``--remove-device --sound pcspk`` + Remove all sound devices with model='pcspk' + + This option will error if specified with a non-device XML option + (see --edit isection for a partial list). + + +``--build-xml`` + Just build the specified XML, and print it to stdout. No input domain or + input XML is required. Example: '--build-xml --disk DISK-OPTIONS' will + just print the new <disk> device. + + However if the generated XML is targeted for a specific domain, it's + recommended to pass it to virt-xml, so the tool can set optimal defaults. + + This option will error if specified with an XML option that does not map + cleanly to a specific XML block, like --vcpus or --memory. + + +OUTPUT OPTIONS +============== + +These options decide what action to take after altering the XML. In the common case these do not need to be specified, as 'XML actions' will imply a default output action, described in detail above. These are only needed if you want to modify the default output. + + +``--update`` + If the specified domain is running, attempt to alter the running VM configuration. If combined with --edit, this is an update operation. If combined with --add-device, this is a device hotplug. If combined with --remove-device, this is a device hotunplug. + + Keep in mind, most XML properties and devices do not support live update operations, so don't expect it to succeed in all cases. + + By default this also implies ``--define``. + + +``--define`` + Define the requested XML change. This is typically the default if no output option is specified, but if a --print option is specified, --define is required to force the change. + + +``--no-define`` + Explicitly do not define the XML. For example if you only want to alter the runtime state of a VM, combine this with ``--update``. + + +``--start`` + Start the VM after performing the requeseted changes. If combined with --no-define, this will create transient VM boot with the requested changes. + + +``--print-diff`` + Print the generated XML change in unified diff format. If only this output option is specified, all other output options are disabled and no persistent change is made. + + +``--print-xml`` + Print the generated XML in its entirety. If only this output option is specified, all other output options are disabled and no persistent change is made. + + +``--confirm`` + Before defining or updating the domain, show the generated XML diff and interactively request confirmation. + + +GUEST OS OPTIONS +================ + +``--os-variant`` OS_VARIANT + Optimize the guest configuration for a specific operating system (ex. + 'fedora29', 'rhel7', 'win10'). While not required, specifying this + options is HIGHLY RECOMMENDED, as it can greatly increase performance + by specifying virtio among other guest tweaks. + + If the guest has been installed using virt-manager version 2.0.0 or newer, + providing this information should not be necessary, as the OS variant will + have been stored in the guest configuration during installation and virt-xml + will retrieve it from there automatically. + + Use the command "osinfo-query os" to get the list of the accepted OS + variants. + + +XML OPTIONS +=========== + +* ``--disk`` +* ``--network`` +* ``--graphics`` +* ``--metadata`` +* ``--memory`` +* ``--vcpus`` +* ``--cpu`` +* ``--iothreads`` +* ``--seclabel`` +* ``--keywrap`` +* ``--cputune`` +* ``--numatune`` +* ``--memtune`` +* ``--blkiotune`` +* ``--memorybacking`` +* ``--features`` +* ``--clock`` +* ``--pm`` +* ``--events`` +* ``--resources`` +* ``--sysinfo`` +* ``--xml`` +* ``--qemu-commandline`` +* ``--launchSecurity`` +* ``--boot`` +* ``--idmap`` +* ``--controller`` +* ``--input`` +* ``--serial`` +* ``--parallel`` +* ``--channel`` +* ``--console`` +* ``--hostdev`` +* ``--filesystem`` +* ``--sound`` +* ``--watchdog`` +* ``--video`` +* ``--smartcard`` +* ``--redirdev`` +* ``--memballoon`` +* ``--tpm`` +* ``--rng`` +* ``--panic`` +* ``--memdev`` + +These options alter the XML for a single class of XML elements. More complete documentation is found in virt-install(1). + +Generally these options map pretty straightforwardly to the libvirt XML, documented at https://libvirt.org/formatdomain.html + +Option strings are in the format of: --option opt=val,opt2=val2,... example: --disk path=/tmp/foo,shareable=on. Properties can be used with '--option opt=,', so to clear a disks cache setting you could use '--disk cache=,' + +For any option, use --option=? to see a list of all available sub options, example: --disk=? or --boot=? + +--help output also lists a few general examples. See the EXAMPLES section below for some common examples. + + +MISCELLANEOUS OPTIONS +===================== + +``-h``, ``--help`` + Show the help message and exit + + +``--version`` + Show program's version number and exit + + +``-q``, ``--quiet`` + Avoid verbose output. + + +``-d``, ``--debug`` + Print debugging information + + +EXAMPLES +======== + +See a list of all suboptions that --disk and --network take + +.. code-block:: + + # virt-xml --disk=? --network=? + + +Change the <description> of domain 'EXAMPLE': + +.. code-block:: + + # virt-xml EXAMPLE --edit --metadata description="my new description" + + +# Enable the boot device menu for domain 'EXAMPLE': + +.. code-block:: + + # virt-xml EXAMPLE --edit --boot menu=on + + +Clear the previous <cpu> definition of domain 'winxp', change it to 'host-model', but interactively confirm the diff before saving: + +.. code-block:: + + # virt-xml winxp --edit --cpu host-model,clearxml=yes --confirm + + +Change the second sound card to model=ich6 on 'fedora19', but only output the diff: + +.. code-block:: + + # virt-xml fedora19 --edit 2 --sound model=ich6 --print-diff + + +Update the every graphics device password to 'foo' of the running VM 'rhel6': + +.. code-block:: + + # virt-xml rhel6 --edit all --graphics password=foo --update + + +Remove the disk path from disk device hdc: + +.. code-block:: + + # virt-xml rhel6 --edit target=hdc --disk path= + + +Change all disk devices of type 'disk' to use cache=none, using XML from stdin, printing the new XML to stdout. + +.. code-block:: + + # cat <xmlfile> | virt-xml --edit device=disk --disk cache=none + + +Change disk 'hda' IO to native and use startup policy as 'optional'. + +.. code-block:: + + # virt-xml fedora20 --edit target=hda \ + --disk io=native,startup_policy=optional + + +Change all host devices to use driver_name=vfio for VM 'fedora20' on the remote connection + +.. code-block:: + + # virt-xml --connect qemu+ssh://remotehost/system \ + fedora20 --edit all --hostdev driver_name=vfio + + +Hotplug host USB device 001.003 to running domain 'fedora19': + +.. code-block:: + + # virt-xml fedora19 --update --add-device --hostdev 001.003 + + +Add a spicevmc channel to the domain 'winxp', that will be available after the next VM shutdown. + +.. code-block:: + + # virt-xml winxp --add-device --channel spicevmc + + +Create a 10G qcow2 disk image and attach it to 'fedora18' for the next VM startup: + +.. code-block:: + + # virt-xml fedora18 --add-device \ + --disk /var/lib/libvirt/images/newimage.qcow2,format=qcow2,size=10 + + +Same as above, but ensure the disk is attached to the most appropriate bus +for the guest OS by providing information about it on the command line: + +.. code-block:: + + # virt-xml fedora18 --os-variant fedora18 --add-device \ + --disk /var/lib/libvirt/images/newimage.qcow2,format=qcow2,size=10 + + +Hotunplug the disk vdb from the running domain 'rhel7': + +.. code-block:: + + # virt-xml rhel7 --update --remove-device --disk target=vdb + + +Remove all graphics devices from the VM 'rhel7' after the next shutdown: + +.. code-block:: + + # virt-xml rhel7 --remove-device --graphics all + + +Generate XML for a virtio console device and print it to stdout: + +.. code-block:: + + # virt-xml --build-xml --console pty,target_type=virtio + + +Add qemu command line passthrough: + +.. code-block:: + + # virt-xml f25 --edit --confirm --qemu-commandline="-device FOO" + + +Use boot device 'network' for a single transient boot: + +.. code-block:: + + # virt-xml myvm --no-define --start --edit --boot network + + +CAVEATS +======= + +Virtualization hosts supported by libvirt may not permit all changes that might seem possible. Some edits made to a VM's definition may be ignored. For instance, QEMU does not allow the removal of certain devices once they've been defined. + + +BUGS +==== + +Please see https://virt-manager.org/bugs + + +COPYRIGHT +========= + +Copyright (C) Red Hat, Inc, and various contributors. +This is free software. You may redistribute copies of it under the terms +of the GNU General Public License https://www.gnu.org/licenses/gpl.html. +There is NO WARRANTY, to the extent permitted by law. + + +SEE ALSO +======== + +virt-install(1), the project website https://virt-manager.org |