Command Line Interface

Veeam Agent command line interface is a powerful tool that lets users perform advanced operations that are not supported by the Veeam Agent control panel.

To work with Veeam Agent using command line interface, you can use a terminal console (TTY) or a terminal emulator of your choice. All tasks in Veeam Agent are performed with the veeamconfig command-line utility. To perform tasks with Veeam Agent, you should construct the necessary command and type it in the Linux shell prompt.

You can view short help information on every Veeam Agent command at any time you need. To learn more, see Viewing Help.

You should construct a command in the following format:

veeamconfig <command_1> <command_2> --<parameter_1> --<parameter_2> --<parameter_n>


  • <command_1> — command that defines a type of an object with which you want to perform a task. Currently, the following commands are available in Veeam Agent:
  • aap
  • agreement
  • backup
  • cloud
  • config
  • downloadiso
  • gfs
  • grablogs
  • help
  • job
  • license
  • mode
  • objectstorage
  • patchiso
  • point
  • repository
  • schedule
  • session
  • ui
  • version
  • vbrserver
  • <command_2> — command that defines a task that you want to perform with an object of the specified type. For example, you can perform the following commands with backup repositories:
  • create
  • delete
  • edit
  • help
  • list
  • rescan
  • <parameter_1>, <parameter_2>, <parameter_n> — parameters for the command that you want to execute. Commands may require one or several mandatory or optional parameters. Some commands, for example, veeamconfig ui and veeamconfig [<command>] help do not require parameters.

The following example shows the command that displays a list of backup repositories configured in Veeam Agent and the output of this command:

user@srv01:~$ veeamconfig repository list
Name          ID                                      Location            Type   Backup server
Repository_1  {818e3a0f-8155-4a51-9430-248a203a43d1}  /home/backups       local              
Repository_2  {2155a2e7-a1e9-4347-9d8b-cf8f3a6f3fcb}  cifs