18. Update & Backup
18.1. Update v3.a.b > v3.x.y
Connect to your server via SSH
Create a backup of the current version using the following command:
sudo cp -pr cs cs_backup
Change to the cs directory
cd ./cs
Download the latest Connectivity Suite console application. The credentials for repository are provided by NetModule.
curl -u cs-install ftp://ftp.netmodule.com/latest/cs-cmd -o cs-cmd
Run the cs-cmd tool and select “update assistant”
./cs-cmd
18.2. Upgrade v2.6 > v3.0
Since v3.0 is based on a different software architecture than v2.6, this is not only an update but also a migration.
Warning
In case any of the following steps fail we advice to snapshot the Virtual Machine where the Connectivity Suite is installed so that a roll back is possible.
Warning
To install and run the Connectivty Suite v3 your need to have an up to date Ubuntu 20/22 or Debian 10/11 with Docker v20+ and the Docker Compose v2+ plugin installed. See Section 2.1.2 for details.
Warning
Routers with NRSW older than 4.3 will not be able to connect to a Connectivity Suite v3.x. Make sure to update the outdate Router Software before upgrading the Connectivity Suite.
Note
The following steps assume that you have installed your CS v2.6 in your home directory under ~/cs
. If this is not the case, please adjust the paths below accordingly.
Connect to your server via SSH
Download the Connectivity Suite Backup script
curl https://repo.netmodule.com/repository/cs/v2.6/scripts/export_cs_v2.py -o export_cs_v2.py
Export Connectivity Suite v2.6 data with the Backup script and note the location of the cs_export.zip file. You will need this later.
python ./export_cs_v2.py
Change to the ~/cs/docker-prod directory
cd ./cs/docker-prod
Stop the v2.6 instance
docker-compose down
Change directory back to home
cd ~
Rename the cs directory to cs_v2x
mv cs cs_v2x
Create new cs directory
mkdir cs
Change to new cs directory
cd ./cs
Run a ls command to make sure the directory is empty
ls
Download Connectivity Suite console application. The credentials for repository are provided by NetModule.
curl -u cs-install ftp://ftp.netmodule.com/latest/cs-cmd -o cs-cmd
Add execution permission to newly downloaded cs-cmd
sudo chmod +x ./cs-cmd
Run the cs-cmd tool and select “v2.x migration assistant”
./cs-cmd
The requested path to the cs_export.zip was printed out at step 3 and is similar to
/home/ubuntu/cs_export.zip
Optional: Remove v2.6
rm -rf ~/cs_v2x
Warning
When updating from v2.6 to v3.0, certain restrictions must be observed which are noted in chapter Section 18.2.1
18.2.1. Migration Notes
The migration to v3.0 will not migrate the full data of v2.6. The following list shows the affected entities:
Replacement Devices
Devices which should replace an existing device and their replacement provisioning config will not be migrated. Make sure to finish all your device replacement jobs before you upgrade.
Provisioning Devices
Devices currently connected to the provisioning network will not be migrated. Make sure to move all devices to their tenant before you upgrade.
Logs
The plain-text logs will no be migrated.
Jobs
Jobs will not be migrated. Make sure that there are no open jobs before you migrate.
Provisioning Configurations
Already downloaded configurations from CS v2.6 will no longer work for CS v3.0.
Device metric data
6 Months Online/Offline device state changes per Device will be migrated.