浏览代码

ipops: Add ptr_query docs

Xenofon Karamanos 1 年之前
父节点
当前提交
a824e939b5
共有 1 个文件被更改,包括 87 次插入0 次删除
  1. 87 0
      src/modules/ipops/doc/ipops_admin.xml

+ 87 - 0
src/modules/ipops/doc/ipops_admin.xml

@@ -883,6 +883,93 @@ if(dns_query("test.com", "xyz"))
 
 
     </section>
     </section>
 
 
+    <section id="ipops.f.ptr_query">
+      <title>
+        <function moreinfo="none">ptr_query(ip, pvid)</function>
+      </title>
+
+      <para>
+		  Store the hostname that correspond to an IP address (IPv4 or IPv6)
+		  in a pseudo-variable variable $ptrquery(pvid=>hostname).
+      </para>
+
+      <para>
+      <emphasis>Note: Results will be in in $ptrquery(pvid=>key).</emphasis>
+      key can be:
+      <itemizedlist>
+        <listitem>
+          <para>
+            <emphasis>addr</emphasis> - IP address
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>type</emphasis> - type of IP address
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>ipv4</emphasis> - 1 if IPv4 address
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>ipv6</emphasis> - 1 if IPv6 address
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>count</emphasis> - number of hostnames found
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>hostname</emphasis> - hostname
+          </para>
+        </listitem>
+      </itemizedlist>
+      </para>
+
+      <para>Parameters:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para>
+			  <emphasis>ip</emphasis> - string or pseudo-variable containing the ip.
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            <emphasis>pvid</emphasis> - AVP id for script variable.
+          </para>
+        </listitem>
+      </itemizedlist>
+
+      <para>
+        This function can be used from ANY_ROUTE.
+      </para>
+
+      <example>
+        <title>
+          <function>ptr_query</function> usage
+        </title>
+        <programlisting format="linespecific">
+...
+if(ptr_query("8.8.8.8","ip4"))
+{
+		xlog(" number of names: $ptrquery(ip4=>count)\n");
+		$var(j) = 0;
+		while($var(j)&lt;$ptrquery(ip4=>count)) {
+			xlog(" #[$var(j)] name [ $ptrquery(ip4=>hostname) ]\n");
+			$var(j) = $var(j) + 1;
+		}
+}
+...
+        </programlisting>
+      </example>
+
+    </section>
+
     <section id="ipops.f.srv_query">
     <section id="ipops.f.srv_query">
       <title>
       <title>
         <function moreinfo="none">srv_query(srvcname, pvid)</function>
         <function moreinfo="none">srv_query(srvcname, pvid)</function>