summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDonald Sharp <sharpd@cumulusnetworks.com>2019-01-29 08:54:57 -0500
committerDonald Sharp <sharpd@cumulusnetworks.com>2019-05-31 10:06:42 -0400
commit80d02adbb01fcdbd37ea0773129b3d4fdf6c5217 (patch)
tree0ffde46d8b7a8c01f17bf6df6b66609905c39965
parent2950f5da55af16c8efd1ca24f714e9d69c602503 (diff)
doc: Add doc for new configure option
Add documentation for the '--command-log-always' daemon cli and how to use it. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
-rw-r--r--doc/user/basic.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/user/basic.rst b/doc/user/basic.rst
index 3df60169f7..bc9a7d6431 100644
--- a/doc/user/basic.rst
+++ b/doc/user/basic.rst
@@ -180,13 +180,14 @@ Basic Config Commands
In this example, the precision is set to provide timestamps with
millisecond accuracy.
-.. index:: log commands
-.. clicmd:: log commands
+.. index:: [no] log commands
+.. clicmd:: [no] log commands
This command enables the logging of all commands typed by a user to all
enabled log destinations. The note that logging includes full command lines,
- including passwords. Once set, command logging can only be turned off by
- restarting the daemon.
+ including passwords. If the daemon startup option `--command-log-always`
+ is used to start the daemon then this command is turned on by default
+ and cannot be turned off and the [no] form of the command is dissallowed.
.. index:: service password-encryption
.. clicmd:: service password-encryption
@@ -482,6 +483,13 @@ These options apply to all |PACKAGE_NAME| daemons.
Print program version.
+.. option:: --command-log-always
+
+ Cause the daemon to always log commands entered to the specified log file.
+ This also makes the `no log commands` command dissallowed. Enabling this
+ is suggested if you have need to track what the operator is doing on
+ this router.
+
.. option:: --log <stdout|syslog|file:/path/to/log/file>
When initializing the daemon, setup the log to go to either stdout,