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]
10                 [-p database password] [-n database name]
11                 [-d scripts directory] [-4 | -6] [-o output file] [-v]
12

DESCRIPTION

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

OPTIONS

19       command
20           Command to be issued to the servers. It can be one of the
21           following:
22
23           lease-init
24               Initializes a new lease database. Useful during first Kea
25               installation. The database is initialized to the latest version
26               supported by the version of the software.
27
28           lease-version
29               Reports lease database version. This is not necessarily equal
30               to Kea version as each backend has its own versioning scheme.
31
32           lease-upgrade
33               Conducts lease database upgrade. This is useful when migrating
34               between old and new Kea versions.
35
36           lease-dump
37               Dumps the contents of the lease database (MySQL and PostgreSQL
38               backends) to text file. The content of the file consists of
39               comma-separated-values (CSV) where each line in the file
40               contains all of the values for a single lease. The first line
41               of file is a header line containing the column names.
42
43       backend
44           Specifies backend type. Currently allowed backends are: memfile,
45           mysql and pgsql.
46
47       -u|--user username
48           Specify the username when connecting to a database. If not
49           specified, the default value of keatest is used.
50
51       -p|--password password
52           Specifies the password when connecting to a database. If not
53           specified, the default value of keatest is used.
54
55       -n|--name database-name
56           Specifies the database name to connect to. If not specified, the
57           default value of keatest is used.
58
59       -d|--directory script-directory
60           Used for override scripts directory. That script is used during
61           upgrades, database initialization and possibly other operations. If
62           not specified, the default value of (prefix)/share/kea/scripts/ is
63           used.
64
65       -o|--output output_file
66           Required for lease-dump, Specifies the file to which the lease data
67           will be dumped.
68
69       -v|--version
70           Prints kea-admin version and quits.
71
72       -4
73           Directs kea-admin to lease-dump the DHCPv4 leases. Incompatible
74           with the -6 option.
75
76       -6
77           Directs kea-admin to lease-dump the DHCPv6 leases. Incompatible
78           with the -4 option.
79

SEE ALSO

81       keactrl(8), kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-
82       agent(8), kea-netconf(8), keactrl(8), perfdhcp(8), Kea Administrator
83       Guide.
84

AUTHOR

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

94       Copyright © 2014-2018 Internet Systems Consortium, Inc. ("ISC")
95
96
97
98ISC Kea 1.5.0                    Dec 14, 2018                     KEA-ADMIN(8)
Impressum