Skip to content

Commit 3924b88

Browse files
GIC-deGIC-de
committed
github pages
1 parent 07d9591 commit 3924b88

10 files changed

Lines changed: 257 additions & 3 deletions

File tree

‎docs/_sources/api/dhcp.rst.txt‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+-----------------------------------+----------------------------------------------------------------------+
2+
| Command | Description |
3+
+===================================+======================================================================+
4+
| **dhcp-start** | | Start DHCP client. |
5+
| | | |
6+
| | | **Arguments:** |
7+
| | | ``session-id`` |
8+
| | | ``session-group-id`` (ignored if session-id is present) |
9+
+-----------------------------------+----------------------------------------------------------------------+
10+
| **dhcp-stop** | | Stop DHCP client without sending a release message. |
11+
| | | |
12+
| | | **Arguments:** |
13+
| | | ``session-id`` |
14+
| | | ``session-group-id`` (ignored if session-id is present) |
15+
| | | ``keep-address`` remember last address (init-reboot) |
16+
+-----------------------------------+----------------------------------------------------------------------+
17+
| **dhcp-release** | | Stop DHCP client with sending release messages. |
18+
| | | |
19+
| | | **Arguments:** |
20+
| | | ``session-id`` |
21+
| | | ``session-group-id`` (ignored if session-id is present) |
22+
+-----------------------------------+----------------------------------------------------------------------+

‎docs/_sources/api/index.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,10 @@ IGMP
186186
----
187187
.. include:: igmp.rst
188188

189+
DHCP
190+
----
191+
.. include:: dhcp.rst
192+
189193
Traffic
190194
-------
191195
.. include:: traffic.rst

‎docs/_sources/configuration/dhcp.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
| **release-interval** | | DHCP release interval. |
2121
| | | Default: 1 |
2222
+-----------------------------------+----------------------------------------------------------------------+
23-
| **release-retry** | | DHCP release retry (0 means disabled/stop witout release message). |
23+
| **release-retry** | | DHCP release retry. |
2424
| | | Default: 3 |
2525
+-----------------------------------+----------------------------------------------------------------------+
2626
| **tos** | | IPv4 TOS for all DHCP control traffic. |
@@ -37,4 +37,4 @@
3737
| **keep-address** | | Emulates init-reboot on stop if enabled together with |
3838
| | | release-retry set to zero (disabled). |
3939
| | | Default: false |
40-
+-----------------------------------+----------------------------------------------------------------------+
40+
+-----------------------------------+----------------------------------------------------------------------+

‎docs/access/ipoe.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,14 @@ <h3>DHCP<a class="headerlink" href="#dhcp" title="Link to this heading"></a><
313313
</div>
314314
</td>
315315
</tr>
316+
<tr class="row-even"><td><p><strong>keep-address</strong></p></td>
317+
<td><div class="line-block">
318+
<div class="line">Emulates init-reboot on stop if enabled together with</div>
319+
<div class="line">release-retry set to zero (disabled).</div>
320+
<div class="line">Default: false</div>
321+
</div>
322+
</td>
323+
</tr>
316324
</tbody>
317325
</table>
318326
</section>

‎docs/api/dhcp.html‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" data-content_root="../">
3+
<head>
4+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>&lt;no title&gt; &mdash; BNG Blaster 0.9 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
9+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
10+
<link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=a5c4661c" />
11+
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=411f5019" />
12+
13+
14+
<!--[if lt IE 9]>
15+
<script src="../_static/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
18+
<script src="../_static/jquery.js?v=5d32c60e"></script>
19+
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20+
<script src="../_static/documentation_options.js?v=049aceee"></script>
21+
<script src="../_static/doctools.js?v=888ff710"></script>
22+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
23+
<script src="../_static/js/theme.js"></script>
24+
<link rel="index" title="Index" href="../genindex.html" />
25+
<link rel="search" title="Search" href="../search.html" />
26+
</head>
27+
28+
<body class="wy-body-for-nav">
29+
<div class="wy-grid-for-nav">
30+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
31+
<div class="wy-side-scroll">
32+
<div class="wy-side-nav-search" >
33+
34+
35+
36+
<a href="../index.html" class="icon icon-home">
37+
BNG Blaster
38+
<img src="../_static/rtbrick_logo.png" class="logo" alt="Logo"/>
39+
</a>
40+
<div role="search">
41+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
42+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
43+
<input type="hidden" name="check_keywords" value="yes" />
44+
<input type="hidden" name="area" value="default" />
45+
</form>
46+
</div>
47+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
48+
<ul>
49+
<li class="toctree-l1"><a class="reference internal" href="../install.html">Installation</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart Guide</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../interfaces.html">Interfaces</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../access/index.html">Access Protocols</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../routing/index.html">Routing Protocols</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="../streams.html">Traffic Streams</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="../icmp.html">ICMP</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="../http.html">HTTP Emulation</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="../nat.html">NAT / CGNAT</a></li>
58+
<li class="toctree-l1"><a class="reference internal" href="../reports.html">Reports</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuration</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="index.html">API/CLI</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="../controller.html">Controller</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="../performance.html">Performance Guide</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html">Troubleshooting</a></li>
64+
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
65+
</ul>
66+
67+
</div>
68+
</div>
69+
</nav>
70+
71+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
72+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
73+
<a href="../index.html">BNG Blaster</a>
74+
</nav>
75+
76+
<div class="wy-nav-content">
77+
<div class="rst-content">
78+
<div role="navigation" aria-label="Page navigation">
79+
<ul class="wy-breadcrumbs">
80+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
81+
<li class="breadcrumb-item active">&lt;no title&gt;</li>
82+
<li class="wy-breadcrumbs-aside">
83+
<a href="../_sources/api/dhcp.rst.txt" rel="nofollow"> View page source</a>
84+
</li>
85+
</ul>
86+
<hr/>
87+
</div>
88+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
89+
<div itemprop="articleBody">
90+
91+
<table class="docutils align-default">
92+
<thead>
93+
<tr class="row-odd"><th class="head"><p>Command</p></th>
94+
<th class="head"><p>Description</p></th>
95+
</tr>
96+
</thead>
97+
<tbody>
98+
<tr class="row-even"><td><p><strong>dhcp-start</strong></p></td>
99+
<td><div class="line-block">
100+
<div class="line">Start DHCP client.</div>
101+
<div class="line"><br /></div>
102+
<div class="line"><strong>Arguments:</strong></div>
103+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
104+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
105+
</div>
106+
</td>
107+
</tr>
108+
<tr class="row-odd"><td><p><strong>dhcp-stop</strong></p></td>
109+
<td><div class="line-block">
110+
<div class="line">Stop DHCP client without sending a release message.</div>
111+
<div class="line"><br /></div>
112+
<div class="line"><strong>Arguments:</strong></div>
113+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
114+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
115+
<div class="line"><code class="docutils literal notranslate"><span class="pre">keep-address</span></code> remember last address (init-reboot)</div>
116+
</div>
117+
</td>
118+
</tr>
119+
<tr class="row-even"><td><p><strong>dhcp-release</strong></p></td>
120+
<td><div class="line-block">
121+
<div class="line">Stop DHCP client with sending release messages.</div>
122+
<div class="line"><br /></div>
123+
<div class="line"><strong>Arguments:</strong></div>
124+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
125+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
126+
</div>
127+
</td>
128+
</tr>
129+
</tbody>
130+
</table>
131+
132+
133+
</div>
134+
</div>
135+
<footer>
136+
137+
<hr/>
138+
139+
<div role="contentinfo">
140+
<p>&#169; Copyright 2020-2026, RtBrick, Inc..</p>
141+
</div>
142+
143+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
144+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
145+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
146+
147+
148+
</footer>
149+
</div>
150+
</div>
151+
</section>
152+
</div>
153+
<script>
154+
jQuery(function () {
155+
SphinxRtdTheme.Navigation.enable(true);
156+
});
157+
</script>
158+
159+
</body>
160+
</html>

‎docs/api/index.html‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
<li class="toctree-l2"><a class="reference internal" href="#ppp">PPP</a></li>
6868
<li class="toctree-l2"><a class="reference internal" href="#l2tp">L2TP</a></li>
6969
<li class="toctree-l2"><a class="reference internal" href="#igmp">IGMP</a></li>
70+
<li class="toctree-l2"><a class="reference internal" href="#dhcp">DHCP</a></li>
7071
<li class="toctree-l2"><a class="reference internal" href="#traffic">Traffic</a></li>
7172
<li class="toctree-l2"><a class="reference internal" href="#streams">Streams</a></li>
7273
<li class="toctree-l2"><a class="reference internal" href="#isis">ISIS</a></li>
@@ -685,6 +686,49 @@ <h2>IGMP<a class="headerlink" href="#igmp" title="Link to this heading"></a><
685686
</tbody>
686687
</table>
687688
</section>
689+
<section id="dhcp">
690+
<h2>DHCP<a class="headerlink" href="#dhcp" title="Link to this heading"></a></h2>
691+
<table class="docutils align-default">
692+
<thead>
693+
<tr class="row-odd"><th class="head"><p>Command</p></th>
694+
<th class="head"><p>Description</p></th>
695+
</tr>
696+
</thead>
697+
<tbody>
698+
<tr class="row-even"><td><p><strong>dhcp-start</strong></p></td>
699+
<td><div class="line-block">
700+
<div class="line">Start DHCP client.</div>
701+
<div class="line"><br /></div>
702+
<div class="line"><strong>Arguments:</strong></div>
703+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
704+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
705+
</div>
706+
</td>
707+
</tr>
708+
<tr class="row-odd"><td><p><strong>dhcp-stop</strong></p></td>
709+
<td><div class="line-block">
710+
<div class="line">Stop DHCP client without sending a release message.</div>
711+
<div class="line"><br /></div>
712+
<div class="line"><strong>Arguments:</strong></div>
713+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
714+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
715+
<div class="line"><code class="docutils literal notranslate"><span class="pre">keep-address</span></code> remember last address (init-reboot)</div>
716+
</div>
717+
</td>
718+
</tr>
719+
<tr class="row-even"><td><p><strong>dhcp-release</strong></p></td>
720+
<td><div class="line-block">
721+
<div class="line">Stop DHCP client with sending release messages.</div>
722+
<div class="line"><br /></div>
723+
<div class="line"><strong>Arguments:</strong></div>
724+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-id</span></code></div>
725+
<div class="line"><code class="docutils literal notranslate"><span class="pre">session-group-id</span></code> (ignored if session-id is present)</div>
726+
</div>
727+
</td>
728+
</tr>
729+
</tbody>
730+
</table>
731+
</section>
688732
<section id="traffic">
689733
<h2>Traffic<a class="headerlink" href="#traffic" title="Link to this heading"></a></h2>
690734
<table class="docutils align-default">

‎docs/configuration/dhcp.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,14 @@
167167
</div>
168168
</td>
169169
</tr>
170+
<tr class="row-even"><td><p><strong>keep-address</strong></p></td>
171+
<td><div class="line-block">
172+
<div class="line">Emulates init-reboot on stop if enabled together with</div>
173+
<div class="line">release-retry set to zero (disabled).</div>
174+
<div class="line">Default: false</div>
175+
</div>
176+
</td>
177+
</tr>
170178
</tbody>
171179
</table>
172180

‎docs/configuration/index.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1787,6 +1787,14 @@ <h2>DHCP<a class="headerlink" href="#dhcp" title="Link to this heading"></a><
17871787
</div>
17881788
</td>
17891789
</tr>
1790+
<tr class="row-even"><td><p><strong>keep-address</strong></p></td>
1791+
<td><div class="line-block">
1792+
<div class="line">Emulates init-reboot on stop if enabled together with</div>
1793+
<div class="line">release-retry set to zero (disabled).</div>
1794+
<div class="line">Default: false</div>
1795+
</div>
1796+
</td>
1797+
</tr>
17901798
</tbody>
17911799
</table>
17921800
</section>

‎docs/objects.inv‎

5 Bytes
Binary file not shown.

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)