Skip to content

Commit

Permalink
doc/cfg_list: updated files with docs for cfg vars
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Jun 3, 2017
1 parent 5d9ee9f commit 790066a
Show file tree
Hide file tree
Showing 27 changed files with 909 additions and 154 deletions.
73 changes: 44 additions & 29 deletions doc/tutorials/cfg_list/cfg_core.txt
Expand Up @@ -16,7 +16,7 @@ Configuration Variables for core

3. core.memdbg
log level for memory debugging messages.
Default: 3.
Default: 4.
Type: integer.

4. core.use_dst_blacklist
Expand Down Expand Up @@ -124,133 +124,138 @@ Configuration Variables for core
Range: 1 - 1.
Type: integer.

23. core.use_dns_cache
23. core.dns_naptr_ignore_rfc
ignore the Order field required by RFC 2915.
Default: 1.
Type: integer.

24. core.use_dns_cache
enable/disable the dns cache.
Default: 1.
Range: 0 - 1.
Type: integer.

24. core.dns_cache_flags
25. core.dns_cache_flags
dns cache specific resolver flags (1=ipv4 only, 2=ipv6 only,
4=prefer ipv6.
Default: 0.
Range: 0 - 4.
Type: integer.

25. core.use_dns_failover
26. core.use_dns_failover
enable/disable dns failover in case the destination resolves to
multiple ip addresses and/or multiple SRV records (depends on
use_dns_cache).
Default: 0.
Range: 0 - 1.
Type: integer.

26. core.dns_srv_lb
27. core.dns_srv_lb
enable/disable load balancing to different srv records of the
same priority based on the srv records weights (depends on
dns_failover).
Default: 0.
Range: 0 - 1.
Type: integer.

27. core.dns_cache_negative_ttl
28. core.dns_cache_negative_ttl
time to live for negative results ("not found") in seconds. Use
0 to disable.
Default: 60.
Type: integer.

28. core.dns_cache_min_ttl
29. core.dns_cache_min_ttl
minimum accepted time to live for a record, in seconds.
Default: 0.
Type: integer.

29. core.dns_cache_max_ttl
30. core.dns_cache_max_ttl
maximum accepted time to live for a record, in seconds.
Default: -1.
Type: integer.

30. core.dns_cache_mem
31. core.dns_cache_mem
maximum memory used for the dns cache in Kb.
Default: 500.
Type: integer.

31. core.dns_cache_del_nonexp
32. core.dns_cache_del_nonexp
allow deletion of non-expired records from the cache when there
is no more space left for new ones.
Default: 0.
Range: 0 - 1.
Type: integer.

32. core.dns_cache_rec_pref
33. core.dns_cache_rec_pref
DNS cache record preference: 0 - do not check duplicates 1 -
prefer old records 2 - prefer new records 3 - prefer records
with longer lifetime.
Default: 0.
Range: 0 - 3.
Type: integer.

33. core.mem_dump_pkg
34. core.mem_dump_pkg
dump process memory status, parameter: pid_number.
Default: 0.
Type: integer.

34. core.mem_dump_shm
35. core.mem_dump_shm
dump shared memory status.
Default: 0.
Type: integer.

35. core.max_while_loops
36. core.max_while_loops
maximum iterations allowed for a while loop.
Default: 100.
Type: integer.

36. core.udp_mtu
37. core.udp_mtu
fallback to a congestion controlled protocol if send size
exceeds udp_mtu.
Default: 0.
Range: 0 - 65535.
Type: integer.

37. core.udp_mtu_try_proto
38. core.udp_mtu_try_proto
if send size > udp_mtu use proto (1 udp, 2 tcp, 3 tls, 4 sctp).
Default: 0.
Range: 1 - 4.
Type: integer.

38. core.udp4_raw
39. core.udp4_raw
enable/disable using a raw socket for sending UDP IPV4 packets.
Should be faster on multi-CPU linux running machines..
Default: 0.
Range: -1 - 1.
Type: integer.

39. core.udp4_raw_mtu
40. core.udp4_raw_mtu
set the MTU used when using raw sockets for udp sending. This
value will be used when deciding whether or not to fragment the
packets..
Default: 1500.
Range: 28 - 65535.
Type: integer.

40. core.udp4_raw_ttl
41. core.udp4_raw_ttl
set the IP TTL used when using raw sockets for udp sending. -1
will use the same value as for normal udp sockets..
Default: -1.
Range: -1 - 255.
Type: integer.

41. core.force_rport
42. core.force_rport
force rport for all the received messages.
Default: 0.
Range: 0 - 1.
Type: integer.

42. core.memlog
43. core.memlog
log level for memory status/summary information.
Default: 3.
Default: 4.
Type: integer.

43. core.mem_summary
44. core.mem_summary
memory debugging information displayed on exit (flags): 0 -
off, 1 - dump all the pkg used blocks (status), 2 - dump all
the shm used blocks (status), 4 - summary of pkg used blocks, 8
Expand All @@ -260,32 +265,42 @@ Configuration Variables for core
Range: 0 - 31.
Type: integer.

44. core.mem_safety
45. core.mem_safety
safety level for memory operations.
Default: 0.
Type: integer.

45. core.mem_join
46. core.mem_join
join free memory fragments.
Default: 0.
Type: integer.

46. core.corelog
47. core.mem_status_mode
print status for free or all memory fragments.
Default: 0.
Type: integer.

48. core.corelog
log level for non-critical core error messages.
Default: -1.
Type: integer.

47. core.latency_log
49. core.latency_cfg_log
log level for printing latency of routing blocks.
Default: 3.
Type: integer.

50. core.latency_log
log level for latency limits alert messages.
Default: -1.
Type: integer.

48. core.latency_limit_db
51. core.latency_limit_db
limit is ms for alerting on time consuming db commands.
Default: 0.
Type: integer.

49. core.latency_limit_action
52. core.latency_limit_action
limit is ms for alerting on time consuming config actions.
Default: 0.
Type: integer.
Expand Down
26 changes: 26 additions & 0 deletions doc/tutorials/cfg_list/cfg_debugger.txt
@@ -0,0 +1,26 @@
Configuration Variables for dbg
===============================

[ this file is autogenerated, do not edit ]


1. dbg.mod_level_mode
Enable or disable per module log level (0 - disabled, 1 -
enabled).
Default: 0.
Range: 0 - 1.
Type: integer.

2. dbg.mod_facility_mode
Enable or disable per module log facility (0 - disabled, 1 -
enabled).
Default: 0.
Range: 0 - 1.
Type: integer.

3. dbg.mod_hash_size
power of two as size of internal hash table to store levels per
module.
Default: 0.
Type: integer. Read-only.

12 changes: 9 additions & 3 deletions doc/tutorials/cfg_list/cfg_dispatcher.txt
Expand Up @@ -4,13 +4,19 @@ Configuration Variables for dispatcher
[ this file is autogenerated, do not edit ]


1. dispatcher.probing_threshhold
1. dispatcher.probing_threshold
Number of failed requests, before a destination is set to
probing..
Default: 3.
Default: 1.
Type: integer.

2. dispatcher.ping_reply_codes
2. dispatcher.inactive_threshold
Number of successful requests, before a destination is set to
active..
Default: 1.
Type: integer.

3. dispatcher.ping_reply_codes
Additional, valid reply codes for the OPTIONS Pinger. Default
is "".
Default: <unknown:str>.
Expand Down
82 changes: 82 additions & 0 deletions doc/tutorials/cfg_list/cfg_ims_registrar_scscf.txt
@@ -0,0 +1,82 @@
Configuration Variables for registrar
=====================================

[ this file is autogenerated, do not edit ]


1. registrar.default_expires
Contains number of second to expire if no expire hf or contact
expire present.
Default: 3600.
Type: integer.

2. registrar.default_expires_range
Percent from default_expires that will be used in generating
the range for the expire interval.
Default: 0.
Range: 0 - 100.
Type: integer.

3. registrar.min_expires
The minimum expires value of a Contact. Value 0 disables the
checking. .
Default: 60.
Type: integer.

4. registrar.max_expires
The maximum expires value of a Contact. Value 0 disables the
checking. .
Default: 0.
Type: integer.

5. registrar.em_default_expires
The default emergency expires value of a Contact..
Default: 3600.
Type: integer.

6. registrar.em_max_expires
The maximum emergency expires value of a Contact. Value 0
disables the checking. .
Default: 60.
Type: integer.

7. registrar.em_min_expires
The maximum emergency expires value of a Contact. Value 0
disables the checking. .
Default: 0.
Type: integer.

8. registrar.max_contacts
The maximum number of Contacts for an AOR. Value 0 disables the
checking. .
Default: 0.
Type: integer.

9. registrar.retry_after
If you want to add the Retry-After header field in 5xx replies,
set this parameter to a value grater than zero.
Default: 0.
Type: integer.

10. registrar.case_sensitive
If set to 1 then AOR comparison will be case sensitive.
Recommended and default is 0, case insensitive.
Default: 0.
Type: integer.

11. registrar.default_q
The parameter represents default q value for new contacts..
Default: -1.
Range: -1 - 1000.
Type: integer.

12. registrar.append_branches
If set to 1(default), lookup will put all contacts found in msg
structure.
Default: 1.
Type: integer.

13. registrar.realm_pref
Realm prefix to be removed. Default is "".
Type: string.

2 changes: 1 addition & 1 deletion doc/tutorials/cfg_list/cfg_maxfwd.txt
Expand Up @@ -6,7 +6,7 @@ Configuration Variables for maxfwd

1. maxfwd.max_limit
Max. maxfwd limit.
Default: 16.
Default: 70.
Range: 0 - 255.
Type: integer.

11 changes: 11 additions & 0 deletions doc/tutorials/cfg_list/cfg_outbound.txt
@@ -0,0 +1,11 @@
Configuration Variables for outbound
====================================

[ this file is autogenerated, do not edit ]


1. outbound.outbound_enabled
If set to one (true) Outbound is enabled..
Default: 0.
Type: integer. Read-only.

0 comments on commit 790066a

Please sign in to comment.