Resources.DocsCoreMi16 HistoryHide minor edits - Show changes to markup April 24, 2013, at 10:17 PM
by
- Changed lines 1-241 from:
Resources -> Documentation -> CookBooks -> Core MI Functions v1.6(:toc-float Table of Content:) MI (management interface) functions which are exported by OpenSIPS core. This document is for OpenSIPS 1.6.x argReturns the full list of arguments used when OpenSIPS was started. As in UNIX, the first argument is the name of executable binary. Example of usage: # opensipsctl fifo arg ./opensips -f /etc/openser/test.cfg debug [level]Gets or sets the value of the debug core variable. You may use it to dynamically (at runtime) change or inspect the debug level of your OpenSIPS. If no argument is passed, the function will fetch the value of the debug level. Examples of usage: # opensipsctl fifo debug DEBUG:: 4 # opensipsctl fifo debug 1 killThe command will terminate OpenSIPS (and internal shutdown). Examples of usage: # opensipsctl fifo kill list_blacklistsThe command lists all the defined (static or learned) blacklists from OpenSIPS. Examples of usage: # opensipsctl fifo list_blacklists psThe command will list all all OpenSIPS processes, along with type and description. Examples of usage: # opensipsctl fifo ps Process:: ID=0 PID=16224 Type=attendant Process:: ID=1 PID=16225 Type=SIP receiver udp:192.168.1.2:5060 Process:: ID=2 PID=16226 Type=timer Process:: ID=3 PID=16227 Type=MI FIFO Process:: ID=4 PID=16228 Type=TCP receiver Process:: ID=5 PID=16230 Type=TCP main pwdPrints the working directory of OpenSIPS instance. Examples of usage: # opensipsctl fifo pwd WD:: / uptimePrints various time information about OpenSIPS - when it started to run, for how long it runs. Examples of usage: # opensipsctl fifo uptime Now:: Mon Jul 21 17:41:03 2008 Up since:: Mon Jul 21 17:36:33 2008 Up time:: 270 [sec] versionPrints the version string of a runningOpenSIPS. Examples of usage: # opensipsctl fifo version Server:: OpenSIPS (1.4.0dev14-notls (i386/linux)) whichPrints all available MI commands from the queried OpenSIPSinstance. Examples of usage: # opensipsctl fifo which get_statistics reset_statistics uptime version pwd arg which ps kill debug list_blacklists ul_rm ul_rm_contact ul_dump ul_flush ul_add ul_show_contact nh_enable_ping nh_enable_rtpp get_statisticsPrints the statistics (all, group or one) realtime values. Examples of usage: # opensipsctl fifo get_statistics rcv_requests core:rcv_requests = 35243 # opensipsctl fifo get_statistics shmem: shmem:total_size = 33554432 shmem:used_size = 1686952 shmem:real_used_size = 1704592 shmem:max_used_size = 1704592 shmem:free_size = 31849840 shmem:fragments = 1 # opensipsctl fifo get_statistics all .... reset_statisticsReset (to zero) the value of a statistic variable. Note that not all variables allow reset (depending of the nature of the information they carry - example "shmem:used_size"). Examples of usage: # opensipsctl fifo get_statistics received_replies core:received_replies = 14543 # opensipsctl fifo reset_statistics received_replies # opensipsctl fifo get_statistics received_replies core:received_replies = 0 cache_storeThis command stores in a cache system a string value. # opensipsctl fifo cache_store local password_user1 password cache_fetchThis command queries for a stored value. # opensipsctl fifo cache_fetch local password_user1 cache_removeThis command removes a record from the cache system. # opensipsctl fifo cache_remove local password_user1 CommentsManas? — 09 November 2010, 18:49VIKI? — 14 September 2012, 12:01(:commentboxchrono:) to:
(:redirect Documentation/Interface-CoreMI-1-6 quiet=1:) September 25, 2012, at 11:23 AM
by
- Changed line 238 from:
Waiting for replies.... to:
[By Bogdan] You need to load the "nathelper" module in your OpenSIPS September 14, 2012, at 01:01 PM
by
- Comment addedAdded lines 229-239:
September 18, 2011, at 08:30 PM
by
- Deleted lines 228-233:
September 17, 2011, at 07:31 AM
by
- Comment addedAdded lines 229-234:
May 11, 2011, at 10:20 AM
by
- Deleted lines 228-232:
May 10, 2011, at 08:07 AM
by
- Comment addedAdded lines 227-232:
November 10, 2010, at 09:52 AM
by
- Changed line 225 from:
Bogdan: thank you, docs fixed. to:
[By Bogdan] Thank you Manas, I made the fix in the docs November 10, 2010, at 09:49 AM
by
- Changed line 186 from:
# opensipsctl fifo cache_store localcache password_user1 password to:
# opensipsctl fifo cache_store local password_user1 password Changed line 198 from:
# opensipsctl fifo cache_fetch localcache password_user1 to:
# opensipsctl fifo cache_fetch local password_user1 Changed line 209 from:
# opensipsctl fifo cache_remove localcache password_user1 to:
# opensipsctl fifo cache_remove local password_user1 Changed lines 214-215 from:
to:
CommentsAdded lines 224-225:
Bogdan: thank you, docs fixed. November 09, 2010, at 07:49 PM
by
- Comment addedAdded lines 215-225:
October 06, 2010, at 01:02 PM
by
- Changed line 186 from:
# opensipsctl fifo cache_store password_user1 password to:
# opensipsctl fifo cache_store localcache password_user1 password Changed line 198 from:
# opensipsctl fifo cache_fetch password_user1 to:
# opensipsctl fifo cache_fetch localcache password_user1 Changed line 209 from:
# opensipsctl fifo cache_remove password_user1 to:
# opensipsctl fifo cache_remove localcache password_user1 October 14, 2009, at 12:36 AM
by
- Added lines 1-216:
Resources -> Documentation -> CookBooks -> Core MI Functions v1.6(:toc-float Table of Content:) MI (management interface) functions which are exported by OpenSIPS core. This document is for OpenSIPS 1.6.x argReturns the full list of arguments used when OpenSIPS was started. As in UNIX, the first argument is the name of executable binary. Example of usage: # opensipsctl fifo arg ./opensips -f /etc/openser/test.cfg debug [level]Gets or sets the value of the debug core variable. You may use it to dynamically (at runtime) change or inspect the debug level of your OpenSIPS. If no argument is passed, the function will fetch the value of the debug level. Examples of usage: # opensipsctl fifo debug DEBUG:: 4 # opensipsctl fifo debug 1 killThe command will terminate OpenSIPS (and internal shutdown). Examples of usage: # opensipsctl fifo kill list_blacklistsThe command lists all the defined (static or learned) blacklists from OpenSIPS. Examples of usage: # opensipsctl fifo list_blacklists psThe command will list all all OpenSIPS processes, along with type and description. Examples of usage: # opensipsctl fifo ps Process:: ID=0 PID=16224 Type=attendant Process:: ID=1 PID=16225 Type=SIP receiver udp:192.168.1.2:5060 Process:: ID=2 PID=16226 Type=timer Process:: ID=3 PID=16227 Type=MI FIFO Process:: ID=4 PID=16228 Type=TCP receiver Process:: ID=5 PID=16230 Type=TCP main pwdPrints the working directory of OpenSIPS instance. Examples of usage: # opensipsctl fifo pwd WD:: / uptimePrints various time information about OpenSIPS - when it started to run, for how long it runs. Examples of usage: # opensipsctl fifo uptime Now:: Mon Jul 21 17:41:03 2008 Up since:: Mon Jul 21 17:36:33 2008 Up time:: 270 [sec] versionPrints the version string of a runningOpenSIPS. Examples of usage: # opensipsctl fifo version Server:: OpenSIPS (1.4.0dev14-notls (i386/linux)) whichPrints all available MI commands from the queried OpenSIPSinstance. Examples of usage: # opensipsctl fifo which get_statistics reset_statistics uptime version pwd arg which ps kill debug list_blacklists ul_rm ul_rm_contact ul_dump ul_flush ul_add ul_show_contact nh_enable_ping nh_enable_rtpp get_statisticsPrints the statistics (all, group or one) realtime values. Examples of usage: # opensipsctl fifo get_statistics rcv_requests core:rcv_requests = 35243 # opensipsctl fifo get_statistics shmem: shmem:total_size = 33554432 shmem:used_size = 1686952 shmem:real_used_size = 1704592 shmem:max_used_size = 1704592 shmem:free_size = 31849840 shmem:fragments = 1 # opensipsctl fifo get_statistics all .... reset_statisticsReset (to zero) the value of a statistic variable. Note that not all variables allow reset (depending of the nature of the information they carry - example "shmem:used_size"). Examples of usage: # opensipsctl fifo get_statistics received_replies core:received_replies = 14543 # opensipsctl fifo reset_statistics received_replies # opensipsctl fifo get_statistics received_replies core:received_replies = 0 cache_storeThis command stores in a cache system a string value. # opensipsctl fifo cache_store password_user1 password cache_fetchThis command queries for a stored value. # opensipsctl fifo cache_fetch password_user1 cache_removeThis command removes a record from the cache system. # opensipsctl fifo cache_remove password_user1 (:commentboxchrono:) |