1KEA-ADMIN(8) Kea KEA-ADMIN(8)
2
6 kea-admin - Shell script for managing Kea databases
7
9 kea-admin [command] [backend] [-u database username] [-p database pass‐
10 word] [-n database name] [-d scripts directory] [-4 | -6] [-o output
11 file] [-v]
12
14 kea-admin is a shell script which offers database maintenance. In par‐
15 ticular, it features database initialization, database version check‐
16 ing, and database schema upgrade.
17
19 command
20 Specifies the command to be issued to the servers. It can be one
21 of the following:
22 db-init
24 Initializes a new database schema. This is useful during
25 a new Kea installation. The database is initialized to
26 the latest version supported by the version of the soft‐
27 ware being installed.
28 db-version
30 Reports the database backend version number. This is not
31 necessarily equal to the Kea version number as each back‐
32 end has its own versioning scheme.
33 db-upgrade
35 Conducts a database schema upgrade. This is useful when
36 upgrading Kea.
37 db-dump
39 Dumps the contents of the lease database (for MySQL,
40 PostgreSQL, or CQL backends) to a CSV (comma-separated
41 values) text file. The first line of the file contains
42 the column names. This is meant to be used as a diagnos‐
43 tic tool, so it provides a portable, human-readable form
44 of the lease data.
45 backend
47 Specifies the backend type. Currently allowed backends are: mem‐
48 file, mysql, and pgsql.
49 -u|--user username
51 Specifies the username when connecting to a database. If not
52 specified, the default value of keatest is used.
53 -p|--password password
55 Specifies the password when connecting to a database. If not
56 specified, the default value of keatest is used.
57 -n|--name database-name
59 Specifies the name of the database to connect to. If not speci‐
60 fied, the default value of keatest is used.
61 -d|--directory script-directory
63 Specifies the override scripts directory. That script is used
64 during upgrades, database initialization, and possibly other
65 operations. If not specified, the default value of (pre‐
66 fix)/share/kea/scripts/ is used.
67 -o|--output output_file
69 Specifies the file to which the lease data will be dumped.
70 Required for lease-dump.
71 -v|--version
73 Prints the kea-admin version and quits.
74 -4 Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible
76 with the -6 option.
77 -6 Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible
79 with the -4 option.
80
82 Kea comes with an extensive Kea Administrator Reference Manual that
83 covers all aspects of running the Kea software - compilation, installa‐
84 tion, configuration, configuration examples, and much more. Kea also
85 features a Kea Messages Manual, which lists all possible messages Kea
86 can print with a brief description for each of them. Both documents are
87 available in various formats (.txt, .html, .pdf) with the Kea distribu‐
88 tion. The Kea documentation is available at
89 https://kb.isc.org/docs/kea-administrator-reference-manual .
90 Kea source code is documented in the Kea Developer's Guide. Its online
92 version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
93 The Kea project website is available at https://kea.isc.org.
95
97 There are two public mailing lists available for the Kea project.
98 kea-users (kea-users at lists.isc.org) is intended for Kea users, while
99 kea-dev (kea-dev at lists.isc.org) is intended for Kea developers,
100 prospective contributors, and other advanced users. Both lists are
101 available at https://lists.isc.org. The community provides best-effort
102 support on both of those lists.
103 ISC provides professional support for Kea services. See
105 https://www.isc.org/kea/ for details.
106
108 kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8), keac‐
109 trl(8), perfdhcp(8), kea-netconf(8), Kea Administrator Reference Man‐
110 ual.
111
113 Internet Systems Consortium
114
116 2020, Internet Systems Consortium
1171.7.9 Jul 28, 2020 KEA-ADMIN(8)