<!-- autogenerated using cmd_docgen. Do not edit by hand! -->
<appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="api">
<title>API Reference</title>
- <para>Kea currently supports 119 commands:
+ <para>Kea currently supports 121 commands:
<command><link linkend="ref-build-report">build-report</link></command>
, <command><link linkend="ref-cache-clear">cache-clear</link></command>
, <command><link linkend="ref-cache-get">cache-get</link></command>
<!-- start of cache-get-by-id -->
<section xml:id="reference-cache-get-by-id">
<title>cache-get-by-id reference</title>
-<para xml:id="ref-cache-get-by-id"><command>cache-get-by-id</command> - Returns entries matching the given identifier from the host cache.</para>
+<para xml:id="ref-cache-get-by-id"><command>cache-get-by-id</command> - Returns entries matching the given identifier from the host cache.</para>
<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
"command": "cache-get-by-id",
"arguments": {
"hw-address": "01:02:03:04:05:06"
- }
-}</screen>
+ }</screen>
</para>
<para>Response syntax:
<screen>{
"result": 0
"text": "2 entries returned."
- "arguments": <list of cashed host>
+ "arguments": <list of host reservations>
}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
<!-- start of cache-size -->
<section xml:id="reference-cache-size">
<title>cache-size reference</title>
-<para xml:id="ref-cache-size"><command>cache-size</command> - This command returns the number of cached host reservations.</para>
+<para xml:id="ref-cache-size"><command>cache-size</command> - Returns number of entries of the host cache.</para>
<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
<para>Response syntax:
<screen>{
- "result": 0,
- "text": "123 entries.",
+ "result": 0
+ "text": "123 entries."
"arguments": { "size": 123 }
-}
-</screen>
+}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
<listitem><para>0 - success</para></listitem>
<!-- start of ha-sync -->
<section xml:id="reference-ha-sync">
<title>ha-sync reference</title>
-<para xml:id="ref-ha-sync"><command>ha-sync</command> - The command is issued to instruct the server running in HA mode to
-synchronize its local lease database with the selected peer.</para>
+<para xml:id="ref-ha-sync"><command>ha-sync</command> - The command is issued to instruct the server running in HA mode to
+ synchronize its local lease database with the selected peer.</para>
<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
<para>Response syntax:
<screen>{
"result": 0,
- "text": "DHCPv4 option set."
+ "text": "DHCPv4 option set.",
+ "arguments": {
+ "options": [
+ {
+ "code": <option code>,
+ "space": <option space>
+ }
+ ]
+ }
}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
<para>Response syntax:
<screen>{
"result": 0,
- "text": "DHCPv6 option set."
+ "text": "DHCPv6 option set.",
+ "arguments": {
+ "options": [
+ {
+ "code": <option code>,
+ "space": <option space>
+ }
+ ]
+ }
}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>