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