Skip to content

Build Variables

David Dieruf edited this page Feb 27, 2020 · 8 revisions

(Bolded example values are the defaults)

REQUIRED VALUES

Variable Name Value Required Example Values
vcenter-host The DNS or IP address to vcenter server. Do not include http(s):// Yes myvcenter.domain.com
vcenter-username User to interact with vcenter server. Needs the permission to create/config/remove VMs. Yes (string)
vcenter-password Password for vcenter user. Yes (string)
vcenter-datacenter Vsphere datacenter name, for placing VMs and data. Do not include a slash(/). Yes (alphanumeric, underscore, dash)
vm-folder The vsphere datacenter VM folder to hold base and clone VMs. Yes Stemcell
vm-datastore The vsphere datastore to hold VM disks. Yes (alphanumeric, underscore, dash)
vm-host The vsphere host name or IP to create VMs on. Yes
esxi-version Version of esxi the vm-host is using. Yes 6.5, 6.0, ...
iso-path-in-datastore The Windows ISO file path in iso-datastore. Yes Win-Stemcell-ISO/windows2019.iso
operating-system-name Used during the Windows installaton. Most ISOs hold different flavors of an OS and during install you specify which is desired. See the docs for more detail. Yes Windows Server 2019 SERVERSTANDARDCORE
ip-address The network address assigned to the VM. Note that both the base and the clone(s) use the same IP, as they should never need to be powered on at the same time. The address needs to be routable to wherevere the tasks are run from (local desktop, concourse worker, etc). Yes 10.0.0.5
subnet-mask The subnet mask of the IP address of the VM. Yes 255.255.255.0
gateway-address The address of the gateway network service. Yes (IP, DNS name)
dns-address The address of the DNS network service. Yes (IP, DNS name)
admin-password The Windows administrator password of the base VM. Stembuild will scramble the cloned VM password. Yes (alphanumeric)

OPTIONAL VALUES

Variable Name Value Required Example Values
base-vm-name The name of the initial Windows VM created, used as a clone for stembuild. No Win-Stemcell-Base
vm-resource-pool The vsphere resource pool where VMs are created. No
vm-network The vsphere network name to associate with VMs No VM Network
vm-cpu Number of CPUs to give new VMs. Provide number only. No 4
vm-disk-gb Size of disk (in gb) to give new VMs. Provide number only. No 100
vm-memory-mb Amount of memory (in mb) to give new VMs. Provide number only No 8000
vm-guest-os-id Vsphere VM operating system identifier. See the docs for more detail. No windows9Server64Guest
vm-net-adapter Type of network adaptor to attach to VMs. No e1000e
firmware-type Firmware type for the VMs attached disk. No bios, efi, ...
disk-controller-type Type of controller for the attached disk. No lsilogic-sas, IDE, BusLogic, ...
iso-datastore The vcenter datastore name where the formatted ISO will be uploaded. !!Note the VMs need to have access to this datastore, from their vm-datastore to retrieve the ISO. Yes (alphanumeric, underscore, dash)
product-key The Windows product key. No (alphanumeric)
language The default language, locale, and other international settings to use during Windows Setup. See the docs for more detail. No en-US
vmware-tools-uri The exe to install VMWare tools. This is required by stembuild as well as a VSphere best practice. See the FTP to manually download. No Current tested version 10.3.10
windows-update-module-uri The powershell module used to run window update and control reboots. See the technet script center listing for more detail. No PSWindowsUpdate.zip
vmware-tools-status How strict will vmware tools compatability be enforced. The default value of "current" means your chosen version of vmware tools must be up to date with its ESXi host. Alternatly a value of "supported" means the tools can be an older but still supported version. Here is a version mapping. No current, supported
windows-install-timeout Timeout the windows installation. If there's a bad value or something odd happens this process can run forever. This is a floating point number with an optional suffix: 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days. A duration of 0 disables the timeout. No 10m
timeout Throughout the tasks, VM's are powered on, rebooted, and powered off. These actions can sometimes run forever. This timeout also applies to windows updates that install during bootup, thats why the default is 1 minute. This is a floating point number with an optional suffix: 's' for seconds (the default), 'm' for minutes, 'h' for hours or 'd' for days. A duration of 0 disables the timeout. No 1m
vcenter-ca-certs Communicating with vCenter over a secure connection is required. The certificate to do so, is available for download from the vcenter-host. Override the certificate that is retrieved from vcenter with this var. Follow this vmware doc to retrieve the Base64 string. No (string)
Clone this wiki locally