MaxBack
by

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

Getting Started with MaxBack

This guide walks you through installing MaxBack and connecting it to your MaxDB database.

Prerequisites

Before installing, verify your environment meets these requirements:

Windows Server (x64) — Windows Server 2012 R2, 2016, 2019, or 2022.

Software — .NET Framework 4.7.1 or higher (downloaded by the setup if missing) and Visual C++ Redistributable 2017 x64 (included in the setup).

MaxDB — Version 7.8.2 or higher is required. MaxDB 7.9.08.39 or higher is recommended.

CacheMemorySize

The database parameter CacheMemorySize has to be large enough to create snapshots. See SAP note 2324249 for sizing recommendations.

Backup product — Any VSS backup product that supports component selection mode and snapshot backup. See Supported Backup Tools for tested products.

Installation

  1. Install binaries — Download and run the MaxBack setup package from the downloads page.

  2. Install the license — Copy the activation license file you received from our sales team to the database host, then run from an elevated command prompt:

    maxback.vssclient instlicense -f <path to the license file>

    If the host has internet access, the instance license will be activated automatically via the dbosoft license server.

    Trial License

    To activate a trial license, add the --temp option to the command.

    For hosts without internet access or if activation fails, see License Installation for offline activation and other options.

  3. Connect to the database — Create the writer instance from an elevated command prompt:

    maxback.vssclient connect

    This will:

    • Create a Windows service for the VSS Writer
    • Create a database user vsswriter with a random password
    • Ask for a log media name (the log medium must already exist in MaxDB)

    Log Media

    It is recommended to use a separate disk for log backups. See Log Management for recommendations.

  4. Enable a configuration set (recommended) — Apply a best-practices configuration for your backup tool:

    For Veeam:

    maxback.vssclient enableconfigset -s Veeam

    For Azure Backup:

    maxback.vssclient enableconfigset -s AzureBackup

    For other tools:

    maxback.vssclient enableconfigset

    This applies the default configuration. See Configuration for all available options.

Next steps