mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 14:05:33 +00:00
Code Issues Releases Wiki Activity

[313-return-a-list-of-all-reservations-by-subnet-id] Added a note about Cassandra / get page

Browse Source
This commit is contained in:
Francis Dupont
2019-01-24 09:45:41 +01:00
parent e48f94f7e9
commit 8d09cf6c55
2 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/guide/api.xml
View File

@@ -2581,7 +2581,7 @@ The reservation-get-all command may result in very large responses.</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>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
<para>Availability: 1.6.0 (<link linkend="commands-host_cmds-lib">host_cmds</link> hook)</para> <para>Availability: 1.6.0 (<link linkend="commands-host_cmds-lib">host_cmds</link> hook) at the exception of the Cassandra host backend</para>
<para>Description and examples: See <xref linkend="command-reservation-get-page"/></para> <para>Description and examples: See <xref linkend="command-reservation-get-page"/></para>

15
doc/guide/hooks.xml
View File

@@ -1663,7 +1663,7 @@ An example result returned when the query was malformed:<screen>
retrieved by using subnet-id value of zero (0). retrieved by using subnet-id value of zero (0).
</para> </para>
<para>For instance for retrieving host reservations for the <para>For instance for retrieving host reservations for the
subnet 1: subnet 1:
<screen> <screen>
{ {
@@ -1737,14 +1737,14 @@ An example result returned when the query was malformed:<screen>
the returned list is empty, count is 0 and result 3 is returned. the returned list is empty, count is 0 and result 3 is returned.
</para> </para>
<para>For instance for retrieving host reservations for the <para>For instance for retrieving host reservations for the
subnet 1 requesting the first page can be done by: subnet 1 requesting the first page can be done by:
<screen> <screen>
{ {
"command": "reservation-get-page", "command": "reservation-get-page",
"arguments": { "arguments": {
<userinput>"subnet-id": 1, <userinput>"subnet-id": 1,
"limit": 10</userinput> "limit": 10</userinput>
} }
} }
</screen> leaving source-index and from to their zero default values. </screen> leaving source-index and from to their zero default values.
@@ -1792,7 +1792,7 @@ An example result returned when the query was malformed:<screen>
<userinput>"subnet-id": 1, <userinput>"subnet-id": 1,
"source-index": 1, "source-index": 1,
"from": 1234567, "from": 1234567,
"limit": 10</userinput> "limit": 10</userinput>
} }
} }
</screen> responses after the last page look like: </screen> responses after the last page look like:
@@ -1818,6 +1818,11 @@ An example result returned when the query was malformed:<screen>
<para> <para>
For a reference, see <xref linkend="ref-reservation-get-page"/>. For a reference, see <xref linkend="ref-reservation-get-page"/>.
</para> </para>
<note><simpara>
Currently <command>reservation-get-page</command> is not
supported by the Cassandra host backend.
</simpara></note>
</section> </section>
<section xml:id="command-reservation-del"> <section xml:id="command-reservation-del">