getVm

Proxmox Virtual Environment (Proxmox VE) v8.0.0, Apr 5 26

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

Using getVm

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVm(args: GetVmArgs, opts?: InvokeOptions): Promise<GetVmResult>
function getVmOutput(args: GetVmOutputArgs, opts?: InvokeOptions): Output<GetVmResult>

def get_vm(cpu: Optional[GetVmCpu] = None,
           description: Optional[str] = None,
           id: Optional[int] = None,
           name: Optional[str] = None,
           node_name: Optional[str] = None,
           rng: Optional[GetVmRng] = None,
           tags: Optional[Sequence[str]] = None,
           template: Optional[bool] = None,
           timeouts: Optional[GetVmTimeouts] = None,
           vga: Optional[GetVmVga] = None,
           opts: Optional[InvokeOptions] = None) -> GetVmResult
def get_vm_output(cpu: Optional[pulumi.Input[GetVmCpuArgs]] = None,
           description: Optional[pulumi.Input[str]] = None,
           id: Optional[pulumi.Input[int]] = None,
           name: Optional[pulumi.Input[str]] = None,
           node_name: Optional[pulumi.Input[str]] = None,
           rng: Optional[pulumi.Input[GetVmRngArgs]] = None,
           tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
           template: Optional[pulumi.Input[bool]] = None,
           timeouts: Optional[pulumi.Input[GetVmTimeoutsArgs]] = None,
           vga: Optional[pulumi.Input[GetVmVgaArgs]] = None,
           opts: Optional[InvokeOptions] = None) -> Output[GetVmResult]

func LookupVm(ctx *Context, args *LookupVmArgs, opts ...InvokeOption) (*LookupVmResult, error)
func LookupVmOutput(ctx *Context, args *LookupVmOutputArgs, opts ...InvokeOption) LookupVmResultOutput

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

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

public static CompletableFuture<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)
public static Output<GetVmResult> getVm(GetVmArgs args, InvokeOptions options)

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

The following arguments are supported:

Id int: The unique identifier of the VM in the Proxmox cluster.
NodeName string: The name of the node where the VM is provisioned.
Cpu Pulumi.ProxmoxVE.Inputs.GetVmCpu: The CPU configuration.
Description string: The description of the VM.
Name string: The name of the VM.
Rng Pulumi.ProxmoxVE.Inputs.GetVmRng: The RNG (Random Number Generator) configuration.
Tags List<string>: The tags assigned to the VM.
Template bool: Whether the VM is a template.
Timeouts Pulumi.ProxmoxVE.Inputs.GetVmTimeouts
Vga Pulumi.ProxmoxVE.Inputs.GetVmVga: The VGA configuration.

Id int: The unique identifier of the VM in the Proxmox cluster.
NodeName string: The name of the node where the VM is provisioned.
Cpu GetVmCpu: The CPU configuration.
Description string: The description of the VM.
Name string: The name of the VM.
Rng GetVmRng: The RNG (Random Number Generator) configuration.
Tags []string: The tags assigned to the VM.
Template bool: Whether the VM is a template.
Timeouts GetVmTimeouts
Vga GetVmVga: The VGA configuration.

id Integer: The unique identifier of the VM in the Proxmox cluster.
nodeName String: The name of the node where the VM is provisioned.
cpu GetVmCpu: The CPU configuration.
description String: The description of the VM.
name String: The name of the VM.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags List<String>: The tags assigned to the VM.
template Boolean: Whether the VM is a template.
timeouts GetVmTimeouts
vga GetVmVga: The VGA configuration.

id number: The unique identifier of the VM in the Proxmox cluster.
nodeName string: The name of the node where the VM is provisioned.
cpu GetVmCpu: The CPU configuration.
description string: The description of the VM.
name string: The name of the VM.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags string[]: The tags assigned to the VM.
template boolean: Whether the VM is a template.
timeouts GetVmTimeouts
vga GetVmVga: The VGA configuration.

id int: The unique identifier of the VM in the Proxmox cluster.
node_name str: The name of the node where the VM is provisioned.
cpu GetVmCpu: The CPU configuration.
description str: The description of the VM.
name str: The name of the VM.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags Sequence[str]: The tags assigned to the VM.
template bool: Whether the VM is a template.
timeouts GetVmTimeouts
vga GetVmVga: The VGA configuration.

id Number: The unique identifier of the VM in the Proxmox cluster.
nodeName String: The name of the node where the VM is provisioned.
cpu Property Map: The CPU configuration.
description String: The description of the VM.
name String: The name of the VM.
rng Property Map: The RNG (Random Number Generator) configuration.
tags List<String>: The tags assigned to the VM.
template Boolean: Whether the VM is a template.
timeouts Property Map
vga Property Map: The VGA configuration.

getVm Result

The following output properties are available:

Cpu Pulumi.ProxmoxVE.Outputs.GetVmCpu: The CPU configuration.
Id int: The unique identifier of the VM in the Proxmox cluster.
NodeName string: The name of the node where the VM is provisioned.
Rng Pulumi.ProxmoxVE.Outputs.GetVmRng: The RNG (Random Number Generator) configuration.
Tags List<string>: The tags assigned to the VM.
Vga Pulumi.ProxmoxVE.Outputs.GetVmVga: The VGA configuration.
Description string: The description of the VM.
Name string: The name of the VM.
Template bool: Whether the VM is a template.
Timeouts Pulumi.ProxmoxVE.Outputs.GetVmTimeouts

Cpu GetVmCpu: The CPU configuration.
Id int: The unique identifier of the VM in the Proxmox cluster.
NodeName string: The name of the node where the VM is provisioned.
Rng GetVmRng: The RNG (Random Number Generator) configuration.
Tags []string: The tags assigned to the VM.
Vga GetVmVga: The VGA configuration.
Description string: The description of the VM.
Name string: The name of the VM.
Template bool: Whether the VM is a template.
Timeouts GetVmTimeouts

cpu GetVmCpu: The CPU configuration.
id Integer: The unique identifier of the VM in the Proxmox cluster.
nodeName String: The name of the node where the VM is provisioned.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags List<String>: The tags assigned to the VM.
vga GetVmVga: The VGA configuration.
description String: The description of the VM.
name String: The name of the VM.
template Boolean: Whether the VM is a template.
timeouts GetVmTimeouts

cpu GetVmCpu: The CPU configuration.
id number: The unique identifier of the VM in the Proxmox cluster.
nodeName string: The name of the node where the VM is provisioned.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags string[]: The tags assigned to the VM.
vga GetVmVga: The VGA configuration.
description string: The description of the VM.
name string: The name of the VM.
template boolean: Whether the VM is a template.
timeouts GetVmTimeouts

cpu GetVmCpu: The CPU configuration.
id int: The unique identifier of the VM in the Proxmox cluster.
node_name str: The name of the node where the VM is provisioned.
rng GetVmRng: The RNG (Random Number Generator) configuration.
tags Sequence[str]: The tags assigned to the VM.
vga GetVmVga: The VGA configuration.
description str: The description of the VM.
name str: The name of the VM.
template bool: Whether the VM is a template.
timeouts GetVmTimeouts

cpu Property Map: The CPU configuration.
id Number: The unique identifier of the VM in the Proxmox cluster.
nodeName String: The name of the node where the VM is provisioned.
rng Property Map: The RNG (Random Number Generator) configuration.
tags List<String>: The tags assigned to the VM.
vga Property Map: The VGA configuration.
description String: The description of the VM.
name String: The name of the VM.
template Boolean: Whether the VM is a template.
timeouts Property Map

Supporting Types

GetVmCpu

Affinity string: List of host cores used to execute guest processes, for example: '0,5,8-11'
Architecture string: The CPU architecture.
Cores int: The number of CPU cores per socket.
Flags List<string>: Set of additional CPU flags.
Hotplugged int: The number of hotplugged vCPUs.
Limit double: Limit of CPU usage.
Numa bool: Enable NUMA.
Sockets int: The number of CPU sockets.
Type string: Emulated CPU type.
Units int: CPU weight for a VM

Affinity string: List of host cores used to execute guest processes, for example: '0,5,8-11'
Architecture string: The CPU architecture.
Cores int: The number of CPU cores per socket.
Flags []string: Set of additional CPU flags.
Hotplugged int: The number of hotplugged vCPUs.
Limit float64: Limit of CPU usage.
Numa bool: Enable NUMA.
Sockets int: The number of CPU sockets.
Type string: Emulated CPU type.
Units int: CPU weight for a VM

affinity String: List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture String: The CPU architecture.
cores Integer: The number of CPU cores per socket.
flags List<String>: Set of additional CPU flags.
hotplugged Integer: The number of hotplugged vCPUs.
limit Double: Limit of CPU usage.
numa Boolean: Enable NUMA.
sockets Integer: The number of CPU sockets.
type String: Emulated CPU type.
units Integer: CPU weight for a VM

affinity string: List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture string: The CPU architecture.
cores number: The number of CPU cores per socket.
flags string[]: Set of additional CPU flags.
hotplugged number: The number of hotplugged vCPUs.
limit number: Limit of CPU usage.
numa boolean: Enable NUMA.
sockets number: The number of CPU sockets.
type string: Emulated CPU type.
units number: CPU weight for a VM

affinity str: List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture str: The CPU architecture.
cores int: The number of CPU cores per socket.
flags Sequence[str]: Set of additional CPU flags.
hotplugged int: The number of hotplugged vCPUs.
limit float: Limit of CPU usage.
numa bool: Enable NUMA.
sockets int: The number of CPU sockets.
type str: Emulated CPU type.
units int: CPU weight for a VM

affinity String: List of host cores used to execute guest processes, for example: '0,5,8-11'
architecture String: The CPU architecture.
cores Number: The number of CPU cores per socket.
flags List<String>: Set of additional CPU flags.
hotplugged Number: The number of hotplugged vCPUs.
limit Number: Limit of CPU usage.
numa Boolean: Enable NUMA.
sockets Number: The number of CPU sockets.
type String: Emulated CPU type.
units Number: CPU weight for a VM

GetVmRng

MaxBytes int: Maximum bytes of entropy allowed to get injected into the guest every period.
Period int: Period in milliseconds to limit entropy injection to the guest.
Source string: The entropy source for the RNG device.

MaxBytes int: Maximum bytes of entropy allowed to get injected into the guest every period.
Period int: Period in milliseconds to limit entropy injection to the guest.
Source string: The entropy source for the RNG device.

maxBytes Integer: Maximum bytes of entropy allowed to get injected into the guest every period.
period Integer: Period in milliseconds to limit entropy injection to the guest.
source String: The entropy source for the RNG device.

maxBytes number: Maximum bytes of entropy allowed to get injected into the guest every period.
period number: Period in milliseconds to limit entropy injection to the guest.
source string: The entropy source for the RNG device.

max_bytes int: Maximum bytes of entropy allowed to get injected into the guest every period.
period int: Period in milliseconds to limit entropy injection to the guest.
source str: The entropy source for the RNG device.

maxBytes Number: Maximum bytes of entropy allowed to get injected into the guest every period.
period Number: Period in milliseconds to limit entropy injection to the guest.
source String: The entropy source for the RNG device.

GetVmTimeouts

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

GetVmVga

Clipboard string: Enable a specific clipboard.
Memory int: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
Type string: The VGA type.

Clipboard string: Enable a specific clipboard.
Memory int: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
Type string: The VGA type.

clipboard String: Enable a specific clipboard.
memory Integer: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type String: The VGA type.

clipboard string: Enable a specific clipboard.
memory number: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type string: The VGA type.

clipboard str: Enable a specific clipboard.
memory int: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type str: The VGA type.

clipboard String: Enable a specific clipboard.
memory Number: The VGA memory in megabytes (4-512 MB). Has no effect with serial display.
type String: The VGA type.

Package Details

Repository: proxmoxve muhlba91/pulumi-proxmoxve
License: Apache-2.0
Notes: This Pulumi package is based on the proxmox Terraform Provider.

Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski

Schema (JSON)

muhlba91/pulumi-proxmoxve

proxmoxve.getVm

On this page

On this page

Using getVm

getVm Result

Supporting Types

GetVmCpu

GetVmRng

GetVmTimeouts

GetVmVga

Package Details

On this page

On this page