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