diff options
| author | DmitriyEshenko <DmitriyEshenko@users.noreply.github.com> | 2024-05-31 19:24:37 +0000 |
|---|---|---|
| committer | DmitriyEshenko <DmitriyEshenko@users.noreply.github.com> | 2024-05-31 19:24:37 +0000 |
| commit | 632b351cfd0c9964a38fb0ba8ae651e88d4861dd (patch) | |
| tree | fe775174c8f3182aa28f8c760ebdaec41febfc78 /guides | |
| download | accel-ppp.github.io-632b351cfd0c9964a38fb0ba8ae651e88d4861dd.tar.gz accel-ppp.github.io-632b351cfd0c9964a38fb0ba8ae651e88d4861dd.zip | |
deploy: edadda488d6146b60d2cc42219cf50c25701c797
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/BRAS_tuning.html | 241 | ||||
| -rw-r--r-- | guides/control_features.html | 219 | ||||
| -rw-r--r-- | guides/radius_features.html | 147 | ||||
| -rw-r--r-- | guides/recommendations.html | 176 |
4 files changed, 783 insertions, 0 deletions
diff --git a/guides/BRAS_tuning.html b/guides/BRAS_tuning.html new file mode 100644 index 0000000..742b8cd --- /dev/null +++ b/guides/BRAS_tuning.html @@ -0,0 +1,241 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>BRAS tuning — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="RADIUS and DM/CoA features" href="radius_features.html" /> + <link rel="prev" title="Recommendations" href="recommendations.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="recommendations.html">Recommendations</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">BRAS tuning</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#network-tuning">Network tuning</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#disable-kernel-mitigations-to-maximize-performance">Disable kernel mitigations to maximize performance</a></li> +<li class="toctree-l3"><a class="reference internal" href="#disable-nic-offloads">Disable NIC offloads</a></li> +<li class="toctree-l3"><a class="reference internal" href="#fix-download-speed-problem-shaper">Fix Download speed problem (shaper)</a></li> +<li class="toctree-l3"><a class="reference internal" href="#default-rate-limits-shaper">Default rate limits (shaper)</a></li> +<li class="toctree-l3"><a class="reference internal" href="#change-pppoe-mtu">Change PPPoE MTU</a></li> +<li class="toctree-l3"><a class="reference internal" href="#hotplug-optimization">Hotplug optimization</a></li> +<li class="toctree-l3"><a class="reference internal" href="#systemd-udev-optimizations">SYSTEMD-UDEV optimizations</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">BRAS tuning</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/guides/BRAS_tuning.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="bras-tuning"> +<h1>BRAS tuning<a class="headerlink" href="#bras-tuning" title="Link to this heading"></a></h1> +<p>Recommendations for BRAS (Broadband Remote Access Server) performance.</p> +<section id="network-tuning"> +<h2>Network tuning<a class="headerlink" href="#network-tuning" title="Link to this heading"></a></h2> +<section id="disable-kernel-mitigations-to-maximize-performance"> +<h3>Disable kernel mitigations to maximize performance<a class="headerlink" href="#disable-kernel-mitigations-to-maximize-performance" title="Link to this heading"></a></h3> +<p>Edit file <code class="docutils literal notranslate"><span class="pre">/etc/default/grub</span></code></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">GRUB_CMDLINE_LINUX_DEFAULT</span><span class="o">=</span><span class="s2">"intel_idle.max_cstate=0 processor.max_cstate=1 idle=poll quiet mitigations=off"</span> +</pre></div> +</div> +<p>Additional GRUB CMD arguments:</p> +<blockquote> +<div><ul class="simple"> +<li><p>ixgbe.allow_unsupported_sfp=1 - Allow to use not original Intel SFP+ modules</p></li> +<li><p>pcie_aspm=off - Disable Active-State Power Management</p></li> +</ul> +</div></blockquote> +<p>After saving, please update grub settings</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">$sudo</span><span class="w"> </span>update-grub +</pre></div> +</div> +<p>Warning! Enabling the idle loop (<code class="docutils literal notranslate"><span class="pre">idle=poll</span></code>) parameter can cause 100% CPU utilization on your VM (if you’re using virtual enviroments like ProxMox, VMWare, etc.)</p> +</section> +<section id="disable-nic-offloads"> +<h3>Disable NIC offloads<a class="headerlink" href="#disable-nic-offloads" title="Link to this heading"></a></h3> +<p>Disable hardware offloads,increase Tx/Rx buffers and queue length on your NICs to prevent speed problems. +Please note, that GSO offload changed to tx-gso-partial in Linux kernels 4.15 and later.</p> +<p>Debian <code class="docutils literal notranslate"><span class="pre">/etc/network/interfaces</span></code>:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>allow-hotplug<span class="w"> </span>eth0 +iface<span class="w"> </span>eth0<span class="w"> </span>inet<span class="w"> </span>manual +<span class="w"> </span>up<span class="w"> </span>ethtool<span class="w"> </span>-K<span class="w"> </span>eth0<span class="w"> </span>tso<span class="w"> </span>off<span class="w"> </span>gso<span class="w"> </span>off<span class="w"> </span>gro<span class="w"> </span>off<span class="w"> </span>rxvlan<span class="w"> </span>off<span class="w"> </span>txvlan<span class="w"> </span>off<span class="w"> </span>rx-vlan-filter<span class="w"> </span>off<span class="w"> </span>ntuple<span class="w"> </span>on<span class="w"> </span><span class="p">&</span>><span class="w"> </span>/dev/null +<span class="w"> </span>up<span class="w"> </span>ethtool<span class="w"> </span>-K<span class="w"> </span>eth0<span class="w"> </span>tx-gso-partial<span class="w"> </span>off<span class="w"> </span><span class="p">&</span>><span class="w"> </span>/dev/null +<span class="w"> </span>up<span class="w"> </span>ethtool<span class="w"> </span>-G<span class="w"> </span>eth0<span class="w"> </span>rx<span class="w"> </span><span class="m">4096</span><span class="w"> </span>tx<span class="w"> </span><span class="m">4096</span><span class="w"> </span><span class="p">&</span>><span class="w"> </span>/dev/null +<span class="w"> </span>up<span class="w"> </span>ip<span class="w"> </span>link<span class="w"> </span><span class="nb">set</span><span class="w"> </span>eth0<span class="w"> </span>txqueuelen<span class="w"> </span><span class="m">10000</span><span class="w"> </span><span class="p">&</span>><span class="w"> </span>/dev/null +</pre></div> +</div> +<p>Please determine your NIC queue and buffers limit before increase:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ethtool<span class="w"> </span>-g<span class="w"> </span>eth0 +</pre></div> +</div> +</section> +<section id="fix-download-speed-problem-shaper"> +<h3>Fix Download speed problem (shaper)<a class="headerlink" href="#fix-download-speed-problem-shaper" title="Link to this heading"></a></h3> +<p>Change shaper from htb to tbf</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>shaper<span class="o">]</span> +… +down-limiter<span class="o">=</span>tbf +</pre></div> +</div> +</section> +<section id="default-rate-limits-shaper"> +<h3>Default rate limits (shaper)<a class="headerlink" href="#default-rate-limits-shaper" title="Link to this heading"></a></h3> +<p>If radius-server Access-Accept answer has no compatible speed attributes - to prevent unlimited session speed you can add default rate-limits (in Kbps).</p> +<p><code class="docutils literal notranslate"><span class="pre">nano</span> <span class="pre">/etc/accel-ppp.conf</span></code></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>shaper<span class="o">]</span> +rate-limit<span class="o">=</span><span class="m">888</span>/888 +</pre></div> +</div> +</section> +<section id="change-pppoe-mtu"> +<h3>Change PPPoE MTU<a class="headerlink" href="#change-pppoe-mtu" title="Link to this heading"></a></h3> +<p>You can adjust allowed PPPoE min/max MTU/MRU settings: +<code class="docutils literal notranslate"><span class="pre">nano</span> <span class="pre">/etc/accel-ppp.conf</span></code></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="o">[</span>ppp<span class="o">]</span> +<span class="nv">verbose</span><span class="o">=</span><span class="m">1</span> +min-mtu<span class="o">=</span><span class="m">1280</span> +<span class="nv">mtu</span><span class="o">=</span><span class="m">1492</span> +<span class="nv">mru</span><span class="o">=</span><span class="m">1492</span> +</pre></div> +</div> +</section> +<section id="hotplug-optimization"> +<h3>Hotplug optimization<a class="headerlink" href="#hotplug-optimization" title="Link to this heading"></a></h3> +<p>To generate hotplug events on IPoE interfaces (Debian 10):</p> +<p><code class="docutils literal notranslate"><span class="pre">nano</span> <span class="pre">/lib/udev/ifupdown-hotplug</span></code></p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="k">case</span><span class="w"> </span><span class="s2">"</span><span class="nv">$ACTION</span><span class="s2">"</span><span class="w"> </span><span class="k">in</span> +add<span class="o">)</span> +<span class="c1"># these interfaces generate hotplug events *after* they are brought up</span> +<span class="k">case</span><span class="w"> </span><span class="nv">$INTERFACE</span><span class="w"> </span><span class="k">in</span> +<span class="w"> </span>ppp*<span class="p">|</span>ippp*<span class="p">|</span>isdn*<span class="p">|</span>plip*<span class="p">|</span>lo<span class="p">|</span>irda*<span class="p">|</span>ipsec* +</pre></div> +</div> +<p>just add <code class="docutils literal notranslate"><span class="pre">|ipoe*</span></code> after <code class="docutils literal notranslate"><span class="pre">|ipsec*</span></code></p> +<p>repeat with file <code class="docutils literal notranslate"><span class="pre">/lib/udev/net.agent</span></code></p> +</section> +<section id="systemd-udev-optimizations"> +<h3>SYSTEMD-UDEV optimizations<a class="headerlink" href="#systemd-udev-optimizations" title="Link to this heading"></a></h3> +<ol class="arabic simple"> +<li><p>Delete <code class="docutils literal notranslate"><span class="pre">99-default.link</span></code> from <code class="docutils literal notranslate"><span class="pre">/lib/systemd/network/</span></code> directory</p></li> +</ol> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>rm<span class="w"> </span>/lib/systemd/network/99-default.link +</pre></div> +</div> +<ol class="arabic simple" start="2"> +<li><p>Change <code class="docutils literal notranslate"><span class="pre">/lib/udev/rules.d/99-systemd.rules</span></code></p></li> +</ol> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">ACTION</span><span class="o">==</span><span class="s2">"add"</span>,<span class="w"> </span><span class="nv">SUBSYSTEM</span><span class="o">==</span><span class="s2">"net"</span>,<span class="w"> </span>KERNEL!<span class="o">=</span><span class="s2">"lo|ppp*|ipoe*"</span>,<span class="w"> </span><span class="nv">RUN</span><span class="o">+=</span><span class="s2">"/lib/systemd/systemd-sysctl --prefix=/net/ipv4/conf/</span><span class="nv">$name</span><span class="s2"> --prefix=/net/ipv4/neigh/</span><span class="nv">$name</span><span class="s2"> --prefix=/net/ipv6/conf/</span><span class="nv">$name</span><span class="s2"> --prefix=/net/ipv6/neigh/</span><span class="nv">$name</span><span class="s2">"</span> +</pre></div> +</div> +<p>Add <code class="docutils literal notranslate"><span class="pre">|ppp*|ipoe*</span></code> to <code class="docutils literal notranslate"><span class="pre">KERNEL!="lo"</span></code></p> +<ol class="arabic simple" start="3"> +<li><p>Change <code class="docutils literal notranslate"><span class="pre">/lib/udev/rules.d/80-ifupdown.rules</span></code></p></li> +</ol> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nv">SUBSYSTEM</span><span class="o">==</span><span class="s2">"net"</span>,<span class="w"> </span><span class="nv">ACTION</span><span class="o">==</span><span class="s2">"add|remove"</span>,<span class="w"> </span>KERNEL!<span class="o">=</span><span class="s2">"ppp*|ipoe*"</span>,<span class="w"> </span><span class="nv">RUN</span><span class="o">+=</span><span class="s2">"ifupdown-hotplug"</span> +</pre></div> +</div> +<p>Add <code class="docutils literal notranslate"><span class="pre">KERNEL!="ppp*|ipoe*"</span></code></p> +</section> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="recommendations.html" class="btn btn-neutral float-left" title="Recommendations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="radius_features.html" class="btn btn-neutral float-right" title="RADIUS and DM/CoA features" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/guides/control_features.html b/guides/control_features.html new file mode 100644 index 0000000..1b93c9c --- /dev/null +++ b/guides/control_features.html @@ -0,0 +1,219 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Control features — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Recommendations" href="recommendations.html" /> + <link rel="prev" title="SNMP" href="../configuration/snmp.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Control features</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#accel-cmd">accel-cmd</a></li> +<li class="toctree-l2"><a class="reference internal" href="#telnet">telnet</a></li> +<li class="toctree-l2"><a class="reference internal" href="#radius-coa">radius CoA</a></li> +<li class="toctree-l2"><a class="reference internal" href="#snmp">snmp</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Control features</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/guides/control_features.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="control-features"> +<h1>Control features<a class="headerlink" href="#control-features" title="Link to this heading"></a></h1> +<p>Accel-ppp support next features for control daemon and sessions:</p> +<blockquote> +<div><ul class="simple"> +<li><p><code class="docutils literal notranslate"><span class="pre">accel-cmd</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">telnet</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">snmp</span></code></p></li> +<li><p><code class="docutils literal notranslate"><span class="pre">RADIUS</span> <span class="pre">COA</span></code></p></li> +</ul> +</div></blockquote> +<p>Common available commands for <code class="docutils literal notranslate"><span class="pre">accel-cmd</span></code> and <code class="docutils literal notranslate"><span class="pre">telnet</span></code>. Also possible show this help message with one of commands <code class="docutils literal notranslate"><span class="pre">accel-cmd</span> <span class="pre">help</span></code> and <code class="docutils literal notranslate"><span class="pre">telnet</span> <span class="pre">127.0.0.1</span>  <span class="pre">2000</span></code> then run <code class="docutils literal notranslate"><span class="pre">help</span></code>.</p> +<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>show stat - shows various statistics information +terminate if <interface> [soft|hard]- terminate session by interface name + [match] username <username> [soft|hard]- terminate session by username + ip <address> [soft|hard]- terminate session by ip address + csid <id> [soft|hard]- terminate session by calling station id + sid <id> [soft|hard]- terminate session by session id + all [soft|hard]- terminate all sessions +reload - reload config file +restart [hard] - restart daemon + hard - restart immediatly + default action - terminate all connections then restart +shutdown [soft|hard|cancel]- shutdown daemon + default action - send termination signals to all clients and wait everybody disconnects + soft - wait until all clients disconnects, don't accept new connections + hard - shutdown now, don't wait anything + cancel - cancel 'shutdown soft' and return to normal operation +exit - exit cli +show sessions [columns] [order <column>] [match <column> <regexp>] - shows sessions + columns: + netns - network namespace name + ifname - interface name + username - user name + ip - IP address + ip6 - IPv6 address + ip6-dp - IPv6 delegated prefix + type - VPN type + state - state of session + uptime - uptime (human readable) + uptime-raw - uptime (in seconds) + calling-sid - calling station id + called-sid - called station id + sid - session id + comp - compression/encryption method + rx-bytes - received bytes (human readable) + tx-bytes - transmitted bytes (human readable) + rx-bytes-raw - received bytes + tx-bytes-raw - transmitted bytes + rx-pkts - received packets + tx-pkts - transmitted packets + ipoe-type - IPoE session type + rate-limit - rate limit down-stream/up-stream (Kbit) +pppoe mac-filter reload - reload mac-filter file +pppoe mac-filter add <address> - add address to mac-filter list +pppoe mac-filter del <address> - delete address from mac-filter list +pppoe mac-filter show - show current mac-filter list +pppoe interface add <name> - start pppoe server on specified interface +pppoe interface del <name> - stop pppoe server on specified interface and drop his connections +pppoe interface show - show interfaces on which pppoe server started +pppoe set verbose <n> - set verbosity of pppoe logging +pppoe set PADO-delay <delay[,delay1:count1[,delay2:count2[,...]]]> - set PADO delays (ms) +pppoe set Service-Name <name> - set Service-Name to respond +pppoe set Service-Name * - respond with client's Service-Name +pppoe set AC-Name <name> - set AC-Name tag value +pppoe show verbose - show current verbose value +pppoe show PADO-delay - show current PADO delay value +pppoe show Service-Name - show current Service-Name value +pppoe show AC-Name - show current AC-Name tag value +shaper change <interface> <value> [temp] - change shaper on specified interface, if temp is set then previous settings may be restored later by 'shaper restore' +shaper change all <value> [temp] - change shaper on all interfaces, if temp is set also new interfaces will have specified shaper value +shaper restore <interface> - restores shaper settings on specified interface made by 'shaper change' command with 'temp' flag +shaper restore all - restores shaper settings on all interfaces made by 'shaper change' command with 'temp' flag +</pre></div> +</div> +<section id="accel-cmd"> +<h2>accel-cmd<a class="headerlink" href="#accel-cmd" title="Link to this heading"></a></h2> +<p>This application is very powerful and often used if you have <cite>cli</cite> connection. Be default accel-ppp listen <em>TCP</em> port <em>2000</em> for input/output with accel-cmd. However <cite>telnet</cite> has same functions, but <cite>accel-cmd</cite> is more comfortable, allow send command without enter in to another environment. Detail about cli you may read at <a class="reference internal" href="../configuration/cli.html#cli-configuration"><span class="std std-ref">[cli]</span></a> .Let’s revise <cite>accel-cmd</cite> possible commands.</p> +<blockquote> +<div><ul class="simple"> +<li><p><cite>accel-cmd show stat</cite> - one of more important command, allow display <em>accel-ppp</em> daemon statistics and information about connections types and something counters such as RADIUS auth, acct summary and lost queries. Detail below:</p></li> +</ul> +</div></blockquote> +</section> +<section id="telnet"> +<h2>telnet<a class="headerlink" href="#telnet" title="Link to this heading"></a></h2> +</section> +<section id="radius-coa"> +<h2>radius CoA<a class="headerlink" href="#radius-coa" title="Link to this heading"></a></h2> +<p>Example, terminate session by username: <code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">User-Name=username</span> <span class="pre">|</span> <span class="pre">radclient</span> <span class="pre">-x</span> <span class="pre">127.0.0.1:3799</span> <span class="pre">disconnect</span> <span class="pre">testing123</span></code>.</p> +</section> +<section id="snmp"> +<h2>snmp<a class="headerlink" href="#snmp" title="Link to this heading"></a></h2> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="../configuration/snmp.html" class="btn btn-neutral float-left" title="SNMP" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="recommendations.html" class="btn btn-neutral float-right" title="Recommendations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/guides/radius_features.html b/guides/radius_features.html new file mode 100644 index 0000000..1de8bf4 --- /dev/null +++ b/guides/radius_features.html @@ -0,0 +1,147 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>RADIUS and DM/CoA features — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="Examples" href="../examples/examples.html" /> + <link rel="prev" title="BRAS tuning" href="BRAS_tuning.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="control_features.html">Control features</a></li> +<li class="toctree-l1"><a class="reference internal" href="recommendations.html">Recommendations</a></li> +<li class="toctree-l1"><a class="reference internal" href="BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">RADIUS and DM/CoA features</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#set-vrf-via-coa">Set VRF via CoA</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">RADIUS and DM/CoA features</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/guides/radius_features.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="radius-and-dm-coa-features"> +<h1>RADIUS and DM/CoA features<a class="headerlink" href="#radius-and-dm-coa-features" title="Link to this heading"></a></h1> +<p>Since from commit version 385c403 accel-ppp support VRF (Virtual Routing and Forwarding).</p> +<p>Usually, this feature is useful to isolate clients e.g. put client interface to some context with different routing and firewall rules. +User interface can be put to VRF context via RADIUS Access-Accept packet, or change it via RADIUS CoA.</p> +<p>Accel-ppp uses own RADIUS vendor dictionary <a class="reference external" href="https://github.com/accel-ppp/accel-ppp/blob/master/accel-pppd/radius/dict/dictionary.accel">https://github.com/accel-ppp/accel-ppp/blob/master/accel-pppd/radius/dict/dictionary.accel</a> and RADIUS attribute <code class="docutils literal notranslate"><span class="pre">Accel-VRF-Name</span></code></p> +<p>All VRFs should be manually created in advance:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ip<span class="w"> </span>link<span class="w"> </span>add<span class="w"> </span>VRF_NAME<span class="w"> </span><span class="nb">type</span><span class="w"> </span>vrf<span class="w"> </span>table<span class="w"> </span>RT_TABLE_ID +ip<span class="w"> </span>link<span class="w"> </span><span class="nb">set</span><span class="w"> </span>dev<span class="w"> </span>VRF_NAME<span class="w"> </span>up +</pre></div> +</div> +<p>Linux VRF documentation <a class="reference external" href="https://www.kernel.org/doc/Documentation/networking/vrf.txt">https://www.kernel.org/doc/Documentation/networking/vrf.txt</a></p> +<p>If <code class="docutils literal notranslate"><span class="pre">Accel-VRF-Name</span></code> is used in Access-Accept message, but VRF was not created then the session will not be established.</p> +<section id="set-vrf-via-coa"> +<h2>Set VRF via CoA<a class="headerlink" href="#set-vrf-via-coa" title="Link to this heading"></a></h2> +<p>Put user interface to some VRF context</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s1">'User-Name=bob, Accel-VRF-Name="red"'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>radclient<span class="w"> </span>-x<span class="w"> </span><span class="m">127</span>.0.0.1:3799<span class="w"> </span>coa<span class="w"> </span>testing123 +</pre></div> +</div> +<p>Delete user interface from VRF context</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">echo</span><span class="w"> </span><span class="s1">'User-Name=bob, Accel-VRF-Name="0"'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>radclient<span class="w"> </span>-x<span class="w"> </span><span class="m">127</span>.0.0.1:3799<span class="w"> </span>coa<span class="w"> </span>testing123 +</pre></div> +</div> +<p>If <code class="docutils literal notranslate"><span class="pre">Accel-VRF-Name</span></code> is used in CoA message and VRF does not exist then CoA-NAK will be sent.</p> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="BRAS_tuning.html" class="btn btn-neutral float-left" title="BRAS tuning" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="../examples/examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file diff --git a/guides/recommendations.html b/guides/recommendations.html new file mode 100644 index 0000000..340933f --- /dev/null +++ b/guides/recommendations.html @@ -0,0 +1,176 @@ +<!DOCTYPE html> +<html class="writer-html5" lang="en" data-content_root="../"> +<head> + <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> + + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>Recommendations — Accel-ppp 1.12 documentation</title> + <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> + <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + <!--[if lt IE 9]> + <script src="../_static/js/html5shiv.min.js"></script> + <![endif]--> + + <script src="../_static/jquery.js?v=5d32c60e"></script> + <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> + <script src="../_static/documentation_options.js?v=2d52a127"></script> + <script src="../_static/doctools.js?v=9a2dae69"></script> + <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> + <script src="../_static/js/theme.js"></script> + <link rel="index" title="Index" href="../genindex.html" /> + <link rel="search" title="Search" href="../search.html" /> + <link rel="next" title="BRAS tuning" href="BRAS_tuning.html" /> + <link rel="prev" title="Control features" href="control_features.html" /> +</head> + +<body class="wy-body-for-nav"> + <div class="wy-grid-for-nav"> + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search" > + + + + <a href="../index.html" class="icon icon-home"> + Accel-ppp + <img src="../_static/logo.png" class="logo" alt="Logo"/> + </a> +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> + <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../installation/install.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../configuration/configuration.html">Configuration</a></li> +<li class="toctree-l1"><a class="reference internal" href="control_features.html">Control features</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Recommendations</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#enable-forwarding">Enable forwarding</a></li> +<li class="toctree-l2"><a class="reference internal" href="#mtu">MTU</a></li> +<li class="toctree-l2"><a class="reference internal" href="#increase-arp-cache-size">Increase ARP cache size</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="BRAS_tuning.html">BRAS tuning</a></li> +<li class="toctree-l1"><a class="reference internal" href="radius_features.html">RADIUS and DM/CoA features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/index.html">Debugging</a></li> +<li class="toctree-l1"><a class="reference internal" href="../debugging/faq.html">FAQ</a></li> +</ul> + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Accel-ppp</a> + </nav> + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="Page navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> + <li class="breadcrumb-item active">Recommendations</li> + <li class="wy-breadcrumbs-aside"> + <a href="../_sources/guides/recommendations.rst.txt" rel="nofollow"> View page source</a> + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> + <div itemprop="articleBody"> + + <section id="recommendations"> +<h1>Recommendations<a class="headerlink" href="#recommendations" title="Link to this heading"></a></h1> +<section id="enable-forwarding"> +<h2>Enable forwarding<a class="headerlink" href="#enable-forwarding" title="Link to this heading"></a></h2> +<p>To enable packet forwarding need edit /etc/sysctl.conf and add or uncomment next:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>net.ipv4.ip_forward<span class="o">=</span><span class="m">1</span> +net.ipv6.conf.all.forwarding<span class="o">=</span><span class="m">1</span> +</pre></div> +</div> +<p>For apply this params now, use command <code class="docutils literal notranslate"><span class="pre">sysctl</span> <span class="pre">-p</span></code> or after reboot server this params will be applied automatically.</p> +</section> +<section id="mtu"> +<h2>MTU<a class="headerlink" href="#mtu" title="Link to this heading"></a></h2> +<p>If used vlan-per-user often required 802.1ad standard also called as QinQ or Q-in-Q, then need to set MTU on main interface and S-VLAN, because adding to headed one more field. +Interface which using QinQ usually consist of <code class="docutils literal notranslate"><span class="pre"><interface_name>.<S-VLAN>.<C-VLAN></span></code>. +S-VLAN (Service VLAN) is TAG which wrap C-VLAN (Customer VLAN).</p> +<p>As example:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>MTU +<span class="w"> </span><span class="m">1504</span> +<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">1504</span> +<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="m">1500</span> +<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span> +<span class="w"> </span>eth0.2001.101 +<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span> +<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>C-VLAN +<span class="w"> </span><span class="p">|</span><span class="w"> </span>S-VLAN +<span class="w"> </span>Interface +</pre></div> +</div> +<p>Set up MTU on interface eth0 and interface with S-VLAN</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ip<span class="w"> </span>link<span class="w"> </span><span class="nb">set</span><span class="w"> </span>eth0<span class="w"> </span>mtu<span class="w"> </span><span class="m">1504</span> +ip<span class="w"> </span>link<span class="w"> </span><span class="nb">set</span><span class="w"> </span>eth0.2001<span class="w"> </span>mtu<span class="w"> </span><span class="m">1504</span> +</pre></div> +</div> +<div class="admonition-note admonition"> +<p class="admonition-title">Note:</p> +<p>If used <code class="docutils literal notranslate"><span class="pre">bonding</span></code> need change MTU on <em>bonding</em> (bond0) and <em>slaves</em> (eth0, eth1 …) interfaces.</p> +</div> +</section> +<section id="increase-arp-cache-size"> +<h2>Increase ARP cache size<a class="headerlink" href="#increase-arp-cache-size" title="Link to this heading"></a></h2> +<p>If accel-ppp used as DHCP BRAS important to increase ARP cache size, otherwise you can cache overflow and clients have lost connections. Edit /etc/sysctl.conf and add next:</p> +<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>net.ipv4.neigh.default.gc_thresh1<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4096</span> +net.ipv4.neigh.default.gc_thresh2<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8192</span> +net.ipv4.neigh.default.gc_thresh3<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">12288</span> +net.ipv6.neigh.default.gc_thresh1<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">4096</span> +net.ipv6.neigh.default.gc_thresh2<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">8192</span> +net.ipv6.neigh.default.gc_thresh3<span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">12288</span> +</pre></div> +</div> +<p>For apply this params now, use command <code class="docutils literal notranslate"><span class="pre">sysctl</span> <span class="pre">-p</span></code> or after reboot server this params will be applied automatically.</p> +</section> +</section> + + + </div> + </div> + <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> + <a href="control_features.html" class="btn btn-neutral float-left" title="Control features" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> + <a href="BRAS_tuning.html" class="btn btn-neutral float-right" title="BRAS tuning" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> + </div> + + <hr/> + + <div role="contentinfo"> + <p>© Copyright 2023, Accel-ppp Dev.</p> + </div> + + Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a + <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> + provided by <a href="https://readthedocs.org">Read the Docs</a>. + + +</footer> + </div> + </div> + </section> + </div> + <script> + jQuery(function () { + SphinxRtdTheme.Navigation.enable(true); + }); + </script> + +</body> +</html>
\ No newline at end of file |