summaryrefslogtreecommitdiff
path: root/docs/configuration/system
diff options
context:
space:
mode:
authorLiudmylaNad <l.nadolina@vyos.io>2026-08-04 11:54:54 +0200
committerGitHub <noreply@github.com>2026-08-04 10:54:54 +0100
commit873a388fdb5faeb869881cc780de16c96385e433 (patch)
treea45874674c10ef5611e39b040ecc01ec48f8911b /docs/configuration/system
parent2ea0928fc0277eacb208765ab119055908b8e184 (diff)
downloadvyos-documentation-873a388fdb5faeb869881cc780de16c96385e433.tar.gz
vyos-documentation-873a388fdb5faeb869881cc780de16c96385e433.zip
docs: fix MyST roles used inside eval-rst blocks (#2125)sagitta
* docs: fix MyST roles used inside eval-rst blocks * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/configuration/system')
-rw-r--r--docs/configuration/system/flow-accounting.md2
-rw-r--r--docs/configuration/system/frr.md2
-rw-r--r--docs/configuration/system/lcd.md2
-rw-r--r--docs/configuration/system/login.md2
-rw-r--r--docs/configuration/system/syslog.md33
5 files changed, 21 insertions, 20 deletions
diff --git a/docs/configuration/system/flow-accounting.md b/docs/configuration/system/flow-accounting.md
index 9b328fff..5e693100 100644
--- a/docs/configuration/system/flow-accounting.md
+++ b/docs/configuration/system/flow-accounting.md
@@ -113,7 +113,7 @@ exported them to a collection server.
* **5** - Most common version, but restricted to IPv4 flows only
* **9** - NetFlow version 9 (default)
- * **10** - {abbr}`IPFIX (IP Flow Information Export)` as per {rfc}`3917`
+ * **10** - :abbr:`IPFIX (IP Flow Information Export)` as per :rfc:`3917`
```
```{eval-rst}
diff --git a/docs/configuration/system/frr.md b/docs/configuration/system/frr.md
index 37e6e502..905cead0 100644
--- a/docs/configuration/system/frr.md
+++ b/docs/configuration/system/frr.md
@@ -9,7 +9,7 @@ but require either a restart of the routing daemon, or a reboot of the system.
```{eval-rst}
.. cfgcmd:: set system frr bmp
- Enable {abbr}`BMP (BGP Monitoring Protocol)` support
+ Enable :abbr:`BMP (BGP Monitoring Protocol)` support
```
```{eval-rst}
diff --git a/docs/configuration/system/lcd.md b/docs/configuration/system/lcd.md
index 1956c73b..770f3b71 100644
--- a/docs/configuration/system/lcd.md
+++ b/docs/configuration/system/lcd.md
@@ -20,7 +20,7 @@ connectivity of the display to your system. This can be any serial port
display. Tab completion is supported and it will list you all available
serial interface.
- For serial via USB port information please refor to: {ref}`hardware_usb`.
+ For serial via USB port information please refer to: :ref:`hardware_usb`.
```
```{eval-rst}
diff --git a/docs/configuration/system/login.md b/docs/configuration/system/login.md
index 562ed419..6010a0ec 100644
--- a/docs/configuration/system/login.md
+++ b/docs/configuration/system/login.md
@@ -65,7 +65,7 @@ lines. Be attentive when you paste it that it only pastes as a single line.
The third part is simply an identifier, and is for your own reference.
```{eval-rst}
-.. seealso:: SSH {ref}`ssh_operation`
+.. seealso:: SSH :ref:`ssh_operation`
```
```{eval-rst}
diff --git a/docs/configuration/system/syslog.md b/docs/configuration/system/syslog.md
index b4335c22..17acf186 100644
--- a/docs/configuration/system/syslog.md
+++ b/docs/configuration/system/syslog.md
@@ -20,7 +20,7 @@ server which is reached via {abbr}`IP (Internet Protocol)` UDP/TCP.
.. cfgcmd:: set system syslog console facility <keyword> level <keyword>
Log syslog messages to ``/dev/console``, for an explanation on
- {ref}`syslog_facilities` keywords and {ref}`syslog_severity_level` keywords
+ :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords
see tables below.
```
@@ -32,7 +32,7 @@ server which is reached via {abbr}`IP (Internet Protocol)` UDP/TCP.
.. cfgcmd:: set system syslog file <filename> facility <keyword> level <keyword>
Log syslog messages to file specified via `<filename>`, for an explanation on
- {ref}`syslog_facilities` keywords and {ref}`syslog_severity_level` keywords
+ :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords
see tables below.
```
@@ -65,7 +65,7 @@ sending the messages via port 514/UDP.
Log syslog messages to remote host specified by `<address>`. The address
can be specified by either FQDN or IP address. For an explanation on
- {ref}`syslog_facilities` keywords and {ref}`syslog_severity_level`
+ :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level`
keywords see tables below.
```
@@ -82,7 +82,7 @@ sending the messages via port 514/UDP.
```{eval-rst}
.. cfgcmd:: set system syslog vrf <name>
- Specify name of the {abbr}`VRF (Virtual Routing and Forwarding)` instance.
+ Specify name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance.
```
#### {abbr}`TLS (Transport Layer Security)`-encrypted remote logging
@@ -90,8 +90,9 @@ sending the messages via port 514/UDP.
VyOS supports {abbr}`TLS (Transport Layer Security)`-encrypted remote logging
over TCP to ensure secure transmission of syslog data to remote syslog servers.
-**Prerequisites**: Before configuring {abbr}`TLS (Transport Layer
-Security)`-encrypted remote logging, ensure you have:
+**Prerequisites**: Before configuring
+{abbr}`TLS (Transport Layer Security)`-encrypted remote logging,
+ensure you have:
- A valid remote syslog server address.
@@ -118,12 +119,12 @@ Security)`-encrypted remote logging, ensure you have:
```{eval-rst}
.. cfgcmd:: set system syslog remote <address> tls ca-certificate <ca_name>
- **Configure the** {abbr}`CA (Certificate Authority)` **certificate.**
+ **Configure the** :abbr:`CA (Certificate Authority)` **certificate.**
- The syslog client uses the {abbr}`CA (Certificate Authority)` certificate to
+ The syslog client uses the :abbr:`CA (Certificate Authority)` certificate to
verify the identity of the remote syslog server.
- The {abbr}`CA (Certificate Authority)` certificate is required for **all**
+ The :abbr:`CA (Certificate Authority)` certificate is required for **all**
authentication modes except ``anon``.
```
@@ -152,7 +153,7 @@ Security)`-encrypted remote logging, ensure you have:
* ``anon`` **(default)**: Allows encrypted connections without verifying the syslog
server's identity. This mode is **not recommended**, as it is vulnerable to
- {abbr}`MITM (Man-in-the-Middle)` attacks.
+ :abbr:`MITM (Man-in-the-Middle)` attacks.
* ``fingerprint``: Verifies the server’s certificate fingerprint against the
value preconfigured with:
@@ -161,12 +162,12 @@ Security)`-encrypted remote logging, ensure you have:
set system syslog remote <address> tls permitted-peer <peer>
* ``certvalid``: Verifies the server certificate is signed by a trusted
- {abbr}`CA (Certificate Authority)`, skipping {abbr}`CN (Common Name)` check.
+ :abbr:`CA (Certificate Authority)`, skipping :abbr:`CN (Common Name)` check.
* ``name``: Verifies that:
- * The server’s certificate is signed by a trusted {abbr}`CA (Certificate
- Authority)`.
- * The {abbr}`CN (Common Name)` in the certificate matches the value
+ * The server’s certificate is signed by a trusted
+ :abbr:`CA (Certificate Authority)`.
+ * The :abbr:`CN (Common Name)` in the certificate matches the value
preconfigured with:
.. code-block:: none
@@ -185,7 +186,7 @@ Security)`-encrypted remote logging, ensure you have:
* ``fingerprint``: Enter the expected certificate fingerprints (SHA-1 or
SHA-256).
- * ``name``: Enter the expected certificate {abbr}`CNs (Common Names)`.
+ * ``name``: Enter the expected certificate :abbr:`CNs (Common Names)`.
For ``anon`` and ``certvalid`` authentication modes, certificate identifiers
are not required.
@@ -243,7 +244,7 @@ set system syslog host graylog.example.com tls permitted-peer 'graylog.example.c
If logging to a local user account 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. For an explanation on
- {ref}`syslog_facilities` keywords and {ref}`syslog_severity_level` keywords
+ :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords
see tables below.
```