%PDF- %PDF- Mini Shell
Mini Shell

Current File : //usr/share/man/man8/veeamconfig.8
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH VEEAMCONFIG(8) "2023" Linux "User Manuals"
.SH NAME

veeamconfig - Veeam Agent for Linux configuration tool
.SH SYNOPSIS

.B veeamconfig
{
.I OBJECT
|
.B help
}
{
.I  ACTION 
|
.B help
}
--argument1
.I <value>
--argument2
.I <value>
...
--argumentN
.I <value>
[OPTIONAL ARGUMENTS]
.SH DESCRIPTION
.PP                                                     
veeamconfig is a command-line tool for configuring and monitoring Veeam Agent for Linux. All command are case-insensitive.

To use the
.B veeamconfig
tool, a user must belong to the
.B veeam
group which is automatically created during the installation of Veeam Agent for Linux.

If
.B veeamconfig
is invoked with no arguments, it lists objects that can be subjects to actions.

If
.B veeamconfig
is invoked with an object following it, it lists actions that are applicable to the object.

An action must be followed by an action-specific set of arguments that require a value. Some arguments take default values in case no value is provided by user.

Invocation of
.B veeamconfig
with only an object and an action specified lists a complete set of arguments that are applicable to the action.

.SH OBJECTS, ACTIONS, ARGUMENTS

.HP 5
REPOSITORY - a repository is a storage location where backup files are kept;

.B veeamconfig repository create
--name <value> --location <value> [ --type {local|smb|nfs} { [ --domain <value> --username <value> --password <value> ] | --options } ]

.B veeamconfig repository edit
--<parameter> <newValue>
.B for
--name <objectName>

.B veeamconfig repository rescan
{--name <value> | --id <value> | --all} [ --skipencrypted ]

.B veeamconfig repository delete
{--name <value> | --id <value>} [ --answer <value> ]

.B veeamconfig repository list

EXAMPLE 1: veeamconfig repository create --name MyRepo1 --location /mnt

EXAMPLE 2: veeamconfig repository create --name shared --type smb --location //172.24.167.112/share --options credentials=/root/.credentials

EXAMPLE 3: veeamconfig repository create --name shared --type smb --location //172.24.167.112/share --username Administrator --password mypass

.HP 5
OBJECTSTORAGE - Object storage;

.B veeamconfig objectstorage createrepository
{azureblob|google|amazon3|s3compatible} --name <value> --servicepoint <address> --region <storage_region> --accesskeyid <id> [--fingerprint <ssl_thumbprint>] --bucketname <bucket_name> --folder <folder_name>

EXAMPLE 1: veeamconfig objectstorage createrepository s3compatible --name s3comp --servicepoint fd00:ca19:0:18b0:0:ac8a:abca:c942:9000 --accesskeyid S3ertlD9EIO9DjnZjuD4 --region us-east-1 --fingerprint <value> --bucketname backup01 --folder folder01

EXAMPLE 2: veeamconfig objectstorage createrepository amazons3 --name amazon --accesskeyid AMAZONKIAWHDY4BDYCJC --region us-east-1 --bucketname bucket01 --folder folder01

EXAMPLE 3: veeamconfig objectstorage createrepository google --name google --accesskeyid GOOGLE56L5ATTDKJCLWUQG3E --region europe-west3 --bucketname backup01 --folder folder01

EXAMPLE 4: veeamconfig objectstorage createrepository azureblob --name azure --account my-account --region azurecloud --bucketname backup01 --folder folder01

.HP 5
VBRSERVER - Veeam Backup & Replication server;

.B veeamconfig vbrserver add
--name <value> --address <value> --login <value> [ --port <value> --password <value> --domain <value> ]

.B veeamconfig vbrserver edit
--<parameter> <newValue>

.B veeamconfig vbrserver resync
[--force]

.B veeamconfig vbrserver delete
{--name <value> | --id <value>}

.B veeamconfig vbrserver list

.B veeamconfig vbrserver info
{--id <value> | --name <value>}

EXAMPLE: veeamconfig vbrserver add --name FriendlyName --address <FQDN or IP> --login Administrator 


.HP 5
JOB - a job defines how, where, and when to back up data;

.B veeamconfig job start
{--id <value> | --name <value>}

.B veeamconfig job create volumeLevel
--name <value> --repoName <value> {--objects <enum> | --backupAllSystem} [ --compressionLevel {0|1|2|3|4} --blockSize {256|512|1024|4096} --prejob <value> --postjob <value> --prefreeze <value> --postthaw <value> --maxPoints <value> {--indexAll | --indexOnly <enum> | --indexExcept <enum>} --setencryption ]

.B veeamconfig job create fileLevel
--name <value> --repoName <value> --includeDirs <enum> [ --includeMasks <enum> --excludeMasks <enum> --excludedirs <enum> --compressionLevel {0|1|2|3|4} --blockSize {256|512|1024|4096} --prejob <value> --postjob <value> --prefreeze <value> --postthaw <value> --maxPoints <value> --indexAll --setencryption ]

.I NOTE:
To configure a job to use a Veeam backup repository as a target, you must also specify a name of the Veeam backup server that appears under the "Name" column when the
.B veeamconfig vbrserver list
command is invoked. Veeam server name is specified in square brackets with backslashes behind, and followed by the Veeam backup repository name:

.B veeamconfig job create volumeLevel
--name <value> --reponame \\[vbrName\\]repoName --backupAllSystem

or use quotes:

.B veeamconfig job create volumeLevel
--name <value> --reponame "[vbrName] repoName" --backupAllSystem

.B veeamconfig job edit {volumeLevel | fileLevel}
--<parameter> <newValue>
.B for
{--name <objectName> | --id <value>}

.B veeamconfig job list

.B veeamconfig job delete
{--name <value> | --id <value>}

.B veeamconfig job info
{--id <value> | --name <value>}


.HP 5
BACKUP - a backup is a collection of restore points representing the most recent state of backed up data 

.B veeamconfig backup info
--id <value>

.B veeamconfig backup show
--id <value>

.B veeamconfig backup delete
--id <value>

.B veeamconfig backup list

.B veeamconfig backup import
--path <value>

.B veeamconfig backup mount 
--id <value> --mountDir <value>

.B veeamconfig backup restore
--id <value> --targetDev <value> --backupDev <value>

.B veeamconfig backup export
--id <value> --outDir <value>

.B veeamconfig backup rescan
--id <value>


.HP 5
POINT - a point contains a copy of data generated by a particular backup session;

.B veeamconfig point mount
--id <value> --mountDir <value>

.B veeamconfig point restore
--id <value> --targetDev <value> --backupDev <value>

.B veeamconfig point list
--backupId <value>

.B veeamconfig point export
--id <value> --outDir <value>


.HP 5
LICENSE - a license defines what features are available and for how long;

.B veeamconfig license show

.B veeamconfig license install
--path <value> {--workstation | --server}

.B veeamconfig license remove


.HP 5
AGREEMENT - end user license agreement management;

.B veeamconfig agreement acceptEula

.B veeamconfig agreement acceptThirdPartyLicenses

.B veeamconfig agreement show


.HP 5
CONFIG - a config is a copy of the current settings;

.B veeamconfig config import
--file <value>

.B veeamconfig config export
--file <value> [--overwrite]


.HP 5
SCHEDULE - a schedule is a part of a job, it defines when to start a session;

.B veeamconfig schedule enable
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule disable
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule show
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule set
--jobId <value> {--weekdays {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --daily | --thisDay { {1 ... 31} | Last } | --monthlyweekday {Mon|Tue|Wed|Thu|Fri|Sat|Sun} --weeknumber {first|second|third|fourth|Last} [--months <enum>] } --at HH:MM

.B veeamconfig schedule activefull enable
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule activefull disable
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule activefull show
{--jobId <value> | --jobname <value>}

.B veeamconfig schedule activefull set
{--jobId <value> | --jobname <value>} {--weekdays {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --daily} --at HH:MM

EXAMPLE 1: veeamconfig schedule set --jobName BackupJob1 --weekdays Mon,Tue --at 12:05

EXAMPLE 2: veeamconfig schedule set --jobName BackupJob1 --daily --at 12:05

EXAMPLE 3: veeamconfig schedule activefull set --jobName BackupJob1 --weekdays Sat

.HP 5
GFS - long-term retentnion policy;

.B veeamconfig gfs enable
{--jobId <value> | --jobname <value>}

.B veeamconfig gfs disable
{--jobId <value> | --jobname <value>}

.B veeamconfig gfs show
{--jobId <value> | --jobname <value>}

.B veeamconfig gfs set
{--jobId <value> | --jobname <value>} {weekly --on {Mon|Tue|Wed|Thu|Fri|Sat|Sun} --keep <weeks> | monthly --on {first|second|third|fourth|Last} --keep <months> | yearly --on <month> --keep <years>}

EXAMPLE 1: veeamconfig gfs set --jobid 4849a3ae-1935-4969-98a3-d8acd2f6c73f yearly --on January --keep 3

EXAMPLE 2: veeamconfig gfs set --jobid 4849a3ae-1935-4969-98a3-d8acd2f6c73f monthly --on Second --keep 6

EXAMPLE 3: veeamconfig gfs set --jobid 4849a3ae-1935-4969-98a3-d8acd2f6c73f weekly --on Saturday --keep 1


.HP 5
CLOUD - Veeam Cloud Connect server;

.B veeamconfig cloud add
--name <value> --address <value> --login <value> --password <value> [ --port <value> ]

.B veeamconfig cloud edit
--<parameter> <newValue>

.B veeamconfig cloud resync
[--force]

.B veeamconfig cloud delete
{--name <value> | --id <value>}


.HP 5
GRABLOGS - an action, collects support logs bundle and places it in the current directory;

.B veeamconfig grabLogs


.HP 5
PATCHISO - an action, copies your current Linux kernel with its currently loaded modules and includes them into the custom recovery media;

.B veeamconfig patchiso
--input <value> --output <value> [ --efi --copy <value> ]


.HP 5
MODE - Veeam Agent for Linux operation mode;

.B veeamconfig mode info

.B veeamconfig mode reset


.HP 5
SESSION - a session is an interval between job start and finish;

.B veeamconfig session list

.B veeamconfig session info
--id <value>

.B veeamconfig session log
--id <value>

.B veeamconfig session stop
--id <value>

.B veeamconfig session ui


.HP 5
UI - an action, starts a curses-based TUI application for interacting with Veeam Agent for Linux;


.HP 5
APP - application processing settings, it defines how applications are processed during the backup;

.B veeamconfig app set oracle
--jobId <value> --jobName <value> --requireSuccess --pruneLogs <value> --usrOracleos <value> --usrOracledb <value>

.B veeamconfig app disable oracle
--jobId <value> --jobName <value>

.B veeamconfig app set mysql
{ --jobId <value> | --jobName <value> } [ { [ --usrMysqlDb <value> [ --password <value> ] ] | --defaults-file <value> } --tryProcess ]

.B veeamconfig app disable mysql
{ --jobId <value> | --jobName <value> }

.B veeamconfig app set postgres
{ --jobId <value> | --jobName <value> } { --usrpgdb <value> [ --password <value> ] | --usrpgos <value> } [ --tryProcess ]

.B veeamconfig app disable postgres
{ --jobId <value> | --jobName <value> }

.B veeamconfig app disableall
{ --jobId <value> | --jobName <value> }

.B veeamconfig app show
--jobId <value> --jobName <value>


EXAMPLE 1: veeamconfig aap set mysql  --jobName BackupJob1

EXAMPLE 2: veeamconfig aap set mysql --jobName BackupJob1 --defaults-file /.mysql_creds

EXAMPLE 3: veeamconfig aap set mysql  --jobName BackupJob1 --usrmysqldb admin

EXAMPLE 4: veeamconfig aap set postgres  --jobName BackupJob1 --usrpgos osadmin

EXAMPLE 5: veeamconfig aap set postgres  --jobName BackupJob1 --usrpgdb dbadmin


.SH DEFAULT VALUES

--port 10006

--compressionLevel 2 (0 - none, 1 - Rle, 2 - Lz4, 3 - ZlibLow, 4 - ZlibHigh)

--blockSize 1024

--maxPoints 14


.SH MORE EXAMPLES and NOTES

.PP
Patch Veeam Recovery Media to inject drivers and kernel from the current system, provided that:

1. The original Veeam Recovery Media .iso file is located at /home/user/veeam-recovery-media-4.0.0.iso

2. The resulting .iso file will be placed at /home/user/patched.iso

.IP
.B veeamconfig patchiso
--input
.I /home/user/veeam-recovery-media-4.0.0.iso
--output
.I /home/user/patched.iso

.PP
Create the "BackupJob1" file-level backup job pointed to the "vault13" repository, all files from the /home directory with extensions .bak and .pdf are included:

.IP
.B veeamconfig job create filelevel
--name
.I BackupJob1
--reponame
.I vault13
--includedirs
.I /home
--includemasks "
.I *.bak,*.pdf
"


.PP
Create the "BackupJob2" backup job to back up /dev/sda device pointed to the "vault14" repository, enable indexing for /home/admin and /boot directories only:

.IP
.B veeamconfig job create
--name
.I BackupJob2
--reponame
.I vault14
--objects
.I /dev/sda
--indexOnly
.I /home/admin,/boot

.PP
Add Veeam Backup & Replication server by IP (172.16.16.122) under the MAINVBR name, using the domain\\user credentials. Port is not specified and is set to the default value (10006):

.IP
.B veeamconfig vbrserver add
--address
.I 172.16.16.122
--domain
.I domain
--login
.I user
--password
.I PASSWORD
--name
.I MAINVBR

.PP
Create the "entire machine" backup job "myJob" pointed to the "myRepo" repository at the "myVBR" server:

.IP
.B veeamconfig job create
--name
.I myJob
--backupallsystem
--reponame
.I \e[myVBR\e]myRepo

.PP
Set the backup job that has ID 9ab42a6b-27ba-4b27-b2b5-27118e3b2d38 to run on Mondays and Tuesdays at 4:00 pm:

.IP
.B veeamconfig schedule set
--weekdays
.I Mon,Tue
--at
.I 16:00
--jobid
.I 9ab42a6b-27ba-4b27-b2b5-27118e3b2d38

.SH FILES

.I /etc/veeam/veeam.ini
- the
.B veeamservice
configuration file

.I /etc/bash_completion.d/veeam
- the bash completion file

.I /var/log/veeam/config/veeamconfig.log
- the log file

.I /var/lib/veeam/veeam_db.sqlite
- the database veeamconfig connects to

.I /usr/share/veeam/lpb_scheme.sql
- the database schema

.SH ENVIRONMENT

.I NCURSES_NO_UTF8_ACS=1
is required to properly display TUI elements on some terminals

.SH REPORTING BUGS

Report bugs to: veeam_team@veeam.com

.SH COPYRIGHT
Copyright © 2023 Veeam\*R Software Group GmbH. Veeam End User License Agreement (EULA) <https://www.veeam.com/eula.html/>.
Local path: /usr/share/veeam/EULA

3rd party License Agreement (applies to 3rd party components)
Local path: /usr/share/veeam/3rdPartyNotices.txt

GPLv2 (applies to veeamsnap kernel module)
https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt

.SH SEE ALSO
Full documentation at: <https://www.veeam.com/documentation-guides-datasheets.html>

Veeam Agent for Linux online help and feature requests: <https://forums.veeam.com/veeam-agents-for-linux-unix-f41/>
Zerion Mini Shell 1.0