Documentation

Documentation.Migration-2-4-0-to-3-0-0 History

Hide minor edits - Show changes to output

May 04, 2021, at 11:48 AM by liviu -
Added lines 43-44:
* %red% due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work as before %%
Deleted lines 49-50:

* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work as before
June 25, 2020, at 12:00 PM by liviu -
Changed line 49 from:
* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work again
to:
* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work as before
June 25, 2020, at 11:59 AM by liviu -
Changed line 49 from:
* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to explicitly set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work again
to:
* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work again
June 25, 2020, at 11:58 AM by liviu -
Added lines 48-49:

* due to the newly introduced '''xlog_level''' global parameter (default value: L_NOTICE (2)), you may need to explicitly set an '''xlog_level = 3''' value before any of your ''xlog("L_INFO", ...)'' statements can work again
May 26, 2020, at 07:41 PM by liviu -
Changed line 17 from:
# opensips-cli -x database migrate opensips_2_4 opensips_3_0
to:
# opensips-cli -x database migrate 2.4_to_3.0 opensips_2_4 opensips_3_0
Added lines 23-24:

See [[https://github.com/OpenSIPS/opensips-cli/blob/master/docs/modules/database.md#database-migration-mysql-only|the opensips-cli documentation]] for more details.
October 11, 2019, at 08:41 AM by liviu -
Changed line 15 from:
You can migrate your 2.4.x MySQL DB to the 3.0.x format by using the '''opensipsdbctl''' tool :
to:
You can migrate your 2.4.x MySQL DB to the 3.0.x format by using the '''opensips-cli''' tool :
Changed line 17 from:
# opensipsdbctl migrate opensips_2_4 opensips_3_0
to:
# opensips-cli -x database migrate opensips_2_4 opensips_3_0
August 29, 2019, at 12:08 PM by liviu -
Added lines 78-89:

For example:

[@
avp_subst("$avp(sdp_ip)", "/^c=IN IP[46] (.*)$/\1/");
@]

becomes:

[@
avp_subst("$avp(sdp_ip)", "/^c=IN IP[46] (.*)$$/\1/");
@]
August 29, 2019, at 12:07 PM by liviu -
Added lines 51-52:
!!!!! Remove quotes
Changed lines 74-80 from:
\\
to:

!!!!! Escape "$" characters in plain-text strings

Since all OpenSIPS strings which get passed to functions have become format strings in 3.0, each singular '''"$"''' sign must be escaped using its '''"$$"''' form, otherwise the parser will expect a variable over there!

!!!!! Other function-related issues
July 09, 2019, at 12:39 PM by liviu -
Changed line 191 from:
!!!! URI module
to:
!!!! URI module (dropped)
July 03, 2019, at 01:50 PM by razvancrainea -
Added lines 127-141:

!!!! EVENT_ROUTE module
* '''fetch_event_params()''' function has been completely dropped - in order to fetch the parameters of an event, you will have to use the '''$params(name)''' variable in the route. As an example, the following snippets have the same meaning in the two different versions:
[@
# route used in OpenSIPS 2.4
event_route[E_PIKE_BLOCKED] {
fetch_event_params("ip=$avp(pike-ip)");
xlog("IP $avp(pike-ip) has been blocked\n");
}

# route used in OpenSIPS 3.0
event_route[E_PIKE_BLOCKED] {
xlog("IP $param(ip) has been blocked\n");
}
@]
June 09, 2019, at 12:16 PM by liviu -
Changed line 153 from:
* '''remove_hf()''' was split into '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf()]]''', '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf_re()]]''' and '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf_glob()]]'''. As a result, the "flags" parameter was dropped.
to:
* '''remove_hf()''' was split into '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf()]]''', '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf_re|remove_hf_re()]]''' and '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf_glob|remove_hf_glob()]]'''. As a result, the "flags" parameter was dropped.
June 09, 2019, at 12:16 PM by liviu -
Changed line 153 from:
* '''remove_hf()''' was split into '''remove_hf()''', '''remove_hf_re()''' and '''remove_hf_glob()'''. As a result, the "flags" parameter was dropped.
to:
* '''remove_hf()''' was split into '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf()]]''', '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf_re()]]''' and '''[[https://opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_remove_hf|remove_hf_glob()]]'''. As a result, the "flags" parameter was dropped.
June 05, 2019, at 07:16 PM by rvlad_patrascu -
Added line 136:
* as the protocol for MI interaction has been shifted to ''JSON-RPC'', you must now use POST instead of GET as HTTP request method.
May 24, 2019, at 07:11 PM by liviu -
Added line 88:
* '''buf_size''' query printing buffer was removed in favour of the new generic format string buffer setting, '''[[https://www.opensips.org/Documentation/Script-CoreParameters-3-0#pv_print_buf_size|pv_print_buf_size]]'''
April 25, 2019, at 06:31 PM by 109.99.227.30 -
Changed line 76 from:
ERROR:core:fix_actions: Failed to fix command <_name_of_function_>
to:
ERROR:core:fix_actions: Failed to fix command <name_of_function>
Changed line 78 from:
it means the ''n''-th parameter of the module function ''_name_of_function_'' changed from string type to integer or variable type. \\
to:
it means the ''n''-th parameter of the module function ''name_of_function'' changed from string type to integer or variable type. \\
April 25, 2019, at 06:31 PM by 109.99.227.30 -
Added line 54:
Added line 56:
Added line 58:
Added line 60:
Added line 64:
Added line 66:
Added line 68:
Added line 70:
April 25, 2019, at 06:30 PM by 109.99.227.30 -
Changed lines 49-65 from:
!!!! Core keywords

* example

!!!! Core MI commands

* example

!!!! Statistics migration

* example

!!! Module migration

!!!! CACHEDB_REDIS

* example
to:
!!!! Module functions

As a result of the enhancement of the interface for module functions (for generic support of script variables in the parameters), some parameters will have be passed without quotes (like if they are numerical values or returning variables).

For example:
[@ send_reply( "200", "OK"); @]
is now
[@ send_reply( 200, "OK"); @]
as the first parameter requires a numerical value.

Also :
[@ check_source_address( "4", "$avp(ctx)"); @]
is now
[@ check_source_address( 4, $avp(ctx)); @]
as the first parameter requires a numerical value and the second one requires a returning variable.\\
\\
There are many changes as the ones listed above. IF during the startup, while the config file is parsed to get an error like:
[@
ERROR:core:fix_cmd: Param [n] expected to be an integer or variable
ERROR:core:fix_actions: Failed to fix command <_name_of_function_>
@]
it means the ''n''-th parameter of the module function ''_name_of_function_'' changed from string type to integer or variable type. \\
\\
To do the translation to the right type of parameter, check the documentation of faulty function - there you can find the required type for each parameter. If you have doubts how to pass the certain parameters (depending on their type), please check this [[https://www.opensips.org/Documentation/Script-Syntax-3-0#toc8|documentation]].
April 19, 2019, at 08:42 AM by liviu -
Changed line 110 from:
* '''enum_pv_query()''' has been merged into '''[[https://opensips.org/html/docs/modules/3.0.x/enum.html#func_enum_query|enum_query()]]
to:
* '''enum_pv_query()''' has been merged into [[https://opensips.org/html/docs/modules/3.0.x/enum.html#func_enum_query|enum_query()]]
April 19, 2019, at 08:42 AM by liviu -
Added lines 108-110:

!!!! ENUM module
* '''enum_pv_query()''' has been merged into '''[[https://opensips.org/html/docs/modules/3.0.x/enum.html#func_enum_query|enum_query()]]
April 16, 2019, at 08:47 PM by rvlad_patrascu -
Added lines 111-116:

!!!! MI_HTTP module
* the '''mi_http''' module has been renamed to '''mi_html''' module. you have to replace your @@modparam("mi_http"...@@ lines with @@modparam("mi_html"...@@ lines

!!!! MI_JSON module
* the '''mi_json''' module has been renamed to '''mi_http''' module. you have to replace your @@modparam("mi_json"...@@ lines with @@modparam("mi_http"...@@ lines
April 16, 2019, at 08:03 PM by liviu -
Changed lines 71-73 from:
to:
!!!! AVPOPS module
* '''avp_insert()''' was dropped in favour of the equivalent, already existing syntax: '''$(avp(foo)[append]) = "bar";''' (for appending to end-of-list) and '''$(avp(foo)[3]) = "bar";''' (for writing at a specific AVP index)
Changed lines 85-98 from:
to:
!!!! DIALPLAN module
* '''[[https://opensips.org/html/docs/modules/3.0.x/dialplan.html#func_dp_translate|dp_translate()]]''' parameters have been reworked to be more clear:
** the composite "partition:id" parameter was split into "id" (mandatory) and "partition" (optional)
** the composite "src/dest" parameter was split into "input" (mandatory) and "out_var" (optional)

!!!! DISPATCHER module
* '''[[https://opensips.org/html/docs/modules/3.0.x/dispatcher.html#func_ds_select_dst|ds_select_dst()]]''' parameters have been reworked to be easier to understand and maintain. Specifically:
** the "s" (skip destination) flag was dropped (equivalent logic: "$du == NULL && ds_select_dst()")
** the "a" (append destination) flag was added, replacing all the complex set / algorithm / flags list-parameter logic in favour of simply calling ds_select_dst() multiple times.
** the "set" composite parameter was decoupled into two basic parameters: "set" (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/dispatcher.html#func_ds_select_domain|ds_select_domain()]]''' parameters have been reworked to be easier to understand and maintain. The changes follow the same pattern as ds_select_dst().
* '''[[https://opensips.org/html/docs/modules/3.0.x/dispatcher.html#func_ds_count|ds_count()]]''''s complex "set" parameter has been split in two simple parameters: "set" (mandatory) and "partition" (optional).
* '''[[https://opensips.org/html/docs/modules/3.0.x/dispatcher.html#func_ds_is_in_list|ds_is_in_list()]]''''s complex "set" parameter has been split in two simple parameters: "set" (mandatory) and "partition" (optional).
Changed lines 101-102 from:

to:
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_do_routing|do_routing()]]''''s composite "[partition:]group_id" parameter has been split in two parameters: "group_id" (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_route_to_carrier|route_to_carrier()]]''''s composite "[partition:]carrier_id" parameter has been split in two parameters: "carriers" (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_route_to_gw|route_to_gw()]]''''s composite "[partition:]gw_id" parameter has been split in two parameters: "gw_id" CSV (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_use_next_gw|use_next_gw()]]''''s parameter order has been changed for consistency reasons ("partition" is last now)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_goes_to_gw|goes_to_gw()]]''''s parameter order has been changed for consistency reasons ("partition" is last now)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_is_from_gw|is_from_gw()]]''''s parameter order has been changed for consistency reasons ("partition" is last now)
* '''[[https://opensips.org/html/docs/modules/3.0.x/drouting.html#func_dr_is_gw|dr_is_gw()]]''''s parameter order has been changed for consistency reasons ("partition" is last now)
Changed lines 112-116 from:
to:
!!!! PERMISSIONS module
* '''[[https://opensips.org/html/docs/modules/3.0.x/permissions.html#func_check_address|check_address()]]''''s composite "[partition:]group_id" parameter has been split in two parameters: "group_id" (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/permissions.html#func_check_source_address|check_source_address()]]''''s composite "[partition:]group_id" parameter has been split in two parameters: "group_id" (mandatory) and "partition" (optional)
* '''[[https://opensips.org/html/docs/modules/3.0.x/permissions.html#func_get_source_group|get_source_group()]]''''s composite "[partition:]var" parameter has been split in two parameters: "var" (mandatory) and "partition" (optional)
Changed lines 126-133 from:
to:
!!!! SIPMSGOPS module
* '''remove_hf()''' was split into '''remove_hf()''', '''remove_hf_re()''' and '''remove_hf_glob()'''. As a result, the "flags" parameter was dropped.

!!!! SIPCAPTURE module
* '''[[https://opensips.org/html/docs/modules/3.0.x/sipcapture.html#func_report_capture|report_capture()]]''' parameter order has changed
* '''[[https://opensips.org/html/docs/modules/3.0.x/sipcapture.html#func_hep_set|hep_set()]]''' parameter order has changed
* '''[[https://opensips.org/html/docs/modules/3.0.x/sipcapture.html#func_hep_get|hep_get()]]''' parameter order has changed
Deleted line 138:
Added lines 146-148:

!!!! UAC_REDIRECT module
* '''[[https://opensips.org/html/docs/modules/3.0.x/uac_redirect.html#func_get_redirects|get_redirects()]]''' -> the deprecated "reason" parameter, along with the accounting logic behind it have been completely dropped
April 16, 2019, at 07:57 PM by 109.99.227.30 -
Added lines 102-107:
!!!! SIPTRACE module
* the '''siptrace''' module has been renamed to '''tracer''' module. you have to replace your @@modparam("siptrace"...@@ lines with @@modparam("tracer"...@@ lines
* function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#func_sip_trace|sip_trace()]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#func_trace|trace()]]
* MI function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#mi_sip_trace|sip_trace]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#mi_trace|trace]]

Changed lines 113-115 from:
to:
!!!! UAC module
* the "uac_replace_xxx()" functions requires now 2 parameters (display and URI), where the first one may be optional. Instead of '''uac_replace_from("URI")''', simply use '''uac_replace_from( , "URI")'''
Changed lines 139-145 from:
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_user_exist|aaa_does_uri_user_exist()]] was moved to the AUTH_AAA module under the same name and behavior.


!!!! SIPTRACE module
* the '''siptrace''' module has been renamed to '''tracer''' module. you have to replace your @@modparam("siptrace"...@@ lines with @@modparam("tracer"...@@ lines
* function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#func_sip_trace|sip_trace()]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#func_trace|trace()]]
* MI function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#mi_sip_trace|sip_trace]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#mi_trace|trace]]
to:
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_user_exist|aaa_does_uri_user_exist()]] was moved to the AUTH_AAA module under the same name and behavior.
April 16, 2019, at 07:50 PM by razvancrainea -
Added lines 134-137:
!!!! SIPTRACE module
* the '''siptrace''' module has been renamed to '''tracer''' module. you have to replace your @@modparam("siptrace"...@@ lines with @@modparam("tracer"...@@ lines
* function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#func_sip_trace|sip_trace()]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#func_trace|trace()]]
* MI function [[https://opensips.org/html/docs/modules/2.4.x/siptrace#mi_sip_trace|sip_trace]] was renamed in the new module to [[https://opensips.org/html/docs/modules/2.4.x/tracer#mi_trace|trace]]
March 08, 2019, at 02:52 PM by 109.99.227.30 -
Added line 47:
* global parameter ''xlog_default_level''' was renamed as '''xlog_print_level''', with no change in its behavior
February 13, 2019, at 02:35 PM by 109.99.227.30 -
Changed lines 41-46 from:
* example
to:
* the '''children''' parameter is replaced by '''udp_workers''' parameter. The old name is marked as obsolete, but it still can be used (it will be effectively removed in the next release)

* the '''tcp_children''' parameter is replaced by '''tcp_workers''' parameter. The old name is marked as obsolete, but it still can be used (it will be effectively removed in the next release)

* the '''use_children''' option inside the '''listen''' parameter is replaced by '''use_workers'''. The old name is marked as obsolete, but it still can be used (it will be effectively removed in the next release)
January 07, 2019, at 05:23 PM by rvlad_patrascu -
Added lines 68-70:

!!!! CLUSTERER module
* the '''current_id''', '''current_info''' and '''neighbor_info''' module parameters were renamed to '''my_node_id''', '''my_node_info''' and '''neighbor_node_info''' respectively.
January 05, 2019, at 07:08 PM by 109.99.227.30 -
Changed line 83 from:
!!! PRESENCE module
to:
!!!! PRESENCE module
January 05, 2019, at 07:04 PM by 109.99.227.30 -
Added line 74:
Changed lines 76-77 from:
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/drouting.html#param_status_replication_cluster|status_replication_cluster]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/drouting.html#param_cluster_id|cluster_id]].
to:
* the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/drouting.html#param_status_replication_cluster|status_replication_cluster]] was renamed as [[http://www.opensips.org/html/docs/modules/3.0.x/drouting.html#param_cluster_id|cluster_id]].


!!!! LOAD_BALANCER module
* the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/load_balancer.html#param_status_replication_cluster|status_replication_cluster]] was renamed as [[http://www.opensips.org/html/docs/modules/3.0.x/load_balancer.html#param_cluster_id|cluster_id]].


!!! PRESENCE module
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/presence.html#param_cluster_sharing_tags|cluster_sharing_tags]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#param_sharing_tag|sharing_tag]] - note that the syntax is slightly different, refer to docs.
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/presence.html#mi_pres_set_sharing_tag_active|pres_set_sharing_tag_active]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_shtag_set_active|mi_clusterer_shtag_set_active]]
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/presence.html#mi_pres_list_sharing_tags|pres_list_sharing_tags]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_list_shtags|mi_clusterer_list_shtags]]
January 05, 2019, at 07:00 PM by 109.99.227.30 -
Added lines 73-76:

!!!! DROUTING module
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/drouting.html#param_status_replication_cluster|status_replication_cluster]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/drouting.html#param_cluster_id|cluster_id]].
January 05, 2019, at 06:58 PM by 109.99.227.30 -
Changed line 70 from:
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#param_dlg_sharing_tag|lg_sharing_tag]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#param_sharing_tag|sharing_tag]] - note that the syntax is slightly different, refer to docs.
to:
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#param_dlg_sharing_tag|dlg_sharing_tag]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#param_sharing_tag|sharing_tag]] - note that the syntax is slightly different, refer to docs.
Changed line 72 from:
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#mi_dlg_list_shtags|dlg_list_shtags]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_list_shtags|mi_clusterer_list_shtags]]
to:
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#mi_dlg_list_sharing_tags|dlg_list_sharing_tags]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_list_shtags|mi_clusterer_list_shtags]]
January 05, 2019, at 06:56 PM by 109.99.227.30 -
Deleted lines 65-74:
!!!! TLS_MGM module

* the '''address''' column from the ''tls_mgm'' table was removed and the TLS domain matching is now driven by two new columns: '''match_ip_address''' and '''match_sip_domain'''

* the syntax for the '''server_domain''' and '''client_domain''' parameters now only accepts the TLS domain name

* the '''client_domain_avp''' module parameter was renamed to '''client_tls_domain_avp'''


Deleted line 66:
Added lines 69-73:
!!!! DIALOG module
* the functionality of the old module parameter [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#param_dlg_sharing_tag|lg_sharing_tag]] is now provided via the clusterer module parameter [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#param_sharing_tag|sharing_tag]] - note that the syntax is slightly different, refer to docs.
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#mi_dlg_set_sharing_tag_active|dlg_set_sharing_tag_active]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_shtag_set_active|mi_clusterer_shtag_set_active]]
* the functionality of the old MI function [[http://www.opensips.org/html/docs/modules/2.4.x/dialog.html#mi_dlg_list_shtags|dlg_list_shtags]] is now provided via the clusterer module MI function [[http://www.opensips.org/html/docs/modules/3.0.x/clusterer.html#mi_clusterer_list_shtags|mi_clusterer_list_shtags]]
Deleted line 74:
Added lines 78-82:

!!!! TLS_MGM module
* the '''address''' column from the ''tls_mgm'' table was removed and the TLS domain matching is now driven by two new columns: '''match_ip_address''' and '''match_sip_domain'''
* the syntax for the '''server_domain''' and '''client_domain''' parameters now only accepts the TLS domain name
* the '''client_domain_avp''' module parameter was renamed to '''client_tls_domain_avp'''
October 30, 2018, at 12:34 PM by 109.99.227.30 -
Changed lines 109-110 from:
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_exist|aaa_does_uri_exist()]] was moved to the URI module under the same name and behavior.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_user_exist|aaa_does_uri_user_exist()]] was moved to the URI module under the same name and behavior.
to:
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_exist|aaa_does_uri_exist()]] was moved to the AUTH_AAA module under the same name and behavior.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_user_exist|aaa_does_uri_user_exist()]] was moved to the AUTH_AAA module under the same name and behavior.
October 30, 2018, at 12:34 PM by 109.99.227.30 -
Changed lines 61-64 from:
!!!! DIALOG

!!!! TLS_MGM
to:
!!!! AUTH_AAA module

* the [[http://www.opensips.org/html/docs/modules/2.4.x/auth_aaa.html#param_service_type|service_type]] module parameter was renamed as [[http://www.opensips.org/html/docs/modules/3.0.x/auth_aaa.html#param_auth_service_type|auth_service_type]] with the same meaning and values.


!!!! TLS_MGM module
Changed lines 74-75 from:
!!!! DB_MYSQL
to:


!!!! DB_MYSQL module
Changed lines 80-81 from:
!!!! REST_CLIENT
to:
!!!! REST_CLIENT module
Added lines 85-86:

Changed lines 108-110 from:
to:
* the [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#param_service_type|service_type]] module parameter was moved to URI module as [[http://www.opensips.org/html/docs/modules/3.0.x/auth_aaa.html#param_check_service_type|check_service_type]] with the same meaning and values.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_exist|aaa_does_uri_exist()]] was moved to the URI module under the same name and behavior.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_aaa_does_uri_user_exist|aaa_does_uri_user_exist()]] was moved to the URI module under the same name and behavior.
October 27, 2018, at 05:17 PM by liviu -
Changed line 78 from:
* extended return codes for [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_get|rest_get()]], [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_post|rest_post()]] and [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_put|rest_put()]]
to:
* extensive return codes for [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_get|rest_get()]], [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_post|rest_post()]] and [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_put|rest_put()]]
October 27, 2018, at 05:15 PM by liviu -
Added line 78:
* extended return codes for [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_get|rest_get()]], [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_post|rest_post()]] and [[https://opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_put|rest_put()]]
October 03, 2018, at 05:07 PM by 109.99.227.30 -
Changed line 94 from:
** if '''use_uri_table''' was not set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_does_uri_exist|db_does_uri_exist("$ru","uri")]]
to:
** if '''use_uri_table''' was not set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_does_uri_exist|db_does_uri_exist("$ru","subscriber")]]
October 03, 2018, at 05:06 PM by 109.99.227.30 -
Changed lines 88-89 from:
** if '''use_uri_table'' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_to_authorized|db_is_to_authorized("uri")]]
** if '''use_uri_table'' was not set, imply replace it with the [@ $au==$tU @] script test.
to:
** if '''use_uri_table''' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_to_authorized|db_is_to_authorized("uri")]]
** if '''use_uri_table''' was not set, imply replace it with the [@ $au==$tU @] script test.
Changed lines 91-92 from:
** if '''use_uri_table'' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_from_authorized|db_is_from_authorized("uri")]]
** if '''use_uri_table'' was not set, simply replace it with the [@ $au==$fU @] script test.
to:
** if '''use_uri_table''' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_from_authorized|db_is_from_authorized("uri")]]
** if '''use_uri_table''' was not set, simply replace it with the [@ $au==$fU @] script test.
Changed lines 94-97 from:
** if '''use_uri_table'' was not set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_does_uri_exist|db_does_uri_exist("$ru","uri")]]
** if '''use_uri_table'' was set (very unlikely setup), you can still achieve it by use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri","$ru","$avp(auser)","$avp(arealm)")]]
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_get_auth_id|db_get_auth_id()]] was moved in AUTH_DB module under the same name but an extra first parameter being "uri" [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri",....)]].
to:
** if '''use_uri_table''' was not set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_does_uri_exist|db_does_uri_exist("$ru","uri")]]
** if '''use_uri_table''' was set (very unlikely setup), you can still achieve it by use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri","$ru","$avp(auser)","$avp(arealm)")]]
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_get_auth_id|db_get_auth_id()]] was moved in AUTH_DB module under the same name but an extra first parameter set to "uri" value, like [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri",....)]].
* the parameter [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#param_user_column|user_column]] was moved in AUTH_DB module under the [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#param_uri_user_column|uri_user_column]] name.
* the parameter [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#param_domain_column|domain_column]] was moved in AUTH_DB module under the [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#param_uri_domain_column|uri_domain_column]] name.
* the parameter [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#param_uriuser_column|uriuser_column]] was moved in AUTH_DB module under the [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#param_uri_uriuser_column|uri_uriuser_column]] name.
October 03, 2018, at 05:02 PM by 109.99.227.30 -
Added lines 87-100:
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_check_to|db_check_to()]] was replaced by the AUTH_DB module with:
** if '''use_uri_table'' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_to_authorized|db_is_to_authorized("uri")]]
** if '''use_uri_table'' was not set, imply replace it with the [@ $au==$tU @] script test.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_check_from|db_check_from()]] was replaced by the AUTH_DB module with:
** if '''use_uri_table'' was set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_is_from_authorized|db_is_from_authorized("uri")]]
** if '''use_uri_table'' was not set, simply replace it with the [@ $au==$fU @] script test.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_does_uri_exist|db_does_uri_exist()]] was replaced by the AUTH_DB module with:
** if '''use_uri_table'' was not set, use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_does_uri_exist|db_does_uri_exist("$ru","uri")]]
** if '''use_uri_table'' was set (very unlikely setup), you can still achieve it by use [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri","$ru","$avp(auser)","$avp(arealm)")]]
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_db_get_auth_id|db_get_auth_id()]] was moved in AUTH_DB module under the same name but an extra first parameter being "uri" [[http://www.opensips.org/html/docs/modules/3.0.x/auth_db.html#func_db_get_auth_id|db_get_auth_id("uri",....)]].



October 03, 2018, at 02:51 PM by 109.99.227.30 -
Changed lines 77-86 from:
* The parameter of the '''[[http://www.opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_init_client_tls|rest_init_client_tls]]''' function now only takes the TLS domain name.
to:
* The parameter of the '''[[http://www.opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_init_client_tls|rest_init_client_tls]]''' function now only takes the TLS domain name.

!!!! URI module
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_has_totag|has_totag()]] was moved in SIPMSGOPS module under the same name.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_is_user|is_user()]] was removed, it can simply be replaced with the script test [@ $au==$var(my_username) @].
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_uri_param|uri_param()]] was moved in SIPMSGOPS module under the [[http://www.opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_ruri_has_param|ruri_has_param()]] name.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_add_uri_param|add_uri_param()]] was moved in SIPMSGOPS module under the [[http://www.opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_ruri_add_param|ruri_add_param()]] name.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_del_uri_param|del_uri_param()]] was moved in SIPMSGOPS module under the [[http://www.opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_ruri_del_param|ruri_del_param()]] name.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_tel2sip|tel2sip()]] was moved in SIPMSGOPS module under the [[http://www.opensips.org/html/docs/modules/3.0.x/sipmsgops.html#func_ruri_tel2sip|ruri_tel2sip()]] name.
* function [[http://www.opensips.org/html/docs/modules/2.4.x/uri.html#func_is_uri_user_e164|is_uri_user_e164()]] was moved in SIPMSGOPS module under the same name.
July 24, 2018, at 03:23 PM by rvlad_patrascu -
Changed lines 69-77 from:
* the '''client_domain_avp''' module parameter was renamed to '''client_tls_domain_avp'''
to:
* the '''client_domain_avp''' module parameter was renamed to '''client_tls_domain_avp'''

!!!! DB_MYSQL

* the '''tls_client_domain''' module parameter was removed in favor of a new way of enabling TLS for specific MySQL connections via the DB URL.

!!!! REST_CLIENT

* The parameter of the '''[[http://www.opensips.org/html/docs/modules/3.0.x/rest_client.html#func_rest_init_client_tls|rest_init_client_tls]]''' function now only takes the TLS domain name.
July 24, 2018, at 01:17 PM by rvlad_patrascu -
Changed line 1 from:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 2.3.x to 3.0.0
to:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 2.4.x to 3.0.0
Changed line 6 from:
This section is meant to provide useful help in migrating your OpenSIPS installations from the '''2.3.0''' version to '''3.0.0'''.
to:
This section is meant to provide useful help in migrating your OpenSIPS installations from the '''2.4.0''' version to '''3.0.0'''.
July 24, 2018, at 01:16 PM by rvlad_patrascu -
Changed lines 63-69 from:
* example
to:
!!!! TLS_MGM

* the '''address''' column from the ''tls_mgm'' table was removed and the TLS domain matching is now driven by two new columns: '''match_ip_address''' and '''match_sip_domain'''

* the syntax for the '''server_domain''' and '''client_domain''' parameters now only accepts the TLS domain name

* the '''client_domain_avp''' module parameter was renamed to '''client_tls_domain_avp'''
June 07, 2018, at 11:44 AM by liviu -
Added lines 1-63:
!!!!!Documentation -> [[Documentation.Migration|Migration]] -> Migration from 2.3.x to 3.0.0
This page has been visited {$PageCount} times.
(:toc-float Table of Contents:)
----

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

You can find the all the new additions in the '''3.0.0''' release compiled [[ About.Version-3-0-0| under this page]]. The ChangeLog may help your understanding of the migration / update process.

%red% 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 2.4.x MySQL DB to the 3.0.x format by using the '''opensipsdbctl''' tool :
[@
# opensipsdbctl migrate opensips_2_4 opensips_3_0
@]
where :
* opensips_2_4 is the existing DB name corresponding to version 2.4.x format
* opensips_3_0 is the DB name to be created for 3.0.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


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

%red% 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

!!!! CACHEDB_REDIS

* example

!!!! DIALOG

* example

Page last modified on May 04, 2021, at 11:48 AM