From: Marcin Siodelski Date: Tue, 23 Jun 2015 10:08:36 +0000 (+0200) Subject: [3578] Updated the DHCPv4 user guide with the options always returned. X-Git-Tag: trac3771_base~1^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2f61f31e92ead4f78c5b48d22b9a976b3a343ba7;p=thirdparty%2Fkea.git [3578] Updated the DHCPv4 user guide with the options always returned. --- diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index d38bebe38d..ac28f77ae9 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -715,10 +715,24 @@ temporarily override a list of interface names and listen on all interfaces. One of the major features of the DHCPv4 server is to provide configuration options to clients. Although there are several options that require special behavior, most options are sent by the server only if the client - explicitly requests them. The following example shows how to - configure the addresses of DNS servers, which is one of the most frequently used - options. Options specified in this way are considered global and apply - to all configured subnets. + explicitly requests them using the Parameter Request List option. + The last column of the specifies + which options can be sent by the server even when they are not + requested in the Parameter Request List option, and which are sent only + when explicitly requested. These options are marked with the 'true' + and 'false' values respectively. One group of options which are + sent by the server even when they are not requested are those that + require special processing, e.g. Client FQDN option returned if the + client has sent Client FQDN option to the server. Another group comprises + options with the fixed values specified in the server configuration, + e.g. 'domain-name-servers'. + + + + The following example shows how to configure the addresses of DNS + servers, which is one of the most frequently used options. Options + specified in this way are considered global and apply to all + configured subnets. "Dhcp4": { @@ -851,59 +865,61 @@ temporarily override a list of interface names and listen on all interfaces. List of standard DHCPv4 options - + + Name Code Type Array? + Returned if not requested? -subnet-mask1ipv4-addressfalse -time-offset2int32false -routers3ipv4-addresstrue -time-servers4ipv4-addresstrue -name-servers5ipv4-addressfalse -domain-name-servers6ipv4-addresstrue -log-servers7ipv4-addresstrue -cookie-servers8ipv4-addresstrue -lpr-servers9ipv4-addresstrue -impress-servers10ipv4-addresstrue -resource-location-servers11ipv4-addresstrue -host-name12stringfalse -boot-size13uint16false -merit-dump14stringfalse -domain-name15fqdnfalse -swap-server16ipv4-addressfalse -root-path17stringfalse -extensions-path18stringfalse -ip-forwarding19booleanfalse -non-local-source-routing20booleanfalse -policy-filter21ipv4-addresstrue -max-dgram-reassembly22uint16false -default-ip-ttl23uint8false -path-mtu-aging-timeout24uint32false -path-mtu-plateau-table25uint16true -interface-mtu26uint16false -all-subnets-local27booleanfalse -broadcast-address28ipv4-addressfalse -perform-mask-discovery29booleanfalse -mask-supplier30booleanfalse -router-discovery31booleanfalse -router-solicitation-address32ipv4-addressfalse -static-routes33ipv4-addresstrue -trailer-encapsulation34booleanfalse -arp-cache-timeout35uint32false -ieee802-3-encapsulation36booleanfalse -default-tcp-ttl37uint8false -tcp-keepalive-interval38uint32false -tcp-keepalive-garbage39booleanfalse +subnet-mask1ipv4-addressfalsetrue +time-offset2int32falsefalse +routers3ipv4-addresstruetrue +time-servers4ipv4-addresstruefalse +name-servers5ipv4-addressfalsefalse +domain-name-servers6ipv4-addresstruetrue +log-servers7ipv4-addresstruefalse +cookie-servers8ipv4-addresstruefalse +lpr-servers9ipv4-addresstruefalse +impress-servers10ipv4-addresstruefalse +resource-location-servers11ipv4-addresstruefalse +host-name12stringfalsetrue +boot-size13uint16falsefalse +merit-dump14stringfalsefalse +domain-name15fqdnfalsetrue +swap-server16ipv4-addressfalsefalse +root-path17stringfalsefalse +extensions-path18stringfalsefalse +ip-forwarding19booleanfalsefalse +non-local-source-routing20booleanfalsefalse +policy-filter21ipv4-addresstruefalse +max-dgram-reassembly22uint16falsefalse +default-ip-ttl23uint8falsefalse +path-mtu-aging-timeout24uint32falsefalse +path-mtu-plateau-table25uint16truefalse +interface-mtu26uint16falsefalse +all-subnets-local27booleanfalsefalse +broadcast-address28ipv4-addressfalsefalse +perform-mask-discovery29booleanfalsefalse +mask-supplier30booleanfalsefalse +router-discovery31booleanfalsefalse +router-solicitation-address32ipv4-addressfalsefalse +static-routes33ipv4-addresstruefalse +trailer-encapsulation34booleanfalsefalse +arp-cache-timeout35uint32falsefalse +ieee802-3-encapsulation36booleanfalsefalse +default-tcp-ttl37uint8falsefalse +tcp-keepalive-interval38uint32falsefalse +tcp-keepalive-garbage39booleanfalsefalse @@ -913,65 +929,70 @@ temporarily override a list of interface names and listen on all interfaces.
List of standard DHCPv4 options (continued) - + + Name Code Type Array? + Returned if not requested? -nis-domain40stringfalse -nis-servers41ipv4-addresstrue -ntp-servers42ipv4-addresstrue -vendor-encapsulated-options43emptyfalse -netbios-name-servers44ipv4-addresstrue -netbios-dd-server45ipv4-addresstrue -netbios-node-type46uint8false -netbios-scope47stringfalse -font-servers48ipv4-addresstrue -x-display-manager49ipv4-addresstrue -dhcp-requested-address50ipv4-addressfalse - -dhcp-option-overload52uint8false +dhcp-option-overload52uint8falsefalse -dhcp-message56stringfalse -dhcp-max-message-size57uint16false +dhcp-message56stringfalsefalse +dhcp-max-message-size57uint16falsefalse -vendor-class-identifier60binaryfalse +vendor-class-identifier60binaryfalsefalse +nwip-domain-name62stringfalsefalse +nwip-suboptions63binaryfalsefalse +tftp-server-name66stringfalsefalse +boot-file-name67stringfalsefalse +user-class77binaryfalsefalse +fqdn81recordfalsetrue + -nwip-domain-name62stringfalse -nwip-suboptions63binaryfalse -tftp-server-name66stringfalse -boot-file-name67stringfalse -user-class77binaryfalse -fqdn81recordfalse -dhcp-agent-options82emptyfalse -authenticate90binaryfalse -client-last-transaction-time91uint32false -associated-ip92ipv4-addresstrue -subnet-selection118ipv4-addressfalse -domain-search119binaryfalse -vivco-suboptions124binaryfalse -vivso-suboptions125binaryfalse +authenticate90binaryfalsefalse +client-last-transaction-time91uint32falsefalse +associated-ip92ipv4-addresstruefalse +subnet-selection118ipv4-addressfalsefalse +domain-search119binaryfalsefalse +vivco-suboptions124binaryfalsefalse +vivso-suboptions125binaryfalsefalse