vcd 3.14.1, Apr 14 25

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getVappVm

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const web = vcd.getVapp({
    name: "web",
});
const web1 = web.then(web => vcd.getVappVm({
    vappName: web.name,
    name: "web1",
}));
export const vmId = data.vcd_vapp_vm.id;
export const vm = web1;

import pulumi
import pulumi_vcd as vcd

web = vcd.get_vapp(name="web")
web1 = vcd.get_vapp_vm(vapp_name=web.name,
    name="web1")
pulumi.export("vmId", data["vcd_vapp_vm"]["id"])
pulumi.export("vm", web1)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		web, err := vcd.LookupVapp(ctx, &vcd.LookupVappArgs{
			Name: "web",
		}, nil)
		if err != nil {
			return err
		}
		web1, err := vcd.LookupVappVm(ctx, &vcd.LookupVappVmArgs{
			VappName: web.Name,
			Name:     "web1",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vmId", data.Vcd_vapp_vm.Id)
		ctx.Export("vm", web1)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var web = Vcd.GetVapp.Invoke(new()
    {
        Name = "web",
    });

    var web1 = Vcd.GetVappVm.Invoke(new()
    {
        VappName = web.Apply(getVappResult => getVappResult.Name),
        Name = "web1",
    });

    return new Dictionary<string, object?>
    {
        ["vmId"] = data.Vcd_vapp_vm.Id,
        ["vm"] = web1,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetVappArgs;
import com.pulumi.vcd.inputs.GetVappVmArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var web = VcdFunctions.getVapp(GetVappArgs.builder()
            .name("web")
            .build());

        final var web1 = VcdFunctions.getVappVm(GetVappVmArgs.builder()
            .vappName(web.applyValue(getVappResult -> getVappResult.name()))
            .name("web1")
            .build());

        ctx.export("vmId", data.vcd_vapp_vm().id());
        ctx.export("vm", web1.applyValue(getVappVmResult -> getVappVmResult));
    }
}

variables:
  web:
    fn::invoke:
      function: vcd:getVapp
      arguments:
        name: web
  web1:
    fn::invoke:
      function: vcd:getVappVm
      arguments:
        vappName: ${web.name}
        name: web1
outputs:
  vmId: ${data.vcd_vapp_vm.id}
  vm: ${web1}

Sample output:

vm = {
  "computer_name" = "TestVM"
  "cpu_cores" = 1
  "cpus" = 2
  "description" = "This OVA provides a minimal installed profile of PhotonOS. Default password for root user is changeme"
  "disk" = []
  "guest_properties" = {}
  "href" = "https://my-vcd.org/api/vApp/vm-ecb449a2-0b11-494d-bbc7-6ae2f2ff9b82"
  "id" = "urn:vcloud:vm:ecb449a2-0b11-494d-bbc7-6ae2f2ff9b82"
  "memory" = 1024
  "metadata" = {
    "vm_metadata" = "VM Metadata."
  }
  "name" = "vm-datacloud"
  "network" = [
    {
      "ip" = "192.168.2.10"
      "ip_allocation_mode" = "MANUAL"
      "is_primary" = true
      "mac" = "00:50:56:29:08:89"
      "name" = "net-datacloud-r"
      "type" = "org"
    },
  ]
  "org" = "datacloud"
  "storage_profile" = "*"
  "vapp_name" = "vapp-datacloud"
  "vdc" = "vdc-datacloud"
}

Metadata

The metadata_entry (v3.8+) is a set of metadata entries that have the following structure:

key - Key of this metadata entry.
value - Value of this metadata entry.
type - Type of this metadata entry. One of: MetadataStringValue, MetadataNumberValue, MetadataDateTimeValue, MetadataBooleanValue.
user_access - User access level for this metadata entry. One of: PRIVATE (hidden), READONLY (read only), READWRITE (read/write).
is_system - Domain for this metadata entry. true if it belongs to SYSTEM, false if it belongs to GENERAL.

Using getVappVm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVappVm(args: GetVappVmArgs, opts?: InvokeOptions): Promise<GetVappVmResult>
function getVappVmOutput(args: GetVappVmOutputArgs, opts?: InvokeOptions): Output<GetVappVmResult>

def get_vapp_vm(id: Optional[str] = None,
                name: Optional[str] = None,
                network_dhcp_wait_seconds: Optional[float] = None,
                org: Optional[str] = None,
                placement_policy_id: Optional[str] = None,
                sizing_policy_id: Optional[str] = None,
                vapp_name: Optional[str] = None,
                vdc: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVappVmResult
def get_vapp_vm_output(id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                network_dhcp_wait_seconds: Optional[pulumi.Input[float]] = None,
                org: Optional[pulumi.Input[str]] = None,
                placement_policy_id: Optional[pulumi.Input[str]] = None,
                sizing_policy_id: Optional[pulumi.Input[str]] = None,
                vapp_name: Optional[pulumi.Input[str]] = None,
                vdc: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVappVmResult]

func LookupVappVm(ctx *Context, args *LookupVappVmArgs, opts ...InvokeOption) (*LookupVappVmResult, error)
func LookupVappVmOutput(ctx *Context, args *LookupVappVmOutputArgs, opts ...InvokeOption) LookupVappVmResultOutput

> Note: This function is named LookupVappVm in the Go SDK.

public static class GetVappVm 
{
    public static Task<GetVappVmResult> InvokeAsync(GetVappVmArgs args, InvokeOptions? opts = null)
    public static Output<GetVappVmResult> Invoke(GetVappVmInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVappVmResult> getVappVm(GetVappVmArgs args, InvokeOptions options)
public static Output<GetVappVmResult> getVappVm(GetVappVmArgs args, InvokeOptions options)

fn::invoke:
  function: vcd:index/getVappVm:getVappVm
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

A name for the VM, unique within the vApp

VappName string

The vApp this VM belongs to.

Id string

NetworkDhcpWaitSeconds double

Allows to wait for up to a defined amount of seconds before IP address is reported for NICs with ip_allocation_mode=DHCP setting. It constantly checks if IP is reported 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 in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

Org string

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

PlacementPolicyId string

(v3.8+) VM placement policy ID.

SizingPolicyId string

(v3.0+, vCD 10.0+) VM sizing policy ID.

Vdc string

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

Name string

A name for the VM, unique within the vApp

VappName string

The vApp this VM belongs to.

Id string

NetworkDhcpWaitSeconds float64

VM has guest tools. It waits for IP address to be reported in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

Org string

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

PlacementPolicyId string

(v3.8+) VM placement policy ID.

SizingPolicyId string

(v3.0+, vCD 10.0+) VM sizing policy ID.

Vdc string

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

name String

A name for the VM, unique within the vApp

vappName String

The vApp this VM belongs to.

id String

networkDhcpWaitSeconds Double

VM has guest tools. It waits for IP address to be reported in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

org String

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

placementPolicyId String

(v3.8+) VM placement policy ID.

sizingPolicyId String

(v3.0+, vCD 10.0+) VM sizing policy ID.

vdc String

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

name string

A name for the VM, unique within the vApp

vappName string

The vApp this VM belongs to.

id string

networkDhcpWaitSeconds number

VM has guest tools. It waits for IP address to be reported in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

org string

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

placementPolicyId string

(v3.8+) VM placement policy ID.

sizingPolicyId string

(v3.0+, vCD 10.0+) VM sizing policy ID.

vdc string

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

name str

A name for the VM, unique within the vApp

vapp_name str

The vApp this VM belongs to.

id str

network_dhcp_wait_seconds float

VM has guest tools. It waits for IP address to be reported in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

org str

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

placement_policy_id str

(v3.8+) VM placement policy ID.

sizing_policy_id str

(v3.0+, vCD 10.0+) VM sizing policy ID.

vdc str

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

name String

A name for the VM, unique within the vApp

vappName String

The vApp this VM belongs to.

id String

networkDhcpWaitSeconds Number

VM has guest tools. It waits for IP address to be reported in vCD UI. 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 UI reports IP addresses, but is more constrained. However this is the only option if guest tools are not present on the VM.

org String

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

placementPolicyId String

(v3.8+) VM placement policy ID.

sizingPolicyId String

(v3.0+, vCD 10.0+) VM sizing policy ID.

vdc String

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

getVappVm Result

The following output properties are available:

BootOptions List<GetVappVmBootOption>
ComputerName string: Computer name to assign to this virtual machine.
CpuCores double: The number of cores per socket
CpuHotAddEnabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
CpuReservation double: The amount of MHz reservation on the underlying virtualization infrastructure
CpuShares double: Custom priority for the resource in MHz
Cpus double: The number of virtual CPUs allocated to the VM
Customizations List<GetVappVmCustomization>
Description string: The VM description. Note: description is read only. Currently, this field has the description of the OVA used to create the VM
Disks List<GetVappVmDisk>: Independent disk attachment configuration.
ExposeHardwareVirtualization bool: Expose hardware-assisted CPU virtualization to guest OS
ExtraConfigs List<GetVappVmExtraConfig>
Firmware string
GuestProperties Dictionary<string, string>: Key value map of guest properties
HardwareVersion string: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
Href string
Id string
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<GetVappVmInternalDisk>: (v2.7+) A block providing internal disk of VM details
Memory double: The amount of RAM (in MB) allocated to the VM
MemoryHotAddEnabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
MemoryReservation double: The amount of RAM (in MB) reservation on the underlying virtualization infrastructure
MemoryShares double: Custom priority for the resource in MB
Metadata Dictionary<string, string>: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
MetadataEntries List<GetVappVmMetadataEntry>: A set of metadata entries assigned to this VM. See Metadata section for details
Name string
Networks List<GetVappVmNetwork>: A block defining a network interface. Multiple can be used.
OsType string: (v2.9+) Operating System type.
PlacementPolicyId string: (v3.8+) VM placement policy ID.
SecurityTags List<string>: (v3.9+) Set of security tags assigned to this VM.
SizingPolicyId string: (v3.0+, vCD 10.0+) VM sizing policy ID.
Status double: (v3.8+) The vApp status as a numeric code.
StatusText string: (v3.8+) The vApp status as text.
StorageProfile string
VappId string
VappName string
VmType string: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
NetworkDhcpWaitSeconds double
Org string
Vdc string

BootOptions []GetVappVmBootOption
ComputerName string: Computer name to assign to this virtual machine.
CpuCores float64: The number of cores per socket
CpuHotAddEnabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
CpuReservation float64: The amount of MHz reservation on the underlying virtualization infrastructure
CpuShares float64: Custom priority for the resource in MHz
Cpus float64: The number of virtual CPUs allocated to the VM
Customizations []GetVappVmCustomization
Description string: The VM description. Note: description is read only. Currently, this field has the description of the OVA used to create the VM
Disks []GetVappVmDisk: Independent disk attachment configuration.
ExposeHardwareVirtualization bool: Expose hardware-assisted CPU virtualization to guest OS
ExtraConfigs []GetVappVmExtraConfig
Firmware string
GuestProperties map[string]string: Key value map of guest properties
HardwareVersion string: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
Href string
Id string
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 []GetVappVmInternalDisk: (v2.7+) A block providing internal disk of VM details
Memory float64: The amount of RAM (in MB) allocated to the VM
MemoryHotAddEnabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
MemoryReservation float64: The amount of RAM (in MB) reservation on the underlying virtualization infrastructure
MemoryShares float64: Custom priority for the resource in MB
Metadata map[string]string: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
MetadataEntries []GetVappVmMetadataEntry: A set of metadata entries assigned to this VM. See Metadata section for details
Name string
Networks []GetVappVmNetwork: A block defining a network interface. Multiple can be used.
OsType string: (v2.9+) Operating System type.
PlacementPolicyId string: (v3.8+) VM placement policy ID.
SecurityTags []string: (v3.9+) Set of security tags assigned to this VM.
SizingPolicyId string: (v3.0+, vCD 10.0+) VM sizing policy ID.
Status float64: (v3.8+) The vApp status as a numeric code.
StatusText string: (v3.8+) The vApp status as text.
StorageProfile string
VappId string
VappName string
VmType string: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
NetworkDhcpWaitSeconds float64
Org string
Vdc string

bootOptions List<GetVappVmBootOption>
computerName String: Computer name to assign to this virtual machine.
cpuCores Double: The number of cores per socket
cpuHotAddEnabled Boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
cpuReservation Double: The amount of MHz reservation on the underlying virtualization infrastructure
cpuShares Double: Custom priority for the resource in MHz
cpus Double: The number of virtual CPUs allocated to the VM
customizations List<GetVappVmCustomization>
description String: The VM description. Note: description is read only. Currently, this field has the description of the OVA used to create the VM
disks List<GetVappVmDisk>: Independent disk attachment configuration.
exposeHardwareVirtualization Boolean: Expose hardware-assisted CPU virtualization to guest OS
extraConfigs List<GetVappVmExtraConfig>
firmware String
guestProperties Map<String,String>: Key value map of guest properties
hardwareVersion String: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
href String
id String
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<GetVappVmInternalDisk>: (v2.7+) A block providing internal disk of VM details
memory Double: The amount of RAM (in MB) allocated to the VM
memoryHotAddEnabled Boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
memoryReservation Double: The amount of RAM (in MB) reservation on the underlying virtualization infrastructure
memoryShares Double: Custom priority for the resource in MB
metadata Map<String,String>: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
metadataEntries List<GetVappVmMetadataEntry>: A set of metadata entries assigned to this VM. See Metadata section for details
name String
networks List<GetVappVmNetwork>: A block defining a network interface. Multiple can be used.
osType String: (v2.9+) Operating System type.
placementPolicyId String: (v3.8+) VM placement policy ID.
securityTags List<String>: (v3.9+) Set of security tags assigned to this VM.
sizingPolicyId String: (v3.0+, vCD 10.0+) VM sizing policy ID.
status Double: (v3.8+) The vApp status as a numeric code.
statusText String: (v3.8+) The vApp status as text.
storageProfile String
vappId String
vappName String
vmType String: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
networkDhcpWaitSeconds Double
org String
vdc String

bootOptions GetVappVmBootOption[]
computerName string: Computer name to assign to this virtual machine.
cpuCores number: The number of cores per socket
cpuHotAddEnabled boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
cpuReservation number: The amount of MHz reservation on the underlying virtualization infrastructure
cpuShares number: Custom priority for the resource in MHz
cpus number: The number of virtual CPUs allocated to the VM
customizations GetVappVmCustomization[]
description string: The VM description. Note: description is read only. Currently, this field has the description of the OVA used to create the VM
disks GetVappVmDisk[]: Independent disk attachment configuration.
exposeHardwareVirtualization boolean: Expose hardware-assisted CPU virtualization to guest OS
extraConfigs GetVappVmExtraConfig[]
firmware string
guestProperties {[key: string]: string}: Key value map of guest properties
hardwareVersion string: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
href string
id string
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 GetVappVmInternalDisk[]: (v2.7+) A block providing internal disk of VM details
memory number: The amount of RAM (in MB) allocated to the VM
memoryHotAddEnabled boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
memoryReservation number: The amount of RAM (in MB) reservation on the underlying virtualization infrastructure
memoryShares number: Custom priority for the resource in MB
metadata {[key: string]: string}: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
metadataEntries GetVappVmMetadataEntry[]: A set of metadata entries assigned to this VM. See Metadata section for details
name string
networks GetVappVmNetwork[]: A block defining a network interface. Multiple can be used.
osType string: (v2.9+) Operating System type.
placementPolicyId string: (v3.8+) VM placement policy ID.
securityTags string[]: (v3.9+) Set of security tags assigned to this VM.
sizingPolicyId string: (v3.0+, vCD 10.0+) VM sizing policy ID.
status number: (v3.8+) The vApp status as a numeric code.
statusText string: (v3.8+) The vApp status as text.
storageProfile string
vappId string
vappName string
vmType string: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
networkDhcpWaitSeconds number
org string
vdc string

boot_options Sequence[GetVappVmBootOption]
computer_name str: Computer name to assign to this virtual machine.
cpu_cores float: The number of cores per socket
cpu_hot_add_enabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
cpu_reservation float: The amount of MHz reservation on the underlying virtualization infrastructure
cpu_shares float: Custom priority for the resource in MHz
cpus float: The number of virtual CPUs allocated to the VM
customizations Sequence[GetVappVmCustomization]
description str: The VM description. Note: description is read only. Currently, this field has the description of the OVA used to create the VM
disks Sequence[GetVappVmDisk]: Independent disk attachment configuration.
expose_hardware_virtualization bool: Expose hardware-assisted CPU virtualization to guest OS
extra_configs Sequence[GetVappVmExtraConfig]
firmware str
guest_properties Mapping[str, str]: Key value map of guest properties
hardware_version str: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
href str
id str
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[GetVappVmInternalDisk]: (v2.7+) A block providing internal disk of VM details
memory float: The amount of RAM (in MB) allocated to the VM
memory_hot_add_enabled bool
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
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
metadata Mapping[str, str]: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
metadata_entries Sequence[GetVappVmMetadataEntry]: A set of metadata entries assigned to this VM. See Metadata section for details
name str
networks Sequence[GetVappVmNetwork]: A block defining a network interface. Multiple can be used.
os_type str: (v2.9+) Operating System type.
placement_policy_id str: (v3.8+) VM placement policy ID.
security_tags Sequence[str]: (v3.9+) Set of security tags assigned to this VM.
sizing_policy_id str: (v3.0+, vCD 10.0+) VM sizing policy ID.
status float: (v3.8+) The vApp status as a numeric code.
status_text str: (v3.8+) The vApp status as text.
storage_profile str
vapp_id str
vapp_name str
vm_type str: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
network_dhcp_wait_seconds float
org str
vdc str

bootOptions List<Property Map>
computerName String: Computer name to assign to this virtual machine.
cpuCores Number: The number of cores per socket
cpuHotAddEnabled Boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
cpuReservation Number: The amount of MHz reservation on the underlying virtualization infrastructure
cpuShares Number: Custom priority for the resource in MHz
cpus Number: The number of virtual CPUs allocated to the VM
customizations List<Property Map>
description String: The VM description. Note: 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.
exposeHardwareVirtualization Boolean: Expose hardware-assisted CPU virtualization to guest OS
extraConfigs List<Property Map>
firmware String
guestProperties Map<String>: Key value map of guest properties
hardwareVersion String: (v2.9+) Virtual Hardware Version (e.g.vmx-14, vmx-13, vmx-12, etc.).
href String
id String
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
memory Number: The amount of RAM (in MB) allocated to the VM
memoryHotAddEnabled Boolean
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. Values can be: LOW, NORMAL, HIGH and CUSTOM
memoryReservation Number: The amount of RAM (in MB) reservation on the underlying virtualization infrastructure
memoryShares Number: Custom priority for the resource in MB
metadata Map<String>: (Deprecated) Use metadata_entry instead. Key value map of metadata assigned to this VM
Deprecated: Deprecated
metadataEntries List<Property Map>: A set of metadata entries assigned to this VM. See Metadata section for details
name String
networks List<Property Map>: A block defining a network interface. Multiple can be used.
osType String: (v2.9+) Operating System type.
placementPolicyId String: (v3.8+) VM placement policy ID.
securityTags List<String>: (v3.9+) Set of security tags assigned to this VM.
sizingPolicyId String: (v3.0+, vCD 10.0+) VM sizing policy ID.
status Number: (v3.8+) The vApp status as a numeric code.
statusText String: (v3.8+) The vApp status as text.
storageProfile String
vappId String
vappName String
vmType String: (3.2+) - type of the VM (either vcd.VappVm or vcd.Vm)
networkDhcpWaitSeconds Number
org String
vdc String