1. Packages
  2. Vcd Provider
  3. API Docs
  4. getVm
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.getVm

Start a Neo task
Explain and create a vcd.getVm resource
vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Using getVm

    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.

    function getVm(args: GetVmArgs, opts?: InvokeOptions): Promise<GetVmResult>
function getVmOutput(args: GetVmOutputArgs, opts?: InvokeOptions): Output<GetVmResult>
    def get_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) -> GetVmResult
def get_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[GetVmResult]
    func LookupVm(ctx *Context, args *LookupVmArgs, opts ...InvokeOption) (*LookupVmResult, error)
func LookupVmOutput(ctx *Context, args *LookupVmOutputArgs, opts ...InvokeOption) LookupVmResultOutput

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

    public static class GetVm 
{
    public static Task<GetVmResult> InvokeAsync(GetVmArgs args, InvokeOptions? opts = null)
    public static Output<GetVmResult> Invoke(GetVmInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
public static Output<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string
    A name or ID for the standalone VM in VDC
    Id string
    NetworkDhcpWaitSeconds double
    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
    SizingPolicyId string
    VappName string
    Vdc string
    The name of VDC to use, optional if defined at provider level
    Name string
    A name or ID for the standalone VM in VDC
    Id string
    NetworkDhcpWaitSeconds float64
    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
    SizingPolicyId string
    VappName string
    Vdc string
    The name of VDC to use, optional if defined at provider level
    name String
    A name or ID for the standalone VM in VDC
    id String
    networkDhcpWaitSeconds Double
    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
    sizingPolicyId String
    vappName String
    vdc String
    The name of VDC to use, optional if defined at provider level
    name string
    A name or ID for the standalone VM in VDC
    id string
    networkDhcpWaitSeconds number
    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
    sizingPolicyId string
    vappName string
    vdc string
    The name of VDC to use, optional if defined at provider level
    name str
    A name or ID for the standalone VM in VDC
    id str
    network_dhcp_wait_seconds float
    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
    sizing_policy_id str
    vapp_name str
    vdc str
    The name of VDC to use, optional if defined at provider level
    name String
    A name or ID for the standalone VM in VDC
    id String
    networkDhcpWaitSeconds Number
    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
    sizingPolicyId String
    vappName String
    vdc String
    The name of VDC to use, optional if defined at provider level

    getVm Result

    The following output properties are available:

    BootOptions List<GetVmBootOption>
    ComputerName string
    CpuCores double
    CpuHotAddEnabled bool
    CpuLimit double
    CpuPriority string
    CpuReservation double
    CpuShares double
    Cpus double
    Customizations List<GetVmCustomization>
    Description string
    Disks List<GetVmDisk>
    ExposeHardwareVirtualization bool
    ExtraConfigs List<GetVmExtraConfig>
    Firmware string
    GuestProperties Dictionary<string, string>
    HardwareVersion string
    Href string
    Id string
    InheritedMetadata Dictionary<string, string>
    InternalDisks List<GetVmInternalDisk>
    Memory double
    MemoryHotAddEnabled bool
    MemoryLimit double
    MemoryPriority string
    MemoryReservation double
    MemoryShares double
    Metadata Dictionary<string, string>

    Deprecated: Deprecated

    MetadataEntries List<GetVmMetadataEntry>
    Name string
    Networks List<GetVmNetwork>
    OsType string
    PlacementPolicyId string
    SecurityTags List<string>
    SizingPolicyId string
    Status double
    StatusText string
    StorageProfile string
    VappId string
    VappName string
    VmType string
    NetworkDhcpWaitSeconds double
    Org string
    Vdc string
    BootOptions []GetVmBootOption
    ComputerName string
    CpuCores float64
    CpuHotAddEnabled bool
    CpuLimit float64
    CpuPriority string
    CpuReservation float64
    CpuShares float64
    Cpus float64
    Customizations []GetVmCustomization
    Description string
    Disks []GetVmDisk
    ExposeHardwareVirtualization bool
    ExtraConfigs []GetVmExtraConfig
    Firmware string
    GuestProperties map[string]string
    HardwareVersion string
    Href string
    Id string
    InheritedMetadata map[string]string
    InternalDisks []GetVmInternalDiskType
    Memory float64
    MemoryHotAddEnabled bool
    MemoryLimit float64
    MemoryPriority string
    MemoryReservation float64
    MemoryShares float64
    Metadata map[string]string

    Deprecated: Deprecated

    MetadataEntries []GetVmMetadataEntry
    Name string
    Networks []GetVmNetwork
    OsType string
    PlacementPolicyId string
    SecurityTags []string
    SizingPolicyId string
    Status float64
    StatusText string
    StorageProfile string
    VappId string
    VappName string
    VmType string
    NetworkDhcpWaitSeconds float64
    Org string
    Vdc string
    bootOptions List<GetVmBootOption>
    computerName String
    cpuCores Double
    cpuHotAddEnabled Boolean
    cpuLimit Double
    cpuPriority String
    cpuReservation Double
    cpuShares Double
    cpus Double
    customizations List<GetVmCustomization>
    description String
    disks List<GetVmDisk>
    exposeHardwareVirtualization Boolean
    extraConfigs List<GetVmExtraConfig>
    firmware String
    guestProperties Map<String,String>
    hardwareVersion String
    href String
    id String
    inheritedMetadata Map<String,String>
    internalDisks List<GetVmInternalDisk>
    memory Double
    memoryHotAddEnabled Boolean
    memoryLimit Double
    memoryPriority String
    memoryReservation Double
    memoryShares Double
    metadata Map<String,String>

    Deprecated: Deprecated

    metadataEntries List<GetVmMetadataEntry>
    name String
    networks List<GetVmNetwork>
    osType String
    placementPolicyId String
    securityTags List<String>
    sizingPolicyId String
    status Double
    statusText String
    storageProfile String
    vappId String
    vappName String
    vmType String
    networkDhcpWaitSeconds Double
    org String
    vdc String
    bootOptions GetVmBootOption[]
    computerName string
    cpuCores number
    cpuHotAddEnabled boolean
    cpuLimit number
    cpuPriority string
    cpuReservation number
    cpuShares number
    cpus number
    customizations GetVmCustomization[]
    description string
    disks GetVmDisk[]
    exposeHardwareVirtualization boolean
    extraConfigs GetVmExtraConfig[]
    firmware string
    guestProperties {[key: string]: string}
    hardwareVersion string
    href string
    id string
    inheritedMetadata {[key: string]: string}
    internalDisks GetVmInternalDisk[]
    memory number
    memoryHotAddEnabled boolean
    memoryLimit number
    memoryPriority string
    memoryReservation number
    memoryShares number
    metadata {[key: string]: string}

    Deprecated: Deprecated

    metadataEntries GetVmMetadataEntry[]
    name string
    networks GetVmNetwork[]
    osType string
    placementPolicyId string
    securityTags string[]
    sizingPolicyId string
    status number
    statusText string
    storageProfile string
    vappId string
    vappName string
    vmType string
    networkDhcpWaitSeconds number
    org string
    vdc string
    boot_options Sequence[GetVmBootOption]
    computer_name str
    cpu_cores float
    cpu_hot_add_enabled bool
    cpu_limit float
    cpu_priority str
    cpu_reservation float
    cpu_shares float
    cpus float
    customizations Sequence[GetVmCustomization]
    description str
    disks Sequence[GetVmDisk]
    expose_hardware_virtualization bool
    extra_configs Sequence[GetVmExtraConfig]
    firmware str
    guest_properties Mapping[str, str]
    hardware_version str
    href str
    id str
    inherited_metadata Mapping[str, str]
    internal_disks Sequence[GetVmInternalDisk]
    memory float
    memory_hot_add_enabled bool
    memory_limit float
    memory_priority str
    memory_reservation float
    memory_shares float
    metadata Mapping[str, str]

    Deprecated: Deprecated

    metadata_entries Sequence[GetVmMetadataEntry]
    name str
    networks Sequence[GetVmNetwork]
    os_type str
    placement_policy_id str
    security_tags Sequence[str]
    sizing_policy_id str
    status float
    status_text str
    storage_profile str
    vapp_id str
    vapp_name str
    vm_type str
    network_dhcp_wait_seconds float
    org str
    vdc str
    bootOptions List<Property Map>
    computerName String
    cpuCores Number
    cpuHotAddEnabled Boolean
    cpuLimit Number
    cpuPriority String
    cpuReservation Number
    cpuShares Number
    cpus Number
    customizations List<Property Map>
    description String
    disks List<Property Map>
    exposeHardwareVirtualization Boolean
    extraConfigs List<Property Map>
    firmware String
    guestProperties Map<String>
    hardwareVersion String
    href String
    id String
    inheritedMetadata Map<String>
    internalDisks List<Property Map>
    memory Number
    memoryHotAddEnabled Boolean
    memoryLimit Number
    memoryPriority String
    memoryReservation Number
    memoryShares Number
    metadata Map<String>

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    name String
    networks List<Property Map>
    osType String
    placementPolicyId String
    securityTags List<String>
    sizingPolicyId String
    status Number
    statusText String
    storageProfile String
    vappId String
    vappName String
    vmType String
    networkDhcpWaitSeconds Number
    org String
    vdc String

    Supporting Types

    GetVmBootOption

    GetVmCustomization

    GetVmDisk

    BusNumber string
    Name string
    A name or ID for the standalone VM in VDC
    SizeInMb double
    UnitNumber string
    BusNumber string
    Name string
    A name or ID for the standalone VM in VDC
    SizeInMb float64
    UnitNumber string
    busNumber String
    name String
    A name or ID for the standalone VM in VDC
    sizeInMb Double
    unitNumber String
    busNumber string
    name string
    A name or ID for the standalone VM in VDC
    sizeInMb number
    unitNumber string
    bus_number str
    name str
    A name or ID for the standalone VM in VDC
    size_in_mb float
    unit_number str
    busNumber String
    name String
    A name or ID for the standalone VM in VDC
    sizeInMb Number
    unitNumber String

    GetVmExtraConfig

    Key string
    Required bool
    Value string
    Key string
    Required bool
    Value string
    key String
    required Boolean
    value String
    key string
    required boolean
    value string
    key str
    required bool
    value str
    key String
    required Boolean
    value String

    GetVmInternalDisk

    BusNumber double
    BusType string
    DiskId string
    Iops double
    SizeInMb double
    StorageProfile string
    ThinProvisioned bool
    UnitNumber double
    BusNumber float64
    BusType string
    DiskId string
    Iops float64
    SizeInMb float64
    StorageProfile string
    ThinProvisioned bool
    UnitNumber float64
    busNumber Double
    busType String
    diskId String
    iops Double
    sizeInMb Double
    storageProfile String
    thinProvisioned Boolean
    unitNumber Double
    busNumber number
    busType string
    diskId string
    iops number
    sizeInMb number
    storageProfile string
    thinProvisioned boolean
    unitNumber number
    busNumber Number
    busType String
    diskId String
    iops Number
    sizeInMb Number
    storageProfile String
    thinProvisioned Boolean
    unitNumber Number

    GetVmMetadataEntry

    IsSystem bool
    Key string
    Type string
    UserAccess string
    Value string
    IsSystem bool
    Key string
    Type string
    UserAccess string
    Value string
    isSystem Boolean
    key String
    type String
    userAccess String
    value String
    isSystem boolean
    key string
    type string
    userAccess string
    value string
    isSystem Boolean
    key String
    type String
    userAccess String
    value String

    GetVmNetwork

    AdapterType string
    Connected bool
    Ip string
    IpAllocationMode string
    IsPrimary bool
    Mac string
    Name string
    A name or ID for the standalone VM in VDC
    SecondaryIp string
    SecondaryIpAllocationMode string
    Type string
    AdapterType string
    Connected bool
    Ip string
    IpAllocationMode string
    IsPrimary bool
    Mac string
    Name string
    A name or ID for the standalone VM in VDC
    SecondaryIp string
    SecondaryIpAllocationMode string
    Type string
    adapterType String
    connected Boolean
    ip String
    ipAllocationMode String
    isPrimary Boolean
    mac String
    name String
    A name or ID for the standalone VM in VDC
    secondaryIp String
    secondaryIpAllocationMode String
    type String
    adapterType string
    connected boolean
    ip string
    ipAllocationMode string
    isPrimary boolean
    mac string
    name string
    A name or ID for the standalone VM in VDC
    secondaryIp string
    secondaryIpAllocationMode string
    type string
    adapter_type str
    connected bool
    ip str
    ip_allocation_mode str
    is_primary bool
    mac str
    name str
    A name or ID for the standalone VM in VDC
    secondary_ip str
    secondary_ip_allocation_mode str
    type str
    adapterType String
    connected Boolean
    ip String
    ipAllocationMode String
    isPrimary Boolean
    mac String
    name String
    A name or ID for the standalone VM in VDC
    secondaryIp String
    secondaryIpAllocationMode String
    type String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd
      Meet Neo: Your AI Platform Teammate