vSphere

Pulumi Official

Package maintained by Pulumi

v4.1.0 published on Wednesday, Nov 24, 2021 by Pulumi

getVirtualMachine

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

Example Usage

using Pulumi;
using VSphere = Pulumi.VSphere;

class MyStack : Stack
{
    public MyStack()
    {
        var datacenter = Output.Create(VSphere.GetDatacenter.InvokeAsync(new VSphere.GetDatacenterArgs
        {
            Name = "dc1",
        }));
        var template = datacenter.Apply(datacenter => Output.Create(VSphere.GetVirtualMachine.InvokeAsync(new VSphere.GetVirtualMachineArgs
        {
            DatacenterId = datacenter.Id,
            Name = "test-vm-template",
        })));
    }

}

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 {
		opt0 := "dc1"
		datacenter, err := vsphere.LookupDatacenter(ctx, &GetDatacenterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		opt1 := datacenter.Id
		_, err = vsphere.LookupVirtualMachine(ctx, &GetVirtualMachineArgs{
			DatacenterId: &opt1,
			Name:         "test-vm-template",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_vsphere as vsphere

datacenter = vsphere.get_datacenter(name="dc1")
template = vsphere.get_virtual_machine(datacenter_id=datacenter.id,
    name="test-vm-template")

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

const datacenter = pulumi.output(vsphere.getDatacenter({
    name: "dc1",
}));
const template = datacenter.apply(datacenter => vsphere.getVirtualMachine({
    datacenterId: datacenter.id,
    name: "test-vm-template",
}));

Coming soon!

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,
                        firmware: 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_share_count: Optional[int] = None,
                        memory_share_level: 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,
                        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,
                        firmware: 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_share_count: Optional[pulumi.Input[int]] = None,
                        memory_share_level: 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,
                        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:

Name string: The name of the virtual machine. This can be a name or path.
AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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>
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
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
MemoryShareCount int
MemoryShareLevel 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
StoragePolicyId string
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
Vapp Pulumi.VSphere.Inputs.GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

Name string: The name of the virtual machine. This can be a name or path.
AlternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
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
MemoryShareCount int
MemoryShareLevel 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
StoragePolicyId string
SwapPlacementPolicy string
SyncTimeWithHost bool
SyncTimeWithHostPeriodically bool
Vapp GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

name String: The name of the virtual machine. This can be a name or path.
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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
firmware String: The firmware type for this virtual machine. Can be bios or efi.
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
memoryShareCount Integer
memoryShareLevel 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
storagePolicyId String
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
vapp GetVirtualMachineVapp
vbsEnabled Boolean
vvtdEnabled Boolean

name string: The name of the virtual machine. This can be a name or path.
alternateGuestName string: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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}
firmware string: The firmware type for this virtual machine. Can be bios or efi.
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
memoryShareCount number
memoryShareLevel 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
storagePolicyId string
swapPlacementPolicy string
syncTimeWithHost boolean
syncTimeWithHostPeriodically boolean
vapp GetVirtualMachineVapp
vbsEnabled boolean
vvtdEnabled boolean

name str: The name of the virtual machine. This can be a name or path.
alternate_guest_name str: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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]
firmware str: The firmware type for this virtual machine. Can be bios or efi.
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_share_count int
memory_share_level 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
storage_policy_id str
swap_placement_policy str
sync_time_with_host bool
sync_time_with_host_periodically bool
vapp GetVirtualMachineVapp
vbs_enabled bool
vvtd_enabled bool

name String: The name of the virtual machine. This can be a name or path.
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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
firmware String: The firmware type for this virtual machine. Can be bios or efi.
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
memoryShareCount Number
memoryShareLevel 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: The number of SCSI controllers to scan for disk attributes and controller types on. Default: 1.
storagePolicyId String
swapPlacementPolicy String
syncTimeWithHost Boolean
syncTimeWithHostPeriodically Boolean
vapp Property Map
vbsEnabled Boolean
vvtdEnabled Boolean

getVirtualMachine Result

The following output properties are available:

ChangeVersion string
CpuShareCount int
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
Name 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, 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.
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
CpuShareLevel string
DatacenterId string
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig Dictionary<string, string>
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryShareLevel 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
Vapp Pulumi.VSphere.Outputs.GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

ChangeVersion string
CpuShareCount int
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
Name 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, 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.
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
CpuShareLevel string
DatacenterId string
EfiSecureBootEnabled bool
EnableDiskUuid bool
EnableLogging bool
EptRviMode string
ExtraConfig map[string]string
Firmware string: The firmware type for this virtual machine. Can be bios or efi.
HvMode string
IdeControllerScanCount int
LatencySensitivity string
Memory int: The size of the virtual machine's memory, in MB.
MemoryHotAddEnabled bool
MemoryLimit int
MemoryReservation int
MemoryShareLevel 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
Vapp GetVirtualMachineVapp
VbsEnabled bool
VvtdEnabled bool

changeVersion String
cpuShareCount Integer
disks ListVirtualMachineDisk>: 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: 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
name String
networkInterfaceTypes List: 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, or vmxnet3.
networkInterfaces ListVirtualMachineNetworkInterface>: 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
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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
cpuShareLevel String
datacenterId String
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map
firmware String: The firmware type for this virtual machine. Can be bios or efi.
hvMode String
ideControllerScanCount Integer
latencySensitivity String
memory Integer: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Integer
memoryReservation Integer
memoryShareLevel 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
vapp GetVirtualMachineVapp
vbsEnabled Boolean
vvtdEnabled Boolean

changeVersion string
cpuShareCount number
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
name 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, 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.
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
cpuShareLevel string
datacenterId string
efiSecureBootEnabled boolean
enableDiskUuid boolean
enableLogging boolean
eptRviMode string
extraConfig {[key: string]: string}
firmware string: The firmware type for this virtual machine. Can be bios or efi.
hvMode string
ideControllerScanCount number
latencySensitivity string
memory number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled boolean
memoryLimit number
memoryReservation number
memoryShareLevel 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
vapp GetVirtualMachineVapp
vbsEnabled boolean
vvtdEnabled boolean

change_version str
cpu_share_count int
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
name 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, 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.
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_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]
firmware str: The firmware type for this virtual machine. Can be bios or efi.
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_share_level 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
vapp GetVirtualMachineVapp
vbs_enabled bool
vvtd_enabled bool

changeVersion String
cpuShareCount Number
disks List: 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: 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
name String
networkInterfaceTypes List: 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, or vmxnet3.
networkInterfaces List: 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
alternateGuestName String: The alternate guest name of the virtual machine when guest_id is a non-specific operating system, like otherGuest.
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
cpuShareLevel String
datacenterId String
efiSecureBootEnabled Boolean
enableDiskUuid Boolean
enableLogging Boolean
eptRviMode String
extraConfig Map
firmware String: The firmware type for this virtual machine. Can be bios or efi.
hvMode String
ideControllerScanCount Number
latencySensitivity String
memory Number: The size of the virtual machine's memory, in MB.
memoryHotAddEnabled Boolean
memoryLimit Number
memoryReservation Number
memoryShareLevel 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
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 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.
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 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.
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 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.
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 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.
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 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.
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 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.
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>

Properties map[string]string

properties Map

properties {[key: string]: string}

properties Mapping[str, str]

properties Map

Package Details

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