]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#10,!3] Various small corrections in the json files
authorTomek Mrugalski <tomasz@isc.org>
Fri, 5 Oct 2018 16:26:49 +0000 (18:26 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Tue, 29 Oct 2019 17:57:14 +0000 (18:57 +0100)
23 files changed:
doc/api/config-test.json
doc/api/config-write.json
doc/api/list-commands.json
doc/api/network4-list.json
doc/api/network6-del.json
doc/api/network6-list.json
doc/api/shutdown.json
doc/api/stat-lease4-get.json
doc/api/stat-lease6-get.json
doc/api/statistic-reset-all.json
doc/api/statistic-reset.json
doc/api/subnet4-add.json
doc/api/subnet4-del.json
doc/api/subnet4-get.json
doc/api/subnet6-add.json
doc/api/subnet6-del.json
doc/api/subnet6-get.json
doc/api/version-get.json
doc/docgen/cmds-list
doc/guide/hooks-ha.xml
doc/guide/hooks-lease-cmds.xml
doc/guide/hooks-stat-cmds.xml
doc/guide/hooks.xml

index 079c6d942eadedb3153deae221857e57465d745b..9f5daac5bec06b17fcf2f052196635e8b257d8b2 100644 (file)
@@ -2,7 +2,7 @@
     "name": "config-test",
     "brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.",
     "description": "See <xref linkend=\"command-config-test\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"config-test\",
index b998e866c6b742ae3271813e556bb072ec825064..bce80a9007a69bf08e30e38c38e2b60f905faeda 100644 (file)
@@ -1,8 +1,9 @@
 {
     "name": "config-write",
-    "brief": "The config-write command instructs the Kea server to write its current configuration to a file on disk.",
+    "brief": "The config-write command instructs the Kea server to write its
+              current configuration to a file on disk.",
     "description": "See <xref linkend=\"command-config-write\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"config-write\",
index e7a58962f395e6be722b5adef80955691bfc00b4..0e3928895c15c8ebeb35e467559711542b78b426 100644 (file)
@@ -2,7 +2,7 @@
     "name": "list-commands",
     "brief": "The list-commands command retrieves a list of all commands supported by the server.",
     "description": "See <xref linkend=\"command-list-commands\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" , "ca" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ],
     "avail": "1.0.0",
     "cmd-syntax": "{
     \"command\": \"list-commands\",
index a1ec62a6ffb30b3058b1cc44ec7d9bddbf0751b5..865a7c5011d6d493ae7366c9b8e4f88813789f8b 100644 (file)
@@ -1,7 +1,7 @@
 {
     "name": "network4-list",
     "brief": "The network4-list command is used to retrieve full list of currently configured shared networks.",
-    "description": "See <xref linkend=\"idp73\"/>",
+    "description": "See <xref linkend=\"command-networkX-list\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.3.0",
     "hook": "subnet_cmds",
index 84e509f49b5c2df9585d3634fdc24739548e8668..5339f2a7aa4f6d21cfe919f51d9f75ee01611f85 100644 (file)
@@ -1,7 +1,7 @@
 {
     "name": "network6-del",
     "brief": "The network6-del command is used to delete existing shared networks.",
-    "description": "See <xref linkend=\"idp76\"/>",
+    "description": "See <xref linkend=\"command-network6-del\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.3.0",
     "hook": "subnet_cmds",
@@ -11,7 +11,8 @@
         \"name\": \"floor13\"
     }
 }",
-    "cmd-comment": "The network6-del command uses exactly the same syntax for both the command and the response.",
+    "cmd-comment": "The network6-del command uses exactly the same syntax for
+                    both the command and the response.",
     "resp-syntax": "{
     \"command\": \"network4-del\",
     \"arguments\": {
index 64cd2089caf3ab8d97ad65ab0b3fd86cd327288d..61d731b3132ec0f8fbd63277febb44ce4f1f2e86 100644 (file)
@@ -1,7 +1,7 @@
 {
     "name": "network6-list",
     "brief": "The network6-list command is used to retrieve full list of currently configured shared networks.",
-    "description": "See <xref linkend=\"idp73\"/>",
+    "description": "See <xref linkend=\"command-networkX-list\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.3.0",
     "hook": "subnet_cmds",
index 137418ecf21ef42649c58d58332bc5b641963695..5d2c387ad62482821ead5dbc961709b33bd1fff1 100644 (file)
@@ -2,10 +2,11 @@
     "name": "shutdown",
     "brief": "The shutdown command instructs the server to initiate its shutdown procedure.",
     "description": "See <xref linkend=\"command-shutdown\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
     "avail": "1.0.0",
     "cmd-syntax": "{
     \"command\": \"shutdown\"
 }",
-    "cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated."
+    "cmd-comment": "The server will respond with a confirmation that the shutdown
+                    procedure has been initiated."
 }
index d8f16452b7be85b68e3b5a59fdaa713e7e16288c..4ab8f9aaf654f4cff06ea2dcc6252c0c0431bc99 100644 (file)
@@ -1,7 +1,8 @@
 {
     "name": "stat-lease4-get",
-    "brief": "The stat-lease4-get command fetches lease statistics for a range of known subnets.",
-    "description": "See <xref linkend=\"idp81\"/>",
+    "brief": "The stat-lease4-get command fetches lease statistics for a range
+              of known IPv4 subnets.",
+    "description": "See <xref linkend=\"command-stat-lease4-get\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.4.0",
     "hook": "stat_cmds",
     \"text\": \"stat-lease4-get: 2 rows found\",
     \"arguments\": {
       \"result-set\": {
-        \"columns\": [ \"subnet-id\", \"total-addresses\", \"assigned-addresses\", \"declined-addresses\" ]
+        \"columns\": [ \"subnet-id\",
+                       \"total-addresses\",
+                       \"assigned-addresses\",
+                       \"declined-addresses\" ]
         \"rows\": [
           [ 10, 256, 111, 0 ],
           [ 20, 4098, 2034, 4 ]
index 29b96e8704d3d9d500c39853f74dace889818489..4221b0a8a3c506c9586618cfe51330924946681c 100644 (file)
@@ -1,7 +1,8 @@
 {
     "name": "stat-lease6-get",
-    "brief": "The stat-lease6-get command fetches lease statistics for a range of known subnets.",
-    "description": "See <xref linkend=\"idp81\"/>",
+    "brief": "The stat-lease6-get command fetches lease statistics for a range
+              of known IPv6 subnets.",
+    "description": "See <xref linkend=\"command-stat-lease6-get\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.4.0",
     "hook": "stat_cmds",
index deb136aa11b87d9c5cedfc325ffce29ef2a7427a..e87ab26c687e64935280b6c44f41ecb26de436f6 100644 (file)
@@ -8,5 +8,5 @@
     \"command\": \"statistic-reset-all\",
     \"arguments\": { }
 }",
-    "cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description.",
-}
\ No newline at end of file
+    "cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
+}
index 32b9d1a22cbb2b277bb8a0b0a31d657cbfe4f82e..c06162aef434c9300d7761bfbb519ae198b368b3 100644 (file)
@@ -10,5 +10,5 @@
         \"name\": \"pkt4-received\"
     }
 }",
-    "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description.",
-}
\ No newline at end of file
+    "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
+}
index 580e72b0bed0be6c688e079ef51a52fc7decbd5a..5256c36b734e89b68207ceeaa69447b0c9a26d25 100644 (file)
@@ -26,5 +26,5 @@
             }
         ]
     }
-}",
-}
\ No newline at end of file
+}"
+}
index 19c6999442f8017371d3f929353c531849bcd863..cf3475bf619e25072895c0dbf0272a3d5106d04c 100644 (file)
@@ -1,6 +1,6 @@
 {
     "name": "subnet4-del",
-    "brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.",
+    "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
     "description": "See <xref linkend=\"idp71\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.3.0",
@@ -22,5 +22,5 @@
             }
         ]
     }
-}",
-}
\ No newline at end of file
+}"
+}
index 79ba6f927bb7c10af40f3130f4573ea2713d928e..2bef76adc5dd6d2c26605ffdc1bdf86d53098f64 100644 (file)
@@ -26,5 +26,5 @@
             }
         ]
     }
-}",
-}
\ No newline at end of file
+}"
+}
index ece6ece43f60e9369f7501d6bcb6970a4707e60b..bd477eb1f3da5d72c736f0476b9f135ca1eeac53 100644 (file)
@@ -26,5 +26,5 @@
             }
         ]
     }
-}",
-}
\ No newline at end of file
+}"
+}
index 636f8c2a0a7022f5294d4f4d97e7a116714a44c7..3ce5e70096bd18c6fd821a9d1d538f1b5335523c 100644 (file)
@@ -1,6 +1,6 @@
 {
     "name": "subnet6-del",
-    "brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.",
+    "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.",
     "description": "See <xref linkend=\"idp72\"/>",
     "support": [ "kea-dhcp4", "kea-dhcp6" ],
     "avail": "1.3.0",
@@ -20,5 +20,5 @@
             \"subnet\": \"2001:db8:1::/64\"
         }
     ]
-}",
-}
\ No newline at end of file
+}"
+}
index 7541db6d13fce2c903aaf884125ef0cc63826bbb..dde5a00aa28306c171943446ef47b18224c6e077 100644 (file)
@@ -26,5 +26,5 @@
             }
         ]
     }
-}",
-}
\ No newline at end of file
+}"
+}
index 46b8880a10485ed3e3532b7a62970404228b89c7..8daf8639aaf52f4a653d2ce6653407b6997ea075 100644 (file)
@@ -1,10 +1,12 @@
 {
     "name": "version-get",
-    "brief": "The version-get command returns on the control channel what the command line -v argument displays with in arguments the extended version, i.e., what the command line -V argument displays.",
+    "brief": "The version-get command returns on the control channel what the
+              command line -v argument displays with in arguments the extended
+              version, i.e., what the command line -V argument displays.",
     "description": "See <xref linkend=\"command-version-get\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"version-get\"
-}",
-}
\ No newline at end of file
+}"
+}
index 6a6bb62a9a0c219f9bc2a57ed868fbba6762101c..be78abba5f8baed2408206c8a55eed42a8d6723f 100644 (file)
@@ -12,6 +12,7 @@ config-test
 config-write
 dhcp-disable
 dhcp-enable
+ha-continue
 ha-heartbeat
 ha-scopes
 ha-sync
index a7af55c78a4c9942221cedee5f1cb1d59efe14dc..164483a63487a332c7475b37581b1ca718a5318c 100644 (file)
 
       <section xml:id="ha-server-states">
         <title>Server States</title>
-        <para>The DHCP server operating within an HA setup runs a state machine
+        <para id="command-ha-heartbeat">The DHCP server operating
+        within an HA setup runs a state machine
         and the state of the server can be retrieved by its peers using the
         <command>ha-heartbeat</command> command sent over the RESTful API. If
         the partner server doesn't respond to the <command>ha-heartbeat</command>
         HA hook library which are available for the administrator.
         </para>
 
-        <section xml:id="ha-sync-command">
+        <section xml:id="command-ha-sync">
           <title>ha-sync command</title>
           <para>The <command>ha-sync</command> is issued to instruct the
           server to synchronize its local lease database with the
           </para>
         </section> <!-- ha-sync-command -->
 
-        <section xml:id="ha-scopes-command">
+        <section xml:id="command-ha-scopes">
           <title>ha-scopes command</title>
           <para>This command allows for modifying the HA scopes that the
           server is serving. Consult <xref linkend="ha-load-balancing-config"/>
 <screen>
 {
     "command": "ha-scopes",
-    "service": [ "dhcp4 "],
+    "service": [ "dhcp4],
     "arguments": {
         "scopes": [ "HA_server1", "HA_server2" ]
     }
           </para>
         </section> <!-- ha-scopes-command -->
 
-        <section xml:id="ha-continue-command">
+        <section xml:id="command-ha-continue">
         <title>ha-continue command</title>
         <para>This command is used to resume the operation of the paused HA
         state machine as described in the <xref linkend="ha-pause-state-machine"/>.
index 557ada805ce3972bff6b6411149040a82330688e..fefa0249155079146f72ffea7a3ffd4259686fda 100644 (file)
 </screen>
         </para>
 
-        <section>
+        <section id="command-lease4-add">
           <title>lease4-add, lease6-add commands</title>
-        <para>
+        <para id="command-lease6-add">
           <command>lease4-add</command> and <command>lease6-add</command>
           commands allow for the creation of a new lease. Typically Kea creates
           a lease on its own, when it first sees a new device. However,
@@ -284,9 +284,10 @@ The commands can take a number of additional optional parameters:
         </para>
 
 
-        <section>
+        <section id="command-lease4-get">
           <title>lease4-get, lease6-get commands</title>
-          <para><command>lease4-get</command> or <command>lease6-get</command>
+          <para  id="command-lease6-get">
+            <command>lease4-get</command> or <command>lease6-get</command>
           can be used to query the lease database and retrieve existing
           leases. There are two types of parameters the
           <command>lease4-get</command> supports: (address) or (subnet-id,
@@ -401,9 +402,9 @@ An example result returned when the host was found:
 
         </section>
 
-        <section>
+        <section id="command-lease4-get-all">
           <title>lease4-get-all, lease6-get-all commands</title>
-          <para><command>lease4-get-all</command> and
+          <para id="command-lease6-get-all"><command>lease4-get-all</command> and
           <command>lease6-get-all</command> are used to retrieve all
           IPv4 or IPv6 leases or all leases for the specified set of
           subnets. All leases are returned when there are no arguments
@@ -610,9 +611,10 @@ An example result returned when the host was found:
 
         </section>
 
-        <section>
+        <section id="command-lease4-del">
           <title>lease4-del, lease6-del commands</title>
-          <para><command>leaseX-del</command> can be used to delete a lease from
+          <para id="command-lease6-del">
+            <command>leaseX-del</command> can be used to delete a lease from
           the lease database. There are two types of parameters this command
           supports, similar to leaseX-get commands: (address) for both v4 and
           v6, (subnet-id, identifier-type, identifier) for v4 and (subnet-id,
@@ -658,9 +660,9 @@ An example IPv4 lease deletion by "hw-address" looks as follows:
           </para>
         </section>
 
-        <section>
+        <section id="command-lease4-update">
           <title>lease4-update, lease6-update commands</title>
-          <para><command>lease4-update</command> and
+          <para id="command-lease6-update"><command>lease4-update</command> and
           <command>lease6-update</command> commands can be used to update
           existing leases. Since all lease database backends are indexed by IP
           addresses, it is not possible to update an address. All other fields
@@ -713,9 +715,9 @@ An example IPv4 lease deletion by "hw-address" looks as follows:
           </para>
         </section>
 
-        <section>
+        <section id="command-lease4-wipe">
           <title>lease4-wipe, lease6-wipe commands</title>
-          <para><command>lease4-wipe</command> and
+          <para id="command-lease6-wipe"><command>lease4-wipe</command> and
           <command>lease6-wipe</command> are designed to remove all
           leases associated with a given subnet. This administrative
           task is expected to be used when existing subnet is being
index 549f6f1b98d285a306e2df79cf2616a99f8ff714..d4604c47371eb86365bb305b05c2111f817f5a6f 100644 (file)
@@ -74,9 +74,9 @@
     will not retrieve statistics for it.
  </para>
 
-<section>
+<section id="command-stat-lease4-get">
   <title>stat-lease4-get, stat-lease6-get commands</title>
-    <para>
+    <para id="command-stat-lease6-get">
       The <command>stat-lease4-get</command> and <command>stat-lease6-get</command>
       commands fetch lease statistics for a range of known subnets.  The
       range of subnets is determined through the use of optional command
index 68c959f0045ba930b8e871ff9b676a41c0b58e14..7f739930d8fc1252cfcd4a2edb6f64ea1a517044 100644 (file)
@@ -1432,7 +1432,7 @@ Requirements </link> document.</para>
         </para>
         </section>
 
-        <section xml:id="cmd-reservation-add">
+        <section xml:id="command-reservation-add">
           <title>reservation-add command</title>
         <para>
           <command>reservation-add</command> allows for the insertion of a new host.  It
@@ -1766,7 +1766,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows
         </itemizedlist>
         </para>
 
-        <section>
+        <section id="command-subnet4-list">
           <title>subnet4-list command</title>
           <para>
             This command is used to list all currently configured subnets. The
@@ -1810,7 +1810,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows
           </para>
         </section>
 
-        <section>
+        <section id="command-subnet6-list">
           <title>subnet6-list command</title>
           <para>
             This command is used to list all currently configured subnets. The
@@ -1854,7 +1854,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows
           </para>
         </section>
 
-      <section>
+      <section id="command-subnet4-get">
         <title>subnet4-get command</title>
         <para>This command is used to retrieve detailed information about the
         specified subnet. This command usually follows the
@@ -1906,7 +1906,7 @@ or
         </para>
       </section>
 
-      <section>
+      <section id="command-subnet6-get">
         <title>subnet6-get command</title>
         <para>This command is used to retrieve detailed information about the
         specified subnet. This command usually follows the
@@ -1955,7 +1955,7 @@ If the subnet exists the response will be similar to this:
         </para>
       </section>
 
-      <section>
+      <section id="command-subnet4-add">
         <title>subnet4-add</title>
         <para>
           This command is used to create and add new subnet to the existing
@@ -2004,7 +2004,7 @@ If the subnet exists the response will be similar to this:
         </para>
       </section>
 
-      <section>
+      <section id="command-subnet6-add">
         <title>subnet6-add</title>
         <para>
           This command is used to create and add new subnet to the existing
@@ -2083,7 +2083,7 @@ If the subnet exists the response will be similar to this:
 
       </section>
 
-      <section>
+      <section id="command-subnet4-del">
         <title>subnet4-del command</title>
         <para>
           This command is used to remove a subnet from the server's configuration.
@@ -2143,7 +2143,7 @@ If the subnet exists the response will be similar to this:
         </para>
       </section>
 
-      <section>
+      <section id="command-subnet6-del">
         <title>subnet6-del command</title>
         <para>
           This command is used to remove a subnet from the server's configuration.
@@ -2201,9 +2201,9 @@ If the subnet exists the response will be similar to this:
         </para>
       </section>
 
-      <section>
+      <section id="command-network4-list">
         <title>network4-list, network6-list commands</title>
-        <para>
+        <para id="command-network6-list">
           These commands are used to retrieve full list of currently configured
           shared networks. The list contains only very basic information about
           each shared network. If more details are needed, please use
@@ -2232,9 +2232,9 @@ both the query and the response.
         </para>
     </section>
 
-    <section>
+    <section id="command-network4-get">
         <title>network4-get, network6-get commands</title>
-        <para>
+        <para id="command-network6-get">
           These commands are used to retrieve detailed information
           about shared networks, including subnets currently
           being part of a given network. Both commands take one
@@ -2291,9 +2291,9 @@ shared networks information.
         </para>
     </section>
 
-    <section>
+    <section id="command-network4-add">
         <title>network4-add, network6-add commands</title>
-        <para>
+        <para id="command-network6-add">
           These commands are used to add a new shared network. New
           network has to have unique name. This command requires one parameter
           <command>shared-networks</command>, which is a list and
@@ -2366,9 +2366,9 @@ the response. However, there are some parameters that are IPv4-only
 applies to subnets within the network.
         </para>
     </section>
-    <section>
+    <section id="command-network4-del">
         <title>network4-del, network6-del commands</title>
-        <para>
+        <para id="command-network6-del">
           These commands are used to delete existing shared
           networks. Both commands take exactly one parameter 'name' that
           specifies the name of the network to be removed. An example invocation
@@ -2424,9 +2424,9 @@ both the command and the response.
         <command>subnet6-del</command> commands.</para>
 
     </section>
-    <section>
+    <section id="command-network4-subnet-add">
         <title>network4-subnet-add, network6-subnet-add commands</title>
-        <para>
+        <para id="command-network6-subnet-add">
           These commands are used to add existing subnets to existing shared
           networks. There are several ways to add new shared network. System
           administrator can add the whole shared network at once, either by
@@ -2483,9 +2483,9 @@ both the command and the response.
           filled with default values, rather than inherited from
           global scope or from the shared network.</para></note>
     </section>
-    <section>
+    <section id="command-network4-subnet-del">
         <title>network4-subnet-del, network6-subnet-del commands</title>
-        <para>
+        <para id="command-network6-subnet-del">
           These commands are used to remove a subnet that is part of existing shared
           network and demote it to a plain, stand-alone subnet. If you want to
           remove a subnet completely, use <command>subnet4-del</command> or