1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
<!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>[cli] — 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=e59714d7" />
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<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=9bcbadda"></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="[pppd-compat]" href="pppd_compat.html" />
<link rel="prev" title="[log]" href="log.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 current"><a class="reference internal" href="configuration.html">Configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="modules.html">[modules]</a></li>
<li class="toctree-l2"><a class="reference internal" href="core.html">[core]</a></li>
<li class="toctree-l2"><a class="reference internal" href="common.html">[common]</a></li>
<li class="toctree-l2"><a class="reference internal" href="radius.html">[radius]</a></li>
<li class="toctree-l2"><a class="reference internal" href="chap_secrets.html">[chap-secrets]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ppp.html">[ppp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pppoe.html">[pppoe]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pptp.html">[pptp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="l2tp.html">[l2tp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipoe.html">[ipoe]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ip-pool.html">[ip-pool]</a></li>
<li class="toctree-l2"><a class="reference internal" href="sstp.html">[sstp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="dns.html">[dns]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-dns.html">[ipv6-dns]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-pool.html">[ipv6-pool]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-nd.html">[ipv6-nd]</a></li>
<li class="toctree-l2"><a class="reference internal" href="ipv6-dhcp.html">[ipv6-dhcp]</a></li>
<li class="toctree-l2"><a class="reference internal" href="shaper.html">[shaper]</a></li>
<li class="toctree-l2"><a class="reference internal" href="log.html">[log]</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">[cli]</a></li>
<li class="toctree-l2"><a class="reference internal" href="pppd_compat.html">[pppd-compat]</a></li>
<li class="toctree-l2"><a class="reference internal" href="snmp.html">SNMP</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../guides/control_features.html">Control features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/recommendations.html">Recommendations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/BRAS_tuning.html">BRAS tuning</a></li>
<li class="toctree-l1"><a class="reference internal" href="../guides/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"><a href="configuration.html">Configuration</a></li>
<li class="breadcrumb-item active">[cli]</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/configuration/cli.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="cli">
<span id="cli-configuration"></span><h1>[cli]<a class="headerlink" href="#cli" title="Link to this heading"></a></h1>
<p>Configuration overview of the command line interface.</p>
<dl>
<dt><strong>verbose=1|2</strong></dt><dd><p>By default <code class="docutils literal notranslate"><span class="pre">verbose=1</span></code></p>
<p>If <code class="docutils literal notranslate"><span class="pre">verbose=1</span></code> then cli module will log IP address of each connection.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">verbose=2</span></code> then cli module will also log passed commands.</p>
</dd>
<dt><strong>tcp=host:port</strong></dt><dd><p>By default is not defined.</p>
<p>Defines on which IP address and port the TCP module will listen for incoming connections. When host is empty, the TCP module listens on all local interfaces. It isn’t loaded if this option isn’t defined.</p>
</dd>
<dt><strong>telnet=host:port</strong></dt><dd><p>By default is not defined.</p>
<p>Defines on which IP address and port the Telnet module will listen for incoming connections. When host is empty, the Telnet module listens on all local interfaces. It isn’t loaded if this option isn’t defined.</p>
</dd>
<dt><strong>password=passwd</strong></dt><dd><p>By default is not defined.</p>
<p>Defines the password to be used by the TCP and Telnet modules for authenticating clients. No authentication is performed if this option isn’t defined.</p>
</dd>
<dt><strong>prompt=prompt</strong></dt><dd><p>By default <code class="docutils literal notranslate"><span class="pre">prompt=accel-ppp</span></code></p>
<p>Defines the prompt string used by the Telnet module.</p>
</dd>
<dt><strong>history-file=filename</strong></dt><dd><p>By default <code class="docutils literal notranslate"><span class="pre">history-file=/var/lib/accel-ppp/history</span></code></p>
<p>Defines the file used by the Telnet module for loading and storing its command history.</p>
</dd>
<dt><strong>sessions-columns=column_list</strong></dt><dd><p>By default <code class="docutils literal notranslate"><span class="pre">sessions-columns=ifname,username,calling-sid,ip,rate-limit,type,comp,state,uptime</span></code></p>
<p>Defines the default set of columns to be displayed by the <code class="docutils literal notranslate"><span class="pre">show</span> <span class="pre">sessions</span></code> command. Invalid column names are silently discarded. All possible params:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ifname</span></code> - interface name</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">username</span></code> - username</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">calling-sid</span></code> - calling station identifier, for <em>PPPoE</em> and <em>IPoE start=dhcpv4</em> is client mac-address, for <em>PPTP</em>, <em>L2TP</em>, <em>SSTP</em> and <em>IPoE start=up</em> is client ip addres.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">called-sid</span></code> - called station identifier, for <em>PPPoE</em> and <em>IPoE start=dhcpv4</em> is server mac-address, for <em>PPTP</em>, <em>L2TP</em>, <em>SSTP</em> and <em>IPoE start=up</em> is server ip addres.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sid</span></code> - session identifier</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ip</span></code> - client ip address</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ip6</span></code> - client ipv6 prefix</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ip6-dp</span></code> - delegated ipv6 prefix for client</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rate-limit</span></code> - rate-limit, required param <code class="docutils literal notranslate"><span class="pre">[modules]shaper</span></code>, otherwise this column not displayed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">type</span></code> - session type, may contain next connection types: <em>ipoe</em>, <em>pppoe</em>, <em>pptp</em>, <em>l2tp</em>, <em>sstp</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">comp</span></code> - compression/ecnryption method</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">state</span></code> - state of session, may contain next states: <em>start</em>, <em>active</em>, <em>finish</em></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uptime</span></code> - human readable session uptime</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uptime-raw</span></code> - session uptime in seconds</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rx-bytes</span></code> - human readable received bytes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tx-bytes</span></code> - human readable transmitted bytes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rx-bytes-raw</span></code> - received bytes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tx-bytes-raw</span></code> - transmitted bytes</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">rx-pkts</span></code> - received packets</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">tx-pkts</span></code> - transmitted packets</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">netns</span></code> - network namespace name</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vrf</span></code> - Virtual Routing and Forwarding</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ipoe-type</span></code> - IPoE session type (UP/DHCP)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">inbound-if</span></code> - Session inbound interface</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">service-name</span></code> - PPPoE service name</p></li>
</ul>
</dd>
</dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="log.html" class="btn btn-neutral float-left" title="[log]" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pppd_compat.html" class="btn btn-neutral float-right" title="[pppd-compat]" 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>
|
