1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. getNode
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v7.13.0
published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves information about a specific Proxmox VE node.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const example = proxmoxve.getNode({
        nodeName: "pve",
    });
    export const dataProxmoxVirtualEnvironmentNode = {
        cpuCores: example.then(example => example.cpuCores),
        cpuCount: example.then(example => example.cpuCount),
        cpuSockets: example.then(example => example.cpuSockets),
        cpuModel: example.then(example => example.cpuModel),
        memoryTotal: example.then(example => example.memoryTotal),
        uptime: example.then(example => example.uptime),
    };
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    example = proxmoxve.get_node(node_name="pve")
    pulumi.export("dataProxmoxVirtualEnvironmentNode", {
        "cpuCores": example.cpu_cores,
        "cpuCount": example.cpu_count,
        "cpuSockets": example.cpu_sockets,
        "cpuModel": example.cpu_model,
        "memoryTotal": example.memory_total,
        "uptime": example.uptime,
    })
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := proxmoxve.GetNode(ctx, &proxmoxve.GetNodeArgs{
    			NodeName: "pve",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dataProxmoxVirtualEnvironmentNode", pulumi.Map{
    			"cpuCores":    example.CpuCores,
    			"cpuCount":    example.CpuCount,
    			"cpuSockets":  example.CpuSockets,
    			"cpuModel":    example.CpuModel,
    			"memoryTotal": example.MemoryTotal,
    			"uptime":      example.Uptime,
    		})
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var example = ProxmoxVE.GetNode.Invoke(new()
        {
            NodeName = "pve",
        });
    
        return new Dictionary<string, object?>
        {
            ["dataProxmoxVirtualEnvironmentNode"] = 
            {
                { "cpuCores", example.Apply(getNodeResult => getNodeResult.CpuCores) },
                { "cpuCount", example.Apply(getNodeResult => getNodeResult.CpuCount) },
                { "cpuSockets", example.Apply(getNodeResult => getNodeResult.CpuSockets) },
                { "cpuModel", example.Apply(getNodeResult => getNodeResult.CpuModel) },
                { "memoryTotal", example.Apply(getNodeResult => getNodeResult.MemoryTotal) },
                { "uptime", example.Apply(getNodeResult => getNodeResult.Uptime) },
            },
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.ProxmoxveFunctions;
    import com.pulumi.proxmoxve.inputs.GetNodeArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ProxmoxveFunctions.getNode(GetNodeArgs.builder()
                .nodeName("pve")
                .build());
    
            ctx.export("dataProxmoxVirtualEnvironmentNode", Map.ofEntries(
                Map.entry("cpuCores", example.cpuCores()),
                Map.entry("cpuCount", example.cpuCount()),
                Map.entry("cpuSockets", example.cpuSockets()),
                Map.entry("cpuModel", example.cpuModel()),
                Map.entry("memoryTotal", example.memoryTotal()),
                Map.entry("uptime", example.uptime())
            ));
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: proxmoxve:getNode
          arguments:
            nodeName: pve
    outputs:
      dataProxmoxVirtualEnvironmentNode:
        cpuCores: ${example.cpuCores}
        cpuCount: ${example.cpuCount}
        cpuSockets: ${example.cpuSockets}
        cpuModel: ${example.cpuModel}
        memoryTotal: ${example.memoryTotal}
        uptime: ${example.uptime}
    

    Using getNode

    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 getNode(args: GetNodeArgs, opts?: InvokeOptions): Promise<GetNodeResult>
    function getNodeOutput(args: GetNodeOutputArgs, opts?: InvokeOptions): Output<GetNodeResult>
    def get_node(node_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetNodeResult
    def get_node_output(node_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetNodeResult]
    func GetNode(ctx *Context, args *GetNodeArgs, opts ...InvokeOption) (*GetNodeResult, error)
    func GetNodeOutput(ctx *Context, args *GetNodeOutputArgs, opts ...InvokeOption) GetNodeResultOutput

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

    public static class GetNode 
    {
        public static Task<GetNodeResult> InvokeAsync(GetNodeArgs args, InvokeOptions? opts = null)
        public static Output<GetNodeResult> Invoke(GetNodeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNodeResult> getNode(GetNodeArgs args, InvokeOptions options)
    public static Output<GetNodeResult> getNode(GetNodeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:index/getNode:getNode
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NodeName string
    The node name
    NodeName string
    The node name
    nodeName String
    The node name
    nodeName string
    The node name
    node_name str
    The node name
    nodeName String
    The node name

    getNode Result

    The following output properties are available:

    CpuCores int
    The total number of physical CPU cores on the node
    CpuCount int
    The total number of logical CPUs on the node (sockets * cores * threads)
    CpuModel string
    The CPU model on the node
    CpuSockets int
    The number of CPU sockets on the node
    Id string
    The provider-assigned unique ID for this managed resource.
    MemoryAvailable int
    The available memory in bytes on the node
    MemoryTotal int
    The total memory in bytes on the node
    MemoryUsed int
    The used memory in bytes on the node
    NodeName string
    The node name
    Uptime int
    The uptime in seconds on the node
    CpuCores int
    The total number of physical CPU cores on the node
    CpuCount int
    The total number of logical CPUs on the node (sockets * cores * threads)
    CpuModel string
    The CPU model on the node
    CpuSockets int
    The number of CPU sockets on the node
    Id string
    The provider-assigned unique ID for this managed resource.
    MemoryAvailable int
    The available memory in bytes on the node
    MemoryTotal int
    The total memory in bytes on the node
    MemoryUsed int
    The used memory in bytes on the node
    NodeName string
    The node name
    Uptime int
    The uptime in seconds on the node
    cpuCores Integer
    The total number of physical CPU cores on the node
    cpuCount Integer
    The total number of logical CPUs on the node (sockets * cores * threads)
    cpuModel String
    The CPU model on the node
    cpuSockets Integer
    The number of CPU sockets on the node
    id String
    The provider-assigned unique ID for this managed resource.
    memoryAvailable Integer
    The available memory in bytes on the node
    memoryTotal Integer
    The total memory in bytes on the node
    memoryUsed Integer
    The used memory in bytes on the node
    nodeName String
    The node name
    uptime Integer
    The uptime in seconds on the node
    cpuCores number
    The total number of physical CPU cores on the node
    cpuCount number
    The total number of logical CPUs on the node (sockets * cores * threads)
    cpuModel string
    The CPU model on the node
    cpuSockets number
    The number of CPU sockets on the node
    id string
    The provider-assigned unique ID for this managed resource.
    memoryAvailable number
    The available memory in bytes on the node
    memoryTotal number
    The total memory in bytes on the node
    memoryUsed number
    The used memory in bytes on the node
    nodeName string
    The node name
    uptime number
    The uptime in seconds on the node
    cpu_cores int
    The total number of physical CPU cores on the node
    cpu_count int
    The total number of logical CPUs on the node (sockets * cores * threads)
    cpu_model str
    The CPU model on the node
    cpu_sockets int
    The number of CPU sockets on the node
    id str
    The provider-assigned unique ID for this managed resource.
    memory_available int
    The available memory in bytes on the node
    memory_total int
    The total memory in bytes on the node
    memory_used int
    The used memory in bytes on the node
    node_name str
    The node name
    uptime int
    The uptime in seconds on the node
    cpuCores Number
    The total number of physical CPU cores on the node
    cpuCount Number
    The total number of logical CPUs on the node (sockets * cores * threads)
    cpuModel String
    The CPU model on the node
    cpuSockets Number
    The number of CPU sockets on the node
    id String
    The provider-assigned unique ID for this managed resource.
    memoryAvailable Number
    The available memory in bytes on the node
    memoryTotal Number
    The total memory in bytes on the node
    memoryUsed Number
    The used memory in bytes on the node
    nodeName String
    The node name
    uptime Number
    The uptime in seconds on the node

    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) v7.13.0
    published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
      Try Pulumi Cloud free. Your team will thank you.