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

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

    Manages a Proxmox VE cluster backup job.

    Example Usage

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

const dailyBackup = new proxmoxve.backup.Job("daily_backup", {
    resourceId: "daily-backup",
    schedule: "*-*-* 02:00",
    storage: "local",
    all: true,
    mode: "snapshot",
    compress: "zstd",
});

    import pulumi
import pulumi_proxmoxve as proxmoxve

daily_backup = proxmoxve.backup.Job("daily_backup",
    resource_id="daily-backup",
    schedule="*-*-* 02:00",
    storage="local",
    all=True,
    mode="snapshot",
    compress="zstd")

    package main

import (
	"github.com/muhlba91/pulumi-proxmoxve/sdk/v8/go/proxmoxve/backup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := backup.NewJob(ctx, "daily_backup", &backup.JobArgs{
			ResourceId: pulumi.String("daily-backup"),
			Schedule:   pulumi.String("*-*-* 02:00"),
			Storage:    pulumi.String("local"),
			All:        pulumi.Bool(true),
			Mode:       pulumi.String("snapshot"),
			Compress:   pulumi.String("zstd"),
		})
		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 dailyBackup = new ProxmoxVE.Backup.Job("daily_backup", new()
    {
        ResourceId = "daily-backup",
        Schedule = "*-*-* 02:00",
        Storage = "local",
        All = true,
        Mode = "snapshot",
        Compress = "zstd",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import io.muehlbachler.pulumi.proxmoxve.backup.Job;
import io.muehlbachler.pulumi.proxmoxve.backup.JobArgs;
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 dailyBackup = new Job("dailyBackup", JobArgs.builder()
            .resourceId("daily-backup")
            .schedule("*-*-* 02:00")
            .storage("local")
            .all(true)
            .mode("snapshot")
            .compress("zstd")
            .build());

    }
}

    resources:
  dailyBackup:
    type: proxmoxve:backup:Job
    name: daily_backup
    properties:
      resourceId: daily-backup
      schedule: '*-*-* 02:00'
      storage: local
      all: true
      mode: snapshot
      compress: zstd

    Create Job Resource

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

    Constructor syntax

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

@overload
def Job(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        resource_id: Optional[str] = None,
        storage: Optional[str] = None,
        schedule: Optional[str] = None,
        pigz: Optional[int] = None,
        enabled: Optional[bool] = None,
        fleecing: Optional[JobFleecingArgs] = None,
        ionice: Optional[int] = None,
        lockwait: Optional[int] = None,
        mailnotification: Optional[str] = None,
        mailtos: Optional[Sequence[str]] = None,
        maxfiles: Optional[int] = None,
        mode: Optional[str] = None,
        node: Optional[str] = None,
        notes_template: Optional[str] = None,
        pbs_change_detection_mode: Optional[str] = None,
        performance: Optional[JobPerformanceArgs] = None,
        all: Optional[bool] = None,
        exclude_paths: Optional[Sequence[str]] = None,
        prune_backups: Optional[Mapping[str, str]] = None,
        pool: Optional[str] = None,
        remove: Optional[bool] = None,
        repeat_missed: Optional[bool] = None,
        protected: Optional[bool] = None,
        compress: Optional[str] = None,
        script: Optional[str] = None,
        starttime: Optional[str] = None,
        stdexcludes: Optional[bool] = None,
        stopwait: Optional[int] = None,
        bwlimit: Optional[int] = None,
        tmpdir: Optional[str] = None,
        vmids: Optional[Sequence[str]] = None,
        zstd: Optional[int] = None)
    func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
    public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
    public Job(String name, JobArgs args)
public Job(String name, JobArgs args, CustomResourceOptions options)

    type: proxmoxve:backup:Job
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 JobArgs
    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 JobArgs
    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 JobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ResourceId string
    The identifier of the backup job.
    Schedule string
    Backup schedule in systemd calendar event format.
    Storage string
    The storage identifier for the backup.
    All bool
    Whether to back up all known guests on the node.
    Bwlimit int
    I/O bandwidth limit in KiB/s.
    Compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    Enabled bool
    Whether the backup job is enabled.
    ExcludePaths List<string>
    A list of paths to exclude from the backup.
    Fleecing Pulumi.ProxmoxVE.Backup.Inputs.JobFleecing
    Fleecing configuration for the backup job.
    Ionice int
    I/O priority (0-8).
    Lockwait int
    Maximum wait time in minutes for the global lock.
    Mailnotification string
    Email notification setting (always or failure).
    Mailtos List<string>
    A list of email addresses to send notifications to.
    Maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    Mode string
    The backup mode (snapshot, suspend, or stop).
    Node string
    The cluster node name to limit the backup job to.
    NotesTemplate string
    Template for notes attached to the backup.
    PbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    Performance Pulumi.ProxmoxVE.Backup.Inputs.JobPerformance
    Performance-related settings for the backup job.
    Pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    Pool string
    Limit backup to guests in the specified pool.
    Protected bool
    Whether the backup should be marked as protected.
    PruneBackups Dictionary<string, string>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    Remove bool
    Whether to remove old backups if there are more than maxfiles.
    RepeatMissed bool
    Whether to repeat missed backup jobs as soon as possible.
    Script string
    Path to a script to execute before/after the backup job.
    Starttime string
    The scheduled start time (HH:MM).
    Stdexcludes bool
    Whether to exclude common temporary files from the backup.
    Stopwait int
    Maximum wait time in minutes for a guest to stop.
    Tmpdir string
    Path to the temporary directory for the backup job.
    Vmids List<string>
    A list of guest VM/CT IDs to include in the backup job.
    Zstd int
    Number of zstd threads (0 uses half of available cores).
    ResourceId string
    The identifier of the backup job.
    Schedule string
    Backup schedule in systemd calendar event format.
    Storage string
    The storage identifier for the backup.
    All bool
    Whether to back up all known guests on the node.
    Bwlimit int
    I/O bandwidth limit in KiB/s.
    Compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    Enabled bool
    Whether the backup job is enabled.
    ExcludePaths []string
    A list of paths to exclude from the backup.
    Fleecing JobFleecingArgs
    Fleecing configuration for the backup job.
    Ionice int
    I/O priority (0-8).
    Lockwait int
    Maximum wait time in minutes for the global lock.
    Mailnotification string
    Email notification setting (always or failure).
    Mailtos []string
    A list of email addresses to send notifications to.
    Maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    Mode string
    The backup mode (snapshot, suspend, or stop).
    Node string
    The cluster node name to limit the backup job to.
    NotesTemplate string
    Template for notes attached to the backup.
    PbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    Performance JobPerformanceArgs
    Performance-related settings for the backup job.
    Pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    Pool string
    Limit backup to guests in the specified pool.
    Protected bool
    Whether the backup should be marked as protected.
    PruneBackups map[string]string
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    Remove bool
    Whether to remove old backups if there are more than maxfiles.
    RepeatMissed bool
    Whether to repeat missed backup jobs as soon as possible.
    Script string
    Path to a script to execute before/after the backup job.
    Starttime string
    The scheduled start time (HH:MM).
    Stdexcludes bool
    Whether to exclude common temporary files from the backup.
    Stopwait int
    Maximum wait time in minutes for a guest to stop.
    Tmpdir string
    Path to the temporary directory for the backup job.
    Vmids []string
    A list of guest VM/CT IDs to include in the backup job.
    Zstd int
    Number of zstd threads (0 uses half of available cores).
    resourceId String
    The identifier of the backup job.
    schedule String
    Backup schedule in systemd calendar event format.
    storage String
    The storage identifier for the backup.
    all Boolean
    Whether to back up all known guests on the node.
    bwlimit Integer
    I/O bandwidth limit in KiB/s.
    compress String
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled Boolean
    Whether the backup job is enabled.
    excludePaths List<String>
    A list of paths to exclude from the backup.
    fleecing JobFleecing
    Fleecing configuration for the backup job.
    ionice Integer
    I/O priority (0-8).
    lockwait Integer
    Maximum wait time in minutes for the global lock.
    mailnotification String
    Email notification setting (always or failure).
    mailtos List<String>
    A list of email addresses to send notifications to.
    maxfiles Integer
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode String
    The backup mode (snapshot, suspend, or stop).
    node String
    The cluster node name to limit the backup job to.
    notesTemplate String
    Template for notes attached to the backup.
    pbsChangeDetectionMode String
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformance
    Performance-related settings for the backup job.
    pigz Integer
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool String
    Limit backup to guests in the specified pool.
    protected_ Boolean
    Whether the backup should be marked as protected.
    pruneBackups Map<String,String>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove Boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed Boolean
    Whether to repeat missed backup jobs as soon as possible.
    script String
    Path to a script to execute before/after the backup job.
    starttime String
    The scheduled start time (HH:MM).
    stdexcludes Boolean
    Whether to exclude common temporary files from the backup.
    stopwait Integer
    Maximum wait time in minutes for a guest to stop.
    tmpdir String
    Path to the temporary directory for the backup job.
    vmids List<String>
    A list of guest VM/CT IDs to include in the backup job.
    zstd Integer
    Number of zstd threads (0 uses half of available cores).
    resourceId string
    The identifier of the backup job.
    schedule string
    Backup schedule in systemd calendar event format.
    storage string
    The storage identifier for the backup.
    all boolean
    Whether to back up all known guests on the node.
    bwlimit number
    I/O bandwidth limit in KiB/s.
    compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled boolean
    Whether the backup job is enabled.
    excludePaths string[]
    A list of paths to exclude from the backup.
    fleecing JobFleecing
    Fleecing configuration for the backup job.
    ionice number
    I/O priority (0-8).
    lockwait number
    Maximum wait time in minutes for the global lock.
    mailnotification string
    Email notification setting (always or failure).
    mailtos string[]
    A list of email addresses to send notifications to.
    maxfiles number
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode string
    The backup mode (snapshot, suspend, or stop).
    node string
    The cluster node name to limit the backup job to.
    notesTemplate string
    Template for notes attached to the backup.
    pbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformance
    Performance-related settings for the backup job.
    pigz number
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool string
    Limit backup to guests in the specified pool.
    protected boolean
    Whether the backup should be marked as protected.
    pruneBackups {[key: string]: string}
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed boolean
    Whether to repeat missed backup jobs as soon as possible.
    script string
    Path to a script to execute before/after the backup job.
    starttime string
    The scheduled start time (HH:MM).
    stdexcludes boolean
    Whether to exclude common temporary files from the backup.
    stopwait number
    Maximum wait time in minutes for a guest to stop.
    tmpdir string
    Path to the temporary directory for the backup job.
    vmids string[]
    A list of guest VM/CT IDs to include in the backup job.
    zstd number
    Number of zstd threads (0 uses half of available cores).
    resource_id str
    The identifier of the backup job.
    schedule str
    Backup schedule in systemd calendar event format.
    storage str
    The storage identifier for the backup.
    all bool
    Whether to back up all known guests on the node.
    bwlimit int
    I/O bandwidth limit in KiB/s.
    compress str
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled bool
    Whether the backup job is enabled.
    exclude_paths Sequence[str]
    A list of paths to exclude from the backup.
    fleecing JobFleecingArgs
    Fleecing configuration for the backup job.
    ionice int
    I/O priority (0-8).
    lockwait int
    Maximum wait time in minutes for the global lock.
    mailnotification str
    Email notification setting (always or failure).
    mailtos Sequence[str]
    A list of email addresses to send notifications to.
    maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode str
    The backup mode (snapshot, suspend, or stop).
    node str
    The cluster node name to limit the backup job to.
    notes_template str
    Template for notes attached to the backup.
    pbs_change_detection_mode str
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformanceArgs
    Performance-related settings for the backup job.
    pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool str
    Limit backup to guests in the specified pool.
    protected bool
    Whether the backup should be marked as protected.
    prune_backups Mapping[str, str]
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove bool
    Whether to remove old backups if there are more than maxfiles.
    repeat_missed bool
    Whether to repeat missed backup jobs as soon as possible.
    script str
    Path to a script to execute before/after the backup job.
    starttime str
    The scheduled start time (HH:MM).
    stdexcludes bool
    Whether to exclude common temporary files from the backup.
    stopwait int
    Maximum wait time in minutes for a guest to stop.
    tmpdir str
    Path to the temporary directory for the backup job.
    vmids Sequence[str]
    A list of guest VM/CT IDs to include in the backup job.
    zstd int
    Number of zstd threads (0 uses half of available cores).
    resourceId String
    The identifier of the backup job.
    schedule String
    Backup schedule in systemd calendar event format.
    storage String
    The storage identifier for the backup.
    all Boolean
    Whether to back up all known guests on the node.
    bwlimit Number
    I/O bandwidth limit in KiB/s.
    compress String
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled Boolean
    Whether the backup job is enabled.
    excludePaths List<String>
    A list of paths to exclude from the backup.
    fleecing Property Map
    Fleecing configuration for the backup job.
    ionice Number
    I/O priority (0-8).
    lockwait Number
    Maximum wait time in minutes for the global lock.
    mailnotification String
    Email notification setting (always or failure).
    mailtos List<String>
    A list of email addresses to send notifications to.
    maxfiles Number
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode String
    The backup mode (snapshot, suspend, or stop).
    node String
    The cluster node name to limit the backup job to.
    notesTemplate String
    Template for notes attached to the backup.
    pbsChangeDetectionMode String
    PBS change detection mode (legacy, data, or metadata).
    performance Property Map
    Performance-related settings for the backup job.
    pigz Number
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool String
    Limit backup to guests in the specified pool.
    protected Boolean
    Whether the backup should be marked as protected.
    pruneBackups Map<String>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove Boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed Boolean
    Whether to repeat missed backup jobs as soon as possible.
    script String
    Path to a script to execute before/after the backup job.
    starttime String
    The scheduled start time (HH:MM).
    stdexcludes Boolean
    Whether to exclude common temporary files from the backup.
    stopwait Number
    Maximum wait time in minutes for a guest to stop.
    tmpdir String
    Path to the temporary directory for the backup job.
    vmids List<String>
    A list of guest VM/CT IDs to include in the backup job.
    zstd Number
    Number of zstd threads (0 uses half of available cores).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Job 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Job Resource

    Get an existing Job 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?: JobState, opts?: CustomResourceOptions): Job
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all: Optional[bool] = None,
        bwlimit: Optional[int] = None,
        compress: Optional[str] = None,
        enabled: Optional[bool] = None,
        exclude_paths: Optional[Sequence[str]] = None,
        fleecing: Optional[JobFleecingArgs] = None,
        ionice: Optional[int] = None,
        lockwait: Optional[int] = None,
        mailnotification: Optional[str] = None,
        mailtos: Optional[Sequence[str]] = None,
        maxfiles: Optional[int] = None,
        mode: Optional[str] = None,
        node: Optional[str] = None,
        notes_template: Optional[str] = None,
        pbs_change_detection_mode: Optional[str] = None,
        performance: Optional[JobPerformanceArgs] = None,
        pigz: Optional[int] = None,
        pool: Optional[str] = None,
        protected: Optional[bool] = None,
        prune_backups: Optional[Mapping[str, str]] = None,
        remove: Optional[bool] = None,
        repeat_missed: Optional[bool] = None,
        resource_id: Optional[str] = None,
        schedule: Optional[str] = None,
        script: Optional[str] = None,
        starttime: Optional[str] = None,
        stdexcludes: Optional[bool] = None,
        stopwait: Optional[int] = None,
        storage: Optional[str] = None,
        tmpdir: Optional[str] = None,
        vmids: Optional[Sequence[str]] = None,
        zstd: Optional[int] = None) -> Job
    func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)
    public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)
    public static Job get(String name, Output<String> id, JobState state, CustomResourceOptions options)
    resources:  _:    type: proxmoxve:backup:Job    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:
    All bool
    Whether to back up all known guests on the node.
    Bwlimit int
    I/O bandwidth limit in KiB/s.
    Compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    Enabled bool
    Whether the backup job is enabled.
    ExcludePaths List<string>
    A list of paths to exclude from the backup.
    Fleecing Pulumi.ProxmoxVE.Backup.Inputs.JobFleecing
    Fleecing configuration for the backup job.
    Ionice int
    I/O priority (0-8).
    Lockwait int
    Maximum wait time in minutes for the global lock.
    Mailnotification string
    Email notification setting (always or failure).
    Mailtos List<string>
    A list of email addresses to send notifications to.
    Maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    Mode string
    The backup mode (snapshot, suspend, or stop).
    Node string
    The cluster node name to limit the backup job to.
    NotesTemplate string
    Template for notes attached to the backup.
    PbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    Performance Pulumi.ProxmoxVE.Backup.Inputs.JobPerformance
    Performance-related settings for the backup job.
    Pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    Pool string
    Limit backup to guests in the specified pool.
    Protected bool
    Whether the backup should be marked as protected.
    PruneBackups Dictionary<string, string>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    Remove bool
    Whether to remove old backups if there are more than maxfiles.
    RepeatMissed bool
    Whether to repeat missed backup jobs as soon as possible.
    ResourceId string
    The identifier of the backup job.
    Schedule string
    Backup schedule in systemd calendar event format.
    Script string
    Path to a script to execute before/after the backup job.
    Starttime string
    The scheduled start time (HH:MM).
    Stdexcludes bool
    Whether to exclude common temporary files from the backup.
    Stopwait int
    Maximum wait time in minutes for a guest to stop.
    Storage string
    The storage identifier for the backup.
    Tmpdir string
    Path to the temporary directory for the backup job.
    Vmids List<string>
    A list of guest VM/CT IDs to include in the backup job.
    Zstd int
    Number of zstd threads (0 uses half of available cores).
    All bool
    Whether to back up all known guests on the node.
    Bwlimit int
    I/O bandwidth limit in KiB/s.
    Compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    Enabled bool
    Whether the backup job is enabled.
    ExcludePaths []string
    A list of paths to exclude from the backup.
    Fleecing JobFleecingArgs
    Fleecing configuration for the backup job.
    Ionice int
    I/O priority (0-8).
    Lockwait int
    Maximum wait time in minutes for the global lock.
    Mailnotification string
    Email notification setting (always or failure).
    Mailtos []string
    A list of email addresses to send notifications to.
    Maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    Mode string
    The backup mode (snapshot, suspend, or stop).
    Node string
    The cluster node name to limit the backup job to.
    NotesTemplate string
    Template for notes attached to the backup.
    PbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    Performance JobPerformanceArgs
    Performance-related settings for the backup job.
    Pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    Pool string
    Limit backup to guests in the specified pool.
    Protected bool
    Whether the backup should be marked as protected.
    PruneBackups map[string]string
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    Remove bool
    Whether to remove old backups if there are more than maxfiles.
    RepeatMissed bool
    Whether to repeat missed backup jobs as soon as possible.
    ResourceId string
    The identifier of the backup job.
    Schedule string
    Backup schedule in systemd calendar event format.
    Script string
    Path to a script to execute before/after the backup job.
    Starttime string
    The scheduled start time (HH:MM).
    Stdexcludes bool
    Whether to exclude common temporary files from the backup.
    Stopwait int
    Maximum wait time in minutes for a guest to stop.
    Storage string
    The storage identifier for the backup.
    Tmpdir string
    Path to the temporary directory for the backup job.
    Vmids []string
    A list of guest VM/CT IDs to include in the backup job.
    Zstd int
    Number of zstd threads (0 uses half of available cores).
    all Boolean
    Whether to back up all known guests on the node.
    bwlimit Integer
    I/O bandwidth limit in KiB/s.
    compress String
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled Boolean
    Whether the backup job is enabled.
    excludePaths List<String>
    A list of paths to exclude from the backup.
    fleecing JobFleecing
    Fleecing configuration for the backup job.
    ionice Integer
    I/O priority (0-8).
    lockwait Integer
    Maximum wait time in minutes for the global lock.
    mailnotification String
    Email notification setting (always or failure).
    mailtos List<String>
    A list of email addresses to send notifications to.
    maxfiles Integer
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode String
    The backup mode (snapshot, suspend, or stop).
    node String
    The cluster node name to limit the backup job to.
    notesTemplate String
    Template for notes attached to the backup.
    pbsChangeDetectionMode String
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformance
    Performance-related settings for the backup job.
    pigz Integer
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool String
    Limit backup to guests in the specified pool.
    protected_ Boolean
    Whether the backup should be marked as protected.
    pruneBackups Map<String,String>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove Boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed Boolean
    Whether to repeat missed backup jobs as soon as possible.
    resourceId String
    The identifier of the backup job.
    schedule String
    Backup schedule in systemd calendar event format.
    script String
    Path to a script to execute before/after the backup job.
    starttime String
    The scheduled start time (HH:MM).
    stdexcludes Boolean
    Whether to exclude common temporary files from the backup.
    stopwait Integer
    Maximum wait time in minutes for a guest to stop.
    storage String
    The storage identifier for the backup.
    tmpdir String
    Path to the temporary directory for the backup job.
    vmids List<String>
    A list of guest VM/CT IDs to include in the backup job.
    zstd Integer
    Number of zstd threads (0 uses half of available cores).
    all boolean
    Whether to back up all known guests on the node.
    bwlimit number
    I/O bandwidth limit in KiB/s.
    compress string
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled boolean
    Whether the backup job is enabled.
    excludePaths string[]
    A list of paths to exclude from the backup.
    fleecing JobFleecing
    Fleecing configuration for the backup job.
    ionice number
    I/O priority (0-8).
    lockwait number
    Maximum wait time in minutes for the global lock.
    mailnotification string
    Email notification setting (always or failure).
    mailtos string[]
    A list of email addresses to send notifications to.
    maxfiles number
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode string
    The backup mode (snapshot, suspend, or stop).
    node string
    The cluster node name to limit the backup job to.
    notesTemplate string
    Template for notes attached to the backup.
    pbsChangeDetectionMode string
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformance
    Performance-related settings for the backup job.
    pigz number
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool string
    Limit backup to guests in the specified pool.
    protected boolean
    Whether the backup should be marked as protected.
    pruneBackups {[key: string]: string}
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed boolean
    Whether to repeat missed backup jobs as soon as possible.
    resourceId string
    The identifier of the backup job.
    schedule string
    Backup schedule in systemd calendar event format.
    script string
    Path to a script to execute before/after the backup job.
    starttime string
    The scheduled start time (HH:MM).
    stdexcludes boolean
    Whether to exclude common temporary files from the backup.
    stopwait number
    Maximum wait time in minutes for a guest to stop.
    storage string
    The storage identifier for the backup.
    tmpdir string
    Path to the temporary directory for the backup job.
    vmids string[]
    A list of guest VM/CT IDs to include in the backup job.
    zstd number
    Number of zstd threads (0 uses half of available cores).
    all bool
    Whether to back up all known guests on the node.
    bwlimit int
    I/O bandwidth limit in KiB/s.
    compress str
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled bool
    Whether the backup job is enabled.
    exclude_paths Sequence[str]
    A list of paths to exclude from the backup.
    fleecing JobFleecingArgs
    Fleecing configuration for the backup job.
    ionice int
    I/O priority (0-8).
    lockwait int
    Maximum wait time in minutes for the global lock.
    mailnotification str
    Email notification setting (always or failure).
    mailtos Sequence[str]
    A list of email addresses to send notifications to.
    maxfiles int
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode str
    The backup mode (snapshot, suspend, or stop).
    node str
    The cluster node name to limit the backup job to.
    notes_template str
    Template for notes attached to the backup.
    pbs_change_detection_mode str
    PBS change detection mode (legacy, data, or metadata).
    performance JobPerformanceArgs
    Performance-related settings for the backup job.
    pigz int
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool str
    Limit backup to guests in the specified pool.
    protected bool
    Whether the backup should be marked as protected.
    prune_backups Mapping[str, str]
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove bool
    Whether to remove old backups if there are more than maxfiles.
    repeat_missed bool
    Whether to repeat missed backup jobs as soon as possible.
    resource_id str
    The identifier of the backup job.
    schedule str
    Backup schedule in systemd calendar event format.
    script str
    Path to a script to execute before/after the backup job.
    starttime str
    The scheduled start time (HH:MM).
    stdexcludes bool
    Whether to exclude common temporary files from the backup.
    stopwait int
    Maximum wait time in minutes for a guest to stop.
    storage str
    The storage identifier for the backup.
    tmpdir str
    Path to the temporary directory for the backup job.
    vmids Sequence[str]
    A list of guest VM/CT IDs to include in the backup job.
    zstd int
    Number of zstd threads (0 uses half of available cores).
    all Boolean
    Whether to back up all known guests on the node.
    bwlimit Number
    I/O bandwidth limit in KiB/s.
    compress String
    The compression algorithm (0, 1, gzip, lzo, or zstd).
    enabled Boolean
    Whether the backup job is enabled.
    excludePaths List<String>
    A list of paths to exclude from the backup.
    fleecing Property Map
    Fleecing configuration for the backup job.
    ionice Number
    I/O priority (0-8).
    lockwait Number
    Maximum wait time in minutes for the global lock.
    mailnotification String
    Email notification setting (always or failure).
    mailtos List<String>
    A list of email addresses to send notifications to.
    maxfiles Number
    Deprecated: use pruneBackups instead. Maximum number of backup files per guest.
    mode String
    The backup mode (snapshot, suspend, or stop).
    node String
    The cluster node name to limit the backup job to.
    notesTemplate String
    Template for notes attached to the backup.
    pbsChangeDetectionMode String
    PBS change detection mode (legacy, data, or metadata).
    performance Property Map
    Performance-related settings for the backup job.
    pigz Number
    Number of pigz threads (0 disables, 1 uses single-threaded gzip).
    pool String
    Limit backup to guests in the specified pool.
    protected Boolean
    Whether the backup should be marked as protected.
    pruneBackups Map<String>
    Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
    remove Boolean
    Whether to remove old backups if there are more than maxfiles.
    repeatMissed Boolean
    Whether to repeat missed backup jobs as soon as possible.
    resourceId String
    The identifier of the backup job.
    schedule String
    Backup schedule in systemd calendar event format.
    script String
    Path to a script to execute before/after the backup job.
    starttime String
    The scheduled start time (HH:MM).
    stdexcludes Boolean
    Whether to exclude common temporary files from the backup.
    stopwait Number
    Maximum wait time in minutes for a guest to stop.
    storage String
    The storage identifier for the backup.
    tmpdir String
    Path to the temporary directory for the backup job.
    vmids List<String>
    A list of guest VM/CT IDs to include in the backup job.
    zstd Number
    Number of zstd threads (0 uses half of available cores).

    Supporting Types

    JobFleecing, JobFleecingArgs

    Enabled bool
    Whether fleecing is enabled.
    Storage string
    The storage identifier for fleecing.
    Enabled bool
    Whether fleecing is enabled.
    Storage string
    The storage identifier for fleecing.
    enabled Boolean
    Whether fleecing is enabled.
    storage String
    The storage identifier for fleecing.
    enabled boolean
    Whether fleecing is enabled.
    storage string
    The storage identifier for fleecing.
    enabled bool
    Whether fleecing is enabled.
    storage str
    The storage identifier for fleecing.
    enabled Boolean
    Whether fleecing is enabled.
    storage String
    The storage identifier for fleecing.

    JobPerformance, JobPerformanceArgs

    MaxWorkers int
    Maximum number of workers for parallel backup.
    PbsEntriesMax int
    Maximum number of entries for PBS catalog.
    MaxWorkers int
    Maximum number of workers for parallel backup.
    PbsEntriesMax int
    Maximum number of entries for PBS catalog.
    maxWorkers Integer
    Maximum number of workers for parallel backup.
    pbsEntriesMax Integer
    Maximum number of entries for PBS catalog.
    maxWorkers number
    Maximum number of workers for parallel backup.
    pbsEntriesMax number
    Maximum number of entries for PBS catalog.
    max_workers int
    Maximum number of workers for parallel backup.
    pbs_entries_max int
    Maximum number of entries for PBS catalog.
    maxWorkers Number
    Maximum number of workers for parallel backup.
    pbsEntriesMax Number
    Maximum number of entries for PBS catalog.

    Import

    $ pulumi import proxmoxve:backup/job:Job daily_backup daily-backup

    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.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.