Resources.DocsCoreMi History

Hide minor edits - Show changes to markup

April 24, 2013, at 09:12 PM by 92.80.24.181 -
Changed lines 1-276 from:

Resources -> Documentation -> CookBooks -> Core MI Functions


(:toc-float Table of Content:) MI (management interface) functions which are exported by OpenSIPS core.

This document is for OpenSIPS 1.10.x/devel

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

to:

(:redirect Documentation/Interface-CoreMI quiet=1:)

January 29, 2013, at 05:22 PM by vlad_paiu -
Changed line 7 from:

This document is for OpenSIPS 1.9.x/devel

to:

This document is for OpenSIPS 1.10.x/devel

January 25, 2013, at 04:15 PM by 109.99.235.212 -
Added lines 56-65:

@]

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
October 23, 2012, at 03:11 PM by bogdan -
Deleted lines 264-269:

(:nl:)>>messagehead<<

Mary?23 October 2012, 00:44

OK, it turns out you can't set the debug constants in mtllipue places (they are constants) so the debug flag only works if you comment out the WP_DEBUG flag in wp-config.php.DOH!

October 23, 2012, at 12:44 AM by Mary - Comment added
Added lines 265-270:

(:nl:)>>messagehead<<

Mary?23 October 2012, 00:44

OK, it turns out you can't set the debug constants in mtllipue places (they are constants) so the debug flag only works if you comment out the WP_DEBUG flag in wp-config.php.DOH!

April 09, 2012, at 12:46 PM by razvancrainea -
Changed lines 262-266 from:

@]

to:

@]


(:commentboxchrono:)

April 09, 2012, at 11:57 AM by razvancrainea -
Changed lines 213-222 from:

(:nl:)>>messagehead<<

Maggie?10 August 2011, 23:05

Very true! Makes a chngae to see someone spell it out like that. :)

(:commentboxchrono:)

to:

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
March 22, 2012, at 12:53 PM by vlad_paiu -
Changed line 7 from:

This document is for OpenSIPS 1.8.x/devel

to:

This document is for OpenSIPS 1.9.x/devel

August 10, 2011, at 11:05 PM by Maggie - Comment added
Added lines 215-220:

(:nl:)>>messagehead<<

Maggie?10 August 2011, 23:05

Very true! Makes a chngae to see someone spell it out like that. :)

July 12, 2011, at 06:52 PM by bogdan -
Changed line 1 from:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.7/devel

to:

Resources -> Documentation -> CookBooks -> Core MI Functions

Changed line 7 from:

This document is for OpenSIPS 1.7.x/devel

to:

This document is for OpenSIPS 1.8.x/devel

June 28, 2011, at 10:36 AM by bogdan -
Deleted lines 214-220:

(:nl:)>>messagehead<<

Kert?27 June 2011, 19:21

Ppl like you get all the brnais. I just get to say thanks for he answer.

June 27, 2011, at 07:21 PM by Kert - Comment added
Added lines 216-221:

(:nl:)>>messagehead<<

Kert?27 June 2011, 19:21

Ppl like you get all the brnais. I just get to say thanks for he answer.

June 27, 2011, at 05:06 PM by 109.99.2.142 -
Deleted lines 215-219:

(:nl:)>>messagehead<<

Tallin?27 June 2011, 15:09

Hey, that post leaves me fleenig foolish. Kudos to you!

June 27, 2011, at 03:09 PM by Tallin - Comment added
Added lines 215-220:

(:nl:)>>messagehead<<

Tallin?27 June 2011, 15:09

Hey, that post leaves me fleenig foolish. Kudos to you!

November 10, 2010, at 08:51 AM by bogdan -
Changed line 186 from:
    # opensipsctl fifo cache_store password_user1 password
to:
    # opensipsctl fifo cache_store local password_user1 password
Changed line 198 from:
    # opensipsctl fifo cache_fetch password_user1
to:
    # opensipsctl fifo cache_fetch local password_user1
Changed line 209 from:
    # opensipsctl fifo cache_remove password_user1
to:
    # opensipsctl fifo cache_remove local password_user1
October 13, 2009, at 11:35 PM by bogdan -
Changed line 1 from:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.6/devel

to:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.7/devel

Changed line 7 from:

This document is for OpenSIPS 1.6.x/devel

to:

This document is for OpenSIPS 1.7.x/devel

April 23, 2009, at 10:26 AM by bogdan -
Changed lines 1-2 from:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.5

to:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.6/devel


Changed line 7 from:

This document is for OpenSIPS 1.5.x

to:

This document is for OpenSIPS 1.6.x/devel

March 05, 2009, at 05:25 PM by anca_vamanu -
Changed line 201 from:

This command removes a record from the cache system.

to:

This command removes a record from the cache system.\\

March 05, 2009, at 05:24 PM by anca_vamanu -
Changed lines 178-180 from:
   # 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 \\
to:
   - 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 \\
Changed lines 191-192 from:
   # 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 \\
to:
   - 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 \\
Changed lines 203-204 from:
   # 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 \\
to:
   - cache system to use
- the label associated with the stored value \\
March 05, 2009, at 05:20 PM by anca_vamanu -
Added lines 174-211:

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 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 to be associated with this 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 password_user1

cache_remove

This command removes a record from the cache system. 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
Output: None.
Examples of usage:

    # opensipsctl fifo cache_remove password_user1
Added line 213:
March 03, 2009, at 10:49 AM by bogdan -
Changed lines 172-176 from:

@]

to:

@]


(:commentboxchrono:)

January 30, 2009, at 05:53 PM by 81.180.102.217 -
Changed lines 1-2 from:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.4

to:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.5

Changed lines 6-7 from:

This document is for OpenSIPS 1.4.x

to:

This document is for OpenSIPS 1.5.x

January 30, 2009, at 05:52 PM by 81.180.102.217 -
Changed lines 1-2 from:

Resources -> Documentation -> CookBooks -> Core MI Functions

to:

Resources -> Documentation -> CookBooks -> Core MI Functions v1.4

Added lines 6-7:

This document is for OpenSIPS 1.4.x

October 08, 2008, at 08:44 AM by 81.180.102.217 -
Changed lines 1-2 from:

Resources -> Documentation -> Core MI Functions

to:

Resources -> Documentation -> CookBooks -> Core MI Functions

October 03, 2008, at 12:50 PM by 81.180.102.217 -
Changed line 158 from:

reset_statistics

to:

reset_statistics

October 03, 2008, at 12:49 PM by 81.180.102.217 -
Added line 3:

(:toc-float Table of Content:)

July 21, 2008, at 05:29 PM by 81.180.102.217 -
Added lines 135-168:

@]

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
July 21, 2008, at 05:12 PM by 81.180.102.217 -
Changed lines 44-45 from:

ps

The command will list all all OpenSIPS processes, along with type and description.\\

to:

list_blacklists

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

Changed lines 47-48 from:

Output: multiple MI nodes (named "Process") - each node contains process ID (internal), PID (OS), Type and description

to:

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)

Changed lines 51-57 from:
    # 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
to:
    # opensipsctl fifo list_blacklists
Changed lines 54-55 from:

pwd

Prints the working directory of OpenSIPS instance.\\

to:

ps

The command will list all all OpenSIPS processes, along with type and description.\\

Changed lines 57-59 from:

Output: a single MI node with name "WD" containing the working directory full path.

to:

Output: multiple MI nodes (named "Process") - each node contains process ID (internal), PID (OS), Type and description

Changed lines 61-62 from:
    # opensipsctl fifo pwd
    WD:: /
to:
    # 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
Changed lines 70-71 from:

uptime

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

to:

pwd

Prints the working directory of OpenSIPS instance.\\

Changed lines 73-75 from:

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

to:

Output: a single MI node with name "WD" containing the working directory full path.

Changed lines 78-81 from:
    # opensipsctl fifo uptime
    Now:: Mon Jul 21 17:41:03 2008
    Up since:: Mon Jul 21 17:36:33 2008
    Up time:: 270 [sec]
to:
    # opensipsctl fifo pwd
    WD:: /
Changed lines 82-83 from:

version

Prints the version string of a runningOpenSIPS.\\

to:

uptime

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

Changed lines 85-86 from:

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

to:

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

Changed lines 90-91 from:
    # opensipsctl fifo version
    Server:: OpenSIPS (1.4.0dev14-notls (i386/linux))
to:
    # opensipsctl fifo uptime
    Now:: Mon Jul 21 17:41:03 2008
    Up since:: Mon Jul 21 17:36:33 2008
    Up time:: 270 [sec]
Changed lines 96-98 from:

which

Prints all available MI commands from the queried OpenSIPSinstance.\\

to:

version

Prints the version string of a runningOpenSIPS.\\

Changed lines 99-100 from:

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.

to:

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

Added lines 103-114:
    # 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: [@

July 21, 2008, at 05:06 PM by 81.180.102.217 -
Changed lines 61-62 from:
to:

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:: /
Changed lines 73-85 from:
to:

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]
Changed lines 87-97 from:
to:

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))
Changed lines 99-125 from:
to:

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
July 21, 2008, at 04:38 PM by 81.180.102.217 -
Deleted line 20:
Changed lines 45-59 from:
to:

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
Added line 62:
July 21, 2008, at 04:33 PM by 81.180.102.217 -
Changed lines 36-44 from:
to:

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

Examples of usage:

    # opensipsctl fifo kill
July 21, 2008, at 04:32 PM by 81.180.102.217 -
Changed lines 6-7 from:

Returns the full list of arguments used when OpenSIPS was started. As in UNIX, the first argument is the name of executable binary.

to:

Returns the full list of arguments used when OpenSIPS was started. As in UNIX, the first argument is the name of executable binary.\\

Changed line 12 from:
    opensipsctl fifo arg
to:
    # opensipsctl fifo arg
Changed lines 22-23 from:

Gets or sets value of debug core variable.

to:

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"

Changed lines 29-30 from:
    opensipsctl fifo debug
    opensipsctl fifo debug 1
to:
    # opensipsctl fifo debug
    DEBUG:: 4
    # opensipsctl fifo debug 1
July 21, 2008, at 04:27 PM by 81.180.102.217 -
Changed line 8 from:

Arguments: none

to:

Arguments: none\\

July 21, 2008, at 04:27 PM by 81.180.102.217 -
Changed lines 7-9 from:

Arguments: none Output: multiple MI nodes where each node contains an argument. The MI nodes have no name, but only value.

to:

Arguments: none Output: multiple MI nodes where each node contains an argument. The MI nodes have no name, but only value.

July 21, 2008, at 04:26 PM by 81.180.102.217 -
Changed lines 6-11 from:

debug [level]

Gets or sets value of debug core variable.

Examples of usage:

to:

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:

Changed lines 12-13 from:
    opensipsctl fifo debug
    opensipsctl fifo debug 1
to:
    opensipsctl fifo arg
    ./opensips
    -f
    /etc/openser/test.cfg
Added lines 20-30:

debug [level]

Gets or sets value of debug core variable.

Examples of usage:

    opensipsctl fifo debug
    opensipsctl fifo debug 1
July 21, 2008, at 04:19 PM by 81.180.102.217 -
Changed lines 5-6 from:
to:

arg

Changed lines 15-29 from:

@]

to:

@]

kill

ps

pwd

uptime

version

which

July 21, 2008, at 04:16 PM by 81.180.102.217 -
Changed lines 1-2 from:

Core MI Functions

to:

Resources -> Documentation -> Core MI Functions

July 19, 2008, at 08:16 PM by 81.180.102.217 -
Added lines 1-14:

Core MI Functions

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

debug [level]

Gets or sets value of debug core variable.

Examples of usage:

    opensipsctl fifo debug
    opensipsctl fifo debug 1

Page last modified on April 24, 2013, at 09:12 PM