@@ -872,19 +839,18 @@ Result is an integer representation of the status. Currently supported statuses
<para>Description and examples: See <xreflinkend="command-ha-heartbeat"/></para>
<para>Command syntax:
<screen>tbd</screen>
<screen>{
"command": "ha-heartbeat",
}</screen>
</para>
<para>Response syntax:
<screen>tbd</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>
<screen>{
"result": <integer>,
"text": <string>
}
</screen>
The response to this command is different from the typical command response. The response will include server state (see <xreflinkend="ha-server-states"/> plus the current clock value.</para>
</section>
<!-- end of ha-heartbeat -->
...
...
@@ -892,8 +858,7 @@ Result is an integer representation of the status. Currently supported statuses
<!-- start of ha-scopes -->
<sectionxml:id="reference-ha-scopes">
<title>ha-scopes reference</title>
<paraxml:id="ref-ha-scopes"><command>ha-scopes</command> - This command allows for modifying the High Availability (HA) scopes
that the server is serving.a sentence or two explaining what this command does</para>
<paraxml:id="ref-ha-scopes"><command>ha-scopes</command> - This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode.</para>
@@ -990,7 +953,7 @@ Result is an integer representation of the status. Currently supported statuses
"hw-address": "1a:1b:1c:1d:1e:1f"
}
}</screen>
</para>
Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported.</para>
<para>Response syntax:
<screen>{
...
...
@@ -1015,7 +978,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>lease4-del reference</title>
<paraxml:id="ref-lease4-del"><command>lease4-del</command> - lease4-del can be used to delete a lease from the lease database.</para>
@@ -1028,7 +991,7 @@ Result is an integer representation of the status. Currently supported statuses
"ip-address": "192.0.2.202"
}
}</screen>
leaseX-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease in this case) has not been found.</para>
Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are "hw-address" and "client-id".</para>
<para>Response syntax:
<screen>{
...
...
@@ -1053,7 +1016,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>lease4-get reference</title>
<paraxml:id="ref-lease4-get"><command>lease4-get</command> - lease4-get can be used to query the lease database and retrieve existing leases.</para>
@@ -1095,7 +1058,7 @@ lease4-get returns a result that indicates a result of the operation and lease d
<title>lease4-get-all reference</title>
<paraxml:id="ref-lease4-get-all"><command>lease4-get-all</command> - lease4-get-all is used to retrieve all IPv4 leases or all leases for the specified set of subnets.</para>
@@ -1325,7 +1289,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>lease6-get-all reference</title>
<paraxml:id="ref-lease6-get-all"><command>lease6-get-all</command> - lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets.</para>
@@ -1471,7 +1435,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>leases-reclaim reference</title>
<paraxml:id="ref-leases-reclaim"><command>leases-reclaim</command> - The leases-reclaim command instructs the server to reclaim all expired leases immediately.</para>
@@ -1690,7 +1654,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network4-get reference</title>
<paraxml:id="ref-network4-get"><command>network4-get</command> - The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.</para>
@@ -1748,7 +1712,7 @@ Note that the actual response contains many additional fields that are omitted h
<title>network4-list reference</title>
<paraxml:id="ref-network4-list"><command>network4-list</command> - The network4-list command is used to retrieve full list of currently configured shared networks.</para>
@@ -1788,7 +1752,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network4-subnet-add reference</title>
<paraxml:id="ref-network4-subnet-add"><command>network4-subnet-add</command> - The network4-subnet-add command is used to add existing subnets to existing shared networks.</para>
@@ -1826,7 +1790,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network4-subnet-del reference</title>
<paraxml:id="ref-network4-subnet-del"><command>network4-subnet-del</command> - The network4-subnet-del command is used to remove a subnet that is part of an existing shared network and demote it to a plain, stand-alone subnet.</para>
@@ -1970,7 +1934,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network6-get reference</title>
<paraxml:id="ref-network6-get"><command>network6-get</command> - The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network.</para>
@@ -2028,7 +1992,7 @@ Note that the actual response contains many additional fields that are omitted h
<title>network6-list reference</title>
<paraxml:id="ref-network6-list"><command>network6-list</command> - The network6-list command is used to retrieve full list of currently configured shared networks.</para>
@@ -2068,7 +2032,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network6-subnet-add reference</title>
<paraxml:id="ref-network6-subnet-add"><command>network6-subnet-add</command> - The network6-subnet-add command is used to add existing subnets to existing shared networks.</para>
@@ -2106,7 +2070,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>network6-subnet-del reference</title>
<paraxml:id="ref-network6-subnet-del"><command>network6-subnet-del</command> - The network6-subnet-del command is used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet.</para>
@@ -2653,7 +2617,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet4-add reference</title>
<paraxml:id="ref-subnet4-add"><command>subnet4-add</command> - This command is used to create and add a new subnet to the existing server configuration.</para>
@@ -2702,7 +2666,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet4-del reference</title>
<paraxml:id="ref-subnet4-del"><command>subnet4-del</command> - 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.</para>
@@ -2747,7 +2711,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet4-get reference</title>
<paraxml:id="ref-subnet4-get"><command>subnet4-get</command> - This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes.</para>
@@ -2796,7 +2760,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet4-list reference</title>
<paraxml:id="ref-subnet4-list"><command>subnet4-list</command> - This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet.</para>
@@ -2834,7 +2798,7 @@ If no IPv4 subnets are found, an error code is returned along with the error des
<title>subnet6-add reference</title>
<paraxml:id="ref-subnet6-add"><command>subnet6-add</command> - This command is used to create and add new subnet to the existing server configuration. This operation has no impact on other subnets.</para>
@@ -2883,7 +2847,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet6-del reference</title>
<paraxml:id="ref-subnet6-del"><command>subnet6-del</command> - 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.</para>
@@ -2926,7 +2890,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet6-get reference</title>
<paraxml:id="ref-subnet6-get"><command>subnet6-get</command> - This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet6-list, which is used to discover available subnets with their respective subnet identifiers and prefixes.</para>
@@ -2975,7 +2939,7 @@ Result is an integer representation of the status. Currently supported statuses
<title>subnet6-list reference</title>
<paraxml:id="ref-subnet6-list"><command>subnet6-list</command> - This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet.</para>
