Skip to content

Commit

Permalink
carrierroute: docs - removed mi commands section
Browse files Browse the repository at this point in the history
  • Loading branch information
@miconda
miconda committed Jul 31, 2018
1 parent de429e1 commit 4a64fb9
Showing 1 changed file with 0 additions and 190 deletions.
190 changes: 0 additions & 190 deletions src/modules/carrierroute/doc/carrierroute_admin.xml
View file
Expand Up @@ -651,196 +651,6 @@ cr_tree_rewrite_uri(tree, domain)

<xi:include href="rpc.xml"/>

<section>
<title><acronym>MI</acronym> Commands</title>
<para>All commands understand the "-?" parameter to print a short help message.
The options have to be quoted as one string to be passed to MI interface.
Each option except host and new host can be wildcarded by * (but only * and not things
like "-d prox*").</para>
<section>
<title><function moreinfo="none">cr_reload_routes</function></title>
</section>
<section>
<title><function moreinfo="none">cr_dump_routes</function></title>
</section>
<section>
<title><function moreinfo="none">cr_replace_host</function></title>
<para>
This command can replace the rewrite_host of a route rule, it is only
usable in file mode. Following options are possible:
</para>
<itemizedlist>
<listitem>
<para><emphasis>-d</emphasis> - the domain containing the host</para>
</listitem>
<listitem>
<para><emphasis>-p</emphasis> - the prefix containing the host</para>
</listitem>
<listitem>
<para><emphasis>-h</emphasis> - the host to be replaced</para>
</listitem>
<listitem>
<para><emphasis>-t</emphasis> - the new host</para>
</listitem>
</itemizedlist>
<para>Use the "null" prefix to specify an empty prefix.</para>
<example>
<title><function>cr_replace_host</function> usage</title>
<programlisting format="linespecific">
...
&ctltool; fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">cr_deactivate_host</function></title>
<para>
This command deactivates the specified host, i.e. it sets its status to 0.
It is only usable in file mode. Following options are possible:
</para>
<itemizedlist>
<listitem>
<para><emphasis>-d</emphasis> - the domain containing the host</para>
</listitem>
<listitem>
<para><emphasis>-p</emphasis> - the prefix containing the host</para>
</listitem>
<listitem>
<para><emphasis>-h</emphasis> - the host to be deactivated</para>
</listitem>
<listitem>
<para><emphasis>-t</emphasis> - the new host used as backup</para>
</listitem>
</itemizedlist>
<para>When -t (new_host) is specified, the portion of traffic for the deactivated host
is routed to the host given by -t. This is indicated in the output of dump_routes.
The backup route is deactivated if the host is activated again.</para>
<para>Use the "null" prefix to specify an empty prefix.</para>
<example>
<title><function>cr_deactivate_host</function> usage</title>
<programlisting format="linespecific">
...
&ctltool; fifo cr_deactivate_host "-d proxy -p 49 -h proxy1"
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">cr_activate_host</function></title>
<para>
This command activates the specified host, i.e. it sets its status to 1.
It is only usable in file mode. Following options are possible:
</para>
<itemizedlist>
<listitem>
<para><emphasis>-d</emphasis> - the domain containing the host</para>
</listitem>
<listitem>
<para><emphasis>-p</emphasis> - the prefix containing the host</para>
</listitem>
<listitem>
<para><emphasis>-h</emphasis> - the host to be activated</para>
</listitem>
</itemizedlist>
<para>Use the "null" prefix to specify an empty prefix.</para>
<example>
<title><function>cr_activate_host</function> usage</title>
<programlisting format="linespecific">
...
&ctltool; fifo cr_activate_host "-d proxy -p 49 -h proxy1"
...
</programlisting>
</example>
</section>

<section>
<title><function moreinfo="none">cr_add_host</function></title>
<para>
This command adds a route rule, it is only usable in file mode. Following options
are possible:
</para>
<itemizedlist>
<listitem>
<para><emphasis>-d</emphasis> - the domain containing the host</para>
</listitem>
<listitem>
<para><emphasis>-p</emphasis> - the prefix containing the host</para>
</listitem>
<listitem>
<para><emphasis>-h</emphasis> - the host to be added</para>
</listitem>
<listitem>
<para><emphasis>-w</emphasis> - the weight of the rule</para>
</listitem>
<listitem>
<para><emphasis>-P</emphasis> - an optional rewrite prefix</para>
</listitem>
<listitem>
<para><emphasis>-S</emphasis> - an optional rewrite suffix</para>
</listitem>
<listitem>
<para><emphasis>-i</emphasis> - an optional hash index</para>
</listitem>
<listitem>
<para><emphasis>-s</emphasis> - an optional strip value</para>
</listitem>
</itemizedlist>
<para>Use the "null" prefix to specify an empty prefix.</para>
<example>
<title><function>cr_add_host</function> usage</title>
<programlisting format="linespecific">
...
&ctltool; fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
...
</programlisting>
</example>
</section>

<section>
<title><function moreinfo="none">cr_delete_host</function></title>
<para>
This command delete the specified hosts or rules, i.e. remove
them from the route tree. It is only usable in file mode.
Following options are possible:
</para>
<itemizedlist>
<listitem>
<para><emphasis>-d</emphasis> - the domain containing the host</para>
</listitem>
<listitem>
<para><emphasis>-p</emphasis> - the prefix containing the host</para>
</listitem>
<listitem>
<para><emphasis>-h</emphasis> - the host to be added</para>
</listitem>
<listitem>
<para><emphasis>-w</emphasis> - the weight of the rule</para>
</listitem>
<listitem>
<para><emphasis>-P</emphasis> - an optional rewrite prefix</para>
</listitem>
<listitem>
<para><emphasis>-S</emphasis> - an optional rewrite suffix</para>
</listitem>
<listitem>
<para><emphasis>-i</emphasis> - an optional hash index</para>
</listitem>
<listitem>
<para><emphasis>-s</emphasis> - an optional strip value</para>
</listitem>
</itemizedlist>
<para>Use the "null" prefix to specify an empty prefix.</para>
<example>
<title><function>cr_delete_host</function> usage</title>
<programlisting format="linespecific">
...
&ctltool; fifo cr_delete_host "-d proxy -p 49 -h proxy1 -w 0.25"
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Configuration examples</title>
<example>
Expand Down

0 comments on commit 4a64fb9

Please sign in to comment.