Skip to main content

ROSBackup

Summary

Simple utility for backing up RouterOS configuration.

Installation

Create backup user account

It is recommended to create a dedicated user account with limited permissions for backup purposes. This user should have ssh and read permissions. Please check RouterOs manual if you are not sure how to do this.

Installation form PyPI:

pip3 install rosbackup

Docker

You can download the image from Docker Hub:

docker pull mharjac/rosbackup

Or build it on your own:

docker build -t rosbackup . -f docker/Dockerfile

Create a volume for storing backups:

docker volume create mikrotik-router-1

Create a container:

docker run -d --name=mikrotik-router-1 -e ROS_HOST="https://192.168.1.1" -e ROS_USER="backusr" -e ROS_PASS="somesuperstrongpassword" --mount=src=mikrotik-router-1,dst=/backup rosbackup:latest

And finally, for unattended regular backups, create a cron job which will execute:

docker start mikrotik-router-1

Install from Snap Store

snap install rosbackup

Usage

It can be used as an interactive tool from CLI:

rosbackup -H https://192.168.1.1 -u user1 -p passw0rd -f ./backup.cfg

When used in CLI, it will prompt for password if -p (--password) flag is not provided. Also, without -f (--file) flag, config will be printed to the stdout.

It can also be used for unattended backups (e.g., in containers), in which case, it requires following environment variables:

  • ROS_HOST: for storing IP address or hostname (e.g., 192.168.1.1)
  • ROS_USER: username for making backups
  • ROS_PASS: password for provided username
  • ROS_DELAY: execution delay between commands (optional; required on older devices; default 5)
export ROS_HOST="192.168.1.1" ROS_USER="user1" ROS_PASS="passw0rd" ROS_DELAY="3"
rosbackup

When executed in unattended mode, configuration backup will be saved in execution directory as config-{time_stamp}.cfg.

Release files for rosbackup 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rosbackup 1.1.0
File Size Uploaded
rosbackup-1.1.0.tar.gz 3.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rosbackup 1.1.0
File Interpreter ABI Platform
rosbackup-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.9 kB

Release files / rosbackup-1.1.0.tar.gz

Download URL rosbackup-1.1.0.tar.gz
Size 3.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f14c94d1808d3be050d406905976b5d1d1be93689a8c354fca97962da1f4d705
BLAKE2b-256 checksum
How to use checksums
ba22454aea52020d174cfc7aefd3d905514849cae1717a894add0d54bb9cd91c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5rc1

Release files / rosbackup-1.1.0-py3-none-any.whl

Download URL rosbackup-1.1.0-py3-none-any.whl
Size 5.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7301458c276caa3e37118a7cdd7c6f492b02784bd21e11f1eb85d072c868f9cf
BLAKE2b-256 checksum
How to use checksums
e273c7c42f6faa5102c372ec37c4e3bd4e606890f7f2fdab8f66c414eca27009
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.5rc1

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page