diff options
| author | srividya0208 <a.srividya@vyos.io> | 2021-05-28 12:48:50 -0400 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2021-05-28 20:02:31 +0200 |
| commit | 89920c27fafc899ac36cca399f987d05a98a1c25 (patch) | |
| tree | 8e7b573a1ffdb5c06d45a33656015052cef55c8e | |
| parent | 6962d002df6f640161ed5b2bb2d29ad98606f478 (diff) | |
| download | vyos-documentation-89920c27fafc899ac36cca399f987d05a98a1c25.tar.gz vyos-documentation-89920c27fafc899ac36cca399f987d05a98a1c25.zip | |
system:syslog: added delete log file section
Added a help section for the "delete log file" command
(cherry picked from commit 041e8e07a460ed7b9d78fab42115fe5c7a8c9c50)
| -rw-r--r-- | docs/configuration/system/syslog.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/configuration/system/syslog.rst b/docs/configuration/system/syslog.rst index 9f3e1a28..9180ad97 100644 --- a/docs/configuration/system/syslog.rst +++ b/docs/configuration/system/syslog.rst @@ -26,6 +26,7 @@ Log syslog messages to ``/dev/console``, for an explanation on :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords see tables below. +.. _custom-file: Custom File ----------- @@ -222,3 +223,21 @@ allowed parameters: When no options/parameters are used, the contents of the main syslog file are displayed. + + +.. hint:: Use ``show log | strip-private`` if you want to hide private data + when sharing your logs. + +Delete Logs +=========== + +.. opcmd:: delete log file <text> + +Deletes the specified user-defined file <text> in the /var/log/user directory + +Note that deleting the log file does not stop the system from logging events. +If you use this command while the system is logging events, old log events +will be deleted, but events after the delete operation will be recorded in +the new file. To delete the file altogether, first delete logging to the +file using system syslog :ref:`custom-file` command, and then delete the file. + |