From: Francis Dupont Date: Wed, 29 Nov 2017 15:28:41 +0000 (+0100) Subject: [5351] Updated the doc X-Git-Tag: trac5444_base~13 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fa9c65b7342889c8115bc47c081ebff31b890376;p=thirdparty%2Fkea.git [5351] Updated the doc --- diff --git a/doc/examples/kea4/advanced.json b/doc/examples/kea4/advanced.json index 7138533730..1d858cacee 100644 --- a/doc/examples/kea4/advanced.json +++ b/doc/examples/kea4/advanced.json @@ -101,12 +101,12 @@ "match-client-id": true, // The following list defines subnets. Each subnet consists of at - // least subnet and pool entries. One extra feature that requires some - // explanation is user-context. This is a structure that you can define - // in subnets and pools. It is parsed by Kea, but not used directly. - // It is intended to keep anything you may want to put there - comments, - // extra designations, floor or department names etc. These structures - // will be made available to Kea hooks. + // least subnet and pool entries. One extra feature that requires + // some explanation is user-context. This is a structure that you can + // define in subnets, pools and others. It is parsed by Kea, but not + // used directly. It is intended to keep anything you may want to + // put there - comments, extra designations, floor or department + // names etc. These structures will be made available to Kea hooks. // You can define multiple user-contexts in the same scope without // the last one replacing previous values. A comment entry is // translated into a user-context with a "comment" property so diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml index bc6ee58d2f..cf101ab28c 100644 --- a/doc/guide/dhcp4-srv.xml +++ b/doc/guide/dhcp4-srv.xml @@ -4636,8 +4636,11 @@ autogenerated IDs are not stable across configuration changes. - User contexts can be specified on either subnet or pool level. One - other useful usage is the ability to store comments or descriptions. + User contexts can be specified on either global scope, + shared network, subnet, pool, client class, option data or + definition level but not yet for a host reservation. One + other useful usage is the ability to store comments or + descriptions. diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml index befbca5b3e..9e59aba9b0 100644 --- a/doc/guide/dhcp6-srv.xml +++ b/doc/guide/dhcp6-srv.xml @@ -4597,8 +4597,11 @@ autogenerated IDs are not stable across configuration changes. - User contexts can be specified on either subnet or pool level. One - other useful usage is the ability to store comments or descriptions. + User contexts can be specified on either global scope, + shared network, subnet, pool, client class, option data or + definition level but not yet for a host reservation. One + other useful usage is the ability to store comments or + descriptions. diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index e1b8630fd0..3e245beac2 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -2566,10 +2566,13 @@ both the command and the response. common usage. - As of Kea 1.3, the structures that allow user contexts are pools of all - types (addresses and prefixes) and subnets. These are supported in both - DHCPv4 and DHCPv6. It is expected that other structures will be extended - in the future to provide the user context capability. + As of Kea 1.3, the structures that allow user contexts are + pools of all types (addresses and prefixes) and subnets. Kea + 1.4 extended to the global scope, shared-networks, client + classes, and option data and definitions. These are supported + in both DHCPv4 and DHCPv6. It is expected that host + reservations and other structures will be extended in the + future to provide the user context capability.