Differences

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

doc:uci:6relayd [2012/11/16 09:30]
steven created
doc:uci:6relayd [2013/06/11 22:59] (current)
steven
Line 1: Line 1:
-====== 6relayd IPv6 relay configuration ======+====== 6relayd IPv6 server and relay configuration ======
-The ''/etc/config/6relayd'' configures the //6relayd// IPv6 relay & server.+The ''/etc/config/6relayd'' configures the //6relayd// IPv6 server & relay.
-6relayd is an IPv6-tool that relays IPv6-management protocols like router +6relayd is a daemon for serving and relaying IPv6 management protocols to 
-discovery, neighbor discovery and DHCPv6 so that clients on routed (non- +configure clients and downstream routers. 
-bridged) interfaces can use the public address prefix, DHCPv6 and DNS-service + 
-of a master interface. This is useful to avoid NAT in chained IPv6-routers.+6relayd provides server services for RA, stateless and stateful DHCPv6, DHCPv6-PD and can 
 +be used to relay RA, DHCPv6 and NDP between routed (non-bridged) interfaces 
 +in case no delegated prefixes are provided by the upstream router.
-It can also be used as a lightweight router advertisement daemon and provide 
-stateless DHCPv6 service where size matters. 
==== Examples ==== ==== Examples ====
-**Example #1: Create a relay for several networks (here wan and lan) in proxy mode.+ 
 +**Example #1: Provide Router Discovery and DHCPv6 in server mode and 
 +fallback to relaying if there is no public prefix on the master interface. ** 
 + 
 +| ''config server 
 +      option network  'lan guest' 
 +      option rd      'server' 
 +      option dhcpv6  'server' 
 + # Remove the 2 following lines to disable fallback-mode 
 +      option master  'wan6' 
 +      option fallback_relay      'rd dhcpv6 ndp''' | 
 + 
 + 
 +**Example #2: Create a relay for several networks (here wan6 and lan) in proxy mode.
This can be used to proxy Router Discovery, DHCPv6 and NDP.** This can be used to proxy Router Discovery, DHCPv6 and NDP.**
-| ''config relay +| ''config server 
-      option network  'wan lan'+      option master  'wan6' 
 +      option network  'lan'
      option rd      'relay'       option rd      'relay'
      option dhcpv6  'relay'       option dhcpv6  'relay'
Line 23: Line 37:
-**Example #2: Provide Router Discovery and stateless DHCPv6 in server mode 
-This can be used as a small radvd and stateless DHCPv6-server replacement.** 
-| ''config server +**Example #3: Create a static IPv6 lease while running in management_level 1 or 2.** 
-      option network  'lan+| ''config lease 
-      option rd      'server' +      option duid '0001000115c4599a4b5b3a5a21d9
-      option dhcpv6  'server''' |+      option id '1234''' | 
 + 
==== Sections ==== ==== Sections ====
-Each section of type ''relay'' or ''server'' defines an instance of //6relayd// that will be run. +Each section of type ''server'' defines an instance of //6relayd// that will be run.\\ 
-Use type ''server'' if you want to use 6relayd to only announce the router and / or use it as a stateless DHCPv6 server only. +Each section of type ''lease'' defines an assigned static lease while running in management_level 1 or 2.
-Use type ''relay'' for all other use cases (e.g. relaying between different interfaces, proxying NDP, acting as a DHCPv6 relay, ...).+
-Sections of type ''server'' and ''relay'' share the same options. The only difference is the way the "network"-option is interpreted+Services of 6relayd can be used in two modes: 
-In ''relay''-mode the first network mentioned is the master interface to which Router Discovery and DHCPv6 requests are forwarded. For NDP-Proxying messages are proxied between all networks. +  * ''server'' if you want to use 6relayd to only announce the router and / or use it as a DHCPv6 server
-Server services (RD and DHCPv6) are only provided to slaves, therefore if you only want to use server features you should use the section type ''server'' where the first network listed is also + * ''relay'' for all other use cases (e.g. relaying between different interfaces, proxying NDP, acting as a DHCPv6 relay, ...).
-treated as a slave.+
^ Name ^ Values ^ Required ^ Default ^ Description ^ ^ Name ^ Values ^ Required ^ Default ^ Description ^
-| ''network'' | | yes | '''' | Specifies the network on which the 6relayd instance should provide services (first network is master, if section type is ''relay'') |+| ''master'' | 1 <logical interface> | yes, if services in relay-mode are present | | Specifies the network which is used as master for relaying | 
 +| ''network'' | 1 or more <logical interface> | yes | '''' | Specifies the network on which the 6relayd instance should provide services (first network is master, if section type is ''relay'') |
| ''rd'' | [relay,server] | no | '''' | Router Discovery mode of operation (empty = disabled) | | ''rd'' | [relay,server] | no | '''' | Router Discovery mode of operation (empty = disabled) |
| ''dhcpv6'' | [relay,server] | no | '''' | DHCPv6 mode of operation (empty = disabled) | | ''dhcpv6'' | [relay,server] | no | '''' | DHCPv6 mode of operation (empty = disabled) |
| ''ndp'' | [relay] | no | '''' | NDP-Proxy mode of operation (empty = disabled) | | ''ndp'' | [relay] | no | '''' | NDP-Proxy mode of operation (empty = disabled) |
 +| ''compat_ula'' | [0,1] | no | 0 | Ensure compatbility with broken devices and deprecate ULA if public prefixes are available. |
 +| ''fallback_relay'' | 1 or more [rd,dhcpv6,ndp] | no | '''' | Services to relay as fallback if there is no public prefix on the wan interface available |
| ''always_rewrite_dns'' | [0,1] | no | 0 | Define whether the RD- and DHCPv6-relay will always announce the DNS on the router itself instead of the one provided from the upstream router | | ''always_rewrite_dns'' | [0,1] | no | 0 | Define whether the RD- and DHCPv6-relay will always announce the DNS on the router itself instead of the one provided from the upstream router |
 +| ''rewrite_dns_addr'' | <IPv6-address> | no | '''' | Override the announced DNS-server with the specified address |
 +| ''always_assume_default'' | [0,1] | no | 0 | Define whether the RD-server will assume that IPv6 connectivity is present even if no public addresses are announced. |
 +| ''management_level'' | [0,1,2] | no | 0 | Define DHCPv6 mode. 0: stateless (no M-flag, A-flags set), 1: hybrid (M-Flag and A-flags set), 2: stateful (M-Flag set, A-Flags unset). |
 +| ''management_offlink'' | [0,1] | no | 0 | Announce prefixes as off-link (L-flags unset). |
 +| ''management_preference'' | [medium,low,high] | no | medium | Preference value announced for default router and routes. |
 +
 +
 +\\
 +A section of type lease assigns the client with the given duid adresses from every available prefix with the interface id ::1234/128.
 +The pool for non-static leases is ::100-::fff. The leasefile can be found at /tmp/hosts/6relayd for getting duids, hostnames, etc.
 +^ Name ^ Values ^ Description ^
 +| ''duid'' | hexadecimal | The device unique identifier. |
 +| ''id'' | hexadecimal (up to 8 chars) | The id for this lease, e.g. 1234. |

Back to top

doc/uci/6relayd.1353054652.txt.bz2 · Last modified: 2012/11/16 09:30 by steven