embedaddon/mpd/doc/mpd18.html - diff

Return to mpd18.html CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / mpd / doc

Diff for /embedaddon/mpd/doc/mpd18.html between versions 1.1 and 1.1.1.4

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

version 1.1, 2012/02/21 23:32:47	version 1.1.1.4, 2021/03/17 00:39:23
Line 6	Line 6
</HEAD>	</HEAD>
<BODY text="#000000" bgcolor="#ffffff">	<BODY text="#000000" bgcolor="#ffffff">

<A HREF="mpd.html"><EM>Mpd 5.6 User Manual</EM></A>	<A HREF="mpd.html"><EM>Mpd 5.9 User Manual</EM></A>
<b>:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A>	<b>:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A>
<b>:</b> <EM>General mpd commands</EM><BR>	<b>:</b> <EM>General mpd commands</EM><BR>
<b>Previous:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A><BR>	<b>Previous:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A><BR>
Line 16	Line 16
<HR NOSHADE>	<HR NOSHADE>
<H2><A NAME="18"></A>4.1. General mpd commands<A NAME="gencmd"></A></H2>	<H2><A NAME="18"></A>4.1. General mpd commands<A NAME="gencmd"></A></H2>

<p>This chapter describes general mpd commands that don't	<p>This chapter describes general mpd commands that do not
apply to a specific layer.</p>	apply to a specific layer.</p>
<p>	<p>
<dl>	<dl>

<dt><b><code>create bundle [ template \| static ] <em>name</em> [ <em>template</em> ] </code></b><dd><p>Create new bundle with specified name, optionally based on specified template.	<dt><b><code>create bundle [ template \| static ] <em>name</em> [ <em>template</em> ] </code></b><dd><p>Create new bundle with specified name, optionally based on specified template.
If 'template' option is specified bundle will not operate itself,	If 'template' option is specified, bundle will not operate itself,
but will be used to create new bundles on demand.	but will be used to create new bundles on demand.
If 'static' option is specified, it will be a permanent bundle which will not	If 'static' option is specified, it will be a permanent bundle which will not
disapear after operation complete.	disappear after operation completes.
Maximum name length is 10 characters for templates and 15 characters	Maximum name length is 10 characters for templates and 15 characters
for the rest of bundles.</p>	for the rest of bundles.</p>

<dt><b><code>create link [ template \| static ] <em>name</em> ( <em>type</em> \| <em>template</em> ) </code></b><dd><p>Create new link with specified name and type, optionally based on	<dt><b><code>create link [ template \| static ] <em>name</em> ( <em>type</em> \| <em>template</em> ) </code></b><dd><p>Create new link with specified name and type, optionally based on
specified template.	specified template.
If 'template' option is specified link will not operate itself,	If 'template' option is specified, link will not operate itself,
but will be used to create new links on demand.	but will be used to create new links on demand.
If 'static' option is specified, it will be a permanent link which will not	If 'static' option is specified, it will be a permanent link which will not
disapear after operation complete.	disapear after operation complete.
Line 40 for the rest of links.</p>	Line 40 for the rest of links.</p>

<dt><b><code><br>destroy bundle [ <em>name</em> ]<br>	<dt><b><code><br>destroy bundle [ <em>name</em> ]<br>
destroy link [ <em>name</em> ]</code></b><dd><p>Destroy existing link/bundle.	destroy link [ <em>name</em> ]</code></b><dd><p>Destroy existing link/bundle.
Note, that if link is in use it may not disapear after command return,	Note that if link is in use, it may not disapear after command returns,
it may take some time to properly close it.</p>	it may take some time to properly close it.</p>

<dt><b><code>bundle [ <em>name</em> ] </code></b><dd><p>This command changes the currenly active bundle to the bundle named	<dt><b><code>bundle [ <em>name</em> ] </code></b><dd><p>This command changes the currently active bundle to the bundle named
<code><em>name</em></code>. The currently active link is also	<code><em>name</em></code>. The currently active link is also
changed, to the first link of the bundle. If no	changed, to the first link of the bundle. If no
<code><em>name</em></code> is given, this command lists all	<code><em>name</em></code> is given, this command lists all
Line 75 session with multilink session ID <code><em>msesid</em	Line 75 session with multilink session ID <code><em>msesid</em
session with session ID <code><em>sesid</em></code>.</p>	session with session ID <code><em>sesid</em></code>.</p>

<dt><b><code>authname [ <em>name</em> ] </code></b><dd><p>This command changes the currenly active link to the link holding	<dt><b><code>authname [ <em>name</em> ] </code></b><dd><p>This command changes the currenly active link to the link holding
session with peer auth name <code><em>name</em></code>.</p>	session with peer auth name <code><em>name</em></code>. If CI argument is present
	login comparasion will be case insensitive.</p>

<dt><b><code>load [ <em>file</em> ] <em>label</em></code></b><dd><p>This command causes mpd to read the entry for <code><em>label</em></code>	<dt><b><code>load [ <em>file</em> ] <em>label</em></code></b><dd><p>This command causes mpd to read the entry for <code><em>label</em></code>
out of <code>mpd.conf</code> or other file if specified and	out of <code>mpd.conf</code> or other file if specified and
Line 117 and <code>close</code> commands.</p>	Line 118 and <code>close</code> commands.</p>
<dt><b>sessions [ <em>param</em> <em>value</em> ]</b><dd><p>Show active sessions conforming specified param/value.	<dt><b>sessions [ <em>param</em> <em>value</em> ]</b><dd><p>Show active sessions conforming specified param/value.
Available params: iface, ip, bundle, msession, link, session, user, peer.</p>	Available params: iface, ip, bundle, msession, link, session, user, peer.</p>
<dt><b>customer</b><dd><p>Show active customer details.</p>	<dt><b>customer</b><dd><p>Show active customer details.</p>
<dt><b>summary</b><dd><p>Show status summary</p>	<dt><b>summary</b><dd><p>Show status summary.</p>
<dt><b>console</b><dd><p>Show console summary</p>	<dt><b>console</b><dd><p>Show console summary.</p>
<dt><b>web</b><dd><p>Show web server summary</p>	<dt><b>web</b><dd><p>Show web server summary.</p>
<dt><b>user</b><dd><p>Show defined console users</p>	<dt><b>user</b><dd><p>Show defined console users.</p>
	<dt><b>netflow</b><dd><p>Show status information about NetFlow.</p>

</dl>	</dl>
</p>	</p>
Line 154 for the PAC/PNS pair, but it can increase busy tunnels	Line 156 for the PAC/PNS pair, but it can increase busy tunnels
template, that could exist at the same time.</p>	template, that could exist at the same time.</p>
<p>The default value is 10000.</p>	<p>The default value is 10000.</p>

	<dt><b><code>set global qthreshold <em>min</em> <em>max</em></code></b><dd><p>This option specifies global message queue limit thresholds.</p>
	<p>The default values are 64 and 256.</p>

<dt><b><code>set global filter <em>num</em> add <em>fltnum</em> <em>flt</em><br>	<dt><b><code>set global filter <em>num</em> add <em>fltnum</em> <em>flt</em><br>
set global filter <em>num</em> clear</code></b><dd><p>These commands define or clear traffic filters to be used by rules submitted	set global filter <em>num</em> clear</code></b><dd><p>These commands define or clear traffic filters to be used by rules submitted
by	by
<A HREF="mpd30.html#radius">radius</A> during authentication.</p>	<A HREF="mpd30.html#radius">AAA</A> during authentication.</p>

<dt><b><code>set global enable <em>option ...</em><br>	<dt><b><code>set global enable <em>option ...</em><br>
set global disable <em>option ...</em></code></b><dd><p>These commands configure various global options.</p>	set global disable <em>option ...</em></code></b><dd><p>These commands configure various global options.</p>
Line 176 like to restrict access to mpd. This option affects al	Line 181 like to restrict access to mpd. This option affects al
connections, including PPTP and the TCP device layer.</p>	connections, including PPTP and the TCP device layer.</p>
<p>The default is disable.</p>	<p>The default is disable.</p>

	<dt><b><code>agent-cid</code></b><dd><p>Display PPPoE <em>ADSL-Agent-Circuit-Id</em> option in
	<em>show session</em> command.</p>
	<p>The default is disable.</p>

	<dt><b><code>session-time</code></b><dd><p>Display session time in seconds in <em>show session</em>
	command.</p>
	<p>The default is disable.</p>

<dt><b><code>set user <em>username</em> <em>password</em>	<dt><b><code>set user <em>username</em> <em>password</em>
[<em>admin</em>\|<em>operator</em>\|<em>user</em>]</code></b><dd><p>This command configures which users are allowed to connect to the console.	[<em>admin</em>\|<em>operator</em>\|<em>user</em>]</code></b><dd><p>This command configures which users are allowed to connect to the console.
It may be invoked multiple times with different usernames.</p>	It may be invoked multiple times with different usernames.</p>
Line 211 for the currently active link, which must have type <b	Line 224 for the currently active link, which must have type <b
</dl>	</dl>
</p>	</p>

	<dt><b><code>unset ...</code></b><dd>
	<p>This command allows to unsets some of configuration information set using
	<code>set</code> command.</p>

<dt><b><code>open [ <em>layer</em> ] </code></b><dd><p>This command causes an OPEN event to be sent to the corresponding	<dt><b><code>open [ <em>layer</em> ] </code></b><dd><p>This command causes an OPEN event to be sent to the corresponding
layer or finite state machine (FSM). The valid layers are:</p>	layer or finite state machine (FSM). The valid layers are:</p>
<p>	<p>
Line 283 an incomplete command is given, lists the available al	Line 300 an incomplete command is given, lists the available al
<dt><b><code>exit</code></b><dd><p>This command exits the console, but does not quit the mpd process.	<dt><b><code>exit</code></b><dd><p>This command exits the console, but does not quit the mpd process.
This command is useful for disconnecting a telnet connection.</p>	This command is useful for disconnecting a telnet connection.</p>

<dt><b><code>quit</code></b><dd><p>Close down all connections and quit the mpd process.</p>	<dt><b><code>shutdown</code></b><dd><p>Close down all connections and quit the mpd process.</p>

</dl>	</dl>
</p>	</p>

<HR NOSHADE>	<HR NOSHADE>
<A HREF="mpd.html"><EM>Mpd 5.6 User Manual</EM></A>	<A HREF="mpd.html"><EM>Mpd 5.9 User Manual</EM></A>
<b>:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A>	<b>:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A>
<b>:</b> <EM>General mpd commands</EM><BR>	<b>:</b> <EM>General mpd commands</EM><BR>
<b>Previous:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A><BR>	<b>Previous:</b> <A HREF="mpd17.html"><EM>Configuring Mpd</EM></A><BR>

Removed from v.1.1
changed lines
	Added in v.1.1.1.4