Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
KEA-ADMIN(8)			      Kea			  KEA-ADMIN(8)

NAME
       kea-admin - Shell script	for managing Kea databases

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

DESCRIPTION
       kea-admin  is a shell script which offers database maintenance. In par-
       ticular,	it features database initialization, database  version	check-
       ing, and	database schema	upgrade.

ARGUMENTS
       command
	      Specifies	the command to be issued to the	servers. It can	be one
	      of the following:

	      db-init
		     Initializes a new database	schema.	This is	useful	during
		     a	new  Kea  installation.	The database is	initialized to
		     the latest	version	supported by the version of the	 soft-
		     ware being	installed.

	      db-version
		     Reports  the database backend version number. This	is not
		     necessarily equal to the Kea version number as each back-
		     end has its own versioning	scheme.

	      db-upgrade
		     Conducts  a  database schema upgrade. This	is useful when
		     upgrading Kea.

	      lease-dump
		     Dumps the contents	of  the	 lease	database  (for	MySQL,
		     PostgreSQL,  or  CQL  backends) to	a CSV (comma-separated
		     values) text file.	 The first line	of the	file  contains
		     the  column names.	This is	meant to be used as a diagnos-
		     tic tool, so it provides a	portable, human-readable  form
		     of	the lease data.

	      stats-recount
		     Recounts  lease  statistics for MySQL or PostgreSQL data-
		     base.

       backend
	      Specifies	the backend type. Currently allowed backends are: mem-
	      file, mysql, and pgsql.

       -u|--user username
	      Specifies	 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 name of the database to connect to. If not	speci-
	      fied, the	default	value of keatest is used.

       -d|--directory script-directory
	      Specifies	the override scripts directory.	That  script  is  used
	      during upgrades, database	initialization,	and possibly other op-
	      erations.	 If  not  specified,  the  default  value   of	 (pre-
	      fix)/share/kea/scripts/ is used.

       -o|--output output_file
	      Specifies	 the  file to which the	lease data will	be dumped. Re-
	      quired for lease-dump.

       -v|--version
	      Prints the kea-admin version and quits.

       -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.

DOCUMENTATION
       Kea comes with an extensive Kea	Administrator  Reference  Manual  that
       covers all aspects of running the Kea software -	compilation, installa-
       tion, configuration, configuration examples, and	much  more.  Kea  also
       features	 a  Kea	Messages Manual, which lists all possible messages Kea
       can print with a	brief description for each of them. Both documents are
       available in various formats (.txt, .html, .pdf)	with the Kea distribu-
       tion.	 The	 Kea	  documentation	     is	     available	    at
       https://kb.isc.org/docs/kea-administrator-reference-manual .

       Kea  source code	is documented in the Kea Developer's Guide. Its	online
       version is available at https://jenkins.isc.org/job/Kea_doc/doxygen/.

       The Kea project website is available at https://kea.isc.org.

MAILING	LISTS AND SUPPORT
       There are two public mailing  lists  available  for  the	 Kea  project.
       kea-users (kea-users at lists.isc.org) is intended for Kea users, while
       kea-dev (kea-dev	at lists.isc.org)  is  intended	 for  Kea  developers,
       prospective  contributors,  and	other  advanced	 users.	Both lists are
       available at https://lists.isc.org. The community provides  best-effort
       support on both of those	lists.

       ISC    provides	  professional	 support   for	 Kea   services.   See
       https://www.isc.org/kea/	for details.

SEE ALSO
       kea-dhcp4(8), kea-dhcp6(8), kea-dhcp-ddns(8), kea-ctrl-agent(8),	 keac-
       trl(8),	perfdhcp(8),  kea-netconf(8), Kea Administrator	Reference Man-
       ual.

AUTHOR
       Internet	Systems	Consortium

COPYRIGHT
       2019-2020, Internet Systems Consortium

1.8.1				 Nov 06, 2020			  KEA-ADMIN(8)

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | DOCUMENTATION | MAILING LISTS AND SUPPORT | SEE ALSO | AUTHOR | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=kea-admin&sektion=8&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help