ESXi Native v1.0.0 published on Monday, Aug 28, 2023 by pulumiverse
esxi-native.getVirtualMachine
Explore with Pulumi AI
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(name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualMachineResult
def get_virtual_machine_output(name: Optional[pulumi.Input[str]] = 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: esxi-native:getVirtualMachine
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
 - Virtual Machine Name to get details of
 
- Name string
 - Virtual Machine Name to get details of
 
- name String
 - Virtual Machine Name to get details of
 
- name string
 - Virtual Machine Name to get details of
 
- name str
 - Virtual Machine Name to get details of
 
- name String
 - Virtual Machine Name to get details of
 
getVirtualMachine Result
The following output properties are available:
- Boot
Disk intSize  - VM boot disk size. Will expand boot disk to this size.
 - Boot
Disk Pulumiverse.Type Esxi Native. Disk Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - Boot
Firmware Pulumiverse.Esxi Native. Boot Firmware Type  - Boot type('efi' is boot uefi mode)
 - Disk
Store string - esxi diskstore for boot disk.
 - Id string
 - esxi vm id.
 - Info
List<Pulumiverse.
Esxi Native. Outputs. Key Value Pair>  - pass data to VM
 - Ip
Address string - The IP address reported by VMWare tools.
 - Mem
Size int - VM memory size.
 - Name string
 - esxi vm name.
 - Network
Interfaces List<Pulumiverse.Esxi Native. Outputs. Network Interface>  - VM network interfaces.
 - Notes string
 - VM memory size.
 - Num
VCpus int - VM number of virtual cpus.
 - Os string
 - VM OS type.
 - Power string
 - VM power state.
 - Resource
Pool stringName  - Resource pool name to place vm.
 - Shutdown
Timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - Startup
Timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - Virtual
Disks List<Pulumiverse.Esxi Native. Outputs. VMVirtual Disk>  - VM virtual disks.
 - Virtual
HWVer int - VM Virtual HW version.
 
- Boot
Disk intSize  - VM boot disk size. Will expand boot disk to this size.
 - Boot
Disk DiskType Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - Boot
Firmware BootFirmware Type  - Boot type('efi' is boot uefi mode)
 - Disk
Store string - esxi diskstore for boot disk.
 - Id string
 - esxi vm id.
 - Info
[]Key
Value Pair  - pass data to VM
 - Ip
Address string - The IP address reported by VMWare tools.
 - Mem
Size int - VM memory size.
 - Name string
 - esxi vm name.
 - Network
Interfaces []NetworkInterface  - VM network interfaces.
 - Notes string
 - VM memory size.
 - Num
VCpus int - VM number of virtual cpus.
 - Os string
 - VM OS type.
 - Power string
 - VM power state.
 - Resource
Pool stringName  - Resource pool name to place vm.
 - Shutdown
Timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - Startup
Timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - Virtual
Disks []VMVirtualDisk  - VM virtual disks.
 - Virtual
HWVer int - VM Virtual HW version.
 
- boot
Disk IntegerSize  - VM boot disk size. Will expand boot disk to this size.
 - boot
Disk DiskType Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - boot
Firmware BootFirmware Type  - Boot type('efi' is boot uefi mode)
 - disk
Store String - esxi diskstore for boot disk.
 - id String
 - esxi vm id.
 - info
List<Key
Value Pair>  - pass data to VM
 - ip
Address String - The IP address reported by VMWare tools.
 - mem
Size Integer - VM memory size.
 - name String
 - esxi vm name.
 - network
Interfaces List<NetworkInterface>  - VM network interfaces.
 - notes String
 - VM memory size.
 - num
VCpus Integer - VM number of virtual cpus.
 - os String
 - VM OS type.
 - power String
 - VM power state.
 - resource
Pool StringName  - Resource pool name to place vm.
 - shutdown
Timeout Integer - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - startup
Timeout Integer - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - virtual
Disks List<VMVirtualDisk>  - VM virtual disks.
 - virtual
HWVer Integer - VM Virtual HW version.
 
- boot
Disk numberSize  - VM boot disk size. Will expand boot disk to this size.
 - boot
Disk DiskType Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - boot
Firmware BootFirmware Type  - Boot type('efi' is boot uefi mode)
 - disk
Store string - esxi diskstore for boot disk.
 - id string
 - esxi vm id.
 - info
Key
Value Pair[]  - pass data to VM
 - ip
Address string - The IP address reported by VMWare tools.
 - mem
Size number - VM memory size.
 - name string
 - esxi vm name.
 - network
Interfaces NetworkInterface[]  - VM network interfaces.
 - notes string
 - VM memory size.
 - num
VCpus number - VM number of virtual cpus.
 - os string
 - VM OS type.
 - power string
 - VM power state.
 - resource
Pool stringName  - Resource pool name to place vm.
 - shutdown
Timeout number - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - startup
Timeout number - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - virtual
Disks VMVirtualDisk[]  - VM virtual disks.
 - virtual
HWVer number - VM Virtual HW version.
 
- boot_
disk_ intsize  - VM boot disk size. Will expand boot disk to this size.
 - boot_
disk_ Disktype Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - boot_
firmware BootFirmware Type  - Boot type('efi' is boot uefi mode)
 - disk_
store str - esxi diskstore for boot disk.
 - id str
 - esxi vm id.
 - info
Sequence[Key
Value Pair]  - pass data to VM
 - ip_
address str - The IP address reported by VMWare tools.
 - mem_
size int - VM memory size.
 - name str
 - esxi vm name.
 - network_
interfaces Sequence[NetworkInterface]  - VM network interfaces.
 - notes str
 - VM memory size.
 - num_
v_ intcpus  - VM number of virtual cpus.
 - os str
 - VM OS type.
 - power str
 - VM power state.
 - resource_
pool_ strname  - Resource pool name to place vm.
 - shutdown_
timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - startup_
timeout int - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - virtual_
disks Sequence[VMVirtualDisk]  - VM virtual disks.
 - virtual_
hw_ intver  - VM Virtual HW version.
 
- boot
Disk NumberSize  - VM boot disk size. Will expand boot disk to this size.
 - boot
Disk "thin" | "zeroedthick" | "eagerzeroedthick"Type  - VM boot disk type. thin, zeroedthick, eagerzeroedthick
 - boot
Firmware "bios" | "efi" - Boot type('efi' is boot uefi mode)
 - disk
Store String - esxi diskstore for boot disk.
 - id String
 - esxi vm id.
 - info List<Property Map>
 - pass data to VM
 - ip
Address String - The IP address reported by VMWare tools.
 - mem
Size Number - VM memory size.
 - name String
 - esxi vm name.
 - network
Interfaces List<Property Map> - VM network interfaces.
 - notes String
 - VM memory size.
 - num
VCpus Number - VM number of virtual cpus.
 - os String
 - VM OS type.
 - power String
 - VM power state.
 - resource
Pool StringName  - Resource pool name to place vm.
 - shutdown
Timeout Number - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - startup
Timeout Number - The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
 - virtual
Disks List<Property Map> - VM virtual disks.
 - virtual
HWVer Number - VM Virtual HW version.
 
Supporting Types
BootFirmwareType  
DiskType 
KeyValuePair  
NetworkInterface 
- Virtual
Network string - Mac
Address string - Nic
Type string 
- Virtual
Network string - Mac
Address string - Nic
Type string 
- virtual
Network String - mac
Address String - nic
Type String 
- virtual
Network string - mac
Address string - nic
Type string 
- virtual_
network str - mac_
address str - nic_
type str 
- virtual
Network String - mac
Address String - nic
Type String 
VMVirtualDisk 
- Virtual
Disk stringId  - Slot string
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
- Virtual
Disk stringId  - Slot string
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
- virtual
Disk StringId  - slot String
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
- virtual
Disk stringId  - slot string
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
- virtual_
disk_ strid  - slot str
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
- virtual
Disk StringId  - slot String
 - SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
 
Package Details
- Repository
 - esxi-native pulumiverse/pulumi-esxi-native
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the Terraform Provider terraform-provider-esxi.