Parâmetros globais - Histórico de revisão

Mike em 23h50min de 5 de outubro de 2013

2013-10-05T23:50:08Z

Mike em 23h49min de 5 de outubro de 2013

2013-10-05T23:49:37Z

Mike em 23h39min de 5 de outubro de 2013

2013-10-05T23:39:15Z

Mike em 23h03min de 5 de outubro de 2013

2013-10-05T23:03:44Z

Mostrar alterações

Mike em 21h17min de 5 de outubro de 2013

2013-10-05T21:17:30Z

Mike em 20h39min de 5 de outubro de 2013

2013-10-05T20:39:00Z

Mike em 20h38min de 5 de outubro de 2013

2013-10-05T20:38:37Z

Mostrar alterações

Mike: Criou página com 'Esta sessão lista todos os parametros globais exportados pelo core do '''OpenSIPS''' para utilização do script (para usar no opensips.cfg) ---- ==Keywords== Nota: Keyword...'

2013-10-05T19:36:12Z

Criou página com 'Esta sessão lista todos os parametros globais exportados pelo core do '''OpenSIPS''' para utilização do script (para usar no opensips.cfg) ---- ==Keywords== Nota: Keyword...'

Página nova

Esta sessão lista todos os parametros globais exportados pelo core do '''OpenSIPS''' para utilização do script (para usar no opensips.cfg)

----
==Keywords==
Nota: Keywords aqui são palavras chaves que são usadas pelo core, basicamente, funções do sistema

===Keywords do core===

Keywords especificadas para uma mensagem SIP que pode ser utilizada dentro de um 'if'

====af====

Familia do endereço recebido na mensagem SIP, este será INET se for recebido uma mensagem sobre IPv4 ou INET6 se a mesma foi recebida sobre IPv6

Exemplo de uso:

if(af==INET6) {
log("Message received over IPv6 link\n");
};

====dst_ip====

O ip da interface local onde a mensagem foi recebida, quando o proxy aceita requisições em várias interfaces de rede esta função torna possivel detectar qual foi a interface que recebeu o pacote.

Exemplo de uso:

if(dst_ip==127.0.0.1) {
log("message received on loopback interface\n");
};

====dst_port====

A porta local onde o pacote foi recebido, quando o '''OpenSIPS''' está habilitado para responder em mais de uma porta esta função é util para que se possa saber por ende exatamente o pacote esta chegando.

Exemplo de uso:
if(dst_port==5061)
{
log("message was received on port 5061\n");
};

====from_uri====

Esta variavel é uma referencia a URI do cabeçalho 'From'. Pode ser utilizada para tetar o valor do 'From'.

Exemplo de uso:

if(is_method("INVITE") && from_uri=~".*@opensips.org")
{
log("the caller is from opensips.org\n");
};

====method====

Esta variavel referencia o método SIP da mensagem que está sendo manipulada.

Exemplo de uso:

if(method=="REGISTER")
{
log("this SIP request is a REGISTER message\n");
};

====msg:len====

Esta variável referencia o tamanho da mensagem , pode ser utilizada em 'if' para testar o tamanho de pacotes .

Exemplo de uso:

if(msg:len>2048)
{
sl_send_reply("413", "message too large");
exit;
};

====$retcode====

Representa o valor retornado da ultima função executada (similar ao $? no bash -- você também pode usar $? no OpenSIPs, os dois nomes '$retcode' e '$?' são suportados). Se o valor for verificado após a chamada de uma rota o valor será o retorno daquela rota.

Exemplo de uso:

route {
route(1);
if($retcode==1)
{
log("The request is an INVITE\n");
};
}

route[1] {
if(is_method("INVITE"))
return(1);
return(2);
}

====proto====

Esta variável pode ser utilizada para verificar qual o tipo de protocolo de transporte está sendo utilizado.

Exemplo de uso:

if(proto==UDP)
{
log("SIP message received over UDP\n");
};

====status====

Se utilizanda em onreply_route esta variavel é uma referencia ao código do reply, se utilizada em um bloco de rota normal a vriavel é uma referencia ao status do ultimo reply enviado para fora pela requisição atual.

Exemplos de uso:

if(status=="200")
{
log("this is a 200 OK reply\n");
};

====src_ip====

Referencia ao IP de origem da mensagem SIP.

Exemplo de uso:

if(src_ip==127.0.0.1)
{
log("the message was sent from localhost!\n");
};

====src_port====
Referencia ao porta de origem da mensagem (de que porta o pacote saiu pra ser entregue para o OpenSIPS).

Exemplo de uso:

if(src_port==5061)
{
log("message sent from port 5061\n");
}

====to_uri====

Esta variavel pode ser utilizada para testar o valor da URI pelo cabeçalho '''to''' (to hader ).

Exemplo de uso:

if(to_uri=~"sip:.+@opensips.org")
{
log("this is a request for opensips.org users\n");
};

====uri====

Esta variável pode ser utilizada para testar os parametros da URI requisitada.

Exemplo de uso:

if(uri=~"sip:.+@opensips.org")
{
log("this is a request for opensips.org users\n");
};

==valores==
===Valores do core===

Valores podem ser utilizados nos if's para realizar os testes das keywords do core

====INET====

Esta keyword é utilizada para testar se um pacote foi recebido atraés de uma conexão IPv4

Exemplo de uso:

if(af==INET)
{
log("the SIP message was received over IPv4\n");
};

====INET6====

Esta keyword é utilizada para testar se um pacote foi recebido atraés de uma conexão IPv6

Exemplo de uso:

if(af==INET6)
{
log("the SIP message was received over IPv6\n");
};

====TCP====

Esta keyword é utilizada para verificar o valor de 'proto' e saber assim se o pacote é TCP ou não.

Exemplo de uso:

if(proto==TCP)
{
log("the SIP message was received over TCP\n");
};

====UDP====

Esta keyword é utilizada para verificar o valor de 'proto' e saber assim se o pacote é UDP ou não.

Exemplo de uso:

if(proto==UDP)
{
log("the SIP message was received over UDP\n");
};

====max_len====

Esta keyword é definida para o valor maximo de um pacote UDP e pode ser utilizada para testar o tamanho da mensagem recebida.

Exemplo de uso:

if(msg:len>max_len)
{
sl_send_reply("413", "message too large to be forwarded over UDP without fragmentation");
exit;
}

====myself====

Esta é uma referencia para a lista de endereços IP , hostname e alias que estão sendo utilizados pelo '''OpenSIPS''' em seu arquivo de configuração, a lista contém os dominios que o '''OpenSIPS''' está servindo

A variável pode ser utilizada para testar se o host na URI está na lista, o maior uso desta função é para saber se a mensagem deve ser processada localmente ou ser enviada para outro servidor.

Veja sobre "alias" para adicionar hostname, outros ip's e aliases para a lista

Exemplo de uso:

if(uri==myself) {
log("the request is for local processing\n");
};

====null====

Pode ser utilizado para reiniciar o valor de uma variavel ou para deletar um avp

Exemplo de uso:

$avp(i:12) = null;
$var(x) = null;

==Parametros==
===Parametros do core===

Parametros globais que podem ser definidos no arquivo de configuração. Valores aceitos são dependendo de qual parametro, string, numeros ou yes/no. Se você precisa especificar yes ou no como parte de uma string faça isso utilizando aspas duplas.

====advertised_address====

Pode ser um endereço IP ou uma string e respresenta o endereço anunciado no cabeçalho Via e em outros pontos (como cabeçalho RR), se for vazio ou não definido (valor default) o endereço do socket de onde a requisição é enviada será utilizado.

AVISO:
- não defina este parametro a menos que você saiba exatamente oque está fazendo
- você pode definir qualquer coisa aqui, nenhuma checagem é realizada (ex: foo.bar será aceito mesmo que não exista)

Exemplo de uso

advertised_address="opensips.org"


Além deste parametro é possivel definir o IP e porta por interface , veja o parametro 'listen'. Quando são definidos valores estes serão utilizados apenas para o tráfego que sai da interface.


====advertised_port====

A porta que será anunciada no cabeçalho VIA e outros. Se vazio ou não definido (valor padrão) a porta por onde a mensagem está sendo enviada será utilizada, atente-se para os mesmos aviso do 'advertised_address'.

Exemplos de uso:

advertised_port=5080


Além deste parametro é possivel definir o IP e porta por interface , veja o parametro 'listen'. Quando são definidos valores estes serão utilizados apenas para o tráfego que sai da interface.


====alias====
Parametro para definir outros hostname para o servidor. Este parametro pode ser utilizado quantas vezes necessário, cada valor será adicionado a uma lista e poderá ser utilizado quando a variavel 'myself' for verificada

É necessário incluir a porta (o valor de porta utilizado em 'port=' ou 'listen=') na definição do aliás, caso contrário a função loose_route() não irá funcionar como esperado para encaminhamentos locais.

Exemplos de uso:

alias=other.domain.com:5060
alias=another.domain.com:5060

====auto_aliases====

Este parametro controla se o alias deve ser 'descoberto' automaticamente e adicionado aos valores de listening. A auto descoberta são resutados de checagens de DNS (se o valor é um nome e não um ip), ou em uma checagem de DNS reverso se for um IP.

Por questões de compatibilidade o valor default é "on".

Exemplo de uso:

auto_aliases=no
auto_aliases=0

!!!!check_via

Check if the address in top most via of replies is local. Default value is 0 (check disabled).

Example of usage:

check_via=1

!!!!children

Number of children to fork for '''each''' UDP or SCTP interface you have defined. Default value is 8.

Example of usage:
[@
children=16
@]

%blue%NOTE%%: this global value (applicable for all UDP/SCTP interfaces) can be override if you set a different number of children in the definition of a specific interface - so actually you can define a different number of children for each interface (see the "listen" parameter for syntax).

!!!!chroot

The value must be a valid path in the system. If set, '''OpenSIPS''' will chroot (change root directory) to its value.

Example of usage:

chroot=/other/fakeroot

!!!!db_version_table

The name of the table version to be used by the DB API to check the version of the used tables.\\
Default value is '''"version"'''

Example of usage:

db_version_table="version_1_8"

!!!!db_default_url

The default DB URL to be used by modules if no per-module URL is given. Default is NULL (not defined)

Example of usage:

db_default_url="mysql://opensips:opensipsrw@localhost/opensips"

!!!!debug

Set the debug level. Higher values make '''OpenSIPS''' to print more debug messages.

Examples of usage:

[@
debug=1 -- print only important messages (like errors or more critical situations)
- recommended for running proxy as daemon

debug=4 -- print a lot of debug messages - use it only when doing debugging sessions
@]

Actual values are:
* -3 - Alert level
* -2 - Critical level
* -1 - Error level
* 1 - Warning level
* 2 - Notice level
* 3 - Info level
* 4 - Debug level

The 'debug' parameter is usually used in concordance with 'log_stderror' parameter.

Value of 'debug' parameter can also be get and set dynamically using 'debug' Core MI function.

!!!!disable_503_translation

If 'yes', OpenSIPS will not translate the received 503 replies into 500 replies (RFC 3261 clearly states that a proxy should never relay a 503 response, but instead it must transform it into a 500).

Default value is 'no' (do translation).

!!!!disable_core_dump

Can be 'yes' or 'no'. By default core dump limits are set to unlimited or
a high enough value. Set this config variable to 'yes' to disable core dump-ing
(will set core limits to 0).

Default value is 'no'.

Example of usage:

disable_core_dump=yes

!!!!disable_dns_blacklist

The DNS resolver, when configured with failover, can automatically store in a temporary blacklist the failed destinations. This will prevent (for a limited period of time) '''OpenSIPS''' to send requests to destination known as failed. So, the blacklist can be used as a memory for the DNS resolver.

The temporary blacklist created by DNS resolver is named "dns" and it is by default selected for usage (no need use the use_blacklist()) function. The rules from this list have a life time of 4 minutes - you can change it at compile time, from blacklists.h .

Can be 'yes' or 'no'. By default the blacklist is disabled (Default value is 'yes').

Example of usage:

disable_dns_blacklist=no

!!!!disable_dns_failover

Can be 'yes' or 'no'. By default DNS-based failover is enabled. Set this config variable to 'yes' to disable the DNS-based failover. This is a global option, affecting the core and the modules also.

Default value is 'no'.

Example of usage:

disable_dns_failover=yes

!!!!disable_stateless_fwd

Can be 'yes' or 'no'. This parameter controls the handling of stateless replies:
[@
yes - drop stateless replies if stateless fwd functions (like forward) are not used in script
no - forward stateless replies
@]
Default value is 'yes'.

!!!!disable_tcp

Global parameter to disable TCP support in the SIP server. Default value is 'no'.

Example of usage:

disable_tcp=yes

!!!!disable_tls

Global parameter to disable TLS support in the SIP server. Default value is 'yes'.

Example of usage:

disable_tcp=no

!!!!dns

This parameter controls if the SIP server should attempt to lookup its own domain name in DNS. If this parameter is set to yes and the domain name is not in DNS a warning is printed on syslog and a "received=" field is added to the via header.

Default is no.

!!!!dns_retr_time

Time in seconds before retrying a dns request. Default value is system specific,
depends also on the '/etc/resolv.conf' content (usually 5s).

Example of usage:

dns_retr_time=3

!!!!dns_retr_no

Number of dns retransmissions before giving up. Default value is system specific,
depends also on the '/etc/resolv.conf' content (usually 4).

Example of usage:

dns_retr_no=3

!!!!dns_servers_no

How many dns servers from the ones defined in '/etc/resolv.conf' will be used.
Default value is to use all of them.

Example of usage:

dns_servers_no=2

!!!!dns_try_ipv6

Can be 'yes' or 'no'. If it is set to 'yes' and a DNS lookup fails, it will retry it
for ipv6 (AAAA record). Default value is 'no'.

Example of usage:

dns_try_ipv6=yes

!!!!dns_use_search_list

Can be 'yes' or 'no'. If set to 'no', the search list in '/etc/resolv.conf'
will be ignored (=> fewer lookups => gives up faster). Default value is 'yes'.

HINT: even if you don't have a search list defined, setting this option
to 'no' will still be "faster", because an empty search list is in
fact search "" (so even if the search list is empty/missing there will
still be 2 dns queries, eg. foo+'.' and foo+""+'.')

Example of usage:

dns_use_search_list=no

!!!!dst_blacklist

Definition of a static (read-only) IP/destination blacklist. These lists can be selected from script (at runtime) to filter the outgoing requests, based on IP, protocol, port, etc.

Its primary purposes will be to prevent sending requests to critical IPs (like GWs) due DNS or to avoid sending to destinations that are known to be unavailable (temporary or permanent).

Example of usage:

[@
# filter out requests going to ips of my gws
dst_blacklist = gw:{( tcp , 192.168.2.100 , 5060 , "" ),( any , 192.168.2.101 , 0 , "" )}
# block requests going to "evil" networks
dst_blacklist = net_filter:{ ( any , 192.168.1.100/255.255.255.0 , 0 , "" )}
# block message requests with nasty words
dst_blacklist = msg_filter:{ ( any , 192.168.20.0/255.255.255.0 , 0 , "MESSAGE*ugly_word" )}
# block requests not going to a specific subnet
dst_blacklist = net_filter2:{ !( any , 192.168.30.0/255.255.255.0 , 0 , "" )}
@]

Each rule is defined by:
*protocol : TCP, UDP, TLS or "any" for anything
*port : number or 0 for any
*ip/mask
*test patter - is a filename like matching (see "man 3 fnmatch") applied on the outgoing request buffer (first_line+hdrs+body)

!!!!event_pkg_threshold

A number representing the percentage threshold above which the E_CORE_PKG_THRESHOLD event is raised, warning about low amount of free private memory. It accepts integer values between 0 and 100.

Default value is 0 ( event disabled ).

Example of usage:

event_pkg_threshold = 90

!!!!event_shm_threshold

A number representing the percentage threshold above which the E_CORE_SHM_THRESHOLD event is raised, warning about low amount of free shared memory. It accepts integer values between 0 and 100.

Default value is 0 ( event disabled ).

Example of usage:

event_shm_threshold = 90

!!!!exec_dns_threshold

A number representing the maximum number of microseconds a DNS query is expected to last. Anything above the set number will trigger a warning message to the logging facility.

Default value is 0 ( logging disabled ).

Example of usage:

exec_dns_threshold = 60000

!!!!exec_msg_threshold

A number representing the maximum number of microseconds the processing of a SIP msg is expected to last. Anything above the set number will trigger a warning message to the logging facility.
Aside from the message and the processing time, the most time consuming function calls from the script will also be logged.

Default value is 0 ( logging disabled ).

Example of usage:

exec_msg_threshold = 60000

!!!!fork

If set to 'yes' the proxy will fork and run in daemon mode - one process will be created for each network interface the proxy listens to and for each protocol (TCP/UDP), multiplied with the value of 'children' parameter.

When set to 'no', the proxy will stay bound to the terminal and runs as single process. First interface is used for listening to. OpenSIPS will only listen on UDP. Since the process is attached to the controlling terminal, not PID file will be created even if the -P command line option was specified.

Default value is 'yes'.

Example of usage:

fork=no

!!!!group gid

The group id to run '''OpenSIPS'''.

Example of usage:

group="opensips"

!!!!include_file

Can be called from outside route blocks to load additional routes/blocks or from inside them to simply preform more functions. The file path can be relative or absolute. If it is not an absolute path, first attempt is to locate it relative to current directory. If that fails, second try is relative to directory of the file that includes it. Will throw an error if file is not found.

Example of usage:

[@
include_file "proxy_regs.cfg"
@]

!!!!import_file

Same as include_file but will not throw an error if file is not found.

Example of usage:

[@
import_file "proxy_regs.cfg"
@]

!!!!listen

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:address:port (e.g., udp:10.10.10.10:5060). This parameter can be set multiple times in same configuration file, the server listening on all addresses specified.

The listen definition may accept several optional parameters for:
* configuring an advertise IP and port only for this interface. Syntax "AS 11.22.33.44:5060"
* setting a different number of children for this interface only (for UDP and SCTP interfaces only). This will override the global "children" parameter. Syntax "use_children 5"
Remember that this parameters have affect only for the interface they are configured for; if not defined per interface, the global values will be used.

Example of usage:

[@
listen=10.10.10.10
listen=eth1:5062
listen=udp:10.10.10.10:5064
listen=udp:127.0.0.1:5060 use_children 5
listen=udp:127.0.0.1:5060 as 99.88.44.33:5060 use_children 3
listen=127.0.0.1 use_children 3
@]

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't want this, you need to disable the TCP support completely with the core parameter disable_tcp.

!!!!log_facility

If '''OpenSIPS''' logs to syslog, you can control the facility for logging. Very
useful when you want to divert all '''OpenSIPS''' logs to a different log file.
See the man page syslog(3) for more details.

For more see: http://www.voice-system.ro/docs/ser-syslog/

Default value is LOG_DAEMON.

Example of usage:

log_facility=LOG_LOCAL0

!!!!log_name

Set the id to be printed in syslog. The value must be a string and has
effect only when '''OpenSIPS''' runs in daemon mode (fork=yes), after daemonize.
Default value is argv[0].

Example of usage:

log_name="osips-5070"

!!!!log_stderror

With this parameter you can make '''OpenSIPS''' to write log and debug messages to standard error. Possible values are:

- "yes" - write the messages to standard error

- "no" - write the messages to syslog

Default value is "no".

For more see: http://www.voice-system.ro/docs/ser-syslog/

Example of usage:

log_stderror=yes

!!!!max_while_loops

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.

Example of usage:

max_while_loops=200

!!!!maxbuffer

The size in bytes not to be exceeded during the auto-probing procedure of discovering the maximum buffer size for receiving UDP messages. Default value is 262144.

Example of usage:

maxbuffer=65536

!!!!memdump | mem_dump

Log level to print memory status information (runtime and shutdown). It has to be less than the value of 'debug' parameter if you want memory info to be logged. Default: memdump=L_DBG (4)

Example of usage:

memdump=2

NOTE that setting memlog (see below), will also set the memdump parameter - if you want different values for memlog and memdump, you need to first set memlog and then memdump.

!!!!memlog | mem_log

Log level to print memory debug info. It has to be less than the value of 'debug' parameter if you want memory info to be logged. Default: memlog=L_DBG (4)

Example of usage:

memlog=2

NOTE: by setting memlog parameter, the memdump will automatically be set to the same value (see memdump docs).

!!!!mcast_loopback

It can be 'yes' or 'no'. If set to 'yes', multicast datagram are sent over loopback. Default value is 'no'.

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

!!!!mhomed

Set the server to try to locate outbound interface on multihomed host. By default is not (0) - it is rather time consuming.

Example of usage:

mhomed=1

!!!!mpath

Set the module search path. This can be used to simplify the loadmodule parameter

Example of usage:

[@
mpath="/usr/local/lib/opensips/modules"
loadmodule "mysql.so"
loadmodule "uri.so"
loadmodule "uri_db.so"
loadmodule "sl.so"
loadmodule "tm.so"
...
@]

!!!!open_files_limit

If set and bigger than the current open file limit, '''OpenSIPS''' will try
to increase its open file limit to this number. Note: '''OpenSIPS''' must be
started as root to be able to increase a limit past the hard limit
(which, for open files, is 1024 on most systems).

Example of usage:

open_files_limit=2048

!!!!port

The port the SIP server listens to. The default value for it is 5060.

Example of usage:

port=5080

!!!!reply_to_via

If it is set to 1, any local reply is sent to the address advertised in top most Via of the request. Default value is 0 (off).

Example of usage:

reply_to_via=0

!!!!query_buffer_size

If set to a value greater than 1, inserts to DB will not be flushed one by one. Rows to be inserted will be kept in memory until until they gather up to query_buffer_size rows, and only then they will be flushed to the database.

Example of usage:

query_buffer_size=5

!!!!query_flush_time

If query_buffer_size is set to a value greater than 1, a timer will trigger once every query_flush_time seconds,
ensuring that no row will be kept for too long in memory.

Example of usage:

query_flush_time=10

!!!!rev_dns

This parameter controls if the SIP server should attempt to lookup its own IP address in DNS. If this parameter is set to yes and the IP address is not in DNS a warning is printed on syslog and a "received=" field is added to the via header.

Default is no.

!!!!server_header

The body of Server header field generated by '''OpenSIPS''' when it sends a request as UAS. It defaults to "OpenSIPS (<version> (<arch>/<os>))".

Example of usage:

[@
server_header="Server: My Company SIP Proxy"
@]

Please note that you have to add the header name "Server:", otherwise '''OpenSIPS''' will just write a header like:

[@
My Company SIP Proxy
@]

!!!!server_signature

This parameter controls the "Server" header in any locally generated message.

Example of usage:

server_signature=no

If it is enabled (default=yes) a header is generated as in the following example:

Server: OpenSIPS (0.9.5 (i386/linux))

!!!!sip_warning

Can be 0 or 1. If set to 1 (default value is 0) a 'Warning' header is added to each reply generated by '''OpenSIPS'''.
The header contains several details that help troubleshooting using the network traffic dumps.

Example of usage:

sip_warning=0

!!!!tcp_children

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 "children" parameter) will be used.

Example of usage:

tcp_children=4

!!!!tcp_accept_aliases

!!!!tcp_listen_backlog

The backlog argument defines the maximum length to which the queue of pending connections for the TCP listeners may grow. If a connection request arrives when the queue is full, the client may receive an error with an indication of ECONNREFUSED or, if the underlying protocol supports retransmission, the request may be ignored so that a later reattempt at connection succeeds.

Default configured value is 10.

!!!!tcp_send_timeout

Time in seconds after a TCP connection will be closed if it is not available
for writing in this interval (and '''OpenSIPS''' wants to send something on it).

Example of usage:

tcp_send_timeout=3

!!!!tcp_connect_timeout

Time in seconds before an ongoing attempt to connect will be aborted.

Example of usage:

tcp_connect_timeout=5

!!!!tcp_connection_lifetime!!!!

Lifetime in seconds for TCP sessions. TCP sessions which are inactive for >tcp_connection_lifetime will be closed by '''OpenSIPS'''. Default value is defined in tcp_conn.h: #define DEFAULT_TCP_CONNECTION_LIFETIME 120. Setting this value to 0 will close the TCP connection pretty quick ;-). You can also set the TCP lifetime to the expire value of the REGISTER by using the tcp_persistent_flag parameter of the registrar module.

Example of usage:

tcp_connection_lifetime=3600

!!!!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_conn.h: #define DEFAULT_TCP_MAX_CONNECTIONS 2048

Example of usage:

tcp_max_connections=4096

!!!!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: none, poll, epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll

Example of usage:

tcp_poll_method=select

!!!!tcp_no_new_conn_bflag

A branch flag to be used as marker to instruct OpenSIPS not to attempt to open a new TCP connection when delivering a request, but only to reuse an existing one (if available). If no existing conn, a generic send error will be returned.

This is intended to be used in NAT scenarios, where makes no sense to open a TCP connection towards a destination behind a NAT (like TCP connection created during registration was lost, so there is no way to contact the device until it re-REGISTER). Also this can be used to detect when a NATed registered user lost his TCP connection, so that opensips can disable his registration as useless.

Example of usage:

tcp_no_new_conn_bflag = 6
....
route{
....
if( destination_behin_nat && proto==TCP )
setbflag(6);
....
t_relay("0x02"); # no auto error reply
$var(retcode) = $rc;
if ($var(retcode)==-6) {
#send error
xlog("unable to send request to destination");
send_reply("404","Not found");
exit;
} else if ($var(retcode)<0) {
sl_reply_error();
exit;
}
....
}

!!!!tcp_threshold
A number representing the maximum number of microseconds sending of a TCP request is expected to last. Anything above the set number will trigger a warning message to the logging facility.

Default value is 0 ( logging disabled ).

Example of usage:

tcp_threshold = 60000

!!!!tcp_keepalive

Enable / disable TCP keepalive

Example of usage:

tcp_keepalive = 1

!!!!tcp_keepcount

Number of keepalives to send before closing the connection (Linux only)

Example of usage:

tcp_keepcount = 5

!!!!tcp_keepidle

Amount of time before OpenSIPS will start to send keepalives if the connection is idle (Linux only)

Example of usage:

tcp_keepidle = 30

!!!!tcp_keepinterval

Interval between keepalive probes, if the previous one failed (Linux only)

Example of usage:

tcp_keepinterval = 10

!!!!tls_ca_list

!!!!tls_certificate

!!!!tls_ciphers_list

!!!!tls_domain

!!!!tls_handshake_timeout

!!!!tls_log

!!!!tls_method

!!!!tls_port_no

!!!!tls_private_key

!!!!tls_require_certificate

!!!!tls_send_timeout

!!!!tls_verify

!!!!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
@]

!!!!user uid

The user id to run '''OpenSIPS''' (OpenSIPS will suid to it).

Example of usage:

user="opensips"

!!!!user_agent_header

The body of User-Agent header field generated by '''OpenSIPS''' when it sends a request as UAC. It defaults to "OpenSIPS (<version> (<arch>/<os>))".

Example of usage:

[@
user_agent_header="User-Agent: My Company SIP Proxy"
@]

Please note that you have to include the header name "User-Agent:" as '''OpenSIPS''' does not add it and you will get an erroneous header like:
[@
My Company SIP Proxy
@]

!!!!wdir

The working directory used by '''OpenSIPS''' at runtime. You might find it usefull when come to generating core files :)

Example of usage:
[@
wdir="/usr/local/opensips"
or
wdir=/usr/opensips_wd
@]

← Edição anterior		Edição das 20h39min de 5 de outubro de 2013
Linha 437:		Linha 437:


−	===disable_503_translation===	+	====disable_503_translation====

	Se definido para 'yes' o OpenSIPS não irá traduzir os replies 503 em 500 (RFC 3261 define que um proxy nunca deve fazer relay de mensagens 503, mas sim transformar em 500).		Se definido para 'yes' o OpenSIPS não irá traduzir os replies 503 em 500 (RFC 3261 define que um proxy nunca deve fazer relay de mensagens 503, mas sim transformar em 500).

@@ Linha 2: / Linha 2: @@
-----
 ==Keywords==
 Nota: Keywords aqui são palavras chaves que são usadas pelo core, basicamente, funções do sistema
@@ Linha 1 147: / Linha 1 147: @@
 ou
       wdir=/usr/opensips_wd

@@ Linha 1 030: / Linha 1 030: @@
      tcp_threshold = 60000
-!!!!tcp_keepalive
+====tcp_keepalive====
-Enable / disable TCP keepalive
+Ativa ou Desativa keepalive no TCP
-Example of usage:
      tcp_keepalive = 1
-!!!!tcp_keepcount
+====tcp_keepcount====
-Number of keepalives to send before closing the connection (Linux only)
+Número de keepalives para enviar antes de encerrar a conexão (válido apenas no linux)
-Example of usage:
      tcp_keepcount = 5
-!!!!tcp_keepidle
+====tcp_keepidle====
-Amount of time before OpenSIPS will start to send keepalives if the connection is idle (Linux only)
+Quantidade de tempo antes que o OpenSIPS comece a enviar os keepalive se a conexão estiver idle (válido apenas no linux)
-Example of usage:
+Exemplo de uso:
      tcp_keepidle = 30
-!!!!tcp_keepinterval
+====tcp_keepinterval====
-Example of usage:
+Exemplo de uso:
      tcp_keepinterval = 10
-!!!!tls_ca_list
+====tls_ca_list====
-!!!!tls_certificate
+====tls_certificate====
-!!!!tls_ciphers_list
+====tls_ciphers_list====
-!!!!tls_domain
+====tls_domain====
-!!!!tls_handshake_timeout
+====tls_handshake_timeout====
-!!!!tls_log
+====tls_log====
-!!!!tls_method
+====tls_method====
-!!!!tls_port_no
+====tls_port_no====
-!!!!tls_private_key
+====tls_private_key====
-!!!!tls_require_certificate
+====tls_require_certificate====
-!!!!tls_send_timeout
+====tls_send_timeout====
-!!!!tls_verify
+====tls_verify====
-!!!!tos
+====tos====
-The TOS (Type Of Service) to be used for the sent IP packages (both TCP and UDP).
+O TOS (Tipo de serviço) para ser utilizado nos pacotes enviados (válido para TCP e UDP)
      tos=IPTOS_LOWDELAY
      tos=0x10
      tos=IPTOS_RELIABILITY
-The user id to run '''OpenSIPS''' (OpenSIPS will suid to it).
+====user uid====
-Example of usage:
+O ID do usuário que vai rodar o '''OpenSIPS'''
      user="opensips"
-!!!!user_agent_header
+====user_agent_header====
-The body of User-Agent header field generated by '''OpenSIPS''' when it sends a request as UAC.  It defaults to "OpenSIPS (<version> (<arch>/<os>))".
+O corpo do cabeçalho User-Agent gerado pelo '''OpenSIPS''' quando ele envia um request como UAC. O default é 'OpenSIPS (<version> (<arch>/<os>))'.
-Example of usage:
+Exemplo de uso:
-[@
+Observe que você deve incluir a string 'User-Agent:' ou o OpenSIPS irá gerar apenas um header como 'My Company SIP Proxy'
-Please note that you have to include the header name "User-Agent:" as '''OpenSIPS''' does not add it and you will get an erroneous header like:
+====wdir====
-The working directory used by '''OpenSIPS''' at runtime. You might find it usefull when come to generating core files :)
+Exemplos de uso:
       wdir="/usr/local/opensips"
-     or
+ou
       wdir=/usr/opensips_wd

@@ Linha 851: / Linha 851: @@
 ====port====
-The port the SIP server listens to. The default value for it is 5060.
+A porta que o servidor SIP irá utilizar, o valor padrão é 5060.
-Example of usage:
+Exemplo de uso:
      port=5080
@@ Linha 926: / Linha 926: @@
      sip_warning=0
-!!!!tcp_children
+====tcp_children====
-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 "children" parameter) will be used.
+Número de processos filho que serão criados para aceitar conexões TCP, se nenhum valor for explicitamente setado, o mesmo valor séra utilizado para TCP e UDP ( baseado no parametro 'children')
-Example of usage:
+Exemplo de uso:
      tcp_children=4
-!!!!tcp_accept_aliases
+====tcp_accept_aliases====
-!!!!tcp_listen_backlog
+====tcp_listen_backlog====
-The backlog argument defines the maximum length to which the queue of pending connections for the TCP listeners may grow. If a connection  request arrives when the queue is full, the client may receive an error with an indication  of  ECONNREFUSED  or,  if  the underlying protocol supports retransmission, the request may be ignored so that a later reattempt at connection succeeds.
+O argumento de backlog define o tamanho maximo onde a fila de conexoões pendentes para TCP deverá crescer, se uma requisição chega quando a fila está cheia o cliente deve receber um erro com a indicação de ECONNREFUSED ou se o protocolo suportar retransmissão o request será ignorado e então tentará novamente até que a conexão complete.
-Default configured value is 10.
+O valor default é 10
-!!!!tcp_send_timeout
+====tcp_send_timeout====
-Time in seconds after a TCP connection will be closed if it is not available
+Tempo em segundos para uma conexão TCP ser fechada se não está disponivel para escrita neste intervalo (e o '''OpenSIPS''' precisa enviar alguma coisa para esta)
-Example of usage:
+Exemplo de uso:
      tcp_send_timeout=3
-!!!!tcp_connect_timeout
+====tcp_connect_timeout====
-Time in seconds before an ongoing attempt to connect will be aborted.
+Tempo em segundos antes que uma tentativa de conexão (de saída) seja abortada.
-Example of usage:
      tcp_connect_timeout=5
@@ Linha 962: / Linha 963: @@
-!!!!tcp_connection_lifetime!!!!
+====tcp_connection_lifetime====
-Lifetime in seconds for TCP sessions. TCP sessions which are inactive for >tcp_connection_lifetime will be closed by '''OpenSIPS'''. Default value is defined in tcp_conn.h: #define DEFAULT_TCP_CONNECTION_LIFETIME 120. Setting this value to 0 will close the TCP connection pretty quick ;-). You can also set the TCP lifetime to the expire value of the REGISTER by using the tcp_persistent_flag parameter of the registrar module.
+Tempo de vida em segundos para uma sessão TCP, uma conexão que esteja inativa por > tcp_connection_lifetime será fecada pelo '''OpenSIPS''', o valor default é definido no arquivo tcp_conn.h ( #define DEFAULT_TCP_CONNECTION_LIFETIME 120 ), definir este valor para 0 fechará as conexões TCP de forma muito rapida, você pode também definir o valor para expirar de acordo com o valor do REGISTER (expire) utilizando o parametro tcp_persistent_flag no módulo registrar.
-Example of usage:
      tcp_connection_lifetime=3600
-!!!!tcp_max_connections
+====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_conn.h: #define DEFAULT_TCP_MAX_CONNECTIONS 2048
+Número maximo de conexões tcp (se o número for excedido nenhuma nova conexão será aceita), o valor default é definido em tcp_conn.h ( #define DEFAULT_TCP_MAX_CONNECTIONS 2048)
-Example of usage:
+Exemplo de uso
      tcp_max_connections=4096
-!!!!tcp_poll_method
+====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: none, poll, epoll_lt, epoll_et, sigio_rt, select, kqueue, /dev/poll
-Example of usage:
+Exemplo de uso:
      tcp_poll_method=select
-!!!!tcp_no_new_conn_bflag
+====tcp_no_new_conn_bflag====
-A branch flag to be used as marker to instruct OpenSIPS not to attempt to open a new TCP connection when delivering a request, but only to reuse an existing one (if available). If no existing conn, a generic send error will be returned.
+Uma flag para ser utilizada pela perna (branch) como marca para instruir o OpenSIPS para não abrir uma nova conexão TCP enquanto entrega uma requisição mas apenas reusar uma (se disponivel), se não existir uma conexão um erro genérico será retornado.
-This is intended to be used in NAT scenarios, where makes no sense to open a TCP connection towards a destination behind a NAT (like TCP connection created during registration was lost, so there is no way to contact the device until it re-REGISTER). Also this can be used to detect when a NATed registered user lost his TCP connection, so that opensips can disable his registration as useless.
+Isso foi feito para ser utilizado em cenários de NAT onde não faz sentido abrir uma conexão TCP já que o destino está atrás de NAT ( como quando uma conexão TCP criada durante o registro é perdida, neste caso não há como contactar o dispositivo até que ele se re-REGISTRE) , além disso, esta função pode ser utilizada para detectar quando um usuário registrado atrás de NAT perde sua conexão TCP, então o opensips pode desativar seu registro por desuso.
-Example of usage:
       tcp_no_new_conn_bflag = 6
@@ Linha 1 015: / Linha 1 020: @@
+      }
-!!!!tcp_threshold
+====tcp_threshold====
-A number representing the maximum number of microseconds sending of a TCP request is expected to last. Anything above the set number will trigger a warning message to the logging facility.
+Um número representando o maximo em microsegundos para se aguardar resposta de uma conexão TCP, qualquer coisa acima deste valor irá disparar um mensagem de aviso no log.
-Default value is 0 ( logging disabled ).
+Valor default é 0 (log desativado)
-Example of usage:
      tcp_threshold = 60000

@@ Linha 715: / Linha 715: @@
-!!!!log_facility
+====log_facility====
-If '''OpenSIPS''' logs to syslog, you can control the facility for logging. Very
+Se o '''OpenSIPS''' está utilizando o syslog você pode controlar os recursos para log. Muito útil quando você quer separar os logs do '''OpenSIPS''' em um arquivo diferente, para mais detalhes veja a man page do syslog(3).
-For more see: http://www.voice-system.ro/docs/ser-syslog/
+Veja também: http://www.voice-system.ro/docs/ser-syslog/
-Default value is LOG_DAEMON.
+Valor default é LOG_DAEMON
-Example of usage:
+Exemplo de uso:
      log_facility=LOG_LOCAL0
@@ Linha 731: / Linha 729: @@
-!!!!log_name
+====log_name====
-Set the id to be printed in syslog. The value must be a string and has
+Define o id para ser exibido no syslog. Este valor deve ser uma string and tem efeito apenas quando o '''OpenSIPS''' é executado em modo daemon (fork=yes).
-Example of usage:
+Valor default é argv[0]
      log_name="osips-5070"
-!!!!log_stderror
+====log_stderror====
-With this parameter you can make '''OpenSIPS''' to write log and debug messages to standard error. Possible values are:
+Com este parametro você pode fazer com que o '''OpenSIPS'''escreva os logs e mensagens de debug no saida padrão, possiveis valores são:
-- "no" - write the messages to syslog
+- "yes" - escreve as mensagens na saída padrão
-Default value is "no".
+- "no" - escreve as mensagens no syslog
-For more see: http://www.voice-system.ro/docs/ser-syslog/
+Valor default é 'no'
-Example of usage:
+Para mais informações veja: http://www.voice-system.ro/docs/ser-syslog/
      log_stderror=yes
-!!!!max_while_loops
+====max_while_loops====
-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.
+Este parametro define o valor maximo de vezes que um loop pode ser executando em uma função while, esta função existe para proteger o sistema de loop infinito, valor default é 100.
-Example of usage:
+Exemplo de uso:
      max_while_loops=200
-!!!!maxbuffer
+====maxbuffer====
-The size in bytes not to be exceeded during the auto-probing procedure of discovering the maximum buffer size for receiving UDP messages. Default value is 262144.
+O valor em bytes para que não seja excedido durante um procedimento de auto-probing para descoberta the tamanho maximo de buffer de um pacote UDP, valor default é 262144.
-Example of usage:
+Exemplo de uso:
      maxbuffer=65536
-!!!!memdump | mem_dump
+Nivel de log para exibir informações de memoria (execução e shutdown), precisa ser menor que o valor de debug se você desejar que as informações de memória sejam logadas, valor default é 'memdump=L_DBG' (4)
-Log level to print memory status information (runtime and shutdown). It has to be less than the value of 'debug' parameter if you want memory info to be logged. Default: memdump=L_DBG (4)
+Exemplo de uso:
      memdump=2
-NOTE that setting memlog (see below), will also set the memdump parameter - if you want different values for memlog and memdump, you need to first set memlog and then memdump.
+Veja que definindo o memlog (abaixo), irá também definir o parametro memdump, se você quer valores diferentes você primeiro precisa definir o memlog e então o memdump.
-!!!!memlog | mem_log
+====memlog | mem_log====
 Log level to print memory debug info. It has to be less than the value of 'debug' parameter if you want memory info to be logged. Default: memlog=L_DBG (4)