exec Module

The following modules must be loaded before this module:

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

Set to 1 to enable setting all above-mentioned environment variables for all executed commands.

WARNING: Before enabling this parameter, make sure your "/bin/sh" is safe from the Shellshock bash vulnerability!!!

Default value is 0 (disabled).

...
modparam("exec", "setvars", 1)
...

If set, this parameter specifies the longest time (in seconds) that a program is allowed to execute. Once this duration is exceeded, the program is terminated (SIGTERM).

NOTE: due to internal limitations, a SIGTERM will actually be sent to all job pids once the "time_to_kill" expiration timeout hits. On a standard system, this should have no side-effects, as pids are monotonically increasing in a slow manner, and OpenSIPS should run under the "opensips" user, thus rendering it unable to terminate non-child processes. If this is not the case on your system, do not use the OpenSIPS "time_to_kill" feature -- rather implement it within your external app!

Default value is 0 (disabled).

...
modparam("exec", "time_to_kill", 20)
...

Executes an external command. The input is passed to the standard input of the new process, if specified, and the output is saved in the output variable.

The function waits for the external script until it provided all its output (not necessary to actually finish). If no output (standard output or standard error) is required by the function, it will not block at all - it will simply launch the external script and continue the script.

Meaning of the parameters is as follows:

WARNING: any OpenSIPS pseudo-vars which may contain special bourne shell (sh/bash) characters should be placed inside quotes, e.g. exec("update-stats.sh '$(ct{re.subst,/'//g})'");

WARNING: "stdin"/"stdout"/"stderr" parameters are not designed for large amounts of data, so one should be careful when using them. Because of the basic implementation, filled up pipes could cause a read deadlock.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, STARTUP_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.

...
$avp(env) = "a";
$avp(env) = "b";
exec("ls -l", , "$var(out)", "$var(err)", "$avp(env)");
xlog("The output is $var(out)\n");
xlog("Received the following error\n$var(err)");
...
$var(input) = "input";
exec("/home/../myscript.sh", "this is my $var(input) for exec\n", , , "$avp(env)");
...

WARNING - this function is deprecated and it will be remove in the next version - please use the exec() function ( Section 1.4.1, “ exec(command, [stdin], [stdout], [stderr], [envavp]) ” ).

Executes an external command. The current R-URI is appended to the command as its last parameter. The output of the command will rewrite the current R-URI. Multiple lines of output lead to multiple branches.

Meaning of the parameters is as follows:

WARNING: most OpenSIPS scripting variables should be quoted before being passed to external commands, as in: exec_avp("log-call.sh '$ct'"). This may help avoid some unexpected behaviour (e.g. unwanted extra parameters, errors due to special bash characters, etc.)

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

...
exec_dset("ruri-changer.sh");
exec_dset("ruri-changer.sh '$ct'");
...

WARNING - this function is deprecated and it will be remove in the next version - please use the exec() function ( Section 1.4.1, “ exec(command, [stdin], [stdout], [stderr], [envavp]) ” ).

Executes an external command. The current SIP message is passed to it in the standard input, no command-line parameters are added and the output of the command is ignored.

See sip-server/modules/exec/etc/exec.cfg in the source tarball for information on usage.

Meaning of the parameters is as follows:

WARNING: most OpenSIPS scripting variables should be quoted before being passed to external commands, as in: exec_avp("log-call.sh '$ct'"). This may help avoid some unexpected behaviour (e.g. unwanted extra parameters, errors due to special bash characters, etc.)

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.

...
exec_msg("call-logger.sh '$ct' >> /var/log/call-logger/'$rU'.calls");
...

WARNING - this function is deprecated and it will be remove in the next version - please use the exec() function ( Section 1.4.1, “ exec(command, [stdin], [stdout], [stderr], [envavp]) ” ).

Executes an external command. Each output line of the command is saved in its corresponding AVP from avplist. If avplist is missing or is incomplete, the populated AVPs will be 1, 2, 3... or N, N+1, N+2...

Meaning of the parameters is as follows:

WARNING: most OpenSIPS scripting variables should be quoted before being passed to external commands, as in: exec_avp("log-call.sh '$ct'"). This may help avoid some unexpected behaviour (e.g. unwanted extra parameters, errors due to special bash characters, etc.)

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, LOCAL_ROUTE, STARTUP_ROUTE, TIMER_ROUTE, EVENT_ROUTE, ONREPLY_ROUTE.

...
exec_avp("get-subscriber-details.sh '$rU'", "$avp(credit) $avp(contract_model)");
...

WARNING - this function is deprecated and it will be remove in the next version - please use the exec() function ( Section 1.4.1, “ exec(command, [stdin], [stdout], [stderr], [envavp]) ” ).

Obtains the value of a UNIX evironment_variable. The value is saved in 'avp'. If 'avp' is missing, output will be stored in $avp(1). If there is no such environment variable no value will be returned.

Meaning of the parameters is as follows:

WARNING: any OpenSIPS pseudo-vars which may contain special bash characters should be placed inside quotes, e.g. 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(localhost)");
...

Executes an external command. This function does exactly the same as Section 1.4.1, “ exec(command, [stdin], [stdout], [stderr], [envavp]) ” (in terms of input, output and processing), but in an asynchronous way. The script execution is suspended until the external script provided all its output. OpenSIPS waits for the external script to close its output stream, not necessarily to terminate (so the script may still be running when OpenSIPS resumes the script execution on "seeing" EOF on the the output stream).

NOTE: this function ignore the "error" parameters for now - the asynchronous waiting is done only on the output stream !! This may be fixed in the following versions.

To read and understand more on the asynchronous functions, how to use them and what are their advantages, please refer to the OpenSIPS online Manual.

{
...
async( exec("ruri-changer.sh","$ru","$ru"), resume );
}

route[resume] {
...
}