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.

• consumer (optional) - logging consumer: stderror, syslog or event;

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.

• consumer (optional) - logging consumer: stderror, syslog or event;

@]

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 or syslog). If log_level_filter is not given, the command will print the current level filter for the specified consumer.

Arguments:

• consumer (optional) - logging consumer: stderror or syslog;
• log_level_filter (optional) - the log level filter.

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"

log_mute_state 🔗 consumer [mute_state]

Get or set the mute state (printing enabled/disabled) of a specific logging "consumer"(stderror or syslog). If mute_state is not given, the command will print the current mute state for the specified consumer.

Arguments:

• consumer (optional) - logging consumer: stderror or syslog;
• mute_state (optional) - the new mute state: 1 - muted or 0 - unmuted (enabled)

Examples of usage: [@

    # opensips-cli -x mi log_mute_state syslog
    {
        "mmute state": 0
    }
    # opensips-cli -x mi log_mute_state syslog 1
    "OK"

		  "expire": 1100,
		  "ttl": 1046

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").
Output: none.

Examples of usage:

    # opensips-cli -x mi reset_all_statistics

• params (optional) - array of elements, or a string consisting of a JSON object containing key-value pairs

    # 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

Arguments:

• name (optional) - filter and print only rules in a specific blacklist

check_blacklists 🔗

The command returns all the blacklists that match an proto:IP:port+pattern.
Arguments:

• proto (optional) - protocol of the check rule - if missing, "any" protocol is used. Note that an "any" protocol check can only match an "any" protocol rule.
• ip - the mandatory IP that is used to match the rules
• port (optional) - the port of the check rule - if missing, 0/any port is used. Note that a 0 port will only match a 0 port rule.
• pattern (optional) - optional pattern to check against the rules

Output: an array with the names of each blacklist that matched.

    # opensips-cli -x mi check_blacklists 127.0.0.1
    # opensips-cli -x mi check_blacklists udp 127.0.0.1 5060

check_blacklist 🔗

The command check whether a proto:IP:port+pattern matches any rule of a blacklist.\\

• name = the name of the blacklist to check against
• proto (optional) - protocol of the check rule - if missing, "any" protocol is used. Note that an "any" protocol check can only match an "any" protocol rule.
• ip - the mandatory IP that is used to match the rules
• port (optional) - the port of the check rule - if missing, 0/any port is used. Note that a 0 port will only match a 0 port rule.
• pattern (optional) - optional pattern to check against the rules

Output: an object containing the first rule that matched, or an error if nothing matched.

    # 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

add_blacklist_rule 🔗

Adds a rule to a non-readonly blacklist.
Arguments:

• name- the name of the blacklist to add to
• rule - a string containing a blacklist rule, according to dst_blacklist parameter
• expire (optional) - indicates the number of seconds the rule should expire

Output: success or failed object.

    # 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

del_blacklist_rule 🔗

Removes a rule from a non-readonly blacklist.
Arguments:

• name - the name of the blacklist to remove from
• rule - a string containing a blacklist rule, according to dst_blacklist parameter

Output: success or failed object.

    # opensips-cli -x mi del_blacklist_rule net_dynamic '!tcp,127.0.0.1,5060'

list_tcp_conns 🔗

The command lists all ongoing TCP/TLS connection from OpenSIPS.\\

Output: an array with one object per connection with the following attributes : ID, type, state, source, destination, lifetime, alias port.

    # opensips-cli -x mi list_tcp_conns

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.
Arguments:

• level (optional) - logging level (-3...4) (see meaning of the values)
• pid (optional) - Unix pid (validated by OpenSIPS)

    # 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.668.3.633:5060"
            },

    }
    # opensipsctl fifo log_level 1

        "New global log level": 1

    # opensipsctl fifo log_level 4 10670
    {
        "Log level": 1
    }

ps 🔗

The command will list all all OpenSIPS processes, along with type and description.
Arguments: none
Output: multiple objects, each one containing a process ID (internal), PID (OS) and Type.

    # 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"
        }
    ]

} @]

pwd 🔗

Prints the working directory of OpenSIPS instance.
Arguments: none
Output: a single item containing the working directory full path.

Examples of usage: [@

    # opensips-cli -x mi pwd

        "WD": "/"

reload_routes 🔗

Triggers the reload of the routing block (the routes) from the script during the runtime. Arguments: none
Output: 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.
If the reload fails, take a look at the logs to understand why - it may have been a syntax error or maybe a module related constraint. Anyhow, if the reload fails, there is no impact on your running OpenSIPS.

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

1. opensips-cli -x mi sr_get_status core

{

    "Readiness": true,
    "Status": 1,
    "Details": "running"

}

1. opensips-cli -x mi sr_get_status drouting all

{

    "Readiness": true,
    "Status": 1,
    "Details": "aggregated"

}

@]

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: [@

1. opensips-cli -x mi sr_list_status

        "Name": "drouting",

            {
                "Name": "Default",
                "Readiness": true,
                "Status": 1,
                "Details": "data available"
            }

        "Name": "test",

            {
                "Name": "main",
                "Readiness": true,
                "Status": 1
            }

        "Name": "core",

            {
                "Name": "main",
                "Readiness": true,
                "Status": 1,
                "Details": "running"
            }

sr_list_reports 🔗

Command to list the full set of reports (logs) collected by 'status/report' identifiers.

Arguments:

• an optional 'status/report' group, see the sr_check_status() script function for more details. If missing, all the groups will be listed.
• an optional 'identifier'. If missing, all the identifiers within the group will be listed.

Output: the reports/logs for the requested identifiers, or for all identifiers within the groups.

1. 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"
                    }
                ]
            }
        ]

]

sr_list_identifiers 🔗

Command to list all the existing identifiers in OpenSIPS or only from a certain group.

• an optional 'status/report' group, see the sr_check_status() script function for more details. If missing, the identifiers from all the groups will be listed.

Output: an array of groups, each group being an array of identifiers .

1. 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"
        ]
    }

]

1. opensips-cli -x mi sr_list_identifiers drouting

    "Group": "drouting",
    "Identifiers": [
        "Default;events",
        "Default"
    ]

}

uptime 🔗

Prints various time information about OpenSIPS - when it started to run, for how long it runs.
Arguments: none
Output: three items: "Now" - current time; "Up since" - start time ; "Up time" - number of seconds since started.

    # 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]"

}

version 🔗

Prints the version string of a runningOpenSIPS.
Arguments: none
Output: one item (named "Server") containing the version string.

    # opensips-cli -x mi version

{

    "Server": "OpenSIPS (3.6.0-dev (x86_64/linux))"

}

which 🔗

Prints all available MI commands from the queried OpenSIPSinstance.
Arguments: none
Output: an array of the names of available MI commands. NOTE that the list of available MI commands may differ depending of what modules your OpenSIPS is using.

    # 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",

...

get_statistics 🔗

Prints the statistics (all, group or one) realtime values.\\

• statistics - an array of the following possible values:
  • "all" - print all available statistics;
  • "group_name:" - print only statistics from a certain group named "group_name"; the OpenSIPS core defines the following groups: core, shmem; Modules export groups typically named like the module itself.
  • "name" - print only the statistic named "name".

Output: an object containing the names and values of statistic variables.

    # 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:
    ....

list_statistics 🔗

Prints a list of available statistics in the current configuration of OpenSIPS.

• statistics (optional) - an array of the same possible values as for get_statistics MI command, with the exception of "all". Omitting the parameter will list all available statistics.

    # 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",

...

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:

• statistics - an array of the names of the variables to be reset.

Output: none.

    # 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
   }

cache_store 🔗

This command stores in a cache system a string value.\\

• system - cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local';
• attr - the label to be associated with this value;
• value - the string to be stored;
• expire (optional) - expire time for the stored value;

Output: none.

    # opensips-cli -x mi cache_store local password_user1 password

cache_fetch 🔗

This command queries for a stored value.\\

• system - cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local'
• attr - the label associated with the 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

@]

cache_remove 🔗

This command removes a record from the cache system.
Arguments:

• system - cache system to use;
• attr - the label associated with the stored value;

Output: None.
Examples of usage:

    # opensips-cli -x mi cache_remove local password_user1

event_subscribe 🔗

Subscribes an external application to a certain event.
Arguments:

• event - event name
• socket - external application socket
• expire (optional) - expire time, in seconds - if absent, the subscription is valid only one hour (3600 s)

Output: None.
Examples of usage:

    # opensips-cli -x mi event_subscribe E_PIKE_BLOCKED udp:127.0.0.1:8888 1200

events_list 🔗

Lists all the events published through the Event Interface.
Arguments: None.
Output: None.
Examples of usage: [@

    # 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
        },

... @]

raise_event 🔗

Raises an event through the Event Interface using an MI command.
Arguments:

• event - event name
• params (optional) - array of elements, or a JSON object containing key-value pairs

Output: None.
Examples of usage:

    # opensips-cli -x mi raise_event E_PIKE_BLOCKED 127.0.0.1

subscribers_list 🔗

Lists information about the subscribers
Arguments:

• event - event name
• socket (optional) - external application socket

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.
Examples of usage: [@

    # opensips-cli -x mi subscribers_list

{

• log_level (optional) - a log level to be used for this dump

@]

sr_list_identifiers 🔗

Command to list all the existing identifiers in OpenSIPS or only from a certain group.

Arguments:

• an optional 'status/report' group, see the sr_check_status() script function for more details. If missing, the identifiers from all the groups will be listed.

Output: an array of groups, each group being an array of identifiers .

Examples of usage: [@

1. 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"
        ]
    }

]

1. opensips-cli -x mi sr_list_identifiers drouting

{

    "Group": "drouting",
    "Identifiers": [
        "Default;events",
        "Default"
    ]

}

arg 🔗

kill 🔗

list_blacklists 🔗

list_tcp_conns 🔗

log_level 🔗 [level] [pid]

ps 🔗

pwd 🔗

reload_routes 🔗

sr_get_status 🔗

sr_list_status 🔗

sr_list_reports 🔗

uptime 🔗

version 🔗

which 🔗

get_statistics 🔗

list_statistics 🔗

reset_statistics 🔗

cache_store 🔗

cache_fetch 🔗

cache_remove 🔗

event_subscribe 🔗

events_list 🔗

raise_event 🔗

subscribers_list 🔗

mem_pkg_dump 🔗

mem_shm_dump 🔗

shm_check 🔗

xlog_level [level] 🔗

• level (optional)

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"
}

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"
            }
        ]
    }
]

sr_list_reports

Command to list the full set of reports (logs) collected by 'status/report' identifiers.

Arguments:

• an optional 'status/report' group, see the sr_check_status() script function for more details. If missing, all the groups will be listed.
• an optional 'identifier'. If missing, all the identifiers within the group will be listed.

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"
                    }
                ]
            }
        ]
    }
]

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. \\

Arguments:

• system - cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local'
• attr - the label associated with the value

Output: object containing the value if a record is found or 'Value not found' string otherwise.

Arguments:

• system - cache system to use;
• attr - the label associated with the stored value;

Arguments:

• event - event name
• socket - external application socket
• expire (optional) - expire time, in seconds - if absent, the subscription is valid only one hour (3600 s)

{

    "Events": [
        {
            "name": "E_CORE_THRESHOLD",
            "id": 0
        },
        {
            "name": "E_CORE_SHM_THRESHOLD",
            "id": 1
        },
        {
            "name": "E_CORE_PKG_THRESHOLD",
            "id": 2
        },

...

Arguments:

• event - event name
• params (optional) - array of elements, or a JSON object containing key-value pairs

Arguments:

• event - event name
• socket (optional) - external application socket

{

  "Events": [{
	  "name": "E_RTPPROXY_STATUS",
	  "id": 1,
	  "subscribers": [
		...
	  ]
	},
	{
	  "name": "E_PIKE_BLOCKED",
	  "id": 2,
	  "subscribers": [
		...
	  ]
	}
  ]

}

{

  "Event": {
	"name": "E_RTPPROXY_STATUS",
	"id": 1,
	"subscribers": [{
		  "socket": "unix:/tmp/event.sock",
		  "expire": "never",
		},
		{
		  "socket": "udp:127.0.0.1:8888",
		  "expire": 1100
		}
	]
  } 

}

{

  "Event": {
	"name": "E_RTPPROXY_STATUS",
	"id": 1,
	"Subscriber": {
	  "socket": "unix:/tmp/event.sock",
	  "expire": "never"
	}
  } 

}

Arguments:

• pid - the PID of the process to perform the pkg dump
• log_level (optional) - a log level to be used for this dump

Arguments:

• log_level (otpional) - a log level to be used for this dump

Arguments:

• level (otpional)

Arguments: none
Output: an array with multiple strings representing the arguments.

    [
        "./opensips",
        "-f",
        "/etc/openser/test.cfg"
    ]

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).

Output: an array with one object per connection with the following attributes : ID, type, state, source, destination, lifetime, alias port.

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.\\

• level (optional) - logging level (-3...4) (see meaning of the values)
• pid (optional) - Unix pid (validated by OpenSIPS)

    {
        "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.668.3.633:5060"
            },
        ]
    }

    {
        "New global log level": 1
    }

    {
        "Log level": 1
    }

Output: multiple objects, each one containing a process ID (internal), PID (OS) and Type.

{

    "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"
        }
    ]

}

Output: a single item containing the working directory full path.

    {
        "WD": "/"
    }

Output: three items: "Now" - current time; "Up since" - start time ; "Up time" - number of seconds since started.

{

    "Now": "Mon Jul 21 17:41:03 2008",
    "Up since": "Mon Jul 21 17:36:33 2008",
    "Up time": "270 [sec]"

}

Output: one item (named "Server") containing the version string.

{

    "Server": "OpenSIPS (3.6.0-dev (x86_64/linux))"

}

Output: an array of the names of available MI commands. NOTE that the list of available MI commands may differ depending of what modules your OpenSIPS is using.

[

    "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",

...

Arguments:

• statistics - an array of the following possible values:
  • "all" - print all available statistics;
  • "group_name:" - print only statistics from a certain group named "group_name"; the OpenSIPS core defines the following groups: core, shmem; Modules export groups typically named like the module itself.
  • "name" - print only the statistic named "name".

Output: an object containing the names and values of statistic variables.

   {
       "core:rcv_requests": 35243
   }

    {
        "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:

Prints a list of available statistics in the current configuration of OpenSIPS. Arguments:

• statistics (optional) - an array of the same possible values as for get_statistics MI command, with the exception of "all". Omitting the parameter will list all available 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",

...

Arguments:

• statistics - an array of the names of the variables to be reset.

   {
       "tm:received_replies": 14543
   }

   {
       "tm:received_replies": 0
   }

Arguments:

• system - cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local';
• attr - the label to be associated with this value;
• value - the string to be stored;
• expire (optional) - expire time for the stored value;

Arguments: \\

@]

raise_event

Raises an event through the Event Interface using an MI command.
Arguments: None.
- event name
- params - array of elements, or a JSON object containing key-value pairs
Output: None.
Examples of usage: [@

    # opensips-cli -x mi raise_event E_PIKE_BLOCKED 127.0.0.1

reload_routes

    # opensips-cli -x mi arg

    # opensips-cli -x mi kill

    # opensips-cli -x mi list_blacklists

    # opensips-cli -x mi list_tcp_conns

    # opensips-cli -x mi log_level

    # opensips-cli -x mi ps

    # opensips-cli -x mi pwd

reload_script

Triggers the reload of the routing block (the routes) from the script during the runtime.

Output: 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.
If the reload fails, take a look at the logs to understand why - it may have been a syntax error or maybe a module related constraint. Anyhow, if the reload fails, there is no impact on your running OpenSIPS.

uptime

Prints various time information about OpenSIPS - when it started to run, for how long it runs.
Arguments: none\\

    # opensips-cli -x mi uptime

    # opensips-cli -x mi version

    # opensips-cli -x mi which

    # opensips-cli -x mi get_statistics rcv_requests

    # opensipsc-cli -x mi get_statistics shmem:      

    # opensips-cli -x mi get_statistics all

    # opensips-cli -x mi list_statistics

    # opensips-cli -x mi get_statistics received_replies

    # opensips-cli -x mi reset_statistics received_replies
    # opensips-cli -x mi get_statistics received_replies

    # opensips-cli -x mi cache_store local password_user1 password

    # opensips-cli -x mi cache_fetch local password_user1

    # opensips-cli -x mi cache_remove local password_user1

    # opensips-cli -x mi event_subscribe E_PIKE_BLOCKED udp:127.0.0.1:8888 1200

    # opensips-cli -x mi events_list

    # opensips-cli -x mi subscribers_list

    # opensips-cli -x mi subscribers_list E_RTPPROXY_STATUS

    # opensips-cli -x mi subscribers_list E_RTPPROXY_STATUS unix:/tmp/event.sock

    # opensips-cli -x mi mem_pkg_dump 11854 -1

    # opensips-cli -x mi mem_shm_dump -1

    # opensips-cli -x mi shm_check

    # opensips-cli -x mi xlog_level -2

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:

    # opensipsctl fifo xlog_level -2

Arguments:
- command (optional)
Output: multiple MI nodes where each node contains an argument. The MI nodes have no name, but only value. If command is specified, the command returns an array that contains all the parameters the command can support.

@]

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.
Arguments: None
Output: current number of fragments.
Example of usage: [@

    # opensipsctl fifo shm_check

mem_pkg_dump

mem_shm_dump

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.
Arguments:
- log level - optional, a log level to be used for this dump
Output: None.
Examples of usage:

    # opensipsctl fifo mem_shm_dump -1

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.
Arguments:
- PID - mandatory, the pid of the process to perform the pkg dump
- log level - optional, a log level to be used for this dump
Output: None.
Examples of usage:

    # opensipsctl fifo mem_pkg_dump 11854 -1

• logging level (-3...4) (see meaning of the values)

debug (Removed in OpenSIPS 3.6)

Replaced by log_level function.

kill

The command will terminate OpenSIPS (and internal shutdown).
Arguments: none
Output: none

    # opensipsctl fifo kill

list_blacklists

The command lists all the defined (static or learned) blacklists from OpenSIPS.\\

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)

    # opensipsctl fifo list_blacklists

list_tcp_conns

The command lists all ongoing TCP/TLS connection from OpenSIPS.\\

Output: an MI tree - one record per connection with the following attributes : ID, state, proto, source, destination, timeout, lifetime

    # opensipsctl fifo list_tcp_conns

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. Arguments:

• logging level (-3...4) (see meaning of the values)
• Unix pid (validated by OpenSIPS)

    # opensipsctl fifo log_level
    Process::  PID=10670 Debug=2 Type=attendant
    Process::  PID=10672 Debug=3 Type=MI FIFO
    Process::  PID=10673 Debug=1 Type=SIP receiver udp:193.668.3.633:5060
    # opensipsctl fifo log_level 1
    New global debug:: 1
    # opensipsctl fifo log_level 4 10670
    New debug:: 4

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.

• logging level (-3...4) (see meaning of the values)

    # opensipsctl fifo log_level

    # opensipsctl fifo log_level 1

    # opensipsctl fifo log_level 4 10670

Get or set the logging level of one or all OpenSIPS processes. If no argument is passed to the debug 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.

Get or set the logging level of one or all OpenSIPS processes. If no argument is passed to the debug 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 be changed only for that process.

    list_statistics

    ....

@]

list_statistics

Prints a list of all available statistics in the current configuration of OpenSIPS

Examples of usage: [@

    # opensipsctl fifo list_statistics

shmem:total_size:: incremental shmem:used_size:: incremental shmem:real_used_size:: incremental shmem:max_used_size:: incremental shmem:free_size:: incremental shmem:fragments:: incremental core:rcv_requests:: incremental core:rcv_replies:: incremental core:fwd_requests:: incremental core:fwd_replies:: incremental core:drop_requests:: incremental

debug [level] [pid]

Get or set the logging level of one or all OpenSIPS processes. If no argument is passed to the debug 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 given, the logging level will be changed only for that process. Arguments:

• debug level (-3...4)
• Unix pid (validated by OpenSIPS)

    Process::  PID=10670 Debug=2 Type=attendant
    Process::  PID=10672 Debug=3 Type=MI FIFO
    Process::  PID=10673 Debug=1 Type=SIP receiver udp:193.668.3.633:5060

    New global debug:: 1
    # opensipsctl fifo debug 4 10670
    New debug:: 4

Documentation -> Manuals -> Manual devel -> Core MI Functions

(:title Core MI Functions - 3.6:)

(:allVersions Interface-CoreMI 3.6:)

(:toc-float Table of Content:)

MI (management interface) functions which are exported by OpenSIPS core.

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

list_tcp_conns

The command lists all ongoing TCP/TLS connection from OpenSIPS.
Arguments: none
Output: an MI tree - one record per connection with the following attributes : ID, state, proto, source, destination, timeout, lifetime

Examples of usage:

    # opensipsctl fifo list_tcp_conns

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:193.668.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 runningOpenSIPS.
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 OpenSIPSinstance.
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

cache_store

This command stores in a cache system a string value.
Arguments:
- cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local'
- the label to be associated with this value
- the string to be stored
Output: none.
Examples of usage:

    # opensipsctl fifo cache_store local password_user1 password

cache_fetch

This command queries for a stored value.
Arguments:
- cache system to use - for the cache system implemented by OpenSIPS module 'localcache' the value of this parameter should be 'local'
- the label associated with the value
Output: MI tree containing the value if a record is found or 'Value not found' string otherwise.
Examples of usage:

    # opensipsctl fifo cache_fetch local password_user1

cache_remove

This command removes a record from the cache system.
Arguments:
- cache system to use
- the label associated with the stored value
Output: None.
Examples of usage:

    # opensipsctl fifo cache_remove local password_user1

event_subscribe

Subscribes an external application to a certain event.
Arguments:
- event name
- external application socket
- expire time, in seconds - if absent, the subscription is valid only one hour (3600 s)
Output: None.
Examples of usage:

    # opensipsctl fifo event_subscribe E_PIKE_BLOCKED udp:127.0.0.1:8888 1200

events_list

Lists all the events published through the Event Interface.
Arguments: None.
Output: None.
Examples of usage:

    # opensipsctl fifo events_list
    Event:: E_CORE_THRESHOLD id=0
    Event:: E_RTPPROXY_STATUS id=1
    Event:: E_PIKE_BLOCKED id=2

subscribers_list

Lists information about the subscribers
Arguments:
- event name
- external application socket
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.
Examples of usage:

    # opensipsctl fifo subscribers_list
    Event:: E_CORE_THRESHOLD id=0
    Event:: E_RTPPROXY_STATUS id=1
	Subscriber::  socket=unix:/tmp/event.sock expire=never
	Subscriber::  socket=udp:127.0.0.1:8888 expire=1100
    Event:: E_PIKE_BLOCKED id=2
	Subscriber::  socket=rabbitmq:guest@127.0.0.1/hello expire=never

    # opensipsctl fifo subscribers_list E_RTPPROXY_STATUS
    Event:: E_RTPPROXY_STATUS id=1
	Subscriber::  socket=unix:/tmp/event.sock expire=never
	Subscriber::  socket=udp:127.0.0.1:8888 expire=1100

    # opensipsctl fifo subscribers_list E_RTPPROXY_STATUS unix:/tmp/event.sock
    Event:: E_RTPPROXY_STATUS id=1
	Subscriber::  socket=unix:/tmp/event.sock expire=never

(:commentboxchrono:)