Restore Parameters

Bacula Enterprise Only

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

The S3 Plugin is able to restore to the local file system on the server where the File Daemon is running or to the S3 environment. The method selected is based on the value of the where parameter at restore time:

Empty or ‘/’ (example: where=/) → S3 restore method will be triggered
Any other path for where (example: where=/tmp) → Local file system restore will be triggered

When using S3 restore method, the following parameters may be modified by selecting ‘Plugin Options’ during the bconsole restore session:

Option	Required	Default	Values	Example	Description
destination_bucket	No		Destination bucket name	myrestorebucket	Destination bucket where restore data will be uploaded. If no bucket is set, every selected file will be restored in the original bucket
destination_path	No		Destination path to be created (or existing) into the selected bucket	RestoreFolder	Destination path where all selected files to restore will be placed. If no destination_path is provided, every selected file will be restored into their original path
destination_storageclass	No		STANDARD, REDUCED_REDUNDANCY, GLACIER, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR	ONEZONE_IA	Destination storage class to be used for the restore. If none is provided, the original storage class of this object will be used
skip_versions	No	1	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	0	Skip restoring former file versions (tagged with ‘###date’) even if they are selected. Important: Note that this parameter is enabled by default, as we consider not restoring file versions the most common case. You need to disable it in order to have this kind of files restored
skip_acl	No	1	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	0	Skip restoring ACLs even if they are selected. Important: Note that this parameter is enabled by default, as we consider not restoring file ACLs the most common case. You need to disable it in order to have this kind of information restored
disable_hashcheck	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	Yes	Disable hashcheck mechanism for file integrity, so you can avoid some computation resources or disable it if your S3 server does not support it
endpoint	No		URL of a S3 endpoint	https://192.168.10.4:9000	Cross-endpoint/bucket restore: Main URL where the S3 service is being served
access_key	Yes		Valid S3 access key to read from or write to buckets to backup	KMN02jCv5YpmirOa	Cross-endpoint/bucket restore: Valid access key to write to the bucket to restore
secret_key	Yes		Valid S3 secret key associated to the provided access_key to read from or write to buckets to backup	bTq6FzPbnU9x1jqka5STRDnz3CPLouyq	Cross-endpoint/bucket restore: Valid S3 secret key associated to the provided access_key to write to buckets to restore
region	No		AWS region code-name: eu-west-1, us-east-1, us‑east‑2, eu-west-1, eu-south-1…	us-east-2	Cross-endpoint/bucket restore: AWS Region code name where the buckets to write to exist: https://docs.aws.amazon.com/directoryservice/latest/admin-guide/regions.html
force_path_style	No	No	0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on	us-east-2	Cross-endpoint/bucket restore: Force requests to use PathStyle (http(s)://myS3host/bucketname) instead of HostStyle (http(s)://bucketname.myS3host)
config_file	No		The path pointing to a file containing any combination of plugin parameters	/opt/bacula/etc/s3-2.settings	Cross-endpoint/bucket restore: Allows you to define a new config file with different destination parameters for your restore. Therefore you don’t need to put them directly in the other restore options of the BConsole session. This is useful for improving the usability when typing complex parameters and/or for sensitive fields such as access_key or secret_key
debug	No		0, 1, 2 ,3, 4, 5, 6, 7, 8, 9	3	Change debug level

Restore options using S3 allow you to:

Restore into the original bucket or in a different one (destination_bucket)

Restore to the original endpoint or to a different one (see next ‘Cross endpoint restore’)

Restore to the original path or to a different one (destination_path)

Restore using the original storageclass or set up a new one for all the restored objects (destination_storageclass)

Restore selected file versions (unset skip_versions)

Restore selected ACLs (unset skip_acls)

Restore without using MD5 hashcheck (set disable_hashcheck)