Type: vsphere-iso Artifact BuilderId: jetbrains.vsphere

This builder uses the vSphere API, and creates virtual machines remotely. It starts from an ISO file and creates new VMs from scratch.

• VMware Player is not required.
• It uses the official vCenter Server API, and does not require ESXi host modification
• The builder supports versions following the VMware Product Lifecycle Matrix from General Availability to End of General Support. Builds on versions that are end of support may work, but configuration options may throw errors if they do not exist in the vSphere API for those versions.

Examples

See example templates in the examples folder.

Configuration Reference

There are many configuration options available for this builder. In addition to the items listed here, you will want to look at the general configuration references for HTTP, Floppy, Boot, Hardware, Output, Run, Shutdown, Communicator, Export, configuration references, which are necessary for this build to succeed and can be found further down the page.

• create_snapshot (bool) - Create a snapshot of the virtual machine to use as a base for linked clones. Defaults to false.

• snapshot_name (string) - The name of the snapshot when create_snapshot is true. Defaults to Created By Packer.

• convert_to_template (bool) - Convert the virtual machine to a template after the build is complete. Defaults to false. If set to true, the virtual machine can not be imported into a content library.

• export (*common.ExportConfig) - The configuration for exporting the virtual machine to an OVF. The virtual machine is not exported if export configuration is not specified.

• content_library_destination (*common.ContentLibraryDestinationConfig) - Import the virtual machine as a VM template or OVF template to a content library. The template will not be imported if no content library import configuration is specified. If set, convert_to_template must be set to false.

• local_cache_overwrite (bool) - Overwrite files in the local cache if they already exist. Defaults to false.

• remote_cache_cleanup (bool) - Cleanup items added to the remote cache after the build is complete. Defaults to false.

  Note: If the local cache overwrite flag is set to true, RemoteCacheOverwrite will implicitly be set to true. This is to ensure consistency between the local and remote cache.

• remote_cache_overwrite (bool) - Overwrite files in the remote cache if they already exist. Defaults to false.

• remote_cache_datastore (string) - The remote cache datastore to use for the build. If not set, the datastore of the virtual machine is used.

• remote_cache_path (string) - The directory path on the remote cache datastore to use for the build. If not set, the default path is packer_cache/.

Boot Configuration

The boot configuration is very important: boot_command specifies the keys to type when the virtual machine is first booted in order to start the OS installer. This command is typed after boot_wait, which gives the virtual machine some time to actually load.

The boot_command is an array of strings. The strings are all typed in sequence. It is an array only to improve readability within the template.

There are a set of special keys available. If these are in your boot command, they will be replaced by the proper key:

• <bs> - Backspace

• <del> - Delete

• <enter> <return> - Simulates an actual "enter" or "return" keypress.

• <esc> - Simulates pressing the escape key.

• <tab> - Simulates pressing the tab key.

• <f1> - <f12> - Simulates pressing a function key.

• <up> <down> <left> <right> - Simulates pressing an arrow key.

• <spacebar> - Simulates pressing the spacebar.

• <insert> - Simulates pressing the insert key.

• <home> <end> - Simulates pressing the home and end keys.

• <pageUp> <pageDown> - Simulates pressing the page up and page down keys.

• <menu> - Simulates pressing the Menu key.

• <leftAlt> <rightAlt> - Simulates pressing the alt key.

• <leftCtrl> <rightCtrl> - Simulates pressing the ctrl key.

• <leftShift> <rightShift> - Simulates pressing the shift key.

• <leftSuper> <rightSuper> - Simulates pressing the ⌘ or Windows key.

• <wait> <wait5> <wait10> - Adds a 1, 5 or 10 second pause before sending any additional keys. This is useful if you have to generally wait for the UI to update before typing more.

• <waitXX> - Add an arbitrary pause before sending any additional keys. The format of XX is a sequence of positive decimal numbers, each with optional fraction and a unit suffix, such as 300ms, 1.5h or 2h45m. Valid time units are ns, us (or µs), ms, s, m, h. For example <wait10m> or <wait1m20s>.

• <XXXOn> <XXXOff> - Any printable keyboard character, and of these "special" expressions, with the exception of the <wait> types, can also be toggled on or off. For example, to simulate ctrl+c, use <leftCtrlOn>c<leftCtrlOff>. Be sure to release them, otherwise they will be held down until the machine reboots. To hold the c key down, you would use <cOn>. Likewise, <cOff> to release.

• {{ .HTTPIP }} {{ .HTTPPort }} - The IP and port, respectively of an HTTP server that is started serving the directory specified by the http_directory configuration parameter. If http_directory isn't specified, these will be blank!

• {{ .Name }} - The name of the VM.

Example boot command. This is actually a working boot command used to start an CentOS 6.4 installer:

In JSON:

"boot_command": [

       "<tab><wait>",
       " ks=http://{{ .HTTPIP }}:{{ .HTTPPort }}/centos6-ks.cfg<enter>"
    ]

In HCL2:

boot_command = [

       "<tab><wait>",
       " ks=http://{{ .HTTPIP }}:{{ .HTTPPort }}/centos6-ks.cfg<enter>"
    ]

The example shown below is a working boot command used to start an Ubuntu 12.04 installer:

In JSON:

"boot_command": [

    "<esc><esc><enter><wait>",
    "/install/vmlinuz noapic ",
    "preseed/url=http://{{ .HTTPIP }}:{{ .HTTPPort }}/preseed.cfg ",
    "debian-installer=en_US auto locale=en_US kbd-chooser/method=us ",
    "hostname={{ .Name }} ",
    "fb=false debconf/frontend=noninteractive ",
    "keyboard-configuration/modelcode=SKIP keyboard-configuration/layout=USA ",
    "keyboard-configuration/variant=USA console-setup/ask_detect=false ",
    "initrd=/install/initrd.gz -- <enter>"

]

In HCL2:

boot_command = [

    "<esc><esc><enter><wait>",
    "/install/vmlinuz noapic ",
    "preseed/url=http://{{ .HTTPIP }}:{{ .HTTPPort }}/preseed.cfg ",
    "debian-installer=en_US auto locale=en_US kbd-chooser/method=us ",
    "hostname={{ .Name }} ",
    "fb=false debconf/frontend=noninteractive ",
    "keyboard-configuration/modelcode=SKIP keyboard-configuration/layout=USA ",
    "keyboard-configuration/variant=USA console-setup/ask_detect=false ",
    "initrd=/install/initrd.gz -- <enter>"

]

For more examples of various boot commands, see the sample projects from our community templates page.

We send each character to the VM with a default delay of 100ms between groups. The delay alleviates possible issues with latency and CPU contention. If you notice missing keys, you can tune this delay by specifying "boot_keygroup_interval" in your Packer template, for example:

JSON

{
  "builders": [
    {
      "type": "vsphere-iso",
      "boot_keygroup_interval": "500ms"
      ...
    }
  ]
}

HCL2

source "vsphere-iso" "example" {
    boot_keygroup_interval = "500ms"
    # ...
}

Optional:

• boot_keygroup_interval (duration string | ex: "1h5m2s") - Time to wait after sending a group of key pressses. The value of this should be a duration. Examples are 5s and 1m30s which will cause Packer to wait five seconds and one minute 30 seconds, respectively. If this isn't specified, a sensible default value is picked depending on the builder type.

• boot_wait (duration string | ex: "1h5m2s") - The time to wait after booting the initial virtual machine before typing the boot_command. The value of this should be a duration. Examples are 5s and 1m30s which will cause Packer to wait five seconds and one minute 30 seconds, respectively. If this isn't specified, the default is 10s or 10 seconds. To set boot_wait to 0s, use a negative number, such as "-1s"

• boot_command ([]string) - This is an array of commands to type when the virtual machine is first booted. The goal of these commands should be to type just enough to initialize the operating system installer. Special keys can be typed as well, and are covered in the section below on the boot command. If this is not specified, it is assumed the installer will start itself.

• http_ip (string) - The IP address to use for the HTTP server started to serve the http_directory. If unset, Packer will automatically discover and assign an IP.

Http directory configuration

Packer will create an http server serving http_directory when it is set, a random free port will be selected and the architecture of the directory referenced will be available in your builder.

Example usage from a builder:

wget http://{{ .HTTPIP }}:{{ .HTTPPort }}/foo/bar/preseed.cfg

Optional:

• http_directory (string) - Path to a directory to serve using an HTTP server. The files in this directory will be available over HTTP that will be requestable from the virtual machine. This is useful for hosting kickstart files and so on. By default this is an empty string, which means no HTTP server will be started. The address and port of the HTTP server will be available as variables in boot_command. This is covered in more detail below.

• http_content (map[string]string) - Key/Values to serve using an HTTP server. http_content works like and conflicts with http_directory. The keys represent the paths and the values contents, the keys must start with a slash, ex: /path/to/file. http_content is useful for hosting kickstart files and so on. By default this is empty, which means no HTTP server will be started. The address and port of the HTTP server will be available as variables in boot_command. This is covered in more detail below. Example:

    http_content = {
      "/a/b"     = file("http/b")
      "/foo/bar" = templatefile("${path.root}/preseed.cfg", { packages = ["nginx"] })
    }
  

  Copy

• http_port_min (int) - These are the minimum and maximum port to use for the HTTP server started to serve the http_directory. Because Packer often runs in parallel, Packer will choose a randomly available port in this range to run the HTTP server. If you want to force the HTTP server to be on one port, make this minimum and maximum port the same. By default the values are 8000 and 9000, respectively.

• http_port_max (int) - HTTP Port Max

• http_bind_address (string) - This is the bind address for the HTTP server. Defaults to 0.0.0.0 so that it will work with any network interface.

Floppy configuration

• floppy_img_path (string) - Datastore path to a floppy image that will be mounted to the VM. Example: [datastore1] ISO/pvscsi-Windows8.flp.

• floppy_files ([]string) - List of local files to be mounted to the VM floppy drive. Can be used to make Debian preseed or RHEL kickstart files available to the VM.

• floppy_dirs ([]string) - List of directories to copy files from.

• floppy_content (map[string]string) - Key/Values to add to the floppy disk. The keys represent the paths, and the values contents. It can be used alongside floppy_files or floppy_dirs, which is useful to add large files without loading them into memory. If any paths are specified by both, the contents in floppy_content will take precedence.

  Usage example (HCL):

  floppy_content = {
    "meta-data" = jsonencode(local.instance_data)
    "user-data" = templatefile("user-data", { packages = ["nginx"] })
  }
  

  Copy

• floppy_label (string) - The label to use for the floppy disk that is attached when the VM is booted. This is most useful for cloud-init, Kickstart or other early initialization tools, which can benefit from labelled floppy disks. By default, the floppy label will be 'packer'.

Connection Configuration

• vcenter_server (string) - vCenter Server hostname.

• username (string) - vSphere username.

• password (string) - vSphere password.

• insecure_connection (bool) - Do not validate the vCenter Server TLS certificate. Defaults to false.

• datacenter (string) - vSphere datacenter name. Required if there is more than one datacenter in the vSphere inventory.

Hardware Configuration

• CPUs (int32) - Number of CPU cores.

• cpu_cores (int32) - Number of CPU cores per socket.

• CPU_reservation (int64) - Amount of reserved CPU resources in MHz.

• CPU_limit (int64) - Upper limit of available CPU resources in MHz.

• CPU_hot_plug (bool) - Enable CPU hot plug setting for virtual machine. Defaults to false.

• RAM (int64) - Amount of RAM in MB.

• RAM_reservation (int64) - Amount of reserved RAM in MB.

• RAM_reserve_all (bool) - Reserve all available RAM. Defaults to false. Cannot be used together with RAM_reservation.

• RAM_hot_plug (bool) - Enable RAM hot plug setting for virtual machine. Defaults to false.

• video_ram (int64) - Amount of video memory in KB. See vSphere documentation for supported maximums. Defaults to 4096 KB.

• displays (int32) - Number of video displays. See vSphere documentation for supported maximums. Defaults to 1.

• pci_passthrough_allowed_device ([]PCIPassthroughAllowedDevice) - Configure Dynamic DirectPath I/O PCI Passthrough for virtual machine. See vSphere documentation

• vgpu_profile (string) - vGPU profile for accelerated graphics. vGPU profile for accelerated graphics. See NVIDIA GRID vGPU documentation for examples of profile names. Defaults to none.

• NestedHV (bool) - Enable nested hardware virtualization for VM. Defaults to false.

• firmware (string) - Set the Firmware for virtual machine. Supported values: bios, efi or efi-secure. Defaults to bios.

• force_bios_setup (bool) - During the boot, force entry into the BIOS setup screen. Defaults to false.

• vTPM (bool) - Add virtual TPM device for virtual machine. Defaults to false.

• precision_clock (string) - Add a precision clock device for virtual machine. Defaults to none.

PCI Passthrough Configuration

Dynamic DirectPath I/O is component of the Assignable Hardware framework in VMware vSphere. Dynamic DirectPath I/O enables the Assignable Hardware intelligence for passthrough devices and the hardware address of the PCIe device is no longer directly mapped to the virtual machine configuration. Instead, the attributes, or capabilities, are exposed to the virtual machine.

JSON

    {
      "pci_passthrough_allowed_device": {
        "vendor_id": "8086",
        "device_id": "100e",
        "sub_device_id": "8086",
        "sub_vendor_id": "100e"
      }
    }

HCL2

    pci_passthrough_allowed_device {
      "vendor_id": "8086",
      "device_id": "100e",
      "sub_device_id": "8086",
      "sub_vendor_id": "100e"
    }

• vendor_id (string) - The sub-vendor ID of the PCI device.

• device_id (string) - The vendor ID of the PCI device.

• sub_vendor_id (string) - The sub-vendor ID of the PCI device.

• sub_device_id (string) - The sub-device ID of the PCI device.

Location Configuration

• vm_name (string) - Name of the virtual machine.

• folder (string) - VM folder where the virtual machine is created.

• cluster (string) - vSphere cluster where the virtual machine is created. See the Working With Clusters And Hosts section above for more details.

• host (string) - ESXi host where the virtual machine is created. A full path must be specified if the host is in a folder. For example folder/host. See the Working With Clusters And Hosts section above for more details.

• resource_pool (string) - vSphere resource pool where the virtual machine is created. If this is not specified, the root resource pool associated with the host or cluster is used. Note that the full path to the resource pool must be provided. For example, a simple resource pool path might resemble rp-packer and a nested path might resemble 'rp-packer/rp-linux-images'.

• datastore (string) - vSphere datastore where the virtual machine is created. Required if host is a cluster, or if host has multiple datastores.

• set_host_for_datastore_uploads (bool) - Specifies that the host is used for uploading files to the datastore. Defaults to false.

Run Configuration

• boot_order (string) - Priority of boot devices. Defaults to disk,cdrom

Shutdown Configuration

• shutdown_command (string) - Specify a VM guest shutdown command. This command will be executed using the communicator. Otherwise, the VMware Tools are used to gracefully shutdown the VM.

• shutdown_timeout (duration string | ex: "1h5m2s") - Amount of time to wait for graceful VM shutdown. Defaults to 5m or five minutes. This will likely need to be modified if the communicator is 'none'.

• disable_shutdown (bool) - Packer normally halts the virtual machine after all provisioners have run when no shutdown_command is defined. If this is set to true, Packer will not halt the virtual machine but will assume that you will send the stop signal yourself through a preseed.cfg, a script or the final provisioner. Packer will wait for a default of five minutes until the virtual machine is shutdown. The timeout can be changed using shutdown_timeout option.

Wait Configuration

• ip_wait_timeout (duration string | ex: "1h5m2s") - Amount of time to wait for VM's IP, similar to 'ssh_timeout'. Defaults to 30m (30 minutes). See the Golang ParseDuration documentation for full details.

• ip_settle_timeout (duration string | ex: "1h5m2s") - Amount of time to wait for VM's IP to settle down, sometimes VM may report incorrect IP initially, then its recommended to set that parameter to apx. 2 minutes. Examples 45s and 10m. Defaults to 5s(5 seconds). See the Golang ParseDuration documentation for full details.

• ip_wait_address (*string) - Set this to a CIDR address to cause the service to wait for an address that is contained in this network range. Defaults to "0.0.0.0/0" for any ipv4 address. Examples include:

  • empty string ("") - remove all filters
  • 0:0:0:0:0:0:0:0/0 - allow only ipv6 addresses
  • 192.168.1.0/24 - only allow ipv4 addresses from 192.168.1.1 to 192.168.1.254

ISO Configuration

By default, Packer will symlink, download or copy image files to the Packer cache into a "hash($iso_url+$iso_checksum).$iso_target_extension" file. Packer uses hashicorp/go-getter in file mode in order to perform a download.

go-getter supports the following protocols:

• Local files
• Git
• Mercurial
• HTTP
• Amazon S3

Examples: go-getter can guess the checksum type based on iso_checksum length, and it is also possible to specify the checksum type.

In JSON:

    "iso_checksum": "946a6077af6f5f95a51f82fdc44051c7aa19f9cfc5f737954845a6050543d7c2",
    "iso_url": "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    "iso_checksum": "file:ubuntu.org/..../ubuntu-14.04.1-server-amd64.iso.sum",
    "iso_url": "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    "iso_checksum": "file://./shasums.txt",
    "iso_url": "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    "iso_checksum": "file:./shasums.txt",
    "iso_url": "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

In HCL2:

    iso_checksum = "946a6077af6f5f95a51f82fdc44051c7aa19f9cfc5f737954845a6050543d7c2"
    iso_url = "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    iso_checksum = "file:ubuntu.org/..../ubuntu-14.04.1-server-amd64.iso.sum"
    iso_url = "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    iso_checksum = "file://./shasums.txt"
    iso_url = "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

    iso_checksum = "file:./shasums.txt",
    iso_url = "ubuntu.org/.../ubuntu-14.04.1-server-amd64.iso"

Required:

• iso_checksum (string) - The checksum for the ISO file or virtual hard drive file. The type of the checksum is specified within the checksum field as a prefix, ex: "md5:{$checksum}". The type of the checksum can also be omitted and Packer will try to infer it based on string length. Valid values are "none", "{$checksum}", "md5:{$checksum}", "sha1:{$checksum}", "sha256:{$checksum}", "sha512:{$checksum}" or "file:{$path}". Here is a list of valid checksum values:

  • md5:090992ba9fd140077b0661cb75f7ce13
  • 090992ba9fd140077b0661cb75f7ce13
  • sha1:ebfb681885ddf1234c18094a45bbeafd91467911
  • ebfb681885ddf1234c18094a45bbeafd91467911
  • sha256:ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
  • ed363350696a726b7932db864dda019bd2017365c9e299627830f06954643f93
  • file:http://releases.ubuntu.com/20.04/SHA256SUMS
  • file:file://./local/path/file.sum
  • file:./local/path/file.sum
  • none Although the checksum will not be verified when it is set to "none", this is not recommended since these files can be very large and corruption does happen from time to time.

• iso_url (string) - A URL to the ISO containing the installation image or virtual hard drive (VHD or VHDX) file to clone.

Optional:

• iso_urls ([]string) - Multiple URLs for the ISO to download. Packer will try these in order. If anything goes wrong attempting to download or while downloading a single URL, it will move on to the next. All URLs must point to the same file (same checksum). By default this is empty and iso_url is used. Only one of iso_url or iso_urls can be specified.

• iso_target_path (string) - The path where the iso should be saved after download. By default will go in the packer cache, with a hash of the original filename and checksum as its name.

• iso_target_extension (string) - The extension of the iso file after download. This defaults to iso.

CDRom Configuration

Each iso defined in the CDRom Configuration adds a new drive. If the "iso_url" is defined in addition to the "iso_paths", the "iso_url" is added to the VM first. This keeps the "iso_url" first in the boot order by default allowing the boot iso being defined by the iso_url and the vmware tools iso added from the datastore. Example:

JSON

"iso_urls": [
  "win10.iso",
  "http://example.org/isos/win10.iso"
],
"iso_paths": [
    "[] /usr/lib/vmware/isoimages/windows.iso"
],

HCL2

iso_urls = [
  "win10.iso",
  "http://example.org/isos/win10.iso"
]

iso_paths = [
    "[] /usr/lib/vmware/isoimages/windows.iso"
]

• cdrom_type (string) - Which controller to use. Example: sata. Defaults to ide.

• iso_paths ([]string) - A list of paths to ISO files in either a datastore or a content library that will be mounted to the VM.

  Usage example (HCL):

  iso_paths = [
    "[nfs] iso/ubuntu-server-amd64.iso",
    "Packer/ubuntu-server-amd64/ubuntu-server-amd64.iso"
  ]
  

  Copy

  Two ISOs are referenced:

  1. An ISO in the "iso" folder of the "nfs" datastore with the file name of "ubuntu-server-amd64.iso".
  2. An ISO in the "Packer" content library with the item name of "ubuntu-server-amd64".

  Note: All files in a content library have an associated item name. To determine the file name, view the datastore backing the content library or use the govc vSphere CLI.

• remove_cdrom (bool) - Remove CD-ROM devices from template. Defaults to false.

• reattach_cdroms (int) - Reattach one or more configured CD-ROM devices. Range: 1-4. You can reattach up to 4 CD-ROM devices to the final build artifact. If set to 0, reattach_cdroms is ignored and the step is skipped. When set to a value in the range, remove_cdrom is ignored and the CD-ROM devices are kept without any attached media.

An iso (CD) containing custom files can be made available for your build.

By default, no extra CD will be attached. All files listed in this setting get placed into the root directory of the CD and the CD is attached as the second CD device.

This config exists to work around modern operating systems that have no way to mount floppy disks, which was our previous go-to for adding files at boot time.

Optional:

• cd_files ([]string) - A list of files to place onto a CD that is attached when the VM is booted. This can include either files or directories; any directories will be copied onto the CD recursively, preserving directory structure hierarchy. Symlinks will have the link's target copied into the directory tree on the CD where the symlink was. File globbing is allowed.

  Usage example (JSON):

  "cd_files": ["./somedirectory/meta-data", "./somedirectory/user-data"],
  "cd_label": "cidata",
  

  Copy

  Usage example (HCL):

  cd_files = ["./somedirectory/meta-data", "./somedirectory/user-data"]
  cd_label = "cidata"
  

  Copy

  The above will create a CD with two files, user-data and meta-data in the CD root. This specific example is how you would create a CD that can be used for an Ubuntu 20.04 autoinstall.

  Since globbing is also supported,

  cd_files = ["./somedirectory/*"]
  cd_label = "cidata"
  

  Copy

  Would also be an acceptable way to define the above cd. The difference between providing the directory with or without the glob is whether the directory itself or its contents will be at the CD root.

  Use of this option assumes that you have a command line tool installed that can handle the iso creation. Packer will use one of the following tools:

  • xorriso
  • mkisofs
  • hdiutil (normally found in macOS)
  • oscdimg (normally found in Windows as part of the Windows ADK)

• cd_content (map[string]string) - Key/Values to add to the CD. The keys represent the paths, and the values contents. It can be used alongside cd_files, which is useful to add large files without loading them into memory. If any paths are specified by both, the contents in cd_content will take precedence.

  Usage example (HCL):

  cd_files = ["vendor-data"]
  cd_content = {
    "meta-data" = jsonencode(local.instance_data)
    "user-data" = templatefile("user-data", { packages = ["nginx"] })
  }
  cd_label = "cidata"
  

  Copy

• cd_label (string) - CD Label

Create Configuration

• vm_version (uint) - Specifies the virtual machine hardware version. Defaults to the most current virtual machine hardware version supported by the ESXi host. Refer to KB 315655 for more information on supported virtual hardware versions.

• guest_os_type (string) - Specifies the guest operating system identifier for the virtual machine. If not specified, the setting defaults to otherGuest.

  To get a list of supported guest operating system identifiers for your ESXi host, run the following PowerShell command using VMware.PowerCLI:

  Connect-VIServer -Server "vc.example.com" -User "administrator@vsphere" -Password "password"
  $esxiHost = Get-VMHost -Name "esxi.example.com"
  $environmentBrowser = Get-View -Id $esxiHost.ExtensionData.Parent.ExtensionData.ConfigManager.EnvironmentBrowser
  $vmxVersion = ($environmentBrowser.QueryConfigOptionDescriptor() | Where-Object DefaultConfigOption).Key
  $osDescriptor = $environmentBrowser.QueryConfigOption($vmxVersion, $null).GuestOSDescriptor
  $osDescriptor | Select-Object Id, Fullname
  

  Copy

• network_adapters ([]NIC) - Specifies the network adapters for the virtual machine. If no network adapter is defined, all network-related operations will be skipped.

• usb_controller ([]string) - Specifies the USB controllers for the virtual machine. Use usb for a USB 2.0 controller and `xhci`` for a USB 3.0 controller. -> Note: Maximum of one controller of each type.

• notes (string) - Specifies the annotations for the virtual machine.

• destroy (bool) - Specifies whether to destroy the virtual machine after the build is complete.

• disk_controller_type ([]string) - Set VM disk controller type. Example lsilogic, lsilogic-sas, pvscsi, nvme, or scsi. Use a list to define additional controllers. Defaults to lsilogic. See SCSI, SATA, and NVMe Storage Controller Conditions, Limitations, and Compatibility for additional details.

• storage ([]DiskConfig) - Configures a collection of one or more disks to be provisioned along with the VM. See the Storage Configuration.

Network Adapter Configuration

Defines a Network Adapter If no adapter is defined, network tasks (communicators, most provisioners) won't work, so it's advised to define one.

Example that creates two network adapters:

In JSON:

    "network_adapters": [
      {
        "network": "VM Network",
        "network_card": "vmxnet3"
      },
      {
        "network": "OtherNetwork",
        "network_card": "vmxnet3"
      }
    ],

In HCL2:

    network_adapters {
        network = "VM Network"
        network_card = "vmxnet3"
    }
    network_adapters {
        network = "OtherNetwork"
        network_card = "vmxnet3"
    }

• network_card (string) - Specifies the virtual machine network card type. For example vmxnet3.

• remove_network_adapter (bool) - Remove all network adapters from template. Defaults to false.

Optional

• network (string) - Specifies the network to which the virtual machine will connect.

  For example:

  • Name: <NetworkName>
  • Inventory Path: /<DatacenterName>/<FolderName>/<NetworkName>
  • Managed Object ID (Port Group): Network:network-<xxxxx>
  • Managed Object ID (Distributed Port Group): DistributedVirtualPortgroup::dvportgroup-<xxxxx>
  • Logical Switch UUID: <uuid>
  • Segment ID: /infra/segments/<SegmentID>

  Note: If more than one network resolves to the same name, either the inventory path to network or an ID must be provided.

  Note: If no network is specified, provide host to allow the plugin to search for an available network.

• mac_address (string) - Specifies the network card MAC address. For example 00:50:56:00:00:00.

• passthrough (*bool) - Specifies whether to enable DirectPath I/O passthrough for the network device.

Storage Configuration

Defines the disk storage for a VM.

Example that will create a 15GB and a 20GB disk on the VM. The second disk will be thin provisioned:

In JSON:

    "storage": [
      {
        "disk_size": 15000
      },
      {
        "disk_size": 20000,
        "disk_thin_provisioned": true
      }
    ],

In HCL2:

    storage {
        disk_size = 15000
    }
    storage {
        disk_size = 20000
        disk_thin_provisioned = true
    }

Example that creates 2 pvscsi controllers and adds 2 disks to each one:

In JSON:

    "disk_controller_type": ["pvscsi", "pvscsi"],
    "storage": [
      {
        "disk_size": 15000,
        "disk_controller_index": 0
      },
      {
        "disk_size": 15000,
        "disk_controller_index": 0
      },
      {
        "disk_size": 15000,
        "disk_controller_index": 1
      },
      {
        "disk_size": 15000,
        "disk_controller_index": 1
      }
    ],

In HCL2:

    disk_controller_type = ["pvscsi", "pvscsi"]
    storage {
       disk_size = 15000,
       disk_controller_index = 0
    }
    storage {
       disk_size = 15000
       disk_controller_index = 0
    }
    storage {
       disk_size = 15000
       disk_controller_index = 1
    }
    storage {
       disk_size = 15000
       disk_controller_index = 1
    }

• disk_size (int64) - The size of the disk in MiB.

Optional

• disk_thin_provisioned (bool) - Enable VMDK thin provisioning for VM. Defaults to false.

• disk_eagerly_scrub (bool) - Enable VMDK eager scrubbing for VM. Defaults to false.

• disk_controller_index (int) - The assigned disk controller. Defaults to the first one (0).

Export Configuration

You can export an image in Open Virtualization Format (OVF) to the Packer host.

Example usage:

In JSON:

...

    "vm_name": "example-ubuntu",

...

    "export": {
      "force": true,
      "output_directory": "./output-artifacts"
    },

In HCL2:

    # ...
    vm_name = "example-ubuntu"
    # ...
    export {
      force = true
      output_directory = "./output-artifacts"
    }

The above configuration would create the following files:

./output-artifacts/example-ubuntu-disk-0.vmdk
./output-artifacts/example-ubuntu.mf
./output-artifacts/example-ubuntu.ovf

Optional:

• name (string) - Name of the exported image in Open Virtualization Format (OVF). The name of the virtual machine with the .ovf extension is used if this option is not specified.

• force (bool) - Forces the export to overwrite existing files. Defaults to false. If set to false, an error is returned if the file(s) already exists.

• image_files (bool) - Include additional image files that are that are associated with the virtual machine. Defaults to false. For example, .nvram and .log files.

• manifest (string) - Generate a manifest file with the specified hash algorithm. Defaults to sha256. Available options include none, sha1, sha256, and sha512. Use none for no manifest.

• options ([]string) - Advanced image export options. Available options can include:

  • mac - MAC address is exported for each Ethernet device.
  • uuid - UUID is exported for the virtual machine.
  • extraconfig - Extra configuration options are exported for the virtual machine.
  • nodevicesubtypes - Resource subtypes for CD/DVD drives, floppy drives, and serial and parallel ports are not exported.

  For example, adding the following export config option outputs the MAC addresses for each Ethernet device in the OVF descriptor:

  In JSON:

  ...
    "export": {
      "options": ["mac"]
    },
  

  Copy

  In HCL2:

  ...
    export {
      options = ["mac"]
    }
  

  Copy

• output_format (string) - The output format for the exported virtual machine image. Defaults to ovf. Available options include ovf and ova.

  When set to ova, the image is first exported using Open Virtualization / Format (.ovf) and then converted to an Open Virtualization Archive (.ova) using the VMware Open Virtualization Format Tool (ovftool). The intermediate files are removed after the conversion.

  Note: To use the ova format option, VMware ovftool must be installed on the Packer host and accessible in either the system PATH or the user's PATH.

Output Configuration:

• output_directory (string) - This setting specifies the directory that artifacts from the build, such as the virtual machine files and disks, will be output to. The path to the directory may be relative or absolute. If relative, the path is relative to the working directory packer is executed from. This directory must not exist or, if created, must be empty prior to running the builder. By default this is "output-BUILDNAME" where "BUILDNAME" is the name of the build.

• directory_permission (os.FileMode) - The permissions to apply to the "output_directory", and to any parent directories that get created for output_directory. By default this is "0750". You should express the permission as quoted string with a leading zero such as "0755" in JSON file, because JSON does not support octal value. In Unix-like OS, the actual permission may differ from this value because of umask.

Content Library Import Configuration

With this configuration Packer creates a library item in a content library whose content is a VM template or an OVF template created from the just built VM. The template is stored in a existing or newly created library item.

• library (string) - Name of the library in which the new library item containing the template should be created/updated. The Content Library should be of type Local to allow deploying virtual machines.

• name (string) - Name of the library item that will be created or updated. For VM templates, the name of the item should be different from vm_name and the default is vm_name + timestamp when not set. VM templates will be always imported to a new library item. For OVF templates, the name defaults to vm_name when not set, and if an item with the same name already exists it will be then updated with the new OVF template, otherwise a new item will be created.

  Note: It's not possible to update existing library items with a new VM template. If updating an existing library item is necessary, use an OVF template instead by setting the ovf option as true.

• description (string) - Description of the library item that will be created. Defaults to "Packer imported vm_name VM template".

• cluster (string) - Cluster onto which the virtual machine template should be placed. If cluster and resource_pool are both specified, resource_pool must belong to cluster. If cluster and host are both specified, host must be a member of cluster. This option is not used when importing OVF templates. Defaults to cluster.

• folder (string) - Virtual machine folder into which the virtual machine template should be placed. This option is not used when importing OVF templates. Defaults to the same folder as the source virtual machine.

• host (string) - Host onto which the virtual machine template should be placed. If host and resource_pool are both specified, resource_pool must belong to host. If host and cluster are both specified, host must be a member of cluster. This option is not used when importing OVF templates. Defaults to host.

• resource_pool (string) - Resource pool into which the virtual machine template should be placed. Defaults to resource_pool. if resource_pool is also unset, the system will attempt to choose a suitable resource pool for the virtual machine template.

• datastore (string) - The datastore for the virtual machine template's configuration and log files. This option is not used when importing OVF templates. Defaults to the storage backing associated with the library specified by library.

• destroy (bool) - If set to true, the VM will be destroyed after deploying the template to the Content Library. Defaults to false.

• ovf (bool) - When set to true, Packer will import and OVF template to the content library item. Defaults to false.

• skip_import (bool) - When set to true, the VM won't be imported to the content library item. Useful for setting to true during a build test stage. Defaults to false.

• ovf_flags ([]string) - Flags to use for OVF package creation. The supported flags can be obtained using ExportFlag.list. If unset, no flags will be used. Known values: EXTRA_CONFIG, PRESERVE_MAC

Minimal example of usage to import a VM template:

JSON

    "content_library_destination" : {
        "library": "Packer Library Test"
    }

HCL2

    content_library_destination {
            library = "Packer Library Test"
    }

Minimal example of usage to import a OVF template:

JSON

    "content_library_destination" : {
        "library": "Packer Library Test",
        "ovf": true
    }

HCL2

    content_library_destination {
            library = "Packer Library Test"
            ovf = true
    }

Extra Configuration Parameters

• configuration_parameters (map[string]string) - configuration_parameters is a direct passthrough to the vSphere API's VirtualMachineConfigSpec

• tools_sync_time (bool) - Enables time synchronization with the host. Defaults to false.

• tools_upgrade_policy (bool) - If sets to true, vSphere will automatically check and upgrade VMware Tools upon a system power cycle. If not set, defaults to manual upgrade.

Communicator configuration

Optional common fields:

• communicator (string) - Packer currently supports three kinds of communicators:

  • none - No communicator will be used. If this is set, most provisioners also can't be used.

  • ssh - An SSH connection will be established to the machine. This is usually the default.

  • winrm - A WinRM connection will be established.

  In addition to the above, some builders have custom communicators they can use. For example, the Docker builder has a "docker" communicator that uses docker exec and docker cp to execute scripts and copy files.

• pause_before_connecting (duration string | ex: "1h5m2s") - We recommend that you enable SSH or WinRM as the very last step in your guest's bootstrap script, but sometimes you may have a race condition where you need Packer to wait before attempting to connect to your guest.

  If you end up in this situation, you can use the template option pause_before_connecting. By default, there is no pause. For example if you set pause_before_connecting to 10m Packer will check whether it can connect, as normal. But once a connection attempt is successful, it will disconnect and then wait 10 minutes before connecting to the guest and beginning provisioning.

Optional SSH fields:

• ssh_host (string) - The address to SSH to. This usually is automatically configured by the builder.

• ssh_port (int) - The port to connect to SSH. This defaults to 22.

• ssh_username (string) - The username to connect to SSH with. Required if using SSH.

• ssh_password (string) - A plaintext password to use to authenticate with SSH.

• ssh_ciphers ([]string) - This overrides the value of ciphers supported by default by Golang. The default value is [ "aes128-gcm@openssh.com", "chacha20-poly1305@openssh.com", "aes128-ctr", "aes192-ctr", "aes256-ctr", ]

  Valid options for ciphers include: "aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-gcm@openssh.com", "chacha20-poly1305@openssh.com", "arcfour256", "arcfour128", "arcfour", "aes128-cbc", "3des-cbc",

• ssh_clear_authorized_keys (bool) - If true, Packer will attempt to remove its temporary key from ~/.ssh/authorized_keys and /root/.ssh/authorized_keys. This is a mostly cosmetic option, since Packer will delete the temporary private key from the host system regardless of whether this is set to true (unless the user has set the -debug flag). Defaults to "false"; currently only works on guests with sed installed.

• ssh_key_exchange_algorithms ([]string) - If set, Packer will override the value of key exchange (kex) algorithms supported by default by Golang. Acceptable values include: "curve25519-sha256@libssh.org", "ecdh-sha2-nistp256", "ecdh-sha2-nistp384", "ecdh-sha2-nistp521", "diffie-hellman-group14-sha1", and "diffie-hellman-group1-sha1".

• ssh_certificate_file (string) - Path to user certificate used to authenticate with SSH. The ~ can be used in path and will be expanded to the home directory of current user.

• ssh_pty (bool) - If true, a PTY will be requested for the SSH connection. This defaults to false.

• ssh_timeout (duration string | ex: "1h5m2s") - The time to wait for SSH to become available. Packer uses this to determine when the machine has booted so this is usually quite long. Example value: 10m. This defaults to 5m, unless ssh_handshake_attempts is set.

• ssh_disable_agent_forwarding (bool) - If true, SSH agent forwarding will be disabled. Defaults to false.

• ssh_handshake_attempts (int) - The number of handshakes to attempt with SSH once it can connect. This defaults to 10, unless a ssh_timeout is set.

• ssh_bastion_host (string) - A bastion host to use for the actual SSH connection.

• ssh_bastion_port (int) - The port of the bastion host. Defaults to 22.

• ssh_bastion_agent_auth (bool) - If true, the local SSH agent will be used to authenticate with the bastion host. Defaults to false.

• ssh_bastion_username (string) - The username to connect to the bastion host.

• ssh_bastion_password (string) - The password to use to authenticate with the bastion host.

• ssh_bastion_interactive (bool) - If true, the keyboard-interactive used to authenticate with bastion host.

• ssh_bastion_private_key_file (string) - Path to a PEM encoded private key file to use to authenticate with the bastion host. The ~ can be used in path and will be expanded to the home directory of current user.

• ssh_bastion_certificate_file (string) - Path to user certificate used to authenticate with bastion host. The ~ can be used in path and will be expanded to the home directory of current user.

• ssh_file_transfer_method (string) - scp or sftp - How to transfer files, Secure copy (default) or SSH File Transfer Protocol.

  NOTE: Guests using Windows with Win32-OpenSSH v9.1.0.0p1-Beta, scp (the default protocol for copying data) returns a a non-zero error code since the MOTW cannot be set, which cause any file transfer to fail. As a workaround you can override the transfer protocol with SFTP instead ssh_file_transfer_protocol = "sftp".

• ssh_proxy_host (string) - A SOCKS proxy host to use for SSH connection

• ssh_proxy_port (int) - A port of the SOCKS proxy. Defaults to 1080.

• ssh_proxy_username (string) - The optional username to authenticate with the proxy server.

• ssh_proxy_password (string) - The optional password to use to authenticate with the proxy server.

• ssh_keep_alive_interval (duration string | ex: "1h5m2s") - How often to send "keep alive" messages to the server. Set to a negative value (-1s) to disable. Example value: 10s. Defaults to 5s.

• ssh_read_write_timeout (duration string | ex: "1h5m2s") - The amount of time to wait for a remote command to end. This might be useful if, for example, packer hangs on a connection after a reboot. Example: 5m. Disabled by default.

• ssh_remote_tunnels ([]string) -

• ssh_local_tunnels ([]string) -

• ssh_private_key_file (string) - Path to a PEM encoded private key file to use to authenticate with SSH. The ~ can be used in path and will be expanded to the home directory of current user.

Optional WinRM fields:

• winrm_username (string) - The username to use to connect to WinRM.

• winrm_password (string) - The password to use to connect to WinRM.

• winrm_host (string) - The address for WinRM to connect to.

  NOTE: If using an Amazon EBS builder, you can specify the interface WinRM connects to via ssh_interface

• winrm_no_proxy (bool) - Setting this to true adds the remote host:port to the NO_PROXY environment variable. This has the effect of bypassing any configured proxies when connecting to the remote host. Default to false.

• winrm_port (int) - The WinRM port to connect to. This defaults to 5985 for plain unencrypted connection and 5986 for SSL when winrm_use_ssl is set to true.

• winrm_timeout (duration string | ex: "1h5m2s") - The amount of time to wait for WinRM to become available. This defaults to 30m since setting up a Windows machine generally takes a long time.

• winrm_use_ssl (bool) - If true, use HTTPS for WinRM.

• winrm_insecure (bool) - If true, do not check server certificate chain and host name.

• winrm_use_ntlm (bool) - If true, NTLMv2 authentication (with session security) will be used for WinRM, rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. Further reading for remote connection authentication can be found here.

Working With Clusters And Hosts

Standalone Hosts

Only use the host option. Optionally specify a resource_pool:

JSON

"host": "esxi-01.example.com",
"resource_pool": "pool1",

HCL2

host = ""esxi-01.example.com""
resource_pool = "pool1"

Clusters Without DRS

Use the cluster and hostparameters:

JSON

"cluster": "cluster1",
"host": "esxi-02.example.com",

HCL2

cluster = "cluster1"
host = "esxi-02.example.com"

Clusters With DRS

Only use the cluster option. Optionally specify a resource_pool:

JSON

"cluster": "cluster2",
"resource_pool": "pool1",

HCL2

cluster = "cluster2"
resource_pool = "pool1"

Required vSphere Privileges

It is recommended to create a custom vSphere role with the required privileges to integrate Packer with vSphere. Accounts or groups can be added to the role to ensure that Packer has the least privileged access to the infrastructure. For example, a named service account (e.g. svc-packer-vsphere@example.com).

Clone the default Read-Only vSphere role and add the following privileges, which are based on the capabilities of the vsphere-iso plugin:

Global permissions are required for the content library based on the hierarchical inheritance of permissions. Once the custom vSphere role is created, assign Global Permissions in vSphere to the accounts or groups used for the Packer to vSphere integration, if using the content library.

For example:

1. Log in to the vCenter Server at https://<management_vcenter_server_fqdn>/ui as administrator@vsphere.local.
2. Select Menu > Administration.
3. In the left pane, select Access control > Global permissions and click the Add permissions icon.
4. In the Add permissions dialog box, enter the service account (e.g. svc-packer-vsphere@example.com), select the custom role (e.g. Packer to vSphere Integration Role) and the Propagate to children check box, and click OK.

In an environment with many vCenter Server instances, such as management and workload, in enhanced linked-mode, you may wish to further reduce the scope of access across the vSphere infrastructure. For example, if you do not want Packer to have access to the management vCenter Server instance, but only allow access to workload vCenter Server instances:

1. From the Hosts and clusters inventory, select management vCenter Server to restrict scope, and click the Permissions tab.
2. Select the service account with the custom role assigned and click the Change role icon.
3. In the Change role dialog box, from the Role drop-down menu, select No Access, select the Propagate to children check box, and click OK.