Backup & Restore - Host and User Data Explained
On this topic
With the start of version 14 of 3CX Phone System the restore process has been changed. Backups have been split into two parts, the Host and User data. The following guide illustrates the reasons and the benefits for this change.
The below mentioned splitting of the host and user data now allows you free movement of a backup. It can be compared with a VM migrating from one hypervisor to another. The host setup provides the computing power for 3CX Phone System based on the network topology matching the host configuration. The user data can now utilise this configuration and immediately resume the service on the new host.
To extend on the above image a backup can now move:
- From Host A to Host B
- From Host B back to Host A
- From a Virtual PBX Server installation to Host A or B
- From Host A or B into a Virtual PBX Server installation
(any Instance Slot, v14 backups only)
The splitting of host and user data also gives administrators greater flexibility to perform and pretest updates and enables you to plan failover scenarios. Therefore the backup has been split into host and user data. But what is the host and user data? What can you expect when you restore a backup and what are the options you have with the backup?
Host data defines the data which is only relevant to the installation on the current host. Basically all the information you enter during the installation process is host data plus some of which is defined within the Management Console.
Static Host Data
Static host data can NOT be changed unless the PBX is re-installed:
- Installation Mode (NAT or No NAT)
- Web Server Ports
- Local Interface IP Address
- FQDN (internal and external)
Dynamic Host Data
Besides the static host data, there is also dynamic host data. This data can be changed on the fly without the need to re-install the PBX, although you may need to re-provision endpoints. Note, altering the below values may imply changes to the Firewall-NAT also:
- External IP Address
- Static or dynamic public IP address
- SIP Port
- RTP Ports
- Tunnel Port / Password
- Admin E-Mail Address
In general no host data will be restored from a backup.
A common scenario which you may encounter is how to restore a backup which used to run on a different SIP port (e.g. sip port 6060):
- Complete the Installation of the PBX
- Complete the Configuration Wizard
- Login to the Management Console
- Change the SIP Port to 6060
- Restore the Backup
User data on the other hand, is the configuration which runs on the host. User data consists of all the configuration information, which is made by the client, as well as some of the main host data parts. The Username and Password entered during the installation process is considered as User Data, and when you restore your backup, the username and password defined in the Backup file will be valid upon restore. To expand on what is considered as user data information:
- Extension groups & rights
- Phones & Provisioning
- System Extensions (Queues, Ring Groups, IVRs, VoiceMail)
- Global Option settings
- SIP Trunks & PSTN Gateways
- Inbound and Outbound Rules
- Username and Password
All of these will be restored once the backup is restored to the host.