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

[#810, !471] fixed sphinx docs

Browse Source
This commit is contained in:
Razvan Becheriu 2019-08-09 02:09:41 +03:00 committed by Tomek Mrugalski
parent 295f81cb1f
commit 71ec70431f
20 changed files with 67 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -45,28 +45,26 @@
"The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, inserting it into the database, etc., the result is set to 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned." "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, inserting it into the database, etc., the result is set to 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned."
], ],
"resp-syntax": [ "resp-syntax": [
" {", "{",
" {", " \"result\": 0,",
" \"result\": 0,", " \"text\": \"IPv6 leases bulk apply completed.\",",
" \"text\": \"IPv6 leases bulk apply completed.\",", " \"arguments\": {",
" \"arguments\": {", " \"failed-deleted-leases\": [",
" \"failed-deleted-leases\": [", " {",
" {", " \"ip-address\": \"2001:db8:abcd::\",",
" \"ip-address\": \"2001:db8:abcd::\",", " \"type\": \"IA_PD\",",
" \"type\": \"IA_PD\",", " \"result\": <control result>,",
" \"result\": <control result>,", " \"error-message\": <error message>",
" \"error-message\": <error message>", " }",
" }", " ],",
" ],", " \"failed-leases\": [",
" \"failed-leases\": [", " {",
" {", " \"ip-address\": \"2001:db8:cafe::\",",
" \"ip-address\": \"2001:db8:cafe::\",", " \"type\": \"IA_PD\",",
" \"type\": \"IA_PD\",", " \"result\": <control result>,",
" \"result\": <control result>,", " \"error-message\": <error message>",
" \"error-message\": <error message>", " }",
" }", " ]",
" ]",
" }",
" }", " }",
"}" "}"
], ],

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

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

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

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

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

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

2
doc/sphinx/api/remote-network6-get.json
View File

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

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

@ -12,7 +12,7 @@
" \"arguments\": {", " \"arguments\": {",
" \"option-defs\": [ {", " \"option-defs\": [ {",
" \"code\": <option code>,", " \"code\": <option code>,",
" \"space\": <option space", " \"space\": <option space>",
" } ],", " } ],",
" \"remote\": {", " \"remote\": {",
" <specification of the database to connect to>", " <specification of the database to connect to>",

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

@ -12,7 +12,7 @@
" \"arguments\": {", " \"arguments\": {",
" \"option-defs\": [ {", " \"option-defs\": [ {",
" \"code\": <option code>,", " \"code\": <option code>,",
" \"space\": <option space", " \"space\": <option space>",
" } ],", " } ],",
" \"remote\": {", " \"remote\": {",
" <specification of the database to connect to>", " <specification of the database to connect to>",

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

@ -13,7 +13,7 @@
" \"options\": [", " \"options\": [",
" {", " {",
" \"code\": <option code>,", " \"code\": <option code>,",
" \"space\": <option space>,", " \"space\": <option space>",
" }", " }",
" ],", " ],",
" \"remote\": {", " \"remote\": {",

1
doc/sphinx/api/remote-option4-global-get.json
View File

@ -20,6 +20,7 @@
" <specification of the database to connect to>", " <specification of the database to connect to>",
" },", " },",
" \"server-tags\": [ <single server tag as string> ]", " \"server-tags\": [ <single server tag as string> ]",
" }",
"}" "}"
], ],
"hook": "cb_cmds", "hook": "cb_cmds",

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

@ -13,7 +13,7 @@
" \"options\": [", " \"options\": [",
" {", " {",
" \"code\": <option code>,", " \"code\": <option code>,",
" \"space\": <option space>,", " \"space\": <option space>",
" }", " }",
" ],", " ],",
" \"remote\": {", " \"remote\": {",

1
doc/sphinx/api/remote-option6-global-get.json
View File

@ -20,6 +20,7 @@
" <specification of the database to connect to>", " <specification of the database to connect to>",
" },", " },",
" \"server-tags\": [ <single server tag as string> ]", " \"server-tags\": [ <single server tag as string> ]",
" }"
"}" "}"
], ],
"hook": "cb_cmds", "hook": "cb_cmds",

4
doc/sphinx/api/remote-server4-get.json
View File

@ -29,7 +29,7 @@
"resp-syntax": [ "resp-syntax": [
"{", "{",
" \"result\": 0,", " \"result\": 0,",
" \"text\": \"DHCP server <server tag> found.\",", " \"text\": \"DHCP server 'server tag' found.\",",
" \"arguments\": {", " \"arguments\": {",
" \"servers\": [", " \"servers\": [",
" {", " {",
@ -44,4 +44,4 @@
"support": [ "support": [
"kea-dhcp4" "kea-dhcp4"
] ]
} }

4
doc/sphinx/api/remote-server6-get.json
View File

@ -29,7 +29,7 @@
"resp-syntax": [ "resp-syntax": [
"{", "{",
" \"result\": 0,", " \"result\": 0,",
" \"text\": \"DHCP server <server tag> found.\",", " \"text\": \"DHCP server 'server tag' found.\",",
" \"arguments\": {", " \"arguments\": {",
" \"servers\": [", " \"servers\": [",
" {", " {",
@ -44,4 +44,4 @@
"support": [ "support": [
"kea-dhcp6" "kea-dhcp6"
] ]
} }

4
doc/sphinx/api/reservation-add.json
View File

@ -17,7 +17,7 @@
" \"arguments\": {", " \"arguments\": {",
" \"reservation\": {", " \"reservation\": {",
" \"boot-file-name\": <string>,", " \"boot-file-name\": <string>,",
" \"comment\": <string>", " \"comment\": <string>,",
" \"client-id\": <string>,", " \"client-id\": <string>,",
" \"circuit-id\": <string>,", " \"circuit-id\": <string>,",
" \"duid\": <string>,", " \"duid\": <string>,",
@ -32,7 +32,7 @@
" \"reservation-client-classes\": [ <comma separated strings> ],", " \"reservation-client-classes\": [ <comma separated strings> ],",
" \"server-hostname\": <string>,", " \"server-hostname\": <string>,",
" \"subnet-id\": <integer>,", " \"subnet-id\": <integer>,",
" \"user-context\": <any valid JSON>,", " \"user-context\": <any valid JSON>",
" }", " }",
" }", " }",
"}" "}"

4
doc/sphinx/api/reservation-del.json
View File

@ -12,7 +12,7 @@
" \"arguments\": {", " \"arguments\": {",
" \"subnet-id\": <integer>,", " \"subnet-id\": <integer>,",
" \"ip-address\": <string>,", " \"ip-address\": <string>,",
" \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,", " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
" \"identifier\": <string>", " \"identifier\": <string>",
" }", " }",
"}" "}"
@ -23,4 +23,4 @@
"kea-dhcp4", "kea-dhcp4",
"kea-dhcp6" "kea-dhcp6"
] ]
} }

3
doc/sphinx/api/reservation-get-all.json
View File

@ -8,6 +8,7 @@
" \"command\": \"reservation-get-all\",", " \"command\": \"reservation-get-all\",",
" \"arguments\": {", " \"arguments\": {",
" \"subnet-id\": <integer>", " \"subnet-id\": <integer>",
" }"
"}" "}"
], ],
"hook": "host_cmds", "hook": "host_cmds",
@ -19,4 +20,4 @@
"kea-dhcp4", "kea-dhcp4",
"kea-dhcp6" "kea-dhcp6"
] ]
} }

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

@ -11,8 +11,8 @@
" \"command\": \"reservation-get\",", " \"command\": \"reservation-get\",",
" \"arguments\": {", " \"arguments\": {",
" \"subnet-id\": <integer>,", " \"subnet-id\": <integer>,",
" \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,", " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
" \"identifier\": <string>;", " \"identifier\": <string>",
" }", " }",
"}" "}"
], ],

2
doc/sphinx/api/stat-lease6-get.json
View File

@ -23,7 +23,7 @@
" \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ],", " \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ],",
" \"rows\": [", " \"rows\": [",
" [ 10, 4096, 2400, 3, 0, 0],", " [ 10, 4096, 2400, 3, 0, 0],",
" [ 20, 0, 0, 0, 1048, 233 ]", " [ 20, 0, 0, 0, 1048, 233 ],",
" [ 30, 256, 60, 0, 1048, 15 ]", " [ 30, 256, 60, 0, 1048, 15 ]",
" ],", " ],",
" \"timestamp\": \"2018-05-04 15:03:37.000000\"", " \"timestamp\": \"2018-05-04 15:03:37.000000\"",

23
doc/sphinx/api/subnet4-list.json
View File

@ -19,19 +19,20 @@
" \"result\": 0,", " \"result\": 0,",
" \"text\": \"2 IPv4 subnets found\",", " \"text\": \"2 IPv4 subnets found\",",
" \"arguments\": {", " \"arguments\": {",
" \"subnets\": [", " \"subnets\": [",
" {", " {",
" \"id\": 10,", " \"id\": 10,",
" \"subnet\": \"10.0.0.0/8\"", " \"subnet\": \"10.0.0.0/8\"",
" },", " },",
" {", " {",
" \"id\": 100,", " \"id\": 100,",
" \"subnet\": \"192.0.2.0/24\"", " \"subnet\": \"192.0.2.0/24\"",
" }", " }",
" ]", " ]",
" }",
"}" "}"
], ],
"support": [ "support": [
"kea-dhcp4" "kea-dhcp4"
] ]
} }

23
doc/sphinx/api/subnet6-list.json
View File

@ -19,19 +19,20 @@
" \"result\": 0,", " \"result\": 0,",
" \"text\": \"2 IPv6 subnets found\",", " \"text\": \"2 IPv6 subnets found\",",
" \"arguments\": {", " \"arguments\": {",
" \"subnets\": [", " \"subnets\": [",
" {", " {",
" \"id\": 11,", " \"id\": 11,",
" \"subnet\": \"2001:db8:1::/64\"", " \"subnet\": \"2001:db8:1::/64\"",
" },", " },",
" {", " {",
" \"id\": 233,", " \"id\": 233,",
" \"subnet\": \"3000::/16\"", " \"subnet\": \"3000::/16\"",
" }", " }",
" ]", " ]",
" }",
"}" "}"
], ],
"support": [ "support": [
"kea-dhcp6" "kea-dhcp6"
] ]
} }