Returns the Proxmox Backup Server version, release, and repository ID. Use this to confirm connectivity and check which PBS version is running.

Returns detailed status of the PBS node: CPU usage, memory, disk, swap, load averages, uptime, and kernel version.

Returns:

• CPU model, core count, and current usage percentage

• Memory: free / total / used

• Root filesystem: available / total / used

• Swap: free / total / used

• Uptime and load averages

• Kernel version

List recent tasks on the PBS node. Returns task UPID, type, user, start/end times, and status.

Args:

• limit (number): Max tasks to return (default 30, max 200)

• running (boolean): If true, only show currently running tasks

• typefilter (string): Filter by task type, e.g. "garbage_collection", "verify", "prune", "sync"

• statusfilter (string): Filter by status, e.g. "ok", "error"

Returns: List of tasks with UPID, type, user, timestamps, and completion status.

Get the status and log output of a specific task by its UPID.

Args:

• upid (string): The task UPID

Returns: Task status and log lines.

List all configured datastores on the PBS server with their paths, comments, and retention settings.

Returns: Array of datastores with name, path, comment, GC schedule, prune schedule, and keep-* retention counts.

Get usage statistics for all datastores: total/used/available space, GC status, and deduplication factor.

Returns: For each datastore: name, total, used, available, percent used, GC last-run time, dedup factor, removed/pending bytes/chunks.

List all backup groups in a datastore. Groups are organized by backup type (vm, ct, host) and ID.

Args:

• store (string): Datastore name

• ns (string, optional): Namespace path (e.g. "ns1/ns2")

Returns: Array of backup groups with type, ID, last backup time, backup count, and owner.

List snapshots in a datastore, optionally filtered by backup type and ID.

Args:

• store (string): Datastore name

• backup_type (string, optional): Filter by type — "vm", "ct", or "host"

• backup_id (string, optional): Filter by backup ID (e.g. "100")

• ns (string, optional): Namespace path

Returns: Array of snapshots with type, ID, timestamp, size, protection status, verification state, and file list.

Start a garbage collection job on a datastore. Returns the task UPID which can be tracked with pbs_get_task_status.

Args:

• store (string): Datastore name

Returns: Task UPID for the started GC job.

Start a verification job on a datastore to check backup integrity. Returns a task UPID.

Args:

• store (string): Datastore name

• backup_type (string, optional): Only verify this backup type

• backup_id (string, optional): Only verify this backup ID

• ignore_verified (boolean, optional): Skip already-verified snapshots (default true)

• outdated_after (number, optional): Re-verify if last verification is older than this many days

• ns (string, optional): Namespace path

Returns: Task UPID for the started verification job.

Run a prune operation on a backup group to remove old snapshots per retention policy. Supports dry-run mode.

Args:

• store (string): Datastore name

• backup_type (string): Backup type — "vm", "ct", or "host"

• backup_id (string): Backup ID (e.g. "100")

• dry_run (boolean, optional): If true, only show what would be pruned (default false)

• keep_last (number, optional): Keep the last N snapshots

• keep_hourly (number, optional): Keep N hourly snapshots

• keep_daily (number, optional): Keep N daily snapshots

• keep_weekly (number, optional): Keep N weekly snapshots

• keep_monthly (number, optional): Keep N monthly snapshots

• keep_yearly (number, optional): Keep N yearly snapshots

• ns (string, optional): Namespace path

Returns: Task UPID or dry-run results showing which snapshots would be removed/kept.

List backup namespaces in a datastore.

Args:

• store (string): Datastore name

• parent (string, optional): Parent namespace to list children of

Returns: Array of namespace paths and their comments.

Set or remove protection on a backup snapshot. Protected snapshots cannot be pruned or deleted.

Args:

• store (string): Datastore name

• backup_type (string): "vm", "ct", or "host"

• backup_id (string): Backup ID

• backup_time (string): Backup timestamp in ISO format (e.g. "2025-03-22T04:00:00Z")

• protected (boolean): true to protect, false to unprotect

• ns (string, optional): Namespace path

Returns: Confirmation of the protection change.

List all scheduled verification jobs configured on the PBS server.

Returns: Array of verification jobs with ID, store, schedule, ignore-verified flag, outdated-after, namespace, and comment.

Manually trigger a configured verification job by ID.

Args:

• id (string): Verification job ID

Returns: Task UPID for the started job.

List all configured sync jobs that replicate data between PBS servers.

Returns: Array of sync jobs with ID, local store, remote name, remote store, schedule, remove-vanished flag, namespace settings, and comments.

Manually trigger a configured sync job by ID.

Args:

• id (string): Sync job ID

Returns: Task UPID for the started job.

List all configured scheduled prune jobs.

Returns: Array of prune jobs with ID, store, schedule, retention settings, namespace, and disabled status.

List all configured remote PBS servers used for sync jobs.

Returns: Array of remotes with name, host, port, auth-id, fingerprint, and comment.