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, 3 months ago) by misho
Branches: mpd, MAIN
CVS tags: v5_9p16, v5_9, HEAD

mpd 5.9

1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> 2: <HTML> 3: <HEAD> 4: <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> 5: <TITLE>General mpd commands</TITLE> 6: </HEAD> 7: <BODY text="#000000" bgcolor="#ffffff"> 8: 9: <A HREF="mpd.html">Mpd 5.9 User Manual</A> 10: : <A HREF="mpd17.html">Configuring Mpd</A> 11: : General mpd commands  12: Previous: <A HREF="mpd17.html">Configuring Mpd</A>  13: Next: <A HREF="mpd19.html">Mpd Layers</A> 14: 15: 16: <HR NOSHADE> 17: <H2><A NAME="18"></A>4.1. General mpd commands<A NAME="gencmd"></A></H2> 18: 19: This chapter describes general mpd commands that do not 20: apply to a specific layer. 21:  22: <dl> 23: 24: <dt><code>create bundle [ template | static ] name [ template ] </code><dd>Create new bundle with specified name, optionally based on specified template. 25: If 'template' option is specified, bundle will not operate itself, 26: but will be used to create new bundles on demand. 27: If 'static' option is specified, it will be a permanent bundle which will not 28: disappear after operation completes. 29: Maximum name length is 10 characters for templates and 15 characters 30: for the rest of bundles. 31: 32: <dt><code>create link [ template | static ] name ( type | template ) </code><dd>Create new link with specified name and type, optionally based on 33: specified template. 34: If 'template' option is specified, link will not operate itself, 35: but will be used to create new links on demand. 36: If 'static' option is specified, it will be a permanent link which will not 37: disapear after operation complete. 38: Maximum name length is 10 characters for templates and 15 characters 39: for the rest of links. 40: 41: <dt><code> destroy bundle [ name ]  42: destroy link [ name ]</code><dd>Destroy existing link/bundle. 43: Note that if link is in use, it may not disapear after command returns, 44: it may take some time to properly close it. 45: 46: <dt><code>bundle [ name ] </code><dd>This command changes the currently active bundle to the bundle named 47: <code>name</code>. The currently active link is also 48: changed, to the first link of the bundle. If no 49: <code>name</code> is given, this command lists all 50: of the defined bundles and their constituent links. 51: The new bundle will be reflected in the prompt. 52: 53: <dt><code>link [ name | [number] ] </code><dd>This command changes the currenly active link to the link named 54: <code>name</code>. If this link does not belong to 55: the currently active bundle, then the currently active bundle 56: is changed to the bundle that owns link <code>name</code>. 57: The new link will be reflected in the prompt. 58: Link number (RAD_NAS_PORT) can be specified in hex form in 59: square brackets in place of name. 60: 61: <dt><code>repeater [ name ] </code><dd>This command changes the currenly active repeater to the repeater named 62: <code>name</code>. The currently active phys is also 63: changed, to the first phys of the repeater. If no 64: <code>name</code> is given, this command lists all 65: of the defined repeaters and their constituent physes. 66: The new phys will be reflected in the prompt. 67: 68: <dt><code>iface [ iface ] </code><dd>This command changes the currenly active bundle to the bundle using 69: interface <code>iface</code>. 70: 71: <dt><code>msession [ msesid ] </code><dd>This command changes the currenly active bundle to the bundle holding 72: session with multilink session ID <code>msesid</code>. 73: 74: <dt><code>session [ sesid ] </code><dd>This command changes the currenly active link to the link holding 75: session with session ID <code>sesid</code>. 76: 77: <dt><code>authname [ name ] </code><dd>This command changes the currenly active link to the link holding 78: session with peer auth name <code>name</code>. If CI argument is present 79: login comparasion will be case insensitive. 80: 81: <dt><code>load [ file ] label</code><dd>This command causes mpd to read the entry for <code>label</code> 82: out of <code>mpd.conf</code> or other file if specified and 83: execute the corresponding commands. file can be relative 84: or absolute file path or http/https/ftp URL. Note, that remote file 85: access may be less reliable. 86: 87: <dt><code>show [ item ] </code><dd>This command displays various status information. The valid 88: values for <code>item</code> are: 89:  90: <dl> 91: 92: <dt>bundle<dd>Show status information about the currently active bundle. 93: <dt>link<dd>Show status information about the currently active link. 94: <dt>repeater<dd>Show status information about the currently active repeater. 95: <dt>iface<dd>Show status information about the interface layer associated 96: with the currently active bundle. 97: <dt>routes<dd>Show the current IP routing table. 98: <dt>ipcp<dd>Show status information about the IP control 99: protocol associated with the currently active bundle. 100: <dt>ippool<dd>Show status information about configures IP pools. 101: <dt>ccp<dd>Show status information about the compression control 102: protocol associated with the currently active bundle. 103: <dt>lcp<dd>Show status information about the link control 104: protocol associated with the currently active link. 105: <dt>nat<dd>Show information about NAT on the currently active bundle. 106: <dt>auth<dd>Show status information about Authentication. 107: <dt>eap<dd>Show status information about EAP. 108: <dt>radius<dd>Information relating to RADIUS authentication. 109: <dt>proto<dd>Show protocol statistics for the currently active bundle and link. 110: <dt>types<dd>Show the device types supported by this version of mpd. 111: <dt>layers<dd>Show the names of the layers that are valid as arguments to the <code>open</code> 112: and <code>close</code> commands. 113: <dt>l2tp<dd>Show active L2TP tunnels. 114: <dt>pptp<dd>Show active PPTP tunnels. 115: <dt>events<dd>Show all pending events (for debugging mpd). 116: <dt>mem<dd>Show distribution of dynamically allocated memory (for debugging mpd). 117: <dt>version<dd>Show running mpd version and supported features. 118: <dt>sessions [ param value ]<dd>Show active sessions conforming specified param/value. 119: Available params: iface, ip, bundle, msession, link, session, user, peer. 120: <dt>customer<dd>Show active customer details. 121: <dt>summary<dd>Show status summary. 122: <dt>console<dd>Show console summary. 123: <dt>web<dd>Show web server summary. 124: <dt>user<dd>Show defined console users. 125: <dt>netflow<dd>Show status information about NetFlow. 126: 127: </dl> 128:  129: 130: <dt><code>set ...</code><dd> 131: This command sets various configuration information. Further 132: details are contained in later sections in this chapter. 133: The valid completions for <code>set</code> are: 134:  135: <dl> 136: 137: <dt><code>set global startrule num  138: set global startpipe num  139: set global startqueue num  140: set global starttable num</code><dd>These commands define initial values for autonumeration of ipfw 141: rules, pipes, queues and tables. 142: Defaults are 10000, 10000, 10000 and 32 accordingly. 143: 144: <dt><code>set global pptptimeout seconds  145: set global l2tptimeout seconds</code><dd>Set PPTP/L2TP tunnels inactivity shutdown delay. 146: Default is 10 seconds. 147: 148: <dt><code>set global pptplimit num  149: set global l2tplimit num</code><dd>Limit maximum number of calls per PPTP/L2TP tunnel. When limit 150: is reached new tunnel will be created for the next call. 151: This option violates PPTP RFC which requires only one tunnel existing 152: for the PAC/PNS pair, but it can increase busy tunnels stability. 153: Defaults are 100 (10 for L2TP before FreeBSD 6.3-STABLE and 7.0-RELEASE). 154: 155: <dt><code>set global max-children num</code><dd>This option specifies global maximum number of links, created using 156: template, that could exist at the same time. 157: The default value is 10000. 158: 159: <dt><code>set global qthreshold min max</code><dd>This option specifies global message queue limit thresholds. 160: The default values are 64 and 256. 161: 162: <dt><code>set global filter num add fltnum flt  163: set global filter num clear</code><dd>These commands define or clear traffic filters to be used by rules submitted 164: by 165: <A HREF="mpd30.html#radius">AAA</A> during authentication. 166: 167: <dt><code>set global enable option ...  168: set global disable option ...</code><dd>These commands configure various global options. 169: 170: The <code>enable</code> and <code>disable</code> commands 171: determine whether or not we want the corresponding option. 172: The options available are: 173: 174: <dt><code>one-shot</code><dd>This option forces mpd terminate itself after the last link disappear. 175: Link templates are not counted as links. 176: The default is disable. 177: 178: <dt><code>tcp-wrapper</code><dd>With this option mpd uses <code>/etc/hosts.allow</code> everytime a 179: connection is made from the client. This is useful if you would 180: like to restrict access to mpd. This option affects all TCP 181: connections, including PPTP and the TCP device layer. 182: The default is disable. 183: 184: <dt><code>agent-cid</code><dd>Display PPPoE ADSL-Agent-Circuit-Id option in 185: show session command. 186: The default is disable. 187: 188: <dt><code>session-time</code><dd>Display session time in seconds in show session 189: command. 190: The default is disable. 191: 192: <dt><code>set user username password 193: [admin|operator|user]</code><dd>This command configures which users are allowed to connect to the console. 194: It may be invoked multiple times with different usernames. 195: 196: <dt><code>set bundle ...</code><dd>Set bundle layer configuration parameters for the currently active bundle. 197: <dt><code>set link ...</code><dd>Set link layer configuration parameters for the currently active link. 198: <dt><code>set iface ...</code><dd>Set interface layer configuration parameters for the currently active bundle. 199: <dt><code>set nat ...</code><dd>Set NAT configuration parameters for the currently active bundle. 200: <dt><code>set ipcp ...</code><dd>Set IP control protocol configuration parameters 201: for the currently active bundle. 202: <dt><code>set ccp ...</code><dd>Set compression control protocol configuration parameters 203: for the currently active bundle. 204: <dt><code>set auth ...</code><dd>Configures the authentication subsystem. 205: <dt><code>set radius ...</code><dd>Configures RADIUS. 206: <dt><code>set eap ...</code><dd>Configures the EAP. 207: <dt><code>set debug ...level</code><dd>Sets the <code>netgraph(3)</code> debugging level. Default is zero. 208: <dt><code>set modem ...</code><dd>Sets device specific configuration parameters 209: for the currently active link, which must have type modem. 210: <dt><code>set ng ...</code><dd>Sets device specific configuration parameters 211: for the currently active link, which must have type netgraph. 212: <dt><code>set tcp ...</code><dd>Sets device specific configuration parameters 213: for the currently active link, which must have type tcp. 214: <dt><code>set udp ...</code><dd>Sets device specific configuration parameters 215: for the currently active link, which must have type udp. 216: <dt><code>set pptp ...</code><dd>Sets device specific configuration parameters 217: for the currently active link, which must have type pptp. 218: <dt><code>set l2tp ...</code><dd>Sets device specific configuration parameters 219: for the currently active link, which must have type l2tp. 220: <dt><code>set pppoe ...</code><dd>Sets device specific configuration parameters 221: for the currently active link, which must have type pppoe. 222: <dt><code>set console ...</code><dd>Sets console specific configuration parameters 223: <dt><code>set web ...</code><dd>Sets web server specific configuration parameters 224: </dl> 225:  226: 227: <dt><code>unset ...</code><dd> 228: This command allows to unsets some of configuration information set using 229: <code>set</code> command. 230: 231: <dt><code>open [ layer ] </code><dd>This command causes an OPEN event to be sent to the corresponding 232: layer or finite state machine (FSM). The valid layers are: 233:  234: <dl> 235: <dt>iface<dd>Interface layer. Opening this layer configures the interface and 236: installs any routes. If dial-on-demand is enabled, nothing else 237: happens until there is outgoing traffic. If dial-on-demand is disabled 238: there no reason to open this layer manually. 239: 240: <dt>bund<dd>Bundle layer. This layer represents the multi-link bundle ``virtual 241: link'' and is normally opened and closed automatically. 242: 243: <dt>ipcp<dd>IP control protocol FSM. This is normally opened and closed automatically. 244: 245: <dt>ccp<dd>Compression control protocol FSM. 246: This is normally opened and closed automatically. 247: 248: <dt>link<dd>Link control protocol FSM. This is default layer for open/close commands. 249: Opening of this layer initiates outgoing call by this link. 250: 251: <dt>device<dd>Device layer. 252: This is normally opened and closed automatically. 253: 254: </dl> 255:  256: Normally, only the <code>iface</code> and <code>link</code> layers should be explicitly 257: opened or closed. This is because the other layers are programmed 258: to automatically open and close when appropriate. Note that 259: the SIGUSR1 and SIGUSR2 signals are an alternative 260: way to open and close the first link. 261: 262: <dt><code>close [ layer ] </code><dd>This command causes a CLOSE event to be sent to the corresponding 263: layer or finite state machine (FSM). 264: 265: <dt><code>log [ +/-flag ... ] </code><dd>Mpd supports several different logging flags. Every line logged by mpd is 266: tagged with one (or more) of these flags. By turning the flags on or off, 267: that particular type of logging is enabled or disabled. This allows you 268: to customize logging verbosity. 269: Without any arguments, the <code>log</code> command shows the current 270: set of logging flags. 271: To enable a logging flag, add the <code>+flag</code> argument. 272: To disable a logging flag, add the <code>-flag</code> argument. 273: These are the various flags supported by mpd and their corresponding 274: categories: 275:  276: <dl> 277: <dt>auth*<dd>Link authentication events 278: <dt>bund*<dd>Bundle layer events 279: <dt>ccp*<dd>Compression events and negotiation 280: <dt>chat*<dd>Modem chat script 281: <dt>console*<dd>Log to the console as well as the log file 282: <dt>echo<dd>Echo/reply packets for all FSM's 283: <dt>ecp*<dd>Encryption events and negotiation 284: <dt>frame<dd>Dump all frames transmitted and received 285: <dt>fsm*<dd>All FSM events (except echo and resets) 286: <dt>iface*<dd>Interface layer events 287: <dt>ipcp*<dd>IP control protocol events and negotiation 288: <dt>ipv6cp*<dd>IPv6 control protocol events and negotiation 289: <dt>lcp*<dd>Link control protocol events and negotiation 290: <dt>link*<dd>Link layer events 291: <dt>phys*<dd>Device layer events 292: <dt>radius*<dd>RADIUS authentication events 293: <dt>rep*<dd>Repeater layer events 294: </dl> 295:  296: 297: <dt><code>help [ command ] </code><dd>This gives a brief description of the supplied command, or if 298: an incomplete command is given, lists the available alternatives. 299: 300: <dt><code>exit</code><dd>This command exits the console, but does not quit the mpd process. 301: This command is useful for disconnecting a telnet connection. 302: 303: <dt><code>shutdown</code><dd>Close down all connections and quit the mpd process. 304: 305: </dl> 306:  307: 308: <HR NOSHADE> 309: <A HREF="mpd.html">Mpd 5.9 User Manual</A> 310: : <A HREF="mpd17.html">Configuring Mpd</A> 311: : General mpd commands  312: Previous: <A HREF="mpd17.html">Configuring Mpd</A>  313: Next: <A HREF="mpd19.html">Mpd Layers</A> 314: 315: 316: 317: </BODY> 318: </HTML>