Backup
This page describes how the Backup module saves configurations, what it needs on the target device and where its limits are.
What the module does is described on the module page.
As of: November 2026, COD 3.8.6
Documentation contents
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Documentation
- Overview
- Getting started
- Requirements
- Names and addresses
- Network devices
- Time and DNS
- Installation
- Deployment shapes
- Initial setup
- Updates
- Modules
- Network and MikroTik
- Automation
- NAC
- TACACS+
- Firewall
- Captive Portal
- Monitoring
- Backup
- Hypervisor
- OTP
- Passkeepr
- GRC
- Inventory and CMDB import
- Troubleshooting
- Security
- Versions
- Version history
- Support
Overview
| Property | Value |
|---|---|
| Purpose | Scheduled backup of configurations and MariaDB databases. Versions, comparison as a diff, download |
| Supported systems | Devices and servers with SSH or SFTP: switches, routers, firewalls, Linux and BSD systems, embedded devices. Databases: MariaDB |
| Template types | Download (file or folder over SFTP), Command (output of a command), MariaDB dump |
| Connection and direction | The backup service opens the connection to the device, over SSH or SFTP. Optionally through a jump host |
| Service | Package cod-acb with its own storage and its own server register. Runs on the COD server or on a separate module server |
| Credentials | User and password per host. Jump host with user and password. For a MariaDB dump, the database login as well. |
| Rights on the target | Read access to the files and commands being backed up |
| Restore | COD does not restore backups to the device |
Requirements
On the target device
| Requirement | Why |
|---|---|
| SSH or SFTP server switched on | All template types require SSH |
| Reachable from the backup service or from the jump host | The backup service opens the connection |
| A dedicated user for COD with read access to the files or commands | Traceability and minimal rights |
| SSH access restricted to the source address of the backup service | Small attack surface |
| Fixed management address | The host entry in COD is a copy and does not change by itself |
| Hostname on the device equal to “Server Name” in COD when “Check Server Name” is on | The name check compares both |
| Time synchronisation via NTP, recommended | Backup timestamps match logs and schedules |
For a complete export, some routers need full rights. Check on the device whether read access is enough for the command you chose.
In COD
- Backup module enabled for the tenant and rolled out for the location.
- A role with the permission for the Backup module.
- Mail settings of the backup instance, if you want failure emails. The backup service then needs a path to your mail server.
Customers and partners receive the list of connections and firewall rules as part of the project.
Setup
- The manager account enables the module: “Admin Area > Tenant > Modules”. Then sign out and in again. Details under Enable modules.
- Roll out the module: “Admin Area > Module Rollout”, module Backup, choose the location, then “Install”, “Connect”, “Configure” and “Apply”. Details under Roll out modules.
- Set up the mail of the backup instance so that failed runs are reported.
- Create a template. Choose the type (Download, Command or MariaDB dump), enter the path or command and set encryption and retention.
- Create the host: address, port, user, password, template, a jump host if needed. A firewall from the inventory becomes a backup host with one click. COD then fills in the fields once.
- Enter the schedule (cron) on the host. It determines the start time.
- Start a first run with “Execute Now”. Check the status and the content of the snapshot.
- Stagger the start times when many hosts use the same target or the same jump host.
Technical details
Template types
| Type | What is backed up | Note |
|---|---|---|
| Download | A file or a folder over SFTP. Selection inside a folder optionally by regular expression (regex) | Folders arrive as ZIP, diff down to the single file |
| Command | The output of a command on the host | For devices that print their configuration with a command |
| MariaDB dump | A MariaDB database | MariaDB is what we have verified. We do not commit to other database systems |
Paths and commands are used literally. COD does not replace placeholders such as variables for the hostname.
MariaDB dump
The backup service creates the dump itself. For this it connects directly to the MariaDB server you entered. Like every template, the MariaDB dump also requires SSH access to the host. Plan both firewall rules.
Schedule and start
- The cron on the host determines the start time.
- “Execute Now” starts single or many hosts outside the schedule.
- For each run, the backup service opens an SSH session, through the jump host if one is set.
Status and failure notice
- Status, errors and recent runs appear in the module overview and on the Home dashboard.
- A failed run sets the host to the status “ERROR”.
- If the mail of the backup instance is set up, the backup service also sends a failure email. It is an operational aid, not alerting.
- Changes in the backup service appear in the Admin Area audit, with the user who made them.
Encryption and retention
| Setting | Applies | Note |
|---|---|---|
| Encryption | per template | Applies to the snapshots in the storage of the backup service. Folder backups are excluded |
| Retention | per template | By count or by age in days. Once the limit is reached, COD deletes the oldest snapshots |
Storage, comparison and download
- Each backup instance keeps its snapshots in its own storage on its host.
- The comparison shows two snapshots as a diff, either only the differences or the full text.
- You download a snapshot as a file, a folder as a ZIP.
- There is no automatic offloading. The former offloading over SCP was removed in COD 3.7.11.
- The storage belongs in your regular backup. You receive the complete list as part of the project.
Host register
The module keeps its own server register. A host entry is a copy and is not linked to the asset. If you change the address or password in the inventory, this does not reach Backup.
Backup instances and locations
| Layout | When |
|---|---|
| One backup instance per location | Separate server registers and storage per location |
| One backup instance for several locations | Several locations share host register and storage |
| Several instances on one host | One module server serves several locations, each with its own instance |
Which layout fits is described under Deployment shapes.
Known limits
| Limit | What you can do |
|---|---|
| Everything runs over SSH. Devices without SSH or SFTP cannot be backed up directly | Agree on a workaround with your partner. Where the device offers it, switch SSH on |
| No placeholders in path and command | Use fixed paths, with a separate template per device group if needed |
| The “Script” field is not executed | Do not rely on pre-scripts in COD. Set up preparatory steps on the device itself |
| Folders starting with a dot are skipped by the download | After the first run, check that all expected files are in the snapshot |
| An unreadable subfolder aborts the whole download, even with a regex | Give the user read access to the whole folder or back up only readable paths |
| Many simultaneous SSH sessions to the same target or the same jump host fail at its session limit | Stagger the start times |
| Host entries are copies and not linked to the asset | Update address and password in Backup when they change on the device |
| “Check Server Name” requires matching names | Keep the hostname on the device and “Server Name” identical, or switch the check off |
| Encryption does not apply to folder backups | Protect the host of the backup service and its storage |
| No restore | Download the snapshot and apply it with the vendor's tools |
| No automatic offloading since COD 3.7.11 | Include the storage in the backup of the host |
| The failure email is not alerting | Check the status on the dashboard regularly |
| Only MariaDB is verified as a database | Back up other databases with your own tools |
| Login with SSH keys | Clarify this in the project. |
Further reading
- Backup module page
- What your network needs for Backup
- Prepare network devices
- Names and addresses
- Deployment shapes
- Troubleshooting
- Questions about the modules