Documentation

Documentation.Migration-2-1-0-to-2-2-0 History

Hide minor edits - Show changes to markup

April 11, 2016, at 03:03 PM by razvancrainea -
Added line 40:
  • mpath parameter has been changed for debian packages from the default /usr/lib/opensips/modules/ to /usr/lib/x86_64-linux-gnu/opensips/modules/; if you have your OpenSIPS installed from deb files, make sure you update it with the correct path.
March 31, 2016, at 05:36 PM by liviu -
Changed line 49 from:
  • script flags were removed (setsflag(), issflagset(), resetsflag()) - please rewrite logic so it makes use of message flags
to:
  • script flags were removed (setsflag(), issflagset(), resetsflag()) - former logic must be rewritten using message flags
March 31, 2016, at 05:36 PM by liviu -
Changed line 49 from:
  • script flags were removed (setsflag(), issflagset(), resetsflag()) - please base the logic on the message flags instead
to:
  • script flags were removed (setsflag(), issflagset(), resetsflag()) - please rewrite logic so it makes use of message flags
March 31, 2016, at 05:33 PM by liviu -
Added line 49:
  • script flags were removed (setsflag(), issflagset(), resetsflag()) - please base the logic on the message flags instead
March 31, 2016, at 04:07 PM by razvancrainea -
Changed lines 8-10 from:

You can find the all the new additions in the 2.2.0 release compiled under this page. The changelog may help your understanding of the migration / update process.

to:

You can find the all the new additions in the 2.2.0 release compiled under this page. The ChangeLog may help your understanding of the migration / update process.

Make sure you don't have any Makefile.conf files in your sources' root before starting the migration. The configuration file generated by 'menuconfig is not compatible with the one in older version!

March 31, 2016, at 12:16 PM by 109.102.83.252 -
Added lines 65-70:

DIALPLAN module

  • if using the default partition, be sure to explicitly set the db_url parameter (as the default value from db_default_url will not be inherited)

DISPATCHER module

  • if using the default partition, be sure to explicitly set the db_url parameter (as the default value from db_default_url will not be inherited)
March 31, 2016, at 10:49 AM by razvancrainea -
Changed line 75 from:

RATELIMTI module

to:

RATELIMIT module

March 31, 2016, at 10:48 AM by razvancrainea -
Added lines 71-73:

PROTO_TLS module

  • the TLS domains used for tuning the TLS parameters have been moved in the tls_mgm; in order to migrate the TLS module, you have to load the tls_mgm module and move the following modparams from proto_tls to tls_mgm: tls_method, certificate, private_key, ca_list, ca_dir, ciphers_list, dh_params, ec_curve, verify_cert
March 29, 2016, at 11:52 PM by 109.102.83.252 -
Added lines 71-73:

RATELIMTI module

  • to migrate the profile sharing the clusterer support drop the cachedb_url and use replicate_pipes_to parameter to point to a cluster ID (as defined by the clusterer module).
March 29, 2016, at 11:34 PM by 109.102.83.252 -
Added lines 63-64:
  • to migrate the dialog replication the clusterer support: parameter replicate_dialogs_to is an integer now pointing to a cluster ID (as defined by the clusterer module). The set of destinations must be now defined as a cluster.
  • to migrate the profile sharing the clusterer support: parameter replicate_profiles_to is an integer now pointing to a cluster ID (as defined by the clusterer module). Also you should consider setting the auth_check parameter to ON.
March 29, 2016, at 10:54 PM by 109.102.83.252 -
Deleted line 84:
Changed lines 86-89 from:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See Commit 0db7789
to:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See Commit 0db7789

USRLOC module

  • parameter replicate_contacts_to is an integer now pointing to a cluster ID (as defined by the clusterer module). The set of destinations must be now defined as a cluster.
March 29, 2016, at 02:25 PM by 109.102.83.252 -
Changed lines 71-75 from:
  • db_url parameter has been removed; a database can now be defined using trace_id parameter
  • trace_flag parameter has been removed; no flag needed, everything is done now using sip_trace() script function
  • trace_on flag can now be enabled/disabled per trace_id via mi
  • traced_user_avp has been removed; sip_trace now has a paramater trace_attrs which does the same thing, but pops only the first

value in a variable(not an entry for each value in case of an avp);

to:
  • db_url parameter has been removed; the db URL is now part of the trace_id parameter definition.
  • trace_flag parameter has been removed; no flag needed, everything is done now using sip_trace() script function (old sip_trace()+setflag() is now achieved via sip_trace("t") - transaction level tracing).
  • trace_on flag can now be enabled/disabled per trace_id via MI
  • traced_user_avp has been removed; sip_trace now has a paramater trace_attrs which does the same thing, but pops only the first value in a variable (not an entry for each value in case of an avp);
Changed lines 77-79 from:
  • trace_to_database flags has been removed; tracing can be enabled/disabled via mi on each trace_id, giving you the possibility to

enable/disable tracing for a trace_id containing a database

  • duplicate_with_hep flag has been removed; now one can define sip and hep generic uris through which the packets shall duplicated
to:
  • trace_to_database flags has been removed; tracing can be enabled/disabled via mi on each trace_id, giving you the possibility to enable/disable tracing for a trace_id containing a database
  • duplicate_with_hep flag has been removed; now one can define via trace_id parameter any sip or hep destination (any traffic can be traced in the same time to multiple trace IDs)
Changed lines 81-83 from:
  • trace_dialog has been removed; same functionality can be achieved using sip_trace with the proper flags
  • sip_trace function definition has changed; now it expects at least a trace_id and for advanced tracing one needs to properly set the

flags and trace_attrs(old traced_user_avp); see docs!

to:
  • trace_dialog has been removed; same functionality can be achieved using sip_trace with the proper flags ( sip_trace("d",...) )
  • sip_trace function definition has changed; now it expects at least a trace_id and for advanced tracing one needs to properly set the flags and trace_attrs(old traced_user_avp); see docs!
March 29, 2016, at 11:19 AM by ionutionita92 -
Changed lines 52-53 from:
  • cdr_flag has been removed; cdr accounting can now be made only with do_accounting() and disabled with drop_accounting;
  • table_avp has been removed; the table name is now a parameter to do_accounting;
to:
  • cdr_flag has been removed; cdr accounting can now be made only with do_accounting() and disabled with drop_accounting();
  • table_avp has been removed; the table name is now a parameter to do_accounting();
March 29, 2016, at 11:15 AM by ionutionita92 -
Changed lines 51-52 from:
  • all *_flag(log_flag, db_flag...) and *_missed_flag(log_missed_flag, aaa_missed_flag) along with failed_transaction are now parameters to do_accounting()(enable accounting) and drop_accounting()(cancel accounting); the flags are not support anymore so you have to remove them;
to:
  • all *_flag(log_flag, db_flag...) and *_missed_flag(log_missed_flag, aaa_missed_flag...) along with failed_transaction are now parameters to do_accounting()(enable accounting) and drop_accounting()(disable accounting); the flags are not supported anymore so you have to remove them;
  • cdr_flag has been removed; cdr accounting can now be made only with do_accounting() and disabled with drop_accounting;
Changed line 90 from:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See Commit 0db7789
to:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See Commit 0db7789
March 29, 2016, at 11:13 AM by ionutionita92 -
Changed lines 51-52 from:
  • all *_flag and *_missed_flag along with failed_transaction flag have been replaced with do_accounting() and drop_accounting() and also the table_avp has been removed. You need to remove all these flags from your script since they have been completely removed.
to:
  • all *_flag(log_flag, db_flag...) and *_missed_flag(log_missed_flag, aaa_missed_flag) along with failed_transaction are now parameters to do_accounting()(enable accounting) and drop_accounting()(cancel accounting); the flags are not support anymore so you have to remove them;
  • table_avp has been removed; the table name is now a parameter to do_accounting;
Changed lines 70-72 from:
  • a lot of parameters have been replaced with trace_id which offers all the functionality that you had before but in a different, simpler form
  • sip_trace() function changed; you need to provide at least the trace_id to it
  • traced_user_avp is now an argument to sip_trace() function
to:
  • db_url parameter has been removed; a database can now be defined using trace_id parameter
  • trace_flag parameter has been removed; no flag needed, everything is done now using sip_trace() script function
  • trace_on flag can now be enabled/disabled per trace_id via mi
  • traced_user_avp has been removed; sip_trace now has a paramater trace_attrs which does the same thing, but pops only the first

value in a variable(not an entry for each value in case of an avp);

  • duplicate_uri has been removed; it can now be defined using the trace_id both for normal sip and hep
  • table parameter has been removed; a database table can now be defined using trace_id parameter
  • trace_to_database flags has been removed; tracing can be enabled/disabled via mi on each trace_id, giving you the possibility to

enable/disable tracing for a trace_id containing a database

  • duplicate_with_hep flag has been removed; now one can define sip and hep generic uris through which the packets shall duplicated
  • hep_version has been removed; parameter moved inside proto_hep module
  • hep_capture_id has been removed; parameter moved inside proto_hep module
  • trace_dialog has been removed; same functionality can be achieved using sip_trace with the proper flags
  • sip_trace function definition has changed; now it expects at least a trace_id and for advanced tracing one needs to properly set the

flags and trace_attrs(old traced_user_avp); see docs!

March 28, 2016, at 10:58 PM by 109.102.83.252 -
Added lines 58-60:

DIALOG module

  • the ping_interval renamed as options_ping_interval (same meaning)
March 25, 2016, at 09:07 PM by 109.102.83.252 -
Added lines 61-63:

PROTO_TCP module

  • parameter tcp_async is now by default on, so you might need to explicitly set it in order to keep your desired setting.
March 25, 2016, at 08:36 PM by 109.102.83.252 -
Added line 29:

NOTE that the default MySQL DB engine is now InnoDB!

March 25, 2016, at 08:35 PM by 109.102.83.252 -
March 25, 2016, at 08:30 PM by 109.102.83.252 -
Changed line 47 from:
  • bin_listen core parameter is replaced by the bin_port module parameter from proto_bin' module (as a result of migrating the BIN implementation from core into a separate module)
to:
  • bin_listen core parameter is replaced by the bin_port module parameter from proto_bin module (as a result of migrating the BIN implementation from core into a separate module)
March 25, 2016, at 08:30 PM by 109.102.83.252 -
Added lines 46-47:
  • bin_children became obsolete as the BIN protocol implementation is now provided by the proto_bin module.
  • bin_listen core parameter is replaced by the bin_port module parameter from proto_bin' module (as a result of migrating the BIN implementation from core into a separate module)
March 25, 2016, at 07:40 PM by ionutionita92 -
Added lines 47-49:

ACC module

  • all *_flag and *_missed_flag along with failed_transaction flag have been replaced with do_accounting() and drop_accounting() and also the table_avp has been removed. You need to remove all these flags from your script since they have been completely removed.
Added lines 58-63:

SIPTRACE module

  • a lot of parameters have been replaced with trace_id which offers all the functionality that you had before but in a different, simpler form
  • sip_trace() function changed; you need to provide at least the trace_id to it
  • traced_user_avp is now an argument to sip_trace() function
March 25, 2016, at 07:15 PM by 109.102.83.252 -
Changed lines 54-55 from:
  • replace mi_xmlrpc_ng_root module parameter with the new namehttp_root
  • replace mi_xmlrpc_ng_format_version module parameter with the new name format_version
to:
  • replace mi_xmlrpc_ng_root module parameter with the new name http_root
March 25, 2016, at 07:13 PM by 109.102.83.252 -
Added lines 52-55:

MI_XMLRPC_NG

  • replace mi_xmlrpc_ng_root module parameter with the new namehttp_root
  • replace mi_xmlrpc_ng_format_version module parameter with the new name format_version
March 25, 2016, at 03:03 PM by 109.102.83.252 -
Changed line 54 from:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]]
to:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See Commit 0db7789
March 25, 2016, at 03:03 PM by 109.102.83.252 -
Changed lines 36-38 from:
  • Core
    • debug global parameter was replaced by the log_level global parameter, with the same behavior and values.
    • set_debug() function was removed and its functionality replaced by $log_level as follows:
to:

Core

  • debug global parameter was replaced by the log_level global parameter, with the same behavior and values.
  • set_debug() function was removed and its functionality replaced by $log_level as follows:
Changed lines 43-54 from:
  • debug MI command was replaced by log_level MI command - the entire functionality, input and out were preserved.
  • fork options is outdated and needs to be replaced with new debug_mode parameter. Please read carefully the documentation of the debug_mode option and its behavior is not 100% similar to fork.
  • as user/uid and group/gid global parameters were removed, use the -u and -g command line parameters instead.
  • AVPOPS module
    • if avp_db_query is used in multi-fields queries, note than DB NULL fields are reported as string "<null>" AVPs . You need to reconsider your checks for the return data as NULL AVPs may be reported as "<null>" AVPs now.
  • CPL-C module
    • as the module was renamed to cpl_c, be sure an update the loadmodule and modparam statements related to this module. The name of the functions and parameters did not change.
  • TM module
    • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]]
to:
  • debug MI command was replaced by log_level MI command - the entire functionality, input and out were preserved.
  • fork options is outdated and needs to be replaced with new debug_mode parameter. Please read carefully the documentation of the debug_mode option and its behavior is not 100% similar to fork.
  • as user/uid and group/gid global parameters were removed, use the -u and -g command line parameters instead.

AVPOPS module

  • if avp_db_query is used in multi-fields queries, note than DB NULL fields are reported as string "<null>" AVPs . You need to reconsider your checks for the return data as NULL AVPs may be reported as "<null>" AVPs now.

CPL-C module

  • as the module was renamed to cpl_c, be sure an update the loadmodule and modparam statements related to this module. The name of the functions and parameters did not change.

TM module

  • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]]
March 25, 2016, at 03:02 PM by 109.102.83.252 -
Added line 45:
  • as user/uid and group/gid global parameters were removed, use the -u and -g command line parameters instead.
March 25, 2016, at 02:25 PM by 109.102.83.252 -
Added line 35:
Changed lines 46-51 from:
to:
  • AVPOPS module
    • if avp_db_query is used in multi-fields queries, note than DB NULL fields are reported as string "<null>" AVPs . You need to reconsider your checks for the return data as NULL AVPs may be reported as "<null>" AVPs now.
  • CPL-C module
    • as the module was renamed to cpl_c, be sure an update the loadmodule and modparam statements related to this module. The name of the functions and parameters did not change.
Deleted lines 53-55:
  • CPL-C module
    • as the module was renamed to cpl_c, be sure an update the loadmodule and modparam statements related to this module. The name of the functions and parameters did not change.
March 25, 2016, at 12:34 PM by 109.102.83.252 -
Added lines 48-50:
  • CPL-C module
    • as the module was renamed to cpl_c, be sure an update the loadmodule and modparam statements related to this module. The name of the functions and parameters did not change.
March 25, 2016, at 11:34 AM by 109.102.83.252 -
Changed line 43 from:
  • fork options is outdated and needs to be replaced with new debug_mode parameter. Please read carefully the documentation of the debug_mode option and its behavior is not 100% similar to fork.
to:
  • fork options is outdated and needs to be replaced with new debug_mode parameter. Please read carefully the documentation of the debug_mode option and its behavior is not 100% similar to fork.
March 25, 2016, at 11:34 AM by 109.102.83.252 -
Added lines 43-45:
  • fork options is outdated and needs to be replaced with new debug_mode parameter. Please read carefully the documentation of the debug_mode option and its behavior is not 100% similar to fork.
March 24, 2016, at 09:28 PM by 109.102.83.252 -
Changed lines 36-37 from:
  • debug global parameter was replaced by the log_level global parameter, with the same behavior and values.
  • set_debug(N) function was removed and its functionality replaced with $log_level=N. Instead of set_debug(), now do $log_level=NULL;
to:
  • debug global parameter was replaced by the log_level global parameter, with the same behavior and values.
  • set_debug() function was removed and its functionality replaced by $log_level as follows:
  set_debug(2); is now $log_level=2;
  set_debug() is now $log_level=NULL;
Changed line 44 from:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]
to:
  • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]]
March 24, 2016, at 09:13 PM by 109.102.83.252 -
Changed lines 36-37 from:
  • debug global parameter is replaced by the log_level global parameter, with the same behavior and values.
  • set_debug(N) function was removed and its functionality replaced with log_level=N. Instead of set_debug(), now do log_level=NULL;
to:
  • debug global parameter was replaced by the log_level global parameter, with the same behavior and values.
  • set_debug(N) function was removed and its functionality replaced with $log_level=N. Instead of set_debug(), now do $log_level=NULL;
  • debug MI command was replaced by log_level MI command - the entire functionality, input and out were preserved.
Deleted line 40:
March 24, 2016, at 08:56 PM by 109.102.83.252 -
Added line 36:
  • debug global parameter is replaced by the log_level global parameter, with the same behavior and values.
March 24, 2016, at 08:33 PM by 109.102.83.252 -
Added lines 35-36:
  • Core
    • set_debug(N) function was removed and its functionality replaced with log_level=N. Instead of set_debug(), now do log_level=NULL;
March 24, 2016, at 08:24 PM by 109.102.83.252 -
Changed lines 34-36 from:
to:

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script (some of them are fixes):

  • TM module
    • t_relay() - 0x01 flag is outdated (has no effect any more). See [https://github.com/OpenSIPS/opensips/commit/0db7789|Commit 0db7789]
August 26, 2015, at 05:28 PM by 82.208.174.39 -
Added lines 1-35:
Documentation -> Migration -> Migration from 2.1.x to 2.2.0

This page has been visited 6584 times. (:toc-float Table of Content:)


This section is meant to provide useful help in migrating your OpenSIPS installations from the 2.1.0 version to 2.2.0.

You can find the all the new additions in the 2.2.0 release compiled under this page. The changelog may help your understanding of the migration / update process.


DB migration

You can migrate your 1.10.x MySQL DB to the 1.11.0 format by using the opensipsdbctl tool :

   # opensipsdbctl migrate opensips_2_1 opensips_2_2

where :

  • opensips_2_1 is the existing DB name corresponding to version 2.1.x format
  • opensips_2_2 is the DB name to be created for 2.2 format

NOTE:

  • the old database will not be deleted, altered or changed - it will not be touched at all
  • new database will be created and data from old DB will be imported into it

NOTE that the migration tool is available only for MYSQL databases!

(:toc-back Back to Table of Contents:)


Script migration


Page last modified on April 11, 2016, at 03:03 PM