BorgBackup

BorgBackup

SNMP Extend

1. Copy the shell script to the desired host.

wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/borgbackup -O /etc/snmp/borgbackup

1. Make the script executable

chmod +x /etc/snmp/borgbackup

1. Install depends.

pkg install p5-Config-Tiny p5-JSON p5-File-Slurp p5-MIME-Base64 p5-String-ShellQuote

apt-get install libconfig-tiny-perl libjson-perl libfile-slurp-perl libmime-base64-perl libstring-shellquote-perl

cpanm Config::Tiny File::Slurp JSON MIME::Base64 String::ShellQuote

1. Set it up in cron.

*/5 * * * /etc/snmp/borgbackup 2> /dev/null > /dev/null

1. Configure it. See further down below or /etc/snmp/borgbackup --help.

2. Add the following to the SNMPD config.

extend borgbackup /bin/cat /var/cache/borgbackup_extend/extend_return

1. Restart SNMPD and wait for the device to rediscover or tell it to manually.

Config

The config file is a ini file and handled by Config::Tiny.

- mode :: single or multi, for if this is a single repo or for
        multiple repos.
    - Default :: single

- repo :: Directory for the borg backup repo.
    - Default :: undef

- passphrase :: Passphrase for the borg backup repo.
    - Default :: undef

- passcommand :: Passcommand for the borg backup repo.
    - Default :: undef

For single repos all those variables are in the root section of the config, so lets the repo is at '/backup/borg' with a passphrase of '1234abc'.

repo=/backup/borg
repo=1234abc

For multi, each section outside of the root represents a repo. So if there is '/backup/borg1' with a passphrase of 'foobar' and '/backup/derp' with a passcommand of 'pass show backup' it would be like below.

mode=multi

[borg1]
repo=/backup/borg1
passphrase=foobar

[derp]
repo=/backup/derp
passcommand=pass show backup

If 'passphrase' and 'passcommand' are both specified, then passcommand is used.

Metrics

The metrics are all from .data.totals in the extend return.