usr.sbin/bhyve/bhyve.8

   1 .\" Copyright (c) 2013 Peter Grehan
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd April 18, 2021
  28 .Dt BHYVE 8
  29 .Os
  30 .Sh NAME
  31 .Nm bhyve
  32 .Nd "run a guest operating system inside a virtual machine"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl AabCeHhPSuWwxY
  36 .Oo
  37 .Sm off
  38 .Fl c\~
  39 .Oo
  40 .Op Cm cpus=
  41 .Ar numcpus
  42 .Oc
  43 .Op Cm ,sockets= Ar n
  44 .Op Cm ,cores= Ar n
  45 .Op Cm ,threads= Ar n
  46 .Oc
  47 .Sm on
  48 .Op Fl G Ar port
  49 .Op Fl g Ar gdbport
  50 .Oo Fl l
  51 .Sm off
  52 .Ar lpcdev Op Cm \&, Ar conf
  53 .Sm on
  54 .Oc
  55 .Oo Fl m
  56 .Sm off
  57 .Ar memsize
  58 .Oo
  59 .Cm K No | Cm k No | Cm M No | Cm m No | Cm G No | Cm g No | Cm T No | Cm t
  60 .Oc
  61 .Sm on
  62 .Oc
  63 .Op Fl p Ar vcpu Ns Cm \&: Ns Ar hostcpu
  64 .Sm off
  65 .Oo Fl s\~
  66 .Ar slot Cm \&, Ar emulation Op Cm \&, Ar conf
  67 .Sm on
  68 .Oc
  69 .Op Fl U Ar uuid
  70 .Ar vmname
  71 .Nm
  72 .Fl l Cm help
  73 .Nm
  74 .Fl s Cm help
  75 .Sh DESCRIPTION
  76 .Nm
  77 is a hypervisor that runs guest operating systems inside a
  78 virtual machine.
  79 .Pp
  80 Parameters such as the number of virtual CPUs, amount of guest memory, and
  81 I/O connectivity can be specified with command-line parameters.
  82 .Pp
  83 If not using a boot ROM, the guest operating system must be loaded with
  84 .Xr bhyveload 8
  85 or a similar boot loader before running
  86 .Nm ,
  87 otherwise, it is enough to run
  88 .Nm
  89 with a boot ROM of choice.
  90 .Pp
  91 .Nm
  92 runs until the guest operating system reboots or an unhandled hypervisor
  93 exit is detected.
  94 .Sh OPTIONS
  95 .Bl -tag -width 10n
  96 .It Fl A
  97 Generate ACPI tables.
  98 Required for
  99 .Fx Ns /amd64
 100 guests.
 101 .It Fl a
 102 The guest's local APIC is configured in xAPIC mode.
 103 The xAPIC mode is the default setting so this option is redundant.
 104 It will be deprecated in a future version.
 105 .It Fl b
 106 Enable a low-level console device supported by
 107 .Fx
 108 kernels compiled with
 109 .Cd "device bvmconsole" .
 110 This option is deprecated and will be removed in
 111 .Fx 13.0 .
 112 .It Fl C
 113 Include guest memory in core file.
 114 .It Fl c Op Ar setting ...
 115 Number of guest virtual CPUs
 116 and/or the CPU topology.
 117 The default value for each of
 118 .Ar numcpus ,
 119 .Ar sockets ,
 120 .Ar cores ,
 121 and
 122 .Ar threads
 123 is 1.
 124 The current maximum number of guest virtual CPUs is 16.
 125 If
 126 .Ar numcpus
 127 is not specified then it will be calculated from the other arguments.
 128 The topology must be consistent in that the
 129 .Ar numcpus
 130 must equal the product of
 131 .Ar sockets ,
 132 .Ar cores ,
 133 and
 134 .Ar threads .
 135 If a
 136 .Ar setting
 137 is specified more than once the last one has precedence.
 138 .It Fl D
 139 Destroy the VM on guest initiated power-off.
 140 .It Fl e
 141 Force
 142 .Nm
 143 to exit when a guest issues an access to an I/O port that is not emulated.
 144 This is intended for debug purposes.
 145 .It Fl G Ar port
 146 Start a debug server that uses the GDB protocol to export guest state to a
 147 debugger.
 148 An IPv4 TCP socket will be bound to the supplied
 149 .Ar port
 150 to listen for debugger connections.
 151 Only a single debugger may be attached to the debug server at a time.
 152 If
 153 .Ar port
 154 begins with
 155 .Sq w ,
 156 .Nm
 157 will pause execution at the first instruction waiting for a debugger to attach.
 158 .It Fl g Ar gdbport
 159 For
 160 .Fx
 161 kernels compiled with
 162 .Cd "device bvmdebug" ,
 163 allow a remote kernel kgdb to be relayed to the guest kernel gdb stub
 164 via a local IPv4 address and this port.
 165 This option is deprecated and will be removed in
 166 .Fx 13.0 .
 167 .It Fl H
 168 Yield the virtual CPU thread when a HLT instruction is detected.
 169 If this option is not specified, virtual CPUs will use 100% of a host CPU.
 170 .It Fl h
 171 Print help message and exit.
 172 .It Fl k Ar file
 173 Set configuration variables from a simple, key-value config file.
 174 Each line of the config file is expected to consist of a config variable
 175 name, an equals sign
 176 .Pq Sq = ,
 177 and a value.
 178 No spaces are permitted between the variable name, equals sign, or
 179 value.
 180 Blank lines and lines starting with
 181 .Sq #
 182 are ignored.
 183 .It Fl l Cm help
 184 Print a list of supported LPC devices.
 185 .It Fl l Ar lpcdev Ns Op Cm \&, Ns Ar conf
 186 Allow devices behind the LPC PCI-ISA bridge to be configured.
 187 The only supported devices are the TTY-class devices
 188 .Ar com1
 189 and
 190 .Ar com2 ,
 191 the boot ROM device
 192 .Cm bootrom ,
 193 and the debug/test device
 194 .Cm pc-testdev .
 195 .Pp
 196 The possible values for the
 197 .Ar conf
 198 argument are listed in the
 199 .Fl s
 200 flag description.
 201 .It Xo
 202 .Fl m Ar memsize Ns Oo
 203 .Sm off
 204 .Cm K | k | M | m | G | g | T | t
 205 .Sm on
 206 .Oc
 207 .Xc
 208 Set the guest physical memory size
 209 This must be the same size that was given to
 210 .Xr bhyveload 8 .
 211 .Pp
 212 The size argument may be suffixed with one of
 213 .Cm K , M , G
 214 or
 215 .Cm T
 216 (either upper or lower case)
 217 to indicate a multiple of kilobytes, megabytes, gigabytes, or terabytes.
 218 If no suffix is given, the value is assumed to be in megabytes.
 219 .Pp
 220 The default is 256M.
 221 .It Fl o Ar var Ns Cm = Ns Ar value
 222 Set the configuration variable
 223 .Ar var
 224 to
 225 .Ar value .
 226 .It Fl P
 227 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 228 .It Fl p Ar vcpu Ns Cm \& : Ns Ar hostcpu
 229 Pin guest's virtual CPU
 230 .Em vcpu
 231 to
 232 .Em hostcpu .
 233 .It Fl P
 234 Force the guest virtual CPU to exit when a PAUSE instruction is detected.
 235 .It Fl S
 236 Wire guest memory.
 237 .It Fl s Op Ar help|slot,emulation Ns Op , Ns Ar conf
 238 Configure a virtual PCI slot and function.
 239 .Pp
 240 .Nm
 241 provides PCI bus emulation and virtual devices that can be attached to
 242 slots on the bus.
 243 There are 32 available slots, with the option of providing up to 8 functions
 244 per slot.
 245 .Bl -tag -width 10n
 246 .It Ar help
 247 print a list of supported PCI devices.
 248 .It Ar slot
 249 .Ar pcislot[:function]
 250 .Ar bus:pcislot:function
 251 .Pp
 252 The
 253 .Ar pcislot
 254 value is 0 to 31.
 255 The optional
 256 .Ar function
 257 value is 0 to 7.
 258 The optional
 259 .Ar bus
 260 value is 0 to 255.
 261 If not specified, the
 262 .Ar function
 263 value defaults to 0.
 264 If not specified, the
 265 .Ar bus
 266 value defaults to 0.
 267 .It Ar emulation
 268 .Bl -tag -width 10n
 269 .It Li hostbridge | Li amd_hostbridge
 270 .Pp
 271 Provide a simple host bridge.
 272 This is usually configured at slot 0, and is required by most guest
 273 operating systems.
 274 The
 275 .Li amd_hostbridge
 276 emulation is identical but uses a PCI vendor ID of
 277 .Li AMD .
 278 .It Li passthru
 279 PCI pass-through device.
 280 .It Li virtio-net
 281 Virtio network interface.
 282 .It Li virtio-blk
 283 Virtio block storage interface.
 284 .It Li virtio-scsi
 285 Virtio SCSI interface.
 286 .It Li virtio-rnd
 287 Virtio RNG interface.
 288 .It Li virtio-console
 289 Virtio console interface, which exposes multiple ports
 290 to the guest in the form of simple char devices for simple IO
 291 between the guest and host userspaces.
 292 .It Li ahci
 293 AHCI controller attached to arbitrary devices.
 294 .It Li ahci-cd
 295 AHCI controller attached to an ATAPI CD/DVD.
 296 .It Li ahci-hd
 297 AHCI controller attached to a SATA hard-drive.
 298 .It Li e1000
 299 Intel e82545 network interface.
 300 .It Li uart
 301 PCI 16550 serial device.
 302 .It Li lpc
 303 LPC PCI-ISA bridge with COM1 and COM2 16550 serial ports, a boot ROM, and,
 304 optionally, the debug/test device.
 305 The LPC bridge emulation can only be configured on bus 0.
 306 .It Li fbuf
 307 Raw framebuffer device attached to VNC server.
 308 .It Li xhci
 309 eXtensible Host Controller Interface (xHCI) USB controller.
 310 .It Li nvme
 311 NVM Express (NVMe) controller.
 312 .El
 313 .It Op Ar conf
 314 This optional parameter describes the backend for device emulations.
 315 If
 316 .Ar conf
 317 is not specified, the device emulation has no backend and can be
 318 considered unconnected.
 319 .Pp
 320 Network devices:
 321 .Bl -tag -width 10n
 322 .It Ar tapN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 323 .It Ar vmnetN Ns Op , Ns Ar mac=xx:xx:xx:xx:xx:xx
 324 .Pp
 325 If
 326 .Ar mac
 327 is not specified, the MAC address is derived from a fixed OUI and the
 328 remaining bytes from an MD5 hash of the slot and function numbers and
 329 the device name.
 330 .Pp
 331 The MAC address is an ASCII string in
 332 .Xr ethers 5
 333 format.
 334 .El
 335 .Pp
 336 Block storage devices:
 337 .Bl -tag -width 10n
 338 .It Pa /filename Ns Oo , Ns Ar block-device-options Oc
 339 .It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
 340 .El
 341 .Pp
 342 The
 343 .Ar block-device-options
 344 are:
 345 .Bl -tag -width 8n
 346 .It Li nocache
 347 Open the file with
 348 .Dv O_DIRECT .
 349 .It Li direct
 350 Open the file using
 351 .Dv O_SYNC .
 352 .It Li ro
 353 Force the file to be opened read-only.
 354 .It Li sectorsize= Ns Ar logical Ns Oo / Ns Ar physical Oc
 355 Specify the logical and physical sector sizes of the emulated disk.
 356 The physical sector size is optional and is equal to the logical sector size
 357 if not explicitly specified.
 358 .El
 359 .Pp
 360 SCSI devices:
 361 .Bl -tag -width 10n
 362 .It Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc Ns Oo , Ns Ar scsi-device-options Oc
 363 .El
 364 .Pp
 365 The
 366 .Ar scsi-device-options
 367 are:
 368 .Bl -tag -width 10n
 369 .It Li iid= Ns Ar IID
 370 Initiator ID to use when sending requests to specified CTL port.
 371 The default value is 0.
 372 .El
 373 .Pp
 374 TTY devices:
 375 .Bl -tag -width 10n
 376 .It Li stdio
 377 Connect the serial port to the standard input and output of
 378 the
 379 .Nm
 380 process.
 381 .It Pa /dev/xxx
 382 Use the host TTY device for serial port I/O.
 383 .El
 384 .Pp
 385 Boot ROM device:
 386 .Bl -tag -width 10n
 387 .It Pa romfile
 388 Map
 389 .Ar romfile
 390 in the guest address space reserved for boot firmware.
 391 .El
 392 .Pp
 393 Pass-through devices:
 394 .Bl -tag -width 10n
 395 .It Ns Ar slot Ns / Ns Ar bus Ns / Ns Ar function
 396 Connect to a PCI device on the host at the selector described by
 397 .Ar slot ,
 398 .Ar bus ,
 399 and
 400 .Ar function
 401 numbers.
 402 .El
 403 .Pp
 404 Guest memory must be wired using the
 405 .Fl S
 406 option when a pass-through device is configured.
 407 .Pp
 408 The host device must have been reserved at boot-time using the
 409 .Va pptdevs
 410 loader variable as described in
 411 .Xr vmm 4 .
 412 .Pp
 413 Virtio console devices:
 414 .Bl -tag -width 10n
 415 .It Li port1= Ns Pa /path/to/port1.sock Ns ,anotherport= Ns Pa ...
 416 A maximum of 16 ports per device can be created.
 417 Every port is named and corresponds to a Unix domain socket created by
 418 .Nm .
 419 .Nm
 420 accepts at most one connection per port at a time.
 421 .Pp
 422 Limitations:
 423 .Bl -bullet -offset 2n
 424 .It
 425 Due to lack of destructors in
 426 .Nm ,
 427 sockets on the filesystem must be cleaned up manually after
 428 .Nm
 429 exits.
 430 .It
 431 There is no way to use the "console port" feature, nor the console port
 432 resize at present.
 433 .It
 434 Emergency write is advertised, but no-op at present.
 435 .El
 436 .El
 437 .Pp
 438 Framebuffer devices:
 439 .Bl -tag -width 10n
 440 .It Xo
 441 .Oo rfb= Ns Oo Ar IP\&: Oc Ns Ar port Oc Ns Oo ,w= Ns Ar width Oc Ns Oo ,h= Ns
 442 .Ar height Oc Ns Oo ,vga= Ns Ar vgaconf Oc Ns Oo Ns ,wait Oc Ns Oo ,password= Ns
 443 .Ar password Oc
 444 .Xc
 445 .Bl -tag -width 8n
 446 .It Ar IPv4:port No or Ar [IPv6%zone]:port
 447 An
 448 .Ar IP
 449 address and a
 450 .Ar port
 451 VNC should listen on.
 452 The default is to listen on localhost IPv4 address and default VNC port 5900.
 453 An IPv6 address must be enclosed in square brackets and may contain an
 454 optional zone identifier.
 455 .It Ar width No and Ar height
 456 A display resolution, width and height, respectively.
 457 If not specified, a default resolution of 1024x768 pixels will be used.
 458 Minimal supported resolution is 640x480 pixels,
 459 and maximum is 1920x1200 pixels.
 460 .It Ar vgaconf
 461 Possible values for this option are
 462 .Dq io
 463 (default),
 464 .Dq on
 465 , and
 466 .Dq off .
 467 PCI graphics cards have a dual personality in that they are
 468 standard PCI devices with BAR addressing, but may also
 469 implicitly decode legacy VGA I/O space
 470 .Pq Ad 0x3c0-3df
 471 and memory space
 472 .Pq 64KB at Ad 0xA0000 .
 473 The default
 474 .Dq io
 475 option should be used for guests that attempt to issue BIOS calls which result
 476 in I/O port queries, and fail to boot if I/O decode is disabled.
 477 .Pp
 478 The
 479 .Dq on
 480 option should be used along with the CSM BIOS capability in UEFI
 481 to boot traditional BIOS guests that require the legacy VGA I/O and
 482 memory regions to be available.
 483 .Pp
 484 The
 485 .Dq off
 486 option should be used for the UEFI guests that assume that
 487 VGA adapter is present if they detect the I/O ports.
 488 An example of such a guest is
 489 .Ox
 490 in UEFI mode.
 491 .Pp
 492 Please refer to the
 493 .Nm
 494 .Fx
 495 wiki page
 496 .Pq Lk https://wiki.freebsd.org/bhyve
 497 for configuration notes of particular guests.
 498 .It wait
 499 Instruct
 500 .Nm
 501 to only boot upon the initiation of a VNC connection, simplifying the
 502 installation of operating systems that require immediate keyboard input.
 503 This can be removed for post-installation use.
 504 .It password
 505 This type of authentication is known to be cryptographically weak and is not
 506 intended for use on untrusted networks.
 507 Many implementations will want to use stronger security, such as running
 508 the session over an encrypted channel provided by IPsec or SSH.
 509 .El
 510 .El
 511 .Pp
 512 xHCI USB devices:
 513 .Bl -tag -width 10n
 514 .It Li tablet
 515 A USB tablet device which provides precise cursor synchronization
 516 when using VNC.
 517 .El
 518 .Pp
 519 NVMe devices:
 520 .Bl -tag -width 10n
 521 .It Li devpath
 522 Accepted device paths are:
 523 .Ar /dev/blockdev
 524 or
 525 .Ar /path/to/image
 526 or
 527 .Ar ram=size_in_MiB .
 528 .It Li maxq
 529 Max number of queues.
 530 .It Li qsz
 531 Max elements in each queue.
 532 .It Li ioslots
 533 Max number of concurrent I/O requests.
 534 .It Li sectsz
 535 Sector size (defaults to blockif sector size).
 536 .It Li ser
 537 Serial number with maximum 20 characters.
 538 .El
 539 .Pp
 540 AHCI devices:
 541 .Bl -tag -width 10n
 542 .It Li nmrr
 543 Nominal Media Rotation Rate, known as RPM. value 1 will indicate device as Solid State Disk. default value is 0, not report.
 544 .It Li ser
 545 Serial Number with maximum 20 characters.
 546 .It Li rev
 547 Revision Number with maximum 8 characters.
 548 .It Li model
 549 Model Number with maximum 40 characters.
 550 .El
 551 .Pp
 552 HD Audio devices:
 553 .Bl -tag -width 10n
 554 .It Li play
 555 Playback device, typically
 556 .Ar /dev/dsp0 .
 557 .It Li rec
 558 Recording device, typically
 559 .Ar /dev/dsp0 .
 560 .El
 561 .El
 562 .It Fl U Ar uuid
 563 Set the universally unique identifier
 564 .Pq UUID
 565 in the guest's System Management BIOS System Information structure.
 566 By default a UUID is generated from the host's hostname and
 567 .Ar vmname .
 568 .It Fl u
 569 RTC keeps UTC time.
 570 .It Fl W
 571 Force virtio PCI device emulations to use MSI interrupts instead of MSI-X
 572 interrupts.
 573 .It Fl w
 574 Ignore accesses to unimplemented Model Specific Registers (MSRs).
 575 This is intended for debug purposes.
 576 .It Fl x
 577 The guest's local APIC is configured in x2APIC mode.
 578 .It Fl Y
 579 Disable MPtable generation.
 580 .It Ar vmname
 581 Alphanumeric name of the guest.
 582 This should be the same as that created by
 583 .Xr bhyveload 8 .
 584 .El
 585 .Sh DEBUG SERVER
 586 The current debug server provides limited support for debuggers.
 587 .Ss Registers
 588 Each virtual CPU is exposed to the debugger as a thread.
 589 .Pp
 590 General purpose registers can be queried for each virtual CPU, but other
 591 registers such as floating-point and system registers cannot be queried.
 592 .Ss Memory
 593 Memory (including memory mapped I/O regions) can be read by the debugger,
 594 but not written.
 595 Memory operations use virtual addresses that are resolved to physical addresses
 596 via the current virtual CPU's active address translation.
 597 .Ss Control
 598 The running guest can be interrupted by the debugger at any time
 599 .Pq for example, by pressing Ctrl-C in the debugger .
 600 .Pp
 601 Single stepping is only supported on Intel CPUs supporting the MTRAP VM exit.
 602 .Pp
 603 Breakpoints are supported on Intel CPUs that support single stepping.
 604 Note that continuing from a breakpoint while interrupts are enabled in the
 605 guest may not work as expected due to timer interrupts firing while single
 606 stepping over the breakpoint.
 607 .Sh SIGNAL HANDLING
 608 .Nm
 609 deals with the following signals:
 610 .Pp
 611 .Bl -tag -width SIGTERM -compact
 612 .It SIGTERM
 613 Trigger ACPI poweroff for a VM
 614 .El
 615 .Sh EXIT STATUS
 616 Exit status indicates how the VM was terminated:
 617 .Pp
 618 .Bl -tag -width indent -compact
 619 .It 0
 620 rebooted
 621 .It 1
 622 powered off
 623 .It 2
 624 halted
 625 .It 3
 626 triple fault
 627 .It 4
 628 exited due to an error
 629 .El
 630 .Sh EXAMPLES
 631 If not using a boot ROM, the guest operating system must have been loaded with
 632 .Xr bhyveload 8
 633 or a similar boot loader before
 634 .Xr bhyve 4
 635 can be run.
 636 Otherwise, the boot loader is not needed.
 637 .Pp
 638 To run a virtual machine with 1GB of memory, two virtual CPUs, a virtio
 639 block device backed by the
 640 .Pa /my/image
 641 filesystem image, and a serial port for the console:
 642 .Bd -literal -offset indent
 643 bhyve -c 2 -s 0,hostbridge -s 1,lpc -s 2,virtio-blk,/my/image \\
 644   -l com1,stdio -A -H -P -m 1G vm1
 645 .Ed
 646 .Pp
 647 Run a 24GB single-CPU virtual machine with three network ports, one of which
 648 has a MAC address specified:
 649 .Bd -literal -offset indent
 650 bhyve -s 0,hostbridge -s 1,lpc -s 2:0,virtio-net,tap0 \\
 651   -s 2:1,virtio-net,tap1 \\
 652   -s 2:2,virtio-net,tap2,mac=00:be:fa:76:45:00 \\
 653   -s 3,virtio-blk,/my/image -l com1,stdio \\
 654   -A -H -P -m 24G bigvm
 655 .Ed
 656 .Pp
 657 Run an 8GB quad-CPU virtual machine with 8 AHCI SATA disks, an AHCI ATAPI
 658 CD-ROM, a single virtio network port, an AMD hostbridge, and the console
 659 port connected to an
 660 .Xr nmdm 4
 661 null-modem device.
 662 .Bd -literal -offset indent
 663 bhyve -c 4 \\
 664   -s 0,amd_hostbridge -s 1,lpc \\
 665   -s 1:0,ahci,hd:/images/disk.1,hd:/images/disk.2,\\
 666 hd:/images/disk.3,hd:/images/disk.4,\\
 667 hd:/images/disk.5,hd:/images/disk.6,\\
 668 hd:/images/disk.7,hd:/images/disk.8,\\
 669 cd:/images/install.iso \\
 670   -s 3,virtio-net,tap0 \\
 671   -l com1,/dev/nmdm0A \\
 672   -A -H -P -m 8G
 673 .Ed
 674 .Pp
 675 Run a UEFI virtual machine with a display resolution of 800 by 600 pixels
 676 that can be accessed via VNC at: 0.0.0.0:5900.
 677 .Bd -literal -offset indent
 678 bhyve -c 2 -m 4G -w -H \\
 679   -s 0,hostbridge \\
 680   -s 3,ahci-cd,/path/to/uefi-OS-install.iso \\
 681   -s 4,ahci-hd,disk.img \\
 682   -s 5,virtio-net,tap0 \\
 683   -s 29,fbuf,tcp=0.0.0.0:5900,w=800,h=600,wait \\
 684   -s 30,xhci,tablet \\
 685   -s 31,lpc -l com1,stdio \\
 686   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
 687    uefivm
 688 .Ed
 689 .Pp
 690 Run a UEFI virtual machine with a VNC display that is bound to all IPv6
 691 addresses on port 5900.
 692 .Bd -literal -offset indent
 693 bhyve -c 2 -m 4G -w -H \\
 694   -s 0,hostbridge \\
 695   -s 4,ahci-hd,disk.img \\
 696   -s 5,virtio-net,tap0 \\
 697   -s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
 698   -s 30,xhci,tablet \\
 699   -s 31,lpc -l com1,stdio \\
 700   -l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
 701    uefivm
 702 .Ed
 703 .Sh SEE ALSO
 704 .Xr bhyve 4 ,
 705 .Xr nmdm 4 ,
 706 .Xr vmm 4 ,
 707 .Xr ethers 5 ,
 708 .Xr bhyvectl 8 ,
 709 .Xr bhyveload 8
 710 .Pp
 711 .Rs
 712 .%A Intel
 713 .%B 64 and IA-32 Architectures Software Developer’s Manual
 714 .%V Volume 3
 715 .Re
 716 .Sh HISTORY
 717 .Nm
 718 first appeared in
 719 .Fx 10.0 .
 720 .Sh AUTHORS
 721 .An Neel Natu Aq Mt neel@freebsd.org
 722 .An Peter Grehan Aq Mt grehan@freebsd.org