From 9be48a42538b7ea263280f9f58e492e65563f26d Mon Sep 17 00:00:00 2001 From: Piotrek Zadroga Date: Tue, 17 Jun 2025 09:04:59 +0200 Subject: [PATCH] [#3940] ARM doc update --- doc/sphinx/arm/shell.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/sphinx/arm/shell.rst b/doc/sphinx/arm/shell.rst index 25b6058a88..53d2a18c6f 100644 --- a/doc/sphinx/arm/shell.rst +++ b/doc/sphinx/arm/shell.rst @@ -40,7 +40,7 @@ Shell Usage .. code-block:: console - $ kea-shell [--host hostname] [--port number] [--path path] [--auth-user] [--auth-password] [--timeout seconds] [--service service-name] [command] + $ kea-shell [--host hostname] [--port number] [--path path] [--auth-user] [--auth-password] [--auth-password-file] [--timeout seconds] [--service service-name] [command] where: @@ -60,6 +60,11 @@ where: - ``--auth-password`` specifies the password for basic HTTP authentication. If not specified but the user ID is specified, an empty password is used. + If used together with ``--auth-password-file``, it is disregarded. + +- ``--auth-password-file`` specifies a file which first line will be read to + retrieve the password for basic HTTP authentication. This flag takes precedence + over ``--auth-password`` flag. - ``--timeout seconds`` specifies the timeout (in seconds) for the connection. If not given, 10 seconds is used. @@ -95,7 +100,7 @@ The following shows a simple example of usage: .. code-block:: console - $ kea-shell --host 192.0.2.1 --port 8001 --service dhcp4 list-commands + $ kea-shell --host 192.0.2.1 --port 8001 --auth-user foo --auth-password-file secret_file --service dhcp4 list-commands ^D After the command line is entered, the program waits for command -- 2.47.2