1
0
mirror of https://github.com/rtbrick/bngblaster.git synced 2024-05-06 15:54:57 +00:00
Files
rtbrick-bngblaster/docs/configuration/interfaces_links.html
2022-11-02 17:52:51 +01:00

194 lines
7.8 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &mdash; BNG Blaster 0.8 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.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"> BNG Blaster
<img src="../_static/rtbrick_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" />
<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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interfaces.html">Interfaces</a></li>
<li class="toctree-l1"><a class="reference internal" href="../access/index.html">Access Protocols</a></li>
<li class="toctree-l1"><a class="reference internal" href="../routing/index.html">Routing Protocols</a></li>
<li class="toctree-l1"><a class="reference internal" href="../streams.html">Traffic Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reports.html">Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">API/CLI</a></li>
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller</a></li>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</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">BNG Blaster</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"></a> &raquo;</li>
<li>&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/configuration/interfaces_links.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">
<p>The link configuration is optional and allows to define per interface link configurations. An explicit
link configuration with the global default settings is automatically generated if no link is defined
for interface links referenced by interface functions.</p>
<div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="w"> </span><span class="nt">&quot;interfaces&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">&quot;links&quot;</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>
</pre></div>
</div>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 50%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
<th class="head"><p>Description</p></th>
<th class="head"><p>Default</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><cite>interface</cite></p></td>
<td><p>Interface name (e.g. eth0, …)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>description</cite></p></td>
<td><p>Interface description</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>mac</cite></p></td>
<td><p>Overwrite the MAC address</p></td>
<td><p>Interface MAC address</p></td>
</tr>
<tr class="row-odd"><td><p><cite>io-mode</cite></p></td>
<td><p>Overwrite the IO mode</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>io-slots</cite></p></td>
<td><p>Overwrite the IO slots (ring size)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>io-slots-tx</cite></p></td>
<td><p>Overwrite the TX IO slots (ring size)</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>io-slots-rx</cite></p></td>
<td><p>Overwrite the RX IO slots (ring size)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>qdisc-bypass</cite></p></td>
<td><p>Overwrite the kernels qdisc layer configuration</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>tx-interval</cite></p></td>
<td><p>Overwrite the TX polling interval in milliseconds</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>rx-interval</cite></p></td>
<td><p>Overwrite the RX polling interval in milliseconds</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>tx-threads</cite></p></td>
<td><p>Overwrite the number of TX threads per interface link</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>rx-threads</cite></p></td>
<td><p>Overwrite the number of RX threads per interface link</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>tx-cpuset</cite></p></td>
<td><p>Optionally pin TX threads to CPU cores (cpuset)</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>rx-cpuset</cite></p></td>
<td><p>Optionally pin RX threads to CPU cores (cpuset)</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><cite>lag-interface</cite></p></td>
<td><p>Add interface link to LAG group</p></td>
<td></td>
</tr>
<tr class="row-odd"><td><p><cite>lacp-priority</cite></p></td>
<td><p>LACP interface priority</p></td>
<td><p>32768</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2020-2022, RtBrick, Inc..</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>