|kea-admin [command] [backend] [-u database username] [-p database password] [-n database name] [-d scripts directory] [-4 | -6] [-o output file]|
kea-admin is a shell script which offers database maintenance. In particular, it features database initialization, database version checking and database schema upgrade.
commandCommand to be issued to the servers. It can be one of the following:
lease-initInitializes 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-versionReports lease database version. This is not necessarily equal to Kea version as each backend has its own versioning scheme.
lease-upgradeConducts lease database upgrade. This is useful when migrating between old and new Kea versions.
lease-dumpDumps 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.
backendSpecifies backend type. Currently allowed backends are: memfile, mysql and pgsql.
-u|--user usernameSpecify the username when connecting to a database. If not specified, the default value of keatest is used.
-p|--password passwordSpecifies the password when connecting to a database. If not specified, the default value of keatest is used.
-n|--name database-nameSpecifies the database name to connect to. If not specified, the default value of keatest is used.
-d|--directory script-directoryUsed 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_fileRequired for lease-dump, Specifies the file to which the lease data will be dumped.
-4Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible with the -6 option.
-6Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible with the -4 option.
keactrl(8), kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), Kea Administrator Guide.
Copyright © 2014 Internet Systems Consortium, Inc. ("ISC")
|Kea||KEA-ADMIN (8)||Nov 5, 2014|