...

Table of Contents

Change History

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.

Automatic Plugin Upgrade (recommended)

This is the recommended way. Please install the patch update-5.1.0b-base-1.tar. It will automate the whole upgrade process and will migrate the MODBUS configuration to apply to the new generation 5 feature set.

Manual Plugin Upgrade (complex and fragile)

Note
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

Note
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

Image Removed

Once the plugin folder is specified, right click the appliance in status tree and select "Manage Plugins"
Image Removed

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.
Image Removed

Install the modbus_fastd plugin (tick it an press apply)
Image Removed

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.
Image Removed

...

Migrate the Modbus configuration; tick the modbus_active_to_passive_converter and press apply
Image Removed

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.
Image Removed
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:

Image Removed

Configuration changes after upgrade

The new release introduced a whole new logging framework which allows a detailed logging configuration for single system components.

Info

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.

Info
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

...

Version	Date

Version 1.2. 20140527. Please add version and pagination when sending to the client.

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.

Note
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

Plugins need to be upgraded manually. The Plugin configuration will be automatically upgraded during the installation of the new plugins.

Info
The auto-upgrade function for plugins is not supported to upgrade from SONARPLEX generation 4 to SONARPLEX generation 5.

Note
For all plugins (except the *.pl plugins) you already installed on your appliances you should find a new version in the portal. If you miss any of your plugins please do not continue and contact the azeti technical support. Still, the upgrade patch will take care of the versions and the plugins upgrade if you follow the "upgrade patch" route.

Upgrade Preparations

Upgrade path

The SONARPLEX can be upgraded from release 4.2 to 5.1. When you have a previous version you have to 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.

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

Note
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.

...

Open the Administration GUI
Browse to "Backup" (left site menue)
Ensure that all backup options are ticked as shown in the screenshot above
Image Removed
Click on Create new backup including components
SONARPLEX will start to create the backup in the background (will take some time depending of the size of the backup)
Once created it will appear in the list with available backups

Info
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 SONARPLEX generation 5.

Note
Store the created backup on an external drive. To download click on the disk icon in the row of the created backup.

Upgrade Installation

Note
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. Before starting the upgrade process, you should have a new version for each one of your already installed plugins. If you miss a new version for a plugin please do not continue and contact the azeti technical support.

Before the installation

In the Admin GUI, go to Configuration::system::Load Configuration option. Select the option "Use large installation tweaks" and confirm the changes. This option will avoid the automatic backup that is done every time that the SONARPLEX reboots, reducing the time neccesary to perform the upgrades.

Info
You can activate this option whenever you are doing maintenance tasks and want to avoid the automatic start up backup.

Upgrade to SONARPLEX version 4.2

Please perform the following steps to install SONARPLEX version 4.2.0 using the Web Interface:

open the Administration GUI (IPADDRESS:81)
browse to "Update" (left side menu)
go to manual update section and click on "browse" to select the SONARPLEX version 4.2.0 upgrade file
click on "upload the selected file" icon on the right side of the upgrade file name to start the upgrade process
the upgrade process will takes some minutes and will reboot when finished
now the SONARPLEX runs the version 4.2.0

Install Patch to allow upgrade to SONARPLEX generation 5

To allow the upgrade to SONARPLEX Generation 5 please install patch level update-4.2.0b-base-7 or higher on your appliance.

Info
Minimum patch level for the upgrade from SONARPLEX 4.2 is 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

Please perform the following steps to install SONARPLEX generation 5 using the Web Interface:

open the Administration GUI (IPADDRESS:81)
browse to "Update" (left side menu)
go to manual update section and click on "browse" to select the SONARPLEX generation 5 upgrade file
click on "upload the selected file" icon on the right side of the upgrade file name to start the upgrade process
the upgrade process will takes some minutes and will reboot when finished

To check if the update to SONARPLEX generation 5 was successfully installed, simply open the appliance GUI using its IP Address. SONARPLEX 5 was redesigned with different colors, which is is easiest way to verify your update. To check which version of SONARPLEX is running on your appliance visit section Status - Summary.

Due to the caching of your Web Browser it might be necessary to manual reload of the SONARPLEX Web page; most browsers support CTLR-F5 to reload.

SONARPLEX 4

Image Removed

SONARPLEX 5

Image Removed

Plugin Migration

Preparation

Most of the plugins you are using in your appliance are not compatible with the SONARPLEX generation 5 and need to be updated. Therefore after the upgrade, you will find most of the plugins in red (See image below.). This means they have to be upgraded. The new version of the plugins can be found in the azeti portal.

Image Removed

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.

Comment
Current Version (v. 44)	Aug 29, 2014 11:22	Sebastian Koch: Added note about new support of check_azetiplugin_email_loop for 5.1.2a
v. 42	Aug 05, 2014 14:45	Marcos Moreno: removed references to specific version 5.1.1a and 5.1.1b and referring 5.1.x to avoid client confusion.
v.34	Jul 10, 2014 16:09	Sebastian Koch: Added note about fixed check_azetiplugin_netapp3, Added end of life for check_azetiplugin_kyocera_toner. Added not about check_radius_adv fix. Added Known Issues Table
v. 32	Jul 09, 2014 10:25	Sebastian Koch: Enhanced backup creation instructions
v. 29	Jul 08, 2014 18:15	Sebastian Koch: Added extra steps to disable notifications, flushing the mail queue and fixed minor typos
v. 25	Jul 08, 2014 12:11	Sebastian Koch: Extended list of incompatible plugins and known issues for EOL packages
v. 21	Jul 01, 2014 15:31	Sebastian Koch: Added Known Issues for Upgrade section regarding plugin update package
v. 18	Jun 26, 2014 16:01	Sebastian Koch: Fixed minor typos in portal paths, Added section about Plugin Download for azeti NG

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.x 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 before the Upgrade

There are minor restrictions to be aware of, before starting with the upgrade.

Note
This guide assumes you want to upgrade from SONARPLEX release 4.1 to SONARPLEX release 5.1.x. Substitute 5.1.x for your destination version.

Known Issues for Upgrade

Tip
Make sure to download the latest plugin-update package form the azeti Portal as this is maintained and updated frequently and offers the latest bugfixes for the upgrade process.

Following list shows known issues which are already fixed.

Issue	Description	Solution
1	Plugin installation errors can appear in seldom circumstances	latest plugin-updates package (plugin-updates-xxx_v4.2.0b_to_v5.1.x.tar)
2	Monitor process is restarted repeatedly because of missing status.log	latest plugin-updates package (plugin-updates-xxx_v4.2.0b_to_v5.1.x.tar)
3	check_azetiplugin_akcptemperature, check_azetiplugin_akcphumidity and check_azetiplugin_akcpsmoke exit with error "... unexpectedly returned value 4" when remote host is not reachable	latest plugin-updates package (plugin-updates-xxx_v4.2.0b_to_v5.1.x.tar)
4	SMS for contactgroup works only for first contact in list	will be fixed with SP 5.1.2
5	Message in watchdog "watchdog failed to reanimate smsd" when no modem attached	solved in patch 3 for 5.1.2 (e.g. update-5.1.2a-std-xxx)

Plugin and Extension Upgrade

It is important to check your system for compatibility before the upgrade to ensure a seamless migration. Most of the available plugins require an update, this can be done automatically by the plugin-updates packages covered in the following sections. There do all the necessary steps automatically in the background.

Incompatible Plugins and Extensions

Below are all incompatible plugins and extension listed.

Warning
Do not upgrade your device if any of the below plugins are installed and actively used by an service or host check (marked in green with label "used by ..."). Please contact support@azeti.net for further assistance.

Plugin Name	Description	Status
~~check_azetiplugin_email_loop.azsp~~	~~Plugin for checking the whole e-mail delivery loop~~	~~incompatible~~ Fixed with SONARPLEX v5.1.2a, plugin-updates-001_v4.2.0b_to_v5.1.2a (September 2014)
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. It will then try to match the content of the XML file to the mandatory sonarplex variables like service name, hostname, freshness and plugin output. Several variables can be conducted out of mutliple xml fields, e.g. the service name.	incompatible
check_radius	Built in radius check	execution problem, please use check_radius_adv.azsp instead, see Compatible Plugins and Extensions
~~check_azetiplugin_netapp3~~	~~SNMP based check for NetAPP storage systems~~	~~Installation issues in 5.1.1a, will be fixed shortly~~ Fixed with plugin-updates-003_v42.0b_to_v5.1.1b
check_modbus_drycontact check_modbus_drycontact2	Standalone plugin to read dry contacts via MODBUS	End of life. Replaced by check_modbus_fast_drycontact3 and the required modbus_fastd Daemon. Requires manual upgrade work, please contact support@azeti.net for further information.
check_modbus_poll check_modbus_read check_modbus_read2	Standalone plugin for reading values via MODBUS	End of life. Replaced by check_modbus_fast_read3 and the required modbus_fastd Daemon. Requires manual upgrade work, please contact support@azeti.net for further information.
check_modbus_access	MODBUS based access control plugin	End of life. Replaced by check_modbus_access_m2m-wtsc and the required modbus_fastd Daemon. Requires manual upgrade work, please contact support@azeti.net for further information.
check-modbus-device-alive	Host check plugin based on MODBUS	End of life.
check_modbus_write check_modbus_write2	Plugins for writing registers via MODBUS	End of life. Replaced by check_modbus_fast_write4 or the MODBUS action and the required modbus_fastd Daemon. Requires manual upgrade work, please contact support@azeti.net for further information.
check_azetiplugin_kyocera_toner	Checks toner resource via SNMP	End of life. Unsupported for SONARPLEX 5. Monitoring toner should be configured via SNMP Traps from the printer to the SONARPLEX.

Compatible Plugins and Extensions

Following plugins are compatible and will be automatically upgraded through the upgrade patch. You can download all of these plugin in azeti Portal > Download > SONARPLEX Generation 5 > Plugins as well.

Info
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	used for site surveillance based on the state other alarm are triggered	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_netapp3.azsp	Checks NetAPP resource values via SNMP	Version 3.0.807
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_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_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_radius_adv	Advanced RADIUS login check. Replaces the built in check_radius as has currently open bugs	Version 1.0.623
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

Plugins for the azeti NG device

If you're using the azeti NG and want to install plugins manually you must check if a specific ARM version of that plugin exists. Please do so as the ARM platform of the azeti NG may require a specific ARM version of particular plugins. Anyway, most of the plugins will run on any platform. An example for such a specific ARM version is the modbus_fastd.azse.

Info
You can get specific ARM builds of plugins which run on the azeti NG in the azeti Portal > Downloads > SONARPLEX Generation 5 > Plugins > ARM.

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.

Upgrade Preparations

Upgrade path

Note
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

You can either download the files manually or as a package which contains everything.

Upgrade Package

A package containing the necessary update for 4.2.0b, plugin updates for 5.1.1 and the SONARMANAGER is available in the azeti Portal.

Info

Download the package at azeti Portal > Downloads > SONARPLEX Generation 5 > Upgrade from 4.2.x to 5.1.x > Upgrade_Package_vxxx_from_SONARPLEX_4.2.x_to_5.1.x.zip

Note that you still must download the image update file for your device (indentified by its SysId), see azeti Portal > My Appliances > <SONARPLEX SysId>.

Individual File Download

Necessary files can be individually downloaded from the azeti Portal. These are the minimum required files for the upgrade procedure.

Package	Filename	Description	Download
SONARPLEX 4.2 patch level 7	update-4.2.0b-base-7.tar	enables upgrade from SONARPLEX 4.2.0b to 5.1.x	azeti Portal > Downloads > SONARPLEX Generation 4 > Updates
SONARPLEX 5.1.x image	<SysID>-daaz1en-5.1.x.aup (e.g. 2m002421121f36-daaz1en-5.1.1b.aup)	Full Operating System image version 5.1.x	azeti Portal > My Appliances > <SONARPLEX SysId>
SONARPLEX 5.1.x plugin updates	plugin-updates-xxx_v4.2.0b_to_v5.1.x.tar	Package containing all necessary plugin updates for automatic installation	azeti Portal > Downloads > SONARPLEX Generation 5 > Updates
SONARMANAGER 2.7.3.24	SonarManager_2.7.3.24.zip	SONARMANAGER compatible to SONARPLEX 5.x.x	azeti Portal > Downloads > SONARPLEX Generation 5 > SONARMANAGER

System Backup

Anchor

	system-backup
	system-backup

Note
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:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> System > Backup
Choose all listed components (addon_data, logfiles, monitoring, performance_data, system) for the inclusion and tick persistent backup (backup is excluded for the regular rotation)
Choose Create new backup including components. The backup creation starts immediately in the background. The new backup file will appear in the list of available backups after the creation is finalized.
Download the created backup by choosing Image Added and store the created backup on an external drive

Info

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 must be created before updating to generation 5.

Enable Large Installation Tweaks

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:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> Configuration > System > Load Configuration
Activate Use large installation tweaks

Info
You can activate this option whenever you are doing maintenance tasks and want to avoid the automatic start up backup. Of course you can activate it afterwards again.

Disable Notifications

Notifications should be disabled globally during the upgrade process to avoid any unnecessary notifications or even possible alert floods.

Insert excerpt

	_UserWebDisableNotificationsGlobally
	_UserWebDisableNotificationsGlobally
nopanel	true

Info
This disables the notifications persistently, so even reboots and Monitor process restarts will keep the notification system disabled. Check Re-Enable the Notifications after the upgrade.

Upgrade Installation

Upgrade to SONARPLEX version 4.2.x

Info
You must download the SONARPLEX image(s) for the following upgrades form the azeti Portal specifically for your device(s), see the previous section Individual File Download for details.

To upgrade to 4.2.x do the following:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> Update
Choose Manual Update and Browse to select the SONARPLEX version 4.2.0 image file (extension .aup) you downloaded previously
Select the update icon Image Added 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 a patch.

Info
Minimum patch level for the upgrade from SONARPLEX 4.2 is base 7, named update-4.2.0b-base-7.tar.

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:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> Update
Choose Manual Update and Browse to select the SONARPLEX version 5.1.x image file (extension .aup) you downloaded previously
Select the update icon Image Added to start the update, the SONARPLEX will reboot which takes up to 10 minutes

You can easily verify if the upgrade was successful:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> Summary
Check the proper version string in Your appliance is running which must show a 5.1.x version

Info
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.

Image Added

After the SONARPLEX Upgrade

SONARPLEX 5 is a major release and thus some minor system configuration changes must be done right after the upgrade.

Updating the LOAD Configuration

The following step assures that the global LOAD Configuration is properly updated and is mandatory.

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> Configuration > System > Load Configuration
Choose Image Added to save the current configuration and apply it with the following Image Added

Configure the global Log Level

A whole new logging framework was introduced with the upgrade. See

Insert excerpt

	_AdminWeb
	_AdminWeb
nopanel	true

> Configuration > System > Logging Configuration.

By default the Debug log level is set to OFF. We recommend turning it to INFO for all hardware types except the azeti NG.

Note
The azeti NG runs on SD flash storage and debug log levels can lead to decreased lifetime of the storage due to large amounts of write operations through logging. Therefore leave the Debug log level set to OFF.

Flush the Retention File

To warrant a consistent status among the old and new plugins, delete the retention file.

Insert excerpt

	_AdminWebDeleteRetention
	_AdminWebDeleteRetention
nopanel	true

Flush the Mail Queue

It is possible that during the upgrade system messages are created and stored in the email queue. Those would be sent out whenever you enable the SMTP configuration and you can flush those if you don't want to receive such mails from the upgrade.

Flushing queued e-mails:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> System > Email Queue
Choose Image Added Delete all messages in queue and press OK

Re-Enable the Notifications

When all upgrade steps are done and the system behaves properly, it is save to enable the notifications again. Check that not too many service and host checks are in Non-OK states to avoid notification floods.

Insert excerpt

	_UserWebEnableNotificationsGlobally
	_UserWebEnableNotificationsGlobally
nopanel	true

Plugin Migration

Info

Note that most of the plugins will show up Installation problems(s) (see screenshot above) in

Insert excerpt

	_AdminWeb
	_AdminWeb
nopanel	true

> Configuration > My Plugins, this is normal as you now must upgrade the plugins for compatibility.

Image Added

Follow one of the below described ways, automatic or manual, to update all plugins.

Installing the Plugin Update Package

As most of the plugins are not compatible between SONARPLEX 4.x.x and 5.x.x, these must be updated.

Info
We highly recommend to use the upgrade patch as it will upgrade the plugins automatically. You can find the plugin update, named plugin-updates-003_v4.2.0b_to_v5.1.x.tar in the azeti Portal > Downloads > SONARPLEX Generation 5 > Updates

After the download you must install the plugin updates package:

Insert excerpt
_OpenAdminWeb
_OpenAdminWeb
nopanel true
> System > Patch
Choose Browse to select the proper patch file and elect the apply icon Image Added to start the installation, the SONARPLEX will reboot which can take up to 10 minutes

Tip
If you performed all necessary steps as noted in this guide you have successfully updated to SONARPLEX 5.1.x.

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Change History

Automatic Plugin Upgrade (recommended)

Manual Plugin Upgrade (complex and fragile)

Updating Plugins with SONARMANAGER

Updating Plugins via the Administrative Interface

Remove old MODBUS-Daemons

Install the new MODBUS-Daemons

Update incompatible Plugins

Migrate the MODBUS Plugins

Configuration changes after upgrade

The new release introduced a whole new logging framework which allows a detailed logging configuration for single system components.

Downgrade to SONARPLEX 4.x.x

Preparations

Downgrade

Introduction

Important Notes and Restrictions

Status Update

Plugin Upgrade

Upgrade Preparations

Upgrade path

Order of upgrades in distributed monitoring (DM) environments

Order of upgrades in high-availability (HA) configurations

Download necessary upgrade files

System Backup

Upgrade Installation

Before the installation

Upgrade to SONARPLEX version 4.2

Install Patch to allow upgrade to SONARPLEX generation 5

Upgrade to SONARPLEX version 5.1

Plugin Migration

Preparation

Introduction

Important Notes before the Upgrade

Known Issues for Upgrade

Plugin and Extension Upgrade

Incompatible Plugins and Extensions

Compatible Plugins and Extensions

Plugins for the azeti NG device

Status Update

Upgrade Preparations

Upgrade path

Order of upgrades in distributed monitoring (DM) environments

Order of upgrades in high-availability (HA) configurations

Download necessary upgrade files

Upgrade Package

Individual File Download

System Backup

Enable Large Installation Tweaks

Disable Notifications

Upgrade Installation

Upgrade to SONARPLEX version 4.2.x

Install necessary updates for 4.2.x

Upgrade to SONARPLEX version 5.1.x

After the SONARPLEX Upgrade

Updating the LOAD Configuration

Configure the global Log Level

Flush the Retention File

Flush the Mail Queue

Re-Enable the Notifications

Plugin Migration

Installing the Plugin Update Package