Introduction
This guide is intended to help you through the migration process from SONARPLEX Version 4.1.x and 4.2.x to SONARPLEX release 5.1. SONARPLEX Generation 5 is a major release, and contains essential changes of the software especially for the plugins. This requires from the user additional steps in the upgrade procedure.
Important Notes and Restrictions
There are minor restrictions to be aware of, before starting with the upgrade.
This guide assumes you want to upgrade from SONARPLEX release 4.1 to SONARPLEX release 5.1.
Status Update
The system configuration, performance data and event-log will be upgraded to the new version. Due to the major software change the status file will not take over to the new version. This means it will take a while until the status will be updated.
Plugin Upgrade
It is important to check your system for compatibility before the upgrade to ensure a seamless migration.
Most of the plugins you are using in your appliance are not compatible with the SONARPLEX generation 5 and need to be updated as well.
This is will be done through the upgrade patch which includes updates for nearly all plugins except a few (see above). Make sure all plugins installed on your SONARPLEX device are covered by the patch. If not please contact support@azeti.net to clarify compatibility.
Plugins need to be upgraded manually. The Plugin configuration will be automatically upgraded during the installation of the new plugins.
The auto-upgrade function for plugins is not supported to upgrade from SONARPLEX generation 4 to SONARPLEX generation 5.
Incompatible Plugins
| Plugin Name | Description |
|---|---|
| check_azetiplugin_email_loop.azsp | Plugin for checking the whole e-mail delivery loop |
| HTTP-XML-Interface.azse | HTTP POST XML Interface for integration of external data and systems Accepts HTTP POST Requests and receives a XML file and parameters. Several variables can be conducted out of mutliple xml fields, e.g. the service name. |
Compatible Plugins
Following plugins are compatible and will be automatically upgraded through the upgrade patch. You can download all of these plugin in the azeti Portal as well.
The Service Check Plugin check_snmp.pl is not listed as it is installed by default and will be automatically updated.
| Plugin Name | Description | Version |
|---|---|---|
| camera.azsp | receives HTTP alerts form AXIS Cameras upon motion detection | Version 1.0.1273 |
| check_arm_state.azsp |
| Version 1.0.714 |
| check_axis_storage.pl | simple script for checking the storage state (OK or NON-OK) for Axis Mxxxx and Pxxxx cameras | (No version information available) |
| check_azetiplugin_akcpairflow.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcphumidity.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcpmotion.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcpsecurity.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcpsmoke.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcptemperature.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_akcpwater.tar.gz | SNMP based plugin to query specific sensor from AKCP sensorprobe device | Version 0.0.613 |
| check_azetiplugin_ncp_sevpn.azsp | Special remote check. The plugin checks data within a remote MYSQL database. | Version 1.0.663 |
| check_azetiplugin_esx_perf.azsps | Remote Check Plugin for checking performance counter on ESX hosts via the VMware Perl SDK. Requires the azeti Virtual Remote Host (azeti-VRH). | Version 1.0.675 |
| check_azetiplugin_exchange.tar.gz | collection of performance counters for exchange servers, based on check_ azeti_perf | Version 0.0.763 |
| check_azetiplugin_kyocera_toner.tar.gz | SNMP query for toner status of Kyocera printers | Version 0.0.617 |
| check_azetiplugin_netapp3.tar.gz | checks various system parameters like CPULOAD or FAILEDDISKS on NetApp Storage systems via SNMP | Version '3.0'.613 |
| check_oracle_ix.azsp (formerly check_azetiplugin_oracle) | remote check plugin which allows the user to execute custom sql queries via a remote oracle client | Version 1.0.676 |
| check_azetiplugin_remoteping.azsp | remote check plugin which allows the user to ping a host from a remote host | Version 1.0.613 |
| check_azetiplugin_vcenter_inv.azsps | checks VMware vCenter inventory and creats a csv for import within the SONARMANAGER | Version 1.0.683 |
| check_azetiplugin_vcenter_perf.azsps | check the performance counters of configured hosts and cluster in a VMware vCenter | Version 1.0.684 |
| check_azetiplugin_vcenter_status.azsps | check the status of configured hosts and cluster in a VMware vCenter | Version 1.0.686 |
| check_cisco_ipsla.azsp | checks the network latency through the proprietary CISCO IPSLA protocol. Data is received from cisco routers via SNMP | Version 1.0.613 |
| check_icmp_adv2.azsp | enhanced ICMP check with Host Property support (e.g. loading ip addresses of different network interfaces) | Version 1.0.618 |
| check_icmp2.azsp | enhanced check_icmp with TOS support and further advanced options | Version 1.0.613 |
| check_modbus_access_m2m-wtsc.azsp | MODBUS based check plugin for M2m-WTSC converters used within access control (via PIN-Pad or proximity reader) installations | Version 1.6.780 |
| check_modbus_fast_drycontact3.azsp | MODBUS based check for drycontacts | Version 1.7.777 |
| check_modbus_fast_read3.azsp | MODBUS based check to read single registers | Version 1.4.735 |
| check_modbus_fast_write4.azsp | MODBUS based check to write to single registers, also used by action_modbus_write.azsp | Version 1.4.738 |
| check_performance_trend.azsp | checks the latest value of an already monitored service against a historic value and compares the resulting difference against thresholds. This is especially useful to check for the growth or loss over a certain amount of time, e.g. for detecting abnormal fuel level drops. | Version 0.1.613 |
| check_radius_adv.azsp | checks the login on RADIUS servers | Version 1.0.623 |
| check_remote_snmp_ifbandwidth.azsp | remote check to execute a check_snmp_ifbandwidth from another host. E.g. when the destination is not in the same network segment as the SONARPLEX device or if SNMP is only enabled within a special network segment | Version 1.0.678 |
| check_snmp_ifbandwidth_pct.azsp | checks the percentual network interface usage in regards to either a fixed interface speed or an automatically detected interface speed, like it is the case for DSL Routers | Version 1.0.613 |
| data_exporter.azse | Coletcs event and performance data into archives as CSV and/or XML. These exports are regularly uploaded to a destination FTP server. | Version 1.0.506 |
| modbus-fastd.azse | MODBUS Fast Daemon | Version 1.7.1 |
| MODBUS-Setup.azse | tool to send manual request to a connected MODBUS for configuration and setup purposes, requires the modbus_fastd.azse | Version 1.3.563 |
| send_sms_to_gateway | connects the Messaging gateway for SMS sending | (No version information available) |
| snmpd.azse | Net-SNMP based daemon to access status information via SNMP GET from the SONARPLEX | Version 1.0.533 |
| sonargate.azse | provided the connection and configuration interface for the azeti SONARGATE | Version 1.2.28.1245 |
| sonartcpd.azse | TCP based Zigbee daemon for importing data from external sensors | Version 1.0.434 |
| Video.azse-Harvester.azse | Daemon to harvest recorded videos from connected Axis cameras and uploading these to an external FTP server later on | Version 1.0.570 |
Upgrade Preparations
Upgrade path
The SONARPLEX can be upgraded from release 4.2.x to 5.1.x. If you are running any version different from 4.2.x you must upgrade to release 4.2 first.
Order of upgrades in distributed monitoring (DM) environments
When upgrading in a distributed monitoring environment, you can decide the upgrade order that fits your organization. The distributed monitoring environment will work in an environment that have both SONARPLEX generation 4 and generation 5.
Order of upgrades in high-availability (HA) configurations
If you have a HA system installed, first you have to upgrade the master and second the slave.
Download necessary upgrade files
Please download following files from the azeti Portal. These are the minimum required files for the upgrade procedure.
TODO: update this list with proper links
- SONARPLEX 4.2 patch level - 7
- SONARPLEX 4.2 upgrade file - azeti Portal (see My Appliances).
- SONARPLEX 5.1 upgrade file - azeti Portal (see My Appliances).
- SONARPLEX 5 compatible plugins -if you did not receive the latests version plugins with the migration package, contact support.
- SONARMANAGER 2.7.3.17 - if you did not receive this version with the migration package, contact support.
- when neccesary, SONARPLEX 4.1.3 downgrade patch.
System Backup
Please remember to do backup first, before installing an update in case of any problems that may occur. To do backup please follow instructions below.
Please perform the following steps to create a backup using the Web Interface:
Open the Administration GUI
Choose Backup (left side menu) and ensure that all backup options are ticked as shown in the screenshot above
- Choose Create new backup including components. The backup creation starts immediately in the background. It will appear in the list of available backups later.
Download and store the created backup on an external drive. To download click on the disk icon in the row of the created backup.
SONARPLEX generation 5 contains new features which aren´t available in SONARPLEX generation 4. This means that the SONARPLEX generation 5 does not support generation 4 backups anymore.
In order to perform a rollback, a backup should be created before updating to generation 5.
Upgrade Installation
Prerequisites
Please enable Use large installation tweaks before the upgrade, this option deactivates automatic backups upon startup. This is highly recommended as otherwise the upgrade can take a long time and most installations can easily rely on SONARBACKUP or the regular auto backups.
To enable the large installation tweaks:
- Open the Admin GUI > Configuration > Load Configuration
- Activate Use large installation tweaks
Upgrade to SONARPLEX version 4.2.x
To upgrade to 4.2.x do the following:
- Open Admin GUI > Update
- Choose Manual Update and Browse to select the SONARPLEX version 4.2.0 image file (extension .aup)
- Select the update icon
to start the update, the SONARPLEX will reboot which takes up to 10 minutes
Install necessary updates for 4.2.x
To allow the upgrade to SONARPLEX Generation 5 you must install patch level update-4.2.0b-base-7
Even if you decide to stay with SONARPLEX release 4.2 the patch fixes some major bugs and it is recommended to be installed.
Upgrade to SONARPLEX version 5.1.x
Install the new SONARPLEX 5.1.x:
- Open Admin GUI > Update
- Choose Manual Update and Browse to select the SONARPLEX version 4.2.0 image file (extension .aup)
- Select the update icon to start the update, the SONARPLEX will reboot which takes up to 10 minutes
You can easily verify if the upgrade was successful:
- Open Admin GUI > Summary
- Check the proper version string in Your appliance is running which must show a 5.1.x version
SONARPLEX 5 comes with a green web interface color scheme. Due to the caching of your Web Browser it might be necessary to manual reload of the SONARPLEX Web page to see the new scheme.
Plugin Migration
Note that most of the plugins will show up Installation problems(s) (see screenshot above) in Admin GUI > My Plugins, this is normal as you now must now upgrade the plugins for compatibility.
Install the plugin upgrade patch
As most of the plugins are not compatible between SONARPLEX 4.x.x and 5.x.x, these must be updated. We highly recommend to use the upgrade patch (TODO: name here) as it will upgrade the plugins automatically.
TODO: Link to patch
Install the plugin upgrade patch:
- Choose Admin GUI > System > Patch
- Choose Browse to select the proper patch file and elect the apply icon to start the installation, the SONARPLEX will reboot which can take up to 10 minutes
TODO: new section
To migrate all installed plugins you can choose three different ways:
- Plugin upgrade patch (recommended)
- the SONARMANAGER
- the SONARPLEX Administration GUI
Different types of plugins require different handling. With both the SONARPLEX Administration GUI and the SONARMANAGER you are able to migrate and both guides describe all necessary steps.
- Perl plugins (plugins with extension *.pl)
OK, nothing to do. Normally this type of plugins should run under the new version without any migration activities. - *.tar.gz plugins
These type of plugins is not supported anymore. To migrate it to new version the corresponding *.azsp successor need to be installed. The new *.azsp version automatically takes over the configuration from the old version. The obsolete tar.gz should be deinstalled. - *.azse plugins (addons)
These type of plugins need to be replaced by the new version. The new version automatically takes over the configuration from the old version. - *.azsp plugins (checks)
These type of plugins need to be replaced by the new version. The new version automatically takes over the configuration from the old version. - modbus daemon and modbus plugins; see section modbus migration
Migration of MODBUS daemon if you choose not to use the patch:
- Deinstall both plugins modbus_fastd-COM1.azse and modbus_fastd-COM2.azse
- Install modbus_fastd_<version>_INTEL.azse. (version stands for the plugin version number. Please choose the most recent.)
- Installation of the new versions of MODBUS check plugins (if check_modbus_fast_write3 was installed please install the new version of it check_modbus_fast_write4)
- Migration of MODBUS configuration: simply install modbus_active_to_passive_converter-<version>.azse. Once installed the migration is done and the plugin can be deinstalled.
- Adapt configuration to the new plugins (see below).
- If check_modbus_fast_write3 was installed please deinstall it.
Manual Plugin Upgrade (complex and fragile)
The manual plugin upgrade should only be considered if the automatic upgrade is not suitable or cannot be done. Please contact support@azeti.net for assistance.
Updating Plugins with SONARMANAGER
The minimum version of SONARMANAGER is 2.7.3.11. The recommended version is the latest available (at the moment of writing 2.7.3.17). Please upgrade SONARMANAGER before the plugin migration.
- Create a folder and store all SONARPLEX 5 compatible plugins into it. In case you have MODBUS please copy modbus_fastd-COM1.azse, modbus_fastd-COM2.azse and check_modbus_fast_write3.azsp inti the folder as well, in order that SONARMANAGER allow you to delete them from the appliance.
- Open the project of the system that you are migrating. Please take into account that after the upgrade it can take some minutes to the agent to be active. Wait until you can see the agent in OK and with no timeout in the services list.
- Download the configuration of your appliance
- Click on "choose plugin directory" in setup menu
- Once the plugin folder is specified, right click the appliance in status tree and select "Manage Plugins"
- If you are using MODBUS: right click on you appliance and choose "Manage Plugins" and deinstall modbus_fastd-COM1.azse and modbus_fastd-COM2.azse. To do this, uncheck all other plugins, mark the "Remove" tick of the mod_bus_fastd-COM1 and COM2, and modbus_setup, and press apply.
- Install the modbus_fastd plugin (tick it an press apply)
- Install all other plugins to be updated. Check all the new plugins and press apply. The old plugins "Modbus Fast Write Plug-In for fast MODBUS daemon", modbus_fastd-COM1 and 2, the new modbus_fastd and the modbus_active_to_passive_converter have to stay unchecked.
- Migrate the Modbus configuration; tick the modbus_active_to_passive_converter and press apply
- Close the Plugin Management box and open it again (this is because of a software bug)
- Cleanup; deinstall the "Modbus Fast Write Plug-In for fast MODBUS daemon" and the modbus_active_to_passive_converter. Check the two and press apply.
- Close the Plugin Management box
Done!
Updating Plugins via the Administrative Interface
Remove old MODBUS-Daemons
If you are using Modbus deinstall modbus_fastd-COM1.azse, modbus_fastd-COM2.azse and modbus_setup:
- click on the triangle to expand the Plugin page
- click on the bin "Delete plugin" icon and confirm to deinstall it
Install the new MODBUS-Daemons
Install the new Modbus daemon, modbus_fastd.azse:
- Click browse to select modbus_fastd.azse
- Click on upload
- Wait for "install -ok"
Update incompatible Plugins
Incompatible/obsolete plugins are marked in red color and require a new version. Do following steps for all red marked plugins:
- Click browse to select the plugin
- Click on upload
- Wait for "install -ok"
Migrate the MODBUS Plugins
If you are using Modbus install MODBUS migration Plugin:
- Click browse to select the plugin modbus_active_to_passive_converter.azse
- Click on upload
- wait some seconds and press F5 to refresh your Web browser (this is because of a software bug)
For cleaning up your appliance delete check_modbus_fast_write3.azsp and modbus_active_to_passive_converter.azse:
- click on the triangle to expand the Plugin page
- click on the bin "Delete plugin" icon and confirm to deinstall it
Done!
At the end the MyPlugins page should look like this:
Configuration changes after upgrade
The new release introduced a whole new logging framework which allows a detailed logging configuration for single system components.
- By default logging verbose level is OFF. We recommend turning it to INFO for all hardware types except the SONARPLEX NG as it runs on SD flash.
- To warrant a consistent status among the old and new plugins, delete the retention file by going to the administrative interface; go to the Status::Monitor menu and press the icon for "Delete state retention file".
- The modbus upgrade uses a plugin called "modbus_active_to_passive_converter". This is an script that adjusts for you the configuration of the modbus plugins that were installed in the system. If still in the system after the upgrade (when using the patch upgrade, it should automatically removed from the system), search in Configuration::MyPlugins for the pluging "Modbus_active_to_passive_converter". This plugin can be safely removed from the system.
Downgrade to SONARPLEX 4.x.x
Following instruction guides you to perform a downgrade from SONARPLEX generation 5 to the previous version 4.x.x. Similar as for the upgrade you need to follow the upgrade path in the reverse direction. This means if you want to go to release 4.1.3 you need to install 4.2.0 first as an intermediate step.
The next steps are an example how to downgrade from SONARPLEX version 5.1.0 to version 4.1.3 with installed patch level 53
Preparations
- you need the two upgrade images SONARPLEX version 4.2.0 and 4.1.3
- you need the last patch for SONARPLEX version 4.1.3 update-4.1.3a-enhance-53-ir.tar
- you need a backup created in SONARPLEX version 4.1.3
- you need the downgrade patch update-4.1.3a-down-1.tar
Downgrade
- Update to SONARPLEX version 4.2.0
- Update to SONARPLEX version 4.1.3
- Install patch update-4.1.3a-down-1.tar --> Special patch to allow downgrade.
- Install patch update-4.1.3a-enhance-53-ir.tar
- Restore the backup you created in SONARPLEX version 4.1.3
- Done