瀏覽代碼

uac: documented rpc commands uac.reg_enable and uac.reg_disable

Daniel-Constantin Mierla 11 年之前
父節點
當前提交
361052ff5e
共有 2 個文件被更改,包括 77 次插入2 次删除
  1. 36 2
      modules/uac/README
  2. 41 0
      modules/uac/doc/uac_admin.xml

+ 36 - 2
modules/uac/README

@@ -66,6 +66,8 @@ Ramona-Elena Modroiu
 
               6.1. uac.reg_dump
               6.2. uac.reg_info
+              6.3. uac.reg_enable
+              6.4. uac.reg_disable
 
         7. Remote Registration
 
@@ -99,7 +101,9 @@ Ramona-Elena Modroiu
    1.26. uac_reg_request_to usage
    1.27. uac.reg_dump usage
    1.28. uac.reg_info usage
-   1.29. lookup remote registrations usage
+   1.29. uac.reg_enable usage
+   1.30. uac.reg_disable usage
+   1.31. lookup remote registrations usage
 
 Chapter 1. Admin Guide
 
@@ -148,6 +152,8 @@ Chapter 1. Admin Guide
 
         6.1. uac.reg_dump
         6.2. uac.reg_info
+        6.3. uac.reg_enable
+        6.4. uac.reg_disable
 
    7. Remote Registration
 
@@ -681,6 +687,8 @@ failure_route[REMOTE_AUTH] {
 
    6.1. uac.reg_dump
    6.2. uac.reg_info
+   6.3. uac.reg_enable
+   6.4. uac.reg_disable
 
 6.1. uac.reg_dump
 
@@ -704,6 +712,32 @@ failure_route[REMOTE_AUTH] {
    kamcmd uac.reg_info l_uuid account123
 ...
 
+6.3. uac.reg_enable
+
+   Enable a remote registration record based on a filter. The command has
+   two parameter: attribute and value. The attribute can be: l_uuid,
+   l_username, r_username or auth_username. The value is what should be
+   matcheg against the value of the attribute in the remote registration
+   record.
+
+   Example 1.29. uac.reg_enable usage
+...
+   kamcmd uac.reg_enable l_uuid account123
+...
+
+6.4. uac.reg_disable
+
+   Disable a remote registration record based on a filter. The command has
+   two parameter: attribute and value. The attribute can be: l_uuid,
+   l_username, r_username or auth_username. The value is what should be
+   matcheg against the value of the attribute in the remote registration
+   record.
+
+   Example 1.30. uac.reg_disable usage
+...
+   kamcmd uac.reg_disable l_uuid account123
+...
+
 7. Remote Registration
 
    The module can register contact addresses to remote REGISTRAR servers.
@@ -737,7 +771,7 @@ failure_route[REMOTE_AUTH] {
    if the call is coming from a remote SIP provider and can change the
    R-URI to local username@domain. Afterwards you can run location lookup.
 
-   Example 1.29. lookup remote registrations usage
+   Example 1.31. lookup remote registrations usage
 ...
     if(uac_reg_lookup("$rU", "$ru")) {
         xlog("request from a remote SIP provider [$ou => $ru]\n");

+ 41 - 0
modules/uac/doc/uac_admin.xml

@@ -834,7 +834,48 @@ failure_route[REMOTE_AUTH] {
 ...
 			</programlisting>
 		</example>
+		</section>
 
+		<section id="uac.r.uac.reg_enable">
+			<title>
+				<function moreinfo="none">uac.reg_enable</function>
+			</title>
+		<para>
+			Enable a remote registration record based on
+			a filter. The command has two parameter: attribute and value.
+			The attribute can be: l_uuid, l_username, r_username or auth_username.
+			The value is what should be matcheg against the value of the attribute
+			in the remote registration record.
+		</para>
+		<example>
+		<title><function>uac.reg_enable</function> usage</title>
+			<programlisting format="linespecific">
+...
+   kamcmd uac.reg_enable l_uuid account123
+...
+			</programlisting>
+		</example>
+		</section>
+
+		<section id="uac.r.uac.reg_disable">
+			<title>
+				<function moreinfo="none">uac.reg_disable</function>
+			</title>
+		<para>
+			Disable a remote registration record based on
+			a filter. The command has two parameter: attribute and value.
+			The attribute can be: l_uuid, l_username, r_username or auth_username.
+			The value is what should be matcheg against the value of the attribute
+			in the remote registration record.
+		</para>
+		<example>
+		<title><function>uac.reg_disable</function> usage</title>
+			<programlisting format="linespecific">
+...
+   kamcmd uac.reg_disable l_uuid account123
+...
+			</programlisting>
+		</example>
 		</section>
 
 	</section>