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] [-u database username] [-p database pass‐
10       word] [-n database name] [-d scripts directory] [-4 |  -6]  [-o  output
11       file] [-v]
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, and pgsql.
53
54       -u|--user username
55              Specifies  the  username  when  connecting to a database. If not
56              specified, the default value of keatest is used.
57
58       -p|--password password
59              Specifies the password when connecting to  a  database.  If  not
60              specified, the default value of keatest is used.
61
62       -n|--name database-name
63              Specifies  the name of the database to connect to. If not speci‐
64              fied, the default value of keatest is used.
65
66       -d|--directory script-directory
67              Specifies the override scripts directory. That  script  is  used
68              during upgrades, database initialization, and possibly other op‐
69              erations.  If  not  specified,  the  default  value   of   (pre‐
70              fix)/share/kea/scripts/ is used.
71
72       -o|--output output_file
73              Specifies  the  file to which the lease data will be dumped. Re‐
74              quired for lease-dump.
75
76       -v|--version
77              Prints the kea-admin version and quits.
78
79       -4     Directs kea-admin to lease-dump the DHCPv4 leases.  Incompatible
80              with the -6 option.
81
82       -6     Directs  kea-admin to lease-dump the DHCPv6 leases. Incompatible
83              with the -4 option.
84

DOCUMENTATION

86       Kea comes with an extensive Kea  Administrator  Reference  Manual  that
87       covers all aspects of running the Kea software - compilation, installa‐
88       tion, configuration, configuration examples, and much  more.  Kea  also
89       features  a  Kea Messages Manual, which lists all possible messages Kea
90       can print with a brief description for each of them. Both documents are
91       available in various formats (.txt, .html, .pdf) with the Kea distribu‐
92       tion.     The     Kea      documentation      is      available      at
93       https://kb.isc.org/docs/kea-administrator-reference-manual .
94
95       Kea  source code is documented in the Kea Developer's Guide. Its online
96       version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.
97
98       The Kea project website is available at https://kea.isc.org.
99

MAILING LISTS AND SUPPORT

101       There are two public mailing  lists  available  for  the  Kea  project.
102       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
103       kea-dev (kea-dev at lists.isc.org)  is  intended  for  Kea  developers,
104       prospective  contributors,  and  other  advanced  users. Both lists are
105       available at https://lists.isc.org. The community provides  best-effort
106       support on both of those lists.
107
108       ISC    provides    professional   support   for   Kea   services.   See
109       https://www.isc.org/kea/ for details.
110

SEE ALSO

112       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8),  keac‐
113       trl(8),  perfdhcp(8),  kea-netconf(8), Kea Administrator Reference Man‐
114       ual.
115

AUTHOR

117       Internet Systems Consortium
118

120       2019-2021, Internet Systems Consortium
121
122
123
124
1251.9.4                            Feb 08, 2021                     KEA-ADMIN(8)
Impressum