Overview
This article describes how to generate a backup of the UniFi Network Controller as well as how to restore it. This article does not cover the Auto Backup feature. You may see this article for more information on that subject: UniFi - How to Configure Auto Backup.
Table of Contents
- Introduction
- Generating a New Backup
- Restoring a Backup
- Changing the Inform Address for All Devices in Controller
- Related Articles
Introduction
The UniFi backup file has an extension of .unf and contains the settings and the database for the UniFi Network Controller. The database is not included in a "settings only" backup. The backup also includes the config.properties, system.properties and config.gateway.json advanced configuration files, maps, and any customized files in a site's portal folder. You can download a backup at any time from the Controller following the steps below.
Generating a New Backup
Users can generate a new UniFi backup file (.unf) at any moment by going to Settings > Maintenance > Backup > Click Download Backup button. You can modify the Backup Data Retention to hold historical data (select the days) or to save your Settings only before downloading.
Restoring a Backup
Method 1: Restoring in the UniFi Controller
To restore a backup you have previously downloaded, log in to the UniFi Controller and follow these steps:
1. Go to Settings > Maintenance > Restore > Click Choose File button.
2. The file will load and you will be asked to confirm you wish to restore that backup.
3. Once you confirm, the backup restoration will begin. This process takes a few minutes, do not disconnect while the Controller is working on this. Once the new backup is restored, the Controller will restart.
Method 2: Restoring in the UniFi Startup Wizard
If beginning a new installation, it will be easier to just use the option of restore from a previous backup as soon as the UniFi Startup Wizard launches, and select your .unf file.
Method 3: Restoring from the /data Directory
Click here to display Method 3: Restoring from the /data Directory.If the original /data folder (with all subfolders and contents inclusive) is available, follow these steps (some might need to be performed via CLI):
Data folder locations:Windows
Linux
Mac
User Tip:If the .unf file is very large it may result in an error saying Failed to Start on import or migration. You may let this sit for a while, and then try accessing the Controller. It may import without a problem. If it doesn't import properly though, you may need to revert to the original version of the Controller, run the pruning script, make a new backup, then either purge and install then restore, or do an in-place upgrade.
|
Changing the Inform Address for All Devices in Controller
It may be desired to change the IP address or FQDN that the UniFi devices on multiple sites are reporting to after a controller restore. This process is typically used when migrating from one functional controller to a new install.
1. Download a backup file from the current controller.
2. Install the UniFi Controller on the new host.
3. Restore the backup that came from step 1 and let the upload process finish.
4. Log into the new controller.
5. On the old controller: Under Settings > Controller > Controller Settings, type in the new controller's IP address or FQDN in the Controller Hostname/IP field. Also, tick the "Override inform host with controller hostname/IP" checkbox.
6. Select Apply Changes.
After the changes are applied the old controller will send the configuration to Connected state devices stating the inform host is now what was input in the Controller Hostname/IP field.
If this was performed correctly, the devices should start appearing in the new controller host. The process should not take longer than 5 minutes but can be longer depending on the number of devices, physical proximity of the devices, and new controller hardware specs.