diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in index 60eee85bf7..603be80038 100644 --- a/docs/drvbhyve.html.in +++ b/docs/drvbhyve.html.in @@ -79,5 +79,37 @@ in libvirt bhyve driver is yet to be implemented). </domain> + +

Guest usage / management

+ +

Connecting to a guest console

+ +

+Guest console connection is supported through the nmdm device. It could be enabled by adding +the following to the domain XML (Since 1.2.4): +

+ +
+  ...
+  <devices>
+    <serial type="nmdm">
+      <source master="/dev/nmdm0A" slave="/dev/nmdm0B"/>
+    </serial>
+  </devices>
+  ...
+ +

+Then virsh console command can be used to connect to the text console +of a guest.

+ +

NB: Some versions of bhyve have a bug that prevents guests from booting +until the console is opened by a client. This bug was fixed in FreeBSD +r262884. If +an older version is used, one either has to open a console manually with virsh console +to let a guest boot or start a guest using:

+ +
start --console domname
+ + diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 93ee05c94e..b9bbcc9f7d 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -4782,6 +4782,35 @@ qemu-kvm -net nic,model=? /dev/null </devices> ... +
Nmdm device
+ +

+ The nmdm device driver, available on FreeBSD, provides two + tty devices connected together by a virual null modem cable. + Since 1.2.4 +

+ +
+  ...
+  <devices>
+    <serial type="nmdm">
+      <source master="/dev/nmdm0A" slave="/dev/nmdm0B"/>
+    </serial>
+  </devices>
+  ...
+ +

+ The source element has these attributes: +

+ +
+
master
+
Master device of the pair, that is passed to the hypervisor.
+ +
slave
+
Slave device of the pair, that is passed to the clients for connection + to the guest console.
+

Sound devices