UTM 5.3-002 upgrade to version 5.3-003 user manual

Update instructions

1. Stop all the UTM5 components (UTM5 core, UTM5 RADIUS server, UTM5 RFW, etc.) E.g. in case of Debian GNU/Linux, execute the following commands:
/etc/init.d/utm5_core stop
/etc/init.d/utm5_radius stop
/etc/init.d/utm5_rfw stop
Then make sure that the services actually stopped:
ps aux | grep utm5_core
ps aux | grep utm5_radius
ps aux | grep utm5_rfw

2. Make backups for all the configuration files in the /netup/utm5/ directory

3. Be sure to create a fresh backup of the SQL database (DB) and the detailed traffic information (one can use the mysqldump or pg_dump utilities, depending on the DBMS type), or use an existing backup if it is up to date. Make sure all the data can be restored from that backup.

4. Remove the old UTM5 installation E.g. in Debian GNU/Linux distributives use the following command:
dpkg –r utm5
In FreeBSD use the following:
pkg_delete utm5

5. Install the new version of UTM5. E.g. in Debian GNU/Linux distributives use the following command:
dpkg -i utm-5-X.XXX.deb
In FreeBSD use the following:
pkg_add utm5-X-X-XXX.tgz

6. At first launch the new version of the UTM5 core will automatically update the DB structure. This requires the user account used by UTM5 to manage the DB, have the appropriate privileges (for creating and editing DB tables) One can also update the DB structure manually. For MySQL database, use the following command:
mysql -f UTM5 < /netup/utm5/UTM5_MYSQL_update.sql
For PostgreSQL use the following:
psql -f /netup/utm5/UTM5_PG_update.sql -d UTM5

7. In order to automatically update DB indexes at first launch of the UTM5 core, add the following parameter to the core configuration file (utm5.cfg):
verify_database_index=enable
Important! This operation can take A LOT of time. To minimize idle time, one might use table archiving before updating the database indexes

8. When upgrading from build 5.3-001 or older, after unpacking the distributives, updating configuration files and the database structure (just before launching the UTM5 core for the first time), you have to convert the parameters of previously implemented service cost recalculation into the currently used charge policy parameters. This can be done with the automatic converter utility, which comes as part of the UTM5 distributive. Use the following command to launch the converter:
/netup/utm5/bin/block_conv -v old_version_of_UTM5
Where old_version_of_UTM5 is:
007 for version 5.2.1-007 and updates
008 for version 5.2.1-008 and updates
009 for version 5.2.1-009 and updates (default value)
5.3 for version 5.3-001 and updates (virtually the same as 009)
The converter will show the conversion parameters and prompt for confirmation that those parameters are correct.

9. In case of any license updates, e.g. when purchasing new UTM5 modules, one has to update the license information BEFORE the first launch of the updated UTM5 core. In order to update the license, put the new reg.sql file to the /netup/utm5 (replace the old one if necessary) At first launch the UTM5 core will automatically load license information from /netup/utm5/reg.sql into the DB and will delete this file

10. In order to use the utm5_dhcpd module, one has to:
• renew the license (needed for commercial use of the module, in other case the module will operate in demo mode)
• edit /netup/utm5/dhcpd5.cfg configuration file and add:
a) current UTM5 database access parameters
b) current UTM5 core access parameters (via Stream protocol)
c) list of network interfaces
- add a system user for the utm5_dhcpd service if needed. The default user is "dhcp", with password "dhcp", access is allowed from 127.0.0.1. This user is added only after initializing new database.

11. Launch the UTM5 components (UTM5 core, UTM5 RADIUS, UTM5 RFW, etc.) E.g. in case of Debian GNU/Linux, use the following commands:
/etc/init.d/utm5_core start
/etc/init.d/utm5_radius start
/etc/init.d/utm5_rfw start

12. The document generation system implemented in UTM5 5.3-003 or newer is incompatible with the system, implemented in previous versions. We recommend reading current UTM5 documentation to get familiar with the new system and update all document templates to comply with new format. In order to generate documents in PDF format, LibreOffice package is required to be installed on the server running UTM5 (otherwise the documents will be generated in ODT format)