1. Packages
  2. Packages
  3. Proxmox Virtual Environment (Proxmox VE)
  4. API Docs
  5. node
  6. Config
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

    Manages Proxmox VE node configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
    import * as std from "@pulumi/std";
    
    const example = new proxmoxve.node.Config("example", {
        nodeName: "pve",
        description: "Managed by Pulumi",
    });
    const multiline = new proxmoxve.node.Config("multiline", {
        nodeName: "pve2",
        description: std.trimspace({
            input: `Managed by Terraform.
    
    Owner: ops@example.com
    Role: storage
    `,
        }).then(invoke => invoke.result),
    });
    
    import pulumi
    import pulumi_proxmoxve as proxmoxve
    import pulumi_std as std
    
    example = proxmoxve.node.Config("example",
        node_name="pve",
        description="Managed by Pulumi")
    multiline = proxmoxve.node.Config("multiline",
        node_name="pve2",
        description=std.trimspace(input="""Managed by Terraform.
    
    Owner: ops@example.com
    Role: storage
    """).result)
    
    package main
    
    import (
    	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve/node"
    	"github.com/pulumi/pulumi-std/sdk/v2/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := node.NewConfig(ctx, "example", &node.ConfigArgs{
    			NodeName:    pulumi.String("pve"),
    			Description: pulumi.String("Managed by Pulumi"),
    		})
    		if err != nil {
    			return err
    		}
    		invokeTrimspace, err := std.Trimspace(ctx, &std.TrimspaceArgs{
    			Input: "Managed by Terraform.\n\nOwner: ops@example.com\nRole: storage\n",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = node.NewConfig(ctx, "multiline", &node.ConfigArgs{
    			NodeName:    pulumi.String("pve2"),
    			Description: pulumi.String(invokeTrimspace.Result),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ProxmoxVE = Pulumi.ProxmoxVE;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new ProxmoxVE.Node.Config("example", new()
        {
            NodeName = "pve",
            Description = "Managed by Pulumi",
        });
    
        var multiline = new ProxmoxVE.Node.Config("multiline", new()
        {
            NodeName = "pve2",
            Description = Std.Trimspace.Invoke(new()
            {
                Input = @"Managed by Terraform.
    
    Owner: ops@example.com
    Role: storage
    ",
            }).Apply(invoke => invoke.Result),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import io.muehlbachler.pulumi.proxmoxve.node.Config;
    import io.muehlbachler.pulumi.proxmoxve.node.ConfigArgs;
    import com.pulumi.std.StdFunctions;
    import com.pulumi.std.inputs.TrimspaceArgs;
    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) {
            var example = new Config("example", ConfigArgs.builder()
                .nodeName("pve")
                .description("Managed by Pulumi")
                .build());
    
            var multiline = new Config("multiline", ConfigArgs.builder()
                .nodeName("pve2")
                .description(StdFunctions.trimspace(TrimspaceArgs.builder()
                    .input("""
    Managed by Terraform.
    
    Owner: ops@example.com
    Role: storage
                    """)
                    .build()).result())
                .build());
    
        }
    }
    
    resources:
      example:
        type: proxmoxve:node:Config
        properties:
          nodeName: pve
          description: Managed by Pulumi
      multiline:
        type: proxmoxve:node:Config
        properties:
          nodeName: pve2
          description:
            fn::invoke:
              function: std:trimspace
              arguments:
                input: |
                  Managed by Terraform.
    
                  Owner: ops@example.com
                  Role: storage
              return: result
    
    pulumi {
      required_providers {
        proxmoxve = {
          source = "pulumi/proxmoxve"
        }
        std = {
          source = "pulumi/std"
        }
      }
    }
    
    resource "proxmoxve_node_config" "example" {
      node_name   = "pve"
      description = "Managed by Pulumi"
    }
    resource "proxmoxve_node_config" "multiline" {
      node_name   = "pve2"
      description = trimspace("Managed by Terraform.\n\nOwner: ops@example.com\nRole: storage\n")
    }
    

    Create Config Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Config(name: string, args: ConfigArgs, opts?: CustomResourceOptions);
    @overload
    def Config(resource_name: str,
               args: ConfigArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Config(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               node_name: Optional[str] = None,
               description: Optional[str] = None)
    func NewConfig(ctx *Context, name string, args ConfigArgs, opts ...ResourceOption) (*Config, error)
    public Config(string name, ConfigArgs args, CustomResourceOptions? opts = null)
    public Config(String name, ConfigArgs args)
    public Config(String name, ConfigArgs args, CustomResourceOptions options)
    
    type: proxmoxve:node:Config
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "proxmoxve_node_config" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var configResource = new ProxmoxVE.Node.Config("configResource", new()
    {
        NodeName = "string",
        Description = "string",
    });
    
    example, err := node.NewConfig(ctx, "configResource", &node.ConfigArgs{
    	NodeName:    pulumi.String("string"),
    	Description: pulumi.String("string"),
    })
    
    resource "proxmoxve_node_config" "configResource" {
      node_name   = "string"
      description = "string"
    }
    
    var configResource = new Config("configResource", ConfigArgs.builder()
        .nodeName("string")
        .description("string")
        .build());
    
    config_resource = proxmoxve.node.Config("configResource",
        node_name="string",
        description="string")
    
    const configResource = new proxmoxve.node.Config("configResource", {
        nodeName: "string",
        description: "string",
    });
    
    type: proxmoxve:node:Config
    properties:
        description: string
        nodeName: string
    

    Config Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Config resource accepts the following input properties:

    NodeName string
    The name of the node.
    Description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    NodeName string
    The name of the node.
    Description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    node_name string
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName String
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName string
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    node_name str
    The name of the node.
    description str
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName String
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Config resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Config Resource

    Get an existing Config resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConfigState, opts?: CustomResourceOptions): Config
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            node_name: Optional[str] = None) -> Config
    func GetConfig(ctx *Context, name string, id IDInput, state *ConfigState, opts ...ResourceOption) (*Config, error)
    public static Config Get(string name, Input<string> id, ConfigState? state, CustomResourceOptions? opts = null)
    public static Config get(String name, Output<String> id, ConfigState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:node:Config    get:      id: ${id}
    import {
      to = proxmoxve_node_config.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    NodeName string
    The name of the node.
    Description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    NodeName string
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    node_name string
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName String
    The name of the node.
    description string
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName string
    The name of the node.
    description str
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    node_name str
    The name of the node.
    description String
    Description of the node. Shown in the web-interface node notes panel. This is saved as a comment inside the configuration file. Trailing newlines are not supported by PVE; use trimspace() with heredoc values.
    nodeName String
    The name of the node.

    Import

    !/usr/bin/env sh Node config is per-node and can be imported by node name:

    $ pulumi import proxmoxve:node/config:Config example pve
    

    To learn more about importing existing cloud resources, see Importing resources.

    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