This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
cookbooks:devel:pseudovariables [2015/04/03 20:54] carstenbock [$uac_req(key)] |
cookbooks:devel:pseudovariables [2021/04/27 09:34] miconda |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | ===== Introduction ===== | + | Version: Kamailio SIP Server v5.6.x (devel) |
- | The term “pseudo-variable” is used for special tokens that can be given as parameters to different script functions and they will be replaced with a value before the execution of the function. | + | ===== Overview ===== |
- | The beginning of a “pseudo-variable” is marked | + | This tutorial collects the functions and parameters exported |
- | There is a set of predefined pseudo-variables, | + | **Note:** The parameters on this page are **NOT** in alphabetical order. |
- | Pseudo-Variables are implemented by various modules, most of them are provided by **pv** (if there is no special reference to a module, expect that the pseudo-variable is provided by **pv** module). | + | ===== Structure ===== |
- | ===== Pseudo-variables usage ===== | + | The structure of the kamailio.cfg can be seen as three parts: |
+ | * global parameters | ||
+ | * modules settings | ||
+ | * routing blocks | ||
- | Pseudo-variables can be used with many modules, among them: | + | For clarity and making it easy to maintain, it is recommended to keep them in this order, although some of them can be mixed. |
- | * acc | + | ==== Global Parameters Section ==== |
- | * avpops | + | |
- | * htable | + | |
- | * textops | + | |
- | * uac | + | |
- | * xlog | + | |
- | ===== The list of pseudo-variables ===== | + | This is the first part of the configuration file, containing the parameters for the core of kamailio and custom global parameters. |
+ | Typically this is formed by directives of the form: | ||
- | Predefined pseudo-variables are listed in alphabetical order. | + | < |
+ | name=value | ||
+ | </ | ||
- | ==== $$ - Pseudo-variable marker ==== | + | The name corresponds to a core parameter as listed in one of the next sections of this document. If a name is not matching a core parameter, then Kamailio will not start, rising an error during startup. |
- | **$$** - represents the character ' | + | The value is typically an integer, boolean or a string. |
- | ==== $_s(format) - Evaluate dynamic format ==== | + | Several parameters can get a complex value which is formed from a group of integer, strings or identifiers. For example, such parameter is **listen**, which can be assigned a value like **proto: |
- | **$_s(format)** - returns the string after evaluating all pseudo-variables in format | + | Example of content: |
- | < | + | < |
- | | + | log_facility=LOG_LOCAL0 |
- | # is equivalent of: | + | children=4 |
- | $var(x) | + | disable_tcp=yes |
+ | |||
+ | alias=" | ||
+ | |||
+ | listen=udp: | ||
</ | </ | ||
- | ==== $ai - URI inP-Asserted-Identity header ==== | + | Usually setting a parameter is ended by end of line, but it can be also ended with **;** (semicolon). This should be used when the grammar of a parameter allows values on multiple lines (like **listen** or **alias**) and the next line creates a conflict by being swallowed as part of value for previous parameter. |
- | **$ai** - reference to URI in request' | + | <code c> |
+ | alias=" | ||
+ | </ | ||
- | ==== $adu - Auth Digest URI ==== | + | If you want to use a reserved config keyword as part of a parameter, you need to enclose it in quotes. See the example below for the keyword " |
- | **$adu** - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response. | + | <code c> |
+ | listen=tcp: | ||
+ | </ | ||
+ | ==== Modules Settings Section ==== | ||
- | ==== $aa - Auth algorithm ==== | + | This is the second section of the configuration file, containing the directives to load modules and set their parameters. |
- | **$aa** - algorithm from Authorization or Proxy-Authorization header. | + | It contains the directives |
- | ==== $ar - Auth realm ==== | + | Example of content: |
- | **$ar** - realm from Authorization or Proxy-Authorization header | + | <code c> |
+ | loadmodule " | ||
+ | ... | ||
+ | modparam(" | ||
+ | </ | ||
+ | ==== Routing Blocks Section ==== | ||
- | ==== $au - Auth username user ==== | + | This is the last section of the configuration file, typically the biggest one, containing the routing blocks with the routing logic for SIP traffic handled by Kamailio. |
- | **$au** - user part of username from Authorization or Proxy-Authorization header | + | The only mandatory routing block is **request_route**, which contains the actions for deciding the routing for SIP requests. |
+ | See the chapter **Routing Blocks** in this document for more details about what types of routing blocks can be used in the configuration file and their role in routing SIP traffic and Kamailio behaviour. | ||
- | ==== $ad - Auth username domain ==== | + | Example of content: |
- | **$ad** - domain part of username from Authorization or Proxy-Authorization header | + | <code c> |
+ | request_route { | ||
+ | # per request initial checks | ||
+ | route(REQINIT); | ||
- | ==== $aU - Auth whole username ==== | + | ... |
+ | } | ||
- | **$aU** - whole username from Authorization or Proxy-Authorization header | + | branch_route[MANAGE_BRANCH] { |
+ | xdbg(" | ||
+ | route(NATMANAGE); | ||
+ | } | ||
+ | </ | ||
- | ==== $Au - Acc username | + | ===== Generic Elements ===== |
- | **$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise. | + | ==== Comments ==== |
+ | Line comments start with **#** (hash/pound character - like in shell) or **/ /** (double forward slash - like in C++/Java). | ||
- | ==== $branch(name) - Branch attributes ==== | + | Block comments start with /* (forward slash and asterisk) and are ended by */ (sterisk and forward slash) (like in C, C++, Java). |
- | **$branch(name)** - reference to attribute ' | + | Example: |
- | This pseudo variable gives you access to the " | + | < |
+ | # this is a line comment | ||
+ | |||
+ | // this is another line comment | ||
+ | |||
+ | /* this | ||
+ | is | ||
+ | a | ||
+ | | ||
+ | | ||
+ | </ | ||
- | The ' | + | Important: be aware of preprocessor directives that start with **#!** (hash/pound and exclamation) - those are no longer line comments. |
- | * uri - return uri of the branch | + | ==== Values ==== |
- | * dst_uri - return destination uri (next hop address) | + | |
- | * path - return the path vector for the branch | + | There are three types of values: |
- | * q - return the q value of the branch | + | |
- | * send_socket - return the socket to be used to send the branch | + | * integer |
- | * count - return the number | + | * boolean |
- | * flags - return the branch flags value | + | * string |
- | * ruid - return the ruid of the branch (Record internal Unique ID from usrloc) | + | |
- | The PV can take an index to access a specif branch: $(branch(name)[index]) | ||
Example: | Example: | ||
<code c> | <code c> | ||
- | $var(i)=0; | + | // next two are strings |
- | while($var(i)< | + | |
- | { | + | "this is a string value" |
- | xlog("$(branch(uri)[$var(i)])\n"); | + | ' |
- | $var(i) = $var(i) + 1; | + | |
- | } | + | // next is a boolean |
+ | |||
+ | yes | ||
+ | |||
+ | // next is an integer | ||
+ | |||
+ | 64 | ||
</ | </ | ||
- | Starting with 3.1.0, you can assign value per attribute. Index can be used to update a specific branch: | + | ==== Identifiers ==== |
+ | |||
+ | Identifiers are tokens which are not enclosed in single or double quotes and to match the rules for integer or boolean values. | ||
+ | |||
+ | For example, the identifiers are the core parameters and functions, module functions, core keywords and statements. | ||
+ | |||
+ | Example: | ||
<code c> | <code c> | ||
- | $(branch(attr)[index]) = value; | + | return |
</ | </ | ||
- | If index is missing, first branch is used. If index is -1 the last branch is used. | + | ==== Variables ==== |
- | Assigning | + | The variables start with **$** (dollar character). |
+ | |||
+ | You can see the list with available variables in the Pseudo-Variables Cookbook. | ||
+ | |||
+ | Example: | ||
<code c> | <code c> | ||
- | $(branch(uri)[2]) = "sip:test@kamailio.org; | + | $var(x) = $rU + " |
</ | </ | ||
+ | ==== Actions ==== | ||
- | ==== $br - Request' | + | An action is an element used inside routing blocks ended by **;** (semicolon). It can be an execution of a function from core or a module, a conditional or loop statement, an assignment expression. |
- | **$br** - reference to request' | + | Example: |
- | <fc #0000ff>It is R/W variable, you can assign values to it directly in configuration file (will add a new branch).</fc> | + | <code c> |
+ | sl_send_reply(" | ||
+ | exit; | ||
+ | </code> | ||
- | ==== $bR - Request' | + | ==== Expressions |
- | **$bR** - reference to request' | + | An expression is an association group of statements, variables, functions and operators. |
- | ==== $bf - Branch flags ==== | + | Example: |
- | **$bf** - reference to branch flags of branch 0 (RURI) - decimal output | + | <code c> |
+ | if(!t_relay()) | ||
- | <fc # | + | if($var(x)>10) |
- | ==== $bF - Branch flags ==== | + | |
- | **$bF** - reference to branch flags of branch 0 (RURI) - hexa output | + | " |
+ | </ | ||
- | <fc # | + | ===== Config Pre-Processor Directives ===== |
- | ==== $bs - Body size ==== | + | ==== include_file |
- | **$bs** - body size | + | < |
+ | | ||
+ | </ | ||
- | ==== $ci - Call-Id ==== | + | Include the content of the file in config before parsing. path_to_file must be a static string. Including file operation is done at startup. If you change the content of included file, you have to restart the SIP server to become effective. |
- | **$ci** - reference | + | The path_to_file can be relative or absolute. If it is not absolute path, first attempt is to locate it relative to current directory, and if fails, relative to directory |
- | ==== $cl - Content-Length ==== | + | If the included file is not found, the config file parser throws error. You can find this error message at the logging destination, |
- | **$cl** - reference to body of content-length header | + | You can use also the syntax |
- | ==== $cnt(pv) - Count number | + | Example |
- | **$cnt(avp)** - return | + | <code c> |
+ | route { | ||
+ | ... | ||
+ | include_file "/ | ||
+ | ... | ||
+ | } | ||
+ | |||
+ | --- / | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | } | ||
+ | |||
+ | --- | ||
+ | </ | ||
+ | |||
+ | ==== import_file ==== | ||
+ | |||
+ | < | ||
+ | | ||
+ | </ | ||
+ | |||
+ | Similar to **include_file**, | ||
+ | |||
+ | ==== define ==== | ||
+ | |||
+ | Control in C-style what parts of the config file are executed. The parts in non-defined zones are not loaded, ensuring lower memory usage and faster execution. | ||
+ | |||
+ | Available directives: | ||
+ | * **#!define NAME** - define a keyword | ||
+ | * **#!define NAME VALUE** - define a keyword with value | ||
+ | * **#!ifdef NAME** - check if a keyword is defined | ||
+ | * **# | ||
+ | * **#!else** - switch to false branch | ||
+ | * **#!endif** - end ifdef/ | ||
+ | * **# | ||
+ | * **# | ||
+ | |||
+ | Predefined keywords: | ||
+ | * **KAMAILIO_X[_Y[_Z]]** - Kamailio versions | ||
+ | * **MOD_X** - when module X has been loaded | ||
+ | See ' | ||
+ | |||
+ | Among benefits: | ||
+ | * easy way to enable/ | ||
+ | * switch control for parts where conditional statements were not possible (e.g., global parameters, module settings) | ||
+ | * faster by not using conditional statements inside routing blocks when switching between running environments | ||
+ | |||
+ | Example: how to make config to be used in two environments, | ||
<code c> | <code c> | ||
- | xlog(" | + | ... |
+ | |||
+ | #!define TESTBED_MODE | ||
+ | |||
+ | #!ifdef TESTBED_MODE | ||
+ | debug=5 | ||
+ | log_stderror=yes | ||
+ | listen=192.168.1.1 | ||
+ | #!else | ||
+ | debug=2 | ||
+ | log_stderror=no | ||
+ | listen=10.0.0.1 | ||
+ | #!endif | ||
+ | |||
+ | ... | ||
+ | |||
+ | #!ifdef TESTBED_MODE | ||
+ | modparam(" | ||
+ | " | ||
+ | #!else | ||
+ | modparam(" | ||
+ | " | ||
+ | #!endif | ||
+ | |||
+ | ... | ||
+ | |||
+ | #!ifdef TESTBED_MODE | ||
+ | route[DEBUG] { | ||
+ | | ||
+ | } | ||
+ | #!endif | ||
+ | |||
+ | ... | ||
+ | |||
+ | route { | ||
+ | #!ifdef TESTBED_MODE | ||
+ | route(DEBUG); | ||
+ | #!endif | ||
+ | |||
+ | ... | ||
+ | } | ||
+ | |||
+ | ... | ||
</ | </ | ||
- | ==== $conid - TCP Connection ID ==== | ||
- | **$conid** - The TCP connection ID of the connection the current message arrived on for TCP, TLS, WS, and WSS. Set to $null for SCTP and UDP. | + | |
- | ==== $cs - CSeq ==== | + | <code c> |
+ | #!define MYINT 123 | ||
+ | #!define MYSTR " | ||
+ | </ | ||
- | **$cs** - reference to the sequence number in the cseq header. The method in the CSeq header is identical to the request method, thus use $rm to get the method (works also for responses). | + | |
- | ==== $ct - Contact header ==== | + | <code c> |
+ | $var(x) | ||
+ | </ | ||
- | **$ct** - reference to body of contact header | + | |
+ | <code c> | ||
+ | $var(x) = 100 + 123; | ||
+ | </ | ||
- | ==== $cT - Content-Type ==== | + | * you can have multi-line defined IDs |
- | **$cT** - reference to body of content-type header | + | <code c> |
+ | #!define IDLOOP | ||
+ | while($var(i)< | ||
+ | xlog(" | ||
+ | $var(i) = $var(i) + 1; \ | ||
+ | } | ||
+ | </ | ||
- | ==== $dd - Domain of destination URI ==== | + | * then in routing block |
- | **$dd** - reference to domain of destination uri (without port) | + | <code c> |
+ | route { | ||
+ | ... | ||
+ | IDLOOP | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | * number of allowed defines is now set to 256 | ||
- | ==== $di - Diversion header URI ==== | + | * notes: |
+ | * multilines defines are reduced to single line, so line counter should be fine | ||
+ | * column counter goes inside the define value, but you have to omit the ' | ||
+ | * text on the same line as the directive will cause problems. Keep the directive lines clean and only comment on a line before or after. | ||
- | **$di** - reference to Diversion header URI | + | ==== defenv ==== |
- | ==== $dip - Diversion " | + | Preprocessor directive to define an ID to the value of an environment variable with the name ENVVAR. |
- | **$dip** - reference to Diversion header " | + | <code c> |
+ | #!defenv ID=ENVVAR | ||
+ | </ | ||
- | ==== $dir - Diversion " | + | It can also be just **$!defenv ENVVAR** and the defined ID is the ENVVAR name. |
- | **$dir** - reference to Diversion header " | + | Example: |
- | ==== $dic - Diversion " | + | <code c> |
+ | #!defenv SHELL | ||
+ | </ | ||
- | **$dic** - reference to Diversion header " | + | If environment variable |
- | ==== $dp - Port of destination URI ==== | + | <code c> |
+ | #!define SHELL /bin/bash | ||
+ | </ | ||
- | **$dp** - reference to port of destination uri | + | Full expression variant: |
- | ==== $dP - Transport protocol of destination URI ==== | + | <code c> |
+ | #!defenv ENVSHELL=SHELL | ||
+ | </ | ||
- | **$dP** - reference to transport protocol of destination uri | + | Then it is like: |
- | ==== $ds - Destination set ==== | + | <code c> |
+ | #!define ENVSHELL /bin/bash | ||
+ | </ | ||
- | **$ds** - reference to destination set | + | It is a simplified alternative of using **# |
+ | |||
+ | ==== subst ==== | ||
+ | * perform substitutions inside the strings of config (note that define is replacing only IDs - alphanumeric tokens not enclosed in quotes) | ||
+ | * #!subst offers an easy way to search and replace inside strings before cfg parsing. E.g.,: | ||
- | ==== $du - Destination URI ==== | + | <code c> |
+ | #!subst "/ | ||
+ | </ | ||
- | **$du** | + | |
- | If loose_route() returns TRUE a destination uri is set according to the first Route header. | + | Example: |
- | $du is also set if lookup() function of ' | + | |
- | set $du to any SIP URI. | + | |
- | sip:kamailio.org | + | |
- | | + | |
- | | + | |
- | <fc #0000ff>It is R/W variable | + | <code c> |
+ | #!subst "/DBPASSWD/ | ||
+ | modparam(" | ||
+ | </code> | ||
- | To reset $du: | + | * will do the substitution of db password in db_url parameter value |
- | $du = null; | + | |
- | ==== $fd - From URI domain | + | ==== substdef |
- | **$fd** - reference to domain in URI of ' | + | <code c> |
+ | #!substdef "/ | ||
+ | </ | ||
- | ==== $fn - From display name ==== | + | Similar to **subst**, but in addition it adds a **#!define ID subst**. |
- | **$fn** - reference to display name of ' | + | ==== substdefs ==== |
- | ==== $fs - Forced socket ==== | + | <code c> |
+ | #!substdefs "/ | ||
+ | </ | ||
- | **$fs** - reference to the forced socket | + | Similar to **subst**, but in addition it adds a **#!define ID " |
+ | ===== Core Keywords ===== | ||
- | <fc # | + | Keywords specific |
- | ==== $ft - From tag ==== | + | ==== af ==== |
- | **$ft** - reference to tag parameter | + | The address family |
- | ==== $fti - Initial From tag ==== | + | Exampe of usage: |
- | **$fti** - reference to tag parameter of ' | + | <code c> |
+ | if (af==INET6) { | ||
+ | log(" | ||
+ | } | ||
+ | </ | ||
- | The value From tag in the initial request can be in the To tag, if the request within the dialog is sent by the callee. This variable detect who sent the request within the dialog and returns the proper value that was in the From tag of the request initiating the dialog. | + | ==== dst_ip ==== |
- | It is exported by **rr** module and has to be used after loose_route(). | + | The IP of the local interface where the SIP message was received. When the proxy listens on many network interfaces, makes possible |
- | ==== $fu - From URI ==== | + | |
- | **$fu** - reference to URI of ' | + | Example |
- | <fc #0000ff>It is R/W variable | + | <code c> |
+ | | ||
+ | log(" | ||
+ | }; | ||
+ | </code> | ||
- | Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. | + | ==== dst_port |
- | ==== $fU - From URI username | + | |
- | **$fU** - reference | + | The local port where the SIP packet was received. When Kamailio is listening on many ports, it is useful |
- | <fc #0000ff>It is R/W variable | + | Example of usage: |
+ | <code c> | ||
+ | | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </code> | ||
- | Note that changing the From: header may break backwards compatibility with SIP 1.0 devices. | ||
- | ==== $mb - SIP message buffer ==== | ||
- | **$mb** - reference to SIP message buffer | + | ==== from_uri ==== |
- | ==== $mf - Flags ==== | + | This script variable is a reference to the URI of ' |
- | **$mf** - reference to message/ | + | Example of usage: |
- | <fc #0000ff>It is R/W variable | + | <code c> |
+ | if(is_method(" | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </code> | ||
- | ==== $mF - Flags in hexadecimal | + | ==== method |
- | **$mF** -reference to message/ | + | The variable is a reference to the SIP method of the message. |
- | <fc # | + | Example of usage: |
- | ==== $mi - SIP message | + | <code c> |
+ | if(method==" | ||
+ | { | ||
+ | | ||
+ | }; | ||
+ | </ | ||
- | **$mi** - reference to SIP message id | + | ==== msg:len ==== |
- | ==== $ml - SIP message | + | The variable is a reference to the size of the message. It can be used in ' |
- | **$ml** - reference to SIP message length | ||
- | ==== $mt - SIP Message Type ==== | + | Example of usage: |
+ | <code c> | ||
+ | if(msg: | ||
+ | { | ||
+ | sl_send_reply(" | ||
+ | exit; | ||
+ | }; | ||
+ | </ | ||
- | **$mt** - returns 1 if the sip message is a request, returns 2 if the sip message is a reply | ||
+ | . | ||
- | ==== $od - Domain original R-URI ==== | + | ==== proto ==== |
- | **$od** - reference | + | This variable can be used to test the transport protocol of the SIP message. |
- | ==== $op - Port in original R-URI ==== | + | Example of usage: |
+ | <code c> | ||
+ | if(proto==UDP) | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
- | **$op** - reference to port of original R-URI | + | ==== status ==== |
- | ==== $oP - Protocol | + | If used in onreply_route, |
- | **$oP** - reference to transport protocol | + | Example |
+ | <code c> | ||
+ | if(status==" | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
- | ==== $ou - Original R-URI ==== | ||
- | **$ou** - reference to request' | + | ==== snd_af ==== |
- | ==== $oU - Username in original R-URI ==== | + | ==== snd_ip |
- | **$oU** - reference to username in request' | + | ==== snd_port ==== |
- | ==== $pd - Domain in P-Preferred-Identity header URI ==== | + | ==== snd_proto |
- | **$pd** - reference to domain in request' | + | ==== src_ip ==== |
- | ==== $pn - Display Name in P-Preferred-Identity header ==== | + | Reference to source IP address of the SIP message. |
- | **$pn** - reference to Display Name in request' | + | Example of usage: |
+ | <code c> | ||
+ | if(src_ip==127.0.0.1) | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
- | ==== $pp - Process id ==== | + | ==== src_port |
- | **$pp** - reference | + | Reference |
- | ==== $pr - Protocol of received | + | Example of usage: |
+ | <code c> | ||
+ | if(src_port==5061) | ||
+ | { | ||
+ | log("message | ||
+ | } | ||
+ | </ | ||
- | **$pr** or **$proto** - protocol of received message (UDP, TCP, TLS, SCTP, WS, WSS) | + | ==== to_ip ==== |
- | ==== $pU - User in P-Preferred-Identity header URI ==== | + | ==== to_port |
- | **$pU** - reference to user in request' | + | ==== to_uri ==== |
- | ==== $pu - URI in P-Preferred-Identity | + | This variable can be used to test the value of URI from To header. |
- | **$pu** - reference to URI in request' | + | Example of usage: |
+ | <code c> | ||
+ | if(to_uri=~" | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
+ | ==== uri ==== | ||
- | ==== $rb - Body of request/reply ==== | + | This variable can be used to test the value of the request |
- | **$rb** - reference to message body | + | Example of usage: |
+ | <code c> | ||
+ | if(uri=~" | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
- | ==== $rc - Returned code ==== | ||
- | **$rc** - reference to returned code by last invoked function | ||
- | **$retcode** - same as **$rc** | + | ===== Core Values ===== |
- | ==== $rd - Domain | + | Values that can be used in ''' |
- | **$rd** - reference to domain in request' | + | ==== INET ==== |
- | <fc # | + | This keyword |
- | ==== $rdir(key) - Request Direction ==== | + | Example of usage: |
- | **$rdir(key)** - get the direction of the request within dialog. | + | <code c> |
+ | if (af==INET) { | ||
+ | log("the SIP message was received over IPv4\n" | ||
+ | } | ||
+ | </ | ||
- | The direction is ' | + | ==== INET6 ==== |
- | The key can be: | + | This keyword |
- | * id - the returned value is an integer: 1 - for direction downstream, 2 - for direction upstream | + | Example of usage: |
- | | + | <code c> |
+ | | ||
+ | { | ||
+ | log("the SIP message was received over IPv6\n" | ||
+ | }; | ||
+ | </ | ||
- | Example: | + | ==== SCTP ==== |
+ | This keyword can be used to test the value of ' | ||
+ | |||
+ | Example of usage: | ||
<code c> | <code c> | ||
- | if($rdir(name)==" | + | |
- | xlog("request | + | |
- | } | + | log("the SIP message |
+ | }; | ||
</ | </ | ||
- | The variable is exported by **rr** module and append_fromtag parameter must be enabled. The variable has to be used after loose_route() function. | + | ==== TCP ==== |
- | ==== $re - Remote-Party-ID header URI ==== | + | |
- | **$re** - reference | + | This keyword can be used to test the value of ' |
- | ==== $rm - SIP method ==== | + | Example of usage: |
+ | <code c> | ||
+ | if(proto==TCP) | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
- | **$rm** - reference to request' | + | ==== TLS ==== |
- | ==== $rmid - SIP Method ID ==== | + | This keyword can be used to test the value of ' |
- | **$rmid** - returns internal integer representation | + | Example |
+ | <code c> | ||
+ | if(proto==TLS) | ||
+ | { | ||
+ | log(" | ||
+ | }; | ||
+ | </ | ||
+ | ==== UDP ==== | ||
- | ==== $route_uri - URI in first Route header ==== | + | This keyword can be used to test the value of ' |
- | **$route_uri** - returns | + | Example of usage: |
+ | <code c> | ||
+ | if(proto==UDP) | ||
+ | { | ||
+ | log("the SIP message was received over UDP\n" | ||
+ | }; | ||
+ | </ | ||
- | ==== $rp - Port in R-URI ==== | + | ==== WS ==== |
- | **$rp** - reference | + | This keyword can be used to test the value of ' |
- | <fc #0000ff>It is R/W variable | + | Example of usage: |
+ | <code c> | ||
+ | if(proto==WS) | ||
+ | { | ||
+ | log("the SIP message was received over WS\n"); | ||
+ | }; | ||
+ | </code> | ||
- | ==== $rP - Protocol of R-URI ==== | ||
- | **$rP** - reference to transport protocol of R-URI | + | ==== WSS ==== |
- | ==== $rr - SIP reply reason phrase ==== | + | This keyword can be used to test the value of ' |
- | **$rr** - reference to reply' | + | Example of usage: |
+ | <code c> | ||
+ | if(proto==WSS) | ||
+ | { | ||
+ | log("the SIP message was received over WSS\n"); | ||
+ | }; | ||
+ | </ | ||
+ | ==== max_len ==== | ||
- | ==== $rs - SIP reply code ==== | + | Note: This command was removed. |
- | **$rs** - reference to reply' | ||
- | ==== $rt - Refer-to URI ==== | + | ==== myself |
- | **$rt** - reference to URI of refer-to header | + | This is a reference to the list of local IP addresses, hostnames and aliases that has been set in the Kamailio configuration file. This lists contain the domains served by Kamailio. |
- | ==== $ru - Request | + | The variable can be used to test if the host part of an URI is in the list. The usefulness of this test is to select the messages that has to be processed locally or has to be forwarded to another server. |
- | **$ru** - reference | + | See " |
- | <fc #0000ff>It is R/W variable | + | Example of usage: |
+ | <code c> | ||
+ | if(uri==myself) { | ||
+ | log(" | ||
+ | }; | ||
+ | </code> | ||
- | ==== $rU - Username in R-URI ==== | + | Note: You can also use the is_myself() function. |
+ | ===== Core parameters ===== | ||
- | **$rU** - reference to username in request' | + | ==== advertised_address ==== |
- | <fc #0000ff>It is R/W variable (you can assign values to it directly | + | It can be an IP address or string and represents the address advertised |
+ | address from where the request will be sent is used. | ||
- | ==== $ruid - Record internal Unique ID ==== | + | WARNING: |
+ | | ||
+ | - you can set anything here, no check is made (e.g. foo.bar will be accepted even if foo.bar doesn' | ||
- | **$ruid** - the Record internal Unique ID for the location record selected by calling registrar:lookup() | + | Example of usage: |
- | ==== $rz - URI Scheme of R-URI ==== | + | advertised_address=" |
+ | advertised_address=" | ||
- | **$rz** - returns R-URI scheme, possible values: sip, sips, tel, tels and urn, R-URI scheme parsing error should be reflected by value: none | + | Note: this option may be deprecated and removed in the near future, it is recommended to set **advertise** option for **listen** parameter. |
+ | ==== advertised_port ==== | ||
- | ==== $Ri - Received IP address ==== | + | The port advertised in Via header. If empty or not set (default value) the port from where the message will be sent is used. Same warnings as for ' |
- | **$Ri** - reference to IP address | + | Example |
- | ==== $Rp - Received port ==== | + | advertised_port=5080 |
- | **$Rp** - reference to the port where the message was received | + | Note: this option may be deprecated and removed in the near future, it is recommended to set **advertise** option for **listen** parameter. |
+ | ==== alias ==== | ||
- | ==== $sf - Script flags ==== | + | Parameter to set alias hostnames for the server. It can be set many times, each value being added in a list to match the hostname when ' |
- | **$sf** - reference | + | It is necessary to include the port (the port value used in the " |
- | ==== $sF - Script flags ==== | + | Example of usage: |
- | **$sF** - reference to script flags - hexa output | + | < |
+ | alias=other.domain.com: | ||
+ | alias=another.domain.com: | ||
+ | </ | ||
- | ==== $si - Source IP address | + | Note: the hostname has to be enclosed in between quotes if it has reserved tokens such as **forward**, |
+ | ==== async_workers | ||
- | **$si** - reference | + | Specify how many child processes (workers) |
- | ==== $sp - Source port ==== | + | Default: 0 (asynchronous framework is disabled). |
- | **$sp** - reference to the source port of the message | + | Example: |
- | ==== $stat(name) - Statistics ==== | + | < |
+ | async_workers=4 | ||
+ | </ | ||
- | **$stat(name)** - return the value of statistic item specified by ' | + | ==== async_nonblock ==== |
- | ==== $su - Source address as URI ==== | + | Set the non-block mode for the internal sockets used by default group of async workers. |
+ | Default: 0 | ||
- | **$su** - returns the representation of source address (ip, port, proto) as SIP URI. If the proto is UDP, then it is not added (being the default transport protocol). | + | Example: |
- | Its value looks like: | + | < |
+ | async_nonblock=1 | ||
+ | </ | ||
+ | |||
+ | ==== async_usleep ==== | ||
+ | |||
+ | Set the number of microseconds to sleep before trying to receive next task (can be useful when async_nonblock=1). | ||
+ | |||
+ | Default: 0 | ||
+ | |||
+ | Example: | ||
< | < | ||
- | " | + | async_usleep=100 |
- | " | + | |
</ | </ | ||
- | Note that WS and WSS are both represented by transport=ws, conforming with the IETF RFC for SIP over WebSocket. | + | ==== async_workers_group ==== |
- | ==== $sut - Source address as full URI ==== | + | Define groups of asynchronous worker processes. |
- | **$su** - returns the representation of source address (ip, port, proto) as full SIP URI. The proto UDP is added also as transport parameter. | + | Prototype: |
- | Its value looks like: | + | < |
+ | async_workers_group=" | ||
+ | </ | ||
+ | |||
+ | The attributes are: | ||
+ | |||
+ | * **name** - the group name (used by functions such as **sworker_task(name)**) | ||
+ | * **workers** - the number of processes to create for this group | ||
+ | * **nonblock** - set or not set the non-block flag for internal communication socket | ||
+ | * **usleep** - the number of microseconds to sleep before trying to receive next task (can be useful if nonblock=1) | ||
+ | |||
+ | Default: "" | ||
+ | |||
+ | Example: | ||
< | < | ||
- | "sip:ip:port;transport=proto" | + | async_workers_group="name=reg; |
</ | </ | ||
- | ==== $td - To URI Domain ==== | ||
- | **$td** - reference to domain in URI of ' | + | If the **name** is default, then it overwrites the value set by **async_workers**. |
- | ==== $tn - To display name ==== | + | See also **event_route[core: |
- | **$tn** - reference to display name of ' | + | ==== auto_aliases ==== |
- | ==== $tt - To tag ==== | + | Kamailio by default discovers all IPv4 addresses on all interfaces and does a reverse DNS lookup on these addresses to find host names. Discovered host names are added to aliases list, matching the **myself** condition. |
- | **$tt** - reference to tag parameter of ' | + | Example: |
- | ==== $tti - Initial To tag ==== | + | < |
+ | auto_aliases=no | ||
+ | </ | ||
+ | ==== auto_bind_ipv6 | ||
- | **$tti** - reference | + | When turned on, Kamailio will automatically bind to all IPv6 addresses |
- | The value To tag in the initial transaction can be in the From tag, if the request within the dialog is sent by the callee. This variable detect who sent the request within the dialog and returns the proper value that was in the To tag of the transaction initiating the dialog. | + | Example: |
- | It is exported by **rr** module and has to be used after loose_route(). The append_fromtag parameter is required to be set to 1 in order to have this variable returning the right value. | + | < |
- | ==== $tu - To URI ==== | + | auto_bind_ipv6=1 |
+ | </ | ||
- | **$tu** - reference to URI of ' | + | ==== bind_ipv6_link_local ==== |
- | ==== $tU - To URI Username ==== | + | If set to 1, try to bind also IPv6 link local addresses by discovering the scope of the interface. This apply for UDP socket for now, to be added for the other protocols. Default is 0. |
- | **$tU** - reference to username in URI of ' | + | Example: |
- | ==== $Tb - Startup timestamp | + | < |
+ | bind_ipv6_link_local=1 | ||
+ | </ | ||
+ | ==== check_via | ||
- | **$Tb** - reference to unix timestamp of the time at which kamailio was started | + | Check if the address in top most via of replies is local. Default value is 0 (check disabled). |
- | ==== $Tf - String formatted time - cached ==== | + | Example of usage: |
- | **$Tf** - reference string formatted time | + | check_via=1 |
- | Note: the system time is retrieved only once for each processed SIP message. Subsequent calls of $Tf for same SIP message will return same value. | + | ==== children ==== |
- | ==== $TF - String formatted time - current ==== | + | Number of children to fork for the UDP interfaces (one set for each interface |
- | **$TF** - reference string formatted time | + | For configuration of the TCP/TLS worker threads see the option " |
- | Note: the system time is computed for each call of $TF. Subsequent calls of $TF for same SIP message may return different values. | + | Example of usage: |
- | ==== $Ts - Unix time stamp - cached ==== | + | children=16 |
- | **$Ts** - reference to unix time stamp | + | ==== chroot ==== |
- | Note: the system | + | The value must be a valid path in the system. |
- | ==== $TS - Unix time stamp - current ==== | + | Example of usage: |
- | **$TS** - reference to unix time stamp | + | chroot=/ |
- | Note: the system time is computed for each call of $TS. Subsequent calls of $TS for same SIP message may return different values. | ||
- | ==== $ua - User agent header | + | ==== corelog |
- | **$ua** - reference | + | Set the debug level used to print some log messages from core, which might become annoying and don't represent critical errors. For example, such case is failure to parse incoming traffic from the network as SIP message, due to someone sending invalid content. |
- | ===== $avp(id) - AVPs ===== | + | Default value is -1 (L_ERR). |
- | **$avp(id)** - the value of the AVP identified by ' | + | Example |
- | **$(avp(id)[N])** - represents the value of N-th AVP identified by ' | + | < |
+ | corelog=1 | ||
+ | </ | ||
+ | ==== debug ==== | ||
- | The ' | + | Set the debug level. Higher values make Kamailio to print more debug messages. Log messages are usually sent to syslog, except if logging to stderr was activated (see [[# |
- | * " | + | The following log levels are defined: |
- | * " | + | |
- | * pseudo variable - if value of pv is integer, id is integer, if string, id is string | + | |
- | $(avp(id)[0]) can be written in shorter form as $avp(id) and $avp(s:name) as $avp(name). | + | |
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | A log message will be logged if its log-level is lower than the defined debug level. Log messages are either produced by the the code, or manually in the configuration script using log() or xlog() functions. For a production server you usually use a log value between -1 and 2. | ||
+ | |||
+ | Default value: L_WARN (debug=0) | ||
+ | |||
+ | Examples of usage: | ||
+ | |||
+ | * debug=3: print all log messages. This is only useful for debugging of problems. Note: this produces a lot of data and therefore should not be used on production servers | ||
+ | * debug=0: This will only log warning, errors | ||
+ | * debug=-6: This will disable all log messages. | ||
+ | |||
+ | Value of ' | ||
+ | kamcmd cfg.get core debug | ||
+ | kamcmd cfg.set_now_int core debug 2 | ||
+ | kamcmd cfg.set_now_int core debug -- -1 | ||
+ | |||
+ | Note: There is a difference in log-levels between Kamailio 3.x and Kamailio< | ||
+ | |||
+ | For configuration of logging of the memory manager see the parameters [[#memlog]] and [[# | ||
+ | |||
+ | Further information can also be found at: https:// | ||
+ | |||
+ | ==== description ==== | ||
+ | |||
+ | **Alias | ||
+ | |||
+ | ==== disable_core_dump ==== | ||
+ | |||
+ | Can be ' | ||
+ | |||
+ | Default value is ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | disable_core_dump=yes | ||
+ | |||
+ | ==== disable_tls ==== | ||
+ | |||
+ | **Alias name: tls_disable** | ||
+ | |||
+ | Global parameter to disable TLS support in the SIP server. Default value is ' | ||
+ | |||
+ | Note: Make sure to load the " | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | disable_tls=yes | ||
+ | |||
+ | In Kamailio TLS is implemented | ||
+ | http:// | ||
+ | ==== enable_tls ==== | ||
+ | |||
+ | **Alias | ||
+ | |||
+ | Reverse Meaning of the disable_tls parameter. See disable_tls parameter. | ||
+ | |||
+ | enable_tls=yes # enable tls support in core | ||
+ | |||
+ | ==== exit_timeout ==== | ||
+ | |||
+ | **Alias name: ser_kill_timeout** | ||
+ | |||
+ | How much time Kamailio will wait for all the shutdown procedures to complete. If this time is exceeded, all the remaining processes are immediately killed and Kamailio exits immediately (it might also generate a core dump if the cleanup part takes too long). | ||
+ | |||
+ | Default: 60 s. Use 0 to disable. | ||
+ | |||
+ | | ||
+ | |||
+ | ==== flags ==== | ||
+ | |||
+ | SIP message (transaction) flags can have string names. | ||
+ | The //name// for flags cannot be used for **branch** or **script flags**(*) | ||
- | AVPs are special variables that are attached to SIP transactions. It is a list of pairs (name, | ||
- | To delete the first AVP with name ' | ||
<code c> | <code c> | ||
- | $avp(id) = $null; | + | ... |
+ | flags | ||
+ | FLAG_ONE | ||
+ | FLAG_TWO | ||
+ | ... | ||
</ | </ | ||
- | To delete all the AVP with name ' | + | (*) The named flags feature was propagated from the source code merge back in 2008 and is not extensively tested. The recommended way of defining flags is using [[cookbooks: |
<code c> | <code c> | ||
- | $(avp(id)[*]) = $null; | + | #!define FLAG_NAME FLAG_BIT |
</ | </ | ||
- | To overwrite | + | |
+ | |||
+ | ==== force_rport ==== | ||
+ | |||
+ | yes/no: Similar to the force_rport() function, but activates symmetric response routing globally. | ||
+ | |||
+ | ==== fork ==== | ||
+ | |||
+ | If set to ' | ||
+ | |||
+ | When set to ' | ||
+ | |||
+ | Default value is 'yes'. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | fork=no | ||
+ | |||
+ | ==== fork_delay ==== | ||
+ | |||
+ | Number of usecs to wait before forking a process. | ||
+ | |||
+ | Default is 0 (don't wait). | ||
+ | |||
+ | Example of usage: | ||
<code c> | <code c> | ||
- | $(avp(id)[*]) | + | fork_delay=5000 |
</ | </ | ||
+ | ==== group ==== | ||
- | The value of an AVP can be integer or string. To assign | + | **Alias name: gid** |
+ | |||
+ | The group id to run Kamailio. | ||
+ | |||
+ | Example | ||
+ | |||
+ | group=" | ||
+ | |||
+ | ==== http_reply_parse ==== | ||
+ | |||
+ | Alias: http_reply_hack | ||
+ | |||
+ | When enabled, Kamailio | ||
+ | |||
+ | Default | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | http_reply_parse=yes | ||
+ | |||
+ | ==== ip_free_bind ==== | ||
+ | |||
+ | Alias: ipfreebind, ip_nonlocal_bind | ||
+ | |||
+ | Control if Kamailio should attempt | ||
+ | |||
+ | Default is 0 (do not bind to non local ip). | ||
Example of usage: | Example of usage: | ||
<code c> | <code c> | ||
- | $avp(x) | + | ip_free_bind |
- | $avp(x) = 2; | + | |
- | $avp(y) = " | + | |
- | if($(avp(x)[1])==1) { | + | |
- | ... | + | |
- | } | + | |
- | $(avp(x)[1]) = $null; | + | |
</ | </ | ||
- | It is R/W variable (you can assign values to it directly in configuration file). | ||
- | ===== $xavp(id) - XAVPs ===== | + | ==== ipv6_hex_style |
+ | |||
+ | Can be set to " | ||
+ | |||
+ | Default is " | ||
+ | |||
+ | " | ||
+ | |||
+ | Example of usage: | ||
- | xavp - extended AVP's - are structures that can store multiple values. They work like a stack, much like AVPs, and are attached to SIP transactions. Each xavp has a name and can contain multiple named values, the structure name and the value name are separated by ' | ||
<code c> | <code c> | ||
- | $xavp(root=> | + | ipv6_hex_style |
</ | </ | ||
+ | ==== kemi.onsend_route_callback ==== | ||
+ | |||
+ | Set the name of callback function in the KEMI script to be executed as the equivalent of `onsend_route` block (from the native configuration file). | ||
+ | |||
+ | Default value: ksr_onsend_route | ||
+ | |||
+ | Set it to empty string or " | ||
+ | |||
+ | Example: | ||
- | Like avps, xavp act like a stack. To refer to an existing value, use an index. The newest xavp has index zero [0]. | ||
<code c> | <code c> | ||
- | $xavp(root[0]=> | + | kemi.onsend_route_callback=" |
</ | </ | ||
- | If you assign a value without an index, a new xavp is allocated and the old one is pushed up the stack, becoming index [1]. Old index [1] becomes [2] etc. | + | ==== kemi.received_route_callback ==== |
+ | |||
+ | Set the name of callback function in the KEMI script to be executed as the equivalent of `event_route[core: | ||
+ | |||
+ | Default value: none | ||
+ | |||
+ | Set it to empty string or " | ||
+ | |||
+ | Example: | ||
<code c> | <code c> | ||
- | $xavp(example=> | + | kemi.received_route_callback="ksr_my_receieved_route" |
- | #create new | + | |
- | $xavp(example=> | + | |
- | #add extra value to " | + | |
- | $xavp(example[0]=> | + | |
- | #add value to first variable - " | + | |
- | $xavp(example[1]=> | + | |
</ | </ | ||
+ | ==== kemi.reply_route_callback ==== | ||
+ | |||
+ | Set the name of callback function in the KEMI script to be executed as the equivalent of `reply_route` block (from the native configuration file). | ||
+ | |||
+ | Default value: ksr_reply_route | ||
+ | |||
+ | Set it to empty string or " | ||
+ | |||
+ | Example: | ||
- | Another example: | ||
<code c> | <code c> | ||
- | # Create new xavp | + | kemi.onsend_route_callback="ksr_my_reply_route" |
- | $xavp(sf=> | + | </ |
- | #assign values | + | ==== kemi.pre_routing_callback ==== |
- | $xavp(sf[0]=> | + | |
- | $xavp(sf[0]=> | + | |
- | $xavp(sf[0]=> | + | |
- | #create new xavp, moving previous one to sf[1] | + | Set the name of callback function in the KEMI script |
- | $xavp(sf=>uri)=" | + | |
- | $xavp(sf[0]=> | + | |
- | $xavp(sf[0]=> | + | |
- | #Create a third xavp | + | Default value: none |
- | $xavp(sf=> | + | |
- | $xavp(sf[0]=> | + | Set it to empty string or "none" to skip execution of this callback function. |
- | $xavp(sf[0]=>fr_inv_timer)=15; | + | |
- | $xavp(sf[0]=> | + | Example: |
+ | |||
+ | <code c> | ||
+ | kemi.pre_routing_callback="ksr_pre_routing" | ||
</ | </ | ||
- | xavps are read and write variables. You can create multilevel xavps, as xavps may contain xavps. | + | ==== latency_cfg_log ==== |
- | ===== $hdr(name) - Headers ===== | + | If set to a log level less or equal than debug parameter, a log message with the duration in microseconds of executing request route or reply route is printed to syslog. |
+ | Default value is 3 (L_DBG). | ||
- | **$hdr(name)** - represents the body of first header identified by ' | + | Example: |
- | **$(hdr(name)[N])** - represents the body of the N-th header identified by ' | + | <code c> |
+ | latency_cfg_log=2 | ||
+ | </ | ||
- | If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. In case of a comma-separated multi-body headers, it returns all the bodies, comma-separated. To print the last header of that type, use -1, or other negative values to count from the end. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N=' | + | ==== latency_limit_action ==== |
- | The module should identify compact header names. It is recommended to use dedicated specifiers | + | Limit of latency in us (micro-seconds) |
- | Example of usage: | + | Default value is 0 (disabled). |
<code c> | <code c> | ||
- | if($hdr(From)=~" | + | latency_limit_action=500 |
- | ... | + | |
- | } | + | |
</ | </ | ||
+ | |||
+ | ==== latency_limit_db ==== | ||
- | <fc # | + | Limit of latency in us (micro-seconds) for db operations. If a db operation executed via DB API v1 takes longer that its value, a message is printed in the logs, showing the first 50 characters of the db query. |
- | ===== $var(name) - Private memory variables (zero) ===== | ||
- | **$var(name)** - refers to variables that can be used in configuration script, having integer or string value. This kind of variables are faster than AVPs, being referenced directly to memory location. | + | Default value is 0 (disabled). |
- | Example of usage: | + | <code c> |
+ | latency_limit_db=500 | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== latency_log ==== | ||
+ | |||
+ | Log level to print the messages related to latency. | ||
+ | |||
+ | |||
+ | Default value is -1 (L_ERR). | ||
<code c> | <code c> | ||
- | $var(a) | + | latency_log=3 |
- | $var(a) = " | + | </ |
- | $var(a) = " | + | |
- | $var(a) = 3 + (7& | + | |
- | if( $var(a) & 4 ) { | + | ==== listen ==== |
- | xlog("var a has third bit set\n"); | + | |
- | } | + | Set the network addresses the SIP server should listen to. It can be an IP address, hostname or network interface id or combination of protocol: |
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | listen=10.10.10.10 | ||
+ | listen=eth1: | ||
+ | | ||
</ | </ | ||
- | **Note:** Setting a variable to $null is actually initializing | + | If you omit this directive then the SIP server will listen on all interfaces. On start the SIP server reports all the interfaces that it is listening on. Even if you specify only UDP interfaces here, the server will start the TCP engine too. If you don' |
+ | |||
+ | If you specify IPv6 addresses, you should put them into square brackets, e.g.: | ||
<code c> | <code c> | ||
- | $var(x) | + | listen=udp: |
+ | </ | ||
- | if($var(x)==0) { # this is true | + | You can specify an advertise address |
- | ... | + | |
- | } | + | <code c> |
+ | listen=udp: | ||
</ | </ | ||
- | **Note:** A script variable persists over the Kamailio process in which it was initialized, | ||
- | <fc # | + | The advertise address must be the format ' |
- | **pv** module can be used to initialize | + | A typical use case for advertise address is when running SIP server behind a NAT/ |
- | ===== $vz(name) - Private memory variables (zero) ===== | + | A unique |
- | Same as $var(name) -- added to pair with $vn(name). | + | The name has to be provided as a string enclosed in between quotes after the **name** identifier. |
- | ===== $vn(name) - Private memory variables (null) ===== | + | <code c> |
+ | listen=udp: | ||
+ | listen=udp: | ||
+ | listen=udp: | ||
+ | listen=udp: | ||
+ | ... | ||
+ | $fsn = " | ||
+ | t_relay(); | ||
+ | </ | ||
- | Similar | + | Note that there is no internal check for uniqueness of the socket names, the admin has to ensure it in order to be sure the desired socket |
+ | ==== loadmodule ==== | ||
- | Example of usage: | + | Loads a module for later usage in the configuration script. The modules is searched in the path specified by **loadpath**. |
+ | Prototype: **loadmodule " | ||
+ | |||
+ | If modulepath is only modulename or modulename.so, | ||
+ | |||
+ | Example of usage: | ||
<code c> | <code c> | ||
- | $vn(x) = 1; | + | loadpath |
- | $vn(x) = "abc"; | + | |
- | $vn(x) = $null; | + | |
- | if($vn(x) == $null) { ... } | + | loadmodule "/ |
+ | loadmodule " | ||
+ | loadmodule " | ||
+ | loadmodule " | ||
</ | </ | ||
- | ===== $shv(name) - Shared memory variables ===== | ||
- | **$shv(name)** | + | ==== loadmodulex ==== |
- | Example - shv(name) pseudo-variable usage: | + | Similar to **loadmodule** with the ability to evaluate variables in its parameter. |
- | < | + | ==== loadpath ==== |
- | ... | + | |
- | modparam(" | + | |
- | ... | + | |
- | if ($shv(debug) | + | |
- | xlog(" | + | |
- | } | + | |
- | ... | + | |
- | </ | + | |
- | <fc # | + | **Alias name: mpath** |
- | ===== $time(name) | + | Set the module search path. loadpath takes a list of directories separated by ':' |
- | **$time(name)** - the PV provides access | + | This can be used to simplify the loadmodule parameter and can include many paths separated by colon. First module found is used. |
- | The ' | + | Example |
- | * sec - return seconds (int 0-59) | + | |
- | * min - return minutes (int 0-59) | + | |
- | * hour - return hours (int 0-23) | + | |
- | * mday - return the day of month (int 0-59) | + | |
- | * mon - return the month (int 1-12) | + | |
- | * year - return the year (int, e.g., 2008) | + | |
- | * wday - return the day of week (int, 1=Sunday - 7=Saturday) | + | |
- | * yday - return the day of year (int, 1-366) | + | |
- | * isdst - return daylight saving time status (int, 0 - DST off, >0 DST on) | + | |
- | + | ||
- | Example - time(name) pseudo-variable | + | |
<code c> | <code c> | ||
- | ... | + | loadpath "/ |
- | if ($time(year) == 2008) { | + | |
- | | + | |
- | } | + | |
- | ... | + | |
+ | loadmodule " | ||
+ | loadmodule " | ||
</ | </ | ||
+ | The proxy tries to find the modules in a smart way, e.g: loadmodule " | ||
+ | |||
+ | ==== local_rport ==== | ||
- | ===== $timef(format) - Strftime Formatted Time ===== | + | Similar to **add_local_rport()** function, but done in a global scope, so the function does not have to be executed for each request. |
- | **$timef(format)** - return current time as formatted by strftime ' | + | Default: off |
Example: | Example: | ||
<code c> | <code c> | ||
- | xlog(" | + | local_rport = on |
</ | </ | ||
- | ===== $sel(name) - Selects ===== | + | ==== log_engine_data |
- | **$sel(name)** - return | + | Set specific data required by the log engine. See also the **log_engine_type**. |
- | List of available selects: | + | <code c> |
- | * http://www.kamailio.org/ | + | log_engine_type=" |
+ | log_engine_data=" | ||
+ | </code> | ||
- | Example: | + | ==== log_engine_type ==== |
+ | |||
+ | Specify what logging engine to be used and its initialization data. A logging engine is implemented as a module. Supported values are a matter of the module. | ||
+ | |||
+ | For example, see the readme of **log_custom** module for more details. | ||
<code c> | <code c> | ||
+ | log_engine_type=" | ||
+ | log_engine_data=" | ||
+ | </ | ||
- | if($sel(via[1].host)=="10.10.10.10") | + | |
- | { | + | ==== log_facility ==== |
- | ... | + | |
- | } | + | If Kamailio logs to syslog, you can control the facility for logging. Very useful when you want to divert all Kamailio logs to a different log file. See the man page syslog(3) for more details. |
+ | |||
+ | For more see: http://www.kamailio.org/ | ||
+ | |||
+ | Default value is LOG_DAEMON. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | log_facility=LOG_LOCAL0 | ||
+ | |||
+ | ==== log_name ==== | ||
+ | |||
+ | Allows to configure a log_name prefix which will be used when printing to syslog -- it is also known as syslog tag, and the default value is the application name or full path that printed the log message. This is useful to filter log messages when running many instances of Kamailio on same server. | ||
+ | |||
+ | < | ||
+ | log_name=" | ||
</ | </ | ||
- | ===== Send Address Attributes ===== | ||
- | ==== $sndfrom(name) | + | ==== log_prefix |
- | **$snd(name)** - return attributes of the address from where the request is going to be sent (local socket). | + | Specify |
+ | See [[# | ||
- | **$sndfrom(name)** - return attributes of the address from where the request is going to be sent (local socket, same as $snd(name)). | ||
- | The name can have same values as for $sndto(...). | + | If a log message is printed from a part of the code executed out of routing blocks actions |
- | ==== $sndto(name) ==== | + | Example - prefix with message type (1 - request, 2 - response), CSeq and Call-ID: |
- | **$sndto(name)** - return attributes of the address to where the request is going to be sent (remote socket). | + | < |
+ | log_prefix=" | ||
+ | </ | ||
- | They are available in **onsend_route**. The name can be: | + | ==== log_prefix_mode ==== |
- | * ip - IP address of destination | + | Control if [[# |
- | * af - address family to be used to send (numeric) | + | |
- | * port - port of destination address | + | |
- | * proto - transport protocol to be used to send (numeric) | + | |
- | * buf - entire send buffer as string | + | |
- | * len - length of outgoing packet (length of above buf) | + | |
- | Example: | + | If set to 0 (default), then log prefix is evaluated when the sip message is received and then reused (recommended if the **log_prefix** has only variables that have same value for same message). This is the current behaviour of **log_prefix** evaluation. |
- | <code c> | + | If set to 1, then the log prefix is evaluated before/ |
- | onsend_route { | + | Example: |
- | | + | |
- | { | + | < |
- | ... | + | log_prefix_mode=1 |
- | } | + | |
- | } | + | |
</ | </ | ||
+ | ==== log_stderror ==== | ||
- | ===== Benchmark module Pseudo-Variables ===== | + | With this parameter you can make Kamailio to write log and debug messages to standard error. Possible values are: |
- | ==== $BM_time_diff ==== | + | - " |
- | $BM_time_diff | + | |
- | ===== Dialog module Pseudo-Variables ===== | + | - " |
- | ==== $dlg(attr) ==== | + | Default value is " |
- | Return the attribute of the current processed dialog. | + | For more see: http://www.kamailio.org/ |
- | <fc # | + | Example of usage: |
- | The ' | + | log_stderror=yes |
- | * h_id - hash id | + | |
- | * h_entry - hash entry | + | |
- | * ref - reference count | + | |
- | * state - state of dialog | + | |
- | * to_rs - To route set | + | |
- | * from_rs - From route set | + | |
- | * dflags - dialog internal flags | + | |
- | * sflags - dialog script flags | + | |
- | * callid - sip call id | + | |
- | * to_uri - To uri | + | |
- | * to_tag - To tag | + | |
- | * from_uri - From uri | + | |
- | * from_tag - From tag | + | |
- | * toroute - timeout route | + | |
- | * lifetime - timeout inteval | + | |
- | * start_ts - start timestamp | + | |
- | * to_cseq - To CSeq | + | |
- | * from_cseq - From CSeq | + | |
- | * to_contact - To contact address | + | |
- | * from_contact - From contact address | + | |
- | * to_bindaddr - To bind address | + | |
- | * from_bindaddr - From bind address | + | |
- | ==== $dlg_ctx(attr) | + | ==== cfgengine |
- | Return | + | Set the config interpreter engine for execution |
- | <fc # | + | Example of usage: |
- | The ' | + | cfgengine=" |
- | * set | + | |
- | * flags | + | |
- | * timeout_route | + | |
- | * timeout_bye | + | |
- | ==== $dlg_var(key) ==== | + | If name is " |
+ | |||
+ | The name can be the identifier of an embedded language interpreter, | ||
- | Store and retrieve custom variable for current processed dialog. | + | cfgengine " |
- | <fc # | + | ==== maxbuffer ==== |
- | The ' | + | The size in bytes not to be exceeded during the auto-probing procedure of descovering the maximum buffer size for receiving UDP messages. Default value is 262144. |
- | ===== HTable module Pseudo-Variables ===== | + | Example of usage: |
- | ==== $sht(htable=> | + | maxbuffer=65536 |
- | Access hash table entries. | + | ==== max_branches ==== |
- | <fc #0000ff>It is R/W variable, you can assign values to it directly | + | The maximum number of outgoing branches for each SIP request. |
- | The “htname” must be a hash table name defined via “htable” parameter. | + | The value has to be at least 1 and the upper limit is 31. |
- | The “key” can be: | + | Default value: 12 |
- | * static string - set of characters without pseudo-variables | + | Example |
- | * dynamic string - set of characters that include pseudo-variables. The pseudo-variables will be evaluated at runtime. | + | |
< | < | ||
- | ... | + | max_branches=16 |
- | modparam(" | + | |
- | ... | + | |
- | $sht(a=> | + | |
- | $sht(a=> | + | |
- | ... | + | |
</ | </ | ||
- | ==== $shtex(htable=> | + | ==== max_recursive_level |
- | Access hash table entry expire | + | The parameters set the value of maximum recursive calls to blocks of actions, such as sub-routes or chained IF-ELSE (for the ELSE branches). Default is 256. |
- | <fc # | + | Example of usage: |
- | The “htname” must be a hash table name defined via “htable” parameter and have auto-expire greater than 0. | + | max_recursive_level=500 |
- | The “key” can be: | ||
- | * static string - set of characters without pseudo-variables | + | ==== max_while_loops ==== |
- | * dynamic string - set of characters that include pseudo-variables. The pseudo-variables will be evaluated at runtime. | + | |
- | < | + | The parameters set the value of maximum loops that can be done within a "while". Comes as a protection to avoid infinite loops in config file execution. Default is 100. |
- | ... | + | |
- | modparam("htable", | + | |
- | ... | + | |
- | $sht(a=>$au) = 1; | + | |
- | $shtex(a=> | + | |
- | ... | + | |
- | </ | + | |
+ | Example of usage: | ||
- | ==== $shtcn(htable=> | + | max_while_loops=200 |
- | Count items matching the name by regexp. | + | ==== mcast ==== |
- | The “htname” must be a hash table name defined via “htable” parameter. | + | This parameter can be used to set the interface that should join the multicast group. This is useful if you want to **listen** on a multicast address and don't want to depend on the kernel routing |
- | The **exp** can be: | + | The parameter is reset after each **listen** parameter, so you can join the right multicast group on each interface without having to modify kernel routing beforehand. |
- | * reqexp - match by regular expression ' | + | Example of usage: |
- | * ~~regexp - match by regular expression ' | + | |
- | * ~%prefix - match by right prefix | + | |
- | * %~prefix - match by left prefix | + | |
- | * ==value - match by string value | + | |
- | * eqvalue - match by integer value | + | |
- | * * * - (two asterisks next to each other) - count all items | + | |
- | The **exp** can contain pseudo-variables. | + | mcast=" |
+ | listen=udp: | ||
+ | |||
+ | ==== mcast_loopback ==== | ||
+ | |||
+ | It can be ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | mcast_loopback=yes | ||
+ | |||
+ | ==== mcast_ttl ==== | ||
+ | |||
+ | Set the value for multicast ttl. Default value is OS specific (usually 1). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | mcast_ttl=32 | ||
+ | |||
+ | ==== memdbg ==== | ||
+ | |||
+ | **Alias name: mem_dbg** | ||
+ | |||
+ | This parameter specifies on which log level the memory debugger messages will be logged. If memdbg is active, every request (alloc, free) to the memory manager will be logged. (Note: if compile option NO_DEBUG is specified, there will never be logging from the memory manager). | ||
+ | |||
+ | Default value: L_DBG (memdbg=3) | ||
+ | |||
+ | For example, memdbg=2 means that memory debugging is activated if the debug level is 2 or higher. | ||
+ | |||
+ | debug=3 | ||
+ | memdbg=4 | ||
+ | |||
+ | debug=3 | ||
+ | memdbg=2 | ||
+ | |||
+ | Please see also [[#memlog]] and [[# | ||
+ | |||
+ | ==== memlog ==== | ||
+ | |||
+ | **Alias name: mem_log** | ||
+ | |||
+ | This parameter specifies on which log level the memory statistics will be logged. If memlog is active, Kamailio will log memory statistics on shutdown (or if requested via signal SIGUSR1). This can be useful for debugging of memory leaks. | ||
+ | |||
+ | Default value: L_DBG (memlog=3) | ||
+ | |||
+ | For example, memlog=2 means that memory statistics dumping is activated if the debug level is 2 or higher. | ||
+ | |||
+ | debug=3 | ||
+ | memlog=4 | ||
+ | |||
+ | debug=3 | ||
+ | memlog=2 | ||
+ | |||
+ | Please see also [[#memdbg]] and [[# | ||
+ | |||
+ | ==== mem_join ==== | ||
+ | |||
+ | If set to 1, memory manger (e.g., q_malloc) does join of free fragments. It is effective if MEM_JOIN_FREE compile option is defined. | ||
+ | |||
+ | It can be set via config reload framework. | ||
+ | |||
+ | Default is 1 (enabled). | ||
+ | |||
+ | <code c> | ||
+ | mem_join=1 | ||
+ | </ | ||
+ | |||
+ | To change its value at runtime, **kamcmd** needs to be used and the modules **ctl** and **cfg_rpc** loaded. Enabling it can be done with: | ||
< | < | ||
- | ... | + | kamcmd cfg.set_now_int core mem_join |
- | modparam(" | + | |
- | ... | + | |
- | $sht(a=> | + | |
- | $shtex(a=> | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $shtcv(htable=> | + | To disable, set its value to 0. |
+ | ==== mem_safety | ||
- | Count items matching | + | If set to 1, memory free operation does not call abort() for double freeing a pointer or freeing an invalid address. The server still prints |
- | The “htname” must be a hash table name defined | + | It can be set via config reload framework. |
- | The **exp** must follow same rules as for **$shtcn(...)**. | + | Default is 1 (enabled). |
- | < | + | < |
- | ... | + | mem_safety=0 |
- | modparam(" | + | |
- | ... | + | |
- | $sht(a=> | + | |
- | $shtex(a=> | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $shtinc(htable=> | + | ==== mem_status_mode |
- | Atomic increment of the value for the hash table item. | + | If set to 1, memory status dump for qm allocator will print details about used fragments. If set to 0, the dump contains only free fragments. It can be set at runtime via cfg param framework (e.g., via kamcmd). |
- | < | + | Default is 0. |
- | ... | + | |
- | modparam(" | + | < |
- | ... | + | mem_status_mode=1 |
- | $sht(a=> | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $shtdec(htable=> | + | ==== mem_summary |
- | Atomic decrement | + | Parameter to control printing |
+ | * 1 - dump all the pkg used blocks (status) | ||
+ | * 2 - dump all the shm used blocks (status) | ||
+ | * 4 - summary of pkg used blocks | ||
+ | * 8 - summary of shm used blocks | ||
+ | |||
+ | If set to 0, nothing is printed. | ||
+ | |||
+ | Default | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | mem_summary=15 | ||
+ | </ | ||
+ | |||
+ | ==== mhomed ==== | ||
+ | |||
+ | Set the server to try to locate outbound interface on multihomed host. This parameter affects the selection of the outgoing socket | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | mhomed=1 | ||
+ | |||
+ | ==== mlock_pages ==== | ||
+ | Locks all Kamailio pages into memory making it unswappable (in general one doesn' | ||
+ | |||
+ | mlock_pages = yes |no (default no) | ||
+ | |||
+ | ==== modinit_delay ==== | ||
+ | |||
+ | Number of microseconds to wait after initializing a module - useful to cope with systems where are rate limits on new connections to database or other systems. | ||
+ | |||
+ | Default value is 0 (no wait). | ||
< | < | ||
- | ... | + | modinit_delay=100000 |
- | modparam(" | + | |
- | ... | + | |
- | $sht(a=> | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ===== Memcached module Pseudo-Variables ===== | ||
- | ==== $mct(key) | + | ==== modparam |
- | Access hash table entries stored in the memcached server. | + | The modparam command will be used to set the options of the modules. |
- | <fc # | + | Example: |
- | The “key” can be: | + | modparam(" |
+ | modparam(" | ||
- | * static string - set of characters without pseudo-variables | + | See the documenation |
- | * dynamic string - set of characters that include pseudo-variables. The pseudo-variables will be evaluated at runtime. | + | |
- | When assigning values, the default expiry | + | ==== modparamx ==== |
+ | |||
+ | Similar to **modparam**, with ability to evaluate | ||
+ | ==== onsend_route_reply ==== | ||
+ | |||
+ | If set to 1 (yes, on), onsend_route block is executed for received replies that are sent out. Default is 0. | ||
+ | |||
+ | onsend_route_reply=yes | ||
+ | |||
+ | ==== open_files_limit ==== | ||
+ | |||
+ | If set and bigger than the current open file limit, Kamailio | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | open_files_limit=2048 | ||
+ | |||
+ | ==== phone2tel ==== | ||
+ | By enabling this feature, Kamailio internally treats SIP URIs with user=phone parameter as TEL URIs. If you do not want this behavior, you have to turn it off. | ||
+ | |||
+ | Default value: 1 (enabled) | ||
+ | |||
+ | phone2tel = 0 | ||
+ | |||
+ | |||
+ | ==== pmtu_discovery ==== | ||
+ | If enabled, the Don't Fragment (DF) bit will be set in outbound IP packets. | ||
+ | |||
+ | pmtu_discovery = 0 | 1 (default 0) | ||
+ | |||
+ | ==== port ==== | ||
+ | |||
+ | The port the SIP server listens to. The default value for it is 5060. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | port=5080 | ||
+ | |||
+ | ==== pv_buffer_size ==== | ||
+ | |||
+ | The size in bytes of internal buffer to print dynamic strings with pseudo-variables inside. The default value is 8192 (8kB). Please keep in mind that for xlog messages, there is a dedicated module parameter to set the internal buffer size. | ||
+ | |||
+ | Example of usage: | ||
< | < | ||
- | ... | + | pv_buffer_size=2048 |
- | $mct($au) | + | |
- | $mct($ru) = $fu; | + | |
- | $mct(test) = 1; | + | |
- | xlog(" | + | |
- | $mct(test) = null; # delete it | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $mct(key=> | + | ==== pv_buffer_slots |
- | Using this alternative format, the default | + | The number of internal buffer slots to print dynamic strings with pseudo-variables inside. The default value is 10. |
+ | |||
+ | Example of usage: | ||
< | < | ||
- | ... | + | pv_buffer_slots=12 |
- | $mct(test=>30) = 1; # set expire time to 30 seconds | + | |
- | xlog(" | + | |
- | # sleep 30 seconds | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $mcinc(key) | + | ==== pv_cache_limit |
- | Do a atomic increment operation on the value stored in memcached. You need to add a value previously. | + | The limit how many pv declarations in the cache after which an action is taken. Default |
- | <fc #0000ff>It is R/W variable, you can assign values to it directly in configuration file.</fc> | + | <code> |
+ | pv_cache_limit=1024 | ||
+ | </code> | ||
- | The “key” can be: | + | ==== pv_cache_action ==== |
- | * static string - set of characters without pseudo-variables | + | Specify what action to be done when the size of pv cache is exceeded. If 0, print an warning log message when the limit is exceeded. If 1, warning log messages is printed and the cache systems tries to drop a $sht(...) declaration. Default is 0. |
- | * dynamic string - set of characters that include pseudo-variables. The pseudo-variables will be evaluated at runtime. | + | |
< | < | ||
- | ... | + | pv_cache_action=1 |
- | $mct(cnt) | + | |
- | $mcinc(cnt) = 2; # increment by 2 | + | |
- | xlog(" | + | |
- | ... | + | |
</ | </ | ||
- | ==== $mcdec(key) | + | ==== rundir |
- | Do a atomic decrement operation on the value stored in memcached. You need to add a value previously. | + | Alias: run_dir |
- | <fc # | + | Set the folder for creating runtime files such as MI fifo or CTL unixsocket. |
- | The “key” can be: | + | Default: / |
- | * static string - set of characters without pseudo-variables | + | Example |
- | * dynamic string - set of characters that include pseudo-variables. The pseudo-variables will be evaluated at runtime. | + | |
< | < | ||
- | ... | + | rundir="/tmp" |
- | $mct(cnt) | + | |
- | $mcdec(cnt) = 2; # decrement by 2 | + | |
- | xlog("counter is now $mct(cnt)"); | + | |
- | ... | + | |
</ | </ | ||
- | ===== XMLOPS Pseudo-Variables ===== | + | ==== received_route_mode |
- | ==== $xml(name=> | + | Enable or disable the execution of event_route[core: |
- | * name - id to refer the documet | + | Default value: 0 (disabled) |
- | * spec - specifier: | + | |
- | | + | Example of usage: |
- | | + | |
+ | <code c> | ||
+ | received_route_mode=1 | ||
+ | </ | ||
+ | |||
+ | ==== reply_to_via ==== | ||
+ | |||
+ | If it is set to 1, any local reply is sent to the IP address advertised in top most Via of the request instead of the IP address from which the request was received. Default value is 0 (off). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | | ||
+ | | ||
+ | |||
+ | ==== route_locks_size ==== | ||
+ | |||
+ | Set the number of mutex locks to be used for synchronizing the execution of config script for messages sharing the same Call-Id. In other words, enables Kamailio to execute the config script sequentially for the requests and replies received within the same dialog | ||
+ | |||
+ | For smaller impact on parallel processing, its value it should be at least twice the number of Kamailio processes (all children processes). | ||
Example: | Example: | ||
- | < | + | < |
- | $xml(x=>doc) = '<? | + | route_locks_size |
- | xlog(" | + | |
- | $xml(x=> | + | |
</ | </ | ||
- | ===== TMX module Pseudo-Variables ===== | + | Note that ordering of the SIP messages can still be changed by network transmission (quite likely for UDP, especially on long distance paths) or CPU allocation for processes when executing pre-config and post-config tasks (very low chance, but not to be ruled out completely). |
+ | ==== server_id | ||
- | ==== $T_branch_idx ==== | + | A configurable unique server id that can be used to discriminate server instances within a cluster of servers when all other information, |
- | * the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is ' | + | <code c> |
+ | server_id = number | ||
+ | </ | ||
- | ==== $T_reply_ruid | + | ==== server_header |
- | * the ruid stored in the current branch | + | Set the value of Server header for replies generated by Kamailio. It must contain |
+ | Example of usage: | ||
- | ==== $T_reply_code ==== | + | <code c> |
+ | server_header=" | ||
+ | </ | ||
- | * the code of the reply, as follows: in request_route will be the last stateful sent reply; in reply_route will be the current processed reply; in failure_route will be the negative winning reply. In case of no-reply or error, ' | + | ==== server_signature ==== |
- | ==== $T_req(pv) ==== | + | This parameter controls the " |
- | * can be used in reply routes or inside | + | Example of usage: |
+ | |||
+ | | ||
+ | |||
+ | If it is enabled (default=yes) a header is generated as in the following example: | ||
+ | |||
+ | | ||
+ | |||
+ | ==== shm_force_alloc ==== | ||
+ | Tries to pre-fault all the shared memory, before starting. When " | ||
+ | |||
+ | shm_force_alloc = yes | no (default no) | ||
+ | |||
+ | ==== shm_mem_size ==== | ||
+ | |||
+ | Set shared memory size (in Mb). | ||
+ | |||
+ | shm_mem_size = 64 (default 64) | ||
+ | |||
+ | ==== sip_parser_log ==== | ||
+ | |||
+ | Log level for printing debug messages for some of the SIP parsing errors. | ||
+ | |||
+ | Default: 0 (L_WARN) | ||
+ | |||
+ | <code c> | ||
+ | sip_parser_log = 1 | ||
+ | </ | ||
+ | |||
+ | ==== sip_parser_mode ==== | ||
+ | |||
+ | Control sip parser behaviour. | ||
+ | |||
+ | If set to 1, the parser is more strict in accepting messages that have invalid headers (e.g., duplicate To or From). It can make the system safer, but loses the flexibility to be able to fix invalid messages with config operations. | ||
+ | |||
+ | If set to 0, the parser is less strict on checking validity | ||
+ | |||
+ | Default: 1 | ||
+ | |||
+ | <code c> | ||
+ | sip_parser_mode = 0 | ||
+ | </ | ||
+ | |||
+ | ==== sip_warning (noisy feedback) ==== | ||
+ | |||
+ | Can be 0 or 1. If set to 1 (default value is 0) a ' | ||
+ | The header contains several details that help troubleshooting using the network traffic dumps, but might reveal details of your network infrastructure and internal SIP routing. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | sip_warning=0 | ||
+ | |||
+ | ==== socket_workers ==== | ||
+ | |||
+ | Number of workers | ||
+ | |||
+ | * when used before **listen** on UDP or SCTP socket, it overwrites **children** or **sctp_children** value for that socket. | ||
+ | * when used before **listen** on TCP or TLS socket, it adds extra tcp workers, these handling traffic only on that socket. | ||
+ | |||
+ | The value of **socket_workers** is reset with next **listen** socket definition that is added, thus use it for each **listen** socket where you want custom number of workers. | ||
+ | |||
+ | If this parameter is not used at all, the values for **children**, | ||
+ | |||
+ | Example for udp sockets: | ||
+ | |||
+ | <code c> | ||
+ | children=4 | ||
+ | socket_workers=2 | ||
+ | listen=udp: | ||
+ | listen=udp: | ||
+ | listen=udp: | ||
+ | </ | ||
+ | |||
+ | * it will start 2 workers to handle traffic on udp: | ||
+ | |||
+ | Example for tcp sockets: | ||
+ | |||
+ | <code c> | ||
+ | children=4 | ||
+ | socket_workers=2 | ||
+ | listen=tcp: | ||
+ | listen=tcp: | ||
+ | listen=tcp: | ||
+ | </ | ||
+ | |||
+ | * it will start 2 workers to handle traffic on tcp: | ||
+ | |||
+ | ==== sql_buffer_size ==== | ||
+ | |||
+ | The size in bytes of the SQL buffer created for data base queries. For database drivers that use the core db_query library, this will be maximum size object that can be written or read from a database. Default value is 65535. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | sql_buffer_size=131070 | ||
+ | |||
+ | |||
+ | ==== statistics ==== | ||
+ | |||
+ | Kamailio has built-in support for statistics counter. This means, these counters can be increased, decreased, read and cleared. The statistics counter are defined either by the core (e.g. tcp counters), by modules (e.g. 2xx_transactions by " | ||
+ | |||
+ | The statistics counters are read/ | ||
+ | |||
+ | Following are some examples how to access statistics variables: | ||
+ | **script** | ||
< | < | ||
- | route { | + | modparam("statistics", |
- | t_on_reply("1"); | + | |
- | t_relay(); | + | |
- | } | + | |
- | onreply_route[1] | + | (if method == " |
- | | + | |
} | } | ||
+ | |||
+ | xlog(" | ||
</ | </ | ||
+ | **MI** | ||
+ | < | ||
+ | # get counter value | ||
+ | kamctl fifo get_statistics NOTIFY | ||
+ | # set counter to zero | ||
+ | kamctl fifo reset_statistics NOTIFY | ||
+ | # get counter value and then set it to zero | ||
+ | kamctl fifo clear_statistics NOTIFY | ||
- | ==== $T_rpl(pv) ==== | + | # or use the kamcmd tool |
+ | kamcmd mi get_statistics 1xx_replies | ||
+ | </ | ||
- | | + | |
- | < | + | ==== stats_name_separator ==== |
- | route { | + | |
- | | + | Specify the character used as a separator for the internal statistics' |
+ | Default value is " | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | stats_name_separator = " | ||
+ | |||
+ | ==== tos ==== | ||
+ | |||
+ | The TOS (Type Of Service) to be used for the sent IP packages (both TCP and UDP). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tos=IPTOS_LOWDELAY | ||
+ | tos=0x10 | ||
+ | tos=IPTOS_RELIABILITY | ||
+ | |||
+ | ==== udp_mtu ==== | ||
+ | Fallback to another protocol (udp_mtu_try_proto must be set also either globally or per packet) if the constructed request size is greater then udp_mtu. | ||
+ | |||
+ | RFC 3261 specified size: 1300. Default: 0 (off). | ||
+ | |||
+ | udp_mtu = number | ||
+ | |||
+ | ==== udp_mtu_try_proto ==== | ||
+ | |||
+ | If udp_mtu !=0 and udp forwarded request size (after adding all the " | ||
+ | |||
+ | **Warning:** Although RFC3261 mandates automatic transport protocol changing, enabling this feature | ||
+ | |||
+ | See also udp_mtu_try_proto(proto) function. | ||
+ | |||
+ | Default: UDP (off). Recommended: | ||
+ | |||
+ | udp_mtu_try_proto = TCP|TLS|SCTP|UDP | ||
+ | |||
+ | |||
+ | ==== uri_host_extra_chars ==== | ||
+ | |||
+ | Specify additional chars that should | ||
+ | |||
+ | <code c> | ||
+ | uri_host_extra_chars = " | ||
+ | </ | ||
+ | ==== user ==== | ||
+ | |||
+ | **Alias name: uid** | ||
+ | |||
+ | The user id to run Kamailio (Kamailio will suid to it). | ||
+ | |||
+ | Example | ||
+ | |||
+ | <code c> | ||
+ | user=" | ||
+ | </ | ||
+ | |||
+ | ==== user_agent_header ==== | ||
+ | |||
+ | Set the value of User-Agent header for requests generated by Kamailio. It must contain header name as well, but not the ending CRLF. | ||
+ | |||
+ | <code c> | ||
+ | user_agent_header=" | ||
+ | </ | ||
+ | |||
+ | ==== verbose_startup ==== | ||
+ | |||
+ | Control if printing routing tree and udp probing buffer debug messages should be printed at startup. | ||
+ | |||
+ | Default is 0 (don't print); set to 1 to get those debug messages. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | | ||
+ | </ | ||
+ | |||
+ | ==== version_table ==== | ||
+ | |||
+ | Set the name of the table holding the table version. Useful if the proxy is sharing a database within a project and during upgrades. Default value is " | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | | ||
+ | </ | ||
+ | |||
+ | ==== wait_worker1_mode ==== | ||
+ | |||
+ | Enable waiting for child SIP worker one to complete initialization, | ||
+ | |||
+ | Default: 0 (do not wait for child worker one to complete initialization). | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | wait_worker1_mode = 1 | ||
+ | </ | ||
+ | |||
+ | ==== wait_worker1_time ==== | ||
+ | |||
+ | How long to wait for child worker one to complete the initialization. In micro-seconds. | ||
+ | |||
+ | Default: 4000000 (micro-seconds = 4 seconds). | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | wait_worker1_time = 1000000 | ||
+ | </ | ||
+ | |||
+ | ==== wait_worker1_usleep ==== | ||
+ | |||
+ | How long to wait for child worker one to complete the initialization. In micro-seconds. | ||
+ | |||
+ | Default: 100000 (micro-seconds = 0.1 seconds). | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | wait_worker1_usleep = 50000 | ||
+ | </ | ||
+ | |||
+ | ==== workdir ==== | ||
+ | |||
+ | **Alias name: wdir** | ||
+ | |||
+ | The working directory used by Kamailio at runtime. You might find it useful when it comes to generating core files :) | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | | ||
+ | or | ||
+ | | ||
+ | |||
+ | ==== xavp_via_params ==== | ||
+ | |||
+ | Set the name of the XAVP of which subfields will be added as local //Via// -header parameters. | ||
+ | |||
+ | If not set, XAVP to Via header parameter manipulation is not applied (default behaviour). | ||
+ | |||
+ | If set, local Via header gets additional parameters from defined XAVP. Core flag FL_ADD_XAVP_VIA_PARAMS needs to be set¹. | ||
+ | |||
+ | Example: | ||
+ | | ||
+ | [1] See function // | ||
+ | |||
+ | ==== xavp_via_fields ==== | ||
+ | |||
+ | Set the name of xavp from where to take Via header field: address and port. | ||
+ | Use them to build local Via header. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | xavp_via_fields=" | ||
+ | |||
+ | request_route | ||
+ | | ||
+ | $xavp(customvia=> | ||
+ | $xavp(customvia=> | ||
+ | via_use_xavp_fields(" | ||
t_relay(); | t_relay(); | ||
} | } | ||
+ | </ | ||
+ | |||
+ | See function // | ||
- | failure_route[1] { | + | ===== DNS Parameters ===== |
- | | + | |
- | } | + | Note: See also file doc/dns.txt for details about Kamailio' |
+ | |||
+ | Kamailio has an internal DNS resolver with caching capabilities. If this caching resolver is activated (default setting) then the system' | ||
+ | |||
+ | ^ DNS resolver comparison | ||
+ | | Caching of resolved records | yes | no* | | ||
+ | | NAPTR/SRV lookups with correct weighting | yes | yes | | ||
+ | | DNS based failover | yes | no | | ||
+ | |||
+ | * Of course you can use the resolving name servers configured in / | ||
+ | |||
+ | If the internal resolver/ | ||
+ | dns.add_srv, | ||
+ | |||
+ | Note: During startup of Kamailio, before the internal resolver is loaded, the system resolver will be used (it will be used for queries done from module register functions or modparams fixups, but not for queries done from mod_init() or normal fixups). | ||
+ | |||
+ | Note: The dns cache uses the DNS servers configured on your server (/ | ||
+ | |||
+ | Kamailio also allows you to finetune the DNS resolver settings. | ||
+ | |||
+ | The maximum time a dns request can take (before failing) is (if dns_try_ipv6 is yes, multiply it again by 2; if SRV and NAPTR lookups are enabled, it can take even longer!): | ||
+ | |||
+ | (dns_retr_time*(dns_retr_no+1)*dns_servers_no)*(search_list_domains) | ||
+ | |||
+ | Note: During DNS lookups, the process which performs the DNS lookup blocks. To minimize the blocked time the following parameters can be used (max 2s): | ||
+ | |||
+ | | ||
+ | dns_retr_time=1 | ||
+ | dns_retr_no=1 | ||
+ | dns_use_search_list=no | ||
+ | |||
+ | ==== dns ==== | ||
+ | |||
+ | This parameter controls if the SIP server will try doing a DNS lookup on the address in the Via header of a received sip request to decide if adding a received=< | ||
+ | DNS names (instead of IPs) should have received= added, so turning dns to yes is not recommended. | ||
+ | |||
+ | Default is no. | ||
+ | |||
+ | ==== rev_dns ==== | ||
+ | |||
+ | This parameter controls if the SIP server will try doing a reverse DNS lookup on the source IP of a sip request | ||
+ | to decide if adding a received=< | ||
+ | See also dns (the effect is cumulative, both can be turned on and in that case if the DNS lookup test fails the reverse | ||
+ | DNS test will be tried). | ||
+ | Note that Vias containing DNS names (instead of IPs) should have received= added, so turning rev_dns to yes is not recommended. | ||
+ | |||
+ | |||
+ | Default is no. | ||
+ | |||
+ | ==== dns_cache_del_nonexp ==== | ||
+ | |||
+ | **Alias name: dns_cache_delete_nonexpired** | ||
+ | |||
+ | dns_cache_del_nonexp = yes | no (default: no) | ||
+ | allow deletion of non-expired records from the cache when there is no more space | ||
+ | left for new ones. The last-recently used entries are deleted first. | ||
+ | |||
+ | ==== dns_cache_rec_pref ==== | ||
+ | dns_cache_rec_pref = number (default 0) | ||
+ | dns cache record preference, determines how new DNS records are stored internally in relation to existing entries. | ||
+ | Possible values: | ||
+ | 0 - do not check duplicates | ||
+ | 1 - prefer old records | ||
+ | 2 - prefer new records | ||
+ | 3 - prefer records with longer lifetime | ||
+ | |||
+ | ==== dns_cache_flags ==== | ||
+ | dns_cache_flags = number (default 0) - | ||
+ | dns cache specific resolver flags, used for overriding the default behaviour (low level). | ||
+ | Possible values: | ||
+ | 1 - ipv4 only: only DNS A requests are performed, even if Kamailio also listens on ipv6 addresses. | ||
+ | 2 - ipv6 only: only DNS AAAA requests are performed. Ignored if dns_try_ipv6 is off or Kamailio | ||
+ | doesn' | ||
+ | 4 - prefer ipv6: try first to resolve a host name to an ipv6 address (DNS AAAA request) and only | ||
+ | if this fails try an ipv4 address (DNS A request). By default the ipv4 addresses are preferred. | ||
+ | |||
+ | ==== dns_cache_gc_interval ==== | ||
+ | Interval in seconds after which the dns cache is garbage collected (default: 120 s) | ||
+ | |||
+ | dns_cache_gc_interval = number | ||
+ | |||
+ | |||
+ | ==== dns_cache_init ==== | ||
+ | |||
+ | If off, the dns cache is not initialized at startup and cannot be enabled runtime, that saves some memory. | ||
+ | |||
+ | dns_cache_init = on | off (default on) | ||
+ | |||
+ | ==== dns_cache_max_ttl ==== | ||
+ | dns_cache_max_ttl = time in seconds (default MAXINT) | ||
+ | |||
+ | ==== dns_cache_mem ==== | ||
+ | Maximum memory used for the dns cache in KB (default 500 K) | ||
+ | |||
+ | dns_cache_mem = number | ||
+ | |||
+ | |||
+ | ==== dns_cache_min_ttl ==== | ||
+ | dns_cache_min_ttl = time in seconds (default 0) | ||
+ | |||
+ | ==== dns_cache_negative_ttl ==== | ||
+ | |||
+ | Tells how long to keep negative DNS responses in cache. | ||
+ | |||
+ | ==== dns_naptr_ignore_rfc ==== | ||
+ | |||
+ | If the DNS lookup should ignore the remote side's protocol preferences, | ||
+ | |||
+ | dns_naptr_ignore_rfc = yes | no (default yes) | ||
+ | |||
+ | ==== dns_retr_no ==== | ||
+ | |||
+ | Number of dns retransmissions before giving up. Default value is system specific, depends also on the '/ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | dns_retr_no=3 | ||
+ | |||
+ | ==== dns_retr_time ==== | ||
+ | |||
+ | Time in seconds before retrying a dns request. Default value is system specific, depends also on the '/ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | dns_retr_time=3 | ||
+ | |||
+ | ==== dns_search_full_match ==== | ||
+ | When name was resolved using dns search list, check the domain added in the answer matches with one from the search list (small performance hit, but more safe) | ||
+ | |||
+ | dns_search_full_match = yes | no (default yes) | ||
+ | |||
+ | ==== dns_servers_no ==== | ||
+ | |||
+ | How many dns servers from the ones defined in '/ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | dns_servers_no=2 | ||
+ | |||
+ | ==== dns_srv_lb ==== | ||
+ | |||
+ | **Alias name: dns_srv_loadbalancing** | ||
+ | |||
+ | Enable dns srv weight based load balancing (see doc/ | ||
+ | |||
+ | dns_srv_lb = yes | no (default no) | ||
+ | |||
+ | ==== dns_try_ipv6 ==== | ||
+ | |||
+ | Can be ' | ||
+ | for ipv6 (AAAA record). Default value is ' | ||
+ | |||
+ | Note: If dns_try_ipv6 is off, no hostname resolving that would result in an ipv6 address would succeed - it doesn' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | dns_try_ipv6=yes | ||
+ | |||
+ | ==== dns_try_naptr ==== | ||
+ | Enable NAPTR support according to RFC 3263 (see doc/dns.txt for more info) | ||
+ | |||
+ | dns_try_naptr = yes | no (default no) | ||
+ | |||
+ | ==== dns_sctp_pref, | ||
+ | |||
+ | **Alias name: dns_sctp_preference, | ||
+ | |||
+ | Set preference for each protocol when doing naptr lookups. By default dns_udp_pref=30, | ||
+ | dns_tls_pref=10 and dns_sctp_pref=20. To use the remote site preferences set all dns_*_pref to the same positive value (e.g. dns_udp_pref=1, | ||
+ | dns_tcp_pref=1, | ||
+ | preference to -1 (or any other negative number). (see doc/dns.txt for more info) | ||
+ | |||
+ | dns_{udp, | ||
+ | |||
+ | ==== dns_use_search_list ==== | ||
+ | |||
+ | Can be ' | ||
+ | |||
+ | HINT: even if you don't have a search list defined, setting this option to ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | dns_use_search_list=no | ||
+ | |||
+ | ==== use_dns_cache ==== | ||
+ | |||
+ | Tells if DNS responses are cached - this means that the internal DNS resolver | ||
+ | |||
+ | ==== use_dns_failover ==== | ||
+ | use_dns_failover = on | off (default off) | ||
+ | |||
+ | ===== TCP Parameters ===== | ||
+ | |||
+ | The following parameters allows to tweak the TCP behaviour. | ||
+ | |||
+ | ==== disable_tcp ==== | ||
+ | |||
+ | Global parameter to disable TCP support in the SIP server. Default value is ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | disable_tcp=yes | ||
+ | |||
+ | ==== tcp_accept_aliases ==== | ||
+ | |||
+ | If a message received over a tcp connection has " | ||
+ | |||
+ | Based on draft-ietf-sip-connect-reuse-00.txt, | ||
+ | |||
+ | See force_tcp_alias for more details. | ||
+ | |||
+ | Note: For NAT traversal of TCP clients it is better to not use tcp_accept_aliases but just use nathelper module and fix_nated_[contact|register] functions. | ||
+ | |||
+ | Default is "no" (off) | ||
+ | |||
+ | | ||
+ | |||
+ | ==== tcp_accept_haproxy ==== | ||
+ | |||
+ | Enable the internal TCP stack to expect a PROXY-protocol-formatted header as the first message of the connection. Both the human-readable (v1) and binary-encoded (v2) variants of the protocol are supported. This option is typically useful if you are behind a TCP load-balancer, | ||
+ | |||
+ | Please note that enabling this option will reject any inbound TCP connection that does not conform to the PROXY-protocol spec. | ||
+ | |||
+ | For reference: A PROXY protocol - https:// | ||
+ | |||
+ | Default value is **no**. | ||
+ | |||
+ | <code c> | ||
+ | tcp_accept_haproxy=yes | ||
</ | </ | ||
- | ==== $T_inv(pv) | + | ==== tcp_accept_hep3 |
- | * can be used in request routes or inside the modules | + | Enable internal TCP receiving stack to accept HEP3 packets. This option has to be set to **yes** on a Kamailio instance acting as Homer SIPCapture server that is supposed to receive HEP3 packets over TCP/TLS. |
- | < | + | Default value is **no**. |
- | route { | + | |
- | if(is_method(" | + | < |
- | { | + | tcp_accept_hep3=yes |
- | | + | |
- | { | + | |
- | # first flag is set in the INVITE transaction | + | |
- | } | + | |
- | } | + | |
- | } | + | |
</ | </ | ||
- | ==== $T(name) | + | ==== tcp_accept_no_cl |
- | | + | Control whether to throw or not error when there is no Content-Length header for requests received over TCP. It is required to be set to **yes** for XCAP traffic sent over HTTP/1.1 which does not use Content-Length header, but splits large bodies in many chunks. The module **sanity** can be used then to restrict this permission to HTTP traffic only, testing in route block in order to stay RFC3261 compliant about this mandatory header for SIP requests over TCP. |
- | The **name** can be: | + | Default value is **no**. |
- | * id_index - return the internal index of current transaction | + | <code c> |
- | * id_label - return the internal label of current transaction | + | tcp_accept_no_cl=yes |
- | * reply_code - alias to $T_reply_code | + | </ |
- | * branch_index - alias to $T_branch_idx | + | |
- | * reply_type - 1 if it is a local generated reply, 0 - if no reply for transaction or it is a received reply | + | |
- | Note: the pair (id_index, | + | ==== tcp_accept_unique ==== |
- | ==== $T_branch(name) ==== | + | If set to 1, reject duplicate connections coming from same source IP and port. |
- | * pseudo-variable class to access TM branch attributes | + | Default set to 0. |
- | The **name** can be: | + | <code c> |
+ | tcp_accept_unique = 1 | ||
+ | </ | ||
+ | ==== tcp_async ==== | ||
- | | + | **Alias name: tcp_buf_write** |
- | | + | |
+ | If enabled, all the tcp writes that would block / wait for connect to finish, will be queued and attempted latter (see also tcp_conn_wq_max and tcp_wq_max). | ||
- | ===== UAC module Pseudo-Variables ===== | + | **Note:** It also applies for TLS. |
- | ==== $uac_req(key) ==== | + | tcp_async |
+ | | ||
- | * used to build the input for uac_send_req() function of UAC module | + | ==== tcp_children ==== |
- | key can be: | + | Number of children processes to be created for reading from TCP connections. If no value is explicitly set, the same number of TCP children as UDP children (see " |
- | * method - SIP method | + | |
- | * ruri - request URI | + | Example of usage: |
- | * furi - From URI | + | |
- | * turi - To URI | + | |
- | * ouri - Outbound proxy URI | + | |
- | * hdrs - SIP Headers | + | ==== tcp_clone_rcvbuf ==== |
- | * body - Body | + | |
- | * auser - authentication username | + | Control if the received buffer should be cloned from the TCP stream, needed by functions working inside the SIP message buffer (such as msg_apply_changes()). |
- | * apasswd - authentication password | + | |
- | * sock - local socket | + | Default is 0 (don't clone), set it to 1 for cloning. |
- | * callid - SIP-Call-ID of the generated request (by default, a call-id | + | |
- | * onreply - On-REPLY-Route for this request | + | Example of usage: |
- | * all - alias useful | + | |
+ | tcp_clone_rcvbuf=1 | ||
+ | ==== tcp_connection_lifetime ==== | ||
+ | |||
+ | Lifetime in seconds for TCP sessions. TCP sessions which are inactive for longer than **tcp_connection_lifetime** will be closed | ||
+ | |||
+ | Note: As many SIP clients are behind NAT/ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tcp_connection_lifetime=3605 | ||
+ | |||
+ | ==== tcp_connection_match ==== | ||
+ | |||
+ | If set to 1, try to be more strict in matching outbound TCP connections, | ||
+ | |||
+ | Default is 0. | ||
<code c> | <code c> | ||
- | $uac_req(method)=" | + | tcp_connection_match=1 |
- | $uac_req(ruri)=" | + | |
- | $uac_req(furi)=" | + | |
- | $uac_req(turi)=" | + | |
- | uac_req_send(); | + | |
</ | </ | ||
- | ===== Nathelper module Pseudo-Variables ===== | + | ==== tcp_connect_timeout |
- | ==== $rr_count ==== | + | Time in seconds before an ongoing attempt to establish a new TCP connection will be aborted. Lower this value for faster detection of TCP connection problems. The default value is 10s. |
- | * Number | + | Example |
- | ==== $rr_top_count ==== | + | tcp_connect_timeout=5 |
- | * If topmost Record Route in received SIP request or reply is a double Record Route, value of $rr_top_count is 2. If it a single Record Route, value of $rr_top_count is 1. If there is no Record Route(s), value of $rr_top_count is 0. | + | ==== tcp_conn_wq_max ==== |
- | ===== MQueue module Pseudo-Variables ===== | + | Maximum bytes queued for write allowed per connection. Attempting to queue more bytes would result in an error and in the connection being closed (too slow). If tcp_buf_write is not enabled, it has no effect. |
- | ==== $mqk(q) | + | tcp_conn_wq_max |
+ | |||
+ | ==== tcp_crlf_ping | ||
+ | Enable SIP outbound TCP keep-alive using PING-PONG (CRLFCRLF - CRLF). | ||
- | | + | |
- | ==== $mqv(q) ==== | ||
+ | ==== tcp_defer_accept ==== | ||
- | * return | + | Tcp accepts will be delayed until some data is received (improves performance on proxies with lots of opened tcp connections). See linux tcp(7) TCP_DEFER_ACCEPT or freebsd ACCF_DATA(0). For now linux and freebsd only. |
+ | |||
+ | WARNING: | ||
+ | |||
+ | On FreeBSD: | ||
+ | tcp_defer_accept = yes | no (default no) | ||
+ | |||
+ | On Linux: | ||
+ | tcp_defer_accept = number of seconds before timeout (default disabled) | ||
+ | |||
+ | ==== tcp_delayed_ack ==== | ||
+ | Initial ACK for opened connections will be delayed and sent with the first data segment (see linux tcp(7) TCP_QUICKACK). For now linux only. | ||
+ | |||
+ | tcp_delayed_ack | ||
+ | |||
+ | ==== tcp_fd_cache ==== | ||
+ | |||
+ | If enabled FDs used for sending will be cached inside the process calling tcp_send (performance increase for sending over tcp at the cost of slightly slower connection closing and extra FDs kept open) | ||
+ | |||
+ | tcp_fd_cache = yes | no (default yes) | ||
+ | |||
+ | ==== tcp_keepalive ==== | ||
+ | Enables keepalive for tcp (sets SO_KEEPALIVE socket option) | ||
+ | |||
+ | tcp_keepalive = yes | no (default yes) | ||
+ | |||
+ | ==== tcp_keepcnt ==== | ||
+ | Number of keepalives sent before dropping the connection (TCP_KEEPCNT socket option). Linux only. | ||
+ | |||
+ | tcp_keepcnt = number (not set by default) | ||
+ | |||
+ | ==== tcp_keepidle ==== | ||
+ | |||
+ | Time before starting to send keepalives, if the connection is idle (TCP_KEEPIDLE socket option). Linux only. | ||
+ | |||
+ | tcp_keepidle | ||
+ | |||
+ | ==== tcp_keepintvl ==== | ||
+ | Time interval between keepalive probes, when the previous probe failed (TCP_KEEPINTVL socket option). Linux only. | ||
+ | |||
+ | tcp_keepintvl = seconds (not set by default) | ||
+ | |||
+ | ==== tcp_linger2 ==== | ||
+ | Lifetime of orphaned sockets in FIN_WAIT2 state (overrides tcp_fin_timeout on, see linux tcp(7) TCP_LINGER2). Linux only. | ||
+ | |||
+ | tcp_linger2 = seconds (not set by default) | ||
+ | |||
+ | ==== tcp_max_connections ==== | ||
+ | |||
+ | Maximum number of tcp connections (if the number is exceeded no new tcp connections will be accepted). Default is defined in tcp_init.h: #define DEFAULT_TCP_MAX_CONNECTIONS 2048 | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tcp_max_connections=4096 | ||
+ | |||
+ | ==== tcp_no_connect ==== | ||
+ | |||
+ | Stop outgoing TCP connects (also stops TLS) by setting tcp_no_connect to yes. | ||
+ | |||
+ | You can do this any time, even even if Kamailio is already started (in this case using the command " | ||
+ | |||
+ | ==== tcp_poll_method ==== | ||
+ | |||
+ | Poll method used (by default the best one for the current OS is selected). For available types see io_wait.c and poll_types.h: | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tcp_poll_method=select | ||
+ | |||
+ | ==== tcp_rd_buf_size ==== | ||
+ | |||
+ | Buffer size used for tcp reads. A high buffer size increases performance on server with few connections and lot of traffic on them, but also increases memory consumption (so for lots of connection is better to use a low value). Note also that this value limits the maximum message size (SIP, HTTP) that can be received over tcp. | ||
+ | |||
+ | The value is internally limited to 16MByte, for higher values recompile Kamailio with higher limit in tcp_options.c (search for " | ||
+ | |||
+ | Default: 4096, can be changed at runtime. | ||
<code c> | <code c> | ||
- | ... | + | tcp_rd_buf_size=65536 |
- | mq_add(" | + | |
- | ... | + | |
- | while(mq_fetch(" | + | |
- | { | + | |
- | | + | |
- | } | + | |
- | ... | + | |
</ | </ | ||
+ | ==== tcp_send_timeout ==== | ||
- | ===== TimeVal ===== | + | Time in seconds after a TCP connection will be closed if it is not available for writing in this interval (and Kamailio wants to send something on it). Lower this value for faster detection of broken TCP connections. The default value is 10s. |
- | ==== $TV(name) ==== | + | Example of usage: |
- | Seconds and microseconds taken from struct timeval. | + | tcp_send_timeout=3 |
- | * $TV(s) - seconds (cached at first call per sip message) | + | ==== tcp_source_ipv4, |
- | * $TV(u) - microseconds (cached at first call per sip message) | + | |
- | * $TV(sn) - seconds (not cached) | + | |
- | * $TV(un) - microseconds (not cached) | + | |
- | * $TV(Sn) - string representation seconds.microseconds (not cached) | + | |
- | ===== Next hop address | + | Set the source IP for all outbound TCP connections. If setting of the IP fails, the TCP connection will use the default IP address. |
- | ==== $nh(key) ==== | + | tcp_source_ipv4 |
+ | tcp_source_ipv6 | ||
- | Return attributes | + | ==== tcp_syncnt ==== |
+ | Number | ||
- | | + | |
- | * $nh(U) - username (upper case u) | + | |
- | * $nh(d) - domain | + | |
- | * $nh(p) - port (lower case p) | + | |
- | * $nh(P) - transport protocol (upper case p) | + | |
- | ===== GeoIP module Pseudo-Variables ===== | + | ==== tcp_wq_blk_size |
+ | Block size used for tcp async writes. It should be big enough to hold a few datagrams. If it's smaller then a datagram (in fact a tcp write()) size, it will be rounded up. It has no influenced on the number of datagrams queued (for that see tcp_conn_wq_max or tcp_wq_max). It has mostly debugging and testing value (can be ignored). | ||
- | ==== $gip(pvc=>key) ==== | + | Default: 2100 (~ 2 INVITEs), can be changed at runtime. |
- | Variables exported by GeoIP module, returning geo-location attributes. The attributes are populated upon calling function **geoip_match(ipaddr, | + | ==== tcp_wq_max ==== |
- | **pvc** (container id) is second parameter of geoip_match(..) and **key** can be: | + | Maximum bytes queued for write allowed globally. It has no effect if tcp_buf_write is not enabled. |
- | | + | |
- | | + | |
- | * zip - postal code | + | ==== tcp_reuse_port ==== |
- | * lat - latitude | + | |
- | * lon - longitude | + | |
- | * dma - dma code | + | |
- | * ips - ip start | + | |
- | * ipe - ip end | + | |
- | * city - city | + | |
- | * area - area code | + | |
- | * regc - region | + | |
- | * regn - region name | + | |
- | * metro - metro code | + | |
- | * contc - continent code | + | |
- | You can call several time **geoip_match(ipaddr, pvc)** with different ip address | + | Allows reuse of TCP ports. This means,for example, that the same TCP ports on which Kamailio is listening on, can be used as source ports of new TCP connections when acting as an UAC. Kamailio must have been compiled in a system implementing SO_REUSEPORT (Linux > 3.9.0, FreeBSD, OpenBSD, NetBSD, MacOSX). This parameter takes effect only if also the system on which Kamailio is running on supports SO_REUSEPORT. |
+ | |||
+ | tcp_reuse_port = yes (default no) | ||
+ | |||
+ | ===== TLS Parameters ===== | ||
+ | |||
+ | Most of TLS layer attributes can be configured via TLS module parameters. | ||
+ | |||
+ | ==== tls_port_no ==== | ||
+ | |||
+ | The port the SIP server listens to for TLS connections. | ||
+ | |||
+ | Default value is 5061. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tls_port_no=6061 | ||
+ | |||
+ | ==== tls_max_connections ==== | ||
+ | |||
+ | Maximum number of ls connections (if the number is exceeded no new ls connections will be accepted). It cannot exceed tcp_max_connections. | ||
+ | |||
+ | Default value is 2048. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | tls_max_connections=4096 | ||
+ | ===== SCTP Parameters ===== | ||
+ | |||
+ | ==== disable_sctp ==== | ||
+ | |||
+ | Global parameter to disable SCTP support in the SIP server. see enable_sctp | ||
+ | |||
+ | Default value is ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | disable_sctp=yes | ||
+ | |||
+ | ==== enable_sctp ==== | ||
+ | |||
+ | enable_sctp = 0/1/2 - SCTP disabled (0)/ SCTP enabled (1)/auto (2), | ||
+ | | ||
+ | |||
+ | ==== sctp_children ==== | ||
+ | sctp children no (similar to udp children) | ||
+ | sctp_children = number | ||
+ | |||
+ | ==== sctp_socket_rcvbuf ==== | ||
+ | Size for the sctp socket receive buffer | ||
+ | |||
+ | **Alias name: sctp_socket_receive_buffer** | ||
+ | |||
+ | sctp_socket_rcvbuf = number | ||
+ | |||
+ | ==== sctp_socket_sndbuf ==== | ||
+ | Size for the sctp socket send buffer | ||
+ | |||
+ | **Alias name: sctp_socket_send_buffer** | ||
+ | |||
+ | sctp_socket_sndbuf = number | ||
+ | |||
+ | ==== sctp_autoclose ==== | ||
+ | Number of seconds before autoclosing an idle association | ||
+ | $ kamcmd cfg.set_now_int sctp autoclose 120 | ||
+ | |||
+ | sctp_autoclose = seconds | ||
+ | |||
+ | ==== sctp_send_ttl ==== | ||
+ | Number of milliseconds before an unsent message/ | ||
+ | $ kamcmd cfg.set_now_int sctp send_ttl 180000 | ||
+ | |||
+ | sctp_send_ttl = milliseconds - n | ||
+ | |||
+ | ==== sctp_send_retries ==== | ||
+ | How many times to attempt re-sending a message on a re-opened association, | ||
+ | |||
+ | WARNING: use with care and low values (e.g. 1-3) to avoid " | ||
+ | |||
+ | sctp_send_retries = 1 | ||
+ | |||
+ | ==== sctp_assoc_tracking ==== | ||
+ | Controls whether or not sctp associations are tracked inside Kamailio. Turning it off would result in less memory being used and slightly better performance, | ||
+ | |||
+ | Can be changed at runtime (" | ||
+ | |||
+ | Note: turning sctp_assoc_tracking on/off will delete all the tracking information for all the currently tracked associations and might introduce a small temporary delay in the sctp processing if lots of associations were tracked. | ||
+ | |||
+ | Config options depending on sctp_assoc_tracking being on: sctp_assoc_reuse. | ||
+ | |||
+ | sctp_assoc_tracking = yes/no | ||
+ | |||
+ | ==== sctp_assoc_reuse ==== | ||
+ | Controls sctp association reuse. For now only association reuse for replies is affected by it. Default: yes. | ||
+ | Depends on sctp_assoc_tracking being on. | ||
+ | |||
+ | Note that even if turned off, if the port in via corresponds to the source port of the association the request was sent on or if rport is turned on (force_rport() or via containing a rport option), the association will be automatically reused by the sctp stack. | ||
+ | Can be changed at runtime (sctp assoc_reuse), | ||
+ | |||
+ | sctp_assoc_reuse = yes/no | ||
+ | |||
+ | ==== sctp_max_assocs ==== | ||
+ | Maximum number of allowed open sctp associations. -1 means maximum allowed by the OS. Default: -1. | ||
+ | Can be changed at runtime (e.g.: | ||
+ | |||
+ | When Kamailio tries to open a new association and the max_assocs is exceeded the exact behaviour depends on whether or not | ||
+ | sctp_assoc_tracking is on. If on, the send triggering the active open will gracefully fail, before actually opening the new association and no packet will be sent. However if sctp_assoc_tracking is off, the association will first be opened and then immediately closed. In general this means that the initial sip packet will be sent (as part of the 4-way handshake). | ||
+ | |||
+ | |||
+ | |||
+ | sctp_max_assocs = number | ||
+ | |||
+ | ==== sctp_srto_initial ==== | ||
+ | Initial value of the retr. timeout, used in RTO calculations (default: OS specific). | ||
+ | |||
+ | Can be changed at runtime (sctp srto_initial) but it will affect only new associations. | ||
+ | |||
+ | sctp_srto_initial = milliseconds | ||
+ | |||
+ | ==== sctp_srto_max ==== | ||
+ | Maximum value of the retransmission timeout (RTO) (default: OS specific). | ||
+ | |||
+ | WARNING: values lower then the sctp sack_delay will cause lots of retransmissions and connection instability (see sctp_srto_min for more details). | ||
+ | |||
+ | Can be changed at runtime (sctp srto_max) but it will affect only new associations. | ||
+ | |||
+ | sctp_srto_max = milliseconds | ||
+ | |||
+ | ==== sctp_srto_min ==== | ||
+ | Minimum value of the retransmission timeout (RTO) (default: OS specific). | ||
+ | |||
+ | WARNING: values lower then the sctp sack_delay of any peer might cause retransmissions and possible interoperability problems. According to the standard the sack_delay should be between 200 and 500 ms, so avoid trying values lower then 500 ms unless you control all the possible sctp peers and you do make sure their sack_delay is higher or their sack_freq is 1. | ||
+ | |||
+ | Can be changed at runtime (sctp srto_min) but it will affect only new associations. | ||
+ | |||
+ | sctp_srto_min = milliseconds | ||
+ | |||
+ | ==== sctp_asocmaxrxt ==== | ||
+ | Maximum retransmissions attempts per association (default: OS specific). It should be set to sctp_pathmaxrxt | ||
+ | |||
+ | Can be changed at runtime (sctp asocmaxrxt) but it will affect only new associations. | ||
+ | |||
+ | sctp_asocmaxrxt | ||
+ | |||
+ | ==== sctp_init_max_attempts ==== | ||
+ | Maximum INIT retransmission attempts (default: OS specific). | ||
+ | |||
+ | Can be changed at runtime (sctp init_max_attempts). | ||
+ | |||
+ | sctp_init_max_attempts = number | ||
+ | |||
+ | ==== sctp_init_max_timeo ==== | ||
+ | Maximum INIT retransmission timeout (RTO max for INIT). Default: OS specific. | ||
+ | |||
+ | Can be changed at runtime (sctp init_max_timeo). | ||
+ | |||
+ | sctp_init_max_timeo = milliseconds | ||
+ | |||
+ | |||
+ | ==== sctp_hbinterval ==== | ||
+ | sctp heartbeat interval. Setting it to -1 will disable the heartbeats. Default: OS specific. | ||
+ | |||
+ | Can be changed at runtime (sctp hbinterval) but it will affect only new associations. | ||
+ | |||
+ | sctp_hbinterval = milliseconds | ||
+ | |||
+ | ==== sctp_pathmaxrxt ==== | ||
+ | Maximum retransmission attempts per path (see also sctp_asocmaxrxt). Default: OS specific. | ||
+ | |||
+ | Can be changed at runtime (sctp pathmaxrxt) but it will affect only new associations. | ||
+ | |||
+ | sctp_pathmaxrxt = number | ||
+ | |||
+ | ==== sctp_sack_delay ==== | ||
+ | Delay until an ACK is generated after receiving a packet. Default: OS specific. | ||
+ | |||
+ | WARNING: a value higher then srto_min can cause a lot of retransmissions (and strange problems). A value higher then srto_max will result in very high connections instability. According to the standard the sack_delay value should be between 200 and 500 ms. | ||
+ | |||
+ | Can be changed at runtime (sctp sack_delay) but it will affect only new associations. | ||
+ | |||
+ | sctp_sack_delay = milliseconds | ||
+ | |||
+ | ==== sctp_sack_freq ==== | ||
+ | Number of packets received before an ACK is sent (without waiting for the sack_delay to expire). | ||
+ | |||
+ | Note: on linux with lksctp up to and including 1.0.9 is not possible to set this value (having it in the config | ||
+ | |||
+ | Can be changed at runtime (sctp sack_freq) but it will affect only new associations. | ||
+ | |||
+ | sctp_sack_freq = number | ||
+ | |||
+ | ==== sctp_max_burst ==== | ||
+ | Maximum burst of packets that can be emitted by an association. Default: OS specific. | ||
+ | |||
+ | Can be changed at runtime (sctp max_burst) but it will affect only new associations. | ||
+ | |||
+ | sctp_max_burst = number | ||
+ | |||
+ | |||
+ | ===== UDP Parameters ===== | ||
+ | |||
+ | ==== udp4_raw ==== | ||
+ | |||
+ | Enables raw socket support for sending UDP IPv4 datagrams (40-50% performance increase on linux multi-cpu). | ||
+ | |||
+ | Possible values: 0 - disabled (default), 1 - enabled, -1 auto. | ||
+ | |||
+ | In " | ||
+ | |||
+ | The parameter can be set at runtime as long as sr was started with enough privileges (core.udp4_raw). | ||
+ | |||
+ | < | ||
+ | udp4_raw = on | ||
+ | </ | ||
+ | |||
+ | ==== udp4_raw_mtu ==== | ||
+ | |||
+ | MTU value used for UDP IPv4 packets when udp4_raw is enabled. | ||
+ | |||
+ | The parameter can be set at runtime (core.udp4_raw_mtu). | ||
+ | |||
+ | ==== udp4_raw_ttl ==== | ||
+ | |||
+ | TTL value used for UDP IPv4 packets when udp4_raw is enabled. By default it is set to auto mode (-1), meaning that the same TTL will be used as for normal UDP sockets. | ||
+ | |||
+ | The parameter can be set at runtime (core.udp4_raw_ttl). | ||
+ | |||
+ | |||
+ | ===== Blocklist Parameters ===== | ||
+ | |||
+ | ==== dst_blocklist_expire ==== | ||
+ | |||
+ | **Alias name: dst_blocklist_ttl** | ||
+ | |||
+ | How much time a blocklisted destination will be kept in the blocklist (w/o any update). | ||
+ | |||
+ | dst_blocklist_expire = time in s (default 60 s) | ||
+ | |||
+ | ==== dst_blocklist_gc_interval ==== | ||
+ | How often the garbage collection will run (eliminating old, expired entries). | ||
+ | |||
+ | dst_blocklist_gc_interval = time in s (default 60 s) | ||
+ | |||
+ | ==== dst_blocklist_init ==== | ||
+ | If off, the blocklist is not initialized at startup | ||
+ | |||
+ | dst_blocklist_init = on | off (default on) | ||
+ | |||
+ | ==== dst_blocklist_mem ==== | ||
+ | Maximum shared memory amount used for keeping the blocklisted destinations. | ||
+ | |||
+ | dst_blocklist_mem = size in Kb (default 250 Kb) | ||
+ | |||
+ | ==== use_dst_blocklist ==== | ||
+ | Enable the destination | ||
+ | |||
+ | Note: using the blocklist incurs a small performance penalty. | ||
+ | |||
+ | See also doc/ | ||
+ | |||
+ | use_dst_blocklist = on | off (default off) | ||
+ | |||
+ | ===== Real-Time Parameters ===== | ||
+ | ==== real_time ==== | ||
+ | |||
+ | Sets real time priority for all the Kamailio processes, or the timers (bitmask). | ||
+ | | ||
+ | 1 - the " | ||
+ | 2 - the " | ||
+ | 4 - all processes, except the timers | ||
+ | | ||
+ | |||
+ | real_time = <int> (flags) (default off) | ||
+ | |||
+ | ==== rt_policy ==== | ||
+ | Real time scheduling policy, 0 = SCHED_OTHER, | ||
+ | |||
+ | rt_policy= < | ||
+ | |||
+ | ==== rt_prio ==== | ||
+ | Real time priority used for everything except the timers, if real_time is enabled. | ||
+ | |||
+ | rt_prio = <int> (default 0) | ||
+ | |||
+ | ==== rt_timer1_policy ==== | ||
+ | |||
+ | **Alias name: rt_ftimer_policy** | ||
+ | |||
+ | Like rt_policy but for the " | ||
+ | |||
+ | rt_timer1_policy=< | ||
+ | |||
+ | ==== rt_timer1_prio ==== | ||
+ | |||
+ | **Alias name: rt_fast_timer_prio, | ||
+ | |||
+ | Like rt_prio but for the " | ||
+ | |||
+ | rt_timer1_prio=< | ||
+ | |||
+ | ==== rt_timer2_policy ==== | ||
+ | |||
+ | **Alias name: rt_stimer_policy** | ||
+ | |||
+ | Like rt_policy but for the " | ||
+ | |||
+ | rt_timer2_policy=< | ||
+ | |||
+ | ==== rt_timer2_prio ==== | ||
+ | |||
+ | **Alias name: rt_stimer_prio** | ||
+ | |||
+ | Like rt_prio but for the " | ||
+ | |||
+ | rt_timer2_prio=< | ||
+ | ===== Core Functions ===== | ||
+ | |||
+ | Functions exported by core that can be used in route blocks. | ||
+ | |||
+ | ==== add_local_rport ==== | ||
+ | |||
+ | Add **rport** parameter to local generated Via header -- see RFC3581. In effect for forwarded SIP requests. | ||
+ | |||
+ | Example of usage: | ||
<code c> | <code c> | ||
- | geoip_match(" | + | add_local_rport(); |
- | geoip_match(" | + | </ |
- | if($gip(src=>cc)==$gip(dst=>cc)) | + | ==== avpflags ==== |
- | { | + | ==== break ==== |
- | # source and destination | + | |
+ | ' | ||
+ | |||
+ | ==== drop ==== | ||
+ | |||
+ | Stop the execution of the configuration script and alter the implicit action which is done afterwards. | ||
+ | |||
+ | If the function is called in a ' | ||
+ | |||
+ | If the function is called in the default ' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | onreply_route { | ||
+ | | ||
+ | drop(); # this works | ||
+ | } | ||
+ | } | ||
+ | |||
+ | onreply_route[FOOBAR] { | ||
+ | if(status==" | ||
+ | drop(); # this is ignored | ||
+ | } | ||
+ | } | ||
+ | |||
+ | ==== exit ==== | ||
+ | |||
+ | Stop the execution of the configuration script -- it has the same behaviour as return(0). It does not affect the implicit action to be taken after script execution. | ||
+ | |||
+ | route { | ||
+ | if (route(2)) { | ||
+ | xlog(" | ||
+ | } else { | ||
+ | xlog(" | ||
+ | }; | ||
+ | } | ||
+ | |||
+ | route[2] { | ||
+ | if (is_method(" | ||
+ | return(1); | ||
+ | } else if (is_method(" | ||
+ | return(-1); | ||
+ | } else if (is_method(" | ||
+ | sl_send_reply(" | ||
+ | exit; | ||
+ | }; | ||
+ | } | ||
+ | |||
+ | ==== error ==== | ||
+ | |||
+ | ==== exec ==== | ||
+ | |||
+ | ==== force_rport ==== | ||
+ | |||
+ | Force_rport() adds the rport parameter to the first Via header of the received message. Thus, Kamailio will add the received | ||
+ | |||
+ | This is useful for NAT traversal, to enforce symmetric response signaling. | ||
+ | |||
+ | The rport parameter is defined in RFC 3581. | ||
+ | |||
+ | Note: there is also a force_rport parameter which changes the gobal behavior of the SIP proxy. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | force_rport(); | ||
+ | |||
+ | ==== add_rport ==== | ||
+ | Alias for force_rport(); | ||
+ | |||
+ | ==== force_send_socket ==== | ||
+ | |||
+ | |||
+ | Force to send the message from the specified socket (it _must_ be one of the sockets specified with the " | ||
+ | |||
+ | This function does not support pseudo-variables, | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code> | ||
+ | force_send_socket(10.10.10.10: | ||
+ | force_send_socket(udp: | ||
+ | </ | ||
+ | ==== force_tcp_alias ==== | ||
+ | |||
+ | **Alias name: add_tcp_alias** | ||
+ | |||
+ | force_tcp_alias(port) | ||
+ | |||
+ | adds a tcp port alias for the current connection (if tcp). | ||
+ | Useful if you want to send all the trafic to port_alias through | ||
+ | the same connection this request came from [it could help | ||
+ | for firewall or nat traversal]. | ||
+ | With no parameters adds the port from the message via as the alias. | ||
+ | When the " | ||
+ | much time), all the port aliases are removed. | ||
+ | |||
+ | ==== forward ==== | ||
+ | |||
+ | Forward the SIP request to destination stored in $du in stateless mode. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | $du = " | ||
+ | forward(); | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== isavpflagset ==== | ||
+ | |||
+ | ==== isflagset ==== | ||
+ | |||
+ | Test if a flag is set for current processed message (if the flag value is 1). The value of the parameter can be in range of 0..31. | ||
+ | |||
+ | For more see: https:// | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | if(isflagset(3)) | ||
+ | log(" | ||
+ | | ||
+ | |||
+ | |||
+ | Kamailio also supports named flags. They have to be declared at the beginning of the config file with: | ||
+ | |||
+ | | ||
+ | |||
+ | Example: | ||
+ | flags test, a:1, b:2 ; | ||
+ | | ||
+ | setflag(test); | ||
+ | if (isflagset(a)){ | ||
+ | .... | ||
+ | } | ||
+ | resetflag(b); | ||
+ | |||
+ | ==== is_int ==== | ||
+ | Checks if a pseudo variable argument contains integer value. | ||
+ | |||
+ | if(is_int(" | ||
+ | log(" | ||
+ | } | ||
+ | |||
+ | ==== log ==== | ||
+ | |||
+ | Write text message to standard error terminal or syslog. You can specify the log level as first parameter. | ||
+ | |||
+ | For more see: http:// | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | log(" | ||
+ | |||
+ | |||
+ | ==== prefix ==== | ||
+ | |||
+ | Add the string parameter in front of username in R-URI. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | prefix(" | ||
+ | |||
+ | ==== resetavpflag ==== | ||
+ | |||
+ | ==== resetflag ==== | ||
+ | |||
+ | ==== return ==== | ||
+ | |||
+ | The return() function allows you to return any integer value from a called route() block. | ||
+ | You can test the value returned by a route using [[devel# | ||
+ | |||
+ | return(0) is same as [[devel# | ||
+ | |||
+ | In bool expressions: | ||
+ | |||
+ | * Negative is FALSE | ||
+ | * Positive is TRUE | ||
+ | |||
+ | If no value is specified, or a route reaches its end without executing a return statement, it returns 1. If return is used in the top level route is equivalent with exit [val]. | ||
+ | |||
+ | Example usage: | ||
+ | |||
+ | < | ||
+ | route { | ||
+ | if (route(2)) { | ||
+ | xlog(" | ||
+ | } else { | ||
+ | xlog(" | ||
+ | }; | ||
} | } | ||
+ | </ | ||
+ | < | ||
+ | route[2] { | ||
+ | if (is_method(" | ||
+ | return(1); | ||
+ | } else if (is_method(" | ||
+ | return(-1); | ||
+ | } else { | ||
+ | return(0); | ||
+ | }; | ||
+ | } | ||
+ | </ | ||
+ | See also the FAQ for how the function return code is evaluated: | ||
+ | |||
+ | * https:// | ||
+ | ==== revert_uri ==== | ||
+ | |||
+ | Set the R-URI to the value of the R-URI as it was when the request was received by server (undo all changes of R-URI). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | revert_uri(); | ||
+ | |||
+ | ==== rewritehostport ==== | ||
+ | |||
+ | **Alias name: sethostport, | ||
+ | |||
+ | Rewrite the domain part and port of the R-URI with the value of function' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewritehostport(" | ||
+ | |||
+ | ==== rewritehostporttrans ==== | ||
+ | |||
+ | **Alias name: sethostporttrans, | ||
+ | |||
+ | Rewrite the domain part and port of the R-URI with the value of function' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewritehostporttrans(" | ||
+ | |||
+ | ==== rewritehost ==== | ||
+ | |||
+ | **Alias name: sethost, seth** | ||
+ | |||
+ | Rewrite the domain part of the R-URI with the value of function' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewritehost(" | ||
+ | |||
+ | ==== rewriteport ==== | ||
+ | |||
+ | **Alias name: setport, setp** | ||
+ | |||
+ | Rewrites/ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewriteport(" | ||
+ | |||
+ | ==== rewriteuri ==== | ||
+ | |||
+ | **Alias name: seturi** | ||
+ | |||
+ | Rewrite the request URI. | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewriteuri(" | ||
+ | |||
+ | ==== rewriteuserpass ==== | ||
+ | |||
+ | **Alias name: setuserpass, | ||
+ | |||
+ | Rewrite the password part of the R-URI with the value of function' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewriteuserpass(" | ||
+ | ==== rewriteuser ==== | ||
+ | |||
+ | **Alias name: setuser, setu** | ||
+ | |||
+ | Rewrite the user part of the R-URI with the value of function' | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | rewriteuser(" | ||
+ | |||
+ | ==== route ==== | ||
+ | |||
+ | Execute route block given in parameter. | ||
+ | |||
+ | Examples of usage: | ||
+ | |||
+ | route(REGISTER_REQUEST); | ||
+ | route(@received.proto + " | ||
+ | |||
+ | |||
+ | ==== selval ==== | ||
+ | |||
+ | Select a value based on conditional expression. | ||
+ | |||
+ | Prototype: | ||
+ | |||
+ | <code c> | ||
+ | selval(evalexpr, | ||
</ | </ | ||
- | ===== TLS module Pseudo-Variables ===== | + | This is a core statement that return the 2nd parameter if the 1st parameter is evaluated to true, or 3rd parameter if the 1st parameter is evaluated to false. It can be considered a core function that is equivalent of ternary condition/ |
- | ==== $tls_version ==== | + | Example: |
- | ==== $tls_description ==== | + | |
- | ==== $tls_cipher_info ==== | + | |
- | ==== $tls_cipher_bits ==== | + | |
- | ==== $tls_peer_version ==== | + | |
- | ==== $tls_my_version ==== | + | |
- | ==== $tls_peer_serial ==== | + | |
- | ==== $tls_my_serial ==== | + | |
- | ==== $tls_peer_subject ==== | + | |
- | ==== $tls_peer_issuer ==== | + | |
- | ==== $tls_my_subject ==== | + | |
- | ==== $tls_my_issuer ==== | + | |
- | ==== $tls_peer_subject_cn ==== | + | |
- | ==== $tls_peer_issuer_cn ==== | + | |
- | ==== $tls_my_subject_cn ==== | + | |
- | ==== $tls_my_issuer_cn ==== | + | |
- | ==== $tls_peer_subject_locality ==== | + | |
- | ==== $tls_peer_issuer_locality ==== | + | |
- | ==== $tls_my_subject_locality ==== | + | |
- | ==== $tls_my_issuer_locality ==== | + | |
- | ==== $tls_peer_subject_country ==== | + | |
- | ==== $tls_peer_issuer_country ==== | + | |
- | ==== $tls_my_subject_country ==== | + | |
- | ==== $tls_my_issuer_country ==== | + | |
- | ==== $tls_peer_subject_state ==== | + | |
- | ==== $tls_peer_issuer_state ==== | + | |
- | ==== $tls_my_subject_state ==== | + | |
- | ==== $tls_my_issuer_state ==== | + | |
- | ==== $tls_peer_subject_organization ==== | + | |
- | ==== $tls_peer_issuer_organization ==== | + | |
- | ==== $tls_my_subject_organization ==== | + | |
- | ==== $tls_my_issuer_organization ==== | + | |
- | ==== $tls_peer_subject_unit ==== | + | |
- | ==== $tls_peer_issuer_unit ==== | + | |
- | ==== $tls_my_subject_unit ==== | + | |
- | ==== $tls_my_issuer_unit ==== | + | |
- | ==== $tls_peer_san_email ==== | + | |
- | ==== $tls_my_san_email ==== | + | |
- | ==== $tls_peer_san_hostname ==== | + | |
- | ==== $tls_my_san_hostname ==== | + | |
- | ==== $tls_peer_san_uri ==== | + | |
- | ==== $tls_my_san_uri ==== | + | |
- | ==== $tls_peer_san_ip ==== | + | |
- | ==== $tls_my_san_ip ==== | + | |
- | ===== XHTTP module Pseudo-Variables ===== | + | <code c> |
+ | $var(x) | ||
+ | </ | ||
- | ==== $hu ==== | + | The first parameter is a conditional expression, like those used for IF, the 2nd and 3rd parameters can be expressions like those used in the right side of assignments. |
+ | ==== set_advertised_address | ||
- | * URL of http request. | + | Same as ' |
- | ===== MSRP Module Pseudo Variables ===== | + | Example of usage: |
- | This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames. | + | set_advertised_address(" |
- | ==== $msrp(buf) ==== | + | |
- | The entire content of MSRP frame - first line, headers, body and end-line. | + | ==== set_advertised_port |
- | ==== $msrp(body) | + | |
- | The body of MSRP frame. | + | Same as ' |
- | ==== $msrp(code) ==== | + | |
- | The code of MSRP replies. | + | Example |
- | ==== $msrp(hdrs) ==== | + | |
- | The headers in a MSRP frame. | + | set_advertised_port(5080); |
- | ==== $msrp(msgid) ==== | + | |
- | The body of Message-Id header. | + | ==== set_forward_no_connect |
- | ==== $msrp(method) | + | |
- | The method of a MSRP request. | + | The message will be forwarded only if there is already an existing connection to the destination. It applies only to connection oriented protocols like TCP and TLS (TODO: SCTP), for UDP it will be ignored. The behavior depends in which route block the function is called: |
- | ==== $msrp(buflen) ==== | + | |
- | The length of entire MSRP frame. | + | * normal request route: affects stateless forwards and tm. For tm it affects all the branches and the possible retransmissions |
- | ==== $msrp(sessid) ==== | + | |
- | The session id for MSRP frame. It is taken from the first MSRP URI in To-Path header. | + | * onreply_route[0] |
- | ==== $msrp(reason) ==== | + | |
- | The reason text in a MSRP reply. | + | * onreply_route[!=0] < |
- | ==== $msrp(crthop) ==== | + | |
- | The URI for current hop - it is the first URI in To-Path header. | + | * branch_route: |
- | ==== $msrp(bodylen) ==== | + | |
- | The length of the body in MSRP frame. | + | * onsend_route: |
- | ==== $msrp(transid) ==== | + | Example of usage: |
- | The transaction ID from the first line of MSRP frame. | + | route { |
- | ==== $msrp(prevhop) ==== | + | ... |
+ | if (lookup()) { | ||
+ | //requests to local users. They are usually behind NAT so it does not make sense to try | ||
+ | //to establish a new TCP connection | ||
+ | set_forward_no_connect(); | ||
+ | t_relay(); | ||
+ | } | ||
+ | ... | ||
+ | } | ||
- | The MSRP URI of the previous hop - the first address in From-Path header. | + | ==== set_forward_close |
- | ==== $msrp(nexthop) | + | |
- | The URI of the next hop - the second address in To-Path header. | + | Try to close the connection (the one on which the message is sent out) after forwarding the current message. Can be used in same route blocks as set_forward_no_connect(). |
- | ==== $msrp(lasthop) ==== | + | |
- | The last hop URI - the last address in To-Path header. | + | Note: Use with care as you might not receive |
- | ==== $msrp(srcaddr) ==== | + | |
- | The address of the previous hop set as MSRP URI using received source IP and port. | ||
- | ==== $msrp(srcsock) ==== | ||
- | The local socket where the MSRP frame was received, set as **proto: | + | ==== set_reply_no_connect |
- | ==== $msrp(firsthop) | + | |
- | The URI of the first hop - the last address in From-Path header. | + | Like set_forward_no_connect(), |
- | ==== $msrp(prevhops) ==== | + | |
- | The number of previous hops - it is the number of addresses in From-Path header. | + | * normal request route: affects all replies sent back on the transaction |
- | ==== $msrp(nexthops) ==== | + | |
- | The number of next hops - it is the number of addresses in To-Path header minus 1 (the first address | + | * onreply_route: |
- | ==== $msrp(conid) ==== | + | * branch_route: |
- | The internal integer id for TCP/TLS connection. | + | * onsend_route: |
- | ===== SIPT module Pseudo-Variables ===== | ||
- | ==== $sipt(calling_party_number.presentation) / $sipt_presentation ==== | + | Example |
- | Returns the value of the Address presentation restricted indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header. | + | |
- | ==== $sipt(calling_party_number.screening) / $sipt_screening ==== | + | route[4] { |
- | Returns the value of the Screening Indicator contained in the Calling Party Number header of the IAM message if it exists. Returns -1 if there isn't a Calling Party Number header. | + | //requests from local users. There are usually behind NAT so it does not make sense to try |
+ | //to establish a new TCP connection for the replies | ||
+ | set_reply_no_connect(); | ||
+ | | ||
+ | ... | ||
+ | } | ||
- | ==== | + | ==== set_reply_close |
- | Returns the value of the Hop Counter for the IAM message if it exists. Returns -1 if there isn't a hop counter. | + | |
- | ==== $sipt(calling_party_category) / $sipt(cpc) / $sipt_cpc ==== | + | Like set_reply_no_connect, |
- | Returns | + | |
- | ==== $sipt(calling_party_number.nature_of_address) / $sipt.(calling_party_number.nai) / $sipt_calling_party_nai ==== | + | Example |
- | Returns the value of the Nature of Address Indicator of the Calling Party for the IAM message. Returns -1 if there is a parsing error or if the Calling Party Number is not present. | + | |
- | ==== $sipt(called_party_number.nature_of_address) / $sipt(called_party_number.nai) / $sipt_called_party_nai ==== | + | route { |
- | Returns | + | |
+ | if (...caller-is-not-registered...) { | ||
+ | | ||
+ | // if request was received via TCP/TLS close the connection, as | ||
+ | // this may trigger re-registration | ||
+ | set_reply_close(); | ||
+ | sl_send_reply(" | ||
+ | exit; | ||
+ | } | ||
+ | | ||
+ | } | ||
- | ==== $sipt(event_info) === | ||
- | Returns the value of the Event Info header of the CPG message. Returns -1 if there is a parsing error. | ||
- | ===== $cfg(key) - Config File Attributes ===== | + | ==== setavpflag |
- | Attributes related to configuration file. | + | ==== setflag ==== |
- | The key can be: | + | Set a flag for current processed message. |
- | * line - return current line in config | + | For more see: https:// |
- | * name - return | + | |
+ | Example of usage: | ||
+ | |||
+ | setflag(3); | ||
+ | |||
+ | ==== strip ==== | ||
+ | |||
+ | Strip the first N-th characters from username of R-URI (N is the value of the parameter). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | strip(3); | ||
+ | |||
+ | ==== strip_tail ==== | ||
+ | |||
+ | Strip the last N-th characters from username of R-URI (N is the value of the parameter). | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | strip_tail(3); | ||
+ | |||
+ | ==== udp_mtu_try_proto(proto) ==== | ||
+ | |||
+ | | ||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | if($rd==" | ||
+ | udp_mtu_try_proto(SCTP); | ||
+ | </ | ||
+ | |||
+ | ==== userphone ==== | ||
+ | |||
+ | Add " | ||
+ | |||
+ | ===== Custom Global Parameters ===== | ||
+ | |||
+ | These are parameters that can be defined by the writer | ||
+ | |||
+ | The definition of a custom global parameter must follow the pattern: | ||
+ | |||
+ | < | ||
+ | group.variable = value desc " | ||
+ | |||
+ | </ | ||
+ | |||
+ | The value can be a quoted string or integer number. | ||
Example: | Example: | ||
<code c> | <code c> | ||
- | send_reply("404", "Not found at line $cfg(line)"); | + | pstn.gw_ip = "1.2.3.4" |
</ | </ | ||
- | ===== $dns(pvid=> | + | The custom global parameter can be accessed inside a routing block via: |
- | This variable stores the DNS result details after a call of dns_query(hostname, pvid) function from ipops module. | + | < |
+ | $sel(cfg_get.group.variable) | ||
+ | </ | ||
- | * pvid can be any string | + | Example: |
- | * key can be: | + | |
- | * count - number of addresses | + | |
- | * ipv4 - set to 1 if at least one ipv4 address (otherwise 0) | + | |
- | * ipv6 - set to 1 if at least one ipv6 address (otherwise 0) | + | |
- | * addr[index] - the address as string from position index in the list (0 based indexing) | + | |
- | * type[index] - the type of address from position index in the list (0 based indexing), the value is 4 for ipv4 and 6 for ipv6 | + | |
- | The index can be an integer | + | <code c> |
+ | $ru = " | ||
+ | </ | ||
+ | |||
+ | **Note:** Some words cannot | ||
+ | |||
+ | ===== Routing Blocks ===== | ||
+ | |||
+ | The routing blocks are the parts of the configuration file executed by kamailio at runtime. They can be seen as blocks of actions similar to functions (or procedures) from common programming languages. | ||
+ | |||
+ | A routing block is identified by a specific token, followed by a name in between square brackets and actions in between curly braces. | ||
<code c> | <code c> | ||
- | if(dns_query("test.com", | + | route_block_id[NAME] { |
- | { | + | ACTIONS |
- | | + | } |
- | | + | </ |
- | | + | |
- | | + | The name can be any alphanumeric string, with specific routing blocks enforcing a particular format. |
- | while($var(i)& | + | |
- | xlog(" #[$var(i)] type ($dns(xyz=> | + | <fc # |
- | " addr [$dns(xyz=>addr[$var(i)])]\n"); | + | |
- | $var(i) = $var(i) + 1; | + | Route blocks can be executed on network events (e.g., receiving a SIP message), timer events (e.g., retransmission timeout) or particular events specific to modules. |
+ | |||
+ | There can be so called sub-route blocks, which can be invoked from another route blocks, like a function. Invocation is done with ' | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | request_route{ | ||
+ | | ||
+ | route("test"); | ||
+ | | ||
+ | } | ||
+ | |||
+ | route["test"]{ | ||
+ | | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== request_route ==== | ||
+ | |||
+ | Request routing block - is executed for each SIP request. | ||
+ | |||
+ | It contains a set of actions to be executed for SIP requests received from the network. It is the equivalent of *main()* function for handling the SIP requests. | ||
+ | |||
+ | <fc #4682b4>For backward compatibility reasons, the main request ' | ||
+ | |||
+ | The implicit action after execution of the main route block is to drop the SIP request. To send a reply or forward the request, explicit actions | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | <code c> | ||
+ | request_route { | ||
+ | if(is_method(" | ||
+ | # send reply for each options request | ||
+ | sl_send_reply(" | ||
+ | exit(); | ||
+ | } | ||
+ | route(FWD); | ||
} | } | ||
+ | route[FWD] { | ||
+ | # forward according to uri | ||
+ | | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== route ==== | ||
+ | |||
+ | This block is used to define ' | ||
+ | |||
+ | The definition of the sub-route block follows the general rules, with a name in between square brackets and actions between curly braces. A sub-route can return an integer value back to the routing block that executed it. The return code can be retrieved via $rc variables. | ||
+ | |||
+ | Evaluation of the return of a subroute is done with following rules: | ||
+ | * negative value is evaluated as false | ||
+ | * 0 - is interpreted as **exit** | ||
+ | * positive value is evaluated as true | ||
+ | |||
+ | |||
+ | <code c> | ||
+ | request_route { | ||
+ | if(route(POSITIVE)) { | ||
+ | xlog(" | ||
+ | } | ||
+ | if( ! route(NEGATIVE)) { | ||
+ | xlog(" | ||
+ | } | ||
+ | if( route(ZERO)) { | ||
+ | xlog(" | ||
+ | } | ||
+ | } | ||
+ | |||
+ | route[POSITIVE] { | ||
+ | return 10; | ||
+ | } | ||
+ | |||
+ | route[NEGATIVE] { | ||
+ | return -8; | ||
+ | } | ||
+ | |||
+ | route[ZERO] { | ||
+ | return 0; | ||
} | } | ||
</ | </ | ||
- | ===== $HN(key) | + | A sub-route can execute another sub-route. There is a limit to the number of recursive levels, avoiding ending up in infinite loops -- see **max_recursive_level** global parameter. |
- | Give local hostname details (implemented by ipops module). | + | The sub-route blocks allow to make the configuration file modular, simplifying the logic and helping to avoid duplication of actions. |
+ | ==== branch_route ==== | ||
- | The key can be: | + | Request' |
- | * n - the hostname | + | |
- | * f - the fullname | + | Example of usage: |
- | * d - the domain | + | |
- | * i - the ip address | + | |
<code c> | <code c> | ||
- | xlog("local hostanme is $HN(n)\n"); | + | request_route { |
+ | lookup("location" | ||
+ | t_on_branch(" | ||
+ | if(!t_relay()) { | ||
+ | sl_send_reply(" | ||
+ | } | ||
+ | } | ||
+ | branch_route[OUT] { | ||
+ | if(uri=~" | ||
+ | # discard branches that go to 10.10.10.10 | ||
+ | drop(); | ||
+ | } | ||
+ | } | ||
</ | </ | ||
- | ===== $RANDOM - Random number ===== | + | ==== failure_route |
- | Returns | + | Failed transaction routing block. It contains |
- | (Part of the cfgutils module) | + | Note that in ' |
+ | |||
+ | |||
+ | Example of usage: | ||
<code c> | <code c> | ||
- | if (rand_event()) { | + | request_route { |
- | $avp(i:10) = ($RANDOM / 16777216); # 2^24 | + | lookup(" |
- | if ($avp(i:10) < 10) { | + | t_on_failure(" |
- | $avp(i:10) = 10; | + | |
+ | | ||
+ | } | ||
+ | } | ||
+ | failure_route[TOVOICEMAIL] { | ||
+ | | ||
+ | # call failed - relay to voice mail | ||
+ | | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== reply_route ==== | ||
+ | |||
+ | Main SIP response (reply) handling block - it contains a set of actions to be executed for SIP replies. It is executed for all replies received from the network. | ||
+ | |||
+ | It does not have a name and it is executed by the core, before any other module handling the SIP reply. It is triggered only by SIP replies received on the network. | ||
+ | |||
+ | There is no network route that can be enforced for a SIP reply - it is sent based on Via header, according to SIP RFC3261 - therefore no dedicated actions for forwarding the reply must be used in this block. | ||
+ | |||
+ | This routing block is optional, if missing, the SIP reply is sent to the address in 2nd Via header. | ||
+ | |||
+ | One can decide to drop a SIP reply by using **drop** action. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code c> | ||
+ | reply_route { | ||
+ | if(status==" | ||
+ | drop; | ||
} | } | ||
- | append_to_reply(" | + | } |
- | sl_send_reply(" | + | |
- | exit; | + | |
- | }; | + | |
- | # normal message processing follows | + | |
</ | </ | ||
- | ===== JSONRPC-S Variables ===== | + | <fc # |
- | ==== $jsonrpl(key) - JSONRPC Reply ==== | + | ==== onreply_route |
- | This variable gives access to JSONRPC reply after executing jsonrpc_exec(...) in kamailio.cfg. | ||
- | The key can be: | + | SIP reply routing block executed by **tm** module. It contains a set of actions to be taken for SIP replies in the contect |
- | | + | |
- | | + | |
- | * body - the body of the JSONRPC response | + | |
- | ===== Presence Module Pseudo-Variables ===== | + | The ' |
- | ==== $subs(key) - Subscription Attributes ==== | + | Core ' |
- | This variable gives access to attributes of the current subscription. The variable has to be used after executing // | + | <code c> |
+ | request_route { | ||
+ | lookup(" | ||
+ | t_on_reply(" | ||
+ | if(!t_relay()) { | ||
+ | sl_send_reply(" | ||
+ | } | ||
+ | } | ||
- | The key can be: | + | reply_route { |
- | * uri - subscription URI. Useful in particular for subscriptions within the dialog, when the request URI in SUBSCRIBE is the Contact address from the initial subscription. | + | |
- | ===== $C(xy) - Foreground and background colors ===== | + | drop; |
+ | } | ||
+ | } | ||
+ | onreply_route[LOGRPL] { | ||
+ | if(status=~" | ||
+ | | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | ==== onsend_route ==== | ||
- | $C(xy) - reference to an escape sequence. “x” represents | + | The route is executed in when a SIP request is sent out. Only a limited number of commands are allowed (drop, if + all the checks, msg flag manipulations, |
- | Colors could be: | + | In this route the final destination of the message is available and can be checked (with snd_ip, snd_port, to_ip, to_port, snd_proto, snd_af). |
- | * x : default color of the terminal | + | This route is executed only when forwarding requests - it is not executed for replies, retransmissions, |
- | * s : Black | + | |
- | * r : Red | + | |
- | * g : Green | + | |
- | * y : Yellow | + | |
- | * b : Blue | + | |
- | * p : Purple | + | |
- | * c : Cyan | + | |
- | * w : White | + | |
+ | Example: | ||
+ | <code c> | ||
+ | onsend_route { | ||
+ | if(to_ip==1.2.3.4 && !isflagset(12)){ | ||
+ | log(1, " | ||
+ | drop; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | * snd_ip, snd_port - behave like src_ip/ | ||
+ | * to_ip, to_port - like above, but contain the ip/port the message will be sent to (not to be confused with dst_ip/ | ||
+ | * snd_proto, snd_af - behave like proto/af but contain the protocol/ | ||
+ | * msg:len - when used in an onsend_route, | ||
- | ===== Examples ===== | + | ==== event_route |
+ | Generic type of route executed when specific events happen. | ||
- | A few examples | + | Prototype: event_route[groupid: |
+ | * groupid - should be the name of the module that triggers the event | ||
+ | * eventid - some meaningful short text describing the event | ||
+ | |||
+ | === Core Event Routes === | ||
+ | |||
+ | Implementations: | ||
+ | |||
+ | * **event_route[core: | ||
+ | * note that due to forking, other sip workers can get faster to listening for sip traffic | ||
- | Example 1. Pseudo-variables usage | ||
<code c> | <code c> | ||
- | ... | + | event_route[core:worker-one-init] |
- | avp_aliases=" | + | xlog("L_INFO","Hello world\n"); |
- | ... | + | |
- | route { | + | |
- | ... | + | |
- | $avp(uuid)="caller_id"; | + | |
- | $avp(i:20)= $avp(uuid) + ": " + $fu; | + | |
- | xdbg(" | + | |
- | ... | + | |
} | } | ||
+ | </ | ||
+ | |||
+ | * **event_route[core: | ||
+ | * it has to be enabled with received_route_mode global parameter. For usage via Kemi, set kemi.received_route_callback global parameter. | ||
+ | * if drop is executed, the received message is no longer processed | ||
+ | |||
+ | <code c> | ||
+ | event_route[core: | ||
+ | xlog(" | ||
+ | if($rcv(srcip) == " | ||
+ | drop; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | * **event_route[core: | ||
+ | * if drop is used, then the message is not processed further with request_route or reply_route in the same process. This can be useful together with sworker module which can delegate the processing to another worker. | ||
+ | |||
+ | <code c> | ||
+ | async_workers_group=" | ||
... | ... | ||
+ | event_route[core: | ||
+ | xinfo(" | ||
+ | if(is_method(" | ||
+ | # delegate processing of REGISTERs to a special group of workers | ||
+ | if(sworker_task(" | ||
+ | drop; | ||
+ | } | ||
+ | } | ||
+ | } | ||
</ | </ | ||
- | ==== Request-URI and Destination-URI parsing ==== | + | * ** event_route[core: |
+ | * note that the SIP message is broken in this case, but it gets access to source and local socket addresses (ip, port, proto, af) as well as the whole message buffer and its size | ||
- | Following | + | <code c> |
+ | event_route[core: | ||
+ | xlog(" | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | === Module Event Routes === | ||
+ | |||
+ | Here are only a few examples, to see if a module exports event_route blocks | ||
+ | |||
+ | |||
+ | * **event_route[htable: | ||
+ | <code c> | ||
+ | modparam(" | ||
+ | |||
+ | event_route[htable: | ||
+ | $sht(a=> | ||
+ | $sht(a=> | ||
+ | } | ||
+ | |||
+ | request_route { | ||
+ | if(is_method(" | ||
+ | { | ||
+ | switch($rd) { | ||
+ | case " | ||
+ | lock(" | ||
+ | $sht(a=> | ||
+ | $sht(a=> | ||
+ | unlock(" | ||
+ | if($sht(a=> | ||
+ | { | ||
+ | | ||
+ | | ||
+ | } | ||
+ | break; | ||
+ | ... | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | * **event_route [tm:local-request]** - executed on locally generated requests. | ||
+ | <code c> | ||
+ | event_route [tm: | ||
+ | xlog(" | ||
+ | t_set_fr(10000, | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | * **event_route [tm: | ||
+ | <code c> | ||
+ | request_route { | ||
+ | ... | ||
+ | t_on_branch_failure(" | ||
+ | t_relay(); | ||
+ | } | ||
+ | |||
+ | event_route[tm: | ||
+ | xlog(" | ||
+ | if (t_check_status(" | ||
+ | unregister(" | ||
+ | if (t_next_contact_flow()) { | ||
+ | t_relay(); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | ===== Script Statements ===== | ||
+ | |||
+ | ==== if ==== | ||
+ | IF-ELSE statement | ||
+ | |||
+ | Prototype: | ||
< | < | ||
- | === Request URI contains SIP URI === | + | if(expr) { |
- | $ru = " | + | actions; |
- | $rz = " | + | } else { |
- | $rU = "<null>" | + | |
- | $rd = " | + | } |
- | $rp = " | + | </code> |
- | $rP = " | + | |
- | === Request URI contains SIP URI === | + | The ' |
- | $ru = " | + | |
- | $rz = " | + | |
- | $rU = " | + | |
- | $rd = " | + | |
- | $rp = " | + | |
- | $rP = " | + | |
- | === Request URI contains service URN === | + | The logical operators that can be used in ' |
- | $ru = "urn:service: | + | |
- | $rz = " | + | |
- | $rU = " | + | |
- | $rd = " | + | |
- | $rp = " | + | |
- | $rP = " | + | |
- | === Request URI contains tel: URI === | + | < |
- | $ru = "tel:+1-201-555-0123" | + | |
- | $rz = "tel" | + | != not equal |
- | $rU = "+1-201-555-0123" | + | =~ regular expression matching: Note: Posix regular expressions will be used, e.g. use [[: |
- | | + | !~ regular expression not-matching (NOT PORTED from Kamailio 1.x, use '!(x =~ y)') |
- | $rp = " | + | > |
- | | + | >= greater or equal |
+ | < | ||
+ | <= less or equal | ||
+ | && | ||
+ | || logical OR | ||
+ | ! | ||
+ | </ | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | if(is_method(" | ||
+ | { | ||
+ | log(" | ||
+ | } else { | ||
+ | log(" | ||
+ | } | ||
+ | |||
+ | See also the FAQ for how the function return code is evaluated: | ||
+ | |||
+ | * https:// | ||
+ | ==== switch ==== | ||
+ | |||
+ | SWITCH statement - it can be used to test the value of a pseudo-variable. | ||
+ | |||
+ | IMPORTANT NOTE: ' | ||
+ | |||
+ | |||
+ | Example of usage: | ||
+ | < | ||
+ | route { | ||
+ | route(1); | ||
+ | switch($retcode) | ||
+ | { | ||
+ | case -1: | ||
+ | log(" | ||
+ | break; | ||
+ | case 1: | ||
+ | log(" | ||
+ | break; | ||
+ | case 2: | ||
+ | case 3: | ||
+ | log(" | ||
+ | break; | ||
+ | default: | ||
+ | log(" | ||
+ | } | ||
+ | |||
+ | # switch of R-URI username | ||
+ | switch($rU) | ||
+ | { | ||
+ | case " | ||
+ | log(" | ||
+ | break; | ||
+ | case " | ||
+ | log(" | ||
+ | break; | ||
+ | case " | ||
+ | case " | ||
+ | log(" | ||
+ | break; | ||
+ | default: | ||
+ | log(" | ||
+ | } | ||
+ | } | ||
+ | |||
+ | route[1]{ | ||
+ | if(is_method(" | ||
+ | { | ||
+ | return(-1); | ||
+ | }; | ||
+ | if(is_method(" | ||
+ | return(1); | ||
+ | } | ||
+ | if(is_method(" | ||
+ | return(2); | ||
+ | } | ||
+ | if(is_method(" | ||
+ | return(3); | ||
+ | } | ||
+ | return(-2); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | NOTE: take care while using ' | ||
+ | |||
+ | |||
+ | ==== while ==== | ||
+ | |||
+ | while statement | ||
+ | |||
+ | Example of usage: | ||
+ | |||
+ | | ||
+ | while($var(i) < 10) | ||
+ | { | ||
+ | xlog("counter: $var(i)\n" | ||
+ | $var(i) = $var(i) | ||
+ | } | ||
+ | |||
+ | ===== Script Operations ===== | ||
+ | |||
+ | Assignments together with string and arithmetic operations can be done directly in configuration file. | ||
+ | ==== Assignment ==== | ||
+ | |||
+ | Assignments can be done like in C, via ' | ||
+ | * Unordered List Item AVPs - to set the value of an AVP | ||
+ | * script variables ($var(...)) | ||
+ | | ||
+ | * $ru - to set R-URI | ||
+ | * $rd - to set domain part of R-URI | ||
+ | * $rU - to set user part of R-URI | ||
+ | * $rp - to set the port of R-URI | ||
+ | * $du - to set dst URI | ||
+ | * $fs - to set send socket | ||
+ | * $br - to set branch | ||
+ | * $mf - to set message flags value | ||
+ | * $sf - to set script flags value | ||
+ | * $bf - to set branch flags value | ||
+ | |||
+ | < | ||
+ | $var(a) = 123; | ||
+ | </ | ||
+ | |||
+ | For avp's there a way to remove all values and assign a single value in one statement (in other words, delete existing AVPs with same name, add a new one with the right side value). This replaces the := assignment operator from kamailio < 3.0. | ||
+ | < | ||
+ | $(avp(i: | ||
+ | $(avp(i: | ||
+ | </ | ||
+ | |||
+ | ==== String Operations ==== | ||
+ | For strings, ' | ||
+ | |||
+ | < | ||
+ | $var(a) | ||
+ | $var(b) | ||
+ | </ | ||
+ | ==== Arithmetic Operations ==== | ||
+ | |||
+ | For numbers, one can use: | ||
+ | * + : plus | ||
+ | * - : minus | ||
+ | * / : divide | ||
+ | * * : multiply | ||
+ | * % : modulo (Kamailio uses ' | ||
+ | * | : bitwise OR | ||
+ | * & : bitwise AND | ||
+ | * ^ : bitwise XOR | ||
+ | * ~ : bitwise NOT | ||
+ | * < | ||
+ | * < | ||
+ | |||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | $var(a) = 4 + ( 7 & ( ~2 ) ); | ||
+ | </ | ||
+ | |||
+ | NOTE: to ensure the priority of operands in expression evaluations do use __parenthesis__. | ||
+ | |||
+ | Arithmetic expressions can be used in condition expressions. | ||
+ | |||
+ | < | ||
+ | if( $var(a) & 4 ) | ||
+ | log(" | ||
+ | </ | ||
+ | |||
+ | ===== Operators ===== | ||
+ | |||
+ | | ||
+ | | ||
+ | - integer comparison: ieq, ine | ||
+ | |||
+ | Note: The names are not yet final (use them at your own risk). Future version might use ==/!= only for ints (ieq/ine) and eq/ne for strings (under debate). They are almost equivalent to == or !=, but they force the conversion of their operands (eq to string and ieq to int), allowing among other things better type checking on startup and more optimizations. | ||
+ | |||
+ | Non equiv. examples: | ||
+ | |||
+ | 0 == "" (true) is not equivalent to 0 eq "" | ||
+ | |||
+ | " | ||
+ | |||
+ | Note: internally == and != are converted on startup to eq/ | ||
+ | |||
+ | - Kamailio tries to guess what the user wanted when operators that support multiple types are used on different typed operands. In general convert the right operand to the type of the left operand and then perform the operation. Exception: the left operand is undef. This applies to the following operators: +, == and !=. | ||
+ | | ||
+ | For +: undef + expr -> undef is converted to string => "" + expr. | ||
+ | For == and !=: undef == expr -> undef is converted to type_of expr. | ||
+ | If expr is undef, then undef == undef is true (internally is converted | ||
+ | to string). | ||
+ | |||
+ | - expression evaluation changes: Kamailio will auto-convert to integer or string in function of the operators: | ||
+ | | ||
+ | | ||
+ | |||
+ | | ||
+ | defined expr - returns true if expr is defined, and false if not. | ||
+ | Note: only a standalone avp or pvar can be | ||
+ | | ||
+ | strlen(expr) - returns the lenght of expr evaluated as string. | ||
+ | strempty(expr) - returns true if expr evaluates to the empty | ||
+ | | ||
+ | Example: if (defined | ||
+ | |||
+ | ===== Command Line Parameters ===== | ||
+ | |||
+ | Kamailio can be started with a set of command line parameters, providing more flexibility to control what is doing at runtime. Some of them can be quite useful when running on containerised environments. | ||
+ | |||
+ | To see the the available command line parameters, run **kamailio -h**: | ||
+ | |||
+ | < | ||
+ | # kamailio -h | ||
+ | |||
+ | version: kamailio 5.4.0-dev4 (x86_64/ | ||
+ | Usage: kamailio [options] | ||
+ | Options: | ||
+ | -a mode Auto aliases mode: enable with yes or on, | ||
+ | disable with no or off | ||
+ | --alias=val | ||
+ | (like for ' | ||
+ | -A define | ||
+ | -A ' | ||
+ | -b nr Maximum receive buffer size which will not be exceeded by | ||
+ | auto-probing procedure even if OS allows | ||
+ | -c Check configuration file for syntax errors | ||
+ | -d | ||
+ | -D | ||
+ | -D..do not fork (almost) anyway; | ||
+ | -DD..do not daemonize creator; | ||
+ | -DDD..daemonize (default) | ||
+ | -e Log messages printed in terminal colors (requires -E) | ||
+ | -E Log to stderr | ||
+ | -f file Configuration file (default: / | ||
+ | -g gid | ||
+ | -G file Create a pgid file | ||
+ | -h This help message | ||
+ | --help | ||
+ | -I Print more internal compile flags and options | ||
+ | -K Turn on " | ||
+ | -l address | ||
+ | mean listening on more addresses). The address format is | ||
+ | [proto: | ||
+ | where proto=udp|tcp|tls|sctp, | ||
+ | addr_lst= addr|(addr, addr_lst), | ||
+ | addr=host|ip_address|interface_name and | ||
+ | advaddr=addr[: | ||
+ | E.g: -l localhost, -l udp: | ||
+ | -l udp: | ||
+ | -l "sctp: | ||
+ | The default behaviour is to listen on all the interfaces. | ||
+ | --loadmodule=name load the module specified by name | ||
+ | --log-engine=log engine name and data | ||
+ | -L path Modules search path (default: / | ||
+ | -m nr Size of shared memory allocated in Megabytes | ||
+ | --modparam=modname: | ||
+ | type has to be ' | ||
+ | example: --modparam=corex: | ||
+ | -M nr Size of private memory allocated, in Megabytes | ||
+ | -n processes Number of child processes to fork per interface | ||
+ | (default: 8) | ||
+ | -N | ||
+ | -O nr Script optimization level (debugging option) | ||
+ | -P file Create a pid file | ||
+ | -Q | ||
+ | -r Use dns to check if is necessary to add a " | ||
+ | field to a via | ||
+ | -R Same as `-r` but use reverse dns; | ||
+ | (to use both use `-rR`) | ||
+ | --server-id=num set the value for server_id | ||
+ | --subst=exp set a subst preprocessor directive | ||
+ | --substdef=exp set a substdef preprocessor directive | ||
+ | --substdefs=exp set a substdefs preprocessor directive | ||
+ | -S | ||
+ | -t dir | ||
+ | -T | ||
+ | -u uid | ||
+ | -v | ||
+ | --version | ||
+ | -V | ||
+ | -x name Specify internal manager for shared memory (shm) | ||
+ | - can be: fm, qm or tlsf | ||
+ | -X name Specify internal manager for private memory (pkg) | ||
+ | - if omitted, the one for shm is used | ||
+ | -Y dir | ||
+ | -w dir | ||
+ | -W type poll method (depending on support in OS, it can be: poll, | ||
+ | epoll_lt, epoll_et, sigio_rt, select, kqueue, / | ||
+ | </ | ||
+ | |||
+ | ==== Log Engine CLI Parameter ==== | ||
+ | |||
+ | The **--log-engine** parameter allows to specify what logging engine to be used, which is practically about the format of the log messages. If not set at all, then Kamailio does the classic style of line-based plain text log messages. | ||
+ | |||
+ | The value of this parameter can be **--log-engine=name** or **--log-engine=name: | ||
+ | |||
+ | The name of the log engine can be: | ||
+ | |||
+ | | ||
+ | * the **data** for **json** log engine can be a set of character flags: | ||
+ | * **a** - add log prefix as a special field | ||
+ | * **A** - do not add log prefix | ||
+ | * **c** - add Call-ID (when available) as a dedicated JSON attribute | ||
+ | * **M** - strip EOL (' | ||
+ | * **N** - do not add EOL at the end of JSON document | ||
+ | |||
+ | Example of JSON logs when running Kamailio with " | ||
+ | |||
+ | < | ||
+ | { " | ||
- | === Request URI contains tel: URI with phone-context === | + | { " |
- | $ru = "tel:7042; | + | |
- | $rz = "tel" | + | |
- | $rU = "7042" | + | |
- | $rd = "< | + | |
- | $rp = "5060" | + | |
- | $rP = "UDP" | + | |
- | === Destination URI (must be a SIP(S) URI) === | ||
- | $du = " | ||
- | $dd = " | ||
- | $dp = " | ||
- | $dP = " | ||
</ | </ |