.\" Process this file with .\" groff -man -Tascii foo.1 .\" .TH VEEAMCONFIG(8) "2022" "Veeam User Manuals" .SH NAME veeamconfig - Veeam Agent for Solaris configuration tool. .SH SYNOPSYS .B veeamconfig { .I OBJECT | .B help } { .I ACTION | .B help } --argument1 .I --argument2 .I ... --argumentN .I [OPTIONAL ARGUMENTS] .SH DESCRIPTION .PP .B veeamconfig is a command-line configuration tool for Veeam Agent for Solaris. .B veeamconfig is used to create and manage backup and recovery activities. The tool also provides integration with Veeam Backup & Replication server, which allows you use Veeam repository as a backup storage. .SH USAGE Invoke .B veeamconfig followed by arguments and options as described in the synopsys above. If .B veeamconfig requires one or more argument to be supplied, it will give you a hint. Any combination of arguments and parameters can be appended with .B help or .B --help or .B -h parameters. .SH OBJECTS, ACTIONS, ARGUMENTS .HP 5 RECOVERYUI - pseudo-graphical user interface for bare-metal restore operations; .B veeamconfig recoveryui .HP 5 REPOSITORY - backup storage; .B veeamconfig repository create --name --location .B veeamconfig repository edit -- .B for --name .B veeamconfig repository rescan {--name | --id | --all} [ --skipencrypted ] .B veeamconfig repository delete {--name | --id } [ --answer ] .B veeamconfig repository list EXAMPLE: veeamconfig repository create --name MyRepo1 --location /mnt .HP 5 VBRSERVER - Veeam Backup & Replication server; .B veeamconfig vbrserver add --name --address --login [ --port --password --domain ] .B veeamconfig vbrserver edit -- .B veeamconfig vbrserver resync .B veeamconfig vbrserver delete {--name | --id } .B veeamconfig vbrserver list .B veeamconfig vbrserver info {--id | --name } EXAMPLE: veeamconfig vbrserver add --name FriendlyName --address --login Administrator .HP 5 JOB - backup job; defines what data to back up, which repository to use, and schedule .B veeamconfig job start {--id | --name } [ --retriable --activeFull ] .B veeamconfig job create --name --repoName --includeDirs [ --includeMasks --excludeMasks --excludedirs --compressionLevel {0|1|2|3|4} --blockSize {256|512|1024|4096|8192} --prejob --postjob --maxPoints --indexAll --setencryption --deleteold ] [ { --weekdays {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --daily } --at HH:MM ] [ { --weekdays-full {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --thisday-full ] .I NOTE: To use Veeam backup repository as a storage you need to specify the name of the Veeam backup server which appears under the "Name" column when the .B veeamconfig vbrserver list command is invoked. Veeam server name is specified in square brackets with backslashes before, and followed by the repository name: EXAMPLE 1: veeamconfig job create --name --reponame \\[vbrName\\]repoName --includeDirs /etc EXAMPLE 2: veeamconfig job create --name --reponame "[vbrName] repoName" --includeDirs /etc .B veeamconfig job edit -- .B for {--name | --id } .B veeamconfig job list [ --sortByTime | --sortByName | --reverseSort ] .B veeamconfig job delete {--name | --id } [ --force ] .B veeamconfig job info {--id | --name } .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 .B veeamconfig backup show --id .B veeamconfig backup delete --id [ --purge ] .B veeamconfig backup list [ --all ] .B veeamconfig backup import --path [ --skipEncrypted ] .B veeamconfig backup rescan --id .B veeamconfig backup mount --id [ --mountDir ] .B veeamconfig backup restore --id [ --excludeDirs --path ] .I NOTE: 'restore' action can be used only from within the Recovery Media environment .HP 5 POINT - a point contains a copy of data generated by a particular backup session; .B veeamconfig point mount --id [ --mountDir ] .B veeamconfig point list --backupId [ --all ] .B veeamconfig point restore --id [ --excludeDirs ] .I NOTE: 'restore' action can be used only from within the Recovery Media environment .HP 5 LICENSE - a license defines what features are available and for how long; .B veeamconfig license show .B veeamconfig license install --path .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 [ --force ] .B veeamconfig config export --file [ --overwrite ] .HP 5 SCHEDULE - a schedule is a part of a job, it defines when to start a session; .B veeamconfig schedule enable {--jobName | --jobId } .B veeamconfig schedule disable {--jobName | --jobId } .B veeamconfig schedule show {--jobName | --jobId } .B veeamconfig schedule set {--jobName | --jobId } {--weekdays {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --daily} --at HH:MM .B veeamconfig schedule activefull enable {--jobName | --jobId } .B veeamconfig schedule activefull disable {--jobName | --jobId } .B veeamconfig schedule activefull show {--jobName | --jobId } .B veeamconfig schedule activefull set {--jobName | --jobId } {--weekdays {Mon|Tue|Wed|Thu|Fri|Sat|Sun} | --thisDay } 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 GRABLOGS - an action, collects support logs bundle and places it in the current directory; .B veeamconfig grabLogs .HP 5 CREATEISO - an action, creates a Recovery Media ISO image (is required for bare-metal recovery); .B veeamconfig createiso --output [--edit --overwrite --tempPath ] NOTE: not available in BMR environment or zones .HP 5 MODE - Veeam Agent for Solaris operation mode; .B veeamconfig mode info .B veeamconfig mode reset [ --force ] .B veeamconfig mode setVbrSettings --cfg [ --force ] .B veeamconfig mode syncNow .B veeamconfig mode exportDebugLogs .HP 5 SESSION - backup or restore session; .B veeamconfig session list [ --24 | --7 | --all ] [ --jobId ] .B veeamconfig session info --id .B veeamconfig session log --id [ --color ] .B veeamconfig session stop --id [ --force ] .HP 5 VERSION - get veeamconfig version .B veeamconfig version .SH DEFAULT VALUES --port 10006 --compressionLevel 2 (0 - none, 1 - Rle, 2 - Lz4, 3 - ZlibLow, 4 - ZlibHigh) --blockSize 1024 --maxPoints 7 .SH MORE EXAMPLES and NOTES .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 --name .I BackupJob1 --reponame .I vault13 --includedirs .I /home --includemasks " .I *.bak,*.pdf " .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 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 /etc/veeam/veeam.ini - veeamservice configuration file /etc/bash_completion.d/veeam - bash completion file /var/log/veeam/config/veeamconfig.log - log file /var/lib/veeam/veeam_db.sqlite - configuration database /opt/share/veeam/db_scheme.sql - database schema .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) . Local path: /opt/share/doc/veeam/EULA 3rd party License Agreement (applies to 3rd party components) Local path: /opt/share/doc/veeam/3rd_party .SH SEE ALSO Full documentation at: https://helpcenter.veeam.com/docs/agentforsolaris/userguide/about.html?ver=40 Veeam Agent for Solaris online help and feature requests: