diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml index 95fc57408b..90485b7e1b 100644 --- a/man/systemd-vmspawn.xml +++ b/man/systemd-vmspawn.xml @@ -32,14 +32,15 @@ Description systemd-vmspawn may be used to start a virtual machine from an OS image. In many ways it is similar to systemd-nspawn1, but it + project='man-pages'>systemd-nspawn1, but launches a full virtual machine instead of using namespaces. File descriptors for /dev/kvm and /dev/vhost-vsock can be passed to systemd-vmspawn via systemd's native socket passing interface (see sd_listen_fds3 for details about the precise protocol used and the order in which the file descriptors are passed), these - fds must be passed with the names kvm and vhost-vsock respectively. + file descriptors must be passed with the names kvm and vhost-vsock + respectively. Note: on Ubuntu/Debian derivatives systemd-vmspawn requires the user to be in the kvm group to use the VSock options. @@ -76,6 +77,7 @@ Directory to use as file system root for the virtual machine. One of either or must be specified. + Note: If mounting a non-root owned directory you may require to map into the user's subuid namespace. @@ -120,129 +122,145 @@ - - BOOL + + BOOL - Configures whether to use KVM. If the option is not specified KVM support will be - detected automatically. If true, KVM is always used, and if false, KVM is never used. + Configures whether to use KVM. If the option is not specified KVM support will be + detected automatically. If true, KVM is always used, and if false, KVM is never used. - - + + - - BOOL + + BOOL - - Configure whether to use VSock networking. - If the option is not specified VSock support will be detected automatically. - If yes is specified VSocks are always used, and vice versa if no is set VSocks are never used. - - - + + Configure whether to use VSock networking. - - CID + If the option is not specified VSock support will be detected automatically. + If yes is specified VSocks are always used, and vice versa if no is set VSocks are never used. + + + - - Configure vmspawn to use a specific CID for the guest. - If the option is not specified or an empty argument is supplied the guest will be assigned a random CID. - Valid CIDs are in the range 3 to 4294967294 (0xFFFF_FFFE). - CIDs outside of this range are reserved. - - - + + CID - - BOOL + + Configure vmspawn to use a specific CID for the guest. - - Configure whether to use qemu with a virtual TPM or not. - If the option is not specified vmspawn will detect the presence of - swtpm8 and use it if available. - If yes is specified swtpm8 - is always used, and vice versa if no is set swtpm - 8 is never used. - Note: the virtual TPM used may change in future. - - - + If the option is not specified or an empty argument is supplied the guest will be assigned a random CID. - - PATH + Valid CIDs are in the range 3 to 4294967294 (0xFFFF_FFFE). + CIDs outside of this range are reserved. - - Set the linux kernel image to use for direct kernel boot. - If no kernel was installed into the image then the image will fail to boot. - - - + + + - - PATH + + BOOL - - Set the initrd to use for direct kernel boot. - If the linux kernel supplied is a UKI then this argument is not required. - If the option is specified multiple times vmspawn will merge the initrds together. - If no initrd was installed into the image then the image will fail to boot. - - - + + Configure whether to use qemu with a virtual TPM or not. - - + If the option is not specified vmspawn will detect the presence of + swtpm8 and use it if available. + If yes is specified swtpm8 + is always used, and vice versa if no is set swtpm + 8 is never used. - Start QEMU in graphical mode. + Note: the virtual TPM used may change in future. - - + + + - - - + + PATH - - Create a TAP device to network with the virtual machine. - - Note: root privileges are required to use TAP networking. - Additionally requires a correctly setup + + Set the linux kernel image to use for direct kernel boot. + + If no kernel was installed into the image then the image will fail to boot. + + + + + + + PATH + + + Set the initrd to use for direct kernel boot. + + If the linux kernel supplied is a UKI then this argument is not required. + + If the option is specified multiple times vmspawn will merge the initrds together. + + If no initrd was installed into the image then the image will fail to boot. + + + + + + + + + Start QEMU in graphical mode. + + + + + + + + + + Create a TAP device to network with the virtual machine. + + Note: root privileges are required to use TAP networking. + Additionally, systemd-networkd8 - to be running on the host to ensure the host interface is correctly configured. - The relevant .network file can be found at /usr/lib/systemd/network/80-vm-vt.network. - - - - + must be running and correctly set up on the host to provision the host interface. The relevant + .network file can be found at + /usr/lib/systemd/network/80-vm-vt.network. + - - + + + - Use user mode networking with QEMU. + + - - + Use user mode networking with QEMU. - - PATH + + - Takes an absolute path, or a relative path beginning with - ./. Specifies a JSON firmware definition file, which allows selecting the - firmware to boot in the VM. If not specified a suitable firmware is automatically discovered. If the - special string list is specified lists all discovered firmwares. + + PATH - - + Takes an absolute path, or a relative path beginning with + ./. Specifies a JSON firmware definition file, which allows selecting the + firmware to boot in the VM. If not specified a suitable firmware is automatically discovered. If the + special string list is specified lists all discovered firmwares. - - BOOL + + - Configure whether to search for firmware which supports Secure Boot. - If the option is not specified the first firmware which is detected will be used. - If the option is set to yes then the first firmware with Secure Boot support will be selected. - If no is specified then the first firmware without Secure Boot will be selected. + + BOOL - - + Configure whether to search for firmware which supports Secure Boot. + + If the option is not specified the first firmware which is detected will be used. + If the option is set to yes then the first firmware with Secure Boot support will be selected. + If no is specified then the first firmware without Secure Boot will be selected. + + + @@ -259,6 +277,7 @@ (for example in tools like machinectl1 and similar). + @@ -319,10 +338,11 @@ FILE|DIR - Forward the virtual machine's journal entries to the host. - systemd-journal-remote8 - Is currently used to receive the guest VM's forwarded journal entries. For more information on the semantics - of supplying a file vs a directory here see / in + Forward the virtual machine's journal to the host. + systemd-journal-remote8 + is currently used to receive the guest VM's forwarded journal entries. This option determines where + this journal is saved on the host and has the same semantics as + / described in systemd-journal-remote8.