From: Marcin Siodelski Date: Thu, 13 Oct 2016 13:58:12 +0000 (+0200) Subject: [github24] Updated Kea User's Guide with Softwire options. X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4034ab9ecd310469f6598d91c3725d4d104ab5b3;p=thirdparty%2Fkea.git [github24] Updated Kea User's Guide with Softwire options. --- diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index f49cd84bec..eb326fe427 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -1194,6 +1194,8 @@ It is merely echoed by the server fqdnFully qualified domain name (e.g. www.example.com) ipv4-addressIPv4 address in the usual dotted-decimal notation (e.g. 192.0.2.1) ipv6-addressIPv6 address in the usual colon notation (e.g. 2001:db8::1) + ipv6-prefixIPv6 prefix and prefix length specified using CIDR notation, e.g. 2001:db8:1::/64. This data type is used to represent an 8-bit field conveying a prefix length and the variable length prefix value + psidPSID and PSID length separated by a slash, e.g. 3/4 specifies PSID=3 and PSID length=4. In the wire format it is represented by an 8-bit field carrying PSID length (in this case equal to 4) and the 16-bits long PSID value field (in this case equal to "0011000000000000b" using binary notation). Allowed values for a PSID length are 0 to 16. See RFC 7597 for the details about the PSID wire representation recordStructured data that may comprise any types (except "record" and "empty") stringAny text uint88 bit unsigned integer with allowed values 0 to 255 diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index 249090065b..3e60c17269 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -819,28 +819,29 @@ temporarily override a list of interface names and listen on all interfaces.
Prefix Exclude Option - For each delegated prefix configured as above, the delegating router - may choose to exclude a subprefix (i.e. with greater prefix length) - as proposed in - RFC 6603. - The IA PD option responsible for specifying IPv6 address prefixes - limits the amount of PD Exclude options that it can encapsulate to - at most one, thus it can only exclude one prefix from a given - delegated prefix. The configuration example below specifies an - excluded prefix. - + For each delegated prefix the delegating router may choose to exclude + a single prefix out of the delegated prefix as specified in the + RFC 6603. + The requesting router must not assign the excluded prefix to any + of its downstream interfaces and it is intended to be used on a + link through which the delegating router exchanges DHCPv6 messages with + the requesting router. The configuration example below demonstrates how + to specify an excluded prefix within a prefix pool definition. The + excluded prefix "2001:db8:1:babe:cafe:80::/72" will be sent to a + requesting router which includes Prefix Exclude option in the ORO, and + which is delegated a prefix from this pool. + "Dhcp6": { "subnet6": [ { "subnet": "2001:db8:1::/48", - "pools": [ { "pool": "2001:db8:1::/80" } ], "pd-pools": [ { "prefix": "2001:db8:1:8000::", "prefix-len": 48, "delegated-len": 64, - "excluded-prefix": "2001:db8:1:babe:cafe:80:", + "excluded-prefix": "2001:db8:1:babe:cafe:80::", "excluded-prefix-len": 72 } ] @@ -1086,10 +1087,10 @@ temporarily override a list of interface names and listen on all interfaces. client-linklayer-addr79binaryfalse dhcp4o6-server-addr88ipv6-addresstrue -s46-rule89record(uint8, uint8, uint8, ipv4-address, ipv6-prefix)false -s46-br90ipv6-prefixfalse +s46-rule89record (uint8, uint8, uint8, ipv4-address, ipv6-prefix)false +s46-br90ipv6-addressfalse s46-dmr91ipv6-prefixfalse -s46-v4v6bind92record(ipv4-address, ipv6-prefix)false +s46-v4v6bind92record (ipv4-address, ipv6-prefix)false s46-portparams93record(uint8, psid)false s46-cont-mape94emptyfalse s46-cont-mapt95emptyfalse @@ -1122,125 +1123,145 @@ temporarily override a list of interface names and listen on all interfaces.
- Common Softwire46 Options - Softwire46 options are involved in IPv4 over IPv6 provisioning by - means of tunneling or translation. More is described in - RFC 7598. - -
- S46 Rule - The following option configuration specifies under data, the IPv6 - prefix that it can use to map addresses from. Mapping is done using - Best Mapping Rule (BMR) and Forwarding Mapping Rule (FMR). + Common Softwire46 Options + + Softwire46 options are involved in IPv4 over IPv6 provisioning by + means of tunneling or translation as specified in the + RFC 7598. + The following sections provide configuration examples of these + options. + + +
+ Softwire46 Container Options + + S46 container options group rules and optional port parameters + for a specified domain. There are three container options specified + in the "dhcp6" (top level) option space: MAP-E Container option, + MAP-T Container option and S46 Lieghtweight 4over6 Container option. + These options only contain encapsulated options specified below. + They do not include any data fields. + + + + In order to configure the server to send specific container option + along with all encapsulated options, the container option must be + included in the server configuration as shown below: + +"Dhcp6": { + ... + "option-data": [ + { + "name": "s46-cont-mape" + } ], + ... +} + + + This configuration will cause the server to include MAP-E Container + option to the client. Use "s46-cont-mapt" or "s46-cont-lw" for the + MAP-T Container and S46 Lightweight 4over6 Container options + respectively. + + + + All remaining softwire options described below are included in one + of the container options. Thus, they have to be included in appropriate + option spaces by selecting a "space" name, which specifies in which + option they are supposed to be included. + +
+ +
+ S46 Rule Option + + The S46 Rule option is used for conveying the Basic Mapping Rule (BMR) + and Forwarding Mapping Rule (FMR). { - "code": 92, - "csv-format": true, - "data": "2001:db8::cafe::/96", - "name": "s46-v4v6bind", - "space": "4over6-lw" + "space": "s46-cont-mape-options", + "name": "s46-rule", + "data": "1, 0, 24, 192.0.2.0, 2001:db8:1::/64" } -
+ Other possible "space" value is "s46-cont-mapt-options". + + +
- S46 BR + S46 BR Option - @todo: Description - + The S46 BR option is used to convey the IPv6 address of the + Border Relay. This option is mandatory in the MAP-E + Container option and not permitted in the MAP-T and + S46 Lightweight 4over6 Container options. { - "code": 90, - "csv-format": true, - "data": "2001:db8::cafe::/48", + "space": "s46-cont-mape-options", "name": "s46-br", - "space": "4over6-lw" + "data": "2001:db8::cafe::1", } + Other possible "space" value is "s46-cont-lw-options". +
+
- S46 DMR. No config required + S46 DMR Option - @todo: Description - + The S46 DMR option is used to convey values for the Default + Mapping Rule (DMR). This option is mandatory in the MAP-T + container option and not permitted in the MAP-E and S46 + Lightweight 4over6 Container options. - @todo: Configuration example +{ + "space": "s46-cont-mapt-options", + "name": "s46-dmr", + "data": "2001:db8::cafe::/64", +} + This option must not be included in other containers. +
+
- S46 IPv4/IPv6 Address Binding + S46 IPv4/IPv6 Address Binding option. - @todo: Description - + The S46 IPv4/IPv6 Address Binding option may be used to specify + the full or shared IPv4 address of the Customer Edge (CE). + The IPv6 prefix field is used by the CE to identify the + correct prefix to use for the tunnel source. - @todo: Configuration example +{ + "space": "s46-cont-lw", + "name": "s46-v4v6bind", + "data": "192.0.2.3, 2001:db8:1:cafe::/64" +} + This option must not be included in other containers. +
S46 Port Parameters - This option specifies a range of optional ports that may be used - in the form of offset,psid-len,psid which - means that ports that fill the area offseted by - offset and shortened to - psid-len length can be used. - + The S46 Port Parameters option specifies optional port set + information that MAY be provided to CEs { - "code": 93, - "csv-format": true, - "data": "2,4,12288", + "space": "s46-rule-options", "name": "s46-portparams", - "space": "v4v6bind" + "data": "2, 3/4", } - -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| PSID | -+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -|<->|<----->| - | └--- Identified PSID value of 4b - └--- Offset of 2b -|<----------------------------->| - └--- 16b - -
-
-
- Softwire46 Containers - - S46 containers group rules and optional ports for a specified - domain. + Other possible "space" value is "s46-v4v6bind" to include + this option in the S46 IPv4/IPv6 Address Binding option. -
- S46 MAP-E container - - @todo: Description - - - @todo: Configuration example - -
-
- S46 MAP-T container - @todo: Description - - - @todo: Configuration example - -
-
- S46 Lightweight 4over6 container - - @todo: Description + Note that the second value in the example above specifies the + PSID and PSID length fields in the format of PSID/PSID length. + This is equivalent to the values of PSID-len=4 and + PSID=12288 conveyed in the S46 Port Parameters option. - -{ - "code": 96, - "name": "s46-cont-lw", - "space": "dhcp6" -} -