vcd_vapp_vm_media_boot Terraform Module

This Terraform module deploys Virtual Machines into an existing Virtual Application (vApp) within a VMware Cloud Director (VCD) Environment, allowing VMs to boot from an ISO media source. This module can be used to provision new Virtual Machines into Rackspace Technology SDDC Flex VCD Data Center Regions.

Requirements

Name	Version
terraform	~> 1.2
vcd	~> 3.8

This module requires an existing vApp in your Virtual Data Center. You can use the vcd_vapp module to create the vApp for provisioning your VMs.

Resources

Name	Type
vcd_vdc_group	data source
vcd_nsxt_edgegateway	data source
vcd_network_routed_v2	data source
vcd_network_isolated_v2	data source
vcd_vm_sizing_policy	data source
vcd_catalog	data source
vcd_catalog_vapp_template	data source
vcd_catalog_media	data source
vcd_vapp	data source
vcd_inserted_media	resource
vcd_vm_internal_disk	resource
vcd_vapp_org_network	resource
vcd_vapp_vm	resource

Inputs

Name	Description	Type	Default	Required
vdc_org_name	The name of the Data Center Group Organization in VCD	string	"Organization Name Format: <Account_Number>-<Region>-<Account_Name>"	yes
vdc_group_name	The name of the Data Center Group in VCD	string	"Data Center Group Name Format: <Account_Number>-<Region>-<Account_Name> <datacenter group>"	yes
vdc_name	Cloud Director VDC Name	string	"Virtual Data Center Name Format: <Account_Number>-<Region>-<VDC_Name>"	Yes
vcd_edge_name	Name of the Data Center Group Edge Gateway	string	"Edge Gateway Name Format: <Account_Number>-<Region>-<Edge_GW_Identifier>-<edge>"	Yes
vm_sizing_policy_name	Cloud Director VM Sizing Policy Name	string	"gp2.4"	no
vapp_org_networks	List of vApp Org networks with their types	list(object)	[]	yes
is_fenced	Enable fencing for vApp networks	bool	false	no
retain_ip_mac_enabled	Retain IP/MAC across deployments	bool	false	no
reboot_vapp_on_removal	Reboot vApp on network removal	bool	true	no
catalog_org_name	Cloud Director Organization Name for Catalog	string	""	yes
catalog_name	Cloud Director Catalog Name	string	""	yes
boot_catalog_org_name	Organization name for boot catalog	string	""	no
boot_catalog_name	Catalog name for boot media	string	""	no
inserted_media_iso_name	ISO name for inserted boot media	string	""	no
inserted_media_eject_force	Force eject ISO if locked	bool	true	no
boot_iso_image_name	ISO name for boot image	string	""	no
catalog_template_name	Catalog template name for VMs	string	""	yes
vapp_name	Cloud Director vApp Name	string	"Production Application vApp"	yes
vm_name_format	Format for VM names	string	"%s %02d"	no
vm_name	List of VM names	list(string)	[]	yes
computer_name_format	Format for computer names	string	"%s-%02d"	no
computer_name	List of computer names	list(string)	[]	yes
vm_cpu_hot_add_enabled	Enable hot add for CPUs	bool	false	no
vm_memory_hot_add_enabled	Enable hot add for memory	bool	false	no
vm_min_cpu	Minimum CPUs per VM	number	2	no
vm_os_type	OS type for the VM	string	""	no
vm_hw_version	VM hardware version	string	""	no
vm_firmware	VM firmware type (BIOS or UEFI)	string	"bios"	no
vm_boot_delay	Boot delay in milliseconds	number	0	no
vm_boot_retry_enabled	Enable boot retry	bool	false	no
vm_boot_retry_delay	Boot retry delay in milliseconds	number	0	no
vm_efi_secure_boot	Enable EFI secure boot	bool	false	no
vm_enter_bios_setup_on_next_boot	Enter BIOS setup on next boot	bool	false	no
vm_count	Number of VMs to create	number	2	no
vm_metadata_entries	List of metadata entries for the VM	list(object({ key = string, value = string, type = string, user_access = string, is_system = bool }))	[{ key = "Built By", value = "Terraform", type = "MetadataStringValue", user_access = "READWRITE", is_system = false }, { key = "Operating System", value = "Ubuntu Linux (64-Bit)", type = "MetadataStringValue", user_access = "READWRITE", is_system = false }, { key = "Server Role", value = "Web Server", type = "MetadataStringValue", user_access = "READWRITE", is_system = false }]	No
disks_per_vm	Number of disks per VM	number	0	no
vm_disks	List of disks per VM	list(object)	[]	no
internal_disks	List of internal disks for VMs	list(object)	[]	no
vm_internal_disk_allow_vm_reboot	Allow reboot when adding disks	bool	true	no
network_interfaces	Network interfaces for VMs	list(object)	[]	no
vm_ips_index_multiplier	Multiplier for IP assignment	number	1	no
vm_ips	List of IPs for VMs	list(string)	[""]	no
override_template_disks	Override template disks	list(object)	[]	no
vm_customization_enabled	Enable guest customization	bool	true	no
vm_customization_force	Force guest customization	bool	false	no
vm_customization_change_sid	Change SID for Windows VMs	bool	true	no
vm_customization_allow_local_admin_password	Allow local admin password	bool	true	no
vm_customization_must_change_password_on_first_login	Require password change on first login	bool	false	no
vm_customization_auto_generate_password	Auto-generate admin password	bool	true	no
vm_customization_admin_password	Admin password for VMs	string	null	no
vm_customization_number_of_auto_logons	Number of auto logons	number	0	no
vm_customization_join_domain	Join VMs to domain	bool	false	no
vm_customization_initscript	Init script for VMs	string	null	no

NOTE: Each object in the vm_metadata_entries list must have the following attributes:

key: The key for the metadata entry. value: The value for the metadata entry. type: The type of the metadata value. The acceptable values are "MetadataStringValue", "MetadataNumberValue", "MetadataDateTimeValue", "MetadataBooleanValue". user_access: The level of access granted to users for this metadata entry. The acceptable values are "READONLY", "READWRITE". is_system: Specifies whether the metadata is system-generated or not. The acceptable values are true, false.

Outputs

Name	Description
all_vm_info	Array of objects containing information about each VM including name, IP, metadata, and disks.
vm_count	The number of VMs created.

Example Usage

This is an example of a main.tf file that would use the "github.com/global-vmware/vcd_vapp_vm_media_boot" Module Source, which allows VMs to boot from an ISO media source when a Virtual Machine is being deployed into an existing Virtual Application (vApp).

module "vcd_vapp_vm_media_boot" {
  source = "github.com/global-vmware/vcd_vapp_vm_media_boot.git?ref=v1.0.3"

  vdc_org_name                      = "<US1-VDC-ORG-NAME>"
  vdc_group_name                    = "<US1-VDC-GRP-NAME>"
  vdc_name                          = "<US1-VDC-NAME>"
  vdc_edge_name                     = "<US1-VDC-EDGE-NAME>"

  catalog_org_name                  = "<US1-CATALOG-ORG-NAME>"
  catalog_name                      = "<US1-CATALOG-NAME>"
  catalog_template_name             = "<US1-CATALOG-TEMPLATE-NAME>"

  boot_catalog_org_name   = "<US1-BOOT-CATALOG-ORG-NAME>"
  boot_catalog_name       = "<US1-BOOT-CATALOG-NAME>"
  #vm_boot_delay           = 0

  # For scenario with boot_image_id but no inserted media:
  boot_iso_image_name     = "ubuntu-24.04.1-live-server-amd64.iso"  # For boot_image_id
  inserted_media_iso_name = ""  # No inserted media

  # For scenario with both boot_image_id and inserted media:
  #boot_iso_image_name      = "ubuntu-24.04.1-live-server-amd64.iso"  # For boot_image_id
  #inserted_media_iso_name  = "ubuntu-tools.iso"  # For inserted media

  # For scenario with neither: 
  # NOTE: Make sure you add a variable assignment for the catalog_template_name below if you want to create a new VM based off a vApp Template when using this module.
  # Comment out the vm_os_type and vm_hw_version variable assignments below to use the vApp Templates default OS Type and Hardware Versions.
  #boot_iso_image_name      = ""  # No boot_image_id
  #inserted_media_iso_name  = ""  # No inserted media

  catalog_template_name   = ""

  vapp_name               = "Ubuntu 24.04 Server vApp"

  vm_count                = 1

  vm_name                 = ["Ubuntu 24.04 Server VM 01"]
  vm_name_format          = ""

  computer_name           = ["tf-ub24-srv01"]
  computer_name_format    = ""

  vm_os_type              = "ubuntu64Guest"
  vm_min_cpu              = "4"
  vm_sizing_policy_name   = "gp4.8"
  vm_hw_version           = "vmx-19"

  vm_disks = [
  ]

  disks_per_vm = 0

  internal_disks = [
    {
      vm_name         = "Ubuntu 24.04 Server VM 01"
      size_in_mb      = 32768
      bus_number      = 0
      unit_number     = 0
      bus_type        = "paravirtual"
      iops            = 0
      storage_profile = "Standard"
    }
  ]

  vm_metadata_entries               = []

  vapp_org_networks = [
    { name = "US1-Segment-01", type = "routed" }
  ]

  vm_ips_index_multiplier = 1

  vm_ips = [""]
  
  network_interfaces = [
    {
      type               = "org"
      adapter_type       = "VMXNET3"
      name               = "US1-Segment-01"
      ip_allocation_mode = "DHCP"
      ip                 = ""
      is_primary         = true
    }
  ]
}

Authors

This module is maintained by the Global VMware Cloud Automation Services Team.