Differences

This shows you the differences between two versions of the page.

doc:uci:network [2013/07/13 14:06]
luka12345
doc:uci:network [2014/07/27 23:28] (current)
doddel
Line 84: Line 84:
| ''pppoa'' | PPP over ATM - DSL connection using a builtin modem |  ''pppd'' + plugin ...  | | ''pppoa'' | PPP over ATM - DSL connection using a builtin modem |  ''pppd'' + plugin ...  |
| ''3g'' | CDMA, UMTS or GPRS connection using an AT-style 3G modem |  ''comgt''  | | ''3g'' | CDMA, UMTS or GPRS connection using an AT-style 3G modem |  ''comgt''  |
 +| ''qmi'' | USB modems using QMI protocol |  ''uqmi''  |
| ''pptp'' | Connection via PPtP VPN |  ?  | | ''pptp'' | Connection via PPtP VPN |  ?  |
-| ''6in4'' | IPv6-in-IPv4 tunnel for use with Tunnel Brokers like HE.net |  ?  |+| ''6in4'' | IPv6-in-IPv4 tunnel forSuppresses DHCP-assigned default gateway if set to 0.0.0.0 use with Tunnel Brokers like HE.net |  ?
 +| ''aiccu'' | Anything-in-anything tunnel  |  ''aiccu'' |
| ''6to4'' | Stateless IPv6 over IPv4 transport |  ?  | | ''6to4'' | Stateless IPv6 over IPv4 transport |  ?  |
 +| ''6rd'' | IPv6 rapid deployment |  ''6rd''  |
 +| ''dslite'' | Dual-Stack Lite |  ''ds-lite''  |
 +| ''l2tp'' | L2TP Pseudowire Tunnel (l2tpv3) |  ''l2tpv3tun''  |
 +| ''l2tpv2'' | PPP over L2TP Pseudowire Tunnel |  ''xl2tpd''  |
 +| ''relay'' | relayd pseudo-bridge |  ''relayd''  |
| ''none'' | Unspecified protocol |  -  | | ''none'' | Unspecified protocol |  -  |
Line 119: Line 126:
| ''ip6class'' | list of strings | no | //(none)// | Define the IPv6 prefix-classes this interface will accept | | ''ip6class'' | list of strings | no | //(none)// | Define the IPv6 prefix-classes this interface will accept |
| ''dns'' | list of ip addresses | no | //(none)// | DNS server(s) | | ''dns'' | list of ip addresses | no | //(none)// | DNS server(s) |
 +| ''dns_search'' | list of domain names | no | //(none)// | Search list for host-name lookup |
| ''metric'' | integer | no | ''0'' | Specifies the default route metric to use | | ''metric'' | integer | no | ''0'' | Specifies the default route metric to use |
 +| ''force_link'' | integer | no | ''0'' | Specifies whether ip address, route, and optionally gateway are assigned to the interface regardless of the link being active ('1') or only after the link has become active ('0'); in trunk since the introduction of netifd; in case of a wireless interface the default is '1' for an AP and '0' for a STA. |
=== Protocol "dhcp" === === Protocol "dhcp" ===
^ Name ^ Type ^ Required ^ Default ^ Description ^ ^ Name ^ Type ^ Required ^ Default ^ Description ^
-| ''gateway'' | string | no | //(none)// | Suppresses DHCP-assigned default gateway if set to 0.0.0.0 |+| ''<del>gateway</del>'' | <del>string</del> | <del>no</del> | <del>//(none)//</del> | <del>Suppresses DHCP-assigned default gateway if set to 0.0.0.0</del> \\ (deprecated) |
| ''broadcast'' | boolean | no | ''0'' | Enable the broadcast flag in DHCP requests, required for certain ISPs, e.g. Charter with DOCSIS 3 | | ''broadcast'' | boolean | no | ''0'' | Enable the broadcast flag in DHCP requests, required for certain ISPs, e.g. Charter with DOCSIS 3 |
| ''hostname'' | string | no | //(none)// | Hostname to include in DHCP requests | | ''hostname'' | string | no | //(none)// | Hostname to include in DHCP requests |
Line 131: Line 140:
| ''dns'' | list of ip addresses | no | //(none)// | Supplement DHCP-assigned DNS server(s), or use only these if peerdns is 0 | | ''dns'' | list of ip addresses | no | //(none)// | Supplement DHCP-assigned DNS server(s), or use only these if peerdns is 0 |
| ''peerdns'' | boolean | no | ''1'' | Use DHCP-provided DNS server(s) | | ''peerdns'' | boolean | no | ''1'' | Use DHCP-provided DNS server(s) |
 +| ''defaultroute'' | boolean | no | ''1'' | Whether to create a default route via the received gateway |
| ''metric'' | integer | no | ''0'' | Specifies the default route metric to use | | ''metric'' | integer | no | ''0'' | Specifies the default route metric to use |
| ''reqopts'' | list of strings | no | //(none)// | Specifies a list of additional DHCP options to request | | ''reqopts'' | list of strings | no | //(none)// | Specifies a list of additional DHCP options to request |
Line 144: Line 154:
| ''reqaddress'' | [try,force,none] | no | try | Behaviour for requesting addresses | | ''reqaddress'' | [try,force,none] | no | try | Behaviour for requesting addresses |
| ''reqprefix'' | [auto,no,0-64] | no | auto | Behaviour for requesting prefixes (numbers denote hinted prefix length).  Use 'no' if you only want a single IPv6 address for the AP itself without a subnet for routing | | ''reqprefix'' | [auto,no,0-64] | no | auto | Behaviour for requesting prefixes (numbers denote hinted prefix length).  Use 'no' if you only want a single IPv6 address for the AP itself without a subnet for routing |
-| ''clientid'' | string | no | //system default// | Override client identifier in DHCP requests |+| ''clientid'' | hexstring | no | //system default// | Override client identifier in DHCP requests |
| ''ifaceid'' | ipv6 addr | no | //link-local identifier// | Override the interface identifier for adresses received via RA | | ''ifaceid'' | ipv6 addr | no | //link-local identifier// | Override the interface identifier for adresses received via RA |
| ''dns'' | list of ip addresses | no | //(none)// | Supplement DHCP-assigned DNS server(s), or use only these if peerdns is 0 | | ''dns'' | list of ip addresses | no | //(none)// | Supplement DHCP-assigned DNS server(s), or use only these if peerdns is 0 |
| ''peerdns'' | boolean | no | ''1'' | Use DHCP-provided DNS server(s) | | ''peerdns'' | boolean | no | ''1'' | Use DHCP-provided DNS server(s) |
 +| ''defaultroute'' | boolean | no | ''1'' | Whether to create an IPv6 default route via the received gateway |
| ''reqopts'' | list of numbers | no | //(none)// | Specifies a list of additional DHCP options to request | | ''reqopts'' | list of numbers | no | //(none)// | Specifies a list of additional DHCP options to request |
| ''noslaaconly'' | boolean | no | ''0'' | Don't allow configuration via SLAAC (RAs) only (implied by reqprefix != no) | | ''noslaaconly'' | boolean | no | ''0'' | Don't allow configuration via SLAAC (RAs) only (implied by reqprefix != no) |
Line 166: Line 177:
| ''connect'' | file path | no | //(none)// | Path to custom PPP connect script | | ''connect'' | file path | no | //(none)// | Path to custom PPP connect script |
| ''disconnect'' | file path | no | //(none)// | Path to custom PPP disconnect script | | ''disconnect'' | file path | no | //(none)// | Path to custom PPP disconnect script |
-| ''keepalive'' | number | no | //(none)// | Number of connection failures before reconnect |+| ''keepalive'' | number | no | //(none)// | Number of unanswered echo requests before considering the peer dead. The interval between echo requests is 5 seconds. |
| ''demand'' | number | no | //(none)// | Number of seconds to wait before closing the connection due to inactivity | | ''demand'' | number | no | //(none)// | Number of seconds to wait before closing the connection due to inactivity |
| ''defaultroute'' | boolean | no | ''1'' | Replace existing default route on PPP connect | | ''defaultroute'' | boolean | no | ''1'' | Replace existing default route on PPP connect |
Line 218: Line 229:
:!: The package ''comgt'' must be installed to use 3G. Check [[doc:recipes:3gdongle]] for further help with that. :!: The package ''comgt'' must be installed to use 3G. Check [[doc:recipes:3gdongle]] for further help with that.
 +
^ Name ^ Type ^ Required ^ Default ^ Description ^ ^ Name ^ Type ^ Required ^ Default ^ Description ^
Line 233: Line 245:
| ''dns'' | list of ip addresses | no | //(none)// | Override peer-assigned DNS server(s) | | ''dns'' | list of ip addresses | no | //(none)// | Override peer-assigned DNS server(s) |
| ''ipv6'' | boolean | no | ''0'' | Enable IPv6 on the PPP link | | ''ipv6'' | boolean | no | ''0'' | Enable IPv6 on the PPP link |
 +
 +
 +=== Protocol "qmi" (USB modems using QMI protocol) ===
 +
 +:!: The package ''uqmi'' must be installed to use QMI.
 +
 +^ Name ^ Type ^ Required ^ Default ^ Description ^
 +| ''device'' | file path | yes | //(none)// | QMI device node, typically /dev/cdc-wdm0 |
 +| ''apn'' | string | yes | //(none)// | Used APN |
 +| ''pincode'' | number | no | //(none)// | PIN code to unlock SIM card |
 +| ''username'' | string | no | //(none)// | Username for PAP/CHAP authentication |
 +| ''password'' | string | no | //(none)// | Password for PAP/CHAP authentication |
 +| ''auth'' | string | no | //(none)// | Authentication type: pap, chap, both, none|
 +| ''modes'' | string | no | //(modem default)// | Allowed network modes, comma separated list of: all, lte, umts, gsm, cdma, td-scdma |
 +| ''delay'' | number | no | 0 | Seconds to wait before trying to interact with the modem (some ZTE modems require up to 30 s.)|
Line 256: Line 283:
| ''ip6addr'' | IPv6 address (CIDR) | yes | //(none)// | Local IPv6 address delegated to the tunnel endpoint | | ''ip6addr'' | IPv6 address (CIDR) | yes | //(none)// | Local IPv6 address delegated to the tunnel endpoint |
| ''ip6prefix'' | IPv6 prefix | no | //(none)// | Routed IPv6 prefix for downstream interfaces (Barrier Breaker and later only) | | ''ip6prefix'' | IPv6 prefix | no | //(none)// | Routed IPv6 prefix for downstream interfaces (Barrier Breaker and later only) |
 +| ''sourcerouting'' | boolean | no | ''1'' | Whether to route only packets from delegated prefixes (Barrier Breaker and later only) |
| ''defaultroute'' | boolean | no | ''1'' | Whether to create an IPv6 default route over the tunnel | | ''defaultroute'' | boolean | no | ''1'' | Whether to create an IPv6 default route over the tunnel |
| ''ttl'' | integer | no | ''64'' | TTL used for the tunnel interface | | ''ttl'' | integer | no | ''64'' | TTL used for the tunnel interface |
| ''mtu'' | integer | no | ''1280'' | MTU used for the tunnel interface | | ''mtu'' | integer | no | ''1280'' | MTU used for the tunnel interface |
| ''tunnelid'' | integer | no | //(none)// | HE.net global tunnel ID (used for endpoint update) | | ''tunnelid'' | integer | no | //(none)// | HE.net global tunnel ID (used for endpoint update) |
-| ''username'' | string | no | //(none)// | HE.net user ID (used for endpoint update) | +| ''username'' | string | no | //(none)// | HE.net username which you use to login into tunnelbroker, not the User ID shows after you have login int  (used for endpoint update) | 
-| ''password'' | string | no | //(none)// | md5sum of HE.net password (used for endpoint update) |+| ''password'' | string | no | //(none)// | <del>md5sum of</del> HE.net password (used for endpoint update) | 
 +| ''updatekey'' | string | no | //(none)// | HE.net updatekey, overrides password (used for endpoint update) |
| ''metric'' | integer | no | ''0'' | Specifies the default route metric to use | | ''metric'' | integer | no | ''0'' | Specifies the default route metric to use |
**Note:** This protocol type does not need an ''ifname'' option set in the interface section. The interface name is derived from the section name, e.g. ''config interface sixbone'' would result in an interface named ''6in4-sixbone''. **Note:** This protocol type does not need an ''ifname'' option set in the interface section. The interface name is derived from the section name, e.g. ''config interface sixbone'' would result in an interface named ''6in4-sixbone''.
 +**Note:** HE.net has introduced updatekey as default for new tunnels in February 2014. Support added to Openwrt trunk by r39646.
 +
 +**Note:** as of r41358 **username**, **password** and **updatekey** are all plaintext entries.
 +
 +**Note:** although ip6prefix isn't required, sourcerouting, enabled by default, will prevent forwarding of packets unless ip6prefix is specified.
 +
 +=== Protocol "aiccu" (Automatic IPv6 Connectivity Client Utility) ===
 +
 +:!: The package ''aiccu'' must be installed to use this protocol.
 +
 +:!: This protocol is avaliable for Barrier Breaker and newer versions only.
 +
 +^ Name ^ Type ^ Required ^ Default ^ Description ^
 +| ''username'' | string | yes | //(none)// | Server username |
 +| ''password'' | string | yes | //(none)// | Server password |
 +| ''protocol'' | string | no | //(none)// | Tunnel setup protocol to use (''tic'', ''tsp'', ''l2tp'')  |
 +| ''server'' | string | no | ''tic.sixxs.net'' | Tunnel setup server to use |
 +| ''ip6addr'' | IPv6 address (CIDR) | no | //(none)// | Local IPv6 address delegated to the tunnel endpoint (not necessary) |
 +| ''ip6prefix'' | IPv6 prefix | no | //(none)// | Routed IPv6 prefix for downstream interfaces |
 +| ''defaultroute'' | boolean | no | ''1'' | Whether to create an IPv6 default route over the tunnel |
 +| ''sourcerouting'' | boolean | no | ''1'' | Whether to route only packets from delegated prefixes |
 +| ''tunnelid'' | integer | no | //(none)// | TIC server tunnel ID |
 +| ''requiretls'' | boolean | no | ''0'' | Require TLS connection to TIC server|
 +| ''nat'' | boolean | no | ''1'' | Notify the user that a NAT-kind network is detected|
 +| ''heartbeat'' | boolean | no | ''1'' | Make heartbeats |
 +| ''verbose'' | boolean | no | ''0'' | Verbose logging to system log|
 +
 +**Note:** This protocol type does not need an ''ifname'' option set in the interface section. The interface name is derived from the section name, e.g. ''config interface sixbone'' would result in an interface named ''aiccu-sixbone''.
=== Protocol "6to4" (IPv6-in-IPv4 Tunnel) === === Protocol "6to4" (IPv6-in-IPv4 Tunnel) ===
Line 301: Line 358:
**Note:** This protocol type does not need an ''ifname'' option set in the interface section. The interface name is derived from the section name, e.g. ''config interface wan6'' would result in an interface named ''6rd-wan6''. **Note:** This protocol type does not need an ''ifname'' option set in the interface section. The interface name is derived from the section name, e.g. ''config interface wan6'' would result in an interface named ''6rd-wan6''.
 +
 +**Note:** Some ISP's give you the number of bytes you should use from your WAN IP to calculate your IPv6 address. ip4prefixlen expects the //prefix// bytes of your WAN IP to calculate the IPv6 address. So if your ISP gives you 14 bytes to calculate, enter 18 (32 - 14).
Line 320: Line 379:
-=== Protocol "l2tp" (L2TP Pseudowire Tunnel) ===+=== Protocol "l2tp" (L2TP Pseudowire Tunnel, version 3) ===
:!: The package ''l2tpv3tun'' must be installed to use this protocol.\\ :!: The package ''l2tpv3tun'' must be installed to use this protocol.\\
Line 339: Line 398:
| //Additionally all options defined for the ''static'' protocol type can be specified// ||||| | //Additionally all options defined for the ''static'' protocol type can be specified// |||||
 +=== Protocol "l2tpv2" (PPP over L2TP Pseudowire Tunnel) ===
 +
 +:!: The package ''xl2tpd'' must be installed to use this protocol.
 +
 +Most options are similar to protocol "ppp".
 +
 +^ Name ^ Type ^ Required ^ Default ^ Description ^
 +| ''server'' | string | yes | //(none)// | L2TP server to connect to (hostname or IP address) |
 +| ''username'' | string | no | //(none)// | Username for PAP/CHAP authentication |
 +| ''password'' | string | yes if ''username'' is provided | //(none)// | Password for PAP/CHAP authentication |
 +| ''ipv6'' | bool | no | 0 | Enable IPv6 on the PPP link (IPv6CP) |
 +| ''mtu'' | int | no | ''pppd'' default | Maximum Transmit/Receive Unit, in bytes |
 +| ''keepalive'' | string | no | //(none)// | Number of unanswered echo requests before considering the peer dead. The interval between echo requests is 5 seconds. |
 +| ''pppd_options'' | string | no | //(none)// | Additional options to pass to ''pppd'' |
 +
 +The name of the physical interface will be "l2tp-<logical interface name>".
=== Protocol "relay" (Relayd Pseudo Bridge) === === Protocol "relay" (Relayd Pseudo Bridge) ===
Line 387: Line 462:
| {{:meta:icons:tango:48px-outdated.svg.png?nolink}} | The "config alias" approach is //deprecated//. it used to be needed when multiple interfaces sharing the same device where not supported. [[https://forum.openwrt.org/viewtopic.php?pid=203943#p203943|JoW]] | | {{:meta:icons:tango:48px-outdated.svg.png?nolink}} | The "config alias" approach is //deprecated//. it used to be needed when multiple interfaces sharing the same device where not supported. [[https://forum.openwrt.org/viewtopic.php?pid=203943#p203943|JoW]] |
 +===== Aliases: the old way =====
//Alias// sections can be used to define further IPv4 and IPv6 addresses for interfaces. //Alias// sections can be used to define further IPv4 and IPv6 addresses for interfaces.
They also allow combinations like DHCP on the main interface and a static IPv6 address in the alias, They also allow combinations like DHCP on the main interface and a static IPv6 address in the alias,
Line 423: Line 499:
  ip addr   ip addr
 +===== Aliases: the new way =====
 +
 +Basically create an 'interface' section per IP, but alias interfaces may NOT be of type bridge
 +
 +  * For non-bridged interfaces (physdev) the ''ifname'' is the <interface-of-network-for-same-phydev>
 +  * For cases where the interface is bridged the ''ifname'' is br-''base-interface'', where ''base-interface'' is the name of the primary IP's config section (e.g. for a the default lan interface config, the first alias would use ifname br-lan).
 +
 +A minimal alias definition for a bridged interface might be (for a scenario without vlans):
 +<code>config interface lan
 +        option 'ifname' 'eth0'
 +        option 'type' 'bridge'
 +        option 'proto' 'static'
 +        option 'ipaddr' '192.168.1.1'
 +        option 'netmask' '255.255.255.0'</code>
 +
 +<code>config interface lan2
 +      option 'ifname' 'br-lan'
 +      option 'proto' 'static'
 +      option 'ipaddr' '10.0.0.1'
 +      option 'netmask' '255.255.255.0'</code>
 +
 +or for a non-bridge interface
 +<code>config interface lan
 +        option 'ifname' 'eth0'
 +        option 'proto' 'static'
 +        option 'ipaddr' '192.168.1.1'
 +        option 'netmask' '255.255.255.0'</code>
 +
 +<code>config interface lan2
 +      option 'ifname' 'eth0'
 +      option 'proto' 'static'
 +      option 'ipaddr' '10.0.0.1'
 +      option 'netmask' '255.255.255.0'</code>
 +
 +To see a list of interfaces you can do ''ubus list network.interface.*'' and to view the ip of a particular interface (the UCI name not the physical interface), do ''ifstatus <interface>'' (e.g. ''ifstatus lan2'')
==== IPv4 Routes ==== ==== IPv4 Routes ====
Line 503: Line 614:
  * ''vpn'' is the incoming //logical interface name//   * ''vpn'' is the incoming //logical interface name//
  * ''fdca:1234::/64'' is the destination subnet to match   * ''fdca:1234::/64'' is the destination subnet to match
-  * ''prohibit'' is a routign action to take+  * ''prohibit'' is a routing action to take
The options below are defined for //IP rule// (''rule'' and ''rule6'') sections: The options below are defined for //IP rule// (''rule'' and ''rule6'') sections:
Line 754: Line 865:
fi fi
</code> </code>
 +===== Multiple IP addresses =====
 +Assigning multiple ip addresses to the same interface:
 +<code>
 +config interface foo
 +  option ifname eth1
 +  list ipaddr 10.8.0.1/24
 +  list ipaddr 10.9.0.1/24
 +  list ip6addr fdca:abcd::1/64
 +  list ip6addr fdca:cdef::1/64
 +</code>
 +Specifying multiple interfaces sharing the same device:
 +<code>
 +config interface foo
 +  option ifname eth1
 +  option ipaddr 10.8.0.1
 +  option netmask 255.255.255.0
 +  option ip6addr fdca:abcd::1/64
 +
 +config interface foo2
 +  option ifname eth1
 +  option ipaddr 10.9.0.1
 +  option netmask 255.255.255.0
 +  option ip6addr fdca:cdef::1/64
 +</code>
 +More info at [[https://dev.openwrt.org/ticket/2829#comment:7]].

Back to top

doc/uci/network.1373717216.txt.bz2 · Last modified: 2013/07/13 14:06 by luka12345