vcd.VappVm

BootOptions VappVmBootOptions

Automatically accept EULA if OVA has it. Default is true

BootImage string

Use boot_image_id instead. Media name to mount as boot image. Image is mounted only during VM creation. On update if value is changed to empty it will eject the mounted media. If you want to mount an image later, please use vcd.InsertedMedia.

Deprecated: Deprecated

BootImageId string

Media URN to mount as boot image. You can fetch it using a vcd.CatalogMedia data source. Image is mounted only during VM creation. On update if value is changed to empty it will eject the mounted media. If you want to mount an image later, please use vcd.InsertedMedia.

A block to define boot options of the VM. See Boot Options

CatalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

ComputerName string

Computer name to assign to this virtual machine.

Performs disk consolidation during creation. The main use case is when one wants to grow template disk size using override_template_disk in fast provisioned VDCs. Note: Consolidating disks requires right vApp: VM Migrate, Force Undeploy, Relocate, Consolidate. This operation may take long time depending on disk size and storage performance.

CopyFromVmId string

The ID of an existing VM to make a copy of it (it cannot be a vApp template). The source VM must be in the same Org (but can be in different VDC). Note: sizing_policy_id must be specified when creating a standalone VM (using vcd.Vm resource) and using different source/destination VDCs.

CpuCores double

The number of cores per socket.

Customization VappVmCustomization

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

CpuLimit double

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

CpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

CpuReservation double

The amount of MHz reservation on the underlying virtualization infrastructure.

CpuShares double

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

Cpus double

The number of virtual CPUs to allocate to the VM. Socket count is a result of: virtual logical processors/cores per socket. If cpu_hot_add_enabled is true, then cpus will be increased without VM power off.

A block to define for guest customization options. See Customization

Description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Disks List<VappVmDisk>

Independent disk attachment configuration. See Disk below for details.

Boolean for exposing full CPU virtualization to the guest operating system so that applications that require hardware virtualization can run on virtual machines without binary translation or paravirtualization. Useful for hypervisor nesting provided underlying hardware supports it. Default is false.

Firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

GuestProperties Dictionary<string, string>

Key value map of guest properties

HardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

Href string

VM Hyper Reference

Memory double

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

MetadataEntries List<VappVmMetadataEntry>

True if the virtual machine supports addition of memory while powered on. Default is false.

MemoryLimit double

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

MemoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

MemoryReservation double

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

MemoryShares double

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

Metadata Dictionary<string, string>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

Name string

A name for the VM, unique within the vApp

NetworkDhcpWaitSeconds double

Optional number of seconds to try and wait for DHCP IP (only valid for adapters in network block with ip_allocation_mode=DHCP). It constantly checks if IP is present so the time given is a maximum. VM must be powered on and at least one of the following must be true:

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

Networks List<VappVmNetwork>

A block to define network interface. Multiple can be used. See Network and example for usage details.

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OsType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

OverrideTemplateDisks List<VappVmOverrideTemplateDisk>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

VM placement policy or [vGPU policy][vgpu-policy] (3.11+) ID. To be used, it needs to be assigned to Org VDC In this case, if the placement policy is not set, it will pick the VDC default on creation. It must be set explicitly if one wants to update it to another policy (the VM requires at least one Compute Policy), and needs to be set to "" to be removed.

PowerOn bool

A boolean value stating if this VM should be powered on. Default is true

SetExtraConfigs List<VappVmSetExtraConfig>

True if the update of resource should fail when virtual machine power off needed. Default is false.

SecurityTags List<string>

Set of security tags to be managed by the vcd.VappVm resource. To remove security_tags you must set security_tags = [] and do not remove the attribute. Removing the attribute will cause the tags to remain unchanged and just stop being managed by this resource. This is to be consistent with existing security tags that were created by the vcd_security_tags resource.

Set of extra configuration key/values to be added or modified. See Extra Configuration

SizingPolicyId string

VM sizing policy ID. To be used, it needs to be assigned to Org VDC using vcd_org_vdc.vm_sizing_policy_ids (and vcd_org_vdc.default_compute_policy_id to make it default). In this case, if the sizing policy is not set, it will pick the VDC default on creation. It must be set explicitly if one wants to update it to another policy (the VM requires at least one Compute Policy), and needs to be set to "" to be removed.

StorageProfile string

Storage profile to override the default one

TemplateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

VappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

VappVmId string

Vdc string

The name of VDC to use, optional if defined at provider level

VmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

VappName string

The vApp this VM belongs to.

BootOptions VappVmBootOptionsArgs

Automatically accept EULA if OVA has it. Default is true

BootImage string

Deprecated: Deprecated

BootImageId string

A block to define boot options of the VM. See Boot Options

CatalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

ComputerName string

Computer name to assign to this virtual machine.

CopyFromVmId string

CpuCores float64

The number of cores per socket.

Customization VappVmCustomizationArgs

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

CpuLimit float64

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

CpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

CpuReservation float64

The amount of MHz reservation on the underlying virtualization infrastructure.

CpuShares float64

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

Cpus float64

A block to define for guest customization options. See Customization

Description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Disks []VappVmDiskArgs

Independent disk attachment configuration. See Disk below for details.

Firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

GuestProperties map[string]string

Key value map of guest properties

HardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

Href string

VM Hyper Reference

Memory float64

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

MetadataEntries []VappVmMetadataEntryArgs

True if the virtual machine supports addition of memory while powered on. Default is false.

MemoryLimit float64

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

MemoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

MemoryReservation float64

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

MemoryShares float64

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

Metadata map[string]string

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

Name string

A name for the VM, unique within the vApp

NetworkDhcpWaitSeconds float64

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

Networks []VappVmNetworkArgs

A block to define network interface. Multiple can be used. See Network and example for usage details.

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OsType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

OverrideTemplateDisks []VappVmOverrideTemplateDiskArgs

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

PowerOn bool

A boolean value stating if this VM should be powered on. Default is true

SetExtraConfigs []VappVmSetExtraConfigArgs

True if the update of resource should fail when virtual machine power off needed. Default is false.

SecurityTags []string

Set of extra configuration key/values to be added or modified. See Extra Configuration

SizingPolicyId string

StorageProfile string

Storage profile to override the default one

TemplateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

VappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

VappVmId string

Vdc string

The name of VDC to use, optional if defined at provider level

VmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vappName String

The vApp this VM belongs to.

acceptAllEulas Boolean

Automatically accept EULA if OVA has it. Default is true

bootImage String

Deprecated: Deprecated

bootImageId String

A block to define boot options of the VM. See Boot Options

catalogName String

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName String

Computer name to assign to this virtual machine.

copyFromVmId String

cpuCores Double

The number of cores per socket.

cpuHotAddEnabled Boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit Double

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation Double

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares Double

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus Double

disks List<VappVmDisk>

A block to define for guest customization options. See Customization

description String

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Independent disk attachment configuration. See Disk below for details.

firmware String

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties Map<String,String>

Key value map of guest properties

hardwareVersion String

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href String

VM Hyper Reference

memory Double

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

metadataEntries List<VappVmMetadataEntry>

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit Double

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation Double

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares Double

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Map<String,String>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

name String

A name for the VM, unique within the vApp

networkDhcpWaitSeconds Double

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks List<VappVmNetwork>

A block to define network interface. Multiple can be used. See Network and example for usage details.

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType String

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks List<VappVmOverrideTemplateDisk>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

powerOn Boolean

A boolean value stating if this VM should be powered on. Default is true

setExtraConfigs List<VappVmSetExtraConfig>

True if the update of resource should fail when virtual machine power off needed. Default is false.

securityTags List<String>

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizingPolicyId String

storageProfile String

Storage profile to override the default one

templateName String

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vappTemplateId String

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vappVmId String

vdc String

The name of VDC to use, optional if defined at provider level

vmNameInTemplate String

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vappName string

The vApp this VM belongs to.

acceptAllEulas boolean

Automatically accept EULA if OVA has it. Default is true

bootImage string

Deprecated: Deprecated

bootImageId string

A block to define boot options of the VM. See Boot Options

catalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName string

Computer name to assign to this virtual machine.

consolidateDisksOnCreate boolean

copyFromVmId string

cpuCores number

The number of cores per socket.

cpuHotAddEnabled boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit number

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation number

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares number

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus number

metadataEntries VappVmMetadataEntry[]

A block to define for guest customization options. See Customization

description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks VappVmDisk[]

Independent disk attachment configuration. See Disk below for details.

exposeHardwareVirtualization boolean

firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties {[key: string]: string}

Key value map of guest properties

hardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href string

VM Hyper Reference

memory number

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

memoryHotAddEnabled boolean

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit number

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation number

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares number

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata {[key: string]: string}

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

name string

A name for the VM, unique within the vApp

networkDhcpWaitSeconds number

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks VappVmNetwork[]

A block to define network interface. Multiple can be used. See Network and example for usage details.

org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks VappVmOverrideTemplateDisk[]

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

placementPolicyId string

powerOn boolean

A boolean value stating if this VM should be powered on. Default is true

preventUpdatePowerOff boolean

True if the update of resource should fail when virtual machine power off needed. Default is false.

securityTags string[]

setExtraConfigs VappVmSetExtraConfig[]

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizingPolicyId string

storageProfile string

Storage profile to override the default one

templateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vappVmId string

vdc string

The name of VDC to use, optional if defined at provider level

vmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vapp_name str

The vApp this VM belongs to.

accept_all_eulas bool

Automatically accept EULA if OVA has it. Default is true

boot_image str

Deprecated: Deprecated

boot_image_id str

boot_options VappVmBootOptionsArgs

A block to define boot options of the VM. See Boot Options

catalog_name str

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computer_name str

Computer name to assign to this virtual machine.

consolidate_disks_on_create bool

copy_from_vm_id str

cpu_cores float

The number of cores per socket.

cpu_hot_add_enabled bool

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpu_limit float

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpu_priority str

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpu_reservation float

The amount of MHz reservation on the underlying virtualization infrastructure.

cpu_shares float

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus float

customization VappVmCustomizationArgs

A block to define for guest customization options. See Customization

description str

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks Sequence[VappVmDiskArgs]

Independent disk attachment configuration. See Disk below for details.

expose_hardware_virtualization bool

firmware str

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guest_properties Mapping[str, str]

Key value map of guest properties

hardware_version str

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href str

VM Hyper Reference

memory float

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

memory_hot_add_enabled bool

True if the virtual machine supports addition of memory while powered on. Default is false.

memory_limit float

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memory_priority str

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memory_reservation float

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memory_shares float

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Mapping[str, str]

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

metadata_entries Sequence[VappVmMetadataEntryArgs]

A set of metadata entries to assign. See Metadata section for details.

name str

A name for the VM, unique within the vApp

network_dhcp_wait_seconds float

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks Sequence[VappVmNetworkArgs]

A block to define network interface. Multiple can be used. See Network and example for usage details.

org str

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

os_type str

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

override_template_disks Sequence[VappVmOverrideTemplateDiskArgs]

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

placement_policy_id str

power_on bool

A boolean value stating if this VM should be powered on. Default is true

prevent_update_power_off bool

True if the update of resource should fail when virtual machine power off needed. Default is false.

security_tags Sequence[str]

set_extra_configs Sequence[VappVmSetExtraConfigArgs]

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizing_policy_id str

storage_profile str

Storage profile to override the default one

template_name str

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vapp_template_id str

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vapp_vm_id str

vdc str

The name of VDC to use, optional if defined at provider level

vm_name_in_template str

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vappName String

The vApp this VM belongs to.

acceptAllEulas Boolean

Automatically accept EULA if OVA has it. Default is true

bootImage String

Deprecated: Deprecated

bootImageId String

bootOptions Property Map

A block to define boot options of the VM. See Boot Options

catalogName String

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName String

Computer name to assign to this virtual machine.

customization Property Map

copyFromVmId String

cpuCores Number

The number of cores per socket.

cpuHotAddEnabled Boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit Number

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation Number

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares Number

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus Number

A block to define for guest customization options. See Customization

description String

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks List<Property Map>

Independent disk attachment configuration. See Disk below for details.

firmware String

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties Map<String>

Key value map of guest properties

hardwareVersion String

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href String

VM Hyper Reference

memory Number

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

metadataEntries List<Property Map>

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit Number

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation Number

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares Number

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Map<String>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

name String

A name for the VM, unique within the vApp

networkDhcpWaitSeconds Number

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks List<Property Map>

A block to define network interface. Multiple can be used. See Network and example for usage details.

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType String

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks List<Property Map>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

powerOn Boolean

A boolean value stating if this VM should be powered on. Default is true

setExtraConfigs List<Property Map>

True if the update of resource should fail when virtual machine power off needed. Default is false.

securityTags List<String>

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizingPolicyId String

storageProfile String

Storage profile to override the default one

templateName String

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vappTemplateId String

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vappVmId String

vdc String

The name of VDC to use, optional if defined at provider level

vmNameInTemplate String

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

Outputs

All input properties are implicitly available as output properties. Additionally, the VappVm resource produces the following output properties:

ExtraConfigs List<VappVmExtraConfig>: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
Id string: The provider-assigned unique ID for this managed resource.
Imported bool: (v3.13.+) A true/false value telling whether the resource was imported.
InheritedMetadata Dictionary<string, string>: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
InternalDisks List<VappVmInternalDisk>: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
Status double: (v3.8+) The vApp status as a numeric code.
StatusText string: (v3.8+) The vApp status as text.
VappId string: ID of parent vApp
VmType string: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

ExtraConfigs []VappVmExtraConfig: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
Id string: The provider-assigned unique ID for this managed resource.
Imported bool: (v3.13.+) A true/false value telling whether the resource was imported.
InheritedMetadata map[string]string: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
InternalDisks []VappVmInternalDisk: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
Status float64: (v3.8+) The vApp status as a numeric code.
StatusText string: (v3.8+) The vApp status as text.
VappId string: ID of parent vApp
VmType string: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

extraConfigs List<VappVmExtraConfig>: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
id String: The provider-assigned unique ID for this managed resource.
imported Boolean: (v3.13.+) A true/false value telling whether the resource was imported.
inheritedMetadata Map<String,String>: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
internalDisks List<VappVmInternalDisk>: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
status Double: (v3.8+) The vApp status as a numeric code.
statusText String: (v3.8+) The vApp status as text.
vappId String: ID of parent vApp
vmType String: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

extraConfigs VappVmExtraConfig[]: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
id string: The provider-assigned unique ID for this managed resource.
imported boolean: (v3.13.+) A true/false value telling whether the resource was imported.
inheritedMetadata {[key: string]: string}: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
internalDisks VappVmInternalDisk[]: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
status number: (v3.8+) The vApp status as a numeric code.
statusText string: (v3.8+) The vApp status as text.
vappId string: ID of parent vApp
vmType string: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

extra_configs Sequence[VappVmExtraConfig]: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
id str: The provider-assigned unique ID for this managed resource.
imported bool: (v3.13.+) A true/false value telling whether the resource was imported.
inherited_metadata Mapping[str, str]: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
internal_disks Sequence[VappVmInternalDisk]: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
status float: (v3.8+) The vApp status as a numeric code.
status_text str: (v3.8+) The vApp status as text.
vapp_id str: ID of parent vApp
vm_type str: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

extraConfigs List<Property Map>: (v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.
id String: The provider-assigned unique ID for this managed resource.
imported Boolean: (v3.13.+) A true/false value telling whether the resource was imported.
inheritedMetadata Map<String>: (v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).
internalDisks List<Property Map>: (v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.
status Number: (v3.8+) The vApp status as a numeric code.
statusText String: (v3.8+) The vApp status as text.
vappId String: ID of parent vApp
vmType String: (3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

Look up Existing VappVm Resource

Get an existing VappVm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: VappVmState, opts?: CustomResourceOptions): VappVm

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accept_all_eulas: Optional[bool] = None,
        boot_image: Optional[str] = None,
        boot_image_id: Optional[str] = None,
        boot_options: Optional[VappVmBootOptionsArgs] = None,
        catalog_name: Optional[str] = None,
        computer_name: Optional[str] = None,
        consolidate_disks_on_create: Optional[bool] = None,
        copy_from_vm_id: Optional[str] = None,
        cpu_cores: Optional[float] = None,
        cpu_hot_add_enabled: Optional[bool] = None,
        cpu_limit: Optional[float] = None,
        cpu_priority: Optional[str] = None,
        cpu_reservation: Optional[float] = None,
        cpu_shares: Optional[float] = None,
        cpus: Optional[float] = None,
        customization: Optional[VappVmCustomizationArgs] = None,
        description: Optional[str] = None,
        disks: Optional[Sequence[VappVmDiskArgs]] = None,
        expose_hardware_virtualization: Optional[bool] = None,
        extra_configs: Optional[Sequence[VappVmExtraConfigArgs]] = None,
        firmware: Optional[str] = None,
        guest_properties: Optional[Mapping[str, str]] = None,
        hardware_version: Optional[str] = None,
        href: Optional[str] = None,
        imported: Optional[bool] = None,
        inherited_metadata: Optional[Mapping[str, str]] = None,
        internal_disks: Optional[Sequence[VappVmInternalDiskArgs]] = None,
        memory: Optional[float] = None,
        memory_hot_add_enabled: Optional[bool] = None,
        memory_limit: Optional[float] = None,
        memory_priority: Optional[str] = None,
        memory_reservation: Optional[float] = None,
        memory_shares: Optional[float] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[VappVmMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        network_dhcp_wait_seconds: Optional[float] = None,
        networks: Optional[Sequence[VappVmNetworkArgs]] = None,
        org: Optional[str] = None,
        os_type: Optional[str] = None,
        override_template_disks: Optional[Sequence[VappVmOverrideTemplateDiskArgs]] = None,
        placement_policy_id: Optional[str] = None,
        power_on: Optional[bool] = None,
        prevent_update_power_off: Optional[bool] = None,
        security_tags: Optional[Sequence[str]] = None,
        set_extra_configs: Optional[Sequence[VappVmSetExtraConfigArgs]] = None,
        sizing_policy_id: Optional[str] = None,
        status: Optional[float] = None,
        status_text: Optional[str] = None,
        storage_profile: Optional[str] = None,
        template_name: Optional[str] = None,
        vapp_id: Optional[str] = None,
        vapp_name: Optional[str] = None,
        vapp_template_id: Optional[str] = None,
        vapp_vm_id: Optional[str] = None,
        vdc: Optional[str] = None,
        vm_name_in_template: Optional[str] = None,
        vm_type: Optional[str] = None) -> VappVm

func GetVappVm(ctx *Context, name string, id IDInput, state *VappVmState, opts ...ResourceOption) (*VappVm, error)

public static VappVm Get(string name, Input<string> id, VappVmState? state, CustomResourceOptions? opts = null)

public static VappVm get(String name, Output<String> id, VappVmState state, CustomResourceOptions options)

resources:  _:    type: vcd:VappVm    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BootOptions VappVmBootOptions

Automatically accept EULA if OVA has it. Default is true

BootImage string

Deprecated: Deprecated

BootImageId string

A block to define boot options of the VM. See Boot Options

CatalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

ComputerName string

Computer name to assign to this virtual machine.

CopyFromVmId string

CpuCores double

The number of cores per socket.

Customization VappVmCustomization

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

CpuLimit double

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

CpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

CpuReservation double

The amount of MHz reservation on the underlying virtualization infrastructure.

CpuShares double

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

Cpus double

A block to define for guest customization options. See Customization

Description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Disks List<VappVmDisk>

Independent disk attachment configuration. See Disk below for details.

ExtraConfigs List<VappVmExtraConfig>

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

Firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

GuestProperties Dictionary<string, string>

Key value map of guest properties

HardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

Href string

VM Hyper Reference

Imported bool

(v3.13.+) A true/false value telling whether the resource was imported.

InheritedMetadata Dictionary<string, string>

(v3.11+; VCD 10.5.1+) A map that contains read-only metadata that is automatically added by VCD (10.5.1+) and provides details on the origin of the VM (e.g. vm.origin.id, vm.origin.name, vm.origin.type).

InternalDisks List<VappVmInternalDisk>

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

Memory double

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

MetadataEntries List<VappVmMetadataEntry>

True if the virtual machine supports addition of memory while powered on. Default is false.

MemoryLimit double

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

MemoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

MemoryReservation double

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

MemoryShares double

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

Metadata Dictionary<string, string>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

Name string

A name for the VM, unique within the vApp

NetworkDhcpWaitSeconds double

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

Networks List<VappVmNetwork>

A block to define network interface. Multiple can be used. See Network and example for usage details.

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OsType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

OverrideTemplateDisks List<VappVmOverrideTemplateDisk>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

PowerOn bool

A boolean value stating if this VM should be powered on. Default is true

SetExtraConfigs List<VappVmSetExtraConfig>

True if the update of resource should fail when virtual machine power off needed. Default is false.

SecurityTags List<string>

Set of extra configuration key/values to be added or modified. See Extra Configuration

SizingPolicyId string

Status double

(v3.8+) The vApp status as a numeric code.

StatusText string

(v3.8+) The vApp status as text.

StorageProfile string

Storage profile to override the default one

TemplateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

VappId string

ID of parent vApp

VappName string

The vApp this VM belongs to.

VappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

VappVmId string

Vdc string

The name of VDC to use, optional if defined at provider level

VmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

VmType string

(3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

BootOptions VappVmBootOptionsArgs

Automatically accept EULA if OVA has it. Default is true

BootImage string

Deprecated: Deprecated

BootImageId string

A block to define boot options of the VM. See Boot Options

CatalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

ComputerName string

Computer name to assign to this virtual machine.

CopyFromVmId string

CpuCores float64

The number of cores per socket.

Customization VappVmCustomizationArgs

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

CpuLimit float64

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

CpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

CpuReservation float64

The amount of MHz reservation on the underlying virtualization infrastructure.

CpuShares float64

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

Cpus float64

A block to define for guest customization options. See Customization

Description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Disks []VappVmDiskArgs

Independent disk attachment configuration. See Disk below for details.

ExtraConfigs []VappVmExtraConfigArgs

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

Firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

GuestProperties map[string]string

Key value map of guest properties

HardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

Href string

VM Hyper Reference

Imported bool

(v3.13.+) A true/false value telling whether the resource was imported.

InheritedMetadata map[string]string

InternalDisks []VappVmInternalDiskArgs

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

Memory float64

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

MetadataEntries []VappVmMetadataEntryArgs

True if the virtual machine supports addition of memory while powered on. Default is false.

MemoryLimit float64

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

MemoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

MemoryReservation float64

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

MemoryShares float64

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

Metadata map[string]string

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

Name string

A name for the VM, unique within the vApp

NetworkDhcpWaitSeconds float64

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

Networks []VappVmNetworkArgs

A block to define network interface. Multiple can be used. See Network and example for usage details.

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OsType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

OverrideTemplateDisks []VappVmOverrideTemplateDiskArgs

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

PowerOn bool

A boolean value stating if this VM should be powered on. Default is true

SetExtraConfigs []VappVmSetExtraConfigArgs

True if the update of resource should fail when virtual machine power off needed. Default is false.

SecurityTags []string

Set of extra configuration key/values to be added or modified. See Extra Configuration

SizingPolicyId string

Status float64

(v3.8+) The vApp status as a numeric code.

StatusText string

(v3.8+) The vApp status as text.

StorageProfile string

Storage profile to override the default one

TemplateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

VappId string

ID of parent vApp

VappName string

The vApp this VM belongs to.

VappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

VappVmId string

Vdc string

The name of VDC to use, optional if defined at provider level

VmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

VmType string

(3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

acceptAllEulas Boolean

Automatically accept EULA if OVA has it. Default is true

bootImage String

Deprecated: Deprecated

bootImageId String

A block to define boot options of the VM. See Boot Options

catalogName String

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName String

Computer name to assign to this virtual machine.

copyFromVmId String

cpuCores Double

The number of cores per socket.

cpuHotAddEnabled Boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit Double

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation Double

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares Double

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus Double

disks List<VappVmDisk>

A block to define for guest customization options. See Customization

description String

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

Independent disk attachment configuration. See Disk below for details.

extraConfigs List<VappVmExtraConfig>

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

firmware String

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties Map<String,String>

Key value map of guest properties

hardwareVersion String

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href String

VM Hyper Reference

imported Boolean

(v3.13.+) A true/false value telling whether the resource was imported.

inheritedMetadata Map<String,String>

internalDisks List<VappVmInternalDisk>

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

memory Double

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

metadataEntries List<VappVmMetadataEntry>

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit Double

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation Double

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares Double

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Map<String,String>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

name String

A name for the VM, unique within the vApp

networkDhcpWaitSeconds Double

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks List<VappVmNetwork>

A block to define network interface. Multiple can be used. See Network and example for usage details.

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType String

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks List<VappVmOverrideTemplateDisk>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

powerOn Boolean

A boolean value stating if this VM should be powered on. Default is true

setExtraConfigs List<VappVmSetExtraConfig>

True if the update of resource should fail when virtual machine power off needed. Default is false.

securityTags List<String>

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizingPolicyId String

status Double

(v3.8+) The vApp status as a numeric code.

statusText String

(v3.8+) The vApp status as text.

storageProfile String

Storage profile to override the default one

templateName String

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vappId String

ID of parent vApp

vappName String

The vApp this VM belongs to.

vappTemplateId String

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vappVmId String

vdc String

The name of VDC to use, optional if defined at provider level

vmNameInTemplate String

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vmType String

(3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

acceptAllEulas boolean

Automatically accept EULA if OVA has it. Default is true

bootImage string

Deprecated: Deprecated

bootImageId string

A block to define boot options of the VM. See Boot Options

catalogName string

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName string

Computer name to assign to this virtual machine.

consolidateDisksOnCreate boolean

copyFromVmId string

cpuCores number

The number of cores per socket.

cpuHotAddEnabled boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit number

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation number

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares number

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus number

extraConfigs VappVmExtraConfig[]

A block to define for guest customization options. See Customization

description string

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks VappVmDisk[]

Independent disk attachment configuration. See Disk below for details.

exposeHardwareVirtualization boolean

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

firmware string

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties {[key: string]: string}

Key value map of guest properties

hardwareVersion string

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href string

VM Hyper Reference

imported boolean

(v3.13.+) A true/false value telling whether the resource was imported.

inheritedMetadata {[key: string]: string}

internalDisks VappVmInternalDisk[]

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

memory number

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

memoryHotAddEnabled boolean

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit number

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority string

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation number

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares number

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata {[key: string]: string}

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

metadataEntries VappVmMetadataEntry[]

A set of metadata entries to assign. See Metadata section for details.

name string

A name for the VM, unique within the vApp

networkDhcpWaitSeconds number

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks VappVmNetwork[]

A block to define network interface. Multiple can be used. See Network and example for usage details.

org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType string

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks VappVmOverrideTemplateDisk[]

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

placementPolicyId string

powerOn boolean

A boolean value stating if this VM should be powered on. Default is true

preventUpdatePowerOff boolean

True if the update of resource should fail when virtual machine power off needed. Default is false.

securityTags string[]

setExtraConfigs VappVmSetExtraConfig[]

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizingPolicyId string

status number

(v3.8+) The vApp status as a numeric code.

statusText string

(v3.8+) The vApp status as text.

storageProfile string

Storage profile to override the default one

templateName string

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vappId string

ID of parent vApp

vappName string

The vApp this VM belongs to.

vappTemplateId string

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vappVmId string

vdc string

The name of VDC to use, optional if defined at provider level

vmNameInTemplate string

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vmType string

(3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

accept_all_eulas bool

Automatically accept EULA if OVA has it. Default is true

boot_image str

Deprecated: Deprecated

boot_image_id str

boot_options VappVmBootOptionsArgs

A block to define boot options of the VM. See Boot Options

catalog_name str

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computer_name str

Computer name to assign to this virtual machine.

consolidate_disks_on_create bool

copy_from_vm_id str

cpu_cores float

The number of cores per socket.

cpu_hot_add_enabled bool

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpu_limit float

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpu_priority str

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpu_reservation float

The amount of MHz reservation on the underlying virtualization infrastructure.

cpu_shares float

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus float

customization VappVmCustomizationArgs

A block to define for guest customization options. See Customization

description str

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks Sequence[VappVmDiskArgs]

Independent disk attachment configuration. See Disk below for details.

expose_hardware_virtualization bool

extra_configs Sequence[VappVmExtraConfigArgs]

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

firmware str

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guest_properties Mapping[str, str]

Key value map of guest properties

hardware_version str

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href str

VM Hyper Reference

imported bool

(v3.13.+) A true/false value telling whether the resource was imported.

inherited_metadata Mapping[str, str]

internal_disks Sequence[VappVmInternalDiskArgs]

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

memory float

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

memory_hot_add_enabled bool

True if the virtual machine supports addition of memory while powered on. Default is false.

memory_limit float

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memory_priority str

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memory_reservation float

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memory_shares float

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Mapping[str, str]

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

metadata_entries Sequence[VappVmMetadataEntryArgs]

A set of metadata entries to assign. See Metadata section for details.

name str

A name for the VM, unique within the vApp

network_dhcp_wait_seconds float

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks Sequence[VappVmNetworkArgs]

A block to define network interface. Multiple can be used. See Network and example for usage details.

org str

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

os_type str

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

override_template_disks Sequence[VappVmOverrideTemplateDiskArgs]

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

placement_policy_id str

power_on bool

A boolean value stating if this VM should be powered on. Default is true

prevent_update_power_off bool

True if the update of resource should fail when virtual machine power off needed. Default is false.

security_tags Sequence[str]

set_extra_configs Sequence[VappVmSetExtraConfigArgs]

Set of extra configuration key/values to be added or modified. See Extra Configuration

sizing_policy_id str

status float

(v3.8+) The vApp status as a numeric code.

status_text str

(v3.8+) The vApp status as text.

storage_profile str

Storage profile to override the default one

template_name str

Use vapp_template_id instead. The name of the vApp Template to use

Deprecated: Deprecated

vapp_id str

ID of parent vApp

vapp_name str

The vApp this VM belongs to.

vapp_template_id str

The URN of the vApp Template to use. You can fetch it using a vcd.CatalogVappTemplate data source.

vapp_vm_id str

vdc str

The name of VDC to use, optional if defined at provider level

vm_name_in_template str

The name of the VM in vApp Template to use. For cases when vApp template has more than one VM.

vm_type str

(3.2+) Type of the VM (either vcd.VappVm or vcd.Vm).

acceptAllEulas Boolean

Automatically accept EULA if OVA has it. Default is true

bootImage String

Deprecated: Deprecated

bootImageId String

bootOptions Property Map

A block to define boot options of the VM. See Boot Options

catalogName String

Use a vcd.Catalog data source along with vapp_template_id or boot_image_id instead. The catalog name in which to find the given vApp Template or media for boot_image.

Deprecated: Deprecated

computerName String

Computer name to assign to this virtual machine.

customization Property Map

copyFromVmId String

cpuCores Number

The number of cores per socket.

cpuHotAddEnabled Boolean

True if the virtual machine supports addition of virtual CPUs while powered on. Default is false.

cpuLimit Number

The limit (in MHz) for how much of CPU can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

cpuPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

cpuReservation Number

The amount of MHz reservation on the underlying virtualization infrastructure.

cpuShares Number

Custom priority for the resource in MHz. This is a read-only, unless the cpu_priority is "CUSTOM"

cpus Number

A block to define for guest customization options. See Customization

description String

The VM description. Note: for VM from Template description is read only. Currently, this field has the description of the OVA used to create the VM.

disks List<Property Map>

Independent disk attachment configuration. See Disk below for details.

extraConfigs List<Property Map>

(v3.13.+) The VM extra configuration. See Extra Configuration for more detail. Not populated on VCD 10.4.0.

firmware String

Specify boot firmware of the VM. Can be efi or bios. If unset, defaults to bios. Changing the value requires the VM to power off.

guestProperties Map<String>

Key value map of guest properties

hardwareVersion String

Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.). Required when creating empty VM.

href String

VM Hyper Reference

imported Boolean

(v3.13.+) A true/false value telling whether the resource was imported.

inheritedMetadata Map<String>

internalDisks List<Property Map>

(v2.7+) A block providing internal disk of VM details. See Internal Disk below for details.

memory Number

The amount of RAM (in MB) to allocate to the VM. If memory_hot_add_enabled is true, then memory will be increased without VM power off

metadataEntries List<Property Map>

True if the virtual machine supports addition of memory while powered on. Default is false.

memoryLimit Number

The limit (in MB) for how much of memory can be consumed on the underlying virtualization infrastructure. -1 value for unlimited.

memoryPriority String

Pre-determined relative priorities according to which the non-reserved portion of this resource is made available to the virtualized workload

memoryReservation Number

The amount of RAM (in MB) reservation on the underlying virtualization infrastructure

memoryShares Number

Custom priority for the resource in MB. This is a read-only, unless the memory_priority is "CUSTOM"

metadata Map<String>

Use metadata_entry instead. Key value map of metadata to assign to this VM

Deprecated: Deprecated

A set of metadata entries to assign. See Metadata section for details.

name String

A name for the VM, unique within the vApp

networkDhcpWaitSeconds Number

VM has Guest Tools. It waits for IP address to be reported by Guest Tools. This is a slower option, but does not require for the VM to use Edge Gateways DHCP service.
VM DHCP interface is connected to routed Org network and is using Edge Gateways DHCP service (not relayed). It works by querying DHCP leases on Edge Gateway. In general it is quicker than waiting until Guest Tools report IP addresses, but is more constrained. However this is the only option if Guest Tools are not present on the VM.

networks List<Property Map>

A block to define network interface. Multiple can be used. See Network and example for usage details.

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

osType String

Operating System type. Possible values can be found in Os Types. Required when creating empty VM.

overrideTemplateDisks List<Property Map>

Allows to update internal disk in template before first VM boot. Disk is matched by bus_type, bus_number and unit_number. See Override template Disk below for details.

powerOn Boolean

A boolean value stating if this VM should be powered on. Default is true