Backup and Restore PortSIP SBC

This article provides procedures for backing up and restoring a PortSIP SBC server. The procedures are designed to ensure no data loss in upgrading and migration.

Backup files and data should be stored on a different server than the one that is used for daily running.

All procedures are performed at the command prompt and require root-level access.

Creating a Backup Using Snapshots

If your PortSIP SBC is running within a virtual environment or hosted on a cloud platform, it’s likely that these platforms offer the capability to create a snapshot of the server. This is a highly recommended method for backing up your current PortSIP SBC server.

Restoring from a Snapshot

Restoring your SBC from a snapshot is a straightforward process. Simply follow the steps provided by your virtual environment or cloud platform to restore the SBC from the snapshot you’ve created.

Remember, it’s always a good idea to test the restore process periodically to ensure your backups are working as expected. This will help you avoid any surprises in the event of a system failure.

Backing Up SBC Data

Linux

When installing PortSIP SBC on Linux, you typically use the following command to create the PortSIP SBC Docker instance:

V11.x:

sudo /bin/sh sbc_ctl.sh run -p /var/lib/portsip -i portsip/sbc:11

In the above command used to create the PortSIP SBC Docker instance, the -p parameter is used to specify the parent folder for storing the SBC data. To back up the data, simply copy the folder /var/lib/portsip/sbc to another server or an external disk.

Please note that it’s important to back up the sbcsubfolder of the parent folder/var/lib/portsip.

sudo mkdir -p /back/sbc-data
sudo cp -p -r /var/lib/portsip/sbc /back/sbc-data

For example, if you specified the parent path as /portsip/data using the -p parameter when installing the PortSIP SBC, then you need to back up the folder /portsip/data/sbc.

sudo mkdir -p /back/sbc-data
sudo cp -p -r /portsip/data/sbc /back/sbc-data

v10.x:

/bin/sh sbc_ctl.sh run -p /var/lib/portsip -i portsip/sbc:10

In the above command used to create the PortSIP SBC Docker instance, the -p parameter is used to specify the parent folder for storing the SBC data. To back up the data, simply copy the folder /var/lib/portsip/sbc to another server or an external disk.

Please note that it’s important to back up the sbcsubfolder of the parent folder/var/lib/portsip.

mkdir -p /back/sbc-data
cp -p -r /var/lib/portsip/sbc /back/sbc-data

For example, if you specified the parent path as /portsip/data using the -p parameter when installing the PortSIP SBC, then you need to back up the folder /portsip/data/sbc.

mkdir -p /back/sbc-data
cp -p -r /portsip/data/sbc /back/sbc-data

Windows

When installing PortSIP SBC on Windows, in step 1, there is an option that allows you to choose the parent folder for storing the SBC data.

To back up the data, simply copy the data folder to another server or an external disk. By default, if you didn’t specify otherwise, the SBC data parent folder is C:\ProgramData\PortSIP. The following folder needs to be copied:

• C:\ProgramData\PortSIP\sbc

Restoring from Backup Data on Linux for SBC v11.x

Please follow the steps below to restore the PortSIP SBC from the backup data in a Linux environment.

You can't restore the backup data of a Windows SBC to a Linux SBC.

Restoring from Backup Data to the Same Server

1. Stop the current PBX and delete the PBX data.

Execute the following commands to stop the SBC and delete the data:

cd /opt/portsip && sudo /bin/sh sbc_ctl.sh stop

sudo cd /var/lib/portsip/sbc

rm -rf *

2. Restoring a PortSIP SBC

First, copy the backup data to the PortSIP SBC server. You can use the default folder, such as /var/lib/portsip as the parent folder, then the SBC data folder is /var/lib/portsip/sbc , or another folder of your choice.

For example:

sudo mkdir -p /var/lib/portsip/sbc
sudo cp -p -r /back/sbc-data/sbc /var/lib/portsip/

After copying the data, make sure that the folder, all subfolders, and files have the correct permissions set to 888:888.

The command below is used to create and run the SBC on a server. If you copied the backup data to a folder other than /var/lib/portsip, make sure to use the actual folder in the commands below.

sudo /bin/sh sbc_ctl.sh run -p /var/lib/portsip -i portsip/sbc:11

Congratulations! Your SBC has now been successfully restored.

Restoring Backup Data to a New SBC Server

If you want to restore the backup SBC v11.x data to another new server, please follow the below steps.

Note, that once you successfully restore the SBC data to the new server, the SBC will be upgraded to the latest v11.x automatically.

1. prepare the new Linux server, don't install the SBC.

Copy the backup data to the new server. You can use the default folder, such as /var/lib/portsip, or another folder of your choice.

sudo mkdir -p /var/lib/portsip/sbc
sudo cp -p -r /back/sbc-data/sbc /var/lib/portsip/

After copying the data, make sure that the folder, all subfolders, and files have the correct permissions set to 888:888.

1. Now follow the guide Installation PortSIP SBC v11.x to install a new SBC with your restored SBC data by using the -p parameter to specify the restored data path.

After successfully installing the PortSIP SBC, your restored SBC data now is attached to the newly installed SBC.

After signing into the SBC web portal, go to the menu Settings > Network to update the SBC IP addresses with the new server's IP address then save changes.

Restoring from Backup Data on Linux for SBC v10.x

Please follow the steps below to restore the PortSIP SBC from the backup data in a Linux environment.

You can't restore the backup data of a Windows SBC to a Linux SBC.

Restoring from Backup Data to the Same Server

1. Stop the current PBX and delete the PBX data.

Execute the following commands to stop the SBC and delete the data:

cd /opt/portsip && /bin/sh sbc_ctl.sh stop

cd /var/lib/portsip/sbc

rm -rf *

2. Restoring a PortSIP SBC

First, copy the backup data to the PortSIP SBC server. You can use the default folder, such as /var/lib/portsip as the parent folder, then the SBC data folder is /var/lib/portsip/sbc , or another folder of your choice.

For example:

mkdir -p /var/lib/portsip/sbc
cp -p -r /back/sbc-data/sbc /var/lib/portsip/

After copying the data, make sure that the folder, all subfolders, and files have the correct permissions set to 888:888.

The command below is used to create and run the SBC on a server. If you copied the backup data to a folder other than /var/lib/portsip, make sure to use the actual folder in the commands below.

/bin/sh sbc_ctl.sh run -p /var/lib/portsip -i portsip/sbc:10

Congratulations! Your SBC has now been successfully restored.

Restoring Backup Data to a New SBC Server

If you want to restore the backup SBC v10.x data to another new server, please follow the below steps.

Note, that once you successfully restore the SBC data to the new server, the SBC will be upgraded to the latest v10.x automatically.

1. prepare the new Linux server, don't install the SBC.

Copy the backup data to the new server. You can use the default folder, such as /var/lib/portsip, or another folder of your choice.

mkdir -p /var/lib/portsip/sbc
cp -p -r /back/sbc-data/sbc /var/lib/portsip/

After copying the data, make sure that the folder, all subfolders, and files have the correct permissions set to 888:888.

1. Now follow the guide Installation PortSIP SBC v10.x to install a new SBC with your restored SBC data by using the -p parameter to specify the restored data path.

After successfully installing the PortSIP SBC, your restored SBC data now is attached to the newly installed SBC.

After signing into the SBC web portal, go to the menu Settings > Network to update the SBC IP addresses with the new server's IP address then save changes.

Restoring from Backup Data on Windows

Please follow the steps below to restore the PortSIP SBC from the backup data in a Windows environment.

You can't restore the backup data of a Linux SBC to a Windows SBC.

1. Uninstall the Currently Running SBC Instance

• Uninstall the PortSIP SBC from Windows

• Delete the below SBC folders:

  • C:\ProgramData\PortSIP\sbc

  • C:\Program Files\PortSIP\SBC

2. Upgrading the PortSIP SBC Installer (Optional)

You have the option to upgrade the PortSIP SBC Installer before restoring the PortSIP SBC data. The latest PortSIP SBC installer for Windows can be downloaded from the PortSIP website.

3. Restoring a PortSIP SBC

First, copy the backup data to the PortSIP SBC server folders:

• C:\ProgramData\PortSIP\SBC

You can use the default folder as the data parent folder, such as C:\ProgramData\PortSIP, or another folder of your choice.

Next, double-click the PortSIP SBC installer to install the PortSIP SBC. In the installation UI, choose the PortSIP SBC data parent folder (C:\ProgramData\PortSIP\), then click the Next button. Wait for the installation to complete.

Congratulations! Your SBC has now been successfully restored.

Restoring Backup Data to a New SBC Server

The steps for restoring backup data to a new SBC server are essentially the same.

After signing into the SBC web portal, go to the menu Settings > Network to update the SBC IP addresses with the new server's IP address then save changes.