1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. getVm
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.getVm

proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Retrieves information about a specific VM.

    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(id: Optional[int] = None,
           node_name: Optional[str] = None,
           timeouts: Optional[GetVmTimeouts] = None,
           opts: Optional[InvokeOptions] = None) -> GetVmResult
def get_vm_output(id: Optional[pulumi.Input[int]] = None,
           node_name: Optional[pulumi.Input[str]] = None,
           timeouts: Optional[pulumi.Input[GetVmTimeoutsArgs]] = 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.
    Timeouts Pulumi.ProxmoxVE.Inputs.GetVmTimeouts
    Id int
    The unique identifier of the VM in the Proxmox cluster.
    NodeName string
    The name of the node where the VM is provisioned.
    Timeouts GetVmTimeouts
    id Integer
    The unique identifier of the VM in the Proxmox cluster.
    nodeName String
    The name of the node where the VM is provisioned.
    timeouts GetVmTimeouts
    id number
    The unique identifier of the VM in the Proxmox cluster.
    nodeName string
    The name of the node where the VM is provisioned.
    timeouts GetVmTimeouts
    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.
    timeouts GetVmTimeouts
    id Number
    The unique identifier of the VM in the Proxmox cluster.
    nodeName String
    The name of the node where the VM is provisioned.
    timeouts Property Map

    getVm Result

    The following output properties are available:

    Cdrom Dictionary<string, Pulumi.ProxmoxVE.Outputs.GetVmCdrom>
    The CD-ROM configuration.
    Cpu Pulumi.ProxmoxVE.Outputs.GetVmCpu
    The CPU configuration.
    Description string
    The description of the VM.
    Id int
    The unique identifier of the VM in the Proxmox cluster.
    Name string
    The name of the VM.
    NodeName string
    The name of the node where the VM is provisioned.
    Rng Pulumi.ProxmoxVE.Outputs.GetVmRng
    The RNG (Random Number Generator) configuration.
    Status string
    The status of the VM (e.g., running, stopped).
    Tags List<string>
    The tags assigned to the VM.
    Template bool
    Whether the VM is a template.
    Vga Pulumi.ProxmoxVE.Outputs.GetVmVga
    The VGA configuration.
    Timeouts Pulumi.ProxmoxVE.Outputs.GetVmTimeouts
    Cdrom map[string]GetVmCdrom
    The CD-ROM configuration.
    Cpu GetVmCpu
    The CPU configuration.
    Description string
    The description of the VM.
    Id int
    The unique identifier of the VM in the Proxmox cluster.
    Name string
    The name of the VM.
    NodeName string
    The name of the node where the VM is provisioned.
    Rng GetVmRng
    The RNG (Random Number Generator) configuration.
    Status string
    The status of the VM (e.g., running, stopped).
    Tags []string
    The tags assigned to the VM.
    Template bool
    Whether the VM is a template.
    Vga GetVmVga
    The VGA configuration.
    Timeouts GetVmTimeouts
    cdrom Map<String,GetVmCdrom>
    The CD-ROM configuration.
    cpu GetVmCpu
    The CPU configuration.
    description String
    The description of the VM.
    id Integer
    The unique identifier of the VM in the Proxmox cluster.
    name String
    The name of the VM.
    nodeName String
    The name of the node where the VM is provisioned.
    rng GetVmRng
    The RNG (Random Number Generator) configuration.
    status String
    The status of the VM (e.g., running, stopped).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Whether the VM is a template.
    vga GetVmVga
    The VGA configuration.
    timeouts GetVmTimeouts
    cdrom {[key: string]: GetVmCdrom}
    The CD-ROM configuration.
    cpu GetVmCpu
    The CPU configuration.
    description string
    The description of the VM.
    id number
    The unique identifier of the VM in the Proxmox cluster.
    name string
    The name of the VM.
    nodeName string
    The name of the node where the VM is provisioned.
    rng GetVmRng
    The RNG (Random Number Generator) configuration.
    status string
    The status of the VM (e.g., running, stopped).
    tags string[]
    The tags assigned to the VM.
    template boolean
    Whether the VM is a template.
    vga GetVmVga
    The VGA configuration.
    timeouts GetVmTimeouts
    cdrom Mapping[str, GetVmCdrom]
    The CD-ROM configuration.
    cpu GetVmCpu
    The CPU configuration.
    description str
    The description of the VM.
    id int
    The unique identifier of the VM in the Proxmox cluster.
    name str
    The name of the VM.
    node_name str
    The name of the node where the VM is provisioned.
    rng GetVmRng
    The RNG (Random Number Generator) configuration.
    status str
    The status of the VM (e.g., running, stopped).
    tags Sequence[str]
    The tags assigned to the VM.
    template bool
    Whether the VM is a template.
    vga GetVmVga
    The VGA configuration.
    timeouts GetVmTimeouts
    cdrom Map<Property Map>
    The CD-ROM configuration.
    cpu Property Map
    The CPU configuration.
    description String
    The description of the VM.
    id Number
    The unique identifier of the VM in the Proxmox cluster.
    name String
    The name of the VM.
    nodeName String
    The name of the node where the VM is provisioned.
    rng Property Map
    The RNG (Random Number Generator) configuration.
    status String
    The status of the VM (e.g., running, stopped).
    tags List<String>
    The tags assigned to the VM.
    template Boolean
    Whether the VM is a template.
    vga Property Map
    The VGA configuration.
    timeouts Property Map

    Supporting Types

    GetVmCdrom

    FileId string
    The file ID of the CD-ROM.
    FileId string
    The file ID of the CD-ROM.
    fileId String
    The file ID of the CD-ROM.
    fileId string
    The file ID of the CD-ROM.
    file_id str
    The file ID of the CD-ROM.
    fileId String
    The file ID of the CD-ROM.

    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.
    Limit double
    Limit of CPU usage.
    Numa bool
    Whether NUMA emulation is enabled.
    Sockets int
    The number of CPU sockets.
    Type string
    Emulated CPU type.
    Units int
    CPU weight for a VM
    Vcpus int
    Number of active vCPUs.
    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.
    Limit float64
    Limit of CPU usage.
    Numa bool
    Whether NUMA emulation is enabled.
    Sockets int
    The number of CPU sockets.
    Type string
    Emulated CPU type.
    Units int
    CPU weight for a VM
    Vcpus int
    Number of active vCPUs.
    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.
    limit Double
    Limit of CPU usage.
    numa Boolean
    Whether NUMA emulation is enabled.
    sockets Integer
    The number of CPU sockets.
    type String
    Emulated CPU type.
    units Integer
    CPU weight for a VM
    vcpus Integer
    Number of active vCPUs.
    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.
    limit number
    Limit of CPU usage.
    numa boolean
    Whether NUMA emulation is enabled.
    sockets number
    The number of CPU sockets.
    type string
    Emulated CPU type.
    units number
    CPU weight for a VM
    vcpus number
    Number of active vCPUs.
    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.
    limit float
    Limit of CPU usage.
    numa bool
    Whether NUMA emulation is enabled.
    sockets int
    The number of CPU sockets.
    type str
    Emulated CPU type.
    units int
    CPU weight for a VM
    vcpus int
    Number of active vCPUs.
    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.
    limit Number
    Limit of CPU usage.
    numa Boolean
    Whether NUMA emulation is enabled.
    sockets Number
    The number of CPU sockets.
    type String
    Emulated CPU type.
    units Number
    CPU weight for a VM
    vcpus Number
    Number of active vCPUs.

    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.
    proxmoxve logo
    Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.1.0
    published on Sunday, Apr 26, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Try Pulumi Cloud free. Your team will thank you.