rosdump

Rosdump

rosdump is a tool for backing up and optionally tracking configuration of RouterOS devices.

Use rosdump to:

• Backup Mikrotik network device configurations to your local file system
• Backup Mikrotik network device configurations to a git repository
• Run as a daemon that backs up devices on a predefined schedule

Quick Start

The following example uses the docker image to backup a RouterOS device. Create a config named rosdump.yml on your computer using the example below.

Specify the IP address, admin user and password of your own device.

Config example that writes backup to local filesystem

version: 1

devices:
  list:
    - host: 192.168.88.1
  common: # Overrides per-device settings
    driver: ssh-command
    timeout: 30s # See https://golang.org/pkg/time/#ParseDuration
    command: export
    username: admin
    password: password

storage:
  driver: file
  timeout: 30s
  path: '/opt/backups/{{.host}}/{{.time.UTC.Format "2006-01-02T15:04:05Z07:00"}}'

timeout: 30s # Optional timeout for a whole work cycle
interval: 4h # Duration between backups when running as a daemon

Assuming your config file is named rosdump.yaml, and you have docker installed on your computer, run the following command:

docker run --rm \
        -v $(realpath rosdump.yml):/etc/rosdump.yml \
        -v $(realpath backups):/opt/backups ecadlabs/rosdump

You will now have a backup of your configuration in a directory named backups/ in your present working directory.

Configuration Schema

Exporter drivers

Common options

ssh-command

Storage drivers

Common options

file

git

Example config for git storage

version: 1

devices:
  list:
    - host: 192.168.88.1
  common:
    driver: ssh-command
    timeout: 30s
    command: export
    username: admin
    identity_file: /etc/rosdump/routeros_admin_private_key

storage:
  driver: git
  timeout: 30s
  url: git@github.com:yourorg/networkbackups.git
  identity_file: /etc/rosdump/git_deploy_key
  destination_path: '{{.host}}'
  push: true
  name: Network Backup
  email: networkbackup@example.net
  commit_message: 'Rosdump backup {{.time.UTC.Format "2006-01-02T15:04:05Z07:00"}}'

timeout: 30s
interval: 4h

Template data fields (transaction metadata)

Currently ssh-command driver exposes all its options (except password) as a transaction metadata. Additionally time field is set to transaction timestamp (see the description of Go time.Time type).