${INSTALL_DATA} $(mans_found) ${DESTDIR}${mandir}/man8/
endif
endif
- mkdir -p $(DESTDIR)$(datarootdir)/${PACKAGE_NAME}/api
- cp $(api_files) $(DESTDIR)$(datarootdir)/${PACKAGE_NAME}/api
uninstall-local:
rm -rf $(DESTDIR)$(docdir)
- rm -rf $(DESTDIR)$(datarootdir)/${PACKAGE_NAME}/api
# There are sometimes conflicts when more then one sphinx-build is run at a time.
# This target blocks running anything in parallel in this Makefile,
api/build-report.json
api/cache-clear.json
-api/cache-get-by-id.json
api/cache-get.json
+api/cache-get-by-id.json
api/cache-insert.json
api/cache-load.json
api/cache-remove.json
api/lease4-get-by-hw-address.json
api/lease4-get-page.json
api/lease4-get.json
-api/lease4-resend-ddns.json
api/lease4-update.json
api/lease4-wipe.json
+api/lease4-resend-ddns.json
api/lease6-add.json
api/lease6-bulk-apply.json
api/lease6-del.json
api/lease6-get-by-hostname.json
api/lease6-get-page.json
api/lease6-get.json
-api/lease6-resend-ddns.json
api/lease6-update.json
api/lease6-wipe.json
+api/lease6-resend-ddns.json
api/leases-reclaim.json
api/libreload.json
api/list-commands.json
api/remote-option4-global-get-all.json
api/remote-option4-global-get.json
api/remote-option4-global-set.json
+api/remote-option6-global-del.json
+api/remote-option6-global-get-all.json
+api/remote-option6-global-get.json
+api/remote-option6-global-set.json
api/remote-option4-network-del.json
api/remote-option4-network-set.json
api/remote-option4-pool-del.json
api/remote-option4-pool-set.json
api/remote-option4-subnet-del.json
api/remote-option4-subnet-set.json
-api/remote-option6-global-del.json
-api/remote-option6-global-get-all.json
-api/remote-option6-global-get.json
-api/remote-option6-global-set.json
api/remote-option6-network-del.json
api/remote-option6-network-set.json
api/remote-option6-pd-pool-del.json
api/remote-subnet6-set.json
api/reservation-add.json
api/reservation-del.json
+api/reservation-get.json
api/reservation-get-all.json
api/reservation-get-by-hostname.json
api/reservation-get-page.json
-api/reservation-get.json
api/server-tag-get.json
api/shutdown.json
-api/stat-lease4-get.json
-api/stat-lease6-get.json
api/statistic-get-all.json
api/statistic-get.json
api/statistic-remove-all.json
api/statistic-sample-count-set-all.json
api/statistic-sample-count-set.json
api/status-get.json
+api/stat-lease4-get.json
+api/stat-lease6-get.json
api/subnet4-add.json
api/subnet4-del.json
api/subnet4-get.json
// a hook), remove the whole "hook" entry.
"hook": "name of the hook that provides this command. remove if provided by the core code",
- // This defines the read or write access. Default is write access
- // to not leave unrestricted access to a dangerous command by accident.
- "access": "write",
-
// This defines the syntax of the command.
"cmd-syntax": [ "Syntax of the command" ],
{
- "access": "read",
"avail": "1.2.0",
"brief": [
"This command returns the list of compilation options that this particular binary was built with."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command removes all cached host reservations."
"kea-dhcp4",
"kea-dhcp6"
]
-}
+}
\ No newline at end of file
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command returns entries matching the given identifier from the host cache."
{
- "access": "read",
"avail": "1.4.0",
"brief": [
"This command returns the full content of the host cache."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command inserts a host into the cache."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command allows the contents of a file on disk to be loaded into an in-memory cache."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command removes entries from the host cache. It takes parameters similar to the ``reservation-get`` command."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command returns the number of entries in the host cache."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command instructs Kea to write its host cache content to disk."
{
- "access": "write",
"avail": "1.5.0",
"brief": [
"This command adds a new class to the existing server configuration."
{
- "access": "write",
"avail": "1.5.0",
"brief": [
"This command removes a client class from the server configuration."
{
- "access": "read",
"avail": "1.5.0",
"brief": [
"This command returns detailed information about an existing client class."
{
- "access": "read",
"avail": "1.5.0",
"brief": [
"This command retrieves a list of all client classes from the server configuration."
{
- "access": "write",
"avail": "1.5.0",
"brief": [
"This command updates an existing client class in the server configuration."
class-get
class-list
class-update
-config-backend-pull
config-get
config-reload
config-set
lease4-del
lease4-get
lease4-get-all
-lease4-get-by-client-id
-lease4-get-by-hostname
-lease4-get-by-hw-address
lease4-get-page
-lease4-resend-ddns
lease4-update
lease4-wipe
lease6-add
lease6-del
lease6-get
lease6-get-all
-lease6-get-by-duid
-lease6-get-by-hostname
lease6-get-page
-lease6-resend-ddns
lease6-update
lease6-wipe
+lease4-resend-ddns
+lease6-resend-ddns
leases-reclaim
libreload
list-commands
remote-option4-global-get
remote-option4-global-get-all
remote-option4-global-set
+remote-option6-global-del
+remote-option6-global-get
+remote-option6-global-get-all
+remote-option6-global-set
remote-option4-network-del
remote-option4-network-set
remote-option4-pool-del
remote-option4-pool-set
remote-option4-subnet-del
remote-option4-subnet-set
-remote-option6-global-del
-remote-option6-global-get
-remote-option6-global-get-all
-remote-option6-global-set
remote-option6-network-del
remote-option6-network-set
remote-option6-pd-pool-del
reservation-del
reservation-get
reservation-get-all
-reservation-get-by-hostname
reservation-get-page
-server-tag-get
shutdown
stat-lease4-get
stat-lease6-get
statistic-sample-age-set-all
statistic-sample-count-set
statistic-sample-count-set-all
-status-get
subnet4-add
subnet4-del
subnet4-get
subnet4-list
-subnet4-update
subnet6-add
subnet6-del
subnet6-get
subnet6-list
-subnet6-update
version-get
{
- "access": "write",
"avail": "1.7.1",
"brief": [
"This command forces an immediate update of the server using Config Backends.",
{
- "access": "read",
"avail": "1.2.0",
"brief": [
"This command retrieves the current configuration used by the server. The configuration is essentially the same as the contents of the configuration file, but includes additional changes made by other commands and due to parameters' inheritance."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command instructs Kea to reload the configuration file that was used previously."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command instructs the Kea server to write its",
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command globally disables the DHCP service."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command globally enables the DHCP service."
echo " \"support\": [ \"undocumented\" ]," >> "$F"
echo " \"avail\": \"0.0.0\"," >> "$F"
echo " \"hook\": \"undocumented\"," >> "$F"
- echo " \"access\": \"write\"," >> $F
echo " \"cmd-syntax\": [ \"Syntax of the command\" ]," >> "$F"
echo " \"cmd-comment\": [ \"Possibly some extra comments after the syntax.\" ]," >> "$F"
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command resumes the operation of a paused HA state machine."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command is sent internally by a Kea partner when operating in High Availability (HA) mode or by the system administrator to verify the state of the servers with regards to the High Availability. It retrieves the server's HA state and clock value."
{
- "access": "write",
"avail": "1.7.4",
"brief": [
"This command is sent to instruct a server in the partner-in-maintenance",
{
- "access": "write",
"avail": "1.7.4",
"brief": [
"This command is sent by the server receiving the ha-maintenance-start",
{
- "access": "write",
"avail": "1.7.4",
"brief": [
"This command is sent to instruct one of the servers to transition",
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command modifies the scope that the server is responsible for serving when operating in High Availability (HA) mode."
{
- "access": "write",
"avail": "1.4.0",
"brief": [
"This command instructs the server running in HA mode to synchronize its local lease database with the selected peer."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command administratively adds a new IPv4 lease."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command deletes a lease from the lease database."
{
- "access": "read",
"avail": "1.4.0",
"brief": [
"This command retrieves all IPv4 leases or all leases for the specified set of subnets."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all IPv4 leases with the specified client id."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all IPv4 leases with the specified hostname."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all IPv4 leases with the specified hardware address."
{
- "access": "read",
"avail": "1.5.0",
"brief": [
"This command retrieves all IPv4 leases by page."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command queries the lease database and retrieves existing leases."
{
- "access": "write",
"avail": "1.7.6",
"brief": [
"This command resends a request to kea-dhcp-ddns to update DNS for an existing lease."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command updates existing leases."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes all leases associated with a given subnet."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command administratively creates a new lease."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates, updates, or deletes multiple IPv6 leases in a single transaction. It communicates lease changes between HA peers, but may be used in all cases where it is desirable to apply multiple lease updates in a single transaction."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command deletes a lease from the lease database."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves all IPv6 leases or all leases for the specified set of subnets."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all IPv6 leases with the specified hardware address."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all IPv6 leases with the specified hostname."
{
- "access": "read",
"avail": "1.5.0",
"brief": [
"This command retrieves all IPv6 leases by page."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command queries the lease database and retrieves existing leases."
{
- "access": "write",
"avail": "1.7.6",
"brief": [
"This command resends a request to kea-dhcp-ddns to update DNS for an existing lease."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command updates existing leases."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes all leases associated with a given subnet."
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command instructs the server to reclaim all expired leases immediately."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command first unloads and then reloads all currently loaded hooks libraries."
{
- "access": "read",
"avail": "1.0.0",
"brief": [
"This command retrieves a list of all commands supported by the server."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command adds a new shared network."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command deletes existing shared networks."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves detailed information about shared networks, including subnets that are currently part of a given network."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves the full list of currently configured shared networks."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command adds existing subnets to existing shared networks."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes a subnet that is part of an existing shared network and demotes it to a plain, stand-alone subnet."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command adds a new shared network."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command deletes existing shared networks."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"The network6-get command retrieves detailed information about shared networks, including subnets that are currently part of a given network."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves the full list of currently configured shared networks."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command adds existing subnets to existing shared networks."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes a subnet that is part of an existing shared network and demotes it to a plain, stand-alone subnet."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a global DHCPv4 parameter from the configuration database. The server uses the value specified in the configuration file, or a default value if the parameter is not specified, after deleting the parameter from the database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all global parameters for the server from the specified database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected global parameter for the server from the specified database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or updates one or more global parameters in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a global DHCPv6 parameter from the configuration database. The server uses the value specified in the configuration file, or a default value if the parameter is not specified in the configuration file, after deleting the parameter from the database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all global parameters for the server from the specified database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected global parameter for the server from the specified database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or updates one or more global parameters in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv4 shared network from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv4 shared network for the server from the specified database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a list of all IPv4 shared networks from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces an IPv4 shared network in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv6 shared network from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv6 shared network for the server from the specified database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a list of all IPv6 shared networks from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces an IPv6 shared network in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv4 option definition from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all DHCPv4 option definitions from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a DHCPv4 option definition from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv4 option definition in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 option definition from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all DHCPv6 option definitions from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a DHCPv6 option definition from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 option definition in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv4 global option from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all DHCPv4 global options for the server from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a global DHCPv4 option for the server from the specified database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv4 global option in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv4 option from a shared network from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv4 option in a shared network in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv4 option from an address pool from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv4 option in an address pool in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv4 option from a subnet from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv4 option in a subnet in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 global option from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches all DHCPv6 global options for the server from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a global DHCPv6 option for the server from the specified database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 global option in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 option from a shared network from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 option in a shared network in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 option from a prefix delegation pool from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 option in a prefix delegation pool in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 option from an address pool from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 option in an address pool in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes a DHCPv6 option from a subnet from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces a DHCPv6 option in a subnet in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes information about a DHCPv4 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. Shareable configuration elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches information about all DHCPv4 servers specified by the user."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches information about the DHCPv4 server, such as the server tag and description."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces information about the DHCPv4 server in the database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes information about a DHCPv6 server from the configuration database. Any configuration explicitly associated with the deleted server is automatically disassociated. In addition, configuration elements not shareable with other servers (e.g. global DHCP parameters) are deleted. Shareable configuration elements (e.g. subnets, shared networks) are not deleted as they may be used by other servers."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches information about all DHCPv6 servers specified by the user."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches information about the DHCPv6 server, such as the server tag and description."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces information about the DHCPv6 server in the database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv4 subnet by ID from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv4 subnet by prefix from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv4 subnet by ID from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv4 subnet by prefix from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a list of all IPv4 subnets from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces an IPv4 subnet in the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv6 subnet by ID from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command deletes an IPv6 subnet by prefix from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv6 subnet by ID from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches the selected IPv6 subnet by prefix from the configuration database."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command fetches a list of all IPv6 subnets from the configuration database."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command creates or replaces an IPv6 subnet in the configuration database."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command adds a new host reservation. The reservation may include IPv4 addresses, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options, and more."
{
- "access": "write",
"avail": "1.2.0",
"brief": [
"This command deletes an existing host reservation."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command retrieves all host reservations for a specified subnet."
{
- "access": "read",
"avail": "1.7.1",
"brief": [
"This command retrieves all host reservations for a specified hostname and optionally a specified subnet."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command retrieves host reservations for a specified subnet by page."
{
- "access": "read",
"avail": "1.2.0",
"brief": [
"This command retrieves an existing host reservation."
{
- "access": "read",
"avail": "1.6.0",
"brief": [
"This command returns the server tag used by the server. ",
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command instructs the server to initiate its shutdown procedure."
{
- "access": "read",
"avail": "1.4.0",
"brief": [
"This command fetches lease statistics for a range of known IPv4 subnets."
{
- "access": "read",
"avail": "1.4.0",
"brief": [
"This command fetches lease statistics for a range of known IPv6 subnets."
{
- "access": "read",
"avail": "1.0.0",
"brief": [
"This command retrieves all recorded statistics."
{
- "access": "read",
"avail": "1.0.0",
"brief": [
"This command retrieves a single statistic. It takes a single string parameter called name that specifies the statistic name."
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command deletes all statistics."
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command deletes a single statistic. It takes a single string parameter called name that specifies the statistic name."
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command sets all statistics to their neutral values: 0 for integer, 0.0 for float, 0h0m0s0us for time duration, and \"\" for string type."
{
- "access": "write",
"avail": "1.0.0",
"brief": [
"This command sets the specified statistic to its neutral value: 0 for integer, 0.0 for float, 0h0m0s0us for time duration, and \"\" for string type. It takes a single string parameter called name that specifies the statistic name."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command sets a time-based limit for all statistics. It takes a single integer parameter called duration."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command sets a time-based limit for a single statistic. It takes two parameters: a string called name and an integer value called duration."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command sets a size-based limit for all statistics. It takes a single integer parameter called max-samples."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command sets a size-based limit for a single statistic. It takes two parameters: a string called name and an integer value called max-samples."
{
- "access": "read",
"avail": "1.7.3",
"brief": [
"This command returns server's runtime information.",
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command creates and adds a new subnet to the existing server configuration. This operation has no impact on other subnets."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes 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."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves detailed information about the specified subnet. This command usually follows ``subnet4-list``, which discovers available subnets with their respective subnet identifiers and prefixes."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command lists all currently configured subnets. The subnets are returned in a brief format, i.e. a subnet identifier and subnet prefix are included for each subnet."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command creates and adds a new subnet to the existing server configuration. This operation has no impact on other subnets."
{
- "access": "write",
"avail": "1.3.0",
"brief": [
"This command removes 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."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command retrieves detailed information about the specified subnet. This command usually follows ``subnet6-list``, which discovers available subnets with their respective subnet identifiers and prefixes."
{
- "access": "read",
"avail": "1.3.0",
"brief": [
"This command lists all currently configured subnets. The subnets are returned in a brief format, i.e. a subnet identifier and subnet prefix are included for each subnet."
{
- "access": "write",
"avail": "1.6.0",
"brief": [
"This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
{
- "access": "read",
"avail": "1.2.0",
"brief": [
"This command returns extended information about the Kea version that is running. The returned string is the same as if Kea were run with the ``-V`` command-line option."
#!/usr/bin/env python3
-# Copyright (C) 2019-2020 Internet Systems Consortium, Inc. ("ISC")
+# Copyright (C) 2019 Internet Systems Consortium, Inc. ("ISC")
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
rst += '(:ref:`%s <commands-%s>` hook library)' % (func['hook'], func['hook']) if 'hook' in func else '(built-in)'
rst += '\n\n'
- # access
- try:
- access = func['access']
- except:
- print('\naccess missing in %s\n\n' % name)
- raise
- if not access in ['read', 'write']:
- print('\nUnknown access %s in %s\n\n' % (access, name))
- raise ValueError('access must be read or write')
- rst += 'Access: %s\n' % access
-
# description and examples
rst += 'Description and examples: see :ref:`%s command <command-%s>`\n\n' % (name, name)
projects / thirdparty / kea.git / commitdiff
