Start/notes.ini Parameters/DEBUG_BACKUP

DEBUG_BACKUP

🛠️
Parameter: DEBUG_BACKUP
Short description: Enables debug output for the Domino backup task (dominobackup.nsf) for analyzing backup, snapshot, and restore runs.

Profile

Parameter
DEBUG_BACKUP
Category
Logging / Debug
Component
Server
Available since
12.0
Supported versions
12.0, 14.0, 14.5, 14.5.1
GUI equivalent
notes.ini only (no GUI)
Possible values
0 = off (default), 1 = on

Description

With Domino 12, the integrated backup framework was introduced (configured in dominobackup.nsf). DEBUG_BACKUP=1 turns on detailed debug output for this task – start/end of individual databases, snapshot creation, transaction log handling, inline copy or file system snapshot calls, and cleanup.
In case of an error (e.g. backup skipped certain NSFs, inline copy aborts, snapshot script returns error code), the log provides the necessary clues to check the configuration in dominobackup.nsf and the snapshot script.

Example configuration

DEBUG_BACKUP=1
Debug_Outfile=/local/notesdata/IBM_TECHNICAL_SUPPORT/backup_debug.log

Notes & pitfalls

  • Enable only during diagnosis – produces extensive logs.
  • Takes effect during the next backup run; a server restart is not strictly required.
  • Complementary to Debug_Outfile and BACKUP_* parameters in dominobackup.nsf.
  • For snapshot backups, additionally evaluate script logs from the storage/hypervisor vendor.
  • Entries appear in console.log and in the backup log file.