@Export @Version("1.0.0")

# Package com.io7m.waxmill.machines

FreeBSD BHyve Manager (Virtual machine domain model).

- Interface Summary
  Interface | Description
  --- | ---
  WXMBootConfigurationNameType | A boot configuration name, such as `install`.
  WXMBootConfigurationType | A boot configuration.
  WXMBootConfigurationType.WXMBootConfigurationGRUBBhyveType | A boot configuration that uses grub-bhyve.
  WXMBootConfigurationType.WXMBootConfigurationUEFIType | A boot configuration that uses UEFI.
  WXMBootConfigurationType.WXMBootDiskAttachmentType | A disk attachment.
  WXMBootConfigurationType.WXMEvaluatedBootCommandsType | A set of boot commands.
  WXMBootConfigurationType.WXMEvaluatedBootConfigurationGRUBBhyveType | A set of evaluated commands used to boot with grub-bhyve.
  WXMBootConfigurationType.WXMEvaluatedBootConfigurationType | The type of evaluated boot configurations.
  WXMBootConfigurationType.WXMEvaluatedBootConfigurationUEFIType | A set of evaluated commands used to boot with UEFI.
  WXMBootConfigurationType.WXMGRUBKernelInstructionsType | Operating system specific GRUB boot instructions.
  WXMBootConfigurationType.WXMGRUBKernelLinuxType | Linux kernel instructions.
  WXMBootConfigurationType.WXMGRUBKernelOpenBSDType | OpenBSD kernel instructions.
  WXMCPUTopologyType | The CPU topology for the virtual machine.
  WXMCPUTopologyType.WXMPinCPUType | A description of a CPU pin.
  WXMDeviceType | The type of devices that can be attached to virtual machines.
  WXMDeviceType.WXMDeviceAHCIDiskType |
  WXMDeviceType.WXMDeviceAHCIOpticalDiskType |
  WXMDeviceType.WXMDeviceE1000Type | An emulation of an Intel e82545 network device.
  WXMDeviceType.WXMDeviceFramebufferType | A raw framebuffer device attached to a VNC server.
  WXMDeviceType.WXMDeviceHostBridgeType |
  WXMDeviceType.WXMDeviceLPCType |
  WXMDeviceType.WXMDevicePassthruType | A PCI passthru device.
  WXMDeviceType.WXMDeviceVirtioBlockStorageType |
  WXMDeviceType.WXMDeviceVirtioNetworkType |
  WXMDeviceType.WXMSectorSizesType |
  WXMDeviceType.WXMStorageBackendFileType |
  WXMDeviceType.WXMStorageBackendType |
  WXMDeviceType.WXMStorageBackendZFSVolumeType |
  WXMDeviceType.WXMTTYBackendFileType |
  WXMDeviceType.WXMTTYBackendNMDMType |
  WXMDeviceType.WXMTTYBackendStdioType |
  WXMDeviceType.WXMTTYBackendType |
  WXMFlagsType | The configuration flags associated with a virtual machine.
  WXMInterfaceGroupNameType | A TAP device name, such as `tap23`.
  WXMMACAddressType | A MAC address, such as `d7:94:b5:60:0d:ac`.
  WXMMachineNameType | A machine name, such as `oregano.example.com`.
  WXMMemoryType | The specification of the size of a virtual machine's memory.
  WXMNetworkDeviceBackendType | The type of network device backends.
  WXMTAPDeviceNameType | A TAP device name, such as `tap23`.
  WXMTapType | A TAP device.
  WXMVirtualMachineSetType | A set of virtual machines.
  WXMVirtualMachineType | A virtual machine.
  WXMVMNetDeviceNameType | A VMNet device name, such as `vmnet23`.
  WXMVMNetType | A vmnet device.
  WXMZFSFilesystemType | A ZFS filesystem.
  WXMZFSVolumeType | A ZFS volume.

- Class Summary
  Class | Description
  --- | ---
  WXMBootConfigurationGRUBBhyve | A boot configuration that uses grub-bhyve.
  WXMBootConfigurationGRUBBhyve.Builder | Builds instances of type `WXMBootConfigurationGRUBBhyve`.
  WXMBootConfigurationName | A boot configuration name, such as `install`.
  WXMBootConfigurationName.Builder | Builds instances of type `WXMBootConfigurationName`.
  WXMBootConfigurationNames | Functions over boot configuration names.
  WXMBootConfigurationUEFI | A boot configuration that uses UEFI.
  WXMBootConfigurationUEFI.Builder | Builds instances of type `WXMBootConfigurationUEFI`.
  WXMBootDiskAttachment | A disk attachment.
  WXMBootDiskAttachment.Builder | Builds instances of type `WXMBootDiskAttachment`.
  WXMCommandExecution | An execution of an external command.
  WXMCommandExecution.Builder | Builds instances of type `WXMCommandExecution`.
  WXMCommandExecutionType | An execution of an external command.
  WXMConsoles | Functions over consoles.
  WXMCPUTopology | The CPU topology for the virtual machine.
  WXMCPUTopology.Builder | Builds instances of type `WXMCPUTopology`.
  WXMDeviceAHCIDisk | Immutable implementation of `WXMDeviceType.WXMDeviceAHCIDiskType`.
  WXMDeviceAHCIDisk.Builder | Builds instances of type `WXMDeviceAHCIDisk`.
  WXMDeviceAHCIOpticalDisk | Immutable implementation of `WXMDeviceType.WXMDeviceAHCIOpticalDiskType`.
  WXMDeviceAHCIOpticalDisk.Builder | Builds instances of type `WXMDeviceAHCIOpticalDisk`.
  WXMDeviceE1000 | An emulation of an Intel e82545 network device.
  WXMDeviceE1000.Builder | Builds instances of type `WXMDeviceE1000`.
  WXMDeviceFramebuffer | A raw framebuffer device attached to a VNC server.
  WXMDeviceFramebuffer.Builder | Builds instances of type `WXMDeviceFramebuffer`.
  WXMDeviceHostBridge | Immutable implementation of `WXMDeviceType.WXMDeviceHostBridgeType`.
  WXMDeviceHostBridge.Builder | Builds instances of type `WXMDeviceHostBridge`.
  WXMDeviceLPC | Immutable implementation of `WXMDeviceType.WXMDeviceLPCType`.
  WXMDeviceLPC.Builder | Builds instances of type `WXMDeviceLPC`.
  WXMDevicePassthru | A PCI passthru device.
  WXMDevicePassthru.Builder | Builds instances of type `WXMDevicePassthru`.
  WXMDeviceSlot | A device slot.
  WXMDeviceSlot.Builder | Builds instances of type `WXMDeviceSlot`.
  WXMDeviceSlots | Functions over device slots.
  WXMDeviceSlotType | A device slot.
  WXMDeviceVirtioBlockStorage | Immutable implementation of `WXMDeviceType.WXMDeviceVirtioBlockStorageType`.
  WXMDeviceVirtioBlockStorage.Builder | Builds instances of type `WXMDeviceVirtioBlockStorage`.
  WXMDeviceVirtioNetwork | Immutable implementation of `WXMDeviceType.WXMDeviceVirtioNetworkType`.
  WXMDeviceVirtioNetwork.Builder | Builds instances of type `WXMDeviceVirtioNetwork`.
  WXMEvaluatedBootCommands | A set of boot commands.
  WXMEvaluatedBootCommands.Builder | Builds instances of type `WXMEvaluatedBootCommands`.
  WXMEvaluatedBootConfigurationGRUBBhyve | A set of evaluated commands used to boot with grub-bhyve.
  WXMEvaluatedBootConfigurationGRUBBhyve.Builder | Builds instances of type `WXMEvaluatedBootConfigurationGRUBBhyve`.
  WXMEvaluatedBootConfigurationUEFI | A set of evaluated commands used to boot with UEFI.
  WXMEvaluatedBootConfigurationUEFI.Builder | Builds instances of type `WXMEvaluatedBootConfigurationUEFI`.
  WXMFlags | The configuration flags associated with a virtual machine.
  WXMFlags.Builder | Builds instances of type `WXMFlags`.
  WXMGRUBKernelLinux | Linux kernel instructions.
  WXMGRUBKernelLinux.Builder | Builds instances of type `WXMGRUBKernelLinux`.
  WXMGRUBKernelOpenBSD | OpenBSD kernel instructions.
  WXMGRUBKernelOpenBSD.Builder | Builds instances of type `WXMGRUBKernelOpenBSD`.
  WXMInterfaceGroupName | A TAP device name, such as `tap23`.
  WXMInterfaceGroupName.Builder | Builds instances of type `WXMInterfaceGroupName`.
  WXMInterfaceGroupNames | Functions over interface group names.
  WXMMACAddress | A MAC address, such as `d7:94:b5:60:0d:ac`.
  WXMMACAddress.Builder | Builds instances of type `WXMMACAddress`.
  WXMMACAddresses | Functions over MAC addresses.
  WXMMachineMessages |
  WXMMachineName | A machine name, such as `oregano.example.com`.
  WXMMachineName.Builder | Builds instances of type `WXMMachineName`.
  WXMMachineNames | Functions over machine names.
  WXMMemory | The specification of the size of a virtual machine's memory.
  WXMMemory.Builder | Builds instances of type `WXMMemory`.
  WXMPinCPU | A description of a CPU pin.
  WXMPinCPU.Builder | Builds instances of type `WXMPinCPU`.
  WXMSectorSizes | Immutable implementation of `WXMDeviceType.WXMSectorSizesType`.
  WXMSectorSizes.Builder | Builds instances of type `WXMSectorSizes`.
  WXMShortIDs | Functions to encode UUIDs using a shortened encoding that can be used with Bhyve's virtual machine name limitations.
  WXMStorageBackendFile | Immutable implementation of `WXMDeviceType.WXMStorageBackendFileType`.
  WXMStorageBackendFile.Builder | Builds instances of type `WXMStorageBackendFile`.
  WXMStorageBackendZFSVolume | Immutable implementation of `WXMDeviceType.WXMStorageBackendZFSVolumeType`.
  WXMStorageBackendZFSVolume.Builder | Builds instances of type `WXMStorageBackendZFSVolume`.
  WXMTap | A TAP device.
  WXMTap.Builder | Builds instances of type `WXMTap`.
  WXMTAPDeviceName | A TAP device name, such as `tap23`.
  WXMTAPDeviceName.Builder | Builds instances of type `WXMTAPDeviceName`.
  WXMTAPDeviceNames | Functions over TAP device names.
  WXMTTYBackendFile | Immutable implementation of `WXMDeviceType.WXMTTYBackendFileType`.
  WXMTTYBackendFile.Builder | Builds instances of type `WXMTTYBackendFile`.
  WXMTTYBackendNMDM | Immutable implementation of `WXMDeviceType.WXMTTYBackendNMDMType`.
  WXMTTYBackendNMDM.Builder | Builds instances of type `WXMTTYBackendNMDM`.
  WXMTTYBackends | Functions over TTY backends.
  WXMTTYBackendStdio | Immutable implementation of `WXMDeviceType.WXMTTYBackendStdioType`.
  WXMTTYBackendStdio.Builder | Builds instances of type `WXMTTYBackendStdio`.
  WXMVirtualMachine | A virtual machine.
  WXMVirtualMachine.Builder | Builds instances of type `WXMVirtualMachine`.
  WXMVirtualMachines | Functions over virtual machines.
  WXMVirtualMachineSet | A set of virtual machines.
  WXMVirtualMachineSet.Builder | Builds instances of type `WXMVirtualMachineSet`.
  WXMVirtualMachineSets | Functions over sets of virtual machines.
  WXMVMNet | A vmnet device.
  WXMVMNet.Builder | Builds instances of type `WXMVMNet`.
  WXMVMNetDeviceName | A VMNet device name, such as `vmnet23`.
  WXMVMNetDeviceName.Builder | Builds instances of type `WXMVMNetDeviceName`.
  WXMVMNetDeviceNames | Functions over VMNet device names.
  WXMZFSFilesystem | A ZFS filesystem.
  WXMZFSFilesystem.Builder | Builds instances of type `WXMZFSFilesystem`.
  WXMZFSFilesystems | Functions over ZFS filesystems.
  WXMZFSVolume | A ZFS volume.
  WXMZFSVolume.Builder | Builds instances of type `WXMZFSVolume`.
  WXMZFSVolumes | Functions over ZFS filesystems.

- Enum Summary
  Enum | Description
  --- | ---
  WXMBootConfigurationType.Kind | The kind of boot configurations.
  WXMBootConfigurationType.WXMGRUBKernelInstructionsType.Kind | The kind of kernels.
  WXMDeviceType.Kind | The device kind
  WXMDeviceType.WXMDeviceFramebufferType.WXMVGAConfiguration | The VGA configuration used.
  WXMDeviceType.WXMDeviceHostBridgeType.Vendor |
  WXMDeviceType.WXMLPCTTYNames |
  WXMDeviceType.WXMStorageBackendType.Kind |
  WXMDeviceType.WXMTTYBackendType.Kind |
  WXMDryRun | A specification of whether or not an operation should be a dry run.
  WXMNetworkDeviceBackendType.Kind | The kind of backend.
  WXMOpenOption | Options used when opening files.
  WXMTTYBackends.NMDMSide | The "side" of an NMDM device.