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

[#810, !471] fixed sphinx docs

Browse Source
This commit is contained in:
Razvan Becheriu
2019-08-08 21:18:38 +03:00
committed by Tomek Mrugalski
parent 2703677d8a
commit 8ffc32fbb2
21 changed files with 39 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/sphinx/api/cache-get-by-id.json
View File

@@ -9,13 +9,14 @@
" \"arguments\": {",
" \"hw-address\": \"01:02:03:04:05:06\"",
" }"
"}"
],
"hook": "host_cache",
"name": "cache-get-by-id",
"resp-syntax": [
"{",
" \"result\": 0",
" \"text\": \"2 entries returned.\"",
" \"result\": 0,",
" \"text\": \"2 entries returned.\",",
" \"arguments\": <list of host reservations>",
"}"
],
@@ -23,4 +24,4 @@
"kea-dhcp4",
"kea-dhcp6"
]
}
}

6
doc/sphinx/api/cache-get.json
View File

@@ -7,8 +7,8 @@
"name": "cache-get",
"resp-syntax": [
"{",
" \"result\": 0",
" \"text\": \"123 entries returned.\"",
" \"result\": 0,",
" \"text\": \"123 entries returned.\",",
" \"arguments\": <list of host reservations>",
"}"
],
@@ -16,4 +16,4 @@
"kea-dhcp4",
"kea-dhcp6"
]
}
}

2
doc/sphinx/api/cache-insert.json
View File

@@ -49,4 +49,4 @@
"kea-dhcp4",
"kea-dhcp6"
]
}
}

6
doc/sphinx/api/cache-size.json
View File

@@ -7,8 +7,8 @@
"name": "cache-size",
"resp-syntax": [
"{",
" \"result\": 0",
" \"text\": \"123 entries.\"",
" \"result\": 0,",
" \"text\": \"123 entries.\",",
" \"arguments\": { \"size\": 123 }",
"}"
],
@@ -16,4 +16,4 @@
"kea-dhcp4",
"kea-dhcp6"
]
}
}

2
doc/sphinx/api/class-add.json
View File

@@ -34,7 +34,7 @@
"resp-syntax": [
"{",
" \"result\": 0,",
" \"text\": \"Class '<class-name>' added.\",",
" \"text\": \"Class '<class-name>' added.\"",
"}"
],
"support": [

2
doc/sphinx/api/class-list.json
View File

@@ -28,7 +28,7 @@
"resp-syntax": [
"{",
" \"result\": 0,",
" \"text\": \"<number of> classes found\",",
" \"text\": \"'<number of>' classes found\",",
" \"arguments\": {",
" \"client-classes\": [",
" {",

2
doc/sphinx/api/class-update.json
View File

@@ -36,7 +36,7 @@
"resp-syntax": [
"{",
" \"result\": 0,",
" \"text\": \"Class '<class-name>' updated.\",",
" \"text\": \"Class '<class-name>' updated.\"",
"}"
],
"support": [

2
doc/sphinx/api/config-get.json
View File

@@ -18,7 +18,7 @@
"{",
" \"result\": <integer>,",
" \"arguments\": {",
" <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>",
" <Dhcp4, Dhcp6, or Control-agent object>: <JSON configuration here> ",
" }",
"}"
],

10
doc/sphinx/api/config-set.json
View File

@@ -4,13 +4,13 @@
"The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
],
"cmd-comment": [
"where `<server>` is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
"where '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
],
"cmd-syntax": [
"{",
" \"command\": \"config-set\",",
" \"arguments\": {",
" \"<server>\": {",
" \"'<server>'\": {",
" }",
" }",
"}"
@@ -18,11 +18,11 @@
"description": "See <xref linkend=\"command-config-set\"/>",
"name": "config-set",
"resp-syntax": [
" {\"result\": 0, \"text\": \"Configuration successful.\" }",
"{\"result\": 0, \"text\": \"Configuration successful.\" }",
"",
" or",
"or",
"",
" {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
"{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
],
"support": [
"kea-dhcp4",

4
doc/sphinx/api/config-test.json
View File

@@ -10,7 +10,7 @@
"{",
" \"command\": \"config-test\",",
" \"arguments\": {",
" \"<server>\": {",
" \"'<server>'\": {",
" }",
" }",
"}"
@@ -20,7 +20,7 @@
"resp-syntax": [
"{ \"result\": 0, \"text\": \"Configuration seems sane...\" }",
"",
" or",
"or",
"",
"{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
],

2
doc/sphinx/api/ha-heartbeat.json
View File

@@ -6,7 +6,7 @@
],
"cmd-syntax": [
"{",
" \"command\": \"ha-heartbeat\",",
" \"command\": \"ha-heartbeat\"",
" }"
],
"description": "See <xref linkend=\"ha-server-states\"/>",

5
doc/sphinx/api/ha-scopes.json
View File

@@ -9,10 +9,11 @@
"cmd-syntax": [
"{",
" \"command\": \"ha-scopes\",",
" \"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],",
" \"service\": [ <service, typically 'dhcp4' or 'dhcp6'> ],",
" \"arguments\": {",
" \"scopes\": [ \"HA_server1\", \"HA_server2\" ]",
" }"
"}"
],
"description": "See <xref linkend=\"command-ha-scopes\"/>",
"hook": "high_availability",
@@ -21,4 +22,4 @@
"kea-dhcp4",
"kea-dhcp6"
]
}
}

2
doc/sphinx/api/ha-sync.json
View File

@@ -7,7 +7,7 @@
"cmd-syntax": [
"{",
" \"command\": \"ha-sync\",",
" \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],",
" \"service\": [ <service affected: 'dhcp4' or 'dhcp6'> ],",
" \"arguments\": {",
" \"server-name\": <name of the partner server>,",
" \"max-period\": <integer, in seconds>",

2
doc/sphinx/api/lease4-add.json
View File

@@ -21,4 +21,4 @@
"support": [
"kea-dhcp4"
]
}
}

4
doc/sphinx/api/lease4-get-all.json
View File

@@ -8,7 +8,7 @@
],
"cmd-syntax": [
"{",
" \"command\": \"lease4-get-all\"",
" \"command\": \"lease4-get-all\",",
" \"arguments\": \"subnets\"",
"}"
],
@@ -18,4 +18,4 @@
"support": [
"kea-dhcp4"
]
}
}

2
doc/sphinx/api/lease6-add.json
View File

@@ -22,7 +22,7 @@
"name": "lease6-add",
"resp-syntax": [
"{ \"result\": 0, \"text\": \"Lease added.\" }",
" or ",
"or",
"{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
],
"support": [

4
doc/sphinx/api/lease6-bulk-apply.json
View File

@@ -48,7 +48,7 @@
" {",
" {",
" \"result\": 0,",
" \"text\": IPv6 leases bulk apply completed.",
" \"text\": \"IPv6 leases bulk apply completed.\",",
" \"arguments\": {",
" \"failed-deleted-leases\": [",
" {",
@@ -62,7 +62,7 @@
" {",
" \"ip-address\": \"2001:db8:cafe::\",",
" \"type\": \"IA_PD\",",
" \"result\" <control result>,",
" \"result\": <control result>,",
" \"error-message\": <error message>",
" }",
" ]",

4
doc/sphinx/api/network4-get.json
View File

@@ -40,8 +40,8 @@
" // many other subnet specific details here",
" },",
" {",
" \"id\": 6,",
" \"subnet\": \"192.0.3.0/31\",",
" \"id\": 6,",
" // many other subnet specific details here",
" }",
" ],",
@@ -54,4 +54,4 @@
"support": [
"kea-dhcp4"
]
}
}

4
doc/sphinx/api/network6-get.json
View File

@@ -40,8 +40,8 @@
" // many other subnet specific details here",
" },",
" {",
" \"id\": 6,",
" \"subnet\": \"192.0.3.0/31\",",
" \"id\": 6,",
" // many other subnet specific details here",
" }",
" ],",
@@ -54,4 +54,4 @@
"support": [
"kea-dhcp6"
]
}
}

2
doc/sphinx/api/remote-global-parameter4-set.json
View File

@@ -8,7 +8,7 @@
],
"cmd-syntax": [
"{",
" \"command\": \"remote-global-parameter4-set\"",
" \"command\": \"remote-global-parameter4-set\",",
" \"arguments\": {",
" \"parameters\": {",
" <first parameter name>: <first parameter value>,",

2
doc/sphinx/api/remote-network4-del.json
View File

@@ -15,7 +15,7 @@
" \"name\": <shared network name>",
" }",
" ],",
" \"subnets-action\": \"keep\" | \"delete\",",
" \"subnets-action\": '<'keep' | 'delete'>',",
" \"remote\": {",
" <specification of the database to connect to>",
" }",