]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Update doc/sphinx/arm/config.rst, doc/sphinx/arm/hooks.rst
authorMarcin Godzina <mgodzina@isc.org>
Wed, 1 Jun 2022 14:52:57 +0000 (14:52 +0000)
committerMarcin Godzina <mgodzina@isc.org>
Wed, 1 Jun 2022 14:52:57 +0000 (14:52 +0000)
doc/sphinx/arm/config.rst
doc/sphinx/arm/hooks.rst

index 684e4815d38de7245b3c017cebca5120497a7243..7f51135cf2a5de6b2fe09a599e9cf3d25534fcef 100644 (file)
@@ -183,6 +183,30 @@ configuration. It is not uncommon for a call for ``config-set`` followed by a
 The best way to avoid this problem is simply to abandon JSON comments and
 use user-context.
 
+Kea supports user contexts at the following levels: global scope,
+interfaces configuration, shared networks,
+subnets, client classes, option data and definitions, host
+reservations, control socket, DHCP-DDNS, loggers, leases and server ID. These
+are supported in both DHCPv4 and DHCPv6, with the exception of server ID,
+which is DHCPv6 only.
+
+User context can be added and edited in structures suported by Commands.
+
+For example `subnet4-update` command can be used to add user context data
+to existing subnet. 
+
+::
+
+   "subnet4": [ {
+      "id": 1,
+      "subnet": "10.20.30.0/24",
+      "user-context": {
+         "building": "Main"
+         "floor": 1 
+         }
+    } ]
+
+
 For a discussion about user-context used in hooks, see :ref:`user-context-hooks`.
 
 
index 55d256b626123fa19e7d03adf42886eece0e2e1f..cd0d19bf2b773a542060740fa81c6ed00486717b 100644 (file)
@@ -3624,12 +3624,7 @@ operations, for example.
 If user context is supported in a given context, the parser translates
 "comment" entries into user context with a "comment" entry.
 
-Kea supports user contexts at the following levels: global scope,
-interfaces configuration, shared networks,
-subnets, client classes, option data and definitions, host
-reservations, control socket, DHCP-DDNS, loggers, and server ID. These
-are supported in both DHCPv4 and DHCPv6, with the exception of server ID,
-which is DHCPv6 only.
+
 
 Some hooks use user-context for configuration to enable easy changes by commands.