embedaddon/mpd/doc/mpd18.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / mpd / doc / mpd18.html
Revision 1.1.1.4 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 00:39:23 2021 UTC (3 years, 2 months ago) by misho
Branches: mpd, MAIN
CVS tags: v5_9p16, v5_9, HEAD

mpd 5.9

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> <TITLE>General mpd commands</TITLE> </HEAD> <BODY text="#000000" bgcolor="#ffffff"> <A HREF="mpd.html">Mpd 5.9 User Manual</A> : <A HREF="mpd17.html">Configuring Mpd</A> : General mpd commands  Previous: <A HREF="mpd17.html">Configuring Mpd</A>  Next: <A HREF="mpd19.html">Mpd Layers</A> <HR NOSHADE> <H2><A NAME="18"></A>4.1. General mpd commands<A NAME="gencmd"></A></H2> This chapter describes general mpd commands that do not apply to a specific layer.  <dl> <dt><code>create bundle [ template | static ] name [ template ] </code><dd>Create new bundle with specified name, optionally based on specified template. If 'template' option is specified, bundle will not operate itself, but will be used to create new bundles on demand. If 'static' option is specified, it will be a permanent bundle which will not disappear after operation completes. Maximum name length is 10 characters for templates and 15 characters for the rest of bundles. <dt><code>create link [ template | static ] name ( type | template ) </code><dd>Create new link with specified name and type, optionally based on specified template. If 'template' option is specified, link will not operate itself, but will be used to create new links on demand. If 'static' option is specified, it will be a permanent link which will not disapear after operation complete. Maximum name length is 10 characters for templates and 15 characters for the rest of links. <dt><code> destroy bundle [ name ]  destroy link [ name ]</code><dd>Destroy existing link/bundle. Note that if link is in use, it may not disapear after command returns, it may take some time to properly close it. <dt><code>bundle [ name ] </code><dd>This command changes the currently active bundle to the bundle named <code>name</code>. The currently active link is also changed, to the first link of the bundle. If no <code>name</code> is given, this command lists all of the defined bundles and their constituent links. The new bundle will be reflected in the prompt. <dt><code>link [ name | [number] ] </code><dd>This command changes the currenly active link to the link named <code>name</code>. If this link does not belong to the currently active bundle, then the currently active bundle is changed to the bundle that owns link <code>name</code>. The new link will be reflected in the prompt. Link number (RAD_NAS_PORT) can be specified in hex form in square brackets in place of name. <dt><code>repeater [ name ] </code><dd>This command changes the currenly active repeater to the repeater named <code>name</code>. The currently active phys is also changed, to the first phys of the repeater. If no <code>name</code> is given, this command lists all of the defined repeaters and their constituent physes. The new phys will be reflected in the prompt. <dt><code>iface [ iface ] </code><dd>This command changes the currenly active bundle to the bundle using interface <code>iface</code>. <dt><code>msession [ msesid ] </code><dd>This command changes the currenly active bundle to the bundle holding session with multilink session ID <code>msesid</code>. <dt><code>session [ sesid ] </code><dd>This command changes the currenly active link to the link holding session with session ID <code>sesid</code>. <dt><code>authname [ name ] </code><dd>This command changes the currenly active link to the link holding session with peer auth name <code>name</code>. If CI argument is present login comparasion will be case insensitive. <dt><code>load [ file ] label</code><dd>This command causes mpd to read the entry for <code>label</code> out of <code>mpd.conf</code> or other file if specified and execute the corresponding commands. file can be relative or absolute file path or http/https/ftp URL. Note, that remote file access may be less reliable. <dt><code>show [ item ] </code><dd>This command displays various status information. The valid values for <code>item</code> are:  <dl> <dt>bundle<dd>Show status information about the currently active bundle. <dt>link<dd>Show status information about the currently active link. <dt>repeater<dd>Show status information about the currently active repeater. <dt>iface<dd>Show status information about the interface layer associated with the currently active bundle. <dt>routes<dd>Show the current IP routing table. <dt>ipcp<dd>Show status information about the IP control protocol associated with the currently active bundle. <dt>ippool<dd>Show status information about configures IP pools. <dt>ccp<dd>Show status information about the compression control protocol associated with the currently active bundle. <dt>lcp<dd>Show status information about the link control protocol associated with the currently active link. <dt>nat<dd>Show information about NAT on the currently active bundle. <dt>auth<dd>Show status information about Authentication. <dt>eap<dd>Show status information about EAP. <dt>radius<dd>Information relating to RADIUS authentication. <dt>proto<dd>Show protocol statistics for the currently active bundle and link. <dt>types<dd>Show the device types supported by this version of mpd. <dt>layers<dd>Show the names of the layers that are valid as arguments to the <code>open</code> and <code>close</code> commands. <dt>l2tp<dd>Show active L2TP tunnels. <dt>pptp<dd>Show active PPTP tunnels. <dt>events<dd>Show all pending events (for debugging mpd). <dt>mem<dd>Show distribution of dynamically allocated memory (for debugging mpd). <dt>version<dd>Show running mpd version and supported features. <dt>sessions [ param value ]<dd>Show active sessions conforming specified param/value. Available params: iface, ip, bundle, msession, link, session, user, peer. <dt>customer<dd>Show active customer details. <dt>summary<dd>Show status summary. <dt>console<dd>Show console summary. <dt>web<dd>Show web server summary. <dt>user<dd>Show defined console users. <dt>netflow<dd>Show status information about NetFlow. </dl>  <dt><code>set ...</code><dd> This command sets various configuration information. Further details are contained in later sections in this chapter. The valid completions for <code>set</code> are:  <dl> <dt><code>set global startrule num  set global startpipe num  set global startqueue num  set global starttable num</code><dd>These commands define initial values for autonumeration of ipfw rules, pipes, queues and tables. Defaults are 10000, 10000, 10000 and 32 accordingly. <dt><code>set global pptptimeout seconds  set global l2tptimeout seconds</code><dd>Set PPTP/L2TP tunnels inactivity shutdown delay. Default is 10 seconds. <dt><code>set global pptplimit num  set global l2tplimit num</code><dd>Limit maximum number of calls per PPTP/L2TP tunnel. When limit is reached new tunnel will be created for the next call. This option violates PPTP RFC which requires only one tunnel existing for the PAC/PNS pair, but it can increase busy tunnels stability. Defaults are 100 (10 for L2TP before FreeBSD 6.3-STABLE and 7.0-RELEASE). <dt><code>set global max-children num</code><dd>This option specifies global maximum number of links, created using template, that could exist at the same time. The default value is 10000. <dt><code>set global qthreshold min max</code><dd>This option specifies global message queue limit thresholds. The default values are 64 and 256. <dt><code>set global filter num add fltnum flt  set global filter num clear</code><dd>These commands define or clear traffic filters to be used by rules submitted by <A HREF="mpd30.html#radius">AAA</A> during authentication. <dt><code>set global enable option ...  set global disable option ...</code><dd>These commands configure various global options. The <code>enable</code> and <code>disable</code> commands determine whether or not we want the corresponding option. The options available are: <dt><code>one-shot</code><dd>This option forces mpd terminate itself after the last link disappear. Link templates are not counted as links. The default is disable. <dt><code>tcp-wrapper</code><dd>With this option mpd uses <code>/etc/hosts.allow</code> everytime a connection is made from the client. This is useful if you would like to restrict access to mpd. This option affects all TCP connections, including PPTP and the TCP device layer. The default is disable. <dt><code>agent-cid</code><dd>Display PPPoE ADSL-Agent-Circuit-Id option in show session command. The default is disable. <dt><code>session-time</code><dd>Display session time in seconds in show session command. The default is disable. <dt><code>set user username password [admin|operator|user]</code><dd>This command configures which users are allowed to connect to the console. It may be invoked multiple times with different usernames. <dt><code>set bundle ...</code><dd>Set bundle layer configuration parameters for the currently active bundle. <dt><code>set link ...</code><dd>Set link layer configuration parameters for the currently active link. <dt><code>set iface ...</code><dd>Set interface layer configuration parameters for the currently active bundle. <dt><code>set nat ...</code><dd>Set NAT configuration parameters for the currently active bundle. <dt><code>set ipcp ...</code><dd>Set IP control protocol configuration parameters for the currently active bundle. <dt><code>set ccp ...</code><dd>Set compression control protocol configuration parameters for the currently active bundle. <dt><code>set auth ...</code><dd>Configures the authentication subsystem. <dt><code>set radius ...</code><dd>Configures RADIUS. <dt><code>set eap ...</code><dd>Configures the EAP. <dt><code>set debug ...level</code><dd>Sets the <code>netgraph(3)</code> debugging level. Default is zero. <dt><code>set modem ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type modem. <dt><code>set ng ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type netgraph. <dt><code>set tcp ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type tcp. <dt><code>set udp ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type udp. <dt><code>set pptp ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type pptp. <dt><code>set l2tp ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type l2tp. <dt><code>set pppoe ...</code><dd>Sets device specific configuration parameters for the currently active link, which must have type pppoe. <dt><code>set console ...</code><dd>Sets console specific configuration parameters <dt><code>set web ...</code><dd>Sets web server specific configuration parameters </dl>  <dt><code>unset ...</code><dd> This command allows to unsets some of configuration information set using <code>set</code> command. <dt><code>open [ layer ] </code><dd>This command causes an OPEN event to be sent to the corresponding layer or finite state machine (FSM). The valid layers are:  <dl> <dt>iface<dd>Interface layer. Opening this layer configures the interface and installs any routes. If dial-on-demand is enabled, nothing else happens until there is outgoing traffic. If dial-on-demand is disabled there no reason to open this layer manually. <dt>bund<dd>Bundle layer. This layer represents the multi-link bundle ``virtual link'' and is normally opened and closed automatically. <dt>ipcp<dd>IP control protocol FSM. This is normally opened and closed automatically. <dt>ccp<dd>Compression control protocol FSM. This is normally opened and closed automatically. <dt>link<dd>Link control protocol FSM. This is default layer for open/close commands. Opening of this layer initiates outgoing call by this link. <dt>device<dd>Device layer. This is normally opened and closed automatically. </dl>  Normally, only the <code>iface</code> and <code>link</code> layers should be explicitly opened or closed. This is because the other layers are programmed to automatically open and close when appropriate. Note that the SIGUSR1 and SIGUSR2 signals are an alternative way to open and close the first link. <dt><code>close [ layer ] </code><dd>This command causes a CLOSE event to be sent to the corresponding layer or finite state machine (FSM). <dt><code>log [ +/-flag ... ] </code><dd>Mpd supports several different logging flags. Every line logged by mpd is tagged with one (or more) of these flags. By turning the flags on or off, that particular type of logging is enabled or disabled. This allows you to customize logging verbosity. Without any arguments, the <code>log</code> command shows the current set of logging flags. To enable a logging flag, add the <code>+flag</code> argument. To disable a logging flag, add the <code>-flag</code> argument. These are the various flags supported by mpd and their corresponding categories:  <dl> <dt>auth*<dd>Link authentication events <dt>bund*<dd>Bundle layer events <dt>ccp*<dd>Compression events and negotiation <dt>chat*<dd>Modem chat script <dt>console*<dd>Log to the console as well as the log file <dt>echo<dd>Echo/reply packets for all FSM's <dt>ecp*<dd>Encryption events and negotiation <dt>frame<dd>Dump all frames transmitted and received <dt>fsm*<dd>All FSM events (except echo and resets) <dt>iface*<dd>Interface layer events <dt>ipcp*<dd>IP control protocol events and negotiation <dt>ipv6cp*<dd>IPv6 control protocol events and negotiation <dt>lcp*<dd>Link control protocol events and negotiation <dt>link*<dd>Link layer events <dt>phys*<dd>Device layer events <dt>radius*<dd>RADIUS authentication events <dt>rep*<dd>Repeater layer events </dl>  <dt><code>help [ command ] </code><dd>This gives a brief description of the supplied command, or if an incomplete command is given, lists the available alternatives. <dt><code>exit</code><dd>This command exits the console, but does not quit the mpd process. This command is useful for disconnecting a telnet connection. <dt><code>shutdown</code><dd>Close down all connections and quit the mpd process. </dl>  <HR NOSHADE> <A HREF="mpd.html">Mpd 5.9 User Manual</A> : <A HREF="mpd17.html">Configuring Mpd</A> : General mpd commands  Previous: <A HREF="mpd17.html">Configuring Mpd</A>  Next: <A HREF="mpd19.html">Mpd Layers</A> </BODY> </HTML>