MaxBack
by

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

MaxBack Command-Line Reference

Reference documentation for the MaxBack command-line tool.

MaxBack.VssClient

The primary tool for managing MaxBack VSS Writer instances. Used during installation, configuration, and licensing.

Maxback.Vssclient.exe [command] [-option value] [-switch]

Global options:

  • /? or --help — Displays help
  • -d or --dbname — Name of the database

All commands will automatically query for required options if not provided on the command line.

Commands

read

Displays current instance configuration and license status.

connect

Creates a service instance for the MaxDB database and configures the connection. Always updates the password of user vsswriter.

Options:

  • -u — Database administrator username. Can include password in MaxDB syntax: username,password
  • -p — Password for vsswriter user (optional)
  • -l — Name of log media to use (optional)

disconnect

Disconnects the instance from the database. Removes the Windows service and deletes the vsswriter user.

Options:

  • -u — Database administrator username. Can include password in MaxDB syntax: username,password

getkey

Outputs the instance license key. Used for offline license activation.

instlicense

Installs a license into the VSS Writer instance. If the license requires activation, requests an instance license from the dbosoft license server.

Options:

  • -f — Path to the license file
  • -b — Batch mode, uses default instance name {hostname}_{dbname} instead of prompting
  • --temp — Request a temporary evaluation license (requires an activatable license file)

enableconfigset

Applies a configuration set.

Options:

  • -s — Config set name. Values: Default, Veeam, AzureBackup. If omitted, applies the default set.

autorecovery

Triggers autorecovery manually, without a full VM or bare metal restore. See System Copy for usage.

Options:

  • -m — Path to the metadata file from the data volume restore
  • -b — Batch mode, prevents the Session Logviewer from starting

Examples

Connect to instance:

Maxback.VssClient.exe connect -u control,secret

Get instance key:

Maxback.VssClient.exe getkey -d PRD

Install license:

Maxback.VssClient.exe instlicense -f c:\license.lic