summaryrefslogtreecommitdiff
path: root/docs/ch12-system.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2018-10-04 09:26:23 +0200
committerChristian Poessinger <christian@poessinger.com>2018-10-04 09:26:23 +0200
commit7648348fe3348f30fee6a6cb4d7411fdbd637149 (patch)
tree03f4fa09527062d2cae7296d28614046c4debde1 /docs/ch12-system.rst
parent6e9b6715684d1e7dab91ebede989254e723cbe06 (diff)
downloadvyos-documentation-7648348fe3348f30fee6a6cb4d7411fdbd637149.tar.gz
vyos-documentation-7648348fe3348f30fee6a6cb4d7411fdbd637149.zip
System: Move Syslog down one hirachy level
Diffstat (limited to 'docs/ch12-system.rst')
-rw-r--r--docs/ch12-system.rst42
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/ch12-system.rst b/docs/ch12-system.rst
index 0a02944f..831d0a90 100644
--- a/docs/ch12-system.rst
+++ b/docs/ch12-system.rst
@@ -67,28 +67,25 @@ remote system:
loadkey jsmith scp://devuser@dev001.vyos.net/home/devuser/.ssh/dev.pub
Syslog
-======
-
-Per default vyos has minimal syslog logging enabled which is stored and rotated locally.
-Errors will be always logged to a local file, which includes local7 error messages, emergency messages will be sent to the console too.
+------
-Configuration
--------------
+Per default VyOSs has minimal syslog logging enabled which is stored and
+rotated locally. Errors will be always logged to a local file, which includes
+`local7` error messages, emergency messages will be sent to the console, too.
To configure syslog, you need to switch into configuration mode.
-
Logging to serial console
^^^^^^^^^^^^^^^^^^^^^^^^^
-The below would log all messages to /dev/console.
+The below would log all messages to :code:`/dev/console`.
.. code-block:: sh
set system syslog console facility all level all
-
-Use the <tab> function to display all facilities and levels which can be configured.
+Use the **[tab]** function to display all facilities and levels which can
+be configured.
.. code-block:: sh
@@ -130,26 +127,30 @@ Use the <tab> function to display all facilities and levels which can be configu
debug Debug messages
all Log everything
+
Logging to a custom file
^^^^^^^^^^^^^^^^^^^^^^^^^
-Logging to a custom file, rotation size and the number of rotate files left on the system can be configured.
+Logging to a custom file, rotation size and the number of rotate files left
+on the system can be configured.
.. code-block:: sh
- set system syslog file <FILENAME> facility <FACILITY> level <LEVEL>
+ set system syslog file <FILENAME> facility <FACILITY> level <LEVEL>
set system syslog file <FILENAME> archive file <NUMBER OF FILES>
set system syslog file FILENAME archive size <FILESIZE>
-The very same setting can be applied to the global configuration, to modify the defaults for the global logging.
+The very same setting can be applied to the global configuration, to modify
+the defaults for the global logging.
Logging to a remote host
^^^^^^^^^^^^^^^^^^^^^^^^
-Logging to a remote host leaves the local logging configuration intact, it can be configured in parallel.
-You can log ro multiple hosts at the same time, using either tcp or udp. The default is sending the messages via udp.
+Logging to a remote host leaves the local logging configuration intact, it
+can be configured in parallel. You can log ro multiple hosts at the same time,
+using either TCP or UDP. The default is sending the messages via UDP.
-**Logging to a remote host using udp**
+**UDP**
.. code-block:: sh
@@ -158,21 +159,20 @@ You can log ro multiple hosts at the same time, using either tcp or udp. The def
set system syslog host 10.1.1.1 facility all protocol udp
-**Logging to a remote host using tcp**
+**TCP**
.. code-block:: sh
set system syslog host 10.1.1.2 facility all level all
set system syslog host 10.1.1.2 facility all protocol tcp
-
Logging to a local user account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If logging to a local useraccount is configured, all defined log messages are display on the console if the local user is logged in,
-if the user is not logged in, no messages are being displayed.
+If logging to a local useraccount is configured, all defined log messages are
+display on the console if the local user is logged in, if the user is not
+logged in, no messages are being displayed.
.. code-block:: sh
set system syslog user <LOCAL_USERNAME> facility <FACILITY> level <LEVEL>
-