[sr-dev] git:master:505d42ad: uac: docs for reg_active param and uac.reg_active rpc command

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 505d42ad214848420335542132b44ab7180a7b65
URL: https://github.com/kamailio/kamailio/commit/505d42ad214848420335542132b44ab7180a7b65

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-08-30T10:23:19+02:00

uac: docs for reg_active param and uac.reg_active rpc command

---

Modified: src/modules/uac/doc/uac_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/505d42ad214848420335542132b44ab7180a7b65.diff
Patch: https://github.com/kamailio/kamailio/commit/505d42ad214848420335542132b44ab7180a7b65.patch

---

diff --git a/src/modules/uac/doc/uac_admin.xml b/src/modules/uac/doc/uac_admin.xml
index 650ec8823c..637d976e25 100644
--- a/src/modules/uac/doc/uac_admin.xml
+++ b/src/modules/uac/doc/uac_admin.xml
@@ -507,6 +507,27 @@ modparam("uac", "reg_keep_callid", 1)
 			</example>
 		</section>
 
+
+		<section id="uac.p.reg_active">
+			<title><varname>reg_active</varname> (int)</title>
+			<para>
+				If set to 0, no remote regisrations are done. In other words,
+				it can control at once if the module should do remote registratios
+				or not. It can be changed at runtime via rpc command
+				'uac.reg_active 0|1'.
+			</para>
+			<para>The default value is 1 (active).</para>
+			<example>
+				<title>Set <varname>reg_active</varname> parameter</title>
+				<programlisting format="linespecific">
+...
+modparam("uac", "reg_active", 0)
+...
+				</programlisting>
+			</example>
+		</section>
+
+
 	</section>
 
 	<section>
@@ -1165,6 +1186,26 @@ event_route[uac:reply] {
 		</example>
 		</section>
 
+		<section id="uac.r.uac.reg_active">
+			<title>
+				<function moreinfo="none">uac.reg_active</function>
+			</title>
+		<para>
+			Control if the module should do remote registrations or not. Setting
+			to 1 enables remote registrations for all records and 0 disables
+			doing them.
+		</para>
+		<example>
+		<title><function>uac.reg_active</function> usage</title>
+			<programlisting format="linespecific">
+...
+   kamctl rpc uac.reg_active 0
+   kamctl rpc uac.reg_active 1
+...
+			</programlisting>
+		</example>
+		</section>
+
 	</section>
 
 	<section>