Skip to content

Instantly share code, notes, and snippets.

@martin-juul

martin-juul/flexisip.mib

Created May 18, 2021 12:15
Show Gist options
  • Save martin-juul/7161ccbf26d78967bd63c493274effce to your computer and use it in GitHub Desktop.
Save martin-juul/7161ccbf26d78967bd63c493274effce to your computer and use it in GitHub Desktop.
Download ZIP
Raw
flexisip.mib
FLEXISIP-MIB DEFINITIONS ::= BEGIN
IMPORTS
OBJECT-TYPE, Integer32, MODULE-IDENTITY, enterprises,
Counter64,NOTIFICATION-TYPE FROM SNMPv2-SMI
MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF;
flexisipMIB MODULE-IDENTITY
LAST-UPDATED "202105180000Z"
ORGANIZATION "belledonne-communications"
CONTACT-INFO "postal: 34 Avenue de L'europe 38 100 Grenoble France
email: [email protected]"
DESCRIPTION "A Flexisip management tree."
REVISION "202105180000Z"
DESCRIPTION "2.0.4-15-g34166fbd"
::={ enterprises 10000 }
flexisip OBJECT IDENTIFIER ::= { flexisipMIB 1 }
notif OBJECT IDENTIFIER ::= { flexisip 1 }
sender NOTIFICATION-TYPE
OBJECTS { flNotifString }
STATUS current
DESCRIPTION
"Send notifications
PN:Sender"
::= { notif 1 }
msg OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"Notification message payload.
Default:
PN:Msg"
::= { notif 10 }
source OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"Notification source payload.
Default:
PN:Source"
::= { notif 11 }
global OBJECT IDENTIFIER ::= { flexisip 2 }
defaultServers OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Servers started by default when no --server option is specified on command line. Possible values are 'proxy', 'presence', 'conference', separated by whitespaces.
Default:proxy
PN:Default servers"
::= { global 1351183376 }
autoRespawn OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Automatically respawn flexisip in case of abnormal termination (crashes). This has an effect if Flexisip has been launched with '--daemon' option only
Default:true
PN:Auto respawn"
::= { global 1527494863 }
pluginsDir OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path to the directory where plugins can be found.
Default:/opt/belledonne-communications/lib/flexisip/plugins
PN:Plugins dir"
::= { global 627460124 }
plugins OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Plugins to load. Look at <prefix>/lib/flexisip/plugins to know the list of installed plugin. The name of a plugin can be derivated from the according library name by striping out the extension part and the leading 'lib' prefix.
E.g. putting 'jweauth' in this setting will make libjweauth.so library to be load on runtime.
Default:
PN:Plugins"
::= { global 837699651 }
dumpCorefiles OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Generate a corefile when crashing. Note that by default linux will generate coredumps in '/' which is not so convenient. The following shell command can be added to /etc/rc.local in order to write core dumps a in specific directory, for example /home/cores:
echo ''/home/cores/core.%e.%t.%p'' >/proc/sys/kernel/core_pattern
Default:false
PN:Dump corefiles"
::= { global 71997024 }
enableSnmp OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable SNMP.
Default:false
PN:Enable snmp"
::= { global 516740826 }
logDirectory OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Directory where to create log files. Create logs are named as 'flexisip-<server_type>.log'. If If several server types have been specified by '--server' option or 'global/default-servers' parameter, then <server_type> is expanded by a concatenation of all the server types joined with '+' character.
WARNING: Flexisip has no embedded log rotation system but provides a configuration file for logrotate. Please ensure that logrotate is installed and running on your system if you want to have Flexisip's logs rotated. Log rotation can be customized by editing /etc/logrotate.d/flexisip-logrotate.
Default:/var/opt/belledonne-communications/log/flexisip
PN:Log directory"
::= { global 289844327 }
logFilename OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Name of the log file. Any occurences of '{server}' will be replaced by the server type which has been given by '--server' option or 'default-servers' parameter. If several server types have been given, then '{server}' will be replaced by the concatenation of these separated by '+' character (e.g. 'proxy+presence')
Default:flexisip-{server}.log
PN:Log filename"
::= { global 711092524 }
logLevel OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Log file verbosity. Possible values are debug, message, warning and error
Default:error
PN:Log level"
::= { global 894990596 }
syslogLevel OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Syslog verbosity. Possible values are debug, message, warning and error
Default:error
PN:Syslog level"
::= { global 566303968 }
userErrorsLogs OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Log (on a different log domain) user errors like authentication, registration, routing, etc...
Default:false
PN:User errors logs"
::= { global 1862612026 }
contextualLogFilter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A boolean expression applied to current SIP message being processed. When matched, logs are output provided that there level is greater than the value defined in contextual-log-level. The definition of the SIP boolean expression is the same as for entry filters of modules, which is documented here: https://wiki.linphone.org/xwiki/wiki/public/view/Flexisip/Configuration/Filter%20syntax/
Default:
PN:Contextual log filter"
::= { global 1804478960 }
contextualLogLevel OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Verbosity of contextual logs to output when the condition defined in 'contextual-log-filter' is met.
Default:debug
PN:Contextual log level"
::= { global 803962265 }
transports OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of white space separated SIP URIs where the proxy must listen.
Wildcard (*) can be used to mean 'all local ip addresses'. If 'transport' parameter is unspecified, it will listen to both udp and tcp. A local address to bind onto can be indicated in the 'maddr' parameter, while the domain part of the uris are used as public domain or ip address.
The 'sips' transport definitions accept two optional parameters:
- 'tls-certificates-dir' taking for value a path, with the same meaning as the 'tls-certificates-dir' property of this section and overriding it for this given transport.
- 'tls-verify-incoming' taking for value '0' or '1', to indicate whether clients connecting are required to present a valid client certificate. Default value is 0.
- 'tls-verify-outgoing' taking for value '0' or '1', whether flexisip should check the peer certificate when it make an outgoing TLS connection to another server. Default value is 1.
- 'require-peer-certificate' (deprecated) same as tls-verify-incoming
It is HIGHLY RECOMMENDED to specify a canonical name for 'sips' transport, so that the proxy can advertise this information in Record-Route headers, which allows TLS cname check to be performed by clients.
Specifying a sip uri with transport=tls is not allowed: the 'sips' scheme must be used instead. As requested by SIP RFC, IPv6 address must be enclosed within brakets.
Here are some examples to understand:
- listen on all local interfaces for udp and tcp, on standard port:
transports=sip:*
- listen on all local interfaces for udp,tcp and tls, on standard ports:
transports=sip:* sips:*
- listen only a specific IPv6 interface, on standard ports, with udp, tcp and tls
transports=sip:[2a01:e34:edc3:4d0:7dac:4a4f:22b6:2083] sips:[2a01:e34:edc3:4d0:7dac:4a4f:22b6:2083]
- listen on tls localhost with 2 different ports and SSL certificates:
transports=sips:localhost:5061;tls-certificates-dir=path_a sips:localhost:5062;tls-certificates-dir=path_b
- listen on tls localhost with 2 peer certificate requirements:
transports=sips:localhost:5061;tls-verify-incoming=0 sips:localhost:5062;tls-verify-incoming=1
- listen on 192.168.0.29:6060 with tls, but public hostname is 'sip.linphone.org' used in SIP messages. Bind address won't appear in messages:
transports=sips:sip.linphone.org:6060;maddr=192.168.0.29
Default:sip:*
PN:Transports"
::= { global 1279671451 }
aliases OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of white space separated host names pointing to this machine. This is to prevent loops while routing SIP messages.
Default:localhost
PN:Aliases"
::= { global 1229778194 }
idleTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time interval in seconds after which inactive connections are closed.
Default:3600
PN:Idle timeout"
::= { global 1559242349 }
keepaliveInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time interval in seconds for sending ''\r\n\r\n'' keepalives packets on inbound and outbound connections. A value of zero stands for no keepalive. The main purpose of sending keepalives is to keep connection alive accross NATs, but it also helps in detecting silently broken connections which can reduce the number socket descriptors used by flexisip.
Default:1800
PN:Keepalive interval"
::= { global 409149312 }
proxyToProxyKeepaliveInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time interval in seconds for sending ''\r\n\r\n'' keepalives packets specifically for proxy to proxy connections. Indeed, while it is undesirable to send frequent keepalives to mobile clients because it drains their battery, sending frequent keepalives has proven to be helpful to keep connections up between proxy nodes in a very popular US virtualized datacenter. A value of zero stands for no keepalive.
Default:0
PN:Proxy to proxy keepalive interval"
::= { global 1546910959 }
transactionTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"SIP transaction timeout in milliseconds. It is T1*64 (32000 ms) by default.
Default:32000
PN:Transaction timeout"
::= { global 1846405778 }
udpMtu OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The UDP MTU. Flexisip will fallback to TCP when sending a message whose size exceeds the UDP MTU. Please read http://sofia-sip.sourceforge.net/refdocs/nta/nta__tag_8h.html#a6f51c1ff713ed4b285e95235c4cc999a for more details. If sending large packets over UDP is not a problem, then set a big value such as 65535. Unlike the recommandation of the RFC, the default value of UDP MTU is 1460 in Flexisip (instead of 1300).
Default:1460
PN:Udp mtu"
::= { global 1036878534 }
tlsCertificatesDir OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path to the directory where TLS server certificate and private key can be found, concatenated inside an 'agent.pem' file. Any chain certificates must be put into a file named 'cafile.pem'. The setup of agent.pem, and eventually cafile.pem is required for TLS transport to work.
Default:/etc/flexisip/tls/
PN:Tls certificates dir"
::= { global 954471288 }
tlsCiphers OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Ciphers string to pass to OpenSSL in order to limit the cipher suites to use while establishing TLS sessions. Please take a look to ciphers(1) UNIX manual to get the list of keywords supported by your current version of OpenSSL. You might visit https://www.openssl.org/docs/manmaster/man1/ciphers.html too. The default value set by Flexisip should provide a high level of security while keeping an acceptable level of interoperability with currenttly deployed clients on the market.
Default:HIGH:!SSLv2:!SSLv3:!TLSv1:!EXP:!ADH:!RC4:!3DES:!aNULL:!eNULL
PN:Tls ciphers"
::= { global 1164811496 }
requirePeerCertificate OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Ask for client certificate on TLS session establishing.
Default:false
PN:Require peer certificate"
::= { global 2059478411 }
uniqueId OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Unique ID used to identify that instance of Flexisip. It must be a randomly generated 16-sized hexadecimal number. If empty, it will be randomly generated on each start of Flexisip.
Default:
PN:Unique id"
::= { global 1096410345 }
maxLogSize OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Max size of a log file before switching to a new log file, expressed with units. For example: 10G, 100M. If -1 then there is no maximum size
Default:-1
PN:Max log size"
::= { global 367047823 }
useMaddr OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Allow flexisip to use maddr in sips connections to verify the CN of the TLS certificate.
Default:false
PN:Use maddr"
::= { global 1434523239 }
versionNumber OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Flexisip version.
Default:2.0.4-15-g34166fbd
PN:Version number"
::= { global 999 }
runtimeError OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Retrieve current runtime error state.
Default:
PN:Runtime error"
::= { global 998 }
countIncomingRequestRegister OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name register.
Default:
PN:Count incoming request register"
::= { global 1347586410 }
countIncomingRequestInvite OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name invite.
Default:
PN:Count incoming request invite"
::= { global 1357905781 }
countIncomingRequestAck OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name ack.
Default:
PN:Count incoming request ack"
::= { global 1470453548 }
countIncomingRequestInfo OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name info.
Default:
PN:Count incoming request info"
::= { global 1049921566 }
countIncomingRequestBye OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name bye.
Default:
PN:Count incoming request bye"
::= { global 1847618846 }
countIncomingRequestCancel OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name cancel.
Default:
PN:Count incoming request cancel"
::= { global 2058833368 }
countIncomingRequestMessage OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name message.
Default:
PN:Count incoming request message"
::= { global 801635202 }
countIncomingRequestDecline OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name decline.
Default:
PN:Count incoming request decline"
::= { global 990462169 }
countIncomingRequestOptions OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name options.
Default:
PN:Count incoming request options"
::= { global 850292408 }
countIncomingRequestUnknown OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming requests with method name unknown.
Default:
PN:Count incoming request unknown"
::= { global 478954087 }
countIncomingResponse100 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 100.
Default:
PN:Count incoming response 100"
::= { global 1732630694 }
countIncomingResponse101 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 101.
Default:
PN:Count incoming response 101"
::= { global 2089957934 }
countIncomingResponse180 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 180.
Default:
PN:Count incoming response 180"
::= { global 1326248172 }
countIncomingResponse200 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 200.
Default:
PN:Count incoming response 200"
::= { global 1387826026 }
countIncomingResponse202 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 202.
Default:
PN:Count incoming response 202"
::= { global 2020175871 }
countIncomingResponse401 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 401.
Default:
PN:Count incoming response 401"
::= { global 120736593 }
countIncomingResponse404 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 404.
Default:
PN:Count incoming response 404"
::= { global 1039690968 }
countIncomingResponse407 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 407.
Default:
PN:Count incoming response 407"
::= { global 1803088426 }
countIncomingResponse408 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 408.
Default:
PN:Count incoming response 408"
::= { global 1396886745 }
countIncomingResponse486 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 486.
Default:
PN:Count incoming response 486"
::= { global 1969957567 }
countIncomingResponse487 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 487.
Default:
PN:Count incoming response 487"
::= { global 2134516028 }
countIncomingResponse488 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 488.
Default:
PN:Count incoming response 488"
::= { global 1550570693 }
countIncomingResponse603 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status 603.
Default:
PN:Count incoming response 603"
::= { global 259053599 }
countIncomingResponseUnknown OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of incoming response with status unknown.
Default:
PN:Count incoming response unknown"
::= { global 1705312878 }
countReply100 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 100.
Default:
PN:Count reply 100"
::= { global 906153746 }
countReply101 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 101.
Default:
PN:Count reply 101"
::= { global 479335331 }
countReply180 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 180.
Default:
PN:Count reply 180"
::= { global 1803748474 }
countReply200 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 200.
Default:
PN:Count reply 200"
::= { global 857955548 }
countReply202 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 202.
Default:
PN:Count reply 202"
::= { global 893008989 }
countReply401 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 401.
Default:
PN:Count reply 401"
::= { global 1487656612 }
countReply404 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 404.
Default:
PN:Count reply 404"
::= { global 1937759882 }
countReply407 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 407.
Default:
PN:Count reply 407"
::= { global 1473890264 }
countReply408 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 408.
Default:
PN:Count reply 408"
::= { global 361130335 }
countReply486 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 486.
Default:
PN:Count reply 486"
::= { global 1301051944 }
countReply487 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 487.
Default:
PN:Count reply 487"
::= { global 1227775952 }
countReply488 OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied 488.
Default:
PN:Count reply 488"
::= { global 1611797983 }
countReplyUnknown OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of replied unknown.
Default:
PN:Count reply unknown"
::= { global 385685010 }
cluster OBJECT IDENTIFIER ::= { flexisip 56191580 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable cluster mode. If 'false', the parameters of [cluster] section won't have any effect.
Default:false
PN:Enabled"
::= { cluster 1350666402 }
clusterDomain OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Domain name that enables external SIP agents to access to the cluster. Such domain is often associated to DNS SRV records for each proxy of the cluster, so that DNS resolution returns the address of a specific proxy randomly.
Flexisip uses that domain when it needs to insert a 'Path' or 'Record-route' header addressing the cluster instead of itself.
Default:
PN:Cluster domain"
::= { cluster 289943355 }
nodes OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of IP addresses of all the proxies present in the cluster. SIP messages coming from these addresses won't be challenged by the authentication module and won't have any rate limit applied by the DoS protection module.
Default:
PN:Nodes"
::= { cluster 1695219361 }
internalTransport OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Transport to use for communication with the other proxies of the cluster. This is useful only when no transport declared in 'global/transport' parameter can be used to reach the other proxies e.g. when inter-proxy communications are to be made through a private network.
Ex: sip:10.0.0.8:5059;transport=tcp
Default:
PN:Internal transport"
::= { cluster 1191666245 }
mdnsRegister OBJECT IDENTIFIER ::= { flexisip 912822333 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to 'true' to enable multicast DNS register
Default:false
PN:Enabled"
::= { mdnsRegister 1350666402 }
mdnsPriority OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Priority of this instance, lower value means more preferred.
'n': priority of n (example 10)
'n-m': random priority between n and m (example 10-50)
Default:0
PN:Mdns priority"
::= { mdnsRegister 1846470187 }
mdnsWeight OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A relative weight for Flexisips with the same priority, higher value means more preferred.
For example, if two Flexisips are registered on the same local domain with one at 20 and the other at 80, then 20% of Flexisip traffic will be redirected to the first Flexisip and 80% to the other one.
The sum of all the weights of Flexisips on the same local domain must be 100.
Default:100
PN:Mdns weight"
::= { mdnsRegister 788130310 }
mdnsTtl OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time To Live of any mDNS query that will ask for this Flexisip instance
Default:3600
PN:Mdns ttl"
::= { mdnsRegister 1545374119 }
eventLogs OBJECT IDENTIFIER ::= { flexisip 519714408 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable event logs.
Default:false
PN:Enabled"
::= { eventLogs 1350666402 }
logger OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Define logger for storing logs. It supports ''filesystem'' and ''database''.
Default:filesystem
PN:Logger"
::= { eventLogs 920263417 }
filesystemDirectory OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Directory where event logs are written as a filesystem (case when filesystem output is choosed).
Default:/var/log/flexisip
PN:Filesystem directory"
::= { eventLogs 2007650043 }
databaseBackend OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Choose the type of backend that Soci will use for the connection.
Depending on your Soci package and the modules you installed, the supported databases are:`mysql`, `sqlite3` and `postgresql`
Default:mysql
PN:Database backend"
::= { eventLogs 1555285227 }
databaseConnectionString OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The configuration parameters of the backend.
The basic format is ''key=value key2=value2''. For a mysql backend, this is a valid config: ''db=mydb user=user password='pass' host=myhost.com''.
Please refer to the Soci documentation of your backend, for instance: http://soci.sourceforge.net/doc/master/backends/#supported-backends-and-features
Default:db='mydb' user='myuser' password='mypass' host='myhost.com'
PN:Database connection string"
::= { eventLogs 421165716 }
databaseMaxQueueSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Amount of queries that will be allowed to be queued before bailing password requests.
This value should be chosen accordingly with 'database-nb-threads-max', so that you have a coherent behavior.
This limit is here mainly as a safeguard against out-of-control growth of the queue in the event of a flood or big delays in the database backend.
Default:100
PN:Database max queue size"
::= { eventLogs 1919435843 }
databaseNbThreadsMax OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum number of threads for writing in database.
If you get a `database is locked` error with sqlite3, you must set this variable to 1.
Default:10
PN:Database nb threads max"
::= { eventLogs 1065424115 }
dir OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Directory where event logs are written as a filesystem (case when filesystem output is choosed).
Default:/var/log/flexisip
PN:Dir"
::= { eventLogs 967836609 }
monitor OBJECT IDENTIFIER ::= { flexisip 73048207 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable or disable the Flexisip monitor daemon
Default:false
PN:Enabled"
::= { monitor 1350666402 }
testInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time between two consecutive tests
Default:30
PN:Test interval"
::= { monitor 1901269476 }
logfile OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path to the log file
Default:/etc/flexisip/flexisip_monitor.log
PN:Logfile"
::= { monitor 1802083609 }
switchPort OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Port to open/close folowing the test succeed or not
Default:12345
PN:Switch port"
::= { monitor 412939592 }
passwordSalt OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Salt used to generate the passwords of each test account
Default:
PN:Password salt"
::= { monitor 309898953 }
stunServer OBJECT IDENTIFIER ::= { flexisip 2086670759 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable or disable stun server.
Default:true
PN:Enabled"
::= { stunServer 1350666402 }
bindAddress OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Local ip address where to bind the socket.
Default:0.0.0.0
PN:Bind address"
::= { stunServer 1438679679 }
port OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"STUN server port number.
Default:3478
PN:Port"
::= { stunServer 1208658685 }
moduleDoSProtection OBJECT IDENTIFIER ::= { flexisip 4 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleDoSProtection 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleDoSProtection 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleDoSProtection 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleDoSProtection 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleDoSProtection 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleDoSProtection 1644085496 }
timePeriod OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Number of milliseconds to consider to compute the packet rate
Default:3000
PN:Time period"
::= { moduleDoSProtection 1897396410 }
packetRateLimit OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum packet rate in packets/seconds, averaged over [time-period] millisecond(s) to consider it as a DoS attack.
Default:20
PN:Packet rate limit"
::= { moduleDoSProtection 2006083629 }
banTime OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Number of minutes to ban the ip/port using iptables
Default:2
PN:Ban time"
::= { moduleDoSProtection 2032959944 }
iptablesChain OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Name of the chain flexisip will create to store the banned IPs
Default:FLEXISIP
PN:Iptables chain"
::= { moduleDoSProtection 951118501 }
moduleSanityChecker OBJECT IDENTIFIER ::= { flexisip 3 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleSanityChecker 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleSanityChecker 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleSanityChecker 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleSanityChecker 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleSanityChecker 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleSanityChecker 1644085496 }
moduleGarbageIn OBJECT IDENTIFIER ::= { flexisip 5 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { moduleGarbageIn 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:false
PN:Filter"
::= { moduleGarbageIn 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleGarbageIn 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleGarbageIn 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleGarbageIn 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleGarbageIn 1644085496 }
moduleNatHelper OBJECT IDENTIFIER ::= { flexisip 30 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleNatHelper 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleNatHelper 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleNatHelper 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleNatHelper 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleNatHelper 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleNatHelper 1644085496 }
contactVerifiedParam OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Internal URI parameter added to response contact by first proxy and cleaned by last one.
Default:verified
PN:Contact verified param"
::= { moduleNatHelper 124695320 }
fixRecordRoutes OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Fix record-routes, to workaround proxies behind firewalls but not aware of it.
Default:false
PN:Fix record routes"
::= { moduleNatHelper 241450067 }
fixRecordRoutesPolicy OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Policy to recognize nat'd record-route and fix them. There are two modes: 'safe' and 'always'
Default:safe
PN:Fix record routes policy"
::= { moduleNatHelper 1344009262 }
moduleAuthentication OBJECT IDENTIFIER ::= { flexisip 60 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { moduleAuthentication 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleAuthentication 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleAuthentication 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleAuthentication 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleAuthentication 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleAuthentication 1644085496 }
authDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of whitespace separated domains to challenge. Others are automatically denied.
Default:localhost
PN:Auth domains"
::= { moduleAuthentication 1602550228 }
availableAlgorithms OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of digest algorithms to use for password hashing. Think this setting as filter applied after fetching the credentials of a user from the user database. For example, if a user has its password hashed by MD5 and SHA-256 but 'available-algorithms' only has MD5, then only a MD5-based challenged will be submited to the UAC.
Furthermore, should a user have several hashed passwords and these are present in the list, then a challenge header will be put in the 401 response for each fetched password in the order given by the list.
Supported algorithems are MD5 and SHA-256.
Default:MD5
PN:Available algorithms"
::= { moduleAuthentication 39860735 }
disableQopAuth OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Disable the QOP authentication method. Default is to use it, use this flag to disable it if needed.
Default:false
PN:Disable qop auth"
::= { moduleAuthentication 1813603288 }
no403 OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Don't reply 403 when authentication fails. Instead, generate a new 401 (or 407) response containing a new challenge.
Default:false
PN:No 403"
::= { moduleAuthentication 1639621972 }
nonceExpires OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Expiration time before generating a new nonce.
Unit: second
Default:3600
PN:Nonce expires"
::= { moduleAuthentication 895437308 }
realmRegex OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Extraction regex applied on the URI of the 'from' header (or P-Prefered-Identity header if present) in order to extract the realm. The realm is found out by getting the first slice of the URI that matches the regular expression. If it has one or more capturing parentheses, the content of the first one is used as realm.
If no regex is specified, then the realm will be the domain part of the URI.
For instance, given auth-domains=sip.example.com, you might use 'sip:.*@sip\.(.*)\.com' in order to use 'example' as realm.
Default:
PN:Realm regex"
::= { moduleAuthentication 253785717 }
trustedHosts OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of whitespace-separated IP addresses which will be judged as trustful. Messages coming from these addresses won't be challenged.
Default:
PN:Trusted hosts"
::= { moduleAuthentication 1673070237 }
rejectWrongClientCertificates OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If set to true, the module will simply reject with ''403 forbidden'' any request coming from clients which have presented a bad TLS certificate (regardless of reason: improper signature, unmatched subjects). Otherwise, the module will fallback to a digest authentication.
This policy applies only for transports configured which have 'required-peer-certificate=1' parameter; indeed no certificate is requested to the client otherwise.
Default:false
PN:Reject wrong client certificates"
::= { moduleAuthentication 807635694 }
tlsClientCertificateRequiredSubject OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"An optional regular expression used to accept or deny a request basing on subject fields of the client certificate. The request is allowed if one of the subjects matches the regular expression.
The list of subjects to check is built by extracting the following fields, in order:
subjectAltNames.DNS, subjectAltNames.URI, subjectAltNames.IP and CN
Default:
PN:Tls client certificate required subject"
::= { moduleAuthentication 345741244 }
trustDomainCertificates OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Accept requests which the client certificate enables to trust the domaine of its Request-URI.
Default:false
PN:Trust domain certificates"
::= { moduleAuthentication 1807302987 }
newAuthOn407 OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When receiving a proxy authenticate challenge, generate a new challenge for this proxy.
Default:false
PN:New auth on 407"
::= { moduleAuthentication 730389599 }
dbImplementation OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Database backend implementation for digest authentication [soci,file].
Default:file
PN:Db implementation"
::= { moduleAuthentication 832722910 }
cacheExpire OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Duration of the validity of the credentials added to the cache in seconds.
Default:1800
PN:Cache expire"
::= { moduleAuthentication 1342451738 }
trustedClientCertificates OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of whitespace separated username or username@domain CN which will trusted. If no domain is given it is computed.
Default:
PN:Trusted client certificates"
::= { moduleAuthentication 1644309978 }
hashedPasswords OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"True if retrieved passwords from the database are hashed. HA1=MD5(A1) = MD5(username:realm:pass).
Default:false
PN:Hashed passwords"
::= { moduleAuthentication 87642267 }
enableTestAccountsCreation OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable a feature useful for automatic tests, allowing a client to create a temporary account in the password database in memory. This MUST not be used for production as it is a real security hole.
Default:false
PN:Enable test accounts creation"
::= { moduleAuthentication 1454731283 }
filePath OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path of the file in which user credentials are stored.
The file must start with 'version:1' as the first line, and then contains lines in the form of:
user@domain clrtxt:clear-text-password md5:md5-password sha256:sha256-password ;
For example:
[email protected] clrtxt:secret ;
[email protected] md5:97ffb1c6af18e5687bf26cdf35e45d30 ;
[email protected] clrtxt:secret md5:97ffb1c6af18e5687bf26cdf35e45d30 sha256:d7580069de562f5c7fd932cc986472669122da91a0f72f30ef1b20ad6e4f61a3 ;
Default:
PN:File path"
::= { moduleAuthentication 550663346 }
datasource OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Odbc connection string to use for connecting to database. ex1: DSN=myodbc3; where 'myodbc3' is the datasource name. ex2: DRIVER={MySQL};SERVER=host;DATABASE=db;USER=user;PASSWORD=pass;OPTION=3; for a DSN-less connection. ex3: /etc/flexisip/passwd; for a file containing user credentials in clear-text, md5 or sha256. The file must start with 'version:1' as the first line, and then contains lines in the form of:
user@domain clrtxt:clear-text-password md5:md5-password sha256:sha256-password ;
For example:
[email protected] clrtxt:secret ;
[email protected] md5:97ffb1c6af18e5687bf26cdf35e45d30 ;
[email protected] clrtxt:secret md5:97ffb1c6af18e5687bf26cdf35e45d30 sha256:d7580069de562f5c7fd932cc986472669122da91a0f72f30ef1b20ad6e4f61a3 ;
Default:
PN:Datasource"
::= { moduleAuthentication 257159866 }
sociBackend OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Choose the type of backend that Soci will use for the connection.
Depending on your Soci package and the modules you installed, this could be 'mysql', 'oracle', 'postgresql' or something else.
Default:mysql
PN:Soci backend"
::= { moduleAuthentication 431166526 }
sociConnectionString OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The configuration parameters of the Soci backend.
The basic format is ''key=value key2=value2''. For a mysql backend, this is a valid config: ''db=mydb user=user password='pass' host=myhost.com''.
Please refer to the Soci documentation of your backend, for intance: http://soci.sourceforge.net/doc/release/4.0/backends/mysql/
Default:db=mydb user=myuser password='mypass' host=myhost.com
PN:Soci connection string"
::= { moduleAuthentication 1063939228 }
sociPasswordRequest OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Soci SQL request used to obtain the password of a given user.
Each keywords starting with ':' character will be replaced by strings extracted from the SIP request to authenticate.
Only these keywords are supported: - ':id' : the user found in the from header (mandatory)
- ':domain' : the authorization realm
- ':authid' : the authorization username
The request MUST returns a two-columns table, which columns are defined as follow:
- 1st column: hashed password of the user or plain password if the associated algorithm is CLRTXT.
- 2nd column: the algorithm used to hash the associated password. Supported values: 'CLRTXT', 'MD5', 'SHA-256'
Examples:
- the password and algorithm are both available in the database
select password, algorithm from accounts where login = :id and domain = :domain
- all the passwords from the database are MD5
select password, 'MD5' from accounts where login = :id and domain = :domain
Default:select password, 'MD5' from accounts where login = :id and domain = :domain
PN:Soci password request"
::= { moduleAuthentication 1565041479 }
sociUserWithPhoneRequest OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"WARNING: This parameter is used by the presence server only.
Soci SQL request used to obtain the username associated with a phone alias.
The string MUST contains the ':phone' keyword which will be replaced by the phone number to look for.
The result of the request is a 1x1 table containing the name of the user associated with the phone number.
Example: select login from accounts where phone = :phone
Default:
PN:Soci user with phone request"
::= { moduleAuthentication 1115222513 }
sociUsersWithPhonesRequest OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"WARNING: This parameter is used by the presence server only.
Same as 'soci-user-with-phone-request' but allows to fetch several users by a unique SQL request.
The string MUST contains the ':phones' keyword which will be replaced by the list of phone numbers to look for. Each element of the list is seperated by a comma character and is protected by simple quotes (e.g. '0336xxxxxxxx','0337yyyyyyyy','034zzzzzzzzz').
If you use phone number linked accounts you'll need to select login, domain, phone in your request for flexisip to work.
Example: select login, domain, phone from accounts where phone in (:phones)
Default:
PN:Soci users with phones request"
::= { moduleAuthentication 1614195863 }
sociMaxQueueSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Amount of queries that will be allowed to be queued before bailing password requests.
This value should be chosen accordingly with 'soci-poolsize', so that you have a coherent behavior.
This limit is here mainly as a safeguard against out-of-control growth of the queue in the event of a flood or big delays in the database backend.
Default:1000
PN:Soci max queue size"
::= { moduleAuthentication 176546003 }
sociPoolsize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Size of the pool of connections that Soci will use. A thread is opened for each DB query, and this pool will allow each thread to get a connection.
The threads are blocked until a connection is released back to the pool, so increasing the pool size will allow more connections to occur simultaneously.
On the other hand, you should not keep too many open connections to your DB at the same time.
Default:100
PN:Soci poolsize"
::= { moduleAuthentication 1578270064 }
countAsyncRetrieve OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of asynchronous retrieves.
Default:
PN:Count async retrieve"
::= { moduleAuthentication 2123426888 }
countSyncRetrieve OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of synchronous retrieves.
Default:
PN:Count sync retrieve"
::= { moduleAuthentication 1216745563 }
countPasswordFound OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of passwords found.
Default:
PN:Count password found"
::= { moduleAuthentication 473066330 }
countPasswordNotFound OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of passwords not found.
Default:
PN:Count password not found"
::= { moduleAuthentication 1770611299 }
moduleRedirect OBJECT IDENTIFIER ::= { flexisip 290 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { moduleRedirect 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleRedirect 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleRedirect 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleRedirect 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleRedirect 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleRedirect 1644085496 }
contact OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A contact where to redirect requests. ex: <sip:127.0.0.1:5065>;expires=100
Default:
PN:Contact"
::= { moduleRedirect 398800377 }
modulePresence OBJECT IDENTIFIER ::= { flexisip 300 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { modulePresence 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:is_request && (request.method-name == 'PUBLISH' || request.method-name == 'NOTIFY' || request.method-name == 'SUBSCRIBE')
PN:Filter"
::= { modulePresence 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { modulePresence 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { modulePresence 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { modulePresence 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { modulePresence 1644085496 }
presenceServer OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A SIP URI where to send all presence related requests.
Default:sip:127.0.0.1:5065;transport=tcp
PN:Presence server"
::= { modulePresence 1856141759 }
onlyListSubscription OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If true, only manage list subscription.
Default:false
PN:Only list subscription"
::= { modulePresence 1464311537 }
checkDomainInPresenceResults OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When getting the list of users with phones, if this setting is enabled, it will limit the results to the ones that have the same domain.
Default:false
PN:Check domain in presence results"
::= { modulePresence 568472234 }
moduleRegistrar OBJECT IDENTIFIER ::= { flexisip 120 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleRegistrar 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleRegistrar 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleRegistrar 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleRegistrar 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleRegistrar 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleRegistrar 1644085496 }
regDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of whitespace separated domain names which the registar is in charge of. It can eventually be the '*' (wildcard) in order to match any domain name.
Default:localhost
PN:Reg domains"
::= { moduleRegistrar 1710654217 }
regOnResponse OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Register users based on response obtained from a back-end server. This mode is for using flexisip as a front-end server to hold client connections but registeracceptance is deferred to backend server to which the REGISTER is routed.
Default:false
PN:Reg on response"
::= { moduleRegistrar 415875333 }
maxContactsByAor OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum number of registered contacts per address of record.
Default:12
PN:Max contacts by aor"
::= { moduleRegistrar 1373788279 }
uniqueIdParameters OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of contact URI parameters that can be used to identify a user's device. The contact parameters are searched in the order of the list, the first matching parameter is used and the others ignored.
Default:+sip.instance pn-tok line
PN:Unique id parameters"
::= { moduleRegistrar 1980590475 }
maxExpires OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum expire time for a REGISTER, in seconds.
Default:86400
PN:Max expires"
::= { moduleRegistrar 1423754776 }
minExpires OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Minimum expire time for a REGISTER, in seconds.
Default:60
PN:Min expires"
::= { moduleRegistrar 1849878177 }
forceExpires OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set a value that will override expire times given by the REGISTER requests. A null or negative value disables that feature. If it is enabled, max-expires and min-expires will not have any effect.
Default:-1
PN:Force expires"
::= { moduleRegistrar 853424464 }
staticRecordsFile OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"File containing the static records to add to database on startup. Format: one 'sip_uri contact_header' by line. Example:
<sip:contact@domain> <sip:127.0.0.1:5460>,<sip:192.168.0.1:5160>
Default:
PN:Static records file"
::= { moduleRegistrar 766253971 }
staticRecordsTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Timeout in seconds after which the static records file is re-read and the contacts updated.
Default:600
PN:Static records timeout"
::= { moduleRegistrar 1314741222 }
dbImplementation OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Implementation used for storing the contact URIs of each address of record. Two backends are available:
- redis : contacts are stored in a Redis database, which allows persistent and shared storage accross multiple Flexisip instances.
- internal : contacts are stored in RAM. Of course, if flexisip is restarted, all the contact URIs are lost until clients update their registration.
The redis backend is recommended, the internal being more adapted to very small deployments.
Default:internal
PN:Db implementation"
::= { moduleRegistrar 832722910 }
redisServerDomain OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Hostname or address of the Redis server.
Default:localhost
PN:Redis server domain"
::= { moduleRegistrar 16550346 }
redisServerPort OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Port of the Redis server.
Default:6379
PN:Redis server port"
::= { moduleRegistrar 701037133 }
redisAuthPassword OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Authentication password for Redis. Empty to disable.
Default:
PN:Redis auth password"
::= { moduleRegistrar 915647039 }
redisServerTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Timeout in milliseconds of the Redis connection.
Default:1500
PN:Redis server timeout"
::= { moduleRegistrar 6477489 }
redisSlaveCheckPeriod OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When Redis is configured in master-slave, Flexisip will periodically ask which Redis instances are the slaves and the master. This is the period with which it will query the server. It will then determine whether is is connected to the master, and if not, let go of the connection and migrate to the master.
Note: This requires that all Redis instances have the same password. Otherwise the authentication will fail.
Default:60
PN:Redis slave check period"
::= { moduleRegistrar 456344032 }
serviceRoute OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Sequence of proxies (space-separated) where requests will be redirected through (RFC3608)
Default:
PN:Service route"
::= { moduleRegistrar 6080178 }
messageExpiresParamName OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Name of the custom Contact header parameter which is to indicate the expire time for chat message delivery.
Default:message-expires
PN:Message expires param name"
::= { moduleRegistrar 1202555223 }
registerExpireRandomizerMax OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If not zero, the expire time put in the 200 OK response won't be the one required by the user agent, but will be slightly modified by substracting a random value. The value given by this parameter is the maximum percentage of the initial expire that can be substracted.
If zero, no randomization is applied.
Default:0
PN:Register expire randomizer max"
::= { moduleRegistrar 584750389 }
redisRecordSerializer OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Serialize contacts with: [C, protobuf, json, msgpack]
Default:protobuf
PN:Redis record serializer"
::= { moduleRegistrar 246487594 }
nameMessageExpires OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Name of the custom Contact header parameter which is to indicate the expire time for chat message delivery.
Default:message-expires
PN:Name message expires"
::= { moduleRegistrar 2055381845 }
countClear OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of cleared registrations.
Default:
PN:Count clear"
::= { moduleRegistrar 422426538 }
countClearFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of cleared registrations. Finished.
Default:
PN:Count clear finished"
::= { moduleRegistrar 1957007289 }
countBind OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of registers.
Default:
PN:Count bind"
::= { moduleRegistrar 388149186 }
countBindFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of registers. Finished.
Default:
PN:Count bind finished"
::= { moduleRegistrar 705462330 }
countLocalRegisteredUsers OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of users currently registered through this server.
Default:
PN:Count local registered users"
::= { moduleRegistrar 2018478931 }
moduleStatisticsCollector OBJECT IDENTIFIER ::= { flexisip 123 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { moduleStatisticsCollector 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:is_request && request.method-name == 'PUBLISH'
PN:Filter"
::= { moduleStatisticsCollector 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleStatisticsCollector 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleStatisticsCollector 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleStatisticsCollector 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleStatisticsCollector 1644085496 }
collectorAddress OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"SIP URI of the statistics collector. Note that application/vq-rtcpxr messages for this address will be deleted by this module and thus not be delivered.
Default:
PN:Collector address"
::= { moduleStatisticsCollector 1086630825 }
moduleRouter OBJECT IDENTIFIER ::= { flexisip 125 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleRouter 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleRouter 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleRouter 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleRouter 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleRouter 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleRouter 1644085496 }
useGlobalDomain OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Store and retrieve contacts without using the domain.
Default:false
PN:Use global domain"
::= { moduleRouter 240257822 }
forkLate OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Fork invites to late registers.
Default:false
PN:Fork late"
::= { moduleRouter 32782458 }
forkNoGlobalDecline OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"All the forked have to decline in order to decline the caller invite.
Default:false
PN:Fork no global decline"
::= { moduleRouter 744993059 }
treatDeclineAsUrgent OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Treat 603 Declined answers as urgent. Only relevant if fork-no-global-decline is set to true.
Default:false
PN:Treat decline as urgent"
::= { moduleRouter 1765189635 }
treatAllAsUrgent OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"During a fork procedure, treat all failure response as urgent.
Default:false
PN:Treat all as urgent"
::= { moduleRouter 1756521156 }
callForkTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum time for a call fork to try to reach a callee, in seconds.
Default:90
PN:Call fork timeout"
::= { moduleRouter 1083494152 }
callForkUrgentTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum time before delivering urgent responses during a call fork, in seconds. The typical fork process requires to wait the best response from all branches before transmitting it to the client. However some error responses are retryable immediately (like 415 unsupported media, 401, 407) thus it is painful for the client to need to wait the end of the transaction time (32 seconds) for these error codes.
Default:5
PN:Call fork urgent timeout"
::= { moduleRouter 2101027178 }
callForkCurrentBranchesTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum time in seconds before trying the next set of lower priority contacts.
Default:10
PN:Call fork current branches timeout"
::= { moduleRouter 284131710 }
callPushResponseTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Optional timer to detect lack of push response, in seconds.
Default:0
PN:Call push response timeout"
::= { moduleRouter 1084457795 }
messageForkLate OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Fork MESSAGE requests to client registering lately.
Default:true
PN:Message fork late"
::= { moduleRouter 826698842 }
messageDeliveryTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum duration for delivering a MESSAGE request. This property applies only if message-fork-late if set to true, otherwise the duration can't exceed the normal transaction duration.
Default:604800
PN:Message delivery timeout"
::= { moduleRouter 2134464414 }
messageAcceptTimeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum duration for accepting a MESSAGE request if no response is received from any recipients. This property is meaningful when message-fork-late is set to true.
Default:5
PN:Message accept timeout"
::= { moduleRouter 1899094265 }
fallbackRoute OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Default route to apply when the recipient is unreachable or when when all attempted destination have failed.It is given as a SIP URI, for example: sip:example.org;transport=tcp (without surrounding brakets)
Default:
PN:Fallback route"
::= { moduleRouter 864041464 }
allowTargetFactorization OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"During a call forking, allow several INVITEs going to the same next hop to be grouped into a single one. A proprietary custom header 'X-target-uris' is added to the INVITE to indicate the final targets of the INVITE.
Default:false
PN:Allow target factorization"
::= { moduleRouter 1108335748 }
permitSelfGeneratedProvisionalResponse OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether the proxy is allowed to generate and send provisional responses during a call forking process. A typical example for this is the '110 Push sent' emitted by the proxy when at least one push notification has been sent to a target UA while routing an INVITE. Some old versions of Linphone (below linphone-sdk 4.2) suffer from an issue when receiving such kind of provisional responses that don't come from a remote client. This setting is mainly intended to temporarily workaround this situation.
Default:true
PN:Permit self generated provisional response"
::= { moduleRouter 500507846 }
resolveRoutes OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether or not to resolve next hop in route header against registrar database. This is an extension to RFC3261, and should not be used unless in some specific deployment cases. A next hope in route header is otherwise resolved through standard DNS procedure by the Forward module.
Default:false
PN:Resolve routes"
::= { moduleRouter 2099060674 }
parentDomainFallback OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether or not to fallback to the parent domain if there is no fallback route set and the recipient is unreachable. For example, if routing to sip:[email protected] returns no result, route the request to b.com. This is also a non-standard behavior.
Default:false
PN:Parent domain fallback"
::= { moduleRouter 1563674255 }
stateful OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Force forking and thus the creation of an outgoing transaction even when only one contact found
Default:true
PN:Stateful"
::= { moduleRouter 1566101228 }
fork OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Fork messages to all registered devices
Default:true
PN:Fork"
::= { moduleRouter 1501452893 }
generatedContactRoute OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Generate a contact from the TO header and route it to the above destination. [sip:host:port]
Default:
PN:Generated contact route"
::= { moduleRouter 1657863088 }
generatedContactExpectedRealm OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Require presence of authorization header for specified realm. [Realm]
Default:
PN:Generated contact expected realm"
::= { moduleRouter 592103508 }
generateContactEvenOnFilledAor OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Generate a contact route even on filled AOR.
Default:false
PN:Generate contact even on filled aor"
::= { moduleRouter 935176933 }
preroute OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Rewrite username with given value.
Default:
PN:Preroute"
::= { moduleRouter 1766883001 }
countForks OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of forks
Default:
PN:Count forks"
::= { moduleRouter 506136962 }
countForksFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of forks Finished.
Default:
PN:Count forks finished"
::= { moduleRouter 392728891 }
countForkTransactions OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of outgoing transaction created for forking
Default:
PN:Count fork transactions"
::= { moduleRouter 470922989 }
countForkTransactionsFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of outgoing transaction created for forking Finished.
Default:
PN:Count fork transactions finished"
::= { moduleRouter 619391493 }
countNonForked OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of non forked invites.
Default:
PN:Count non forked"
::= { moduleRouter 1356401213 }
countLocalRegisteredUsers OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of users currently registered through this server.
Default:
PN:Count local registered users"
::= { moduleRouter 2018478931 }
modulePushNotification OBJECT IDENTIFIER ::= { flexisip 130 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { modulePushNotification 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { modulePushNotification 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { modulePushNotification 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { modulePushNotification 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { modulePushNotification 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { modulePushNotification 1644085496 }
timeout OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Number of seconds to wait before sending a push notification to device. A value lesser or equal to zero will make the push notification to be sent immediately, which is recommended since most of the time devices can't have a permanent connection with the Flexisip server.
Default:0
PN:Timeout"
::= { modulePushNotification 1209243373 }
messageTimeToLive OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Time to live for the push notifications related to IM messages, in seconds. The default value '0' is interpreted as using the same value as for message-delivery-timeout of Router module.
Default:0
PN:Message time to live"
::= { modulePushNotification 1998539372 }
maxQueueSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum number of notifications queued for each push notification service
Default:100
PN:Max queue size"
::= { modulePushNotification 1061273824 }
retransmissionCount OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Number of push notification request retransmissions sent to a client for a same event (call or message). Retransmissions cease when a response is received from the client. Setting a value of zero disables retransmissions.
Default:0
PN:Retransmission count"
::= { modulePushNotification 1344285580 }
retransmissionInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Retransmission interval in seconds for push notification requests, when a retransmission-count has been specified above.
Default:5
PN:Retransmission interval"
::= { modulePushNotification 932267285 }
displayFromUri OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If true, the following key in the payload of the push request will be set:
* 'from-uri': the SIP URI of the caller or the message sender.
* 'display-name': the display name of the caller or the message sender.
* 'loc-args': the display name if not empty or the SIP URI instead.
If false, the keys will be set but as empty.
Default:false
PN:Display from uri"
::= { modulePushNotification 683740730 }
apple OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable push notification for apple devices
Default:true
PN:Apple"
::= { modulePushNotification 261896287 }
appleCertificateDir OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path to directory where to find Apple Push Notification service certificates. They should bear the appid of the application, suffixed by the release mode and .pem extension. For example: org.linphone.dev.pem org.linphone.prod.pem com.somephone.dev.pem etc... The files should be .pem format, and made of certificate followed by private key.
This is also the path to the directory where to find Voice Over IP certificates (certicates to use PushKit). They should bear the appid of the application, suffixed by the release mode and .pem extension, and made of certificate followed by private key. For example: org.linphone.voip.dev.pem org.linphone.voip.prod.pem com.somephone.voip.dev.pem etc...
Default:/etc/flexisip/apn
PN:Apple certificate dir"
::= { modulePushNotification 827855656 }
noBadge OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set the badge value to 0 for Apple push
Default:false
PN:No badge"
::= { modulePushNotification 421025781 }
appleForcePnType OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Allows to force the usage of a given type of push notification whatever the value of the 'app-id' parameter. For instance, if the 'app-id' is 'org.example.prod' and this parameter has been set to 'voip', then a PushKit notification will be sent although the 'app-id' suggests to send a Remote push notification.
The 'apns-topic' header of the PNR is computed from the 'app-id' parameter by adding or removing the '.voip.' part according to the required PN type.
This parameter has an effect only if the client has registered by using legacy push parameters.
Supported values are:
* 'remote', to force the usage of Remote push notifications;
* 'voip', to force the usage of PushKit notifications;
* <empty>, to disable this feature.
Default:
PN:Apple force pn type"
::= { modulePushNotification 1544185934 }
firebase OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable push notification for Android devices (new method for Android)
Default:true
PN:Firebase"
::= { modulePushNotification 1602842792 }
firebaseProjectsApiKeys OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of couples projectId:ApiKey for each Android project that supports push notifications (new method for Android)
Default:
PN:Firebase projects api keys"
::= { modulePushNotification 834906715 }
windowsphone OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable push notification for Windows Phone 8 devices
Default:true
PN:Windowsphone"
::= { modulePushNotification 136226277 }
windowsphonePackageSid OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Unique identifier for your Windows Store app.
For example: ms-app://s-1-15-2-2345030743-3098444494-743537440-5853975885-5950300305-5348553438-505324794
Default:
PN:Windowsphone package sid"
::= { modulePushNotification 2138201507 }
windowsphoneApplicationSecret OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Client secret. For example: Jrp1UoVt4C6CYpVVJHUPdcXLB1pEdRoB
Default:
PN:Windowsphone application secret"
::= { modulePushNotification 664928128 }
externalPushUri OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Instead of having Flexisip sending the push notification directly to the Google/Apple/Microsoft push servers, send an http request to a server with all required information encoded in the URL, to which the actual sending of the push notification is delegated. The following arguments can be substitued in the http request uri, with the following values:
- $type : apple, google, wp, firebase
- $token : device token
- $api-key : the api key to use (google and firebase only)
- $app-id : application ID
- $from-name : the display name in the from header
- $from-uri : the sip uri of the from header
- $from-tag : the tag of the from header
- $to-uri : the sip uri of the to header
- $call-id : the call-id of the INVITE or MESSAGE request
- $event : call, message
- $sound : the sound file to play with the notification
- $msgid : the message id to put in the notification
- $uid :
The content of the text message is put in the body of the http request as text/plain, if any.
Example: http://292.168.0.2/$type/$event?from-uri=$from-uri&tag=$from-tag&callid=$callid&to=$to-uri
Default:
PN:External push uri"
::= { modulePushNotification 39632915 }
externalPushMethod OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Method for reaching external-push-uri, typically GET or POST
Default:GET
PN:External push method"
::= { modulePushNotification 146874233 }
google OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Enable push notification for android devices (for compatibility only)
Default:true
PN:Google"
::= { modulePushNotification 1678860507 }
googleProjectsApiKeys OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of couples projectId:ApiKey for each android project that supports push notifications (for compatibility only)
Default:
PN:Google projects api keys"
::= { modulePushNotification 676535611 }
timeToLive OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Default time to live for the push notifications, in seconds. This parameter shall be set according to mDeliveryTimeout parameter in ForkContext.cc
Default:2592000
PN:Time to live"
::= { modulePushNotification 727443346 }
countPnFailed OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of push notifications failed to be sent
Default:
PN:Count pn failed"
::= { modulePushNotification 1268383194 }
countPnSent OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of push notifications successfully sent
Default:
PN:Count pn sent"
::= { modulePushNotification 1657010145 }
moduleMediaRelay OBJECT IDENTIFIER ::= { flexisip 210 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleMediaRelay 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleMediaRelay 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleMediaRelay 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleMediaRelay 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleMediaRelay 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleMediaRelay 1644085496 }
nortpproxy OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The name of the SDP attribute to set by the first proxy to forbid subsequent proxies to provide relay. Use 'disable' to disable.
Default:nortpproxy
PN:Nortpproxy"
::= { moduleMediaRelay 679176325 }
sdpPortRangeMin OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The minimal value of SDP port range
Default:1024
PN:Sdp port range min"
::= { moduleMediaRelay 103574097 }
sdpPortRangeMax OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximal value of SDP port range
Default:65535
PN:Sdp port range max"
::= { moduleMediaRelay 1737618742 }
byeOrphanDialogs OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Sends a ACK and BYE to 200Ok for INVITEs not belonging to any established call. This is to solve the race condition that happens when two callees answer the same call at the same time. According to RFC3261, the caller is expected to send an ACK followed by a BYE to the loser callee. This is not the case in RFC2543, where the proxy was supposed to do this. When set to true, the MediaRelay module will implement the RFC2543 behavior. Note that it may sound inappropriate to bundle this property with the media relay feature. However the MediaRelay module is the only one in Flexisip that has the visibility of SIP dialogs, which is necessary to implement this feature.
Default:false
PN:Bye orphan dialogs"
::= { moduleMediaRelay 15013248 }
maxCalls OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum concurrent calls processed by the media-relay. Calls arriving when the limit is exceed will be rejected. A value of 0 means no limit.
Default:0
PN:Max calls"
::= { moduleMediaRelay 1534862247 }
forceRelayForNonIceTargets OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When true, the 'c=' line and port number are set to the relay ip/port even if ICE candidates are present in the request, while the standard behavior is to leave the c= line and port number as they are in the original offer sent by the client. This variation allows callees that do not support ICE at all to benefit from the media relay service.
Default:true
PN:Force relay for non ice targets"
::= { moduleMediaRelay 1670049510 }
preventLoops OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Prevent media-relay ports to loop between them, which can cause 100% cpu on the media relay thread. You need to set this property to false if you are running test calls from clients running on the same IP address as the flexisip server
Default:true
PN:Prevent loops"
::= { moduleMediaRelay 839969876 }
earlyMediaRelaySingle OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"In case multiples '183 Early media' responses are received for a call, only the first one will have RTP streams forwarded back to caller. This feature prevents the caller to receive 'mixed' streams, but it breaks scenarios where multiple servers play early media announcement in sequence.
Default:true
PN:Early media relay single"
::= { moduleMediaRelay 483354436 }
maxEarlyMediaPerCall OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Maximum number of relayed early media streams per call. This is useful to limit the cpu usage due to early media relaying on embedded systems. A value of 0 stands for unlimited.
Default:0
PN:Max early media per call"
::= { moduleMediaRelay 556194348 }
inactivityPeriod OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Period of time in seconds, after which a relayed call without any activity is considered as no longer running. Activity counts RTP/RTCP packets exchanged through the relay and SIP messages.
Default:3600
PN:Inactivity period"
::= { moduleMediaRelay 159393699 }
forcePublicIpForSdpMasquerading OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Force the media relay to use the public address of Flexisip to relay calls. It not enabled, Flexisip will deduce a suitable IP address by basing on data from SIP messages, which could fail in tricky situations e.g. when Flexisip is behind a TCP proxy.
Default:false
PN:Force public ip for sdp masquerading"
::= { moduleMediaRelay 701069962 }
countCallsFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of relayed calls. Finished.
Default:
PN:Count calls finished"
::= { moduleMediaRelay 1633761680 }
countCalls OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of relayed calls.
Default:
PN:Count calls"
::= { moduleMediaRelay 1506026269 }
moduleTranscoder OBJECT IDENTIFIER ::= { flexisip 240 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:false
PN:Enabled"
::= { moduleTranscoder 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleTranscoder 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleTranscoder 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleTranscoder 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleTranscoder 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleTranscoder 1644085496 }
jbNomSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Nominal size of RTP jitter buffer, in milliseconds. A value of 0 means no jitter buffer (packet processing).
Default:0
PN:Jb nom size"
::= { moduleTranscoder 122754048 }
rcUserAgents OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whitespace separated list of user-agent strings for which audio rate control is performed.
Default:
PN:Rc user agents"
::= { moduleTranscoder 635544703 }
audioCodecs OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whitespace seprated list of audio codecs, in order of preference. The 'telephone-event' codec is necessary for inband DTMF processing.
Default:speex/8000 amr/8000 iLBC/8000 gsm/8000 pcmu/8000 pcma/8000 telephone-event/8000
PN:Audio codecs"
::= { moduleTranscoder 1614651326 }
removeBwLimits OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Remove the bandwidth limitations from SDP offers and answers
Default:false
PN:Remove bw limits"
::= { moduleTranscoder 852275430 }
blockRetransmissions OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"If true, retransmissions of INVITEs will be blocked. The purpose of this option is to limit bandwidth usage and server load on reliable networks.
Default:false
PN:Block retransmissions"
::= { moduleTranscoder 529984160 }
countCallsFinished OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of transcoded calls. Finished.
Default:
PN:Count calls finished"
::= { moduleTranscoder 1633761680 }
countCalls OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of transcoded calls.
Default:
PN:Count calls"
::= { moduleTranscoder 1506026269 }
moduleForward OBJECT IDENTIFIER ::= { flexisip 270 }
enabled OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicate whether the module is activated.
Default:true
PN:Enabled"
::= { moduleForward 1 }
filter OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A request/response enters module if the boolean filter evaluates to true. Ex: from.uri.domain contains 'sip.linphone.org', from.uri.domain in 'a.org b.org c.org', (to.uri.domain in 'a.org b.org c.org') && (user-agent == 'Linphone v2')
Default:
PN:Filter"
::= { moduleForward 2 }
fromDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip from allowed to enter the module.
Default:*
PN:From domains"
::= { moduleForward 3 }
toDomains OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Deprecated: List of domain names in sip to allowed to enter the module.
Default:*
PN:To domains"
::= { moduleForward 4 }
countEvalTrue OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to true.
Default:
PN:Count eval true"
::= { moduleForward 49511767 }
countEvalFalse OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Number of filter evaluations to false.
Default:
PN:Count eval false"
::= { moduleForward 1644085496 }
route OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A route header value where to send all requests not already resolved by the Router module (ie for which contact information has been found from the registrar database). This is the typical way to setup a Flexisip proxy server acting as a front-end for backend SIP server.Pay attention that is not just a SIP URI, but a route. As a result, when the URI has parameters, brakets must enclose the URI, otherwise the parameters will be parsed as route parameters.
For example:
route=<sip:192.168.0.10;transport=tcp>
Default:
PN:Route"
::= { moduleForward 1310924869 }
addPath OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Add a path header of this proxy
Default:true
PN:Add path"
::= { moduleForward 59214114 }
rewriteReqUri OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Rewrite request-uri's host and port according to above route
Default:false
PN:Rewrite req uri"
::= { moduleForward 1736329388 }
defaultTransport OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"For SIP URIs, in asbsence of transport parameter, assume the given transport is to be used. Possible values are udp, tcp or tls.
Default:udp
PN:Default transport"
::= { moduleForward 1144097462 }
paramsToRemove OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"List of URL and contact params to remove
Default:pn-tok pn-type app-id pn-msg-str pn-call-str pn-call-snd pn-msg-snd pn-timeout pn-silent pn-provider pn-prid pn-param
PN:Params to remove"
::= { moduleForward 683364883 }
interDomainConnections OBJECT IDENTIFIER ::= { flexisip 310 }
acceptDomainRegistrations OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether Flexisip shall accept registrations for entire domains
Default:false
PN:Accept domain registrations"
::= { interDomainConnections 517971997 }
assumeUniqueDomains OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether Flexisip shall assume that there is a unique server per registered domain, which allows to clean old registrations and simplifies the routing logic.
Default:false
PN:Assume unique domains"
::= { interDomainConnections 2012270129 }
domainRegistrations OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Path to a text file describing the domain registrations to make. This file must contains lines like:
<local domain name> <SIP URI of proxy/registrar where to send the domain REGISTER>
where:
<local domain name> is a domain name managed locally by this proxy
<SIP URI of proxy/registrar> is the SIP URI where the domain registration will be sent. The special uri parameter 'tls-certificates-dir' is understood in order to specify a TLS client certificate to present to the remote proxy.
If the file is absent or empty, no registrations are done.
Default:/etc/flexisip/domain-registrations.conf
PN:Domain registrations"
::= { interDomainConnections 1743684879 }
verifyServerCerts OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"When submitting a domain registration to a server over TLS, verify the certificate presented by the server. Disabling this option is only for test, because it is a security flaw
Default:true
PN:Verify server certs"
::= { interDomainConnections 796642946 }
keepaliveInterval OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Interval in seconds for sending \r\n\r\n keepalives throug the outgoing domain registration connection.A value of zero disables keepalives.
Default:30
PN:Keepalive interval"
::= { interDomainConnections 409149312 }
regWhenNeeded OBJECT-TYPE
SYNTAX INTEGER { true(1),false(0) }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Whether Flexisip shall only send a domain registration when a device is registered
Default:false
PN:Reg when needed"
::= { interDomainConnections 1586790085 }
END
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment