Table of Contents
...
| Note |
|---|
This guide assumes you want to upgrade from SONARPLEX release 4.1 to SONARPLEX release 5.1. |
Known Issues for Upgrade
| Warning | ||
|---|---|---|
| ||
| 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-003_v4.2.0b_to_v5.1.1a.tar) |
| 2 | Monitor process is restarted repeatedly because of missing status. |
...
This was released in the time of 25th june 2014 until 1st july 2014.
...
| title | Solution |
|---|
...
| log | latest plugin-updates package (plugin-updates-003_v4.2.0b_to_v5.1.1a.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-003_v4.2.0b_to_v5 |
...
| .1.1a.tar) |
Plugin and Extension Upgrade
...
| Plugin Name | Description | Status | ||
|---|---|---|---|---|
| check_azetiplugin_email_loop.azsp | Plugin for checking the whole e-mail delivery loop | incompatible | ||
| 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. | incompatible | ||
| check_radius_advAdvanced RADIUS check | installation issues in 5.1.1a, will be fixed shortly | check_radius | Built in radius check | execution problem, will be fixed shortlyplease use check_radius_adv.azsp instead, see Compatible Plugins and Extensions |
|
| be fixed shortly
Fixed with plugin-updates-003 | ||
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
...
| 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.gzSNMP query for toner status of Kyocera printers | Version 0netapp3.azsp | Checks NetAPP resource values via SNMP | Version 3.0.617807 | |
| 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 vCenterVersion 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_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 |
...
| 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.1a image | <SysID>-daaz1en-5.1.1a.aup (e.g. 2m002421121f36-daaz1en-5.1.1a.aup) | Full Operating System image version 5.1.1a | azeti Portal > My Appliances > <SONARPLEX SysId> |
| SONARPLEX 5.1.1a plugin updates |
plugin-updates-002003_v4.2.0b_to_v5.1.1a.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 |
...
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.
- Open Admin GUI > Configuration > System > Load Configuration
- Choose
to save the current configuration and apply it with the following 
Configure the global Log Level
A whole new logging framework was introduced with the upgrade. See Admin GUI > 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.
| Info |
|---|
Deleting the retention file leads to a flush of all status information, this will set every host and service object into state PENDING. This is expected and the objects will be checked during the normal check intervals and return into a non-PENDING state. |
Deleting the retention file:
- Open Admin GUI > Status > Monitor
- Choose
Delete state retention file (read online help before using), the Monitor process will be restarted automatically
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:
- Open the Admin GUI > System > Email Queue
- Choose 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.
Enable notifications globally:
- Open the Web GUI > Status > Processes
- Choose
Enable notifications and press Commit in the next screen
Plugin Migration
| Info |
|---|
Note that most of the plugins will show up Installation problems(s) (see screenshot above) in Admin GUI > Configuration > My Plugins, this is normal as you now must upgrade the plugins for compatibility. |
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-002003_v4.2.0b_to_v5.1.1a.tar in the azeti Portal > Downloads > SONARPLEX Generation 5 > Updates |
After the download you must install the plugin updates package:
- 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
| Tip |
|---|
| If you performed all necessary steps as noted in this guide you have successfully updated to SONARPLEX 5.1.1a. |