]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: drvbhyve: document NVMe device
authorRoman Bogorodskiy <bogorodskiy@gmail.com>
Wed, 29 Oct 2025 17:58:47 +0000 (18:58 +0100)
committerJiri Denemark <jdenemar@redhat.com>
Fri, 31 Oct 2025 12:38:50 +0000 (13:38 +0100)
Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
docs/drvbhyve.rst

index 0962bccef4ab13edff1f1ec7ca7fba3880c7bdd4..9db17e55e3d118a5bc9d6e1f3ac165742800b07c 100644 (file)
@@ -638,3 +638,24 @@ Example:
 Note: there's no direct way to check if the actual ``bhyve`` binary supports
 the TCP console. Thus, libvirt always assumes it's supported. Please
 refer to the ``bhyve(1)`` manual page to make sure.
+
+NVMe device
+~~~~~~~~~~~
+:since:`Since 11.9.0`, it's possible to use NVMe device.
+
+Example:
+
+::
+
+   ...
+     <disk type='file'>
+       <driver name='file' type='raw'/>
+       <source file='/tmp/freebsd.img'/>
+       <target dev='nvme0n1' bus='nvme'/>
+     </disk>
+    ...
+
+As ``bhyve(1)`` uses one NVMe device per PCI address, it's modeled in a way
+that there is one device per controller. That is, if using more than one
+NVMe device, for device name users should increment controller number rather
+than namespace number, i.e.: ``nvme0n1``, ``nvme1n1``, etc.