Backup Parameters

Enterprise

Bacula Enterprise Only

This solution is only available for Bacula Enterprise. For subscription inquiries, please reach out to sales@baculasystems.com.

The following parameters control backup scope and behavior.

Backup parameters

Option

Required

Default

Values

Example

Description

database

No

All application databases

Database name

appdb

Application database to include. Repeat or use comma-separated values where supported.

database_exclude

No

Database name

analytics_tmp

Database to exclude after include selection.

collection

No

All collections

Collection name

widgets

Collection name to include across selected databases.

collection_exclude

No

Collection name

temp_events

Collection to exclude after include selection.

include_admin

No

no

yes or no

yes

Include admin database. Intended only for isolated disaster-recovery artifacts.

skip_security

No

no

yes or no

yes

Skip application users and custom roles.

cleanup_on_success

No

no

yes or no

yes

Delete local artifact root after successful backup. Mainly for orchestrated runs.

dry_run

No

no

yes or no

yes

Run backup preflight only.

report_format

No

text

text or json

json

Dry-run report format.

Bacula Level Behavior

The plugin uses Bacula job metadata and local chain state to resolve the previous artifact for Incremental and Differential jobs.

For standalone and sharded deployments, Incremental and Differential jobs run as safe full-style fallback artifacts. For replica-set primaries, they capture oplog segments and participate in a point-in-time recovery chain.

Security Capture

By default, the plugin captures selected application database users and custom roles when the MongoDB user has sufficient privileges. Use skip_security=yes for lower-privilege data-only backups.

Use include_admin=yes only when the backup is intended for isolated disaster recovery. Normal in-place restore of admin content is intentionally guarded because it can overwrite administrative users and roles.

Go back to: Plugin Configuration.