Documentation ¶
Overview ¶
Code generated by "mapstructure-to-hcl2 -type Config"; DO NOT EDIT.
Index ¶
Constants ¶
View Source
const DefaultAdditionalDiskTemplate = `` /* 151-byte string literal not displayed */
View Source
const DefaultVMXTemplate = `` /* 3413-byte string literal not displayed */
This is the default VMX template used if no other template is given. This is hardcoded here. If you wish to use a custom template please do so by specifying in the builder configuration.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func (*Builder) ConfigSpec ¶ added in v1.5.0
func (b *Builder) ConfigSpec() hcldec.ObjectSpec
type Config ¶ added in v0.8.0
type Config struct { common.PackerConfig `mapstructure:",squash"` common.HTTPConfig `mapstructure:",squash"` common.ISOConfig `mapstructure:",squash"` common.FloppyConfig `mapstructure:",squash"` bootcommand.VNCConfig `mapstructure:",squash"` vmwcommon.DriverConfig `mapstructure:",squash"` vmwcommon.HWConfig `mapstructure:",squash"` vmwcommon.OutputConfig `mapstructure:",squash"` vmwcommon.RunConfig `mapstructure:",squash"` shutdowncommand.ShutdownConfig `mapstructure:",squash"` vmwcommon.SSHConfig `mapstructure:",squash"` vmwcommon.ToolsConfig `mapstructure:",squash"` vmwcommon.VMXConfig `mapstructure:",squash"` vmwcommon.ExportConfig `mapstructure:",squash"` // The size(s) of any additional // hard disks for the VM in megabytes. If this is not specified then the VM // will only contain a primary hard disk. The builder uses expandable, not // fixed-size virtual hard disks, so the actual file representing the disk will // not use the full size unless it is full. AdditionalDiskSize []uint `mapstructure:"disk_additional_size" required:"false"` // The adapter type of the VMware virtual disk to create. This option is // for advanced usage, modify only if you know what you're doing. Some of // the options you can specify are `ide`, `sata`, `nvme` or `scsi` (which // uses the "lsilogic" scsi interface by default). If you specify another // option, Packer will assume that you're specifying a `scsi` interface of // that specified type. For more information, please consult [Virtual Disk // Manager User's Guide](http://www.vmware.com/pdf/VirtualDiskManager.pdf) // for desktop VMware clients. For ESXi, refer to the proper ESXi // documentation. DiskAdapterType string `mapstructure:"disk_adapter_type" required:"false"` // The filename of the virtual disk that'll be created, // without the extension. This defaults to packer. DiskName string `mapstructure:"vmdk_name" required:"false"` // The size of the hard disk for the VM in megabytes. // The builder uses expandable, not fixed-size virtual hard disks, so the // actual file representing the disk will not use the full size unless it // is full. By default this is set to 40000 (about 40 GB). DiskSize uint `mapstructure:"disk_size" required:"false"` // The type of VMware virtual disk to create. This // option is for advanced usage. // // For desktop VMware clients: // // Type ID | Description // ------- | --- // `0` | Growable virtual disk contained in a single file (monolithic sparse). // `1` | Growable virtual disk split into 2GB files (split sparse). // `2` | Preallocated virtual disk contained in a single file (monolithic flat). // `3` | Preallocated virtual disk split into 2GB files (split flat). // `4` | Preallocated virtual disk compatible with ESX server (VMFS flat). // `5` | Compressed disk optimized for streaming. // // The default is `1`. // // For ESXi, this defaults to `zeroedthick`. The available options for ESXi // are: `zeroedthick`, `eagerzeroedthick`, `thin`. `rdm:dev`, `rdmp:dev`, // `2gbsparse` are not supported. Due to default disk compaction, when using // `zeroedthick` or `eagerzeroedthick` set `skip_compaction` to `true`. // // For more information, please consult the [Virtual Disk Manager User's // Guide](https://www.vmware.com/pdf/VirtualDiskManager.pdf) for desktop // VMware clients. For ESXi, refer to the proper ESXi documentation. DiskTypeId string `mapstructure:"disk_type_id" required:"false"` // The adapter type (or bus) that will be used // by the cdrom device. This is chosen by default based on the disk adapter // type. VMware tends to lean towards ide for the cdrom device unless // sata is chosen for the disk adapter and so Packer attempts to mirror // this logic. This field can be specified as either ide, sata, or scsi. CdromAdapterType string `mapstructure:"cdrom_adapter_type" required:"false"` // The guest OS type being installed. This will be // set in the VMware VMX. By default this is other. By specifying a more // specific OS type, VMware may perform some optimizations or virtual hardware // changes to better support the operating system running in the // virtual machine. GuestOSType string `mapstructure:"guest_os_type" required:"false"` // The [vmx hardware // version](http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=1003746) // for the new virtual machine. Only the default value has been tested, any // other value is experimental. Default value is `9`. Version string `mapstructure:"version" required:"false"` // This is the name of the VMX file for the new virtual // machine, without the file extension. By default this is packer-BUILDNAME, // where "BUILDNAME" is the name of the build. VMName string `mapstructure:"vm_name" required:"false"` VMXDiskTemplatePath string `mapstructure:"vmx_disk_template_path"` // Path to a [configuration template](/docs/templates/engine.html) that // defines the contents of the virtual machine VMX file for VMware. This is // for **advanced users only** as this can render the virtual machine // non-functional. See below for more information. For basic VMX // modifications, try `vmx_data` first. VMXTemplatePath string `mapstructure:"vmx_template_path" required:"false"` // contains filtered or unexported fields }
func (*Config) FlatMapstructure ¶ added in v1.4.5
FlatMapstructure returns a new FlatConfig. FlatConfig is an auto-generated flat version of Config. Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.
type FlatConfig ¶ added in v1.4.5
type FlatConfig struct { PackerBuildName *string `mapstructure:"packer_build_name" cty:"packer_build_name"` PackerBuilderType *string `mapstructure:"packer_builder_type" cty:"packer_builder_type"` PackerDebug *bool `mapstructure:"packer_debug" cty:"packer_debug"` PackerForce *bool `mapstructure:"packer_force" cty:"packer_force"` PackerOnError *string `mapstructure:"packer_on_error" cty:"packer_on_error"` PackerUserVars map[string]string `mapstructure:"packer_user_variables" cty:"packer_user_variables"` PackerSensitiveVars []string `mapstructure:"packer_sensitive_variables" cty:"packer_sensitive_variables"` HTTPDir *string `mapstructure:"http_directory" cty:"http_directory"` HTTPPortMin *int `mapstructure:"http_port_min" cty:"http_port_min"` HTTPPortMax *int `mapstructure:"http_port_max" cty:"http_port_max"` ISOChecksum *string `mapstructure:"iso_checksum" required:"true" cty:"iso_checksum"` ISOChecksumURL *string `mapstructure:"iso_checksum_url" cty:"iso_checksum_url"` ISOChecksumType *string `mapstructure:"iso_checksum_type" cty:"iso_checksum_type"` RawSingleISOUrl *string `mapstructure:"iso_url" required:"true" cty:"iso_url"` ISOUrls []string `mapstructure:"iso_urls" cty:"iso_urls"` TargetPath *string `mapstructure:"iso_target_path" cty:"iso_target_path"` TargetExtension *string `mapstructure:"iso_target_extension" cty:"iso_target_extension"` FloppyFiles []string `mapstructure:"floppy_files" cty:"floppy_files"` FloppyDirectories []string `mapstructure:"floppy_dirs" cty:"floppy_dirs"` FloppyLabel *string `mapstructure:"floppy_label" cty:"floppy_label"` BootGroupInterval *string `mapstructure:"boot_keygroup_interval" cty:"boot_keygroup_interval"` BootWait *string `mapstructure:"boot_wait" cty:"boot_wait"` BootCommand []string `mapstructure:"boot_command" cty:"boot_command"` DisableVNC *bool `mapstructure:"disable_vnc" cty:"disable_vnc"` BootKeyInterval *string `mapstructure:"boot_key_interval" cty:"boot_key_interval"` FusionAppPath *string `mapstructure:"fusion_app_path" required:"false" cty:"fusion_app_path"` RemoteType *string `mapstructure:"remote_type" required:"false" cty:"remote_type"` RemoteDatastore *string `mapstructure:"remote_datastore" required:"false" cty:"remote_datastore"` RemoteCacheDatastore *string `mapstructure:"remote_cache_datastore" required:"false" cty:"remote_cache_datastore"` RemoteCacheDirectory *string `mapstructure:"remote_cache_directory" required:"false" cty:"remote_cache_directory"` RemoteHost *string `mapstructure:"remote_host" required:"false" cty:"remote_host"` RemotePort *int `mapstructure:"remote_port" required:"false" cty:"remote_port"` RemoteUser *string `mapstructure:"remote_username" required:"false" cty:"remote_username"` RemotePassword *string `mapstructure:"remote_password" required:"false" cty:"remote_password"` RemotePrivateKey *string `mapstructure:"remote_private_key_file" required:"false" cty:"remote_private_key_file"` SkipValidateCredentials *bool `mapstructure:"skip_validate_credentials" required:"false" cty:"skip_validate_credentials"` CpuCount *int `mapstructure:"cpus" required:"false" cty:"cpus"` MemorySize *int `mapstructure:"memory" required:"false" cty:"memory"` CoreCount *int `mapstructure:"cores" required:"false" cty:"cores"` Network *string `mapstructure:"network" required:"false" cty:"network"` NetworkAdapterType *string `mapstructure:"network_adapter_type" required:"false" cty:"network_adapter_type"` Sound *bool `mapstructure:"sound" required:"false" cty:"sound"` USB *bool `mapstructure:"usb" required:"false" cty:"usb"` Serial *string `mapstructure:"serial" required:"false" cty:"serial"` Parallel *string `mapstructure:"parallel" required:"false" cty:"parallel"` OutputDir *string `mapstructure:"output_directory" required:"false" cty:"output_directory"` Headless *bool `mapstructure:"headless" required:"false" cty:"headless"` VNCBindAddress *string `mapstructure:"vnc_bind_address" required:"false" cty:"vnc_bind_address"` VNCPortMin *int `mapstructure:"vnc_port_min" required:"false" cty:"vnc_port_min"` VNCPortMax *int `mapstructure:"vnc_port_max" cty:"vnc_port_max"` VNCDisablePassword *bool `mapstructure:"vnc_disable_password" required:"false" cty:"vnc_disable_password"` ShutdownCommand *string `mapstructure:"shutdown_command" required:"false" cty:"shutdown_command"` ShutdownTimeout *string `mapstructure:"shutdown_timeout" required:"false" cty:"shutdown_timeout"` Type *string `mapstructure:"communicator" cty:"communicator"` PauseBeforeConnect *string `mapstructure:"pause_before_connecting" cty:"pause_before_connecting"` SSHHost *string `mapstructure:"ssh_host" cty:"ssh_host"` SSHPort *int `mapstructure:"ssh_port" cty:"ssh_port"` SSHUsername *string `mapstructure:"ssh_username" cty:"ssh_username"` SSHPassword *string `mapstructure:"ssh_password" cty:"ssh_password"` SSHKeyPairName *string `mapstructure:"ssh_keypair_name" cty:"ssh_keypair_name"` SSHTemporaryKeyPairName *string `mapstructure:"temporary_key_pair_name" cty:"temporary_key_pair_name"` SSHClearAuthorizedKeys *bool `mapstructure:"ssh_clear_authorized_keys" cty:"ssh_clear_authorized_keys"` SSHPrivateKeyFile *string `mapstructure:"ssh_private_key_file" cty:"ssh_private_key_file"` SSHPty *bool `mapstructure:"ssh_pty" cty:"ssh_pty"` SSHTimeout *string `mapstructure:"ssh_timeout" cty:"ssh_timeout"` SSHAgentAuth *bool `mapstructure:"ssh_agent_auth" cty:"ssh_agent_auth"` SSHDisableAgentForwarding *bool `mapstructure:"ssh_disable_agent_forwarding" cty:"ssh_disable_agent_forwarding"` SSHHandshakeAttempts *int `mapstructure:"ssh_handshake_attempts" cty:"ssh_handshake_attempts"` SSHBastionHost *string `mapstructure:"ssh_bastion_host" cty:"ssh_bastion_host"` SSHBastionPort *int `mapstructure:"ssh_bastion_port" cty:"ssh_bastion_port"` SSHBastionAgentAuth *bool `mapstructure:"ssh_bastion_agent_auth" cty:"ssh_bastion_agent_auth"` SSHBastionUsername *string `mapstructure:"ssh_bastion_username" cty:"ssh_bastion_username"` SSHBastionPassword *string `mapstructure:"ssh_bastion_password" cty:"ssh_bastion_password"` SSHBastionPrivateKeyFile *string `mapstructure:"ssh_bastion_private_key_file" cty:"ssh_bastion_private_key_file"` SSHFileTransferMethod *string `mapstructure:"ssh_file_transfer_method" cty:"ssh_file_transfer_method"` SSHProxyHost *string `mapstructure:"ssh_proxy_host" cty:"ssh_proxy_host"` SSHProxyPort *int `mapstructure:"ssh_proxy_port" cty:"ssh_proxy_port"` SSHProxyUsername *string `mapstructure:"ssh_proxy_username" cty:"ssh_proxy_username"` SSHProxyPassword *string `mapstructure:"ssh_proxy_password" cty:"ssh_proxy_password"` SSHKeepAliveInterval *string `mapstructure:"ssh_keep_alive_interval" cty:"ssh_keep_alive_interval"` SSHReadWriteTimeout *string `mapstructure:"ssh_read_write_timeout" cty:"ssh_read_write_timeout"` SSHRemoteTunnels []string `mapstructure:"ssh_remote_tunnels" cty:"ssh_remote_tunnels"` SSHLocalTunnels []string `mapstructure:"ssh_local_tunnels" cty:"ssh_local_tunnels"` SSHPublicKey []byte `mapstructure:"ssh_public_key" cty:"ssh_public_key"` SSHPrivateKey []byte `mapstructure:"ssh_private_key" cty:"ssh_private_key"` WinRMUser *string `mapstructure:"winrm_username" cty:"winrm_username"` WinRMPassword *string `mapstructure:"winrm_password" cty:"winrm_password"` WinRMHost *string `mapstructure:"winrm_host" cty:"winrm_host"` WinRMPort *int `mapstructure:"winrm_port" cty:"winrm_port"` WinRMTimeout *string `mapstructure:"winrm_timeout" cty:"winrm_timeout"` WinRMUseSSL *bool `mapstructure:"winrm_use_ssl" cty:"winrm_use_ssl"` WinRMInsecure *bool `mapstructure:"winrm_insecure" cty:"winrm_insecure"` WinRMUseNTLM *bool `mapstructure:"winrm_use_ntlm" cty:"winrm_use_ntlm"` SSHSkipRequestPty *bool `mapstructure:"ssh_skip_request_pty" cty:"ssh_skip_request_pty"` ToolsUploadFlavor *string `mapstructure:"tools_upload_flavor" required:"false" cty:"tools_upload_flavor"` ToolsUploadPath *string `mapstructure:"tools_upload_path" required:"false" cty:"tools_upload_path"` VMXData map[string]string `mapstructure:"vmx_data" required:"false" cty:"vmx_data"` VMXDataPost map[string]string `mapstructure:"vmx_data_post" required:"false" cty:"vmx_data_post"` VMXRemoveEthernet *bool `mapstructure:"vmx_remove_ethernet_interfaces" required:"false" cty:"vmx_remove_ethernet_interfaces"` VMXDisplayName *string `mapstructure:"display_name" required:"false" cty:"display_name"` Format *string `mapstructure:"format" required:"false" cty:"format"` OVFToolOptions []string `mapstructure:"ovftool_options" required:"false" cty:"ovftool_options"` SkipExport *bool `mapstructure:"skip_export" required:"false" cty:"skip_export"` KeepRegistered *bool `mapstructure:"keep_registered" required:"false" cty:"keep_registered"` SkipCompaction *bool `mapstructure:"skip_compaction" required:"false" cty:"skip_compaction"` AdditionalDiskSize []uint `mapstructure:"disk_additional_size" required:"false" cty:"disk_additional_size"` DiskAdapterType *string `mapstructure:"disk_adapter_type" required:"false" cty:"disk_adapter_type"` DiskName *string `mapstructure:"vmdk_name" required:"false" cty:"vmdk_name"` DiskSize *uint `mapstructure:"disk_size" required:"false" cty:"disk_size"` DiskTypeId *string `mapstructure:"disk_type_id" required:"false" cty:"disk_type_id"` CdromAdapterType *string `mapstructure:"cdrom_adapter_type" required:"false" cty:"cdrom_adapter_type"` GuestOSType *string `mapstructure:"guest_os_type" required:"false" cty:"guest_os_type"` Version *string `mapstructure:"version" required:"false" cty:"version"` VMName *string `mapstructure:"vm_name" required:"false" cty:"vm_name"` VMXDiskTemplatePath *string `mapstructure:"vmx_disk_template_path" cty:"vmx_disk_template_path"` VMXTemplatePath *string `mapstructure:"vmx_template_path" required:"false" cty:"vmx_template_path"` }
FlatConfig is an auto-generated flat version of Config. Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.
Click to show internal directories.
Click to hide internal directories.