From: Tomek Mrugalski Date: Fri, 5 Oct 2018 16:26:49 +0000 (+0200) Subject: [#10,!3] Various small corrections in the json files X-Git-Tag: 176-update-to-sysrepo-0-7-6-release_base~84 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=191194ff784fff31275d605a8842cddc1e2ad711;p=thirdparty%2Fkea.git [#10,!3] Various small corrections in the json files --- diff --git a/doc/api/config-test.json b/doc/api/config-test.json index 079c6d942e..9f5daac5be 100644 --- a/doc/api/config-test.json +++ b/doc/api/config-test.json @@ -2,7 +2,7 @@ "name": "config-test", "brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.", "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], + "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "avail": "1.2.0", "cmd-syntax": "{ \"command\": \"config-test\", diff --git a/doc/api/config-write.json b/doc/api/config-write.json index b998e866c6..bce80a9007 100644 --- a/doc/api/config-write.json +++ b/doc/api/config-write.json @@ -1,8 +1,9 @@ { "name": "config-write", - "brief": "The config-write command instructs the Kea server to write its current configuration to a file on disk.", + "brief": "The config-write command instructs the Kea server to write its + current configuration to a file on disk.", "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], + "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "avail": "1.2.0", "cmd-syntax": "{ \"command\": \"config-write\", diff --git a/doc/api/list-commands.json b/doc/api/list-commands.json index e7a58962f3..0e3928895c 100644 --- a/doc/api/list-commands.json +++ b/doc/api/list-commands.json @@ -2,7 +2,7 @@ "name": "list-commands", "brief": "The list-commands command retrieves a list of all commands supported by the server.", "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" , "ca" ], + "support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ], "avail": "1.0.0", "cmd-syntax": "{ \"command\": \"list-commands\", diff --git a/doc/api/network4-list.json b/doc/api/network4-list.json index a1ec62a6ff..865a7c5011 100644 --- a/doc/api/network4-list.json +++ b/doc/api/network4-list.json @@ -1,7 +1,7 @@ { "name": "network4-list", "brief": "The network4-list command is used to retrieve full list of currently configured shared networks.", - "description": "See ", + "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.3.0", "hook": "subnet_cmds", diff --git a/doc/api/network6-del.json b/doc/api/network6-del.json index 84e509f49b..5339f2a7aa 100644 --- a/doc/api/network6-del.json +++ b/doc/api/network6-del.json @@ -1,7 +1,7 @@ { "name": "network6-del", "brief": "The network6-del command is used to delete existing shared networks.", - "description": "See ", + "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.3.0", "hook": "subnet_cmds", @@ -11,7 +11,8 @@ \"name\": \"floor13\" } }", - "cmd-comment": "The network6-del command uses exactly the same syntax for both the command and the response.", + "cmd-comment": "The network6-del command uses exactly the same syntax for + both the command and the response.", "resp-syntax": "{ \"command\": \"network4-del\", \"arguments\": { diff --git a/doc/api/network6-list.json b/doc/api/network6-list.json index 64cd2089ca..61d731b313 100644 --- a/doc/api/network6-list.json +++ b/doc/api/network6-list.json @@ -1,7 +1,7 @@ { "name": "network6-list", "brief": "The network6-list command is used to retrieve full list of currently configured shared networks.", - "description": "See ", + "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.3.0", "hook": "subnet_cmds", diff --git a/doc/api/shutdown.json b/doc/api/shutdown.json index 137418ecf2..5d2c387ad6 100644 --- a/doc/api/shutdown.json +++ b/doc/api/shutdown.json @@ -2,10 +2,11 @@ "name": "shutdown", "brief": "The shutdown command instructs the server to initiate its shutdown procedure.", "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], + "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "avail": "1.0.0", "cmd-syntax": "{ \"command\": \"shutdown\" }", - "cmd-comment": "The server will respond with a confirmation that the shutdown procedure has been initiated." + "cmd-comment": "The server will respond with a confirmation that the shutdown + procedure has been initiated." } diff --git a/doc/api/stat-lease4-get.json b/doc/api/stat-lease4-get.json index d8f16452b7..4ab8f9aaf6 100644 --- a/doc/api/stat-lease4-get.json +++ b/doc/api/stat-lease4-get.json @@ -1,7 +1,8 @@ { "name": "stat-lease4-get", - "brief": "The stat-lease4-get command fetches lease statistics for a range of known subnets.", - "description": "See ", + "brief": "The stat-lease4-get command fetches lease statistics for a range + of known IPv4 subnets.", + "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", "hook": "stat_cmds", @@ -13,7 +14,10 @@ \"text\": \"stat-lease4-get: 2 rows found\", \"arguments\": { \"result-set\": { - \"columns\": [ \"subnet-id\", \"total-addresses\", \"assigned-addresses\", \"declined-addresses\" ] + \"columns\": [ \"subnet-id\", + \"total-addresses\", + \"assigned-addresses\", + \"declined-addresses\" ] \"rows\": [ [ 10, 256, 111, 0 ], [ 20, 4098, 2034, 4 ] diff --git a/doc/api/stat-lease6-get.json b/doc/api/stat-lease6-get.json index 29b96e8704..4221b0a8a3 100644 --- a/doc/api/stat-lease6-get.json +++ b/doc/api/stat-lease6-get.json @@ -1,7 +1,8 @@ { "name": "stat-lease6-get", - "brief": "The stat-lease6-get command fetches lease statistics for a range of known subnets.", - "description": "See ", + "brief": "The stat-lease6-get command fetches lease statistics for a range + of known IPv6 subnets.", + "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", "hook": "stat_cmds", diff --git a/doc/api/statistic-reset-all.json b/doc/api/statistic-reset-all.json index deb136aa11..e87ab26c68 100644 --- a/doc/api/statistic-reset-all.json +++ b/doc/api/statistic-reset-all.json @@ -8,5 +8,5 @@ \"command\": \"statistic-reset-all\", \"arguments\": { } }", - "cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description.", -} \ No newline at end of file + "cmd-comment": "If the operation is successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description." +} diff --git a/doc/api/statistic-reset.json b/doc/api/statistic-reset.json index 32b9d1a22c..c06162aef4 100644 --- a/doc/api/statistic-reset.json +++ b/doc/api/statistic-reset.json @@ -10,5 +10,5 @@ \"name\": \"pkt4-received\" } }", - "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description.", -} \ No newline at end of file + "cmd-comment": "If the specific statistic is found and reset was successful, the server will respond with a status of 0, indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description." +} diff --git a/doc/api/subnet4-add.json b/doc/api/subnet4-add.json index 580e72b0be..5256c36b73 100644 --- a/doc/api/subnet4-add.json +++ b/doc/api/subnet4-add.json @@ -26,5 +26,5 @@ } ] } -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/subnet4-del.json b/doc/api/subnet4-del.json index 19c6999442..cf3475bf61 100644 --- a/doc/api/subnet4-del.json +++ b/doc/api/subnet4-del.json @@ -1,6 +1,6 @@ { "name": "subnet4-del", - "brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.", + "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.", "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.3.0", @@ -22,5 +22,5 @@ } ] } -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/subnet4-get.json b/doc/api/subnet4-get.json index 79ba6f927b..2bef76adc5 100644 --- a/doc/api/subnet4-get.json +++ b/doc/api/subnet4-get.json @@ -26,5 +26,5 @@ } ] } -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/subnet6-add.json b/doc/api/subnet6-add.json index ece6ece43f..bd477eb1f3 100644 --- a/doc/api/subnet6-add.json +++ b/doc/api/subnet6-add.json @@ -26,5 +26,5 @@ } ] } -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/subnet6-del.json b/doc/api/subnet6-del.json index 636f8c2a0a..3ce5e70096 100644 --- a/doc/api/subnet6-del.json +++ b/doc/api/subnet6-del.json @@ -1,6 +1,6 @@ { "name": "subnet6-del", - "brief": "This command is used to remove a subnet from the server\'s configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server\'s administrator should be aware of.", + "brief": "This command is used to remove a subnet from the server's configuration. This command has no effect on other configured subnets but removing a subnet has certain implications which the server's administrator should be aware of.", "description": "See ", "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.3.0", @@ -20,5 +20,5 @@ \"subnet\": \"2001:db8:1::/64\" } ] -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/subnet6-get.json b/doc/api/subnet6-get.json index 7541db6d13..dde5a00aa2 100644 --- a/doc/api/subnet6-get.json +++ b/doc/api/subnet6-get.json @@ -26,5 +26,5 @@ } ] } -}", -} \ No newline at end of file +}" +} diff --git a/doc/api/version-get.json b/doc/api/version-get.json index 46b8880a10..8daf8639aa 100644 --- a/doc/api/version-get.json +++ b/doc/api/version-get.json @@ -1,10 +1,12 @@ { "name": "version-get", - "brief": "The version-get command returns on the control channel what the command line -v argument displays with in arguments the extended version, i.e., what the command line -V argument displays.", + "brief": "The version-get command returns on the control channel what the + command line -v argument displays with in arguments the extended + version, i.e., what the command line -V argument displays.", "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], + "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ], "avail": "1.2.0", "cmd-syntax": "{ \"command\": \"version-get\" -}", -} \ No newline at end of file +}" +} diff --git a/doc/docgen/cmds-list b/doc/docgen/cmds-list index 6a6bb62a9a..be78abba5f 100644 --- a/doc/docgen/cmds-list +++ b/doc/docgen/cmds-list @@ -12,6 +12,7 @@ config-test config-write dhcp-disable dhcp-enable +ha-continue ha-heartbeat ha-scopes ha-sync diff --git a/doc/guide/hooks-ha.xml b/doc/guide/hooks-ha.xml index a7af55c78a..164483a634 100644 --- a/doc/guide/hooks-ha.xml +++ b/doc/guide/hooks-ha.xml @@ -139,7 +139,8 @@
Server States - The DHCP server operating within an HA setup runs a state machine + The DHCP server operating + within an HA setup runs a state machine and the state of the server can be retrieved by its peers using the ha-heartbeat command sent over the RESTful API. If the partner server doesn't respond to the ha-heartbeat @@ -1292,7 +1293,7 @@ HA hook library which are available for the administrator. -
+
ha-sync command The ha-sync is issued to instruct the server to synchronize its local lease database with the @@ -1346,7 +1347,7 @@
-
+
ha-scopes command This command allows for modifying the HA scopes that the server is serving. Consult @@ -1357,7 +1358,7 @@ { "command": "ha-scopes", - "service": [ "dhcp4 "], + "service": [ "dhcp4" ], "arguments": { "scopes": [ "HA_server1", "HA_server2" ] } @@ -1381,7 +1382,7 @@
-
+
ha-continue command This command is used to resume the operation of the paused HA state machine as described in the . diff --git a/doc/guide/hooks-lease-cmds.xml b/doc/guide/hooks-lease-cmds.xml index 557ada805c..fefa024915 100644 --- a/doc/guide/hooks-lease-cmds.xml +++ b/doc/guide/hooks-lease-cmds.xml @@ -124,9 +124,9 @@ -
+
lease4-add, lease6-add commands - + lease4-add and lease6-add commands allow for the creation of a new lease. Typically Kea creates a lease on its own, when it first sees a new device. However, @@ -284,9 +284,10 @@ The commands can take a number of additional optional parameters: -
+
lease4-get, lease6-get commands - lease4-get or lease6-get + + lease4-get or lease6-get can be used to query the lease database and retrieve existing leases. There are two types of parameters the lease4-get supports: (address) or (subnet-id, @@ -401,9 +402,9 @@ An example result returned when the host was found:
-
+
lease4-get-all, lease6-get-all commands - lease4-get-all and + lease4-get-all and lease6-get-all are used to retrieve all IPv4 or IPv6 leases or all leases for the specified set of subnets. All leases are returned when there are no arguments @@ -610,9 +611,10 @@ An example result returned when the host was found:
-
+
lease4-del, lease6-del commands - leaseX-del can be used to delete a lease from + + leaseX-del can be used to delete a lease from the lease database. There are two types of parameters this command supports, similar to leaseX-get commands: (address) for both v4 and v6, (subnet-id, identifier-type, identifier) for v4 and (subnet-id, @@ -658,9 +660,9 @@ An example IPv4 lease deletion by "hw-address" looks as follows:
-
+
lease4-update, lease6-update commands - lease4-update and + lease4-update and lease6-update commands can be used to update existing leases. Since all lease database backends are indexed by IP addresses, it is not possible to update an address. All other fields @@ -713,9 +715,9 @@ An example IPv4 lease deletion by "hw-address" looks as follows:
-
+
lease4-wipe, lease6-wipe commands - lease4-wipe and + lease4-wipe and lease6-wipe are designed to remove all leases associated with a given subnet. This administrative task is expected to be used when existing subnet is being diff --git a/doc/guide/hooks-stat-cmds.xml b/doc/guide/hooks-stat-cmds.xml index 549f6f1b98..d4604c4737 100644 --- a/doc/guide/hooks-stat-cmds.xml +++ b/doc/guide/hooks-stat-cmds.xml @@ -74,9 +74,9 @@ will not retrieve statistics for it. -
+
stat-lease4-get, stat-lease6-get commands - + The stat-lease4-get and stat-lease6-get commands fetch lease statistics for a range of known subnets. The range of subnets is determined through the use of optional command diff --git a/doc/guide/hooks.xml b/doc/guide/hooks.xml index 68c959f004..7f739930d8 100644 --- a/doc/guide/hooks.xml +++ b/doc/guide/hooks.xml @@ -1432,7 +1432,7 @@ Requirements document.
-
+
reservation-add command reservation-add allows for the insertion of a new host. It @@ -1766,7 +1766,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows -
+
subnet4-list command This command is used to list all currently configured subnets. The @@ -1810,7 +1810,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows
-
+
subnet6-list command This command is used to list all currently configured subnets. The @@ -1854,7 +1854,7 @@ An example deletion by (subnet-id, identifier-type, identifier) looks as follows
-
+
subnet4-get command This command is used to retrieve detailed information about the specified subnet. This command usually follows the @@ -1906,7 +1906,7 @@ or
-
+
subnet6-get command This command is used to retrieve detailed information about the specified subnet. This command usually follows the @@ -1955,7 +1955,7 @@ If the subnet exists the response will be similar to this:
-
+
subnet4-add This command is used to create and add new subnet to the existing @@ -2004,7 +2004,7 @@ If the subnet exists the response will be similar to this:
-
+
subnet6-add This command is used to create and add new subnet to the existing @@ -2083,7 +2083,7 @@ If the subnet exists the response will be similar to this:
-
+
subnet4-del command This command is used to remove a subnet from the server's configuration. @@ -2143,7 +2143,7 @@ If the subnet exists the response will be similar to this:
-
+
subnet6-del command This command is used to remove a subnet from the server's configuration. @@ -2201,9 +2201,9 @@ If the subnet exists the response will be similar to this:
-
+
network4-list, network6-list commands - + These commands are used to retrieve full list of currently configured shared networks. The list contains only very basic information about each shared network. If more details are needed, please use @@ -2232,9 +2232,9 @@ both the query and the response.
-
+
network4-get, network6-get commands - + These commands are used to retrieve detailed information about shared networks, including subnets currently being part of a given network. Both commands take one @@ -2291,9 +2291,9 @@ shared networks information.
-
+
network4-add, network6-add commands - + These commands are used to add a new shared network. New network has to have unique name. This command requires one parameter shared-networks, which is a list and @@ -2366,9 +2366,9 @@ the response. However, there are some parameters that are IPv4-only applies to subnets within the network.
-
+
network4-del, network6-del commands - + These commands are used to delete existing shared networks. Both commands take exactly one parameter 'name' that specifies the name of the network to be removed. An example invocation @@ -2424,9 +2424,9 @@ both the command and the response. subnet6-del commands.
-
+
network4-subnet-add, network6-subnet-add commands - + These commands are used to add existing subnets to existing shared networks. There are several ways to add new shared network. System administrator can add the whole shared network at once, either by @@ -2483,9 +2483,9 @@ both the command and the response. filled with default values, rather than inherited from global scope or from the shared network.
-
+
network4-subnet-del, network6-subnet-del commands - + These commands are used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet. If you want to remove a subnet completely, use subnet4-del or