[sr-dev] git:master:35319cb5: corex: docs for dns_cache parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 35319cb5c0cac7fd656d86e7419dbd3e497fcd92
URL: https://github.com/kamailio/kamailio/commit/35319cb5c0cac7fd656d86e7419dbd3e497fcd92

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-05-26T15:59:01+02:00

corex: docs for dns_cache parameter

---

Modified: src/modules/corex/doc/corex_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/35319cb5c0cac7fd656d86e7419dbd3e497fcd92.diff
Patch: https://github.com/kamailio/kamailio/commit/35319cb5c0cac7fd656d86e7419dbd3e497fcd92.patch

---

diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
index f9572b54f0..203ada5d2f 100644
--- a/src/modules/corex/doc/corex_admin.xml
+++ b/src/modules/corex/doc/corex_admin.xml
@@ -93,6 +93,60 @@
 modparam("corex", "alias_subdomains", "kamailio.org")
 modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 ...
+</programlisting>
+	    </example>
+	</section>
+	<section id="corex.p.dns_cache">
+	    <title><varname>dns_cache</varname> (string)</title>
+	    <para>
+		Add A or AAAA records to internal DNS cache at startup. It can be set
+		many times to add more than one record.
+	    </para>
+	    <para>
+		The format of the value follows the SIP params style:
+		"attr1=val1;attr2=val2;...". The attributes can be:
+	    </para>
+		<itemizedlist>
+		<listitem>
+			<para>
+			<emphasis>type</emphasis> - it can be "A" (IPv4) or "AAAA" (IPv6)
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>name</emphasis> - the domain name
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>addr</emphasis> - the IP address
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>ttl</emphasis> - TTL value
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>flags</emphasis> - can be: 1 - the domain is unresolvable
+			(like blacklisted); 2 - the record is permanent (never times out,
+			never deleted, never overwritten)
+			</para>
+		</listitem>
+		</itemizedlist>
+	    <para>
+		<emphasis>
+		    Default value is <quote>NULL</quote>.
+		</emphasis>
+	    </para>
+	    <example>
+		<title>Set <varname>dns_cache</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("corex", "dns_cache", "type=A;name=kamailio.org;addr=193.22.119.66;ttl=3600000;flags=0")
+modparam("corex", "dns_cache", "type=AAAA;name=kamailio.org;addr=2a00:d60:0:400::2;ttl=3600000;flags=0")
+...
 </programlisting>
 	    </example>
 	</section>