<!-- 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 122 commands:
+ <para>Kea currently supports 130 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>
, <command><link linkend="ref-remote-option6-global-get">remote-option6-global-get</link></command>
, <command><link linkend="ref-remote-option6-global-get-all">remote-option6-global-get-all</link></command>
, <command><link linkend="ref-remote-option6-global-set">remote-option6-global-set</link></command>
+, <command><link linkend="ref-remote-server4-del">remote-server4-del</link></command>
+, <command><link linkend="ref-remote-server4-get">remote-server4-get</link></command>
+, <command><link linkend="ref-remote-server4-get-all">remote-server4-get-all</link></command>
+, <command><link linkend="ref-remote-server4-set">remote-server4-set</link></command>
+, <command><link linkend="ref-remote-server6-del">remote-server6-del</link></command>
+, <command><link linkend="ref-remote-server6-get">remote-server6-get</link></command>
+, <command><link linkend="ref-remote-server6-get-all">remote-server6-get-all</link></command>
+, <command><link linkend="ref-remote-server6-set">remote-server6-set</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-id">remote-subnet4-del-by-id</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-prefix">remote-subnet4-del-by-prefix</link></command>
, <command><link linkend="ref-remote-subnet4-get-by-id">remote-subnet4-get-by-id</link></command>
, <command><link linkend="ref-remote-option4-global-get">remote-option4-global-get</link></command>
, <command><link linkend="ref-remote-option4-global-get-all">remote-option4-global-get-all</link></command>
, <command><link linkend="ref-remote-option4-global-set">remote-option4-global-set</link></command>
+, <command><link linkend="ref-remote-server4-del">remote-server4-del</link></command>
+, <command><link linkend="ref-remote-server4-get">remote-server4-get</link></command>
+, <command><link linkend="ref-remote-server4-get-all">remote-server4-get-all</link></command>
+, <command><link linkend="ref-remote-server4-set">remote-server4-set</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-id">remote-subnet4-del-by-id</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-prefix">remote-subnet4-del-by-prefix</link></command>
, <command><link linkend="ref-remote-subnet4-get-by-id">remote-subnet4-get-by-id</link></command>
, <command><link linkend="ref-remote-option6-global-get">remote-option6-global-get</link></command>
, <command><link linkend="ref-remote-option6-global-get-all">remote-option6-global-get-all</link></command>
, <command><link linkend="ref-remote-option6-global-set">remote-option6-global-set</link></command>
+, <command><link linkend="ref-remote-server6-del">remote-server6-del</link></command>
+, <command><link linkend="ref-remote-server6-get">remote-server6-get</link></command>
+, <command><link linkend="ref-remote-server6-get-all">remote-server6-get-all</link></command>
+, <command><link linkend="ref-remote-server6-set">remote-server6-set</link></command>
, <command><link linkend="ref-remote-subnet6-del-by-id">remote-subnet6-del-by-id</link></command>
, <command><link linkend="ref-remote-subnet6-del-by-prefix">remote-subnet6-del-by-prefix</link></command>
, <command><link linkend="ref-remote-subnet6-get-by-id">remote-subnet6-get-by-id</link></command>
, <command><link linkend="ref-remote-option6-global-get">remote-option6-global-get</link></command>
, <command><link linkend="ref-remote-option6-global-get-all">remote-option6-global-get-all</link></command>
, <command><link linkend="ref-remote-option6-global-set">remote-option6-global-set</link></command>
+, <command><link linkend="ref-remote-server4-del">remote-server4-del</link></command>
+, <command><link linkend="ref-remote-server4-get">remote-server4-get</link></command>
+, <command><link linkend="ref-remote-server4-get-all">remote-server4-get-all</link></command>
+, <command><link linkend="ref-remote-server4-set">remote-server4-set</link></command>
+, <command><link linkend="ref-remote-server6-del">remote-server6-del</link></command>
+, <command><link linkend="ref-remote-server6-get">remote-server6-get</link></command>
+, <command><link linkend="ref-remote-server6-get-all">remote-server6-get-all</link></command>
+, <command><link linkend="ref-remote-server6-set">remote-server6-set</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-id">remote-subnet4-del-by-id</link></command>
, <command><link linkend="ref-remote-subnet4-del-by-prefix">remote-subnet4-del-by-prefix</link></command>
, <command><link linkend="ref-remote-subnet4-get-by-id">remote-subnet4-get-by-id</link></command>
<para>Command syntax:
<screen>{
- "command": "remote-global-parameter4-get"
+ "command": "remote-global-parameter4-get",
"arguments": {
"parameters": [ <parameter name> ],
"remote": {
<para>Command syntax:
<screen>{
- "command": "remote-global-parameter4-get-all"
+ "command": "remote-global-parameter4-get-all",
"arguments": {
"remote": {
<specification of the database to connect to>
<para>Response syntax:
<screen>{
"result": 0,
- "text": "DHCPv4 global parameter(s) successfully set."
+ "text": "DHCPv4 global parameter(s) successfully set.",
+ "arguments": {
+ "parameters": {
+ <first parameter name>: <first parameter value>,
+ <second parameter name>: <second parameter value>
+ },
+ "count": 2
+ }
}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
<para>Response syntax:
<screen>{
"result": 0,
- "text": "DHCPv6 global parameter(s) successfully set."
+ "text": "DHCPv6 global parameter(s) successfully set.",
+ "arguments": {
+ "parameters": {
+ <first parameter name>: <first parameter value>,
+ <second parameter name>: <second parameter value>
+ },
+ "count": 2
+ }
}</screen>
Result is an integer representation of the status. Currently supported statuses are:
<itemizedlist>
</section>
<!-- end of remote-option6-global-set -->
+<!-- start of remote-server4-del -->
+<section xml:id="reference-remote-server4-del">
+<title>remote-server4-del reference</title>
+<para xml:id="ref-remote-server4-del"><command>remote-server4-del</command> - This command is used to delete information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server4-del"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server4-del",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server name>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command carries the list including exactly one map with the tag of the server to be deleted.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "1 DHCPv4 server(s) deleted."
+ "arguments": {
+ "count": 1
+ }
+}</screen>
+Result is an integer representation of the status. Currently supported statuses are:
+<itemizedlist>
+ <listitem><para>0 - success</para></listitem>
+ <listitem><para>1 - error</para></listitem>
+ <listitem><para>2 - unsupported</para></listitem>
+ <listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)</para></listitem>
+</itemizedlist>
+</para>
+
+</section>
+<!-- end of remote-server4-del -->
+
+<!-- start of remote-server4-get -->
+<section xml:id="reference-remote-server4-get">
+<title>remote-server4-get reference</title>
+<para xml:id="ref-remote-server4-get"><command>remote-server4-get</command> - This command is used to fetch the information about the DHCPv4 server, such as server tag and description.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server4-get"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server4-get",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command carries the list including exactly one map with the tag of the server to be fetched.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCP server <server tag> found.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ],
+ "count": 1
+ }
+}</screen>
+The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information.</para>
+
+</section>
+<!-- end of remote-server4-get -->
+
+<!-- start of remote-server4-get-all -->
+<section xml:id="reference-remote-server4-get-all">
+<title>remote-server4-get-all reference</title>
+<para xml:id="ref-remote-server4-get-all"><command>remote-server4-get-all</command> - This command is used to fetch information about all DHCPv4 servers specified by the user.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server4-get-all"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server4-get-all",
+ "arguments": {
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command contains no arguments besides the optional <command>remote</command>.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCPv4 servers found.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <first server tag>
+ "description": <first server description>
+ },
+ {
+ "server-tag": <second server tag>
+ "description": <second server description>
+ }
+ ],
+ "count": 2
+ }
+}</screen>
+The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server4-get-all</command>. Only the user defined servers are returned.</para>
+
+</section>
+<!-- end of remote-server4-get-all -->
+
+<!-- start of remote-server4-set -->
+<section xml:id="reference-remote-server4-set">
+<title>remote-server4-set reference</title>
+<para xml:id="ref-remote-server4-set"><command>remote-server4-set</command> - This command is used to create or replace information about the DHCPv4 server in the database.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server4-set"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server4-set",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCPv4 server successfully set.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ]
+ }
+}</screen>
+Result is an integer representation of the status. Currently supported statuses are:
+<itemizedlist>
+ <listitem><para>0 - success</para></listitem>
+ <listitem><para>1 - error</para></listitem>
+ <listitem><para>2 - unsupported</para></listitem>
+ <listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)</para></listitem>
+</itemizedlist>
+</para>
+
+</section>
+<!-- end of remote-server4-set -->
+
+<!-- start of remote-server6-del -->
+<section xml:id="reference-remote-server6-del">
+<title>remote-server6-del reference</title>
+<para xml:id="ref-remote-server6-del"><command>remote-server6-del</command> - This command is used to delete information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. The shareable configuration (e.g. subnets, shared networks) is not deleted as it may be used by other servers.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server6-del"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server6-del",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server name>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command carries the list including exactly one map with the tag of the server to be deleted.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "1 DHCPv6 server(s) deleted."
+ "arguments": {
+ "count": 1
+ }
+}</screen>
+Result is an integer representation of the status. Currently supported statuses are:
+<itemizedlist>
+ <listitem><para>0 - success</para></listitem>
+ <listitem><para>1 - error</para></listitem>
+ <listitem><para>2 - unsupported</para></listitem>
+ <listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)</para></listitem>
+</itemizedlist>
+</para>
+
+</section>
+<!-- end of remote-server6-del -->
+
+<!-- start of remote-server6-get -->
+<section xml:id="reference-remote-server6-get">
+<title>remote-server6-get reference</title>
+<para xml:id="ref-remote-server6-get"><command>remote-server6-get</command> - This command is used to fetch the information about the DHCPv6 server, such as server tag and description.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server6-get"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server6-get",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command carries the list including exactly one map with the tag of the server to be fetched.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCP server <server tag> found.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ],
+ "count": 1
+ }
+}</screen>
+The server tag is the unique identifier of the server, used to associate the configuration elements in the database with the particular server instance. The returned server description is specified by the user when setting the server information.</para>
+
+</section>
+<!-- end of remote-server6-get -->
+
+<!-- start of remote-server6-get-all -->
+<section xml:id="reference-remote-server6-get-all">
+<title>remote-server6-get-all reference</title>
+<para xml:id="ref-remote-server6-get-all"><command>remote-server6-get-all</command> - This command is used to fetch information about all DHCPv6 servers specified by the user.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server6-get-all"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server6-get-all",
+ "arguments": {
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+This command contains no arguments besides the optional <command>remote</command>.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCPv6 servers found.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <first server tag>
+ "description": <first server description>
+ },
+ {
+ "server-tag": <second server tag>
+ "description": <second server description>
+ }
+ ],
+ "count": 2
+ }
+}</screen>
+The returned response contain a list of maps. Each map contains a server tag uniquely identifying a server and the user defined description of the server. The Kea Configuration Backend uses the keyword <command>all</command> to associate parts of the configuration with all servers. Internally, it creates the logical server <command>all</command> for this purpose. However, this logical server is not returned as a result of the <command>remote-server6-get-all</command>. Only the user defined servers are returned.</para>
+
+</section>
+<!-- end of remote-server6-get-all -->
+
+<!-- start of remote-server6-set -->
+<section xml:id="reference-remote-server6-set">
+<title>remote-server6-set reference</title>
+<para xml:id="ref-remote-server6-set"><command>remote-server6-set</command> - This command is used to create or replace information about the DHCPv6 server in the database.</para>
+
+<para>Supported by: <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
+
+<para>Availability: 1.6.0 (<link linkend="commands-cb_cmds-lib">cb_cmds</link> hook)</para>
+
+<para>Description and examples: See <xref linkend="command-remote-server6-set"/></para>
+
+<para>Command syntax:
+ <screen>{
+ "command": "remote-server6-set",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ],
+ "remote": {
+ <specification of the database to connect to>
+ }
+ }
+}</screen>
+The provided list must contain exactly one server specification. The <command>server-tag</command> must be unique accross all servers within the configuration database. The <command>description</command> is the arbitrary text describing the server, its location within the network etc.</para>
+
+<para>Response syntax:
+ <screen>{
+ "result": 0,
+ "text": "DHCPv6 server successfully set.",
+ "arguments": {
+ "servers": [
+ {
+ "server-tag": <server tag>,
+ "description": <server description>
+ }
+ ]
+ }
+}</screen>
+Result is an integer representation of the status. Currently supported statuses are:
+<itemizedlist>
+ <listitem><para>0 - success</para></listitem>
+ <listitem><para>1 - error</para></listitem>
+ <listitem><para>2 - unsupported</para></listitem>
+ <listitem><para>3 - empty (command was completed successfully, but no data was affected or returned)</para></listitem>
+</itemizedlist>
+</para>
+
+</section>
+<!-- end of remote-server6-set -->
+
<!-- start of remote-subnet4-del-by-id -->
<section xml:id="reference-remote-subnet4-del-by-id">
<title>remote-subnet4-del-by-id reference</title>