MaxBack Configuration Options

The MaxBack VSS Writer supports various options to configure it for your requirements.

Configuration Model

MaxBack 4.x uses a transparent 3-layer configuration model:

1. Defaults — Base defaults that apply to every installation. These are the values used when no config set or custom overrides are active.
2. Config Set — Veeam or AzureBackup config sets override specific defaults for that backup tool. Only the values that differ from defaults are stored in the config set.
3. Custom — Your own overrides. Only values that differ from the active config set + defaults are stored.

Use options list to see all values with their origin (default, configset, or custom), making it transparent where each setting comes from. Use option reset to remove a custom override — the value falls back to the config set or default.

Managing Configuration

Use the command-line client to view and change all configuration options:

List all options:

maxback.vssclient options list -d <dbname>

Get a specific option:

maxback.vssclient option get -d <dbname> -o <option>

Set an option:

maxback.vssclient option set -d <dbname> -o <option> -v <value>

Reset to default:

maxback.vssclient option reset -d <dbname> -o <option>

Switch configuration set:

maxback.vssclient options configset -d <dbname> -s <configset>

See the command-line reference for all available commands and options.

Configuration Sets

Configuration sets provide best-practices defaults for specific backup tools. Each set overrides only the values that differ from the base defaults.

Veeam Configuration Set

The Veeam config set applies the following overrides:

• MediaName: Veeam
• EnableAutorecovery: true
• CopyAutorecoveryBehaviour: Enabled
• CopyDataVolumeBehaviour: CancelAfterSnapshot
• LogSettings:BackupBeforeSnapshot: true
• LogSettings:BackupOnBackupComplete: true
• LogSettings:TruncateOnBackupComplete: FullBackup

Azure Backup Configuration Set

The Azure Backup config set applies the following overrides:

• MediaName: AzureBackup
• EnableAutorecovery: true
• CopyAutorecoveryBehaviour: Enabled
• CopyDataVolumeBehaviour: CancelAfterSnapshot
• AzureBackupCopyModeCheck: Enabled
• LogSettings:BackupBeforeSnapshot: true
• LogSettings:TruncateOnBackupComplete: FullBackup

Configuration Storage

Configuration is stored per writer instance as JSON:

• Folder: C:\ProgramData\dbosoft\MaxBack\VSSWriter\<DatabaseName>
• File Name: settings.json

Only custom overrides are stored in this file. The primary way to manage configuration is via the command-line client — editing the JSON file directly is not recommended.

Configuration Options Reference

Option Details

CopyDataVolumeBehaviour — Controls how data volume backups are handled in copy backups:

• Default — Component selection is used to decide if data volumes have to be backed up
• DisableBackup — Force disable backup of data volumes in copy mode
• CancelAfterSnapshot — The database will be prepared for data volume backup, but is cancelled when the VSS snapshot is removed

LogSettings:TruncateOnBackupComplete — Controls log truncation:

• Disabled — No logs are truncated
• FullBackup — Logs are truncated if a full backup is created
• Always — Even if only a copy backup is created, the log files are truncated

Upgrading from MaxBack 3.x

MaxBack 4.x uses a JSON-based configuration model replacing the old XML format (writer.config). If you have an existing 3.x installation, run:

maxback.vssclient options upgrade -d <dbname>

The upgrade tool will:

1. Detect your old XML configuration (writer.config)
2. Identify the matching configuration set and ask you to confirm
3. Migrate only values that differ from the config set defaults into custom settings
4. Remove the old XML configuration