1KEA-ADMIN(8)                          Kea                         KEA-ADMIN(8)
2
3
4

NAME

6       kea-admin - Shell script for managing Kea databases
7

SYNOPSIS

9       kea-admin [command] [backend] [-h database_host] [-P database_port] [-u
10       database_username]  [-p  [database_password]]  [-n  database_name]  [-d
11       script_directory] [-v] [-4 | -6] [-o output_file]
12

DESCRIPTION

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

ARGUMENTS

19       command
20              Specifies the command to be issued to the servers. It can be one
21              of the following:
22
23              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
29              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
34              db-upgrade
35                     Conducts  a  database schema upgrade. This is useful when
36                     upgrading Kea.
37
38              lease-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
46              stats-recount
47                     Recounts  lease  statistics for MySQL or PostgreSQL data‐
48                     base.
49
50       backend
51              Specifies the backend type. Currently allowed backends are: mem‐
52              file, mysql, pgsql, and cql.
53
54       -h|--host hostname
55              Specifies  the  hostname  when  connecting to a database. If not
56              specified, the default value of localhost is used.
57
58       -P|--port port
59              Specifies the port when connecting to a database. If not  speci‐
60              fied, the default value chosen by the database client is used.
61
62       -u|--user username
63              Specifies  the  username  when  connecting to a database. If not
64              specified, the default value of keatest is used.
65
66       -p|--password password
67              Specifies the password when connecting to a database.   If  only
68              -p  or --password is given, the user is prompted for a password.
69              If not specified at all, the  KEA_ADMIN_DB_PASSWORD  environment
70              variable  is  checked for a value and used if it exists.  Other‐
71              wise the default value of keatest is used.
72
73       -n|--name database-name
74              Specifies the name of the database to connect to. If not  speci‐
75              fied, the default value of keatest is used.
76
77       -d|--directory script-directory
78              Specifies  the  override  scripts directory. That script is used
79              during upgrades, database initialization, and possibly other op‐
80              erations.   If   not  specified,  the  default  value  of  (pre‐
81              fix)/share/kea/scripts/ is used.
82
83       -o|--output output_file
84              Specifies the file to which the lease data will be  dumped.  Re‐
85              quired for lease-dump.
86
87       -v|--version
88              Prints the kea-admin version and quits.
89
90       -4     Directs  kea-admin to lease-dump the DHCPv4 leases. Incompatible
91              with the -6 option.
92
93       -6     Directs kea-admin to lease-dump the DHCPv6 leases.  Incompatible
94              with the -4 option.
95

DOCUMENTATION

97       Kea  comes  with  an  extensive Kea Administrator Reference Manual that
98       covers all aspects of running the Kea software - compilation, installa‐
99       tion,  configuration,  configuration  examples, and much more. Kea also
100       features a Kea Messages Manual, which lists all possible  messages  Kea
101       can print with a brief description for each of them. Both documents are
102       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
103       tion. The Kea documentation is available at https://kea.readthedocs.io.
104
105       Kea  source code is documented in the Kea Developer's Guide. Its online
106       version is available at https://reports.kea.isc.org/dev_guide/.
107
108       The Kea project website is available at https://kea.isc.org.
109

MAILING LISTS AND SUPPORT

111       There are two public mailing  lists  available  for  the  Kea  project.
112       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
113       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
114       prospective  contributors,  and  other  advanced  users. Both lists are
115       available at https://lists.isc.org. The community provides  best-effort
116       support on both of those lists.
117
118       ISC    provides    professional   support   for   Kea   services.   See
119       https://www.isc.org/kea/ for details.
120

SEE ALSO

122       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8),  keac‐
123       trl(8),  perfdhcp(8),  kea-netconf(8), Kea Administrator Reference Man‐
124       ual.
125

AUTHOR

127       Internet Systems Consortium
128

COPYRIGHT

130       2019-2022, Internet Systems Consortium
131
132
133
134
1352.0.2                            Mar 03, 2022                     KEA-ADMIN(8)