HCL Domino Backup (on Windows) using Virtual Machine backup app (like VeeAm, Nakivo)
Background
This article was written on 31-Oct-24.
References:
https://opensource.hcltechsw.com/domino-backup/
For me, that article is excellent but very challenging to understand.
So here it is, I tried to summarize what we need to do to backup HCL Domino (on Windows) virtual machine using virtual machine backup app like VeeAm or Nakivo.
Precautions
As stated above, I may not have a full understanding to how it should be done, so follow with your own precaution.
Always try to restore your backup to ensure that backup process is prudent.
Prerequisites
HCL Domino running on Windows Server virtual machine on Hyper-V.
Running Hyper-V backup app like VeeAm or Nakivo.
Process
HCL Domino version 12 onwards already have a built in backupvss plug in which works with Microsoft Volume Shadow Copy Service to create snapshot backup.
If we do not use this plugin and vss, then backup processed using hyper-v backup will be crash consistent only, not application consistent.
See below article for more information on this terms.
https://www.nakivo.com/blog/crash-consistent-vs-application-consistent-backup/
Running Domino backupvss task
Although HCL backupvss is provided, it will not run automatically, you need to edit your notes.ini and add the backupvss task.
You can also manually run the task using Domino console: load backupvss.
Still from Domino Console, check that backupvss task is running using command: show tasks
Configuring Domino backup
Using Domino Admin, go to files, find and open dominobackup.nsf
Copy the default configuration using ctrl+c and ctrl+v
Double click on your new backup config to open and press edit document.
Most importantly, set Status: Enabled.
Domino backupvss will not run if it cannot find an enabled configuration.
As we will not use file based backup, then we can omit most of the fields.
Backup log dir is still necessary and put Description to differentiate with default config.
On the backup tab, set all blank as we will not use file based backup.
As we will use VSS, then we can enforce snapshot mode.
Leave all else blank as well.
I set restore and prune to all blank as I will use backup app (not use Domino restore function) to restore files.
I set to receive notification for “OK” as I want confirmation that domino backupvss is working well.
Fill in the recipient in quotes and choose your sender server.
Backup App Configuration
Just create a backup job for Hyper-V virtual machine, no need to specify any script.
Backup process
When your backup app start backup job, Domino backupvss will run automatically. You can see/watch this in Console or in log.
and you will receive email notification when Domino backup is working well.
Very good, once you received your domino backup success email notification that means you have succeed in setting up and running your virtual machine backup for HCL Domino !
Now go out and enjoy life :)
