1. Packages
  2. Proxmox Virtual Environment (Proxmox VE)
  3. API Docs
  4. Storage
  5. PBS
Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

proxmoxve.Storage.PBS

proxmoxve logo
Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
Schema (JSON)
muhlba91/pulumi-proxmoxve

    Manages a Proxmox Backup Server (PBS) storage in Proxmox VE.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";

const example = new proxmoxve.storage.PBS("example", {
    pbsId: "example-pbs",
    nodes: ["pve"],
    server: "pbs.example.local",
    datastore: "backup",
    username: "pbs-user",
    password: "pbs-password",
    fingerprint: "AA:BB:CC:DD:EE:FF",
    contents: ["backup"],
    generateEncryptionKey: true,
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

example = proxmoxve.storage.PBS("example",
    pbs_id="example-pbs",
    nodes=["pve"],
    server="pbs.example.local",
    datastore="backup",
    username="pbs-user",
    password="pbs-password",
    fingerprint="AA:BB:CC:DD:EE:FF",
    contents=["backup"],
    generate_encryption_key=True)

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v7/go/proxmoxve/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storage.NewPBS(ctx, "example", &storage.PBSArgs{
			PbsId: pulumi.String("example-pbs"),
			Nodes: pulumi.StringArray{
				pulumi.String("pve"),
			},
			Server:      pulumi.String("pbs.example.local"),
			Datastore:   pulumi.String("backup"),
			Username:    pulumi.String("pbs-user"),
			Password:    pulumi.String("pbs-password"),
			Fingerprint: pulumi.String("AA:BB:CC:DD:EE:FF"),
			Contents: pulumi.StringArray{
				pulumi.String("backup"),
			},
			GenerateEncryptionKey: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ProxmoxVE = Pulumi.ProxmoxVE;

return await Deployment.RunAsync(() => 
{
    var example = new ProxmoxVE.Storage.PBS("example", new()
    {
        PbsId = "example-pbs",
        Nodes = new[]
        {
            "pve",
        },
        Server = "pbs.example.local",
        Datastore = "backup",
        Username = "pbs-user",
        Password = "pbs-password",
        Fingerprint = "AA:BB:CC:DD:EE:FF",
        Contents = new[]
        {
            "backup",
        },
        GenerateEncryptionKey = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import io.muehlbachler.pulumi.proxmoxve.Storage.PBS;
import io.muehlbachler.pulumi.proxmoxve.Storage.PBSArgs;
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) {
        var example = new PBS("example", PBSArgs.builder()
            .pbsId("example-pbs")
            .nodes("pve")
            .server("pbs.example.local")
            .datastore("backup")
            .username("pbs-user")
            .password("pbs-password")
            .fingerprint("AA:BB:CC:DD:EE:FF")
            .contents("backup")
            .generateEncryptionKey(true)
            .build());

    }
}

    resources:
  example:
    type: proxmoxve:Storage:PBS
    properties:
      pbsId: example-pbs
      nodes:
        - pve
      server: pbs.example.local
      datastore: backup
      username: pbs-user
      password: pbs-password
      fingerprint: AA:BB:CC:DD:EE:FF
      contents:
        - backup
      generateEncryptionKey: true

    Create PBS Resource

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

    Constructor syntax

    new PBS(name: string, args: PBSArgs, opts?: CustomResourceOptions);
    @overload
def PBS(resource_name: str,
        args: PBSArgs,
        opts: Optional[ResourceOptions] = None)

@overload
def PBS(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        password: Optional[str] = None,
        username: Optional[str] = None,
        datastore: Optional[str] = None,
        server: Optional[str] = None,
        pbs_id: Optional[str] = None,
        disable: Optional[bool] = None,
        generate_encryption_key: Optional[bool] = None,
        namespace: Optional[str] = None,
        nodes: Optional[Sequence[str]] = None,
        fingerprint: Optional[str] = None,
        encryption_key: Optional[str] = None,
        backups: Optional[PBSBackupsArgs] = None,
        contents: Optional[Sequence[str]] = None)
    func NewPBS(ctx *Context, name string, args PBSArgs, opts ...ResourceOption) (*PBS, error)
    public PBS(string name, PBSArgs args, CustomResourceOptions? opts = null)
    public PBS(String name, PBSArgs args)
public PBS(String name, PBSArgs args, CustomResourceOptions options)

    type: proxmoxve:Storage:PBS
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PBSArgs
    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 PBSArgs
    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 PBSArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PBSArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PBSArgs
    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 pbsResource = new ProxmoxVE.Storage.PBS("pbsResource", new()
{
    Password = "string",
    Username = "string",
    Datastore = "string",
    Server = "string",
    PbsId = "string",
    Disable = false,
    GenerateEncryptionKey = false,
    Namespace = "string",
    Nodes = new[]
    {
        "string",
    },
    Fingerprint = "string",
    EncryptionKey = "string",
    Backups = new ProxmoxVE.Storage.Inputs.PBSBackupsArgs
    {
        KeepAll = false,
        KeepDaily = 0,
        KeepHourly = 0,
        KeepLast = 0,
        KeepMonthly = 0,
        KeepWeekly = 0,
        KeepYearly = 0,
        MaxProtectedBackups = 0,
    },
    Contents = new[]
    {
        "string",
    },
});

    example, err := storage.NewPBS(ctx, "pbsResource", &storage.PBSArgs{
	Password:              pulumi.String("string"),
	Username:              pulumi.String("string"),
	Datastore:             pulumi.String("string"),
	Server:                pulumi.String("string"),
	PbsId:                 pulumi.String("string"),
	Disable:               pulumi.Bool(false),
	GenerateEncryptionKey: pulumi.Bool(false),
	Namespace:             pulumi.String("string"),
	Nodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Fingerprint:   pulumi.String("string"),
	EncryptionKey: pulumi.String("string"),
	Backups: &storage.PBSBackupsArgs{
		KeepAll:             pulumi.Bool(false),
		KeepDaily:           pulumi.Int(0),
		KeepHourly:          pulumi.Int(0),
		KeepLast:            pulumi.Int(0),
		KeepMonthly:         pulumi.Int(0),
		KeepWeekly:          pulumi.Int(0),
		KeepYearly:          pulumi.Int(0),
		MaxProtectedBackups: pulumi.Int(0),
	},
	Contents: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var pbsResource = new PBS("pbsResource", PBSArgs.builder()
    .password("string")
    .username("string")
    .datastore("string")
    .server("string")
    .pbsId("string")
    .disable(false)
    .generateEncryptionKey(false)
    .namespace("string")
    .nodes("string")
    .fingerprint("string")
    .encryptionKey("string")
    .backups(PBSBackupsArgs.builder()
        .keepAll(false)
        .keepDaily(0)
        .keepHourly(0)
        .keepLast(0)
        .keepMonthly(0)
        .keepWeekly(0)
        .keepYearly(0)
        .maxProtectedBackups(0)
        .build())
    .contents("string")
    .build());

    pbs_resource = proxmoxve.storage.PBS("pbsResource",
    password="string",
    username="string",
    datastore="string",
    server="string",
    pbs_id="string",
    disable=False,
    generate_encryption_key=False,
    namespace="string",
    nodes=["string"],
    fingerprint="string",
    encryption_key="string",
    backups={
        "keep_all": False,
        "keep_daily": 0,
        "keep_hourly": 0,
        "keep_last": 0,
        "keep_monthly": 0,
        "keep_weekly": 0,
        "keep_yearly": 0,
        "max_protected_backups": 0,
    },
    contents=["string"])

    const pbsResource = new proxmoxve.storage.PBS("pbsResource", {
    password: "string",
    username: "string",
    datastore: "string",
    server: "string",
    pbsId: "string",
    disable: false,
    generateEncryptionKey: false,
    namespace: "string",
    nodes: ["string"],
    fingerprint: "string",
    encryptionKey: "string",
    backups: {
        keepAll: false,
        keepDaily: 0,
        keepHourly: 0,
        keepLast: 0,
        keepMonthly: 0,
        keepWeekly: 0,
        keepYearly: 0,
        maxProtectedBackups: 0,
    },
    contents: ["string"],
});

    type: proxmoxve:Storage:PBS
properties:
    backups:
        keepAll: false
        keepDaily: 0
        keepHourly: 0
        keepLast: 0
        keepMonthly: 0
        keepWeekly: 0
        keepYearly: 0
        maxProtectedBackups: 0
    contents:
        - string
    datastore: string
    disable: false
    encryptionKey: string
    fingerprint: string
    generateEncryptionKey: false
    namespace: string
    nodes:
        - string
    password: string
    pbsId: string
    server: string
    username: string

    PBS 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 PBS resource accepts the following input properties:

    Datastore string
    The name of the datastore on the Proxmox Backup Server.
    Password string
    The password for authenticating with the Proxmox Backup Server.
    PbsId string
    The unique identifier of the storage.
    Server string
    The IP address or DNS name of the Proxmox Backup Server.
    Username string
    The username for authenticating with the Proxmox Backup Server.
    Backups Pulumi.ProxmoxVE.Storage.Inputs.PBSBackups
    Configure backup retention settings for the storage type.
    Contents List<string>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    Disable bool
    Whether the storage is disabled.
    EncryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    Fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    GenerateEncryptionKey bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    Namespace string
    The namespace to use on the Proxmox Backup Server.
    Nodes List<string>
    A list of nodes where this storage is available.
    Datastore string
    The name of the datastore on the Proxmox Backup Server.
    Password string
    The password for authenticating with the Proxmox Backup Server.
    PbsId string
    The unique identifier of the storage.
    Server string
    The IP address or DNS name of the Proxmox Backup Server.
    Username string
    The username for authenticating with the Proxmox Backup Server.
    Backups PBSBackupsArgs
    Configure backup retention settings for the storage type.
    Contents []string
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    Disable bool
    Whether the storage is disabled.
    EncryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    Fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    GenerateEncryptionKey bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    Namespace string
    The namespace to use on the Proxmox Backup Server.
    Nodes []string
    A list of nodes where this storage is available.
    datastore String
    The name of the datastore on the Proxmox Backup Server.
    password String
    The password for authenticating with the Proxmox Backup Server.
    pbsId String
    The unique identifier of the storage.
    server String
    The IP address or DNS name of the Proxmox Backup Server.
    username String
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackups
    Configure backup retention settings for the storage type.
    contents List<String>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    disable Boolean
    Whether the storage is disabled.
    encryptionKey String
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    fingerprint String
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey Boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    namespace String
    The namespace to use on the Proxmox Backup Server.
    nodes List<String>
    A list of nodes where this storage is available.
    datastore string
    The name of the datastore on the Proxmox Backup Server.
    password string
    The password for authenticating with the Proxmox Backup Server.
    pbsId string
    The unique identifier of the storage.
    server string
    The IP address or DNS name of the Proxmox Backup Server.
    username string
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackups
    Configure backup retention settings for the storage type.
    contents string[]
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    disable boolean
    Whether the storage is disabled.
    encryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    namespace string
    The namespace to use on the Proxmox Backup Server.
    nodes string[]
    A list of nodes where this storage is available.
    datastore str
    The name of the datastore on the Proxmox Backup Server.
    password str
    The password for authenticating with the Proxmox Backup Server.
    pbs_id str
    The unique identifier of the storage.
    server str
    The IP address or DNS name of the Proxmox Backup Server.
    username str
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackupsArgs
    Configure backup retention settings for the storage type.
    contents Sequence[str]
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    disable bool
    Whether the storage is disabled.
    encryption_key str
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    fingerprint str
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generate_encryption_key bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    namespace str
    The namespace to use on the Proxmox Backup Server.
    nodes Sequence[str]
    A list of nodes where this storage is available.
    datastore String
    The name of the datastore on the Proxmox Backup Server.
    password String
    The password for authenticating with the Proxmox Backup Server.
    pbsId String
    The unique identifier of the storage.
    server String
    The IP address or DNS name of the Proxmox Backup Server.
    username String
    The username for authenticating with the Proxmox Backup Server.
    backups Property Map
    Configure backup retention settings for the storage type.
    contents List<String>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    disable Boolean
    Whether the storage is disabled.
    encryptionKey String
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    fingerprint String
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey Boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    namespace String
    The namespace to use on the Proxmox Backup Server.
    nodes List<String>
    A list of nodes where this storage is available.

    Outputs

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

    EncryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    GeneratedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shared bool
    Whether the storage is shared across all nodes.
    EncryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    GeneratedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    Id string
    The provider-assigned unique ID for this managed resource.
    Shared bool
    Whether the storage is shared across all nodes.
    encryptionKeyFingerprint String
    The SHA256 fingerprint of the encryption key currently in use.
    generatedEncryptionKey String
    The encryption key returned by Proxmox when generate_encryption_key is true.
    id String
    The provider-assigned unique ID for this managed resource.
    shared Boolean
    Whether the storage is shared across all nodes.
    encryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    generatedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    id string
    The provider-assigned unique ID for this managed resource.
    shared boolean
    Whether the storage is shared across all nodes.
    encryption_key_fingerprint str
    The SHA256 fingerprint of the encryption key currently in use.
    generated_encryption_key str
    The encryption key returned by Proxmox when generate_encryption_key is true.
    id str
    The provider-assigned unique ID for this managed resource.
    shared bool
    Whether the storage is shared across all nodes.
    encryptionKeyFingerprint String
    The SHA256 fingerprint of the encryption key currently in use.
    generatedEncryptionKey String
    The encryption key returned by Proxmox when generate_encryption_key is true.
    id String
    The provider-assigned unique ID for this managed resource.
    shared Boolean
    Whether the storage is shared across all nodes.

    Look up Existing PBS Resource

    Get an existing PBS 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?: PBSState, opts?: CustomResourceOptions): PBS
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backups: Optional[PBSBackupsArgs] = None,
        contents: Optional[Sequence[str]] = None,
        datastore: Optional[str] = None,
        disable: Optional[bool] = None,
        encryption_key: Optional[str] = None,
        encryption_key_fingerprint: Optional[str] = None,
        fingerprint: Optional[str] = None,
        generate_encryption_key: Optional[bool] = None,
        generated_encryption_key: Optional[str] = None,
        namespace: Optional[str] = None,
        nodes: Optional[Sequence[str]] = None,
        password: Optional[str] = None,
        pbs_id: Optional[str] = None,
        server: Optional[str] = None,
        shared: Optional[bool] = None,
        username: Optional[str] = None) -> PBS
    func GetPBS(ctx *Context, name string, id IDInput, state *PBSState, opts ...ResourceOption) (*PBS, error)
    public static PBS Get(string name, Input<string> id, PBSState? state, CustomResourceOptions? opts = null)
    public static PBS get(String name, Output<String> id, PBSState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:Storage:PBS    get:      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:
    Backups Pulumi.ProxmoxVE.Storage.Inputs.PBSBackups
    Configure backup retention settings for the storage type.
    Contents List<string>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    Datastore string
    The name of the datastore on the Proxmox Backup Server.
    Disable bool
    Whether the storage is disabled.
    EncryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    EncryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    Fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    GenerateEncryptionKey bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    GeneratedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    Namespace string
    The namespace to use on the Proxmox Backup Server.
    Nodes List<string>
    A list of nodes where this storage is available.
    Password string
    The password for authenticating with the Proxmox Backup Server.
    PbsId string
    The unique identifier of the storage.
    Server string
    The IP address or DNS name of the Proxmox Backup Server.
    Shared bool
    Whether the storage is shared across all nodes.
    Username string
    The username for authenticating with the Proxmox Backup Server.
    Backups PBSBackupsArgs
    Configure backup retention settings for the storage type.
    Contents []string
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    Datastore string
    The name of the datastore on the Proxmox Backup Server.
    Disable bool
    Whether the storage is disabled.
    EncryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    EncryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    Fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    GenerateEncryptionKey bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    GeneratedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    Namespace string
    The namespace to use on the Proxmox Backup Server.
    Nodes []string
    A list of nodes where this storage is available.
    Password string
    The password for authenticating with the Proxmox Backup Server.
    PbsId string
    The unique identifier of the storage.
    Server string
    The IP address or DNS name of the Proxmox Backup Server.
    Shared bool
    Whether the storage is shared across all nodes.
    Username string
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackups
    Configure backup retention settings for the storage type.
    contents List<String>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    datastore String
    The name of the datastore on the Proxmox Backup Server.
    disable Boolean
    Whether the storage is disabled.
    encryptionKey String
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    encryptionKeyFingerprint String
    The SHA256 fingerprint of the encryption key currently in use.
    fingerprint String
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey Boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    generatedEncryptionKey String
    The encryption key returned by Proxmox when generate_encryption_key is true.
    namespace String
    The namespace to use on the Proxmox Backup Server.
    nodes List<String>
    A list of nodes where this storage is available.
    password String
    The password for authenticating with the Proxmox Backup Server.
    pbsId String
    The unique identifier of the storage.
    server String
    The IP address or DNS name of the Proxmox Backup Server.
    shared Boolean
    Whether the storage is shared across all nodes.
    username String
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackups
    Configure backup retention settings for the storage type.
    contents string[]
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    datastore string
    The name of the datastore on the Proxmox Backup Server.
    disable boolean
    Whether the storage is disabled.
    encryptionKey string
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    encryptionKeyFingerprint string
    The SHA256 fingerprint of the encryption key currently in use.
    fingerprint string
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    generatedEncryptionKey string
    The encryption key returned by Proxmox when generate_encryption_key is true.
    namespace string
    The namespace to use on the Proxmox Backup Server.
    nodes string[]
    A list of nodes where this storage is available.
    password string
    The password for authenticating with the Proxmox Backup Server.
    pbsId string
    The unique identifier of the storage.
    server string
    The IP address or DNS name of the Proxmox Backup Server.
    shared boolean
    Whether the storage is shared across all nodes.
    username string
    The username for authenticating with the Proxmox Backup Server.
    backups PBSBackupsArgs
    Configure backup retention settings for the storage type.
    contents Sequence[str]
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    datastore str
    The name of the datastore on the Proxmox Backup Server.
    disable bool
    Whether the storage is disabled.
    encryption_key str
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    encryption_key_fingerprint str
    The SHA256 fingerprint of the encryption key currently in use.
    fingerprint str
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generate_encryption_key bool
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    generated_encryption_key str
    The encryption key returned by Proxmox when generate_encryption_key is true.
    namespace str
    The namespace to use on the Proxmox Backup Server.
    nodes Sequence[str]
    A list of nodes where this storage is available.
    password str
    The password for authenticating with the Proxmox Backup Server.
    pbs_id str
    The unique identifier of the storage.
    server str
    The IP address or DNS name of the Proxmox Backup Server.
    shared bool
    Whether the storage is shared across all nodes.
    username str
    The username for authenticating with the Proxmox Backup Server.
    backups Property Map
    Configure backup retention settings for the storage type.
    contents List<String>
    The content types that can be stored on this storage. Valid values: backup (VM backups), images (VM disk images), import (VM disk images for import), iso (ISO images), rootdir (container root directories), snippets (cloud-init, hook scripts, etc.), vztmpl (container templates).
    datastore String
    The name of the datastore on the Proxmox Backup Server.
    disable Boolean
    Whether the storage is disabled.
    encryptionKey String
    An existing encryption key for the datastore. This is a sensitive value. Conflicts with generate_encryption_key.
    encryptionKeyFingerprint String
    The SHA256 fingerprint of the encryption key currently in use.
    fingerprint String
    The SHA256 fingerprint of the Proxmox Backup Server's certificate.
    generateEncryptionKey Boolean
    If set to true, Proxmox will generate a new encryption key. The key will be stored in the generated_encryption_key attribute. Conflicts with encryption_key.
    generatedEncryptionKey String
    The encryption key returned by Proxmox when generate_encryption_key is true.
    namespace String
    The namespace to use on the Proxmox Backup Server.
    nodes List<String>
    A list of nodes where this storage is available.
    password String
    The password for authenticating with the Proxmox Backup Server.
    pbsId String
    The unique identifier of the storage.
    server String
    The IP address or DNS name of the Proxmox Backup Server.
    shared Boolean
    Whether the storage is shared across all nodes.
    username String
    The username for authenticating with the Proxmox Backup Server.

    Supporting Types

    PBSBackups, PBSBackupsArgs

    KeepAll bool
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    KeepDaily int
    The number of daily backups to keep. Older backups will be removed.
    KeepHourly int
    The number of hourly backups to keep. Older backups will be removed.
    KeepLast int
    Specifies the number of the most recent backups to keep, regardless of their age.
    KeepMonthly int
    The number of monthly backups to keep. Older backups will be removed.
    KeepWeekly int
    The number of weekly backups to keep. Older backups will be removed.
    KeepYearly int
    The number of yearly backups to keep. Older backups will be removed.
    MaxProtectedBackups int
    The maximum number of protected backups per guest. Use '-1' for unlimited.
    KeepAll bool
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    KeepDaily int
    The number of daily backups to keep. Older backups will be removed.
    KeepHourly int
    The number of hourly backups to keep. Older backups will be removed.
    KeepLast int
    Specifies the number of the most recent backups to keep, regardless of their age.
    KeepMonthly int
    The number of monthly backups to keep. Older backups will be removed.
    KeepWeekly int
    The number of weekly backups to keep. Older backups will be removed.
    KeepYearly int
    The number of yearly backups to keep. Older backups will be removed.
    MaxProtectedBackups int
    The maximum number of protected backups per guest. Use '-1' for unlimited.
    keepAll Boolean
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    keepDaily Integer
    The number of daily backups to keep. Older backups will be removed.
    keepHourly Integer
    The number of hourly backups to keep. Older backups will be removed.
    keepLast Integer
    Specifies the number of the most recent backups to keep, regardless of their age.
    keepMonthly Integer
    The number of monthly backups to keep. Older backups will be removed.
    keepWeekly Integer
    The number of weekly backups to keep. Older backups will be removed.
    keepYearly Integer
    The number of yearly backups to keep. Older backups will be removed.
    maxProtectedBackups Integer
    The maximum number of protected backups per guest. Use '-1' for unlimited.
    keepAll boolean
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    keepDaily number
    The number of daily backups to keep. Older backups will be removed.
    keepHourly number
    The number of hourly backups to keep. Older backups will be removed.
    keepLast number
    Specifies the number of the most recent backups to keep, regardless of their age.
    keepMonthly number
    The number of monthly backups to keep. Older backups will be removed.
    keepWeekly number
    The number of weekly backups to keep. Older backups will be removed.
    keepYearly number
    The number of yearly backups to keep. Older backups will be removed.
    maxProtectedBackups number
    The maximum number of protected backups per guest. Use '-1' for unlimited.
    keep_all bool
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    keep_daily int
    The number of daily backups to keep. Older backups will be removed.
    keep_hourly int
    The number of hourly backups to keep. Older backups will be removed.
    keep_last int
    Specifies the number of the most recent backups to keep, regardless of their age.
    keep_monthly int
    The number of monthly backups to keep. Older backups will be removed.
    keep_weekly int
    The number of weekly backups to keep. Older backups will be removed.
    keep_yearly int
    The number of yearly backups to keep. Older backups will be removed.
    max_protected_backups int
    The maximum number of protected backups per guest. Use '-1' for unlimited.
    keepAll Boolean
    Specifies if all backups should be kept, regardless of their age. When set to true, other keep_* attributes must not be set.
    keepDaily Number
    The number of daily backups to keep. Older backups will be removed.
    keepHourly Number
    The number of hourly backups to keep. Older backups will be removed.
    keepLast Number
    Specifies the number of the most recent backups to keep, regardless of their age.
    keepMonthly Number
    The number of monthly backups to keep. Older backups will be removed.
    keepWeekly Number
    The number of weekly backups to keep. Older backups will be removed.
    keepYearly Number
    The number of yearly backups to keep. Older backups will be removed.
    maxProtectedBackups Number
    The maximum number of protected backups per guest. Use '-1' for unlimited.

    Package Details

    Repository
    proxmoxve muhlba91/pulumi-proxmoxve
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the proxmox Terraform Provider.
    proxmoxve logo
    Proxmox Virtual Environment (Proxmox VE) v7.13.0 published on Tuesday, Feb 10, 2026 by Daniel Muehlbachler-Pietrzykowski
    Schema (JSON)
    muhlba91/pulumi-proxmoxve
      Meet Neo: Your AI Platform Teammate