kibana/docs/user/commands/kibana-verification-code.asciidoc
Adam Locke 2660e147bc
[DOCS] Add kibana-verification-tool and CLI main page (#120836)
* [DOCS] Add kibana-verification-tool and CLI main page

* Change wording from generating to retrieving
2021-12-09 11:57:25 -05:00

44 lines
No EOL
1.1 KiB
Text
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[[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 dont 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
----