1. Packages
  2. ESXi Native
  3. API Docs
  4. getVirtualMachine
ESXi Native v1.0.0 published on Monday, Aug 28, 2023 by pulumiverse

esxi-native.getVirtualMachine

Explore with Pulumi AI

esxi-native logo
ESXi Native v1.0.0 published on Monday, Aug 28, 2023 by pulumiverse

    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 dictionary

    The 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:

    BootDiskSize int
    VM boot disk size. Will expand boot disk to this size.
    BootDiskType Pulumiverse.EsxiNative.DiskType
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    BootFirmware Pulumiverse.EsxiNative.BootFirmwareType
    Boot type('efi' is boot uefi mode)
    DiskStore string
    esxi diskstore for boot disk.
    Id string
    esxi vm id.
    Info List<Pulumiverse.EsxiNative.Outputs.KeyValuePair>
    pass data to VM
    IpAddress string
    The IP address reported by VMWare tools.
    MemSize int
    VM memory size.
    Name string
    esxi vm name.
    NetworkInterfaces List<Pulumiverse.EsxiNative.Outputs.NetworkInterface>
    VM network interfaces.
    Notes string
    VM memory size.
    NumVCpus int
    VM number of virtual cpus.
    Os string
    VM OS type.
    Power string
    VM power state.
    ResourcePoolName string
    Resource pool name to place vm.
    ShutdownTimeout int
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    StartupTimeout int
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    VirtualDisks List<Pulumiverse.EsxiNative.Outputs.VMVirtualDisk>
    VM virtual disks.
    VirtualHWVer int
    VM Virtual HW version.
    BootDiskSize int
    VM boot disk size. Will expand boot disk to this size.
    BootDiskType DiskType
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    BootFirmware BootFirmwareType
    Boot type('efi' is boot uefi mode)
    DiskStore string
    esxi diskstore for boot disk.
    Id string
    esxi vm id.
    Info []KeyValuePair
    pass data to VM
    IpAddress string
    The IP address reported by VMWare tools.
    MemSize int
    VM memory size.
    Name string
    esxi vm name.
    NetworkInterfaces []NetworkInterface
    VM network interfaces.
    Notes string
    VM memory size.
    NumVCpus int
    VM number of virtual cpus.
    Os string
    VM OS type.
    Power string
    VM power state.
    ResourcePoolName string
    Resource pool name to place vm.
    ShutdownTimeout int
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    StartupTimeout int
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    VirtualDisks []VMVirtualDisk
    VM virtual disks.
    VirtualHWVer int
    VM Virtual HW version.
    bootDiskSize Integer
    VM boot disk size. Will expand boot disk to this size.
    bootDiskType DiskType
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    bootFirmware BootFirmwareType
    Boot type('efi' is boot uefi mode)
    diskStore String
    esxi diskstore for boot disk.
    id String
    esxi vm id.
    info List<KeyValuePair>
    pass data to VM
    ipAddress String
    The IP address reported by VMWare tools.
    memSize Integer
    VM memory size.
    name String
    esxi vm name.
    networkInterfaces List<NetworkInterface>
    VM network interfaces.
    notes String
    VM memory size.
    numVCpus Integer
    VM number of virtual cpus.
    os String
    VM OS type.
    power String
    VM power state.
    resourcePoolName String
    Resource pool name to place vm.
    shutdownTimeout Integer
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    startupTimeout Integer
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    virtualDisks List<VMVirtualDisk>
    VM virtual disks.
    virtualHWVer Integer
    VM Virtual HW version.
    bootDiskSize number
    VM boot disk size. Will expand boot disk to this size.
    bootDiskType DiskType
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    bootFirmware BootFirmwareType
    Boot type('efi' is boot uefi mode)
    diskStore string
    esxi diskstore for boot disk.
    id string
    esxi vm id.
    info KeyValuePair[]
    pass data to VM
    ipAddress string
    The IP address reported by VMWare tools.
    memSize number
    VM memory size.
    name string
    esxi vm name.
    networkInterfaces NetworkInterface[]
    VM network interfaces.
    notes string
    VM memory size.
    numVCpus number
    VM number of virtual cpus.
    os string
    VM OS type.
    power string
    VM power state.
    resourcePoolName string
    Resource pool name to place vm.
    shutdownTimeout number
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    startupTimeout number
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    virtualDisks VMVirtualDisk[]
    VM virtual disks.
    virtualHWVer number
    VM Virtual HW version.
    boot_disk_size int
    VM boot disk size. Will expand boot disk to this size.
    boot_disk_type DiskType
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    boot_firmware BootFirmwareType
    Boot type('efi' is boot uefi mode)
    disk_store str
    esxi diskstore for boot disk.
    id str
    esxi vm id.
    info Sequence[KeyValuePair]
    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_cpus int
    VM number of virtual cpus.
    os str
    VM OS type.
    power str
    VM power state.
    resource_pool_name str
    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_ver int
    VM Virtual HW version.
    bootDiskSize Number
    VM boot disk size. Will expand boot disk to this size.
    bootDiskType "thin" | "zeroedthick" | "eagerzeroedthick"
    VM boot disk type. thin, zeroedthick, eagerzeroedthick
    bootFirmware "bios" | "efi"
    Boot type('efi' is boot uefi mode)
    diskStore String
    esxi diskstore for boot disk.
    id String
    esxi vm id.
    info List<Property Map>
    pass data to VM
    ipAddress String
    The IP address reported by VMWare tools.
    memSize Number
    VM memory size.
    name String
    esxi vm name.
    networkInterfaces List<Property Map>
    VM network interfaces.
    notes String
    VM memory size.
    numVCpus Number
    VM number of virtual cpus.
    os String
    VM OS type.
    power String
    VM power state.
    resourcePoolName String
    Resource pool name to place vm.
    shutdownTimeout Number
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    startupTimeout Number
    The amount of vm uptime, in seconds, to wait for an available IP address on this virtual machine.
    virtualDisks List<Property Map>
    VM virtual disks.
    virtualHWVer Number
    VM Virtual HW version.

    Supporting Types

    BootFirmwareType

    DiskType

    KeyValuePair

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    NetworkInterface

    VirtualNetwork string
    MacAddress string
    NicType string
    VirtualNetwork string
    MacAddress string
    NicType string
    virtualNetwork String
    macAddress String
    nicType String
    virtualNetwork string
    macAddress string
    nicType string
    virtualNetwork String
    macAddress String
    nicType String

    VMVirtualDisk

    VirtualDiskId string
    Slot string
    SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
    VirtualDiskId string
    Slot string
    SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
    virtualDiskId String
    slot String
    SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
    virtualDiskId string
    slot string
    SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
    virtual_disk_id str
    slot str
    SCSI_Ctrl:SCSI_id. Range '0:1' to '0:15'. SCSI_id 7 is not allowed.
    virtualDiskId String
    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.
    esxi-native logo
    ESXi Native v1.0.0 published on Monday, Aug 28, 2023 by pulumiverse