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