mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-02 15:05:16 +00:00
Code Issues Releases Wiki Activity

[313-return-a-list-of-all-reservations-by-subnet-id] Updated doc for the new next map stuff

Browse Source
This commit is contained in:
Francis Dupont
2019-01-27 17:38:12 +01:00
parent a212c70c6f
commit c8c519a533
2 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api/reservation-get-page.json
View File

@@ -14,5 +14,5 @@
\"from\": <integer> \"from\": <integer>
} }
}", }",
"cmd-comment": "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0." "cmd-comment": "the subnet id and the page size limit are mandatory. The source index and from host id are optional and default to 0. Values to use to next the next page are returned in responses in a next map."
} }

36
doc/guide/hooks.xml
View File

@@ -1732,22 +1732,23 @@ An example result returned when the query was malformed:<screen>
</para> </para>
<para> <para>
The usage of next and source-index parameters requires The usage of from and source-index parameters requires
additional explanation. For the first call those additional explanation. For the first call those
parameters should not be specified (or specified as parameters should not be specified (or specified as
zeros). For any follow up calls they should be set to the zeros). For any follow up calls they should be set to the
values returned in previous calls. The subsequent calls values returned in previous calls in a next map holding
should be issued until all reservations are returned. The from and source-index values. The subsequent calls should
end is reached once the returned list is empty, count is 0 be issued until all reservations are returned. The end is
and result status 3 (empty) is returned. reached once the returned list is empty, count is 0, no
next map is present and result status 3 (empty) is returned.
</para> </para>
<note> <note>
<simpara>The next and source-index parameters are <simpara>The from and source-index parameters are
reflecting internal state of the search. There is no need reflecting internal state of the search. There is no need
to understand what they represent, it's simply a value to understand what they represent, it's simply a value
that is supposed to be copied from one response to the that is supposed to be copied from one response to the
next query. However, if you are curious, next field next query. However, if you are curious, from field
represents a 64 bits representation of host identifier represents a 64 bits representation of host identifier
used by a host backend. The source-index represents used by a host backend. The source-index represents
internal representation of multiple host backends: 0 is internal representation of multiple host backends: 0 is
@@ -1769,7 +1770,7 @@ An example result returned when the query was malformed:<screen>
"limit": 10</userinput> "limit": 10</userinput>
} }
} }
</screen> Since this is the first call, source-index and next should </screen> Since this is the first call, source-index and from should
not be specified. They will default to their zero default values. not be specified. They will default to their zero default values.
</para> </para>
@@ -1801,35 +1802,36 @@ not be specified. They will default to their zero default values.
"server-hostname": "server-hostname.example.org" "server-hostname": "server-hostname.example.org"
} }
], ],
"next": 1234567, "next": {
"source-index": 0 "from": 1234567,
"source-index": 1
}
}, },
"result": 0, "result": 0,
"text": "72 IPv4 host(s) found." "text": "72 IPv4 host(s) found."
} }
</screen> Note that next and source-index fields were specified in the </screen> Note that from and source-index fields were specified in the
response. Those two must be copied to the next command, so Kea response in the next map. Those two must be copied to the next
continues from the place where the last command finished. To get the command, so Kea continues from the place where the last command
next page the following command can be sent: finished. To get the next page the following command can be sent:
<screen> <screen>
{ {
"command": "reservation-get-page", "command": "reservation-get-page",
"arguments": { "arguments": {
<userinput>"subnet-id": 1, <userinput>"subnet-id": 1,
"source-index": 1, "source-index": 1,
"next": 1234567, "from": 1234567,
"limit": 10</userinput> "limit": 10</userinput>
} }
} }
</screen>. The response will contain a list of hosts with updated </screen>. The response will contain a list of hosts with updated
source-index and next fields. Continue calling the command until you source-index and from fields. Continue calling the command until you
get the last page. Its response will look like this: get the last page. Its response will look like this:
<screen> <screen>
{ {
"arguments": { "arguments": {
"count": 0, "count": 0,
"hosts": [ ], "hosts": [ ],
"source-index": 2,
}, },
"result": 3, "result": 3,
"0 IPv4 host(s) found." "0 IPv4 host(s) found."