diff --git a/.web-docs/components/builder/iso/README.md b/.web-docs/components/builder/iso/README.md index 400275b4..c0898ca5 100644 --- a/.web-docs/components/builder/iso/README.md +++ b/.web-docs/components/builder/iso/README.md @@ -572,53 +572,58 @@ provisioner](/packer/docs/provisioner/file). -- `cpus` (int) - The number of cpus to use when building the VM. +- `firmware` (string) - The firmware type for the virtual machine. + Allowed values are `bios`, `efi`, and `efi-secure` (for secure boot). + Defaults to the recommended firmware type for the guest operating system. -- `memory` (int) - The amount of memory to use when building the VM in megabytes. +- `cpus` (int) - The number of virtual CPUs cores for the virtual machine. -- `cores` (int) - The number of cores per socket to use when building the VM. This - corresponds to the cpuid.coresPerSocket option in the .vmx file. +- `cores` (int) - The number of virtual CPU cores per socket for the virtual machine. -- `network` (string) - This is the network type that the virtual machine will be created with. - This can be one of the generic values that map to a device such as - hostonly, nat, or bridged. If the network is not one of these values, - then it is assumed to be a VMware network device. (VMnet0..x) +- `memory` (int) - The amount of memory for the virtual machine in MB. -- `network_adapter_type` (string) - This is the ethernet adapter type the the virtual machine will be - created with. By default the `e1000` network adapter type will be used - by Packer. For more information, please consult [Choosing a network - adapter for your virtual - machine](https://kb.vmware.com/s/article/1001805) for desktop VMware - clients. For ESXi, refer to the proper ESXi documentation. +- `network` (string) - The network which the virtual machine will connect for local desktop + hypervisors. Use the generic values that map to a device, such as + `hostonly`, `nat`, or `bridged`. Defaults to `nat`. + + ~> **Note:** If not set to one of these generic values, then it is + assumed to be a network device (_e.g._, `VMnet0..x`). + +- `network_name` (string) - The network which the virtual machine will connect on a remote + hypervisor. -- `network_name` (string) - The custom name of the network. Sets the vmx value "ethernet0.networkName" +- `network_adapter_type` (string) - The virtual machine network card type. Recommended values are `e1000` and + `vmxnet3`. Defaults to `e1000`. + + Refer to VMware product documentation for supported network adapter types + for the hypervisor and guest operating system. -- `sound` (bool) - Specify whether to enable VMware's virtual soundcard device when - building the VM. Defaults to false. +- `sound` (bool) - Enable virtual sound card device. Defaults to `false`. -- `usb` (bool) - Enable VMware's USB bus when building the guest VM. Defaults to false. - To enable usage of the XHCI bus for USB 3 (5 Gbit/s), one can use the - vmx_data option to enable it by specifying true for the usb_xhci.present - property. +- `usb` (bool) - Enable a the USB 2.0 controllers for the virtual machine. + Defaults to `false`. + + ~> **Note:** To enable USB 3.0 controllers, set a `usb_xhci.present` + key to `true` in the `vmx_data` option. -- `serial` (string) - This specifies a serial port to add to the VM. It has a format of - `Type:option1,option2,...`. The field `Type` can be one of the following - values: `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. +- `serial` (string) - Add a serial port to the virtual machine. Use a format of + `Type:option1,option2,...`. Allowed values for the field `Type` include: + `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. * `FILE:path(,yield)` - Specifies the path to the local file to be used as the serial port. * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By - default, the builder will assume this as `FALSE`. + whether the virtual machine should yield the CPU when polling the + port. By default, the builder will assume this as `FALSE`. * `DEVICE:path(,yield)` - Specifies the path to the local device to be   used as the serial port. If `path` is empty, then default to the first serial port. * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By - default, the builder will assume this as `FALSE`. + whether the virtual machine should yield the CPU when polling the + port. By default, the builder will assume this as `FALSE`. * `PIPE:path,endpoint,host(,yield)` - Specifies to use the named-pipe "path" as a serial port. This has a few options that determine how the @@ -627,38 +632,38 @@ provisioner](/packer/docs/provisioner/file). * `endpoint` (string) - Chooses the type of the VM-end, which can be either a `client` or `server`. - * `host` (string) - Chooses the type of the host-end, which can - be either `app` (application) or `vm` (another virtual-machine). + * `host` (string) - Chooses the type of the host-end, which can be + either `app` (application) or `vm` (another virtual-machine). - * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By + * `yield` (bool) - This is an optional boolean that specifies whether + the virtual machine should yield the CPU when polling the port. By default, the builder will assume this as `FALSE`. * `AUTO:(yield)` - Specifies to use auto-detection to determine the - serial port to use. This has one option to determine how the VM should - support the serial port. + serial port to use. This has one option to determine how the virtual + machine should support the serial port. - * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By + * `yield` (bool) - This is an optional boolean that specifies whether + the virtual machine should yield the CPU when polling the port. By default, the builder will assume this as `FALSE`. * `NONE` - Specifies to not use a serial port. (default) -- `parallel` (string) - This specifies a parallel port to add to the VM. It has the format of - `Type:option1,option2,...`. Type can be one of the following values: +- `parallel` (string) - Add a parallel port to add to the virtual machine. Use a format of + `Type:option1,option2,...`. Allowed values for the field `Type` include: `FILE`, `DEVICE`, `AUTO`, or `NONE`. - * `FILE:path` - Specifies the path to the local file to be used - for the parallel port. + * `FILE:path` - Specifies the path to the local file to be used for the + parallel port. - * `DEVICE:path` - Specifies the path to the local device to be used - for the parallel port. + * `DEVICE:path` - Specifies the path to the local device to be used for + the parallel port. - * `AUTO:direction` - Specifies to use auto-detection to determine the + * `AUTO:direction` - Specifies to use auto-detection to determine the parallel port. Direction can be `BI` to specify bidirectional communication or `UNI` to specify unidirectional communication. - * `NONE` - Specifies to not use a parallel port. (default) + * `NONE` - Specifies to not use a parallel port. (default) diff --git a/builder/vmware/common/hw_config.go b/builder/vmware/common/hw_config.go index 08405616..5549787d 100644 --- a/builder/vmware/common/hw_config.go +++ b/builder/vmware/common/hw_config.go @@ -9,59 +9,76 @@ import ( "fmt" "path/filepath" "runtime" + "slices" "strings" "github.com/hashicorp/packer-plugin-sdk/template/interpolate" ) +// Set the firmware types for the virtual machine. +const ( + FirmwareTypeBios = "bios" + FirmwareTypeUEFI = "efi" + FirmwareTypeUEFISecure = "efi-secure" +) + +// allowedFirmwareTypes is a list of allowed firmware types for the virtual +// machine. +var allowedFirmwareTypes = []string{FirmwareTypeBios, FirmwareTypeUEFI, FirmwareTypeUEFISecure} + type HWConfig struct { - // The number of cpus to use when building the VM. + // The firmware type for the virtual machine. + // Allowed values are `bios`, `efi`, and `efi-secure` (for secure boot). + // Defaults to the recommended firmware type for the guest operating system. + Firmware string `mapstructure:"firmware" required:"false"` + // The number of virtual CPUs cores for the virtual machine. CpuCount int `mapstructure:"cpus" required:"false"` - // The amount of memory to use when building the VM in megabytes. - MemorySize int `mapstructure:"memory" required:"false"` - // The number of cores per socket to use when building the VM. This - // corresponds to the cpuid.coresPerSocket option in the .vmx file. + // The number of virtual CPU cores per socket for the virtual machine. CoreCount int `mapstructure:"cores" required:"false"` - // This is the network type that the virtual machine will be created with. - // This can be one of the generic values that map to a device such as - // hostonly, nat, or bridged. If the network is not one of these values, - // then it is assumed to be a VMware network device. (VMnet0..x) + // The amount of memory for the virtual machine in MB. + MemorySize int `mapstructure:"memory" required:"false"` + // The network which the virtual machine will connect for local desktop + // hypervisors. Use the generic values that map to a device, such as + // `hostonly`, `nat`, or `bridged`. Defaults to `nat`. + // + // ~> **Note:** If not set to one of these generic values, then it is + // assumed to be a network device (_e.g._, `VMnet0..x`). Network string `mapstructure:"network" required:"false"` - // This is the ethernet adapter type the the virtual machine will be - // created with. By default the `e1000` network adapter type will be used - // by Packer. For more information, please consult [Choosing a network - // adapter for your virtual - // machine](https://kb.vmware.com/s/article/1001805) for desktop VMware - // clients. For ESXi, refer to the proper ESXi documentation. - NetworkAdapterType string `mapstructure:"network_adapter_type" required:"false"` - // The custom name of the network. Sets the vmx value "ethernet0.networkName" + // The network which the virtual machine will connect on a remote + // hypervisor. NetworkName string `mapstructure:"network_name" required:"false"` - // Specify whether to enable VMware's virtual soundcard device when - // building the VM. Defaults to false. + // The virtual machine network card type. Recommended values are `e1000` and + // `vmxnet3`. Defaults to `e1000`. + // + // Refer to VMware product documentation for supported network adapter types + // for the hypervisor and guest operating system. + NetworkAdapterType string `mapstructure:"network_adapter_type" required:"false"` + // Enable virtual sound card device. Defaults to `false`. Sound bool `mapstructure:"sound" required:"false"` - // Enable VMware's USB bus when building the guest VM. Defaults to false. - // To enable usage of the XHCI bus for USB 3 (5 Gbit/s), one can use the - // vmx_data option to enable it by specifying true for the usb_xhci.present - // property. + // Enable a the USB 2.0 controllers for the virtual machine. + // Defaults to `false`. + // + // ~> **Note:** To enable USB 3.0 controllers, set a `usb_xhci.present` + // key to `true` in the `vmx_data` option. USB bool `mapstructure:"usb" required:"false"` - // This specifies a serial port to add to the VM. It has a format of - // `Type:option1,option2,...`. The field `Type` can be one of the following - // values: `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. + // Add a serial port to the virtual machine. Use a format of + // `Type:option1,option2,...`. Allowed values for the field `Type` include: + // `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. // // * `FILE:path(,yield)` - Specifies the path to the local file to be used // as the serial port. // // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // whether the virtual machine should yield the CPU when polling the + // port. By default, the builder will assume this as `FALSE`. // // * `DEVICE:path(,yield)` - Specifies the path to the local device to be //  used as the serial port. If `path` is empty, then default to the first // serial port. // // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By - // default, the builder will assume this as `FALSE`. + // whether the virtual machine should yield the CPU when polling the + // port. By default, the builder will assume this as `FALSE`. // // * `PIPE:path,endpoint,host(,yield)` - Specifies to use the named-pipe // "path" as a serial port. This has a few options that determine how the @@ -70,57 +87,60 @@ type HWConfig struct { // * `endpoint` (string) - Chooses the type of the VM-end, which can be // either a `client` or `server`. // - // * `host` (string) - Chooses the type of the host-end, which can - // be either `app` (application) or `vm` (another virtual-machine). + // * `host` (string) - Chooses the type of the host-end, which can be + // either `app` (application) or `vm` (another virtual-machine). // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By + // * `yield` (bool) - This is an optional boolean that specifies whether + // the virtual machine should yield the CPU when polling the port. By // default, the builder will assume this as `FALSE`. // // * `AUTO:(yield)` - Specifies to use auto-detection to determine the - // serial port to use. This has one option to determine how the VM should - // support the serial port. + // serial port to use. This has one option to determine how the virtual + // machine should support the serial port. // - // * `yield` (bool) - This is an optional boolean that specifies - // whether the vm should yield the cpu when polling the port. By + // * `yield` (bool) - This is an optional boolean that specifies whether + // the virtual machine should yield the CPU when polling the port. By // default, the builder will assume this as `FALSE`. // // * `NONE` - Specifies to not use a serial port. (default) - // Serial string `mapstructure:"serial" required:"false"` - // This specifies a parallel port to add to the VM. It has the format of - // `Type:option1,option2,...`. Type can be one of the following values: + // Add a parallel port to add to the virtual machine. Use a format of + // `Type:option1,option2,...`. Allowed values for the field `Type` include: // `FILE`, `DEVICE`, `AUTO`, or `NONE`. // - // * `FILE:path` - Specifies the path to the local file to be used - // for the parallel port. + // * `FILE:path` - Specifies the path to the local file to be used for the + // parallel port. // - // * `DEVICE:path` - Specifies the path to the local device to be used - // for the parallel port. + // * `DEVICE:path` - Specifies the path to the local device to be used for + // the parallel port. // - // * `AUTO:direction` - Specifies to use auto-detection to determine the + // * `AUTO:direction` - Specifies to use auto-detection to determine the // parallel port. Direction can be `BI` to specify bidirectional // communication or `UNI` to specify unidirectional communication. // - // * `NONE` - Specifies to not use a parallel port. (default) + // * `NONE` - Specifies to not use a parallel port. (default) Parallel string `mapstructure:"parallel" required:"false"` } func (c *HWConfig) Prepare(ctx *interpolate.Context) []error { var errs []error - if c.CpuCount < 0 { - errs = append(errs, fmt.Errorf("invalid number of cpus specified (cpus < 0): %d", c.CpuCount)) + if (c.Firmware != "") && (!slices.Contains(allowedFirmwareTypes, c.Firmware)) { + errs = append(errs, fmt.Errorf("invalid 'firmware' type specified: %s; must be one of %s", c.Firmware, strings.Join(allowedFirmwareTypes, ", "))) } - if c.MemorySize < 0 { - errs = append(errs, fmt.Errorf("invalid amount of memory specified (memory < 0): %d", c.MemorySize)) + if c.CpuCount < 0 { + errs = append(errs, fmt.Errorf("invalid number of cpus specified (cpus < 0): %d", c.CpuCount)) } if c.CoreCount < 0 { errs = append(errs, fmt.Errorf("invalid number of cpu cores specified (cores < 0): %d", c.CoreCount)) } + if c.MemorySize < 0 { + errs = append(errs, fmt.Errorf("invalid amount of memory specified (memory < 0): %d", c.MemorySize)) + } + // Peripherals if !c.Sound { c.Sound = false @@ -147,13 +167,16 @@ type ParallelUnion struct { Device *ParallelPortDevice Auto *ParallelPortAuto } + type ParallelPortFile struct { Filename string } + type ParallelPortDevice struct { Bidirectional string Devicename string } + type ParallelPortAuto struct { Bidirectional string } diff --git a/builder/vmware/iso/config.hcl2spec.go b/builder/vmware/iso/config.hcl2spec.go index cb659cdc..b66c63b1 100644 --- a/builder/vmware/iso/config.hcl2spec.go +++ b/builder/vmware/iso/config.hcl2spec.go @@ -53,12 +53,13 @@ type FlatConfig struct { RemotePassword *string `mapstructure:"remote_password" required:"false" cty:"remote_password" hcl:"remote_password"` RemotePrivateKey *string `mapstructure:"remote_private_key_file" required:"false" cty:"remote_private_key_file" hcl:"remote_private_key_file"` SkipValidateCredentials *bool `mapstructure:"skip_validate_credentials" required:"false" cty:"skip_validate_credentials" hcl:"skip_validate_credentials"` + Firmware *string `mapstructure:"firmware" required:"false" cty:"firmware" hcl:"firmware"` CpuCount *int `mapstructure:"cpus" required:"false" cty:"cpus" hcl:"cpus"` - MemorySize *int `mapstructure:"memory" required:"false" cty:"memory" hcl:"memory"` CoreCount *int `mapstructure:"cores" required:"false" cty:"cores" hcl:"cores"` + MemorySize *int `mapstructure:"memory" required:"false" cty:"memory" hcl:"memory"` Network *string `mapstructure:"network" required:"false" cty:"network" hcl:"network"` - NetworkAdapterType *string `mapstructure:"network_adapter_type" required:"false" cty:"network_adapter_type" hcl:"network_adapter_type"` NetworkName *string `mapstructure:"network_name" required:"false" cty:"network_name" hcl:"network_name"` + NetworkAdapterType *string `mapstructure:"network_adapter_type" required:"false" cty:"network_adapter_type" hcl:"network_adapter_type"` Sound *bool `mapstructure:"sound" required:"false" cty:"sound" hcl:"sound"` USB *bool `mapstructure:"usb" required:"false" cty:"usb" hcl:"usb"` Serial *string `mapstructure:"serial" required:"false" cty:"serial" hcl:"serial"` @@ -206,12 +207,13 @@ func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec { "remote_password": &hcldec.AttrSpec{Name: "remote_password", Type: cty.String, Required: false}, "remote_private_key_file": &hcldec.AttrSpec{Name: "remote_private_key_file", Type: cty.String, Required: false}, "skip_validate_credentials": &hcldec.AttrSpec{Name: "skip_validate_credentials", Type: cty.Bool, Required: false}, + "firmware": &hcldec.AttrSpec{Name: "firmware", Type: cty.String, Required: false}, "cpus": &hcldec.AttrSpec{Name: "cpus", Type: cty.Number, Required: false}, - "memory": &hcldec.AttrSpec{Name: "memory", Type: cty.Number, Required: false}, "cores": &hcldec.AttrSpec{Name: "cores", Type: cty.Number, Required: false}, + "memory": &hcldec.AttrSpec{Name: "memory", Type: cty.Number, Required: false}, "network": &hcldec.AttrSpec{Name: "network", Type: cty.String, Required: false}, - "network_adapter_type": &hcldec.AttrSpec{Name: "network_adapter_type", Type: cty.String, Required: false}, "network_name": &hcldec.AttrSpec{Name: "network_name", Type: cty.String, Required: false}, + "network_adapter_type": &hcldec.AttrSpec{Name: "network_adapter_type", Type: cty.String, Required: false}, "sound": &hcldec.AttrSpec{Name: "sound", Type: cty.Bool, Required: false}, "usb": &hcldec.AttrSpec{Name: "usb", Type: cty.Bool, Required: false}, "serial": &hcldec.AttrSpec{Name: "serial", Type: cty.String, Required: false}, diff --git a/builder/vmware/iso/step_create_vmx.go b/builder/vmware/iso/step_create_vmx.go index a711ce62..d08e85a7 100644 --- a/builder/vmware/iso/step_create_vmx.go +++ b/builder/vmware/iso/step_create_vmx.go @@ -16,7 +16,7 @@ import ( packersdk "github.com/hashicorp/packer-plugin-sdk/packer" "github.com/hashicorp/packer-plugin-sdk/template/interpolate" "github.com/hashicorp/packer-plugin-sdk/tmp" - vmwcommon "github.com/hashicorp/packer-plugin-vmware/builder/vmware/common" + "github.com/hashicorp/packer-plugin-vmware/builder/vmware/common" ) type vmxTemplateData struct { @@ -25,11 +25,14 @@ type vmxTemplateData struct { ISOPath string Version string + Firmware string + SecureBoot string + CpuCount string MemorySize string DiskName string - vmwcommon.DiskAndCDConfigData + common.DiskAndCDConfigData Network_Type string Network_Device string @@ -102,7 +105,7 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi vmxTemplate = string(rawBytes) } - diskAndCDConfigData := vmwcommon.DefaultDiskAndCDROMTypes(config.DiskAdapterType, config.CdromAdapterType) + diskAndCDConfigData := common.DefaultDiskAndCDROMTypes(config.DiskAdapterType, config.CdromAdapterType) ictx := config.ctx // Mount extra vmdks we created earlier. @@ -201,7 +204,7 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi if config.HWConfig.NetworkName != "" { templateData.Network_Name = config.HWConfig.NetworkName } - driver := state.Get("driver").(vmwcommon.Driver).GetVmwareDriver() + driver := state.Get("driver").(common.Driver).GetVmwareDriver() // check to see if the driver implements a network mapper for mapping // the network-type to its device-name. @@ -265,6 +268,16 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi templateData.Serial_Host = "" templateData.Serial_Auto = "FALSE" + switch config.HWConfig.Firmware { + case common.FirmwareTypeBios: + templateData.Firmware = common.FirmwareTypeBios + case common.FirmwareTypeUEFI, common.FirmwareTypeUEFISecure: + templateData.Firmware = common.FirmwareTypeUEFI + if config.HWConfig.Firmware == common.FirmwareTypeUEFISecure { + templateData.SecureBoot = "TRUE" + } + } + // Set the number of cpus if it was specified if config.HWConfig.CpuCount > 0 { templateData.CpuCount = strconv.Itoa(config.HWConfig.CpuCount) @@ -278,19 +291,19 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi } switch serial.Union.(type) { - case *vmwcommon.SerialConfigPipe: + case *common.SerialConfigPipe: templateData.Serial_Type = "pipe" templateData.Serial_Endpoint = serial.Pipe.Endpoint templateData.Serial_Host = serial.Pipe.Host templateData.Serial_Yield = serial.Pipe.Yield templateData.Serial_Filename = filepath.FromSlash(serial.Pipe.Filename) - case *vmwcommon.SerialConfigFile: + case *common.SerialConfigFile: templateData.Serial_Type = "file" templateData.Serial_Filename = filepath.FromSlash(serial.File.Filename) - case *vmwcommon.SerialConfigDevice: + case *common.SerialConfigDevice: templateData.Serial_Type = "device" templateData.Serial_Filename = filepath.FromSlash(serial.Device.Devicename) - case *vmwcommon.SerialConfigAuto: + case *common.SerialConfigAuto: templateData.Serial_Type = "device" templateData.Serial_Filename = filepath.FromSlash(serial.Auto.Devicename) templateData.Serial_Yield = serial.Auto.Yield @@ -320,14 +333,14 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi templateData.Parallel_Auto = "FALSE" switch parallel.Union.(type) { - case *vmwcommon.ParallelPortFile: + case *common.ParallelPortFile: templateData.Parallel_Present = "TRUE" templateData.Parallel_Filename = filepath.FromSlash(parallel.File.Filename) - case *vmwcommon.ParallelPortDevice: + case *common.ParallelPortDevice: templateData.Parallel_Present = "TRUE" templateData.Parallel_Bidirectional = parallel.Device.Bidirectional templateData.Parallel_Filename = filepath.FromSlash(parallel.Device.Devicename) - case *vmwcommon.ParallelPortAuto: + case *common.ParallelPortAuto: templateData.Parallel_Present = "TRUE" templateData.Parallel_Auto = "TRUE" templateData.Parallel_Bidirectional = parallel.Auto.Bidirectional @@ -372,7 +385,7 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi } /// Now to handle options that will modify the template without using "vmxTemplateData" - vmxData := vmwcommon.ParseVMX(vmxContents) + vmxData := common.ParseVMX(vmxContents) // If no cpus were specified, then remove the entry to use the default if vmxData["numvcpus"] == "" { @@ -386,7 +399,7 @@ func (s *stepCreateVMX) Run(ctx context.Context, state multistep.StateBag) multi // Write the vmxData to the vmxPath vmxPath := filepath.Join(vmxDir, config.VMName+".vmx") - if err := vmwcommon.WriteVMX(vmxPath, vmxData); err != nil { + if err := common.WriteVMX(vmxPath, vmxData); err != nil { err := fmt.Errorf("error creating VMX file: %s", err) state.Put("error", err) ui.Error(err.Error()) @@ -412,6 +425,10 @@ const DefaultVMXTemplate = ` displayName = "{{ .Name }}" +// Firmware +{{ if .Firmware }}firmware = "{{ .Firmware }}"{{ end }} +{{ if .SecureBoot }}uefi.secureBoot.enabled = "TRUE"{{ end }} + // Hardware numvcpus = "{{ .CpuCount }}" memsize = "{{ .MemorySize }}" diff --git a/docs-partials/builder/vmware/common/HWConfig-not-required.mdx b/docs-partials/builder/vmware/common/HWConfig-not-required.mdx index 29e5f982..631c23b4 100644 --- a/docs-partials/builder/vmware/common/HWConfig-not-required.mdx +++ b/docs-partials/builder/vmware/common/HWConfig-not-required.mdx @@ -1,52 +1,57 @@ -- `cpus` (int) - The number of cpus to use when building the VM. +- `firmware` (string) - The firmware type for the virtual machine. + Allowed values are `bios`, `efi`, and `efi-secure` (for secure boot). + Defaults to the recommended firmware type for the guest operating system. -- `memory` (int) - The amount of memory to use when building the VM in megabytes. +- `cpus` (int) - The number of virtual CPUs cores for the virtual machine. -- `cores` (int) - The number of cores per socket to use when building the VM. This - corresponds to the cpuid.coresPerSocket option in the .vmx file. +- `cores` (int) - The number of virtual CPU cores per socket for the virtual machine. -- `network` (string) - This is the network type that the virtual machine will be created with. - This can be one of the generic values that map to a device such as - hostonly, nat, or bridged. If the network is not one of these values, - then it is assumed to be a VMware network device. (VMnet0..x) +- `memory` (int) - The amount of memory for the virtual machine in MB. -- `network_adapter_type` (string) - This is the ethernet adapter type the the virtual machine will be - created with. By default the `e1000` network adapter type will be used - by Packer. For more information, please consult [Choosing a network - adapter for your virtual - machine](https://kb.vmware.com/s/article/1001805) for desktop VMware - clients. For ESXi, refer to the proper ESXi documentation. +- `network` (string) - The network which the virtual machine will connect for local desktop + hypervisors. Use the generic values that map to a device, such as + `hostonly`, `nat`, or `bridged`. Defaults to `nat`. + + ~> **Note:** If not set to one of these generic values, then it is + assumed to be a network device (_e.g._, `VMnet0..x`). + +- `network_name` (string) - The network which the virtual machine will connect on a remote + hypervisor. -- `network_name` (string) - The custom name of the network. Sets the vmx value "ethernet0.networkName" +- `network_adapter_type` (string) - The virtual machine network card type. Recommended values are `e1000` and + `vmxnet3`. Defaults to `e1000`. + + Refer to VMware product documentation for supported network adapter types + for the hypervisor and guest operating system. -- `sound` (bool) - Specify whether to enable VMware's virtual soundcard device when - building the VM. Defaults to false. +- `sound` (bool) - Enable virtual sound card device. Defaults to `false`. -- `usb` (bool) - Enable VMware's USB bus when building the guest VM. Defaults to false. - To enable usage of the XHCI bus for USB 3 (5 Gbit/s), one can use the - vmx_data option to enable it by specifying true for the usb_xhci.present - property. +- `usb` (bool) - Enable a the USB 2.0 controllers for the virtual machine. + Defaults to `false`. + + ~> **Note:** To enable USB 3.0 controllers, set a `usb_xhci.present` + key to `true` in the `vmx_data` option. -- `serial` (string) - This specifies a serial port to add to the VM. It has a format of - `Type:option1,option2,...`. The field `Type` can be one of the following - values: `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. +- `serial` (string) - Add a serial port to the virtual machine. Use a format of + `Type:option1,option2,...`. Allowed values for the field `Type` include: + `FILE`, `DEVICE`, `PIPE`, `AUTO`, or `NONE`. * `FILE:path(,yield)` - Specifies the path to the local file to be used as the serial port. * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By - default, the builder will assume this as `FALSE`. + whether the virtual machine should yield the CPU when polling the + port. By default, the builder will assume this as `FALSE`. * `DEVICE:path(,yield)` - Specifies the path to the local device to be   used as the serial port. If `path` is empty, then default to the first serial port. * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By - default, the builder will assume this as `FALSE`. + whether the virtual machine should yield the CPU when polling the + port. By default, the builder will assume this as `FALSE`. * `PIPE:path,endpoint,host(,yield)` - Specifies to use the named-pipe "path" as a serial port. This has a few options that determine how the @@ -55,37 +60,37 @@ * `endpoint` (string) - Chooses the type of the VM-end, which can be either a `client` or `server`. - * `host` (string) - Chooses the type of the host-end, which can - be either `app` (application) or `vm` (another virtual-machine). + * `host` (string) - Chooses the type of the host-end, which can be + either `app` (application) or `vm` (another virtual-machine). - * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By + * `yield` (bool) - This is an optional boolean that specifies whether + the virtual machine should yield the CPU when polling the port. By default, the builder will assume this as `FALSE`. * `AUTO:(yield)` - Specifies to use auto-detection to determine the - serial port to use. This has one option to determine how the VM should - support the serial port. + serial port to use. This has one option to determine how the virtual + machine should support the serial port. - * `yield` (bool) - This is an optional boolean that specifies - whether the vm should yield the cpu when polling the port. By + * `yield` (bool) - This is an optional boolean that specifies whether + the virtual machine should yield the CPU when polling the port. By default, the builder will assume this as `FALSE`. * `NONE` - Specifies to not use a serial port. (default) -- `parallel` (string) - This specifies a parallel port to add to the VM. It has the format of - `Type:option1,option2,...`. Type can be one of the following values: +- `parallel` (string) - Add a parallel port to add to the virtual machine. Use a format of + `Type:option1,option2,...`. Allowed values for the field `Type` include: `FILE`, `DEVICE`, `AUTO`, or `NONE`. - * `FILE:path` - Specifies the path to the local file to be used - for the parallel port. + * `FILE:path` - Specifies the path to the local file to be used for the + parallel port. - * `DEVICE:path` - Specifies the path to the local device to be used - for the parallel port. + * `DEVICE:path` - Specifies the path to the local device to be used for + the parallel port. - * `AUTO:direction` - Specifies to use auto-detection to determine the + * `AUTO:direction` - Specifies to use auto-detection to determine the parallel port. Direction can be `BI` to specify bidirectional communication or `UNI` to specify unidirectional communication. - * `NONE` - Specifies to not use a parallel port. (default) + * `NONE` - Specifies to not use a parallel port. (default)