kea-admin man page

kea-admin — Shell script for managing Kea databases

Synopsis

kea-admin [command] [backend] [-u database username] [-p database password] [-n database name] [-d scripts directory] [-4 | -6] [-o output file]

Description

kea-admin is a shell script which offers database maintenance. In particular, it features database initialization, database version checking and database schema upgrade.

Options

command

Command to be issued to the servers. It can be one of the following:

lease-init
Initializes a new lease database. Useful during first Kea installation. The database is initialized to the latest version supported by the version of the software.

lease-version
Reports lease database version. This is not necessarily equal to Kea version as each backend has its own versioning scheme.

lease-upgrade
Conducts lease database upgrade. This is useful when migrating between old and new Kea versions.

lease-dump
Dumps the contents of the lease database (MySQL and PostgreSQL backends) to text file. The content of the file consists of comma-separated-values (CSV) where each line in the file contains all of the values for a single lease. The first line of file is a header line containing the column names.

backend

Specifies backend type. Currently allowed backends are: memfile, mysql and pgsql.

-u|--user username
Specify the username when connecting to a database. If not specified, the default value of keatest is used.
-p|--password password
Specifies the password when connecting to a database. If not specified, the default value of keatest is used.
-n|--name database-name
Specifies the database name to connect to. If not specified, the default value of keatest is used.
-d|--directory script-directory
Used for override scripts directory. That script is used during upgrades, database initialization and possibly other operations. If not specified, the default value of (prefix)/share/kea/scripts/ is used.
-o|--output output_file
Required for lease-dump, Specifies the file to which the lease data will be dumped.
-4
Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible with the -6 option.
-6
Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible with the -4 option.

See Also

keactrl(8), kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), keactrl(8), perfdhcp(8), Kea Administrator Guide.

Author

The Kea software has been written by a number of engineers working for ISC: Tomek Mrugalski, Stephen Morris, Marcin Siodelski, Thomas Markwalder, Francis Dupont, Jeremy C. Reed, Wlodek Wencel and Shawn Routhier. That list is roughly in the chronological order in which the authors made their first contribution. For a complete list of authors and contributors, see AUTHORS file.

Referenced By

keactrl(8), kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-lfc(8), perfdhcp(8).

Sep. 28, 2016 ISC Kea 1.1.0 Kea