Restore parameters
EnterpriseBacula Enterprise Only
This solution is only available for Bacula Enterprise. For subscription inquiries, please reach out to sales@baculasystems.com.
The plugin is able to restore to the local file system on the server where the File Daemon is running or to the Microsoft 365 environment. The method is selected based on the value of the where parameter at restore time:
Empty or ‘/’ (example: where=/) → Microsoft 365 restore will be triggered
Any other path for where (example: where=/tmp) → Local file system restore will be triggered
When using the Microsoft 365 restore option, the following parameters may be modified by selecting ‘Plugin Options’ during the bconsole restore session:
Option |
Required |
Default |
Values |
Example |
Services |
Description |
|---|---|---|---|---|---|---|
destination_user |
No |
Existing email address on the target Azure AD Tenant |
email, drive, contact, calendar, onenote, tasks, chat |
Destination User where restore data will be uploaded. If no user is set, every selected file will be restored in the original account |
||
destination_group |
No |
Existing group name address on the target Azure AD Tenant |
Marketing |
drive, calendar, onenote |
Destination Group where restore data will be uploaded. If no group is set, every selected file will be restored in the original group |
|
destination_site |
No |
Existing site name/display name on the target Azure AD Tenant |
live @ contoso |
drive, sharepoint, onenote |
Destination Site where restore data will be uploaded. If no site is set, every selected file will be restored in the original site |
|
destination_path |
No |
Existing path on the selected user (mailfolder path or onedrive folder path) |
Inbox |
email, drive, contact, calendar, sharepoint |
Destination folder where all selected files to restore will be restored. If no path is set: - If no user is set either, every element will go to its original location - If a user is set using the variable destination_user: - Elements belonging to destination_user will be restored in their original location - Elements belonging to different users than destination_user will be restored in a new folder using the email address of the original user of the element |
|
destination_drive |
No |
Existing drive name or drive id in the destination entity |
documents |
drive |
Destination drive where restore data will be uploaded. If no drive is set, every selected file will be restored in the original drive |
|
send_report |
No |
0 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
1 |
email, drive, contact, calendar, sharepoint, tasks |
Send a report to the user where every restore action is listed (generated emails, generated onedrive files..). - In the email service this will be an email in the user Inbox - In onedrive service this will generate a new text file in the top restore folder |
allow_duplicates |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
email, contact, calendar |
In Email services indicates if we want to allow to create duplicate emails or if we want to skip emails that are already in place. Important: This is done using the Microsoft Message ID. Therefore, non intuitive situations can happen. For example, if the original message is deleted and we restore several times using this option, we will see duplicate emails anyway |
drive_skip_sharedwitme |
No |
0 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
1 |
drive |
Skip restoring shared with me elements even if they are selected. |
skip_versions |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
drive |
Skip restoring former file versions (tagged with ‘###date’) even if they are selected. Important: Notice 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 |
restore_share_permissions |
No |
0 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
1 |
drive, calendar |
Restore share permissions of every element in order to regenerate sharing information as allowed identities, shared links, etc. Please note that this parameter is disabled by default.**Important**: Notice that this parameter is disabled by default, as we consider not restoring sharing permissions the most common case. You need to enable it in order to haver shared permissions restored |
drive_send_invitations |
No |
0 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
1 |
drive |
Send email invitations for restored OneDrive shares - Note you need to enable drive_restore_share_permissions in order to this parameter to have any effect |
drive_invitations_message |
No |
String |
I’m sharing with you automatically restored shares |
drive |
Set invitations message for restored OneDrive shares - Note you need to enable drive_restore_share_permissions in order to this parameter to have any effect |
|
calendar_name |
No |
String |
RestoredCalendar |
calendar |
Set the name of restored(s) calendar(s) |
|
sharepoint_list_name |
No |
String |
documentsCopy |
sharepoint |
Set the name of restored(s) sharepoint list(s) |
|
sharepoint_newsite_name |
No |
String |
Restored Site |
sharepoint |
Set the name of restored sharepoint new site |
|
sharepoint_newsite_owner |
No |
String |
sharepoint |
Set the owner of the new restored sharepoint site |
||
sharepoint_skip_system |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
sharepoint |
Skip restoring system lists even if they are selected. This is particularly useful to restore complete sites when using the sharepoint_newsite_name and sharepoint_newsite_owner restore parameters, as system lists are already included in the site template |
sharepoint_local_template_path |
No |
String |
/tmp/my-restores/company meeting.site.template.xml |
sharepoint |
Set the local path of the PnP Sharepoint Site template you want to be using instead of the one contained in the backup itself. |
|
notebook_name |
No |
String |
myRestoredNotes |
onenote |
Set the owner of the new restored sharepoint site |
|
notesection_name |
No |
String |
Technology |
onenote |
Set the name of restored onenote notebook |
|
notesection_group_name |
No |
String |
ForWork |
onenote |
Set the name of restored onenote section |
|
team_name |
No |
String |
MyRestoredTeam |
teams |
Set the name of restored team (it will create also a new associated group) |
|
team_channel_name |
No |
String |
MyRestoredChannel |
teams |
Set the name of restored channel |
|
team_private_channels_mode |
No |
DELEGATED |
DELEGATED, PUBLIC, SKIP |
PUBLIC |
teams |
Set the private channels restore mode |
team_guest_members_enable |
No |
0 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
1 |
teams |
Enable restore of team members with role ‘guest’. That kind of external user needs delegated permissions to be added, so potentially the restore could ask for user interaction (of first team owner found) |
chat_topic |
No |
String |
MyRestoredChat |
chat |
Set the topic of restored chat (supported only for group chats) |
|
tasklist_name |
No |
String |
ProjectA |
tasks |
Set the name of restored task list |
|
tasklist_skip_sharedwithme |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
tasks |
Skip shared with me tasks in the restore process |
plan_name |
No |
String |
RestoredPlan |
tasks |
Set the name of restored planner plan |
|
plan_create_tab |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
tasks |
Create or not an associated tab inside the associated team |
local_path_json_objects |
No |
{path}/bacula-restores |
String |
/home/me/restores |
onenote, sharepoint |
Set local path to restore objects that cannot be restored directly into the M365 service |
foreign_container_generation |
No |
1 |
0, no, No, false, FALSE, false, off ; 1, yes, Yes, TRUE, true, on |
0 |
email, drive, contact, calendar |
Generate a general container (usually a folder) to put restored objects coming from different entities inside. For example, if we restore emails from user a@tenant.com into Mailbox of user b@tenant.com, this option enabled will generate an automatic folder a@tenant.com inside the destination restore folder used over destination user a@tenant.com |
tenant |
No |
A valid tenant id string where some bacula m365 plugin app is registered |
57uia43-d107-17a2-a2g2-aa53c10tdahc |
email, drive, contact, calendar, sharepoint, onenote, tasks, teams, chat |
Set the destination tenant id for a cross-tenant restore |
|
appid |
No |
Appid of bacula-m365-plugin-standalone app registered in the provided tenant |
56ddf1h9-eb5d-42nf-bac7-7b019fd284g5 |
email, drive, contact, calendar, sharepoint, onenote, tasks, teams, chat |
Set the destination appid of bacula-m365-plugin-standalone for a cross-tenant restore |
|
objectid |
No |
Object id associated to set up appid |
89tt4hu7-r4h7-kied-56gu-0895kf94jr9d |
email, drive, contact, calendar, sharepoint, onenote, tasks, teams, chat |
Set the objectid associated to the appid in a cross-tenant restore |
|
secret |
No |
Valid secret associated to appid |
Jn8.lU-B.3P5gIRTGY6M.Xl3e29oQ6Xaf~ |
email, drive, contact, calendar, sharepoint, onenote, tasks, teams, chat |
Set the secret associated to the appid set in the above parameter |
|
debug |
No |
0 |
0, 1, 2 ,3, 4, 5, 6, 7, 8, 9 |
3 |
email, drive, contact, calendar, sharepoint, onenote, tasks, teams, chat |
Change debug level |
See also
Previous articles:
Next articles:
Go back to: Fileset Configuration.