Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Kea
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Incidents
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Pavel Zhukov
Kea
Commits
bf55ad45
Commit
bf55ad45
authored
Aug 28, 2018
by
Tomek Mrugalski
🛰
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[#10, !3] cache-clear,get documented
parent
2c7b4cfd
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
27 additions
and
7 deletions
+27
-7
doc/api/cache-clear.json
doc/api/cache-clear.json
+7
-0
doc/api/cache-get.json
doc/api/cache-get.json
+13
-0
doc/guide/hooks-host-cache.xml
doc/guide/hooks-host-cache.xml
+7
-7
No files found.
doc/api/cache-clear.json
0 → 100644
View file @
bf55ad45
{
"name"
:
"cache-clear"
,
"brief"
:
"This command removes all cached host reservations."
,
"support"
:
[
"kea-dhcp4"
,
"kea-dhcp6"
],
"hook"
:
"host_cache"
,
"avail"
:
"1.4.0"
}
doc/api/cache-get.json
0 → 100644
View file @
bf55ad45
{
"name"
:
"cache-get"
,
"brief"
:
"Returns full content of the host cache."
,
"support"
:
[
"kea-dhcp4"
,
"kea-dhcp6"
],
"avail"
:
"1.4.0"
,
"hook"
:
"host_cache"
,
"resp-syntax"
:
"{
\"
result
\"
: 0
\"
text
\"
:
\"
123 entries returned.
\"
\"
arguments
\"
: <list of host reservations>
}"
}
doc/guide/hooks-host-cache.xml
View file @
bf55ad45
...
...
@@ -60,7 +60,7 @@
sections describe the commands available.
</para>
<section
id=
"c
ache-flush-cmd
"
>
<section
id=
"c
ommand-cache-flush
"
>
<title>
cache-flush command
</title>
<para>
This command allows removal of specified number of cached
host entries. It takes one parameter which defines the number of
...
...
@@ -76,7 +76,7 @@ in FIFO order, so always the oldest entries are removed.
</para>
</section>
<section
id=
"c
ache-clear-cmd
"
>
<section
id=
"c
ommand-cache-clear
"
>
<title>
cache-clear command
</title>
<para>
This command allows removal of all cached
host entries. An example usage looks as follows:
...
...
@@ -89,7 +89,7 @@ certain number of cached hosts, please use cache-flush instead.
</para>
</section>
<section
id=
"c
ache-write-cmd
"
>
<section
id=
"c
ommand-cache-write
"
>
<title>
cache-write command
</title>
<para>
In general case the cache content is considered a run-time
state and the server can be shutdown or restarted as usual. The
...
...
@@ -121,7 +121,7 @@ any other tool that is able to understand JSON format.
</section>
<section
id=
"c
ache-load-cm
d"
>
<section
id=
"c
ommand-cache-loa
d"
>
<title>
cache-load command
</title>
<para>
See previous section for a discussion regarding use cases
where it may be useful to write and load contents of the host
...
...
@@ -142,7 +142,7 @@ any other tool that is able to understand JSON format.
</section>
<section
id=
"c
ache-get-cmd
"
>
<section
id=
"c
ommand-cache-get
"
>
<title>
cache-get command
</title>
<para>
This command is similar to cache-write, but instead of
writing the cache contents to disk, it returns the contents to
...
...
@@ -159,7 +159,7 @@ may be large.
</para>
</section>
<section
id=
"c
ache-insert-cmd
"
>
<section
id=
"c
ommand-cache-insert
"
>
<title>
cache-insert command
</title>
<para>
This command may be used to manually insert a host into the
cache. There are very few use cases when this command could be
...
...
@@ -220,7 +220,7 @@ may be large.
</para>
</section>
<section
id=
"c
ache-remove-cmd
"
>
<section
id=
"c
ommand-cache-remove
"
>
<title>
cache-remove command
</title>
<para>
Sometimes it is useful to remove a single entry from the
host cache. A good use case is a situation where the device is up,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment