|
Documentation |
Documentation -> Manuals -> Manual 3.4 -> Core MI FunctionsPages for other versions: devel 3.5 3.4 Older versions: 3.3 3.2 3.1 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4
Table of Content (hide)
MI (management interface) functions which are exported by OpenSIPS core. 1. arg 🔗Returns 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:
# opensips-cli -x mi arg
[
"./opensips",
"-f",
"/etc/openser/test.cfg"
]
2. kill 🔗The command will terminate OpenSIPS (and internal shutdown). Examples of usage:
# opensips-cli -x mi kill
3. list_blacklists 🔗The command lists all the defined (static or learned) blacklists from OpenSIPS.
Output: an array with each object describing the list (name, owner, flags); the "Rules" item is an array with each object member describing the rules (blacklists) for each list (IP/mask, protocol, port, matching regexp, flags). Examples of usage:
# opensips-cli -x mi list_blacklists
4. check_blacklists 🔗The command returns all the blacklists that match an proto:IP:port+pattern.
Output: an array with the names of each blacklist that matched. Examples of usage:
# opensips-cli -x mi check_blacklists 127.0.0.1
# opensips-cli -x mi check_blacklists udp 127.0.0.1 5060
5. check_blacklist 🔗The command check whether a proto:IP:port+pattern matches any rule of a blacklist.
Output: an object containing the first rule that matched, or an error if nothing matched. Examples of usage:
# opensips-cli -x mi check_blacklist net_dynamic 127.0.0.1
# opensips-cli -x mi check_blacklists net_dynamic udp 127.0.0.1 5060
6. add_blacklist_rule 🔗Adds a rule to a non-readonly blacklist.
Output: success or failed object. Examples of usage:
# opensips-cli -x mi add_blacklist_rule net_dynamic '!tcp,127.0.0.1,5060'
# opensips-cli -x mi add_blacklist_rule net_dynamic '!tcp,127.0.0.1,5060' 3600
7. del_blacklist_rule 🔗Removes a rule from a non-readonly blacklist.
Output: success or failed object. Examples of usage:
# opensips-cli -x mi del_blacklist_rule net_dynamic '!tcp,127.0.0.1,5060'
8. list_tcp_conns 🔗The command lists all ongoing TCP/TLS connection from OpenSIPS. Examples of usage:
# opensips-cli -x mi list_tcp_conns
9. log_level 🔗 [level] [pid]Get or set the logging level of one or all OpenSIPS processes. If no argument is passed to the log_level command, it will print a table with the current logging levels of all processes. If a logging level is given, it will be set for each process. If pid is also given, the logging level will change only for that process.
Examples of usage:
# opensips-cli -x mi log_level
{
"Processes": [
{
"PID": 10670,
"Log level": 2,
"Type": "attendant"
},
{
"PID": 10672,
"Log level": 3,
"Type": "MI FIFO"
},
{
"PID": 10673,
"Log level": 1,
"Type": "SIP receiver udp:193.468.3.433:5060"
},
]
}
# opensipsctl fifo log_level 1
{
"New global log level": 1
}
# opensipsctl fifo log_level 4 10670
{
"Log level": 1
}
10. log_level_filter 🔗 consumer [level_filter]Get or set the level of the extra filtering applied to log messages for a specific logging "consumer"(stderror, syslog or event). If log_level_filter is not given, the command will print the current level filter for the specified consumer. Arguments:
Examples of usage:
# opensips-cli -x mi log_level_filter stderror
{
"Log level filter": 3
}
# opensips-cli -x mi log_level_filter stderror 1
"OK"
11. log_mute_state 🔗 consumer [mute_state]Get or set the mute state (printing enabled/disabled) of a specific logging "consumer"(stderror, syslog or event). If mute_state is not given, the command will print the current mute state for the specified consumer. Arguments:
Examples of usage:
# opensips-cli -x mi log_mute_state syslog
{
"mmute state": 0
}
# opensips-cli -x mi log_mute_state syslog 1
"OK"
12. ps 🔗The command will list all all OpenSIPS processes, along with type and description. Examples of usage:
# opensips-cli -x mi ps
{
"Processes": [
{
"ID": 0,
"PID": 27271,
"Type": "attendant"
},
{
"ID": 1,
"PID": 27272,
"Type": "MI FIFO"
},
{
"ID": 2,
"PID": 27273,
"Type": "time_keeper"
},
{
"ID": 3,
"PID": 27274,
"Type": "timer"
},
{
"ID": 4,
"PID": 27275,
"Type": "SIP receiver udp:127.0.0.1:5060"
},
{
"ID": 5,
"PID": 27276,
"Type": "Timer handler"
}
]
}
13. pwd 🔗Prints the working directory of OpenSIPS instance. Examples of usage:
# opensips-cli -x mi pwd
{
"WD": "/"
}
14. reload_routes 🔗Triggers the reload of the routing block (the routes) from the script during the runtime.
Arguments: none Please note that there are some limitations of when a reload is possible or not. Depending on the initial configuration of your modules, the reload may be rejected as the usage of the functions in the new script is not compatible with the original module setting and initialization. 15. sr_get_status 🔗The MI equivalent of the sr_check_status() script function - to get the status of an 'status/report' identifier/group. Arguments: a mandatory group and optional identifier, see the parameters of the sr_check_status() script function. Output: the readiness, the status and details of the identifier/group (see the aggregation note for the return code of the sr_check_status() script function Examples of usage:
# opensips-cli -x mi sr_get_status core
{
"Readiness": true,
"Status": 1,
"Details": "running"
}
# opensips-cli -x mi sr_get_status drouting all
{
"Readiness": true,
"Status": 1,
"Details": "aggregated"
}
16. sr_list_status 🔗Command to list the status of the identifiers within one or all 'status/report' groups. Arguments: an optional 'status/report' group, see the sr_check_status() script function for more details. Output: the readiness, the status and details for all the identifiers within the requested group, or within all defined/registered groups. Examples of usage:
#opensips-cli -x mi sr_list_status
[
{
"Name": "drouting",
"Identifiers": [
{
"Name": "Default",
"Readiness": true,
"Status": 1,
"Details": "data available"
}
]
},
{
"Name": "test",
"Identifiers": [
{
"Name": "main",
"Readiness": true,
"Status": 1
}
]
},
{
"Name": "core",
"Identifiers": [
{
"Name": "main",
"Readiness": true,
"Status": 1,
"Details": "running"
}
]
}
]
17. sr_list_reports 🔗Command to list the full set of reports (logs) collected by 'status/report' identifiers. Arguments:
Output: the reports/logs for the requested identifiers, or for all identifiers within the groups. Examples of usage:
#bin/opensips-cli -x mi sr_list_reports
[
{
"Name": "drouting",
"Identifiers": [
{
"Name": "Default",
"Reports": [
{
"Timestamp": 1644396830,
"Date": "Wed Feb 9 10:53:50 2022",
"Log": "starting DB data loading"
},
{
"Timestamp": 1644396830,
"Date": "Wed Feb 9 10:53:50 2022",
"Log": "DB data loading successfully completed"
},
{
"Timestamp": 1644396830,
"Date": "Wed Feb 9 10:53:50 2022",
"Log": "2 gateways loaded (0 discarded), 2 carriers loaded (0 discarded), 1 rules loaded (0 discarded)"
}
]
}
]
},
{
"Name": "test",
"Identifiers": [
{
"Name": "main",
"Reports": []
}
]
},
{
"Name": "core",
"Identifiers": [
{
"Name": "main",
"Reports": [
{
"Timestamp": 1644396830,
"Date": "Wed Feb 9 10:53:50 2022",
"Log": "initializing"
},
{
"Timestamp": 1644396830,
"Date": "Wed Feb 9 10:53:50 2022",
"Log": "initialization completed, ready now"
}
]
}
]
}
]
18. sr_list_identifiers 🔗Command to list all the existing identifiers in OpenSIPS or only from a certain group. Arguments:
Output: an array of groups, each group being an array of identifiers . Examples of usage:
#opensips-cli -x mi sr_list_identifiers
[
{
"Group": "clusterer",
"Identifiers": [
"sharing_tags"
]
},
{
"Group": "dispatcher",
"Identifiers": [
"default;events",
"default"
]
},
{
"Group": "drouting",
"Identifiers": [
"Default;events",
"Default"
]
},
{
"Group": "dialplan",
"Identifiers": [
"default"
]
},
{
"Group": "core",
"Identifiers": [
"main"
]
}
]
#opensips-cli -x mi sr_list_identifiers drouting
{
"Group": "drouting",
"Identifiers": [
"Default;events",
"Default"
]
}
19. uptime 🔗Prints various time information about OpenSIPS - when it started to run, for how long it runs. Examples of usage:
# opensips-cli -x mi uptime
{
"Now": "Mon Jul 21 17:41:03 2008",
"Up since": "Mon Jul 21 17:36:33 2008",
"Up time": "270 [sec]"
}
20. version 🔗Prints the version string of a runningOpenSIPS. Examples of usage:
# opensips-cli -x mi version
{
"Server": "OpenSIPS (3.4.0-dev (x86_64/linux))"
}
21. which 🔗Prints all available MI commands from the queried OpenSIPSinstance. Examples of usage:
# opensips-cli -x mi which
[
"get_statistics",
"list_statistics",
"reset_statistics",
"uptime",
"version",
"pwd",
"arg",
"which",
"ps",
"kill",
"log_level",
"xlog_level",
"shm_check",
"cache_store",
"cache_fetch",
"cache_remove",
"event_subscribe",
"events_list",
...
22. get_statistics 🔗Prints the statistics (all, group or one) realtime values.
Output: an object containing the names and values of statistic variables. Examples of usage:
# opensips-cli -x mi get_statistics rcv_requests
{
"core:rcv_requests": 35243
}
# opensipsc-cli -x mi get_statistics shmem:
{
"shmem:total_size": 1073741824,
"shmem:max_used_size": 3389232,
"shmem:free_size": 1070352592,
"shmem:used_size": 2808952,
"shmem:real_used_size": 3389232,
"shmem:fragments": 3769
}
# opensips-cli -x mi get_statistics shmem: core:
....
23. list_statistics 🔗Prints a list of available statistics in the current configuration of OpenSIPS. Arguments:
Examples of usage:
# opensips-cli -x mi list_statistics
{
"shmem:total_size": "non-incremental",
"shmem:max_used_size": "non-incremental",
"shmem:free_size": "non-incremental",
"shmem:used_size": "non-incremental",
"shmem:real_used_size": "non-incremental",
"shmem:fragments": "non-incremental",
"rpmem:rpm_total_size": "non-incremental",
"rpmem:rpm_used_size": "non-incremental",
...
24. 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").
Output: none. Examples of usage:
# opensips-cli -x mi get_statistics received_replies
{
"tm:received_replies": 14543
}
# opensips-cli -x mi reset_statistics received_replies
# opensips-cli -x mi get_statistics received_replies
{
"tm:received_replies": 0
}
25. reset_all_statistics 🔗Reset (to zero) the value of all statistic variables that can be reset. Note that not all variables allow reset (depending of the nature of the information they carry - example "shmem:used_size"). Examples of usage:
# opensips-cli -x mi reset_all_statistics
26. cache_store 🔗This command stores in a cache system a string value.
Output: none.
# opensips-cli -x mi cache_store local password_user1 password
27. cache_fetch 🔗This command queries for a stored value.
Output: object containing the value if a record is found or 'Value not found' string otherwise.
# opensips-cli -x mi cache_fetch local password_user1
28. cache_remove 🔗This command removes a record from the cache system.
Output: None.
# opensips-cli -x mi cache_remove local password_user1
29. event_subscribe 🔗Subscribes an external application to a certain event.
Output: None.
# opensips-cli -x mi event_subscribe E_PIKE_BLOCKED udp:127.0.0.1:8888 1200
30. events_list 🔗Lists all the events published through the Event Interface.
# opensips-cli -x mi events_list
{
"Events": [
{
"name": "E_CORE_THRESHOLD",
"id": 0
},
{
"name": "E_CORE_SHM_THRESHOLD",
"id": 1
},
{
"name": "E_CORE_PKG_THRESHOLD",
"id": 2
},
...
31. raise_event 🔗Raises an event through the Event Interface using an MI command.
Output: None.
# opensips-cli -x mi raise_event E_PIKE_BLOCKED 127.0.0.1 # array mode
# opensips-cli -x -- mi -j raise_event event=E_PIKE_BLOCKED params='{"ip":"127.0.0.1"}' # json mode
32. subscribers_list 🔗Lists information about the subscribers
Output: If no parameter is specified, then the command returns information about all events and their subscribers. If the event is specified, only the external applications subscribed for that event are returned. If the socket is also specified, only one subscriber information is returned.
# opensips-cli -x mi subscribers_list
{
"Events": [{
"name": "E_RTPPROXY_STATUS",
"id": 1,
"subscribers": [
...
]
},
{
"name": "E_PIKE_BLOCKED",
"id": 2,
"subscribers": [
...
]
}
]
}
# opensips-cli -x mi subscribers_list E_RTPPROXY_STATUS
{
"Event": {
"name": "E_RTPPROXY_STATUS",
"id": 1,
"subscribers": [{
"socket": "unix:/tmp/event.sock",
"expire": "never",
},
{
"socket": "udp:127.0.0.1:8888",
"expire": 1100,
"ttl": 1046
}
]
}
}
# opensips-cli -x mi subscribers_list E_RTPPROXY_STATUS unix:/tmp/event.sock
{
"Event": {
"name": "E_RTPPROXY_STATUS",
"id": 1,
"Subscriber": {
"socket": "unix:/tmp/event.sock",
"expire": "never"
}
}
}
33. mem_pkg_dump 🔗Triggers a pkg memory dump for a given process. The memory dump will written to OpenSIPS's log (syslog or stderr) using the 'memdump' logging level. The global 'memdump' log level may be overwritten by a custom value provided as argument to this command.
Output: None.
# opensips-cli -x mi mem_pkg_dump 11854 -1
The processes without IPC support (like timer and per-module processes) will not be able to generate a memory dump. 34. mem_shm_dump 🔗Triggers a shm memory dump. The memory dump will written to OpenSIPS's log (syslog or stderr) using the 'memdump' logging level. The global 'memdump' log level may be overwritten by a custom value provided as argument to this command.
Output: None.
# opensips-cli -x mi mem_shm_dump -1
35. shm_check 🔗Only available with QM_MALLOC + DBG_MALLOC. Fully scans the shared memory pool in order to locate any inconsistencies. If any sign of memory corruption is detected, OpenSIPS will immediately abort.
# opensips-cli -x mi shm_check
36. xlog_level [level] 🔗Get or set the global xlogging level in OpenSIPS processes. If no argument is passed to the xlog_level command, it will print the current xlog_level. If a logging level is given, it will be globally set for all OpenSIPS processes.
Example of usage:
# opensips-cli -x mi xlog_level -2
|