MaxBack
by

You are viewing documentation for v3. View the latest version (v4)

MaxBack Configuration Options

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

Configuration Sets

We deliver best practices configuration sets to preconfigure the writer instance for your backup tool. To activate these configuration sets, use the command-line client.

Veeam Configuration Set

The following options will be set if you enable the Veeam configuration set:

  • Backup Media Name: Veeam
  • enableAutoRecovery: true
  • copyDataVolumeBehaviour: CancelAfterSnapshot
  • Log Settings — backupBeforeSnapshot: true
  • Log Settings — backupOnBackupComplete: true
  • Log Settings — truncateOnBackupComplete: FullBackup

Azure Backup Configuration Set

The following options will be set if you enable the Azure Backup configuration set:

  • Backup Media Name: AzureBackup
  • enableAutoRecovery: true
  • copyDataVolumeBehaviour: CancelAfterSnapshot
  • Log Settings — backupBeforeSnapshot: true
  • Log Settings — backupOnBackupComplete: false
  • Log Settings — truncateOnBackupComplete: FullBackup

Configuration Settings

Configuration settings are stored per writer instance in an XML file in the writer data folder:

  • Folder: C:\ProgramData\dbosoft\MaxBack\VSSWriter\<DatabaseName>
  • File Name: writer.config

If the writer config file doesn't exist, you can create it by applying the default configuration to the instance:

maxback.vssclient enableconfigset

vssWriter Element

The following configuration values are supported for the vssWriter element:

<was.maxdb>
  <vssWriter mode="Standalone" mediaName="VSS" enableAutorecovery="false">
  </vssWriter>
</was.maxdb>

Attributes:

  • mode — Currently only the value Standalone is allowed
  • useJdbcDriver — Enables the fallback to JDBC driver mode. Enable this only if recommended by our support.
  • mediaName — Name of the MaxDB backup media (backup template)
  • enableAutorecovery — Enables the Autorecovery feature
  • copyDataVolumeBehaviour — Option to configure how data volume backups will be handled in copy backups. Values:
    • 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 Element

The following configuration values are supported for the logSettings element:

<was.maxdb>
  <vssWriter>
    <logSettings
      mediaName=""
      backupBeforeSnapshot="true"
      backupOnBackupComplete="false"
      truncateOnBackupComplete="Disabled"
    />
  </vssWriter>
</was.maxdb>

Attributes:

  • mediaName — Specifies the log media to consider for backup. Can contain a list of values separated by ;
  • backupBeforeSnapshot — Enables the Log Backup before Snapshot feature. Creates a log backup before the snapshot of the volume is created.
  • backupOnBackupComplete — Enables the Log Backup after database backup feature. Creates a log backup after the backup is completed (and after truncation).
  • truncateOnBackupComplete — Configures the Log truncation feature:
    • 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