Resources.DocsCoreMi14 HistoryHide minor edits - Show changes to output April 24, 2013, at 10:15 PM
by
- Changed lines 1-173 from:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core MI Functions v1.4 ---- (:toc-float Table of Content:) MI (management interface) functions which are exported by '''OpenSIPS''' core. This document is for '''OpenSIPS 1.4.x''' !!!!arg Returns the full list of arguments used when '''OpenSIPS''' was started. As in UNIX, the first argument is the name of executable binary.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes where each node contains an argument. The MI nodes have no name, but only value. 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.\\ '''Arguments''': debug level (-3...4)\\ '''Output''': debug level (only when no argument is passed). The value will be returned as a single MI node with name "DEBUG" Examples of usage: [@ # opensipsctl fifo debug DEBUG:: 4 # opensipsctl fifo debug 1 @] !!!!kill The command will terminate '''OpenSIPS''' (and internal shutdown).\\ '''Arguments''': none\\ '''Output''': none Examples of usage: [@ # opensipsctl fifo kill @] !!!!list_blacklists The command lists all the defined (static or learned) blacklists from '''OpenSIPS'''.\\ '''Arguments''': none\\ '''Output''': an MI tree - first level (nodes named "List") will describe the list (name, owner, flags); Second level (nodes named "Rules) will describe the rules (blacklists) for each list (IP/mask, protocol, port, matching regexp, flags) Examples of usage: [@ # opensipsctl fifo list_blacklists @] !!!!ps The command will list all all '''OpenSIPS''' processes, along with type and description.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes (named "Process") - each node contains process ID (internal), PID (OS), 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 @] !!!!pwd Prints the working directory of '''OpenSIPS''' instance.\\ '''Arguments''': none\\ '''Output''': a single MI node with name "WD" containing the working directory full path. Examples of usage: [@ # opensipsctl fifo pwd WD:: / @] !!!!uptime Prints various time information about '''OpenSIPS''' - when it started to run, for how long it runs.\\ '''Arguments''': none\\ '''Output''': three MI nodes: "Now" - current time; "Up since" - start time ; "Up time" - number of seconds since started. 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] @] !!!!version Prints the version string of a running'''OpenSIPS'''.\\ '''Arguments''': none\\ '''Output''': one MI node (named "Server") containing the version string. Examples of usage: [@ # opensipsctl fifo version Server:: OpenSIPS (1.4.0dev14-notls (i386/linux)) @] !!!!which Prints all available MI commands from the queried '''OpenSIPS'''instance.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes (no name), each node containing (as value) the name of an available MI command. NOTE that the list of available MI commands may differ depending of what modules your '''OpenSIPS''' is using. 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_statistics Prints the statistics (all, group or one) realtime values.\\ '''Arguments''': input may be "all" - print all available statistics; "group:" - print only statistics from a certain group; "name" - print only this statistic. The '''OpenSIPS''' core defines the following groups: ''core'', ''shmem''; Modules export groups typically named like the module itself.\\ '''Output''': list of MI nodes (no name) - each MI mode contains the name and value of a single statistic variable. 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_statistics Reset (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").\\ '''Arguments''': name of the variable to be reset.\\ '''Output''': none. 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 @] to:
(:redirect Documentation/Interface-CoreMI-1-4 quiet=1:) April 23, 2009, at 11:25 AM
by
- Added line 2:
---- January 30, 2009, at 06:52 PM
by
- Added lines 1-172:
!!Resources -> [[Resources.Documentation | Documentation]] -> [[Resources.DocsCookbooks | CookBooks]] -> Core MI Functions v1.4 (:toc-float Table of Content:) MI (management interface) functions which are exported by '''OpenSIPS''' core. This document is for '''OpenSIPS 1.4.x''' !!!!arg Returns the full list of arguments used when '''OpenSIPS''' was started. As in UNIX, the first argument is the name of executable binary.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes where each node contains an argument. The MI nodes have no name, but only value. 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.\\ '''Arguments''': debug level (-3...4)\\ '''Output''': debug level (only when no argument is passed). The value will be returned as a single MI node with name "DEBUG" Examples of usage: [@ # opensipsctl fifo debug DEBUG:: 4 # opensipsctl fifo debug 1 @] !!!!kill The command will terminate '''OpenSIPS''' (and internal shutdown).\\ '''Arguments''': none\\ '''Output''': none Examples of usage: [@ # opensipsctl fifo kill @] !!!!list_blacklists The command lists all the defined (static or learned) blacklists from '''OpenSIPS'''.\\ '''Arguments''': none\\ '''Output''': an MI tree - first level (nodes named "List") will describe the list (name, owner, flags); Second level (nodes named "Rules) will describe the rules (blacklists) for each list (IP/mask, protocol, port, matching regexp, flags) Examples of usage: [@ # opensipsctl fifo list_blacklists @] !!!!ps The command will list all all '''OpenSIPS''' processes, along with type and description.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes (named "Process") - each node contains process ID (internal), PID (OS), 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 @] !!!!pwd Prints the working directory of '''OpenSIPS''' instance.\\ '''Arguments''': none\\ '''Output''': a single MI node with name "WD" containing the working directory full path. Examples of usage: [@ # opensipsctl fifo pwd WD:: / @] !!!!uptime Prints various time information about '''OpenSIPS''' - when it started to run, for how long it runs.\\ '''Arguments''': none\\ '''Output''': three MI nodes: "Now" - current time; "Up since" - start time ; "Up time" - number of seconds since started. 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] @] !!!!version Prints the version string of a running'''OpenSIPS'''.\\ '''Arguments''': none\\ '''Output''': one MI node (named "Server") containing the version string. Examples of usage: [@ # opensipsctl fifo version Server:: OpenSIPS (1.4.0dev14-notls (i386/linux)) @] !!!!which Prints all available MI commands from the queried '''OpenSIPS'''instance.\\ '''Arguments''': none\\ '''Output''': multiple MI nodes (no name), each node containing (as value) the name of an available MI command. NOTE that the list of available MI commands may differ depending of what modules your '''OpenSIPS''' is using. 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_statistics Prints the statistics (all, group or one) realtime values.\\ '''Arguments''': input may be "all" - print all available statistics; "group:" - print only statistics from a certain group; "name" - print only this statistic. The '''OpenSIPS''' core defines the following groups: ''core'', ''shmem''; Modules export groups typically named like the module itself.\\ '''Output''': list of MI nodes (no name) - each MI mode contains the name and value of a single statistic variable. 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_statistics Reset (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").\\ '''Arguments''': name of the variable to be reset.\\ '''Output''': none. 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 @] |