summaryrefslogtreecommitdiffstats
path: root/src/share/api/config-backend-pull.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/share/api/config-backend-pull.json')
-rw-r--r--src/share/api/config-backend-pull.json31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/share/api/config-backend-pull.json b/src/share/api/config-backend-pull.json
new file mode 100644
index 0000000..db13b16
--- /dev/null
+++ b/src/share/api/config-backend-pull.json
@@ -0,0 +1,31 @@
+{
+ "access": "write",
+ "avail": "1.7.1",
+ "brief": [
+ "This command forces an immediate update of the server using Config Backends.",
+ "This command does not take any parameters."
+ ],
+ "cmd-syntax": [
+ "{",
+ " \"command\": \"config-backend-pull\"",
+ "}"
+ ],
+ "description": "See <xref linkend=\"command-config-backend-pull\"/>",
+ "name": "config-backend-pull",
+ "resp-comment": [
+ "When no Config Backends are configured this command returns empty (3); ",
+ "If an error occurs error (1) is returned with the error details; ",
+ "otherwise success (0) is returned."
+ ],
+ "resp-syntax": [
+ "{",
+ " \"result\": 0,",
+ " \"text\": \"On demand configuration update successful.\"",
+ "}"
+ ],
+
+ "support": [
+ "kea-dhcp4",
+ "kea-dhcp6"
+ ]
+}