Skip to content
All Cheatsheets

Bareos

The most important Bareos commands for bconsole, jobs, clients, volumes, pools and more.

Docker Mode

Prepends docker exec <container> to all commands.

bconsole

Start bconsole

bconsole

Jobs

Run job immediately

run job=<JOB-NAME> yes

Cancel running job

cancel jobid=<JOBID>

Show director status

status director
messages

Delete job from history

delete job jobid=<JOBID>

Purge all jobs for a client

purge jobs client=<CLIENT-NAME> yes

Temporarily disable / enable a job

disable job=<JOB-NAME>
enable job=<JOB-NAME>
ℹ Note

disable/enable are temporary — for a permanent change set Enabled = no/yes in the job config + reload


Clients

Add client

configure add client name=<CLIENT-NAME>-fd address=<HOST-ADDRESS> password=<PASSWORD>

Check client status

status client=<CLIENT-NAME>-fd

Remove client

# 1. Delete config file:
rm /etc/bareos/bareos-dir.d/client/<CLIENT-NAME>-fd.conf
# 2. In bconsole:
reload
⚠ Warning

delete client does not exist in bconsole — remove config file + reload

Remove orphaned client records from catalog

# Run as bareos user — never as root!
su -s /bin/bash bareos -c "bareos-dbcheck -v -f"
# → Select option 10: Check for orphaned Client records
🔴 Caution

bareos-dbcheck must run as bareos user — peer authentication fails as root


Config

Reload director config

reload

Check config syntax (before reload)

bareos-dir -t

Volumes

List all volumes

list volumes

Purge all jobs from a volume

purge volume=<VOLUME-NAME> yes

Truncate purged volume (free disk space)

truncate volstatus=Purged volume=<VOLUME-NAME> yes

Delete volume from catalog

delete volume=<VOLUME-NAME> yes
❗ Important

Bareos never deletes files from the storage medium automatically — manual cleanup on the storage host is required


Pools

Update pool config in catalog

update pool=<POOL-NAME>

List volumes in a pool

list volumes pool=<POOL-NAME>
⚠ Warning

reload alone does not update pool settings in the catalog — always run update pool=<POOL-NAME> after changing pool config

💡 Tip

Maximum Volumes must be sized for retention days × jobs per day (e.g. 30 days × 4 jobs = 120+ volumes)


Catalog

Reset catalog

systemctl stop bareos-director
su -s /bin/bash bareos -c /usr/lib/bareos/scripts/drop_bareos_tables
su -s /bin/bash bareos -c /usr/lib/bareos/scripts/make_bareos_tables
su -s /bin/bash bareos -c /usr/lib/bareos/scripts/grant_bareos_privileges
systemctl start bareos-director
🔴 Caution

Run all commands as bareos user — never as root!

Create pool in catalog

# In bconsole:
create pool=<POOL-NAME>

Ports

ServicePort
Director9101
File Daemon9102
Storage Daemon9103
WebUI (HTTPS)443