mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-01 22:45:18 +00:00
Code Issues Releases Wiki Activity

[#2232] Text edits

Browse Source
This commit is contained in:
Suzanne Goldlust
2021-12-08 19:26:53 +00:00
committed by Thomas Markwalder
parent b1dd255737
commit a3d53f1ff1
1 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/sphinx/man/kea-admin.8.rst
View File

@@ -20,9 +20,9 @@ Synopsis
Description Description
~~~~~~~~~~~ ~~~~~~~~~~~
``kea-admin`` is a shell script which offers database maintenance. In ``kea-admin`` is a shell script that offers database maintenance. In
particular, it features database initialization, database version particular, it features database initialization, database version
checking, and database schema upgrade. checking, and database schema upgrading.
Arguments Arguments
~~~~~~~~~ ~~~~~~~~~
@@ -30,64 +30,64 @@ Arguments
``command`` ``command``
Specifies the command to be issued to the servers. It can be one of the following: Specifies the command to be issued to the servers. It can be one of the following:
**db-init** ``db-init``
Initializes a new database schema. This is useful during a new Kea Initializes a new database schema. This is useful during a new Kea
installation. The database is initialized to the latest version installation. The database is initialized to the latest version
supported by the version of the software being installed. supported by the version of the software being installed.
**db-version** ``db-version``
Reports the database backend version number. This is not necessarily Reports the database backend version number. This is not necessarily
equal to the Kea version number as each backend has its own equal to the Kea version number, as each backend has its own
versioning scheme. versioning scheme.
**db-upgrade** ``db-upgrade``
Conducts a database schema upgrade. This is useful when upgrading Kea. Conducts a database schema upgrade. This is useful when upgrading Kea.
**lease-dump** ``lease-dump``
Dumps the contents of the lease database (for MySQL, PostgreSQL, Dumps the contents of the lease database (for MySQL or PostgreSQL
or CQL backends) to a CSV (comma-separated values) text file. backends) to a CSV (comma-separated values) text file. (Support for
the Cassandra backend has been deprecated.)
The first line of the file contains the column names. This is meant The first line of the file contains the column names. This is meant
to be used as a diagnostic tool, so it provides a portable, to be used as a diagnostic tool, so it provides a portable,
human-readable form of the lease data. human-readable form of the lease data.
**stats-recount** ``stats-recount``
Recounts lease statistics for MySQL or PostgreSQL database. Recounts lease statistics for a MySQL or PostgreSQL database.
``backend`` ``backend``
Specifies the backend type. Currently allowed backends are: memfile, Specifies the backend type. Currently allowed backends are: memfile,
mysql, pgsql, and cql. mysql, and pgsql; cql has been deprecated.
``-h|--host hostname`` ``-h|--host hostname``
Specifies the hostname when connecting to a database. If not specified, Specifies the hostname when connecting to a database.
the default value of **localhost** is used. The default value is ``localhost``.
``-P|--port port`` ``-P|--port port``
Specifies the port when connecting to a database. If not specified, Specifies the port when connecting to a database. If not specified,
the default value chosen by the database client is used. the default value chosen by the database client is used.
``-u|--user username`` ``-u|--user username``
Specifies the username when connecting to a database. If not specified, Specifies the username when connecting to a database.
the default value of **keatest** is used. The default value is **keatest**.
``-p|--password password`` ``-p|--password password``
Specifies the password when connecting to a database. Specifies the password when connecting to a database.
If only ``-p`` or ``--password`` is given, the user is prompted for a password. If only ``-p`` or ``--password`` is given, the user is prompted for a password.
If not specified at all, the **KEA_ADMIN_DB_PASSWORD** environment variable If not specified at all, the ``KEA_ADMIN_DB_PASSWORD`` environment variable
is checked for a value and used if it exists. is checked for a value and used if it exists.
Otherwise the default value of **keatest** is used. Otherwise the default value of ``keatest`` is used.
``-n|--name database-name`` ``-n|--name database-name``
Specifies the name of the database to connect to. If not specified, the Specifies the name of the database to connect to. The
default value of **keatest** is used. default value is ``keatest``.
``-d|--directory script-directory`` ``-d|--directory script-directory``
Specifies the override scripts directory. That script is used during Specifies the override scripts directory. That script is used during
upgrades, database initialization, and possibly other operations. If upgrades, database initialization, and possibly other operations.
not specified, the default value of ``(prefix)/share/kea/scripts/`` is The default value is ``(prefix)/share/kea/scripts/``.
used.
``-o|--output output_file`` ``-o|--output output_file``
Specifies the file to which the lease data will be dumped. Required for lease-dump. Specifies the file to which the lease data will be dumped. Required for ``lease-dump``.
``-v|--version`` ``-v|--version``
Prints the ``kea-admin`` version and quits. Prints the ``kea-admin`` version and quits.