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