vSphere v4.10.0, Mar 12 24

vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi

vsphere.getVirtualMachine

Explore with Pulumi AI

vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi

The vsphere.VirtualMachine data source can be used to find the UUID of an existing virtual machine or template. The most common purpose is for finding the UUID of a template to be used as the source for cloning to a new vsphere.VirtualMachine resource. It also reads the guest ID so that can be supplied as well.

Example Usage

In the following example, a virtual machine template is returned by its unique name within the vsphere.Datacenter.

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

const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const template = datacenter.then(datacenter => vsphere.getVirtualMachine({
    name: "ubuntu-server-template",
    datacenterId: datacenter.id,
}));

import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc-01")
template = vsphere.get_virtual_machine(name="ubuntu-server-template",
    datacenter_id=datacenter.id)

package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		datacenter, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
			Name: pulumi.StringRef("dc-01"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vsphere.LookupVirtualMachine(ctx, &vsphere.LookupVirtualMachineArgs{
			Name:         pulumi.StringRef("ubuntu-server-template"),
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var datacenter = VSphere.GetDatacenter.Invoke(new()
    {
        Name = "dc-01",
    });

    var template = VSphere.GetVirtualMachine.Invoke(new()
    {
        Name = "ubuntu-server-template",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetDatacenterArgs;
import com.pulumi.vsphere.inputs.GetVirtualMachineArgs;
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 datacenter = VsphereFunctions.getDatacenter(GetDatacenterArgs.builder()
            .name("dc-01")
            .build());

        final var template = VsphereFunctions.getVirtualMachine(GetVirtualMachineArgs.builder()
            .name("ubuntu-server-template")
            .datacenterId(datacenter.applyValue(getDatacenterResult -> getDatacenterResult.id()))
            .build());

    }
}

variables:
  datacenter:
    fn::invoke:
      Function: vsphere:getDatacenter
      Arguments:
        name: dc-01
  template:
    fn::invoke:
      Function: vsphere:getVirtualMachine
      Arguments:
        name: ubuntu-server-template
        datacenterId: ${datacenter.id}

In the following example, each virtual machine template is returned by its unique full path within the vsphere.Datacenter.

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

const datacenter = vsphere.getDatacenter({
    name: "dc-01",
});
const productionTemplate = datacenter.then(datacenter => vsphere.getVirtualMachine({
    name: "production/templates/ubuntu-server-template",
    datacenterId: datacenter.id,
}));
const developmentTemplate = datacenter.then(datacenter => vsphere.getVirtualMachine({
    name: "development/templates/ubuntu-server-template",
    datacenterId: datacenter.id,
}));

import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc-01")
production_template = vsphere.get_virtual_machine(name="production/templates/ubuntu-server-template",
    datacenter_id=datacenter.id)
development_template = vsphere.get_virtual_machine(name="development/templates/ubuntu-server-template",
    datacenter_id=datacenter.id)

package main

import (
	"github.com/pulumi/pulumi-vsphere/sdk/v4/go/vsphere"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		datacenter, err := vsphere.LookupDatacenter(ctx, &vsphere.LookupDatacenterArgs{
			Name: pulumi.StringRef("dc-01"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vsphere.LookupVirtualMachine(ctx, &vsphere.LookupVirtualMachineArgs{
			Name:         pulumi.StringRef("production/templates/ubuntu-server-template"),
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vsphere.LookupVirtualMachine(ctx, &vsphere.LookupVirtualMachineArgs{
			Name:         pulumi.StringRef("development/templates/ubuntu-server-template"),
			DatacenterId: pulumi.StringRef(datacenter.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var datacenter = VSphere.GetDatacenter.Invoke(new()
    {
        Name = "dc-01",
    });

    var productionTemplate = VSphere.GetVirtualMachine.Invoke(new()
    {
        Name = "production/templates/ubuntu-server-template",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

    var developmentTemplate = VSphere.GetVirtualMachine.Invoke(new()
    {
        Name = "development/templates/ubuntu-server-template",
        DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetDatacenterArgs;
import com.pulumi.vsphere.inputs.GetVirtualMachineArgs;
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 datacenter = VsphereFunctions.getDatacenter(GetDatacenterArgs.builder()
            .name("dc-01")
            .build());

        final var productionTemplate = VsphereFunctions.getVirtualMachine(GetVirtualMachineArgs.builder()
            .name("production/templates/ubuntu-server-template")
            .datacenterId(datacenter.applyValue(getDatacenterResult -> getDatacenterResult.id()))
            .build());

        final var developmentTemplate = VsphereFunctions.getVirtualMachine(GetVirtualMachineArgs.builder()
            .name("development/templates/ubuntu-server-template")
            .datacenterId(datacenter.applyValue(getDatacenterResult -> getDatacenterResult.id()))
            .build());

    }
}

variables:
  datacenter:
    fn::invoke:
      Function: vsphere:getDatacenter
      Arguments:
        name: dc-01
  productionTemplate:
    fn::invoke:
      Function: vsphere:getVirtualMachine
      Arguments:
        name: production/templates/ubuntu-server-template
        datacenterId: ${datacenter.id}
  developmentTemplate:
    fn::invoke:
      Function: vsphere:getVirtualMachine
      Arguments:
        name: development/templates/ubuntu-server-template
        datacenterId: ${datacenter.id}

Using getVirtualMachine

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 getVirtualMachine(args: GetVirtualMachineArgs, opts?: InvokeOptions): Promise<GetVirtualMachineResult>
function getVirtualMachineOutput(args: GetVirtualMachineOutputArgs, opts?: InvokeOptions): Output<GetVirtualMachineResult>

def get_virtual_machine(alternate_guest_name: Optional[str] = None,
                        annotation: Optional[str] = None,
                        boot_delay: Optional[int] = None,
                        boot_retry_delay: Optional[int] = None,
                        boot_retry_enabled: Optional[bool] = None,
                        cpu_hot_add_enabled: Optional[bool] = None,
                        cpu_hot_remove_enabled: Optional[bool] = None,
                        cpu_limit: Optional[int] = None,
                        cpu_performance_counters_enabled: Optional[bool] = None,
                        cpu_reservation: Optional[int] = None,
                        cpu_share_count: Optional[int] = None,
                        cpu_share_level: Optional[str] = None,
                        datacenter_id: Optional[str] = None,
                        efi_secure_boot_enabled: Optional[bool] = None,
                        enable_disk_uuid: Optional[bool] = None,
                        enable_logging: Optional[bool] = None,
                        ept_rvi_mode: Optional[str] = None,
                        extra_config: Optional[Mapping[str, str]] = None,
                        extra_config_reboot_required: Optional[bool] = None,
                        firmware: Optional[str] = None,
                        folder: Optional[str] = None,
                        guest_id: Optional[str] = None,
                        hardware_version: Optional[int] = None,
                        hv_mode: Optional[str] = None,
                        ide_controller_scan_count: Optional[int] = None,
                        latency_sensitivity: Optional[str] = None,
                        memory: Optional[int] = None,
                        memory_hot_add_enabled: Optional[bool] = None,
                        memory_limit: Optional[int] = None,
                        memory_reservation: Optional[int] = None,
                        memory_reservation_locked_to_max: Optional[bool] = None,
                        memory_share_count: Optional[int] = None,
                        memory_share_level: Optional[str] = None,
                        moid: Optional[str] = None,
                        name: Optional[str] = None,
                        nested_hv_enabled: Optional[bool] = None,
                        num_cores_per_socket: Optional[int] = None,
                        num_cpus: Optional[int] = None,
                        replace_trigger: Optional[str] = None,
                        run_tools_scripts_after_power_on: Optional[bool] = None,
                        run_tools_scripts_after_resume: Optional[bool] = None,
                        run_tools_scripts_before_guest_reboot: Optional[bool] = None,
                        run_tools_scripts_before_guest_shutdown: Optional[bool] = None,
                        run_tools_scripts_before_guest_standby: Optional[bool] = None,
                        sata_controller_scan_count: Optional[int] = None,
                        scsi_controller_scan_count: Optional[int] = None,
                        storage_policy_id: Optional[str] = None,
                        swap_placement_policy: Optional[str] = None,
                        sync_time_with_host: Optional[bool] = None,
                        sync_time_with_host_periodically: Optional[bool] = None,
                        tools_upgrade_policy: Optional[str] = None,
                        uuid: Optional[str] = None,
                        vapp: Optional[GetVirtualMachineVapp] = None,
                        vbs_enabled: Optional[bool] = None,
                        vvtd_enabled: Optional[bool] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
def get_virtual_machine_output(alternate_guest_name: Optional[pulumi.Input[str]] = None,
                        annotation: Optional[pulumi.Input[str]] = None,
                        boot_delay: Optional[pulumi.Input[int]] = None,
                        boot_retry_delay: Optional[pulumi.Input[int]] = None,
                        boot_retry_enabled: Optional[pulumi.Input[bool]] = None,
                        cpu_hot_add_enabled: Optional[pulumi.Input[bool]] = None,
                        cpu_hot_remove_enabled: Optional[pulumi.Input[bool]] = None,
                        cpu_limit: Optional[pulumi.Input[int]] = None,
                        cpu_performance_counters_enabled: Optional[pulumi.Input[bool]] = None,
                        cpu_reservation: Optional[pulumi.Input[int]] = None,
                        cpu_share_count: Optional[pulumi.Input[int]] = None,
                        cpu_share_level: Optional[pulumi.Input[str]] = None,
                        datacenter_id: Optional[pulumi.Input[str]] = None,
                        efi_secure_boot_enabled: Optional[pulumi.Input[bool]] = None,
                        enable_disk_uuid: Optional[pulumi.Input[bool]] = None,
                        enable_logging: Optional[pulumi.Input[bool]] = None,
                        ept_rvi_mode: Optional[pulumi.Input[str]] = None,
                        extra_config: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                        extra_config_reboot_required: Optional[pulumi.Input[bool]] = None,
                        firmware: Optional[pulumi.Input[str]] = None,
                        folder: Optional[pulumi.Input[str]] = None,
                        guest_id: Optional[pulumi.Input[str]] = None,
                        hardware_version: Optional[pulumi.Input[int]] = None,
                        hv_mode: Optional[pulumi.Input[str]] = None,
                        ide_controller_scan_count: Optional[pulumi.Input[int]] = None,
                        latency_sensitivity: Optional[pulumi.Input[str]] = None,
                        memory: Optional[pulumi.Input[int]] = None,
                        memory_hot_add_enabled: Optional[pulumi.Input[bool]] = None,
                        memory_limit: Optional[pulumi.Input[int]] = None,
                        memory_reservation: Optional[pulumi.Input[int]] = None,
                        memory_reservation_locked_to_max: Optional[pulumi.Input[bool]] = None,
                        memory_share_count: Optional[pulumi.Input[int]] = None,
                        memory_share_level: Optional[pulumi.Input[str]] = None,
                        moid: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        nested_hv_enabled: Optional[pulumi.Input[bool]] = None,
                        num_cores_per_socket: Optional[pulumi.Input[int]] = None,
                        num_cpus: Optional[pulumi.Input[int]] = None,
                        replace_trigger: Optional[pulumi.Input[str]] = None,
                        run_tools_scripts_after_power_on: Optional[pulumi.Input[bool]] = None,
                        run_tools_scripts_after_resume: Optional[pulumi.Input[bool]] = None,
                        run_tools_scripts_before_guest_reboot: Optional[pulumi.Input[bool]] = None,
                        run_tools_scripts_before_guest_shutdown: Optional[pulumi.Input[bool]] = None,
                        run_tools_scripts_before_guest_standby: Optional[pulumi.Input[bool]] = None,
                        sata_controller_scan_count: Optional[pulumi.Input[int]] = None,
                        scsi_controller_scan_count: Optional[pulumi.Input[int]] = None,
                        storage_policy_id: Optional[pulumi.Input[str]] = None,
                        swap_placement_policy: Optional[pulumi.Input[str]] = None,
                        sync_time_with_host: Optional[pulumi.Input[bool]] = None,
                        sync_time_with_host_periodically: Optional[pulumi.Input[bool]] = None,
                        tools_upgrade_policy: Optional[pulumi.Input[str]] = None,
                        uuid: Optional[pulumi.Input[str]] = None,
                        vapp: Optional[pulumi.Input[GetVirtualMachineVappArgs]] = None,
                        vbs_enabled: Optional[pulumi.Input[bool]] = None,
                        vvtd_enabled: Optional[pulumi.Input[bool]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualMachineResult]

func LookupVirtualMachine(ctx *Context, args *LookupVirtualMachineArgs, opts ...InvokeOption) (*LookupVirtualMachineResult, error)
func LookupVirtualMachineOutput(ctx *Context, args *LookupVirtualMachineOutputArgs, opts ...InvokeOption) LookupVirtualMachineResultOutput

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

public static class GetVirtualMachine 
{
    public static Task<GetVirtualMachineResult> InvokeAsync(GetVirtualMachineArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualMachineResult> Invoke(GetVirtualMachineInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualMachineResult> getVirtualMachine(GetVirtualMachineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: vsphere:index/getVirtualMachine:getVirtualMachine
  arguments:
    # arguments dictionary

The following arguments are supported:

AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
Annotation string: The user-provided description of this virtual machine.
BootDelay int
BootRetryDelay int
BootRetryEnabled bool
CpuHotAddEnabled bool
CpuHotRemoveEnabled bool
CpuLimit int
CpuPerformanceCountersEnabled bool
CpuReservation int
CpuShareCount int
CpuShareLevel string
DatacenterId string: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig Dictionary<string, string>
ExtraConfigRebootRequired bool
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
Folder string: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
GuestId string: The guest ID of the virtual machine or template.
HardwareVersion int: The hardware version number on this virtual machine.
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryReservationLockedToMax bool
MemoryShareCount int
MemoryShareLevel string
Moid string
Name string: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
NestedHvEnabled bool
NumCoresPerSocket int: The number of cores per socket for this virtual machine.
NumCpus int: The total number of virtual processor cores assigned to this virtual machine.
ReplaceTrigger string
RunToolsScriptsAfterPowerOn bool
RunToolsScriptsAfterResume bool
RunToolsScriptsBeforeGuestReboot bool
RunToolsScriptsBeforeGuestShutdown bool
RunToolsScriptsBeforeGuestStandby bool
SataControllerScanCount int
ScsiControllerScanCount int: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
StoragePolicyId string
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
ToolsUpgradePolicy string
Uuid string: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
Vapp Pulumi.VSphere.Inputs.GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
Annotation string: The user-provided description of this virtual machine.
BootDelay int
BootRetryDelay int
BootRetryEnabled bool
CpuHotAddEnabled bool
CpuHotRemoveEnabled bool
CpuLimit int
CpuPerformanceCountersEnabled bool
CpuReservation int
CpuShareCount int
CpuShareLevel string
DatacenterId string: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig map[string]string
ExtraConfigRebootRequired bool
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
Folder string: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
GuestId string: The guest ID of the virtual machine or template.
HardwareVersion int: The hardware version number on this virtual machine.
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryReservationLockedToMax bool
MemoryShareCount int
MemoryShareLevel string
Moid string
Name string: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
NestedHvEnabled bool
NumCoresPerSocket int: The number of cores per socket for this virtual machine.
NumCpus int: The total number of virtual processor cores assigned to this virtual machine.
ReplaceTrigger string
RunToolsScriptsAfterPowerOn bool
RunToolsScriptsAfterResume bool
RunToolsScriptsBeforeGuestReboot bool
RunToolsScriptsBeforeGuestShutdown bool
RunToolsScriptsBeforeGuestStandby bool
SataControllerScanCount int
ScsiControllerScanCount int: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
StoragePolicyId string
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
ToolsUpgradePolicy string
Uuid string: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
Vapp GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
annotation String: The user-provided description of this virtual machine.
bootDelay Integer
bootRetryDelay Integer
bootRetryEnabled Boolean
cpuHotAddEnabled Boolean
cpuHotRemoveEnabled Boolean
cpuLimit Integer
cpuPerformanceCountersEnabled Boolean
cpuReservation Integer
cpuShareCount Integer
cpuShareLevel String
datacenterId String: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map<String,String>
extraConfigRebootRequired Boolean
firmware String: The firmware type for this virtual machine. Can be bios or efi.
folder String: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
guestId String: The guest ID of the virtual machine or template.
hardwareVersion Integer: The hardware version number on this virtual machine.
hvMode String
ideControllerScanCount Integer
latencySensitivity String
memory Integer: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Integer
memoryReservation Integer
memoryReservationLockedToMax Boolean
memoryShareCount Integer
memoryShareLevel String
moid String
name String: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
nestedHvEnabled Boolean
numCoresPerSocket Integer: The number of cores per socket for this virtual machine.
numCpus Integer: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger String
runToolsScriptsAfterPowerOn Boolean
runToolsScriptsAfterResume Boolean
runToolsScriptsBeforeGuestReboot Boolean
runToolsScriptsBeforeGuestShutdown Boolean
runToolsScriptsBeforeGuestStandby Boolean
sataControllerScanCount Integer
scsiControllerScanCount Integer: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
storagePolicyId String
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
toolsUpgradePolicy String
uuid String: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
vapp GetVirtualMachineVapp
vbsEnabled Boolean
vvtdEnabled Boolean

alternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
annotation string: The user-provided description of this virtual machine.
bootDelay number
bootRetryDelay number
bootRetryEnabled boolean
cpuHotAddEnabled boolean
cpuHotRemoveEnabled boolean
cpuLimit number
cpuPerformanceCountersEnabled boolean
cpuReservation number
cpuShareCount number
cpuShareLevel string
datacenterId string: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
efiSecureBootEnabled boolean
enableDiskUuid boolean
enableLogging boolean
eptRviMode string
extraConfig {[key: string]: string}
extraConfigRebootRequired boolean
firmware string: The firmware type for this virtual machine. Can be bios or efi.
folder string: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
guestId string: The guest ID of the virtual machine or template.
hardwareVersion number: The hardware version number on this virtual machine.
hvMode string
ideControllerScanCount number
latencySensitivity string
memory number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled boolean
memoryLimit number
memoryReservation number
memoryReservationLockedToMax boolean
memoryShareCount number
memoryShareLevel string
moid string
name string: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
nestedHvEnabled boolean
numCoresPerSocket number: The number of cores per socket for this virtual machine.
numCpus number: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger string
runToolsScriptsAfterPowerOn boolean
runToolsScriptsAfterResume boolean
runToolsScriptsBeforeGuestReboot boolean
runToolsScriptsBeforeGuestShutdown boolean
runToolsScriptsBeforeGuestStandby boolean
sataControllerScanCount number
scsiControllerScanCount number: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
storagePolicyId string
swapPlacementPolicy string
syncTimeWithHost boolean
syncTimeWithHostPeriodically boolean
toolsUpgradePolicy string
uuid string: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
vapp GetVirtualMachineVapp
vbsEnabled boolean
vvtdEnabled boolean

alternate_guest_name str: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
annotation str: The user-provided description of this virtual machine.
boot_delay int
boot_retry_delay int
boot_retry_enabled bool
cpu_hot_add_enabled bool
cpu_hot_remove_enabled bool
cpu_limit int
cpu_performance_counters_enabled bool
cpu_reservation int
cpu_share_count int
cpu_share_level str
datacenter_id str: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
efi_secure_boot_enabled bool
enable_disk_uuid bool
enable_logging bool
ept_rvi_mode str
extra_config Mapping[str, str]
extra_config_reboot_required bool
firmware str: The firmware type for this virtual machine. Can be bios or efi.
folder str: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
guest_id str: The guest ID of the virtual machine or template.
hardware_version int: The hardware version number on this virtual machine.
hv_mode str
ide_controller_scan_count int
latency_sensitivity str
memory int: The size of the virtual machine's memory, in MB.
memory_hot_add_enabled bool
memory_limit int
memory_reservation int
memory_reservation_locked_to_max bool
memory_share_count int
memory_share_level str
moid str
name str: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
nested_hv_enabled bool
num_cores_per_socket int: The number of cores per socket for this virtual machine.
num_cpus int: The total number of virtual processor cores assigned to this virtual machine.
replace_trigger str
run_tools_scripts_after_power_on bool
run_tools_scripts_after_resume bool
run_tools_scripts_before_guest_reboot bool
run_tools_scripts_before_guest_shutdown bool
run_tools_scripts_before_guest_standby bool
sata_controller_scan_count int
scsi_controller_scan_count int: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
storage_policy_id str
swap_placement_policy str
sync_time_with_host bool
sync_time_with_host_periodically bool
tools_upgrade_policy str
uuid str: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
vapp GetVirtualMachineVapp
vbs_enabled bool
vvtd_enabled bool

alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
annotation String: The user-provided description of this virtual machine.
bootDelay Number
bootRetryDelay Number
bootRetryEnabled Boolean
cpuHotAddEnabled Boolean
cpuHotRemoveEnabled Boolean
cpuLimit Number
cpuPerformanceCountersEnabled Boolean
cpuReservation Number
cpuShareCount Number
cpuShareLevel String
datacenterId String: The managed object reference ID of the datacenter the virtual machine is located in. This can be omitted if the search path used in name is an absolute path. For default datacenters, use the id attribute from an empty vsphere.Datacenter data source.
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map<String>
extraConfigRebootRequired Boolean
firmware String: The firmware type for this virtual machine. Can be bios or efi.
folder String: The name of the virtual machine folder where the virtual machine is located. The name argument is limited to 80 characters. If the name argument includes the full path to the virtual machine and exceeds the 80 characters limit, the folder folder argument can be used.
guestId String: The guest ID of the virtual machine or template.
hardwareVersion Number: The hardware version number on this virtual machine.
hvMode String
ideControllerScanCount Number
latencySensitivity String
memory Number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Number
memoryReservation Number
memoryReservationLockedToMax Boolean
memoryShareCount Number
memoryShareLevel String
moid String
name String: The name of the virtual machine. This can be a name or the full path relative to the datacenter. This is required if a UUID lookup is not performed.
nestedHvEnabled Boolean
numCoresPerSocket Number: The number of cores per socket for this virtual machine.
numCpus Number: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger String
runToolsScriptsAfterPowerOn Boolean
runToolsScriptsAfterResume Boolean
runToolsScriptsBeforeGuestReboot Boolean
runToolsScriptsBeforeGuestShutdown Boolean
runToolsScriptsBeforeGuestStandby Boolean
sataControllerScanCount Number
scsiControllerScanCount Number: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
NOTE: For best results, ensure that all the disks on any templates you use with this data source reside on the primary controller, and leave this value at the default. See the vsphere.VirtualMachine resource documentation for the significance of this setting, specifically the additional requirements and notes for cloning section.
storagePolicyId String
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
toolsUpgradePolicy String
uuid String: Specify this field for a UUID lookup, name and datacenter_id are not required if this is specified.
vapp Property Map
vbsEnabled Boolean
vvtdEnabled Boolean

getVirtualMachine Result

The following output properties are available:

Annotation string: The user-provided description of this virtual machine.
ChangeVersion string
CpuShareCount int
DefaultIpAddress string: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
Disks List<Pulumi.VSphere.Outputs.GetVirtualMachineDisk>: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
GuestId string: The guest ID of the virtual machine or template.
GuestIpAddresses List<string>: A list of IP addresses as reported by VMware Tools.
HardwareVersion int: The hardware version number on this virtual machine.
Id string: The provider-assigned unique ID for this managed resource.
MemoryShareCount int
Moid string
NetworkInterfaceTypes List<string>: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
NetworkInterfaces List<Pulumi.VSphere.Outputs.GetVirtualMachineNetworkInterface>: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
ScsiBusSharing string: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
ScsiType string: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
StoragePolicyId string
Uuid string
VappTransports List<string>
AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
BootDelay int
BootRetryDelay int
BootRetryEnabled bool
CpuHotAddEnabled bool
CpuHotRemoveEnabled bool
CpuLimit int
CpuPerformanceCountersEnabled bool
CpuReservation int
CpuShareLevel string
DatacenterId string
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig Dictionary<string, string>
ExtraConfigRebootRequired bool
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
Folder string
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryReservationLockedToMax bool
MemoryShareLevel string
Name string
NestedHvEnabled bool
NumCoresPerSocket int: The number of cores per socket for this virtual machine.
NumCpus int: The total number of virtual processor cores assigned to this virtual machine.
ReplaceTrigger string
RunToolsScriptsAfterPowerOn bool
RunToolsScriptsAfterResume bool
RunToolsScriptsBeforeGuestReboot bool
RunToolsScriptsBeforeGuestShutdown bool
RunToolsScriptsBeforeGuestStandby bool
SataControllerScanCount int
ScsiControllerScanCount int
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
ToolsUpgradePolicy string
Vapp Pulumi.VSphere.Outputs.GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

Annotation string: The user-provided description of this virtual machine.
ChangeVersion string
CpuShareCount int
DefaultIpAddress string: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
Disks []GetVirtualMachineDisk: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
GuestId string: The guest ID of the virtual machine or template.
GuestIpAddresses []string: A list of IP addresses as reported by VMware Tools.
HardwareVersion int: The hardware version number on this virtual machine.
Id string: The provider-assigned unique ID for this managed resource.
MemoryShareCount int
Moid string
NetworkInterfaceTypes []string: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
NetworkInterfaces []GetVirtualMachineNetworkInterface: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
ScsiBusSharing string: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
ScsiType string: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
StoragePolicyId string
Uuid string
VappTransports []string
AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
BootDelay int
BootRetryDelay int
BootRetryEnabled bool
CpuHotAddEnabled bool
CpuHotRemoveEnabled bool
CpuLimit int
CpuPerformanceCountersEnabled bool
CpuReservation int
CpuShareLevel string
DatacenterId string
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig map[string]string
ExtraConfigRebootRequired bool
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
Folder string
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryReservationLockedToMax bool
MemoryShareLevel string
Name string
NestedHvEnabled bool
NumCoresPerSocket int: The number of cores per socket for this virtual machine.
NumCpus int: The total number of virtual processor cores assigned to this virtual machine.
ReplaceTrigger string
RunToolsScriptsAfterPowerOn bool
RunToolsScriptsAfterResume bool
RunToolsScriptsBeforeGuestReboot bool
RunToolsScriptsBeforeGuestShutdown bool
RunToolsScriptsBeforeGuestStandby bool
SataControllerScanCount int
ScsiControllerScanCount int
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
ToolsUpgradePolicy string
Vapp GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

annotation String: The user-provided description of this virtual machine.
changeVersion String
cpuShareCount Integer
defaultIpAddress String: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
disks List<GetVirtualMachineDisk>: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
guestId String: The guest ID of the virtual machine or template.
guestIpAddresses List<String>: A list of IP addresses as reported by VMware Tools.
hardwareVersion Integer: The hardware version number on this virtual machine.
id String: The provider-assigned unique ID for this managed resource.
memoryShareCount Integer
moid String
networkInterfaceTypes List<String>: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
networkInterfaces List<GetVirtualMachineNetworkInterface>: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
scsiBusSharing String: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
scsiType String: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
storagePolicyId String
uuid String
vappTransports List<String>
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
bootDelay Integer
bootRetryDelay Integer
bootRetryEnabled Boolean
cpuHotAddEnabled Boolean
cpuHotRemoveEnabled Boolean
cpuLimit Integer
cpuPerformanceCountersEnabled Boolean
cpuReservation Integer
cpuShareLevel String
datacenterId String
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map<String,String>
extraConfigRebootRequired Boolean
firmware String: The firmware type for this virtual machine. Can be bios or efi.
folder String
hvMode String
ideControllerScanCount Integer
latencySensitivity String
memory Integer: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Integer
memoryReservation Integer
memoryReservationLockedToMax Boolean
memoryShareLevel String
name String
nestedHvEnabled Boolean
numCoresPerSocket Integer: The number of cores per socket for this virtual machine.
numCpus Integer: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger String
runToolsScriptsAfterPowerOn Boolean
runToolsScriptsAfterResume Boolean
runToolsScriptsBeforeGuestReboot Boolean
runToolsScriptsBeforeGuestShutdown Boolean
runToolsScriptsBeforeGuestStandby Boolean
sataControllerScanCount Integer
scsiControllerScanCount Integer
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
toolsUpgradePolicy String
vapp GetVirtualMachineVapp
vbsEnabled Boolean
vvtdEnabled Boolean

annotation string: The user-provided description of this virtual machine.
changeVersion string
cpuShareCount number
defaultIpAddress string: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
disks GetVirtualMachineDisk[]: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
guestId string: The guest ID of the virtual machine or template.
guestIpAddresses string[]: A list of IP addresses as reported by VMware Tools.
hardwareVersion number: The hardware version number on this virtual machine.
id string: The provider-assigned unique ID for this managed resource.
memoryShareCount number
moid string
networkInterfaceTypes string[]: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
networkInterfaces GetVirtualMachineNetworkInterface[]: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
scsiBusSharing string: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
scsiType string: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
storagePolicyId string
uuid string
vappTransports string[]
alternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
bootDelay number
bootRetryDelay number
bootRetryEnabled boolean
cpuHotAddEnabled boolean
cpuHotRemoveEnabled boolean
cpuLimit number
cpuPerformanceCountersEnabled boolean
cpuReservation number
cpuShareLevel string
datacenterId string
efiSecureBootEnabled boolean
enableDiskUuid boolean
enableLogging boolean
eptRviMode string
extraConfig {[key: string]: string}
extraConfigRebootRequired boolean
firmware string: The firmware type for this virtual machine. Can be bios or efi.
folder string
hvMode string
ideControllerScanCount number
latencySensitivity string
memory number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled boolean
memoryLimit number
memoryReservation number
memoryReservationLockedToMax boolean
memoryShareLevel string
name string
nestedHvEnabled boolean
numCoresPerSocket number: The number of cores per socket for this virtual machine.
numCpus number: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger string
runToolsScriptsAfterPowerOn boolean
runToolsScriptsAfterResume boolean
runToolsScriptsBeforeGuestReboot boolean
runToolsScriptsBeforeGuestShutdown boolean
runToolsScriptsBeforeGuestStandby boolean
sataControllerScanCount number
scsiControllerScanCount number
swapPlacementPolicy string
syncTimeWithHost boolean
syncTimeWithHostPeriodically boolean
toolsUpgradePolicy string
vapp GetVirtualMachineVapp
vbsEnabled boolean
vvtdEnabled boolean

annotation str: The user-provided description of this virtual machine.
change_version str
cpu_share_count int
default_ip_address str: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
disks Sequence[GetVirtualMachineDisk]: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
guest_id str: The guest ID of the virtual machine or template.
guest_ip_addresses Sequence[str]: A list of IP addresses as reported by VMware Tools.
hardware_version int: The hardware version number on this virtual machine.
id str: The provider-assigned unique ID for this managed resource.
memory_share_count int
moid str
network_interface_types Sequence[str]: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
network_interfaces Sequence[GetVirtualMachineNetworkInterface]: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
scsi_bus_sharing str: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
scsi_type str: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
storage_policy_id str
uuid str
vapp_transports Sequence[str]
alternate_guest_name str: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
boot_delay int
boot_retry_delay int
boot_retry_enabled bool
cpu_hot_add_enabled bool
cpu_hot_remove_enabled bool
cpu_limit int
cpu_performance_counters_enabled bool
cpu_reservation int
cpu_share_level str
datacenter_id str
efi_secure_boot_enabled bool
enable_disk_uuid bool
enable_logging bool
ept_rvi_mode str
extra_config Mapping[str, str]
extra_config_reboot_required bool
firmware str: The firmware type for this virtual machine. Can be bios or efi.
folder str
hv_mode str
ide_controller_scan_count int
latency_sensitivity str
memory int: The size of the virtual machine's memory, in MB.
memory_hot_add_enabled bool
memory_limit int
memory_reservation int
memory_reservation_locked_to_max bool
memory_share_level str
name str
nested_hv_enabled bool
num_cores_per_socket int: The number of cores per socket for this virtual machine.
num_cpus int: The total number of virtual processor cores assigned to this virtual machine.
replace_trigger str
run_tools_scripts_after_power_on bool
run_tools_scripts_after_resume bool
run_tools_scripts_before_guest_reboot bool
run_tools_scripts_before_guest_shutdown bool
run_tools_scripts_before_guest_standby bool
sata_controller_scan_count int
scsi_controller_scan_count int
swap_placement_policy str
sync_time_with_host bool
sync_time_with_host_periodically bool
tools_upgrade_policy str
vapp GetVirtualMachineVapp
vbs_enabled bool
vvtd_enabled bool

annotation String: The user-provided description of this virtual machine.
changeVersion String
cpuShareCount Number
defaultIpAddress String: Whenever possible, this is the first IPv4 address that is reachable through the default gateway configured on the machine, then the first reachable IPv6 address, and then the first general discovered address if neither exist. If VMware Tools is not running on the virtual machine, or if the VM is powered off, this value will be blank.
disks List<Property Map>: Information about each of the disks on this virtual machine or template. These are sorted by bus and unit number so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain disk settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. Only the first number of controllers defined by scsi_controller_scan_count are scanned for disks. The sub-attributes are:
guestId String: The guest ID of the virtual machine or template.
guestIpAddresses List<String>: A list of IP addresses as reported by VMware Tools.
hardwareVersion Number: The hardware version number on this virtual machine.
id String: The provider-assigned unique ID for this managed resource.
memoryShareCount Number
moid String
networkInterfaceTypes List<String>: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, pcnet32, sriov, vmxnet2, vmxnet3vrdma, or vmxnet3.
networkInterfaces List<Property Map>: Information about each of the network interfaces on this virtual machine or template. These are sorted by device bus order so that they can be applied to a vsphere.VirtualMachine resource in the order the resource expects while cloning. This is useful for discovering certain network interface settings while performing a linked clone, as all settings that are output by this data source must be the same on the destination virtual machine as the source. The sub-attributes are:
scsiBusSharing String: Mode for sharing the SCSI bus. The modes are physicalSharing, virtualSharing, and noSharing. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
scsiType String: The common type of all SCSI controllers on this virtual machine. Will be one of lsilogic (LSI Logic Parallel), lsilogic-sas (LSI Logic SAS), pvscsi (VMware Paravirtual), buslogic (BusLogic), or mixed when there are multiple controller types. Only the first number of controllers defined by scsi_controller_scan_count are scanned.
storagePolicyId String
uuid String
vappTransports List<String>
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest or otherGuest64.
bootDelay Number
bootRetryDelay Number
bootRetryEnabled Boolean
cpuHotAddEnabled Boolean
cpuHotRemoveEnabled Boolean
cpuLimit Number
cpuPerformanceCountersEnabled Boolean
cpuReservation Number
cpuShareLevel String
datacenterId String
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map<String>
extraConfigRebootRequired Boolean
firmware String: The firmware type for this virtual machine. Can be bios or efi.
folder String
hvMode String
ideControllerScanCount Number
latencySensitivity String
memory Number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Number
memoryReservation Number
memoryReservationLockedToMax Boolean
memoryShareLevel String
name String
nestedHvEnabled Boolean
numCoresPerSocket Number: The number of cores per socket for this virtual machine.
numCpus Number: The total number of virtual processor cores assigned to this virtual machine.
replaceTrigger String
runToolsScriptsAfterPowerOn Boolean
runToolsScriptsAfterResume Boolean
runToolsScriptsBeforeGuestReboot Boolean
runToolsScriptsBeforeGuestShutdown Boolean
runToolsScriptsBeforeGuestStandby Boolean
sataControllerScanCount Number
scsiControllerScanCount Number
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
toolsUpgradePolicy String
vapp Property Map
vbsEnabled Boolean
vvtdEnabled Boolean

Supporting Types

GetVirtualMachineDisk

EagerlyScrub bool: Set to true if the disk has been eager zeroed.
Label string: The label for the disk.
Size int: The size of the disk, in GIB.
ThinProvisioned bool: Set to true if the disk has been thin provisioned.
UnitNumber int: The disk number on the storage bus.

EagerlyScrub bool: Set to true if the disk has been eager zeroed.
Label string: The label for the disk.
Size int: The size of the disk, in GIB.
ThinProvisioned bool: Set to true if the disk has been thin provisioned.
UnitNumber int: The disk number on the storage bus.

eagerlyScrub Boolean: Set to true if the disk has been eager zeroed.
label String: The label for the disk.
size Integer: The size of the disk, in GIB.
thinProvisioned Boolean: Set to true if the disk has been thin provisioned.
unitNumber Integer: The disk number on the storage bus.

eagerlyScrub boolean: Set to true if the disk has been eager zeroed.
label string: The label for the disk.
size number: The size of the disk, in GIB.
thinProvisioned boolean: Set to true if the disk has been thin provisioned.
unitNumber number: The disk number on the storage bus.

eagerly_scrub bool: Set to true if the disk has been eager zeroed.
label str: The label for the disk.
size int: The size of the disk, in GIB.
thin_provisioned bool: Set to true if the disk has been thin provisioned.
unit_number int: The disk number on the storage bus.

eagerlyScrub Boolean: Set to true if the disk has been eager zeroed.
label String: The label for the disk.
size Number: The size of the disk, in GIB.
thinProvisioned Boolean: Set to true if the disk has been thin provisioned.
unitNumber Number: The disk number on the storage bus.

GetVirtualMachineNetworkInterface

AdapterType string: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
BandwidthShareCount int: The share count for this network interface when the share level is custom.
MacAddress string: The MAC address of this network interface.
NetworkId string: The managed object reference ID of the network this interface is connected to.
PhysicalFunction string: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
BandwidthLimit int: The upper bandwidth limit of this network interface, in Mbits/sec.
BandwidthReservation int: The bandwidth reservation of this network interface, in Mbits/sec.
BandwidthShareLevel string: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

AdapterType string: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
BandwidthShareCount int: The share count for this network interface when the share level is custom.
MacAddress string: The MAC address of this network interface.
NetworkId string: The managed object reference ID of the network this interface is connected to.
PhysicalFunction string: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
BandwidthLimit int: The upper bandwidth limit of this network interface, in Mbits/sec.
BandwidthReservation int: The bandwidth reservation of this network interface, in Mbits/sec.
BandwidthShareLevel string: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

adapterType String: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
bandwidthShareCount Integer: The share count for this network interface when the share level is custom.
macAddress String: The MAC address of this network interface.
networkId String: The managed object reference ID of the network this interface is connected to.
physicalFunction String: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
bandwidthLimit Integer: The upper bandwidth limit of this network interface, in Mbits/sec.
bandwidthReservation Integer: The bandwidth reservation of this network interface, in Mbits/sec.
bandwidthShareLevel String: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

adapterType string: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
bandwidthShareCount number: The share count for this network interface when the share level is custom.
macAddress string: The MAC address of this network interface.
networkId string: The managed object reference ID of the network this interface is connected to.
physicalFunction string: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
bandwidthLimit number: The upper bandwidth limit of this network interface, in Mbits/sec.
bandwidthReservation number: The bandwidth reservation of this network interface, in Mbits/sec.
bandwidthShareLevel string: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

adapter_type str: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
bandwidth_share_count int: The share count for this network interface when the share level is custom.
mac_address str: The MAC address of this network interface.
network_id str: The managed object reference ID of the network this interface is connected to.
physical_function str: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
bandwidth_limit int: The upper bandwidth limit of this network interface, in Mbits/sec.
bandwidth_reservation int: The bandwidth reservation of this network interface, in Mbits/sec.
bandwidth_share_level str: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

adapterType String: The network interface types for each network interface found on the virtual machine, in device bus order. Will be one of e1000, e1000e, vmxnet3vrdma, or vmxnet3.
bandwidthShareCount Number: The share count for this network interface when the share level is custom.
macAddress String: The MAC address of this network interface.
networkId String: The managed object reference ID of the network this interface is connected to.
physicalFunction String: The ID of the Physical SR-IOV NIC to attach to, e.g. '0000:d8:00.0'
bandwidthLimit Number: The upper bandwidth limit of this network interface, in Mbits/sec.
bandwidthReservation Number: The bandwidth reservation of this network interface, in Mbits/sec.
bandwidthShareLevel String: The bandwidth share allocation level for this interface. Can be one of low, normal, high, or custom.

GetVirtualMachineVapp

Properties Dictionary<string, string>: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

Properties map[string]string: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

properties Map<String,String>: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

properties {[key: string]: string}: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

properties Mapping[str, str]: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

properties Map<String>: A map of customizable vApp properties and their values. Allows customization of VMs cloned from OVF templates which have customizable vApp properties.

Package Details

Repository: vSphere pulumi/pulumi-vsphere
License: Apache-2.0
Notes: This Pulumi package is based on the vsphere Terraform Provider.

vSphere v4.10.0 published on Tuesday, Mar 12, 2024 by Pulumi

pulumi/pulumi-vsphere

vsphere.getVirtualMachine

On this page

On this page

Example Usage

Using getVirtualMachine

getVirtualMachine Result

Supporting Types

GetVirtualMachineDisk

GetVirtualMachineNetworkInterface

GetVirtualMachineVapp

Package Details

On this page

On this page