• (only for 3.2.4 or earlier) the $rT pseudo-variable (topmost route type) has been replaced by $route (route call stack). The equivalent syntax is $(route[-1]{s.select,0,[}). The $rT variable has been re-introduced starting with 3.2.5, for backwards-compatibility reasons.

• the $rT pseudo-variable (topmost route type) has been replaced by $route (route call stack). The equivalent syntax is $(route[-1]{s.select,0,[}).

• the timerec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

• the timerec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

ACC module

• The acc_created_avp_name parameter has been completely dropped, as it was no longer being used.

• if the tls_mgm module is only used for the management of TLS certificates and parameters by modules like db_mysql, rabbitmq etc. (and not for TLS operations by transport modules like proto_tls etc.) then the new tls_library module parameter must be set to none. Otherwise, tls_mgm will not start unless you also load tls_openssl or tls_wolfssl, even though they are not actually used in this case.

PROTO_TLS module

• one of the tls_wolfssl or tls_openssl TLS library modules has to be loaded before tls_mgm

PROTO_WSS module

• one of the tls_wolfssl or tls_openssl TLS library modules has to be loaded before tls_mgm

TLS_MGM module

• if the tls_mgm module is only used for the management of TLS certificates and parameters by modules like db_mysql, rabbitmq etc. (and not for TLS operations by transport modules like proto_tls, which also require loading tls_wolfssl or tls_wolfssl) then the new tls_library module parameter must be set to none.

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed (i.e. week 0 becomes week 1, per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

B2B_LOGIC module

• the B2B scenario logic is now implemented via OpenSIPS scripting instead of XML files. Check this tutorial for more details and examples of XML scenarios and their equivalent OpenSIPS script implementation.
• In order to simplify the migration effort, you have the option to use a legacy b2b_logic_xml module, that will be obsoleted with the next OpenSIPS 3.3 release. Use this only as a temporary solution until you properly migrate to the new variant of the b2b_logic_module.

DIALPLAN module

Dialog module

• the E_DLG_STATE_CHANGED parameters have changed. The hash_id and hash_entry parameters were replaced by id and db_id, to be more consistent with the output of dlg_list and what OpenSIPS advertises in the Record-Route header. If you are listening for this event in your external application, or directly in OpenSIPS script using the EVI interface, make sure you adapt the $param names to the new format.

DROUTING module

• the $rT pseudo-variable (topmost route type) has been replaced by $route (route call stack). The equivalent syntax is $(route[-1]).

• the $rT (topmost route type) has been replaced by $route (route call stack). The equivalent syntax is $(route[-1]).

Core Variables

• the $rT (topmost route type) has been replaced by $route. The equivalent syntax is $(route[-1]).

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed (per RFC 5545)! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

• the timerec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.
• time recurrences: the byyearday, bymonth and byweekno integers are now 1-indexed instead of 0-indexed!! Make sure to convert any such data accordingly, otherwise your time recurrence strings will no longer match as expected following an upgrade to 3.2

Make sure you don't carry a left-over Makefile.conf file in your OpenSIPS source tree if migrating to a new branch! This configuration file, generated by make menuconfig, is usually not compatible with the one of a previous major release!

Make sure you don't carry a left-over Makefile.conf file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by make menuconfig, is usually not compatible with the one of a previous major release!

Make sure you don't have a left-over Makefile.conf file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by make menuconfig, is usually not compatible with the one of a previous major release!

Make sure you don't have any left-over Makefile.conf file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by make menuconfig, is usually not compatible with the one of a previous major release!

Make sure you don't have any left-over Makefile.conf file in your OpenSIPS source tree if checking out a new branch! This configuration file, generated by make menuconfig, is usually not compatible with the one of an older major release!

Make sure you don't have any left-over Makefile.conf file in your OpenSIPS source tree before starting the migration! This configuration file, generated by make menuconfig, is usually not compatible with the one of an older major release!

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

• the time_string parameter of check_time_rec() has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your logic unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend an empty-string timezone followed by the delimiter, i.e. "|".

• the time_string parameter of check_time_rec() has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your logic unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend an empty-string timezone, followed by the delimiter, i.e. "|".

• the time_string parameter of check_time_rec() has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your logic unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend "|".

• the timerec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

• the timerec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

• the time_string parameter of check_time_rec() has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your logic unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend "|".

• the time_string parameter of check_time_rec() has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend "|".

• example

Core keywords

• example

Core MI commands

• example

CFGUTILS module

• the time_string parameter has been extended with a leading timezone field. Although we made strings such as "20200101T...|..." backwards-compatible with the current implementation, strings such as "|20200101T..." will now break your code unless you prepend your input with the "timezone |" string. To use the system timezone, just prepend "|".

DROUTING module

• the time_rec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

DIALPLAN module

• the time_rec column syntax has been normalized. Firstly, the "dtend" field has been added, so the final column value has been made compatible with the input of check_time_rec(). Secondly, the leading "timezone" field has been added, so it must be prepended accordingly -- in order to keep using the system timezone, just prepend a "|" string.

Documentation -> Migration -> Migration from 3.1.x to 3.2.0

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

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

You can migrate your 3.1.x MySQL DB to the 3.2.x format using the opensips-cli tool :

   # opensips-cli -x database migrate 3.1_to_3.2 opensips_3_1 opensips_3_2

• opensips_3_1 is the existing DB name corresponding to version 3.1.x format
• opensips_3_2 is the DB name to be created for 3.2.x format

FOOBAR module

• example

B2B_ENTITIES module

• dropped the replication_mode module parameter.

PRESENCE module

• switch to string values instead of integers for the cluster_federation_mode module parameter (disabled instead of 0 and on-demand-sharing instead of 1)

EVENT_DATAGRAM module

• The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.

EVENT_JSONRPC module

• the event_jsonrpc module has been renamed to event_stream. you have to replace your modparam("event_jsonrpc"... lines with modparam("event_stream"... lines
• the transport protocol token from the event socket has been changed from jsonrpc to tcp (for example, you have to use tcp:127.0.0.1:8080/block_ip instead of jsonrpc:127.0.0.1:8080/block_ip).

EVENT_RABBITMQ module

• The event payload is now formated as a JSON-RPC notification instead of the custom OpenSIPS line oriented formatting, so you have to change the parsing of the event in your external applications.

See the opensips-cli documentation for more details.

You can migrate your 3.0.x MySQL DB to the 3.1.x format using the opensips-cli tool :

   # opensips-cli -x database migrate 3.0_to_3.1 opensips_3_0 opensips_3_1

See the opensips-cli documentation for more details.

• the dlg_list MI command no longer outputs the DB id as the ID of the dialog, but a hex(entry).hex(id) representation of its id. The DB id field has been moved in the db_id node.

DIALOG module

• the $DLG_did format has been changed from printing the entry:id of the dialog to hex(entry).hex(id), just as the Record-Route parameter is added
• the dlg_list MI command no longer outputs the DB id as the ID of the dialog, but a hex(entry).hex(id) representation of its id. The DB id field has been moved in the 'db_id node.
• the dlg_end_dlg MI command no longer receives the DB id as an identifier for finding the dialog to terminate, but the same hex(entry).hex(id) printed by the $DLG_did variable and by the dlg_list command.

• script variable $af to be replaced with $socket_in(af)

• script variable $fs to be replaced with $socket_out
• script variable $Ri to be replaced with $socket_in(ip)
• script variable $Rp to be replaced with $socket_in(port)
• script variables $proto/$pr to be replaced with $socket_in(proto)

• the tcp_listen_backlog parameter was renamed as tcp_socket_backlog parameter, with the same definition and behavior.

The following is the full list of backwards-incompatible syntax or functional changes in the OpenSIPS configuration script:

• the listen parameter was renamed as socket parameter, with the same definition and behavior.

TLS_MGM module

• the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it: modparam("tls_mgm", "tls_method", "[default]SSLv23")

• the tls_handshake_timeout and tls_send_timeout from the tls_mgm module have been removed, thus they can no longer be used to tune the proto_wss module. Instead of those parameters, we've added the and , that are now part of the proto_wss module. To migrate your script, you should replace any of your lines as it follows:

@]

PROTO_WSS module

• the default tls_method has been changed from SSLv23 to TLSv1_2. Therefore if you were not setting the tls_method parameter in your script, you will now have to explicitly set it to the SSLv23 value in your script.

    # Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_tls", "tls_handshake_timeout", 200)
    # Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
    modparam("proto_tls", "tls_send_timeout", 200)

    # Before 3.1 was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_wss", "wss_tls_handshake_timeout", 200)
    # Before 3.1 was modparam("tls_mgm", "tls_send_timeout", 200)
    modparam("proto_wss", "wss_send_timeout", 200)

PROTO_TLS module

• the tls_handshake_timeout and tls_send_timeout parameters have been moved from the tls_mgm module to the proto_tls module. Check out the new documentation ]. To migrate your script, you should replace any of your lines as it follows:

    modparam("proto_tls", "tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_tls", "tls_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)

PROTO_WSS module

• the tls_handshake_timeout and tls_send_timeout from the tls_mgm module have been removed, thus they can no longer be used to tune the proto_wss module. Instead of those parameters, we've added the ] and ], that are now part of the proto_wss module. To migrate your script, you should replace any of your lines as it follows:

    modparam("proto_wss", "wss_tls_handshake_timeout", 200) # OLD was modparam("tls_mgm", "tls_handshake_timeout", 200)
    modparam("proto_wss", "wss_send_timeout", 200) # OLD was modparam("tls_mgm", "tls_send_timeout", 200)

• the auto_aliases is now by default off, so if you had no setting of it in the old script you should set it explicitly to "on" to keep the same behavior.

• cache_raw_query()'s last parameter is now an unquoted variable
• construct_uri()'s user, port and extra are now optional parameters

Documentation -> Migration -> Migration from 3.0.x to 3.1.0

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

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

• opensips_3_0 is the existing DB name corresponding to version 3.0.x format

Core functions

• The following alias names were dropped:
  • rewritehost() for sethost()
  • rewritehostport() for sethostport()
  • rewriteuser() for setuser()
  • rewriteuserpass() for setuserpass()
  • rewriteport() for setport()
  • rewriteuri() for seturi()

Documentation -> Migration -> Migration from 3.1.x to 3.1.0

This page has been visited 4021 times. (:toc-float Table of Contents:)

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

You can find the all the new additions in the 3.1.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!

DB migration

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

   # opensipsdbctl migrate opensips_3_0 opensips_3_1

where :

• opensips_3_0 is the existing DB name corresponding to version 3.1.x format
• opensips_3_1 is the DB name to be created for 3.1.x 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!

NOTE that the default MySQL DB engine is now InnoDB!

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

Script migration

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

Global Parameters

• example

Core keywords

• example

Core MI commands

• example

Statistics migration

• example

Module migration

• example