Table of Contents
List of Examples
exec_dset usageexec_msg usageexec_avp usageTable of Contents
The exec module allows external commands to be executed from a Kamailio script. The commands may be any valid shell commands--the command string is passed to the shell using “popen” command. Kamailio passes additional information about the 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 the 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.
NOTE: The environment variables must be specified with double $ (e.g., $$SIP_OUSER) in the parameters given to exec functions. Otherwise they will be evaluated as Kamailio pseudo-variables, throwing errors.
The following modules must be loaded before this module:
No dependencies on other Kamailio modules.
Turn off to disable setting environment variables for executed commands.
Default value is 1.
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 example: exec_dset("print-contact.sh '$ct'");
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.3. exec_dset usage
...
exec_dset("echo TEST > /tmp/test.txt");
exec_dset("echo TEST > /tmp/$rU.txt");
...
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.
The “examples” directory in the source tarball contains several examples that shows how to use this function.
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 example: exec_msg("print-contact.sh '$ct'");
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
Example 1.4. exec_msg usage
...
exec_msg("echo TEST > /tmp/test.txt");
exec_msg("echo TEST > /tmp/$rU.txt");
...
Executes an external command. Each line from output of the command is saved in an AVP from 'avplist'. If 'avplist' is missing, the AVPs 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 example: exec_avp("print-contact.sh '$ct'");
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.