Admin Console Backup

6 min

Note: This is available for Belden Horizon Data Manager version 2.16.0 and later.

The Backup module allows you to download, upload, and bulk delete Belden Horizon Data Manager configuration files.

Overview

The backup process for BHDM consists of a compressed and encrypted file downloaded from the BHDM Admin UI. The data is updated every 24 hours, and 7 copies of each BHDM version are maintained on the server until user deletes them manually.

Backup Type: Compressed and encrypted file, available for download from the BHDM Admin UI.

Rotation: 7 copies of each BHDM version.

Retention Period: Backup files will remain until user deletes them manually.

BHDM backup contain the following files:

1. Application Data

Company and project settings
Activation requests
Sites (except site icons)
Triggers and Actions
Templates
Marketplace Applications and their associated data and configurations
Marketplace Catalog (data and configuration)
Grafana Dashboards and other settings
Remote access setup
Licenses (Note: Licenses won't work after restoring on another VM)
Keycloak
Registry Credentials
Certificates
SMTP Settings
Tokens

2. User Data

Users and their access to specific projects/companies.

3. Marketplace Apps

All marketplace apps and associated data and configurations.

4. BHDO Connected to BHDM

All BHDO devices connected to the BHDM.

5. Database Dumps:

mysql-grafana.sql
mysql-keycloak.sql
mysql-BHDM.sql
mysql-mpcs.sql
mysql-mpcs_rbac.sql
mysql-mysql-user.sql

What Is Not Backed Up

Old upgrades and backups
Events
Docker registry data
ClickHouse data
DNS Entries (BHDM only lists DNS servers; not backed up to avoid network access issues)
Network settings

Review the backup options below.

[1] Create backup: Download a backup file of the Belden Horizon Data Manager configuration. Configuration files are password protected and generated as a .tar file. Process logs are visible in the Log section.

To export the configuration, you'll need the password of the Belden Horizon Data Manager instance.

[2] Upload backup file: Upload a Belden Horizon Data Manager configuration file. To import the configuration, you'll need the password of the Belden Horizon Data Manager instance.

Important:

Importing a configuration replaces configuration data and cannot be undone. Select the appropriate bundled zip file.
Any node-locked licenses will be removed after restoring a backup on a new virtual machine (VM). You will have to request new node-locked licenses from your account representative.
Network files are not backed up to avoid breaks on restore.
As of Belden Horizon Data Manager 2.24.0 release, BHDM Admin UI allows you to create long-term API tokens with scope BHDM Backup.

[3] Remove selected backups: This option allows you to bulk delete the selected backup configurations files at once.

[4] Show backup/restore log: View the latest export/Import operation log. You can toggle Auto-scroll to the On position to automatically scroll down to the most recent messages in Process Log. Doing so helps monitor a running export/import process.

[5] Refresh: Reload the list of backup files.