1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. node
  6. getConfig
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.3.0
published on Sunday, Jul 5, 2026 by Daniel Muehlbachler-Pietrzykowski
proxmoxve logo
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.3.0
published on Sunday, Jul 5, 2026 by Daniel Muehlbachler-Pietrzykowski

    Retrieves configuration of a Proxmox VE node.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    
    const example = proxmoxve.node.getConfig({
        nodeName: "pve",
    });
    export const proxmoxNodeConfigDescription = example.then(example => example.description);
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    
    example = proxmoxve.node.get_config(node_name="pve")
    pulumi.export("proxmoxNodeConfigDescription", example.description)
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve/node"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := node.LookupConfig(ctx, &node.LookupConfigArgs{
    			NodeName: "pve",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("proxmoxNodeConfigDescription", example.Description)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    
    return await Deployment.RunAsync(() => 
    {
        var example = ProxmoxVE.Node.GetConfig.Invoke(new()
        {
            NodeName = "pve",
        });
    
        return new Dictionary<string, object?>
        {
            ["proxmoxNodeConfigDescription"] = example.Apply(getConfigResult => getConfigResult.Description),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.proxmoxve.node.NodeFunctions;
    import com.pulumi.proxmoxve.node.inputs.GetConfigArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 = NodeFunctions.getConfig(GetConfigArgs.builder()
                .nodeName("pve")
                .build());
    
            ctx.export("proxmoxNodeConfigDescription", example.description());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: proxmoxve:node:getConfig
          arguments:
            nodeName: pve
    outputs:
      proxmoxNodeConfigDescription: ${example.description}
    
    pulumi {
      required_providers {
        proxmoxve = {
          source = "pulumi/proxmoxve"
        }
      }
    }
    
    data "proxmoxve_node_getconfig" "example" {
      node_name = "pve"
    }
    
    output "proxmoxNodeConfigDescription" {
      value = data.proxmoxve_node_getconfig.example.description
    }
    

    Using getConfig

    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 getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
    function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>
    def get_config(node_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConfigResult
    def get_config_output(node_name: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]
    func LookupConfig(ctx *Context, args *LookupConfigArgs, opts ...InvokeOption) (*LookupConfigResult, error)
    func LookupConfigOutput(ctx *Context, args *LookupConfigOutputArgs, opts ...InvokeOption) LookupConfigResultOutput

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

    public static class GetConfig 
    {
        public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    public static Output<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
    
    fn::invoke:
      function: proxmoxve:node/getConfig:getConfig
      arguments:
        # arguments dictionary
    data "proxmoxve_node_getconfig" "name" {
        # arguments
    }

    The following arguments are supported:

    NodeName string
    The name of the node.
    NodeName string
    The name of the node.
    node_name string
    The name of the node.
    nodeName String
    The name of the node.
    nodeName string
    The name of the node.
    node_name str
    The name of the node.
    nodeName String
    The name of the node.

    getConfig Result

    The following output properties are available:

    Description string
    Description of the node. Shown in the web-interface node notes panel.
    Id string
    The ID of this resource.
    NodeName string
    The name of the node.
    Description string
    Description of the node. Shown in the web-interface node notes panel.
    Id string
    The ID of this resource.
    NodeName string
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel.
    id string
    The ID of this resource.
    node_name string
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel.
    id String
    The ID of this resource.
    nodeName String
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel.
    id string
    The ID of this resource.
    nodeName string
    The name of the node.
    description str
    Description of the node. Shown in the web-interface node notes panel.
    id str
    The ID of this resource.
    node_name str
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel.
    id String
    The ID of this resource.
    nodeName String
    The name of 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) v8.3.0
    published on Sunday, Jul 5, 2026 by Daniel Muehlbachler-Pietrzykowski

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial