embedaddon/mpd/doc/mpd28.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / mpd / doc / mpd28.html
Revision 1.1.1.3 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Tue Nov 1 09:56:12 2016 UTC (7 years, 8 months ago) by misho
Branches: mpd, MAIN
CVS tags: v5_8p7, v5_8p1_cross, v5_8p1, v5_8, HEAD

mpd 5.8

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>Interface layer</TITLE> 6: </HEAD> 7: <BODY text="#000000" bgcolor="#ffffff"> 8: 9: <A HREF="mpd.html">Mpd 5.8 User Manual</A> 10: : <A HREF="mpd17.html">Configuring Mpd</A> 11: : Interface layer  12: Previous: <A HREF="mpd27.html">IPv6CP layer</A>  13: Next: <A HREF="mpd29.html">Authentication, Authorization and Accounting (AAA)</A> 14: 15: 16: <HR NOSHADE> 17: <H2><A NAME="28"></A>4.9. Interface layer<A NAME="interface"></A></H2> 18: 19: This chapter describes commands that configure the interface layer. 20: All of these commands apply to the currently active bundle. 21: Note that while most of the time mpd is used for transmitting 22: IP traffic, it is designed to support other (currently unimplemented) 23: protocols such as AppleTalk, IPX, etc. This is why the Interface 24: layer (which is protocol independent) is distinct from the 25: <A HREF="mpd26.html#ipcp">ipcp</A> which is specific to IP. 26:  27: <dl> 28: 29: <dt><code>set iface name [ name ]</code><dd>This command changes interface name from default ngX to specified one. 30: If name argument is not specified, original ngX name is restored. 31: Note that inside Netgraph original ngX name is always used. 32: 33: <dt><code>set iface description [ description ]</code><dd>This command changes interface description. 34: Template may contain conversion specifications: 35: <pre> 36: %% expands to single % sign; 37: %a for interface local address; 38: %A for peer local address; 39: %i for system interface index; 40: %I for interface name; 41: %l for name of bundle's first link 42: %M for peer MAC address of bundle's first link 43: %o for local outer ("physical") address of bundle's first link 44: %O for peer outer ("physical") address of bundle's first link 45: %P for peer outer ("physical") port of bundle's first link 46: %S for interface status (DoD/UP/DOWN) 47: %t for type of bundle's first link (pppoe, pptp, l2tp etc.) 48: %u for self auth name (or dash if self auth name not used) 49: %U for peer auth name (or dash if peer has not authenticated) 50: </pre> 51:  52: 53: <dt><code>set iface group [ group ]</code><dd>This command add interface to specific group. 54: 55: <dt><code>set iface addrs [!]local-ip [!]remote-ip</code><dd>This command is usually required when dial-on-demand is enabled. 56: Normally, mpd configures the interface with the IP addresses that 57: were negotiated when connecting the link. Since dial-on-demand 58: configures the interface before actually connecting, mpd has to be 59: told initial local and remote IP addresses to give the interface. 60: These addresses don't have to correspond to the ``real'' ones; in 61: fact, both addresses can be completely fictional. If and when 62: different addresses are negotiated later, mpd will automatically 63: renumber the interface and adjust the routes. 64: Also this command may be used to force specified addresses usage 65: instead of negotiated ones. It may be useful in some specific cases, 66: for example, to avoid routing loop with misconfigured PPTP server. 67: In such case '!' mark specifies IPs to be forced. 68: 69: <dt><code>set iface route address[/width]</code><dd>This command associates a route with the bundle. Whenever the 70: interface is configured up, all associated routes are added. 71: A route of <code>default</code> indicates the default route. 72: Otherwise, the route is a network address with optional netmask 73: width (e.g., <code>192.168.1.0/24</code>). If the netmask 74: width is omitted, a single host route is assumed (i.e., a width 75: of 32). 76: Routes are automatically removed when the interface is brought down. 77: 78: <dt><code>set iface mtu value</code><dd>This command sets an upper bound on the MTU that will be configured 79: on the interface when the bundle comes up. 80: This value is not used at all during link negotiation; there are 81: separate bundle and link commands for configuring that. 82: Even if a higher bundle MTU is negotiated, this limit will still apply. 83: This command is useful when you want to manually restrict the MTU 84: of the interface for other reasons, e.g., if you're also doing IPSec. 85: The default is 1500. 86: 87: <dt><code>set iface idle seconds</code><dd>Sets the idle timeout value for the bundle. If no incoming or 88: outgoing packets are transmitted for <code>seconds</code> 89: seconds, the connection is brought down. An idle timeout of 90: zero disables this feature. 91: When the idle timeout occurs, if the dial-on-demand option is 92: enabled, mpd goes back into dial-on-demand mode. Otherwise, the 93: interface is brought down and all associated routes removed. 94: The default is 0. 95: 96: <dt><code>set iface session seconds</code><dd>Sets the session timeout value for the bundle. An session timeout of 97: zero disables this feature. 98: The default is 0. 99: 100: <dt><code>set iface up-script script </code><dd> 101: <dt><code>set iface down-script script </code><dd> 102: Mpd can optionally run a user program every time one of network 103: protocols (IPCP/IPv6CP) at the interface is brought up or down. 104: The <code>up-script</code> is called like this: 105: <blockquote><code> 106: <code>script interface proto local-ip remote-ip authname [ dns1 server-ip ] [ dns2 server-ip ] 107: peer-address</code> 108: </code></blockquote> 109:  110: If up-script exit status is not 0, mpd will kill respective protocol. 111: The <code>down-script</code> is called like this: 112: <blockquote><code> 113: <code>script interface proto local-ip remote-ip authname peer-address</code> 114: </code></blockquote> 115:  116: 117: <dt><code>set iface enable option ...  118: set iface disable option ...</code><dd>Enable and disable the various interface layer options for the bundle. 119: 120: </dl> 121:  122: 123: The options available at the interface layer are: 124:  125: <dl> 126: 127: <dt><code>on-demand</code><dd>This option causes the interface to operate in dial-on-demand mode, 128: allowing you to have a ``virtual full time'' connection. 129: An OPEN event causes the interface to be configured, but the actual 130: connection of the link is delayed until qualifying outgoing traffic 131: is detected. Moreover, after an idle timeout, the interface is not 132: brought down; further traffic will bring the link back up again. 133: The default is disable. 134: 135: <dt><code>proxy-arp</code><dd>When this option is enabled, if after link negotiation the peer's 136: IP address is determined to lie on a local subnet, then mpd will 137: arrange for the local machine to install a proxy ARP entry for 138: the remote machine's IP address. 139: For example, suppose the local machine lies on a LAN with address 140: 192.168.1.10, and another machine will be connecting via mpd 141: and using the LAN address 192.168.1.20. Then these commands would 142: set up proxy ARP for the remote machine: 143: <blockquote><code> 144: <code>set iface enable proxy-arp 145: set ipcp ranges 192.168.1.10/32 192.168.1.20/32</code> 146: </code></blockquote> 147:  148: The default is disable. 149: 150: <dt><code>keep-timeout</code><dd>When this option is enabled, we are not clear ``session timeout'' 151: counter. This is useful together with CoA requests. 152: The default is disable. 153: 154: <dt><code>tcpmssfix</code><dd>This option causes mpd to adjust incoming and outgoing TCP SYN 155: segments so that the requested maximum segment size is not greater 156: than the amount allowed by the interface MTU. 157: This is necessary in many setups to avoid problems caused by routers 158: that drop ICMP Datagram Too Big messages. Without these messages, 159: the originating machine sends data, it passes the rogue router then 160: hits a machine that has an MTU that is not big enough for the data. 161: Because the IP Don't Fragment option is set, this machine sends an 162: ICMP Datagram Too Big message back to the originator and drops the 163: packet. The rogue router drops the ICMP message and the originator 164: never gets to discover that it must reduce the fragment size or drop 165: the IP Don't Fragment option from its outgoing data. 166: The code is based on tcpmssd wich was written by Ruslan Ermilov 167: <A href="mailto:<ru@FreeBSD.org>">mailto:<ru@FreeBSD.org></A> 168: based on work done by Patrick Bihan-Faou 169: <A href="mailto:<patrick@mindstep.com>">mailto:<patrick@mindstep.com></A>. 170: The default is disable. 171: 172: <dt><code>tee</code><dd>If enabled, a ng_tee(4) node will be inserted 173: into the bundle graph, right after the interface node. The tee node 174: can be useful for debugging or traffic accounting. 175: The default is disable. 176: 177: <dt><code>nat</code><dd>Enable NAT for this bundle. 178: See 179: <A HREF="mpd39.html#nat">nat</A> for more information. 180: The default is disable. 181: 182: <dt><code>netflow-in</code><dd> 183: <dt><code>netflow-out</code><dd> 184: <dt><code>netflow-once</code><dd>If enabled, the bundle will participate in 185: NetFlow generation. See 186: <A HREF="mpd34.html#netflow">netflow</A> 187: for more information. The netflow-out option is like netflow-in, but 188: generates NetFlow data for outgoing packets instead of incoming. 189: If netflow-once enabled - packet will be accounted only once while 190: in kernel. 191: The default is disable. 192: 193: <dt><code>ipacct</code><dd>If enabled, the bundle will participate in IP accounting with ng_ipacct node. 194: See 195: <A HREF="mpd35.html#ipacct">ipacct</A> for more information. 196: The default is disable. 197: 198: </dl> 199:  200: <HR NOSHADE> 201: <A HREF="mpd.html">Mpd 5.8 User Manual</A> 202: : <A HREF="mpd17.html">Configuring Mpd</A> 203: : Interface layer  204: Previous: <A HREF="mpd27.html">IPv6CP layer</A>  205: Next: <A HREF="mpd29.html">Authentication, Authorization and Accounting (AAA)</A> 206: 207: 208: 209: </BODY> 210: </HTML>