mirror of
https://github.com/LibreQoE/LibreQoS.git
synced 2026-10-25 14:20:05 -05:00
163 lines
9.6 KiB
HTML
163 lines
9.6 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Netzur Integration — LibreQoE documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />
|
|
|
|
|
|
<script src="../../_static/jquery.js"></script>
|
|
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
|
|
<script src="../../_static/doctools.js"></script>
|
|
<script src="../../_static/sphinx_highlight.js"></script>
|
|
<script src="../../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../search.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">
|
|
LibreQoE
|
|
</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">Getting Started</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart (Start Here)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="design.html">Deployment Scenarios</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="requirements.html">System Requirements</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="prereq.html">Prerequisites</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ubuntu-server.html">Install Ubuntu Server</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="bridge.html">Configure Shaping Bridge</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Managing LibreQoS (v1.5 to v2.0):</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configure LibreQoS</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="operating-modes.html">Operating Modes and Source of Truth</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="configuration-advanced.html">Advanced Configuration Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="integrations.html">CRM/NMS Integrations</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="components.html">LibreQoS Software Components</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="node-manager-ui.html">LibreQoS WebUI (Node Manager)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="scale-topology.html">Scale Planning and Topology Design</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="stormguard.html">StormGuard</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="high-availability.html">High Availability and Failure Domains</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="update.html">Upgrading</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Insight</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="insight.html">LibreQoS Insight (Insight)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api.html">LibreQoS Node API</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Misc:</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="cake.html">CAKE</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="performance-tuning.html">Performance Tuning</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="extras.html">Extras</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">LibreQoE</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">Netzur Integration</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../../_sources/docs/v2.0/integrations-netzur.md.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="netzur-integration">
|
|
<h1>Netzur Integration<a class="headerlink" href="#netzur-integration" title="Permalink to this heading"></a></h1>
|
|
<p>Netzur deployments expose subscriber and zone inventories via a REST endpoint secured with a Bearer token. Configure <code class="docutils literal notranslate"><span class="pre">/etc/lqos.conf</span></code> as follows:</p>
|
|
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[netzur_integration]</span>
|
|
<span class="na">enable_netzur</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span>
|
|
<span class="na">api_key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"your-netzur-token"</span>
|
|
<span class="na">api_url</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"https://netzur.example.com/api/libreqos"</span>
|
|
<span class="na">timeout_secs</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">60</span>
|
|
<span class="na">use_mikrotik_ipv6</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">false</span>
|
|
</pre></div>
|
|
</div>
|
|
<ul class="simple">
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">enable_netzur</span></code> toggles automatic imports by <code class="docutils literal notranslate"><span class="pre">lqos_scheduler</span></code>.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">api_key</span></code> is the Bearer token generated inside Netzur.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">api_url</span></code> must return JSON containing <code class="docutils literal notranslate"><span class="pre">zones</span></code> (mapped to sites) and <code class="docutils literal notranslate"><span class="pre">customers</span></code> (mapped to client circuits and devices).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">timeout_secs</span></code> overrides the default HTTP timeout (60 seconds) when the API is slow.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">use_mikrotik_ipv6</span></code> enriches subscriber devices with IPv6 prefixes discovered via <code class="docutils literal notranslate"><span class="pre">mikrotikDHCPRouterList.csv</span></code>.</p></li>
|
|
</ul>
|
|
<p>Run a manual import with:</p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>integrationNetzur.py
|
|
</pre></div>
|
|
</div>
|
|
<p>The integration regenerates <code class="docutils literal notranslate"><span class="pre">ShapedDevices.csv</span></code> and, unless <code class="docutils literal notranslate"><span class="pre">always_overwrite_network_json</span></code> is disabled, updates <code class="docutils literal notranslate"><span class="pre">network.json</span></code>. Adjust the Integration → Common settings if you need to preserve an existing network map between Netzur syncs.</p>
|
|
<section id="related-pages">
|
|
<h2>Related Pages<a class="headerlink" href="#related-pages" title="Permalink to this heading"></a></h2>
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="integrations.html"><span class="std std-doc">CRM/NMS Integrations</span></a></p></li>
|
|
<li><p><a class="reference internal" href="operating-modes.html"><span class="std std-doc">Operating Modes and Source of Truth</span></a></p></li>
|
|
<li><p><a class="reference internal" href="troubleshooting.html"><span class="std std-doc">Troubleshooting</span></a></p></li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2026, LibreQoE, LLC.</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> |