[sr-dev] git:master:173f4e90: pipelimit: documentation for rpc command pl.list

Module: kamailio Branch: master Commit: 173f4e901f0c0e4671965514cb39146eb652f100 URL: https://github.com/kamailio/kamailio/commit/173f4e901f0c0e4671965514cb39146… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2018-07-25T14:56:13+02:00 pipelimit: documentation for rpc command pl.list --- Modified: src/modules/pipelimit/doc/pipelimit_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/173f4e901f0c0e4671965514cb39146… Patch: https://github.com/kamailio/kamailio/commit/173f4e901f0c0e4671965514cb39146… --- diff --git a/src/modules/pipelimit/doc/pipelimit_admin.xml b/src/modules/pipelimit/doc/pipelimit_admin.xml index e30d197ca5..554c5d5e3b 100644 --- a/src/modules/pipelimit/doc/pipelimit_admin.xml +++ b/src/modules/pipelimit/doc/pipelimit_admin.xml @@ -487,6 +487,28 @@ with unexpected retcode=$var(check_result)\n"); <section> <title>RPC Commands</title> + <section id="pipelimit.r.pl.list"> + <title> + <function moreinfo="none">pl.list</function> + </title> + <para> + Lists the details of one or all pipes, respectively the attributes + pipe name (id), algorithm, limit and counter. + </para> + <para> + Name: <emphasis>pl.list</emphasis> + </para> + <para>Parameters: <emphasis>name</emphasis> - (optional) pipe name</para> + <para> + RPC Command Format: + </para> + <programlisting format="linespecific"> +... +kamctl rpc pl.list +kamctl rpc pl.list testid +... + </programlisting> + </section> <section id="pipelimit.r.pl.stats"> <title> <function moreinfo="none">pl.stats</function> @@ -503,7 +525,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.stats +... +kamcmd pl.stats +... </programlisting> </section> <section id="pipelimit.r.pl.set_pipe"> @@ -534,7 +558,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.set_pipe 2 RED 10 +... +kamcmd pl.set_pipe 2 RED 10 +... </programlisting> </section> <section id="pipelimit.r.pl.get_pipes"> @@ -552,7 +578,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.get_pipes +... +kamcmd pl.get_pipes +... </programlisting> </section> <section id="pipelimit.r.pl.set_pid"> @@ -581,7 +609,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.set_pid 0.5 0.5 0.5 +... +kamcmd pl.set_pid 0.5 0.5 0.5 +... </programlisting> </section> <section id="pipelimit.r.pl.get_pid"> @@ -599,7 +629,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.get_pid +... +kamcmd pl.get_pid +... </programlisting> </section> <section id="pipelimit.r.pl.push_load"> @@ -624,7 +656,9 @@ with unexpected retcode=$var(check_result)\n"); RPC Command Format: </para> <programlisting format="linespecific"> - kamcmd pl.push_load 0.85 +... +kamcmd pl.push_load 0.85 +... </programlisting> </section> </section>