diff --git a/docs/user/commands/cli-commands.asciidoc b/docs/user/commands/cli-commands.asciidoc new file mode 100644 index 000000000000000..35a25235bc23850 --- /dev/null +++ b/docs/user/commands/cli-commands.asciidoc @@ -0,0 +1,8 @@ +[[cli-commands]] +== Command line tools + +{kib} provides the following tools for configuring security and performing other tasks from the command line: + +* <> + +include::kibana-verification-code.asciidoc[] \ No newline at end of file diff --git a/docs/user/commands/kibana-verification-code.asciidoc b/docs/user/commands/kibana-verification-code.asciidoc new file mode 100644 index 000000000000000..3ad1b0da51e2bd4 --- /dev/null +++ b/docs/user/commands/kibana-verification-code.asciidoc @@ -0,0 +1,44 @@ +[[kibana-verification-code]] +=== kibana-verification-code + +The `kibana-verification-code` tool retrieves a verification code for enrolling +a {kib} instance with a secured {es} cluster. + +[discrete] +==== Synopsis + +[source,shell] +---- +bin/kibana-verification-code +[-V, --version] [-h, --help] +---- + +[discrete] +==== Description + +Use this command to retrieve a verification code for {kib}. You enter this code +in {kib} when manually configuring a secure connection with an {es} cluster. +This tool is useful if you don’t have access to the {kib} terminal output, such +as on a hosted environment. You can connect to a machine where {kib} is +running (such as using SSH) and retrieve a verification code that you enter in +{kib}. + +IMPORTANT: You must run this tool on the same machine where {kib} is running. + +[discrete] +[[kibana-verification-code-parameters]] +==== Parameters + +`-h, --help`:: Returns all of the command parameters. + +`-V, --version`:: Displays the {kib} version number. + +[discrete] +==== Examples + +The following command retrieves a verification code for {kib}. + +[source,shell] +---- +bin/kibana-verification-code +---- \ No newline at end of file diff --git a/docs/user/setup.asciidoc b/docs/user/setup.asciidoc index 546cc8f9748652d..87213249e0d97cf 100644 --- a/docs/user/setup.asciidoc +++ b/docs/user/setup.asciidoc @@ -70,3 +70,5 @@ include::monitoring/configuring-monitoring.asciidoc[leveloffset=+1] include::monitoring/monitoring-metricbeat.asciidoc[leveloffset=+2] include::monitoring/viewing-metrics.asciidoc[leveloffset=+2] include::monitoring/monitoring-kibana.asciidoc[leveloffset=+2] + +include::commands/cli-commands.asciidoc[]