Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
Retrieves the list of cluster-wide backup jobs.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as proxmoxve from "@muhlba91/pulumi-proxmoxve";
const all = proxmoxve.backup.getJobs({});
import pulumi
import pulumi_proxmoxve as proxmoxve
all = proxmoxve.backup.get_jobs()
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.GetJobs(ctx, map[string]interface{}{}, nil)
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 all = ProxmoxVE.Backup.GetJobs.Invoke();
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.proxmoxve.backup.BackupFunctions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var all = BackupFunctions.getJobs(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
}
}
variables:
all:
fn::invoke:
function: proxmoxve:backup:getJobs
arguments: {}
Using getJobs
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getJobs(opts?: InvokeOptions): Promise<GetJobsResult>
function getJobsOutput(opts?: InvokeOptions): Output<GetJobsResult>def get_jobs(opts: Optional[InvokeOptions] = None) -> GetJobsResult
def get_jobs_output(opts: Optional[InvokeOptions] = None) -> Output[GetJobsResult]func GetJobs(ctx *Context, opts ...InvokeOption) (*GetJobsResult, error)
func GetJobsOutput(ctx *Context, opts ...InvokeOption) GetJobsResultOutput> Note: This function is named GetJobs in the Go SDK.
public static class GetJobs
{
public static Task<GetJobsResult> InvokeAsync(InvokeOptions? opts = null)
public static Output<GetJobsResult> Invoke(InvokeOptions? opts = null)
}public static CompletableFuture<GetJobsResult> getJobs(InvokeOptions options)
public static Output<GetJobsResult> getJobs(InvokeOptions options)
fn::invoke:
function: proxmoxve:backup/getJobs:getJobs
arguments:
# arguments dictionarygetJobs Result
The following output properties are available:
- Id string
- Unique identifier for this data source.
- Jobs
List<Pulumi.
Proxmox VE. Backup. Outputs. Get Jobs Job> - List of backup jobs.
- Id string
- Unique identifier for this data source.
- Jobs
[]Get
Jobs Job - List of backup jobs.
- id String
- Unique identifier for this data source.
- jobs
List<Get
Jobs Job> - List of backup jobs.
- id string
- Unique identifier for this data source.
- jobs
Get
Jobs Job[] - List of backup jobs.
- id str
- Unique identifier for this data source.
- jobs
Sequence[Get
Jobs Job] - List of backup jobs.
- id String
- Unique identifier for this data source.
- jobs List<Property Map>
- List of backup jobs.
Supporting Types
GetJobsJob
- All bool
- Indicates whether all VMs and CTs are backed up.
- Compress string
- Compression algorithm used for the backup.
- Enabled bool
- Indicates whether the backup job is enabled.
- Id string
- Unique identifier of the backup job.
- Mailnotification string
- When to send email notifications (always or failure).
- Mailtos List<string>
- List of email addresses for notifications.
- Mode string
- Backup mode (e.g. snapshot, suspend, stop).
- Node string
- Node on which the backup job runs.
- Notes
Template string - Template for backup notes.
- Pool string
- Pool whose members are backed up.
- Protected bool
- Indicates whether backups created by this job are protected from pruning.
- Prune
Backups Dictionary<string, string> - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- Schedule string
- Backup schedule in systemd calendar format.
- Storage string
- Target storage for the backup.
- Vmids List<string>
- List of VM/CT IDs included in the backup job.
- All bool
- Indicates whether all VMs and CTs are backed up.
- Compress string
- Compression algorithm used for the backup.
- Enabled bool
- Indicates whether the backup job is enabled.
- Id string
- Unique identifier of the backup job.
- Mailnotification string
- When to send email notifications (always or failure).
- Mailtos []string
- List of email addresses for notifications.
- Mode string
- Backup mode (e.g. snapshot, suspend, stop).
- Node string
- Node on which the backup job runs.
- Notes
Template string - Template for backup notes.
- Pool string
- Pool whose members are backed up.
- Protected bool
- Indicates whether backups created by this job are protected from pruning.
- Prune
Backups map[string]string - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- Schedule string
- Backup schedule in systemd calendar format.
- Storage string
- Target storage for the backup.
- Vmids []string
- List of VM/CT IDs included in the backup job.
- all Boolean
- Indicates whether all VMs and CTs are backed up.
- compress String
- Compression algorithm used for the backup.
- enabled Boolean
- Indicates whether the backup job is enabled.
- id String
- Unique identifier of the backup job.
- mailnotification String
- When to send email notifications (always or failure).
- mailtos List<String>
- List of email addresses for notifications.
- mode String
- Backup mode (e.g. snapshot, suspend, stop).
- node String
- Node on which the backup job runs.
- notes
Template String - Template for backup notes.
- pool String
- Pool whose members are backed up.
- protected_ Boolean
- Indicates whether backups created by this job are protected from pruning.
- prune
Backups Map<String,String> - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- schedule String
- Backup schedule in systemd calendar format.
- storage String
- Target storage for the backup.
- vmids List<String>
- List of VM/CT IDs included in the backup job.
- all boolean
- Indicates whether all VMs and CTs are backed up.
- compress string
- Compression algorithm used for the backup.
- enabled boolean
- Indicates whether the backup job is enabled.
- id string
- Unique identifier of the backup job.
- mailnotification string
- When to send email notifications (always or failure).
- mailtos string[]
- List of email addresses for notifications.
- mode string
- Backup mode (e.g. snapshot, suspend, stop).
- node string
- Node on which the backup job runs.
- notes
Template string - Template for backup notes.
- pool string
- Pool whose members are backed up.
- protected boolean
- Indicates whether backups created by this job are protected from pruning.
- prune
Backups {[key: string]: string} - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- schedule string
- Backup schedule in systemd calendar format.
- storage string
- Target storage for the backup.
- vmids string[]
- List of VM/CT IDs included in the backup job.
- all bool
- Indicates whether all VMs and CTs are backed up.
- compress str
- Compression algorithm used for the backup.
- enabled bool
- Indicates whether the backup job is enabled.
- id str
- Unique identifier of the backup job.
- mailnotification str
- When to send email notifications (always or failure).
- mailtos Sequence[str]
- List of email addresses for notifications.
- mode str
- Backup mode (e.g. snapshot, suspend, stop).
- node str
- Node on which the backup job runs.
- notes_
template str - Template for backup notes.
- pool str
- Pool whose members are backed up.
- protected bool
- Indicates whether backups created by this job are protected from pruning.
- prune_
backups Mapping[str, str] - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- schedule str
- Backup schedule in systemd calendar format.
- storage str
- Target storage for the backup.
- vmids Sequence[str]
- List of VM/CT IDs included in the backup job.
- all Boolean
- Indicates whether all VMs and CTs are backed up.
- compress String
- Compression algorithm used for the backup.
- enabled Boolean
- Indicates whether the backup job is enabled.
- id String
- Unique identifier of the backup job.
- mailnotification String
- When to send email notifications (always or failure).
- mailtos List<String>
- List of email addresses for notifications.
- mode String
- Backup mode (e.g. snapshot, suspend, stop).
- node String
- Node on which the backup job runs.
- notes
Template String - Template for backup notes.
- pool String
- Pool whose members are backed up.
- protected Boolean
- Indicates whether backups created by this job are protected from pruning.
- prune
Backups Map<String> - Retention options as a map of keep policies (e.g. keep-last = "3", keep-weekly = "2").
- schedule String
- Backup schedule in systemd calendar format.
- storage String
- Target storage for the backup.
- vmids List<String>
- List of VM/CT IDs included in the backup job.
Package Details
- Repository
- proxmoxve muhlba91/pulumi-proxmoxve
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
proxmoxTerraform Provider.
Viewing docs for Proxmox Virtual Environment (Proxmox VE) v8.0.0
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
published on Sunday, Apr 5, 2026 by Daniel Muehlbachler-Pietrzykowski
