diff --git a/doc/guide/api.xml b/doc/guide/api.xml index 0383d34761..44edbd3d60 100644 --- a/doc/guide/api.xml +++ b/doc/guide/api.xml @@ -109,13 +109,7 @@ , lease4-get-all , lease4-update , lease4-wipe -, lease6-add -, lease6-del -, lease6-get -, lease6-get-all -, lease6-update , lease6-wipe -, leases-reclaim , libreload , list-commands , network4-add @@ -124,18 +118,11 @@ , network4-list , network4-subnet-add , network4-subnet-del -, network6-add -, network6-del -, network6-get -, network6-list -, network6-subnet-add -, network6-subnet-del , reservation-add , reservation-del , reservation-get , shutdown , stat-lease4-get -, stat-lease6-get , statistic-get , statistic-get-all , statistic-remove @@ -146,10 +133,6 @@ , subnet4-del , subnet4-get , subnet4-list -, subnet6-add -, subnet6-del -, subnet6-get -, subnet6-list , version-get . Commands supported by kea-dhcp6 daemon: build-report @@ -170,12 +153,6 @@ , ha-heartbeat , ha-scopes , ha-sync -, lease4-add -, lease4-del -, lease4-get -, lease4-get-all -, lease4-update -, lease4-wipe , lease6-add , lease6-del , lease6-get @@ -185,12 +162,6 @@ , leases-reclaim , libreload , list-commands -, network4-add -, network4-del -, network4-get -, network4-list -, network4-subnet-add -, network4-subnet-del , network6-add , network6-del , network6-get @@ -201,7 +172,6 @@ , reservation-del , reservation-get , shutdown -, stat-lease4-get , stat-lease6-get , statistic-get , statistic-get-all @@ -209,10 +179,6 @@ , statistic-remove-all , statistic-reset , statistic-reset-all -, subnet4-add -, subnet4-del -, subnet4-get -, subnet4-list , subnet6-add , subnet6-del , subnet6-get @@ -493,6 +459,8 @@ Result is an integer representation of the status. Currently supported statuses "subnet-id": 123 } } + +Another example that removes IPv6 host identifier by DUID and specific subnet-id is: { "command": "cache-remove", "arguments": { @@ -573,7 +541,7 @@ Result is an integer representation of the status. Currently supported statuses { "command": "config-get" } -config-get takes no parameters. +This command takes no parameters. Response syntax: { @@ -862,8 +830,7 @@ Result is an integer representation of the status. Currently supported statuses
ha-heartbeat reference ha-heartbeat - This command is sent internally by Kea partner when operating - in High Availability (HA) mode. It should not be used by users, - unless you want to implement complete HA replacement. + in High Availability (HA) mode. It will retrieve the server HA state and clock value. Supported by: kea-dhcp4, kea-dhcp6 @@ -872,19 +839,18 @@ Result is an integer representation of the status. Currently supported statuses Description and examples: See Command syntax: - tbd + { + "command": "ha-heartbeat", + } Response syntax: - tbd -Result is an integer representation of the status. Currently supported statuses are: - - 0 - success - 1 - error - 2 - unsupported - 3 - empty (command was completed successfully, but no data was affected or returned) - - + { + "result": <integer>, + "text": <string> +} + +The response to this command is different from the typical command response. The response will include server state (see plus the current clock value.
@@ -892,8 +858,7 @@ Result is an integer representation of the status. Currently supported statuses
ha-scopes reference -ha-scopes - This command allows for modifying the High Availability (HA) scopes - that the server is serving.a sentence or two explaining what this command does +ha-scopes - This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode. Supported by: kea-dhcp4, kea-dhcp6 @@ -907,10 +872,8 @@ Result is an integer representation of the status. Currently supported statuses "service": [ <service, typically "dhcp4" or "dhcp6"> ], "arguments": { "scopes": [ "HA_server1", "HA_server2" ] - } -} - - + } +In the example given, the arguments configure the server to handle traffic from both HA_server1 and HA_server2 scopes. Response syntax: { @@ -974,9 +937,9 @@ Result is an integer representation of the status. Currently supported statuses
lease4-add reference -lease4-add - The lease4-add command allows for the creation of a new lease. +lease4-add - The lease4-add command adds a new IPv4 lease administratively. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (lease_cmds hook) @@ -990,7 +953,7 @@ Result is an integer representation of the status. Currently supported statuses "hw-address": "1a:1b:1c:1d:1e:1f" } } - +Note that Kea 1.4 requires an additional argument, subnet-ID, which is optional as of Kea 1.5. A number of other more detailed optional arguments are also supported. Response syntax: { @@ -1015,7 +978,7 @@ Result is an integer representation of the status. Currently supported statuses lease4-del reference lease4-del - lease4-del can be used to delete a lease from the lease database. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (lease_cmds hook) @@ -1028,7 +991,7 @@ Result is an integer representation of the status. Currently supported statuses "ip-address": "192.0.2.202" } } -leaseX-del returns a result that indicates a outcome of the operation. It has one of the following values: 0 (success), 1 (error) or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease in this case) has not been found. +Specify the lease to be deleted either by IP address, or by identifier-type and identifier value. Currently supported identifiers are "hw-address" and "client-id". Response syntax: { @@ -1053,7 +1016,7 @@ Result is an integer representation of the status. Currently supported statuses lease4-get reference lease4-get - lease4-get can be used to query the lease database and retrieve existing leases. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (lease_cmds hook) @@ -1095,7 +1058,7 @@ lease4-get returns a result that indicates a result of the operation and lease d lease4-get-all reference lease4-get-all - lease4-get-all is used to retrieve all IPv4 leases or all leases for the specified set of subnets. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.4.0 (lease_cmds hook) @@ -1104,6 +1067,7 @@ lease4-get returns a result that indicates a result of the operation and lease d Command syntax: { "command": "lease4-get-all" + "arguments": "subnets" } The lease4-get-all command may result in very large responses. @@ -1130,7 +1094,7 @@ Result is an integer representation of the status. Currently supported statuses lease4-update reference lease4-update - The lease4-update command can be used to update existing leases. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (lease_cmds hook) @@ -1172,7 +1136,7 @@ Result is an integer representation of the status. Currently supported statuses lease4-wipe reference lease4-wipe - lease4-wipe is designed to remove all leases associated with a given subnet. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (lease_cmds hook) @@ -1208,9 +1172,9 @@ Result is an integer representation of the status. Currently supported statuses
lease6-add reference -lease6-add - The lease6-add command allows for the creation of a new lease. +lease6-add - The lease6-add command creates a new lease administratively. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (lease_cmds hook) @@ -1248,7 +1212,7 @@ Result is an integer representation of the status. Currently supported statuses lease6-del reference lease6-del - lease6-del can be used to delete a lease from the lease database. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (lease_cmds hook) @@ -1256,7 +1220,7 @@ Result is an integer representation of the status. Currently supported statuses Command syntax: { - "command": "lease4-del", + "command": "lease6-del", "arguments": { "ip-address": "192.0.2.202" } @@ -1286,7 +1250,7 @@ Result is an integer representation of the status. Currently supported statuses lease6-get reference lease6-get - lease6-get can be used to query the lease database and retrieve existing leases. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (lease_cmds hook) @@ -1325,7 +1289,7 @@ Result is an integer representation of the status. Currently supported statuses lease6-get-all reference lease6-get-all - lease6-get-all is used to retrieve all IPv6 leases or all leases for the specified set of subnets. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (lease_cmds hook) @@ -1389,7 +1353,7 @@ The lease6-get-all command may result in very large responses. lease6-update reference lease6-update - The lease6-update command can be used to update existing leases. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (lease_cmds hook) @@ -1471,7 +1435,7 @@ Result is an integer representation of the status. Currently supported statuses leases-reclaim reference leases-reclaim - The leases-reclaim command instructs the server to reclaim all expired leases immediately. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.0.0 (built-in) @@ -1581,7 +1545,7 @@ Result is an integer representation of the status. Currently supported statuses network4-add reference network4-add - The network4-add command is used to add a new shared network. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1646,7 +1610,7 @@ Result is an integer representation of the status. Currently supported statuses network4-del reference network4-del - The network4-del command is used to delete existing shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1690,7 +1654,7 @@ Result is an integer representation of the status. Currently supported statuses network4-get reference network4-get - The network4-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1748,7 +1712,7 @@ Note that the actual response contains many additional fields that are omitted h network4-list reference network4-list - The network4-list command is used to retrieve full list of currently configured shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1788,7 +1752,7 @@ Result is an integer representation of the status. Currently supported statuses network4-subnet-add reference network4-subnet-add - The network4-subnet-add command is used to add existing subnets to existing shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1826,7 +1790,7 @@ Result is an integer representation of the status. Currently supported statuses network4-subnet-del reference network4-subnet-del - The network4-subnet-del command is used to remove a subnet that is part of an existing shared network and demote it to a plain, stand-alone subnet. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -1864,7 +1828,7 @@ Result is an integer representation of the status. Currently supported statuses network6-add reference network6-add - The network6-add command is used to add a new shared network. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -1929,7 +1893,7 @@ Result is an integer representation of the status. Currently supported statuses network6-del reference network6-del - The network6-del command is used to delete existing shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -1970,7 +1934,7 @@ Result is an integer representation of the status. Currently supported statuses network6-get reference network6-get - The network6-get command is used to retrieve detailed information about shared networks, including subnets currently being part of a given network. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2028,7 +1992,7 @@ Note that the actual response contains many additional fields that are omitted h network6-list reference network6-list - The network6-list command is used to retrieve full list of currently configured shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2068,7 +2032,7 @@ Result is an integer representation of the status. Currently supported statuses network6-subnet-add reference network6-subnet-add - The network6-subnet-add command is used to add existing subnets to existing shared networks. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2106,7 +2070,7 @@ Result is an integer representation of the status. Currently supported statuses network6-subnet-del reference network6-subnet-del - The network6-subnet-del command is used to remove a subnet that is part of existing shared network and demote it to a plain, stand-alone subnet. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2335,7 +2299,7 @@ Result is an integer representation of the status. Currently supported statuses stat-lease4-get - The stat-lease4-get command fetches lease statistics for a range of known IPv4 subnets. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.4.0 (stat_cmds hook) @@ -2383,7 +2347,7 @@ Result is an integer representation of the status. Currently supported statuses stat-lease6-get - The stat-lease6-get command fetches lease statistics for a range of known IPv6 subnets. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.4.0 (stat_cmds hook) @@ -2653,7 +2617,7 @@ Result is an integer representation of the status. Currently supported statuses subnet4-add reference subnet4-add - This command is used to create and add a new subnet to the existing server configuration. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -2702,7 +2666,7 @@ Result is an integer representation of the status. Currently supported statuses subnet4-del reference subnet4-del - 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. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -2747,7 +2711,7 @@ Result is an integer representation of the status. Currently supported statuses subnet4-get reference subnet4-get - This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet4-list, which is used to discover available subnets with their respective subnet identifiers and prefixes. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -2796,7 +2760,7 @@ Result is an integer representation of the status. Currently supported statuses subnet4-list reference subnet4-list - This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp4 Availability: 1.3.0 (subnet_cmds hook) @@ -2834,7 +2798,7 @@ If no IPv4 subnets are found, an error code is returned along with the error des subnet6-add reference subnet6-add - This command is used to create and add new subnet to the existing server configuration. This operation has no impact on other subnets. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2883,7 +2847,7 @@ Result is an integer representation of the status. Currently supported statuses subnet6-del reference subnet6-del - 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. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2926,7 +2890,7 @@ Result is an integer representation of the status. Currently supported statuses subnet6-get reference subnet6-get - This command is used to retrieve detailed information about the specified subnet. This command usually follows the subnet6-list, which is used to discover available subnets with their respective subnet identifiers and prefixes. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook) @@ -2975,7 +2939,7 @@ Result is an integer representation of the status. Currently supported statuses subnet6-list reference subnet6-list - This command is used to list all currently configured subnets. The subnets are returned in a brief form, i.e. a subnet identifier and subnet prefix is included for each subnet. -Supported by: kea-dhcp4, kea-dhcp6 +Supported by: kea-dhcp6 Availability: 1.3.0 (subnet_cmds hook)