EXEC module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”Exec module allows to start an external command from a OpenSIPS script. The commands may be any valid shell commands—the command string is passed to shell using “popen” command. OpenSIPS passes additionally lot of information about request in environment variables:
- SIP_HF_<hf_name> contains value of each header field in request. If a header field occurred multiple times, values are concatenated and comma-separated. <hf_name> is in capital letters. Ff a header-field name occurred in compact form, <hf_name> is canonical.
- SIP_TID is transaction identifier. All request retransmissions or CANCELs/ACKs associated with a previous INVITE result in the same value.
- SIP_DID is dialog identifier, which is the same as to-tag. Initially, it is empty.
- SIP_SRCIP is source IP address from which request came.
- SIP_ORURI is original request URI.
- SIP_RURI is current request URI (if unchanged, equal to original).
- SIP_USER is userpart of current request URI.
- SIP_OUSER is userpart of original request URI.
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”The following modules must be loaded before this module:
- No dependencies on other OpenSIPS modules.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- None.
Exported Parameters
Section titled “Exported Parameters”setvars (integer)
Section titled “setvars (integer)”Turn off to disable setting environment variables for executed commands.
Default value is 1.
...modparam("exec", "setvars", 1)...time_to_kill (integer)
Section titled “time_to_kill (integer)”Specifies the longest time a program is allowed to execute. If the time is exceeded, the program is killed.
Default value is 0.
...modparam("exec", "time_to_kill", 20)...async (integer)
Section titled “async (integer)”Turns on the asynchronous mode for ‘exec_msg’ function. All commands will be executed by a different process and the caller will continue it’s flow, without waiting for a response.
Default value is 0.
...modparam("exec", "async", 1)...Exported Functions
Section titled “Exported Functions”exec_dset(command)
Section titled “exec_dset(command)”Executes an external command. Current URI is passed to the command as parameter. Output of the command is considered URI set (separated by lines).
Meaning of the parameters is as follows:
- command - Command to be executed. It can include pseudo- variabes;
WARNING: if the var you are passing out has a bash special character in it, the var needs to be placed inside quotes, for ex: exec_dset(“print-contact.sh ‘$ct’”);
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
...exec_dset("echo TEST > /tmp/test.txt");exec_dset("echo TEST > /tmp/$rU.txt");...exec_msg(command)
Section titled “exec_msg(command)”Executes an external command. The whole message is passed to it in input, no command-line parameters are added, output of the command is not processed.
See sip-server/modules/exec/etc/exec.cfg in the source tarball for information on usage.
Meaning of the parameters is as follows:
- command - Command to be executed. It can include pseudo-variables.
WARNING: if the var you are passing out has a bash special character in it, the var needs to be placed inside quotes, for ex: exec_msg(“print-contact.sh ‘$ct’”);
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.
...exec_msg("echo TEST > /tmp/test.txt");exec_msg("echo TEST > /tmp/$rU.txt");...exec_avp(command [, avplist])
Section titled “exec_avp(command [, avplist])”Executes an external command. Each line from output of the command is saved in an AVP from ‘avplist’. If ‘avplist’ is missing, the AVP are named 1, 2, 3, …
Meaning of the parameters is as follows:
- command - Command to be executed. It can include pseudo- variabes;
- avplist - comma separated list with AVP names to store the result in;
WARNING: if the var you are passing out has a bash special character in it, the var needs to be placed inside quotes, for ex: exec_avp(“print-contact.sh ‘$ct’”);
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, STARTUP_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.
...exec_avp("echo TEST");exec_avp("echo TEST", "$avp(test)");...exec_getenv(environment_variable [, avp])
Section titled “exec_getenv(environment_variable [, avp])”Get the value of an evironment_variable. The value is saved in ‘avp’. If ‘avp’ is missing, the AVP is named 1. If there is no such environment variable no value is returned.
Meaning of the parameters is as follows:
- environment_variable - Environent variable name. It can include pseudo- variabes;
- avp - an AVP names to store the result in;
WARNING: if the var you are passing out has a bash special character in it, the var needs to be placed inside quotes, for ex: exec_getenv(”‘$ct’”);
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, STARTUP_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.
...exec_getenv("HOSTNAME");exec_getenv("HOSTNAME", "$avp(test)");...Known Issues
Section titled “Known Issues”There is currently no guarantee that scripts ever return and stop blocking SIP server. (There is kill.c but it is not used along with the current mechanisms based on popen. Besides that kill.c is ugly).
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 29 | 20 | 289 | 315 |
| 2. | Jiri Kuthan (@jiriatipteldotorg) | 28 | 11 | 1579 | 152 |
| 3. | Daniel-Constantin Mierla (@miconda) | 26 | 19 | 445 | 136 |
| 4. | Jan Janak (@janakj) | 18 | 10 | 494 | 142 |
| 5. | Razvan Crainea (@razvancrainea) | 13 | 9 | 286 | 30 |
| 6. | Andrei Pelinescu-Onciul | 11 | 8 | 33 | 109 |
| 7. | Stefan Darius (@dariusstefan) | 8 | 4 | 327 | 59 |
| 8. | Henning Westerholt (@henningw) | 4 | 2 | 8 | 8 |
| 9. | Liviu Chircu (@liviuchircu) | 3 | 1 | 6 | 3 |
| 10. | Anca Vamanu | 3 | 1 | 5 | 5 |
All remaining contributors: Dan Pascu (@danpascu), Elena-Ramona Modroiu, Konstantin Bokarius, Andreas Granig, Edson Gellert Schubert, Dror Wald.
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2011 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Apr 2014 - Apr 2014 |
| 4. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jul 2004 - Jan 2013 |
| 5. | Anca Vamanu | Jan 2011 - Jan 2011 |
| 6. | Dror Wald | Nov 2008 - Nov 2008 |
| 7. | Dan Pascu (@danpascu) | Sep 2008 - Sep 2008 |
| 8. | Daniel-Constantin Mierla (@miconda) | Oct 2005 - Jun 2008 |
| 9. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
| 10. | Edson Gellert Schubert | Feb 2008 - Feb 2008 |
All remaining contributors: Henning Westerholt (@henningw), Elena-Ramona Modroiu, Andreas Granig, Jan Janak (@janakj), Andrei Pelinescu-Onciul, Jiri Kuthan (@jiriatipteldotorg).
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Anca Vamanu, Dror Wald, Dan Pascu (@danpascu), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu, Jan Janak (@janakj).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0