Commandline Client

The commandline client MaxBack.VssClient is a tool to manage the MaxBack VSS Writer. Normally you use it only during the installation.

Commands

The help text from the command line is shown below for easy reference.

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

/? or –help Displays help for command

-d or –dbname Name of the database

read: Displays current instance configuration

connect: This command creates a service instance for the MaxDb database and configures the connection to the database.

This command will always update the password of user vsswriter.

-u

The username of the database administrator

Can contain password in Maxdb syntax: username,password

-p

Password for vsswriter user (optional)

-l

Name of Log media to be used (optional)

disconnect: Disconnects instance from the database

Windows service will be removed and user vsswriter deleted.

-u

The username of the database administrator

Can contain password in Maxdb syntax: username,password

getkey: Gets the instance license key

The license key will be in the command output.

instlicense: Installs license into the service

-f

The path to the license file

enableconfigset: Enables a configuration set

-s

The name of the config set. If not set the default configuration set will be enabled.

Supported values: Default, Veeam, AzureBackup

autorecovery: Triggers a autorecovery event without a entire VM restore

-m

Path to the metadata file from the data volume restore

setdbinst: By setting a explicit DB Instance with a JDBC driver you can use the JDBC based connect mode used up to VSS Writer 1.x

-i

Name of MaxDB installation to use (optional)

All commands will automatically query for all required options if not set on command line.

Examples

Connect to instance

Maxback.VssClient.exe connect -d PRD -u control,secret

get instance key

Maxback.VssClient.exe getkey -d PRD

install license

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

set MaxDB installation name and enable JDBC mode

Maxback.VssClient.exe setdbinst -d PRD -i MAXDB