---
title: "Command Line Interface"
description: "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."
canonical: "https://helpcenter.veeam.com/docs/agentformac/userguide/ui_overview_cmd.html"
breadcrumb: "User Guide > Getting to Know User Interface > Command Line Interface"
dateModified: "2026-10-20"
---

# 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 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](#command) and type it in the terminal prompt.

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

In Veeam Agent command line interface, in addition to operations that you can perform with the Veeam Agent graphic user interface, you can perform a set of advanced tasks — for example:

  - Synchronize Veeam Agent with Veeam backup server.
  - Edit backup repository settings.
  - Monitor performance and status of any backup, restore and other data transfer session that was started in Veeam Agent.
  - Export/import Veeam Agent configuration database to/from a configuration file.

## Constructing Commands for Veeam Agent {#command}

You should construct a command in the following format:

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

where:

- `<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:

  - agreement
  - backup
  - cloud
  - config
  - gfs
  - grablogs
  - healthcheck
  - help
  - job
  - license
  - mode
  - objectstorage
  - point
  - repository
  - schedule
  - session
  - settings
  - 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
  - createrepository
  - delete
  - disable
  - edit
  - enable
  - help
  - list
  - rescan
  - set

- `<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@wrk01:~$ veeamconfig repository list
Name          ID                                      Location            Type      Accessible   Backup server
Repository_1  {818e3a0f-8155-4a51-9430-248a203a43d1}  /home/backups       local     true
Repository_2  {2155a2e7-a1e9-4347-9d8b-cf8f3a6f3fcb}  172.17.53.47/veeam  cifs      true
```

## Viewing Help {#help}

You can view short help information on the specific Veeam Agent command. To view help, use the following command:

```
veeamconfig <command> help
```

where:

`<command>` — name of the command for which you want to view help information.

For example:

```
user@wrk01:~$ veeamconfig help
```

or

```
user@wrk01:~$ veeamconfig job help
```

or

```
user@wrk01:~$ veeamconfig job create help
```