summaryrefslogtreecommitdiff
path: root/docs/configuration/system
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/system')
-rw-r--r--docs/configuration/system/ip.rst14
-rw-r--r--docs/configuration/system/login.rst7
-rw-r--r--docs/configuration/system/option.rst15
-rw-r--r--docs/configuration/system/syslog.rst31
4 files changed, 61 insertions, 6 deletions
diff --git a/docs/configuration/system/ip.rst b/docs/configuration/system/ip.rst
index a422388f..27b0870c 100644
--- a/docs/configuration/system/ip.rst
+++ b/docs/configuration/system/ip.rst
@@ -27,6 +27,20 @@ System configuration commands
Use this command to use Layer 4 information for IPv4 ECMP hashing.
+.. cfgcmd:: set system ip import-table <table-id>
+
+ Use this command to immport the table, by given table id, into the main RIB.
+
+.. cfgcmd:: set system ip import-table <table-id> distance <distance>
+
+ Use this command to override the default distance when importing routers
+ from the alternate table.
+
+.. cfgcmd:: set system ip import-table <table-id> route-map <route-map>
+
+ Use this command to filter routes that are imported into the main table
+ from alternate table using route-map.
+
Zebra/Kernel route filtering
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/configuration/system/login.rst b/docs/configuration/system/login.rst
index 3a7481eb..1c4e041d 100644
--- a/docs/configuration/system/login.rst
+++ b/docs/configuration/system/login.rst
@@ -34,6 +34,13 @@ Local
Setup encrypted password for given username. This is useful for
transferring a hashed password from system to system.
+.. cfgcmd:: set system login user <name> authentication principal <principal>
+
+ When using SSH certificate based authentication, define which principals are
+ alled to use this account.
+
+ If unset, the principal will be set to the login name of the user bz default.
+
.. cfgcmd:: set system login user <name> disable
Disable (lock) account. User will not be able to log in.
diff --git a/docs/configuration/system/option.rst b/docs/configuration/system/option.rst
index b5ebaaee..a13e38a8 100644
--- a/docs/configuration/system/option.rst
+++ b/docs/configuration/system/option.rst
@@ -18,6 +18,16 @@ General
Automatically reboot system on kernel panic after 60 seconds.
+.. cfgcmd:: set system option reboot-on-upgrade-failure <timeout>
+
+ Automatically reboot after `timeout` minutes into the previous running
+ image, that was used to perform the image upgrade.
+
+ Reboot `timeout` is configurable in minutes. This gives the user the change
+ to log into the system and perform some analysis before automatic rebooting.
+
+ Automatic reboot can be cancelled after login using: :opcmd:`reboot cancel`
+
.. cfgcmd:: set system option startup-beep
Play an audible beep to the system speaker when system is ready.
@@ -72,6 +82,11 @@ Kernel
.. seealso:: https://docs.kernel.org/admin-guide/pm/amd-pstate.html
+.. cfgcmd:: set system option kernel quiet
+
+ Suppress most kernel messages during boot. This is useful for systems with
+ embedded serial console interfaces to speed up the boot process.
+
***********
HTTP client
***********
diff --git a/docs/configuration/system/syslog.rst b/docs/configuration/system/syslog.rst
index 41a65934..d266131d 100644
--- a/docs/configuration/system/syslog.rst
+++ b/docs/configuration/system/syslog.rst
@@ -20,18 +20,18 @@ server which is reached via :abbr:`IP (Internet Protocol)` UDP/TCP.
Global Settings
---------------
-.. cfgcmd:: system syslog marker interval <number>
+.. cfgcmd:: set system syslog marker interval <number>
Interval (in seconds) for sending mark messages to the syslog input to
indicate that the logging system is functioning.
This defaults to 1200 seconds.
-.. cfgcmd:: system syslog marker disable
+.. cfgcmd:: set system syslog marker disable
Disable periodic injection of mark messages.
-.. cfgcmd:: system syslog preserve-fqdn
+.. cfgcmd:: set system syslog preserve-fqdn
If set, the domain part of the hostname is always sent, even within the same
domain as the receiving system.
@@ -83,13 +83,32 @@ sending the messages via port 514/UDP.
Configure protocol used for communication to remote syslog host. This can be
either UDP or TCP.
+.. cfgcmd:: set system syslog remote <address> port <port>
+
+ Configure the TCP or UDP port to connect to on the remote syslog host.
+ By default, the standard port 514 is used.
+
.. cfgcmd:: set system syslog remote <address> format include-timezone
- Include system timezone in syslog message
+ Send syslog messages in the :rfc:`5424` format, rather than the
+ default :rfc:`3164` (BSD syslog) format.
+
+ .. note::
+ The :rfc:`5424` format utilises an :rfc:`3339` / ISO 8601 formatted
+ timestamp, including the system timezone.
+
+ Examples of the two syslog message formats:
+
+ :rfc:`3164` format: <34>Oct 11 22:14:15 mymachine su: 'su root' failed for lonvick on /dev/pts/8
+
+ :rfc:`5424` format: <34>1 2003-10-11T22:14:15.003-07:00 mymachine.example.com su - ID47 - BOM'su root' failed for lonvick on /dev/pts/8
.. cfgcmd:: set system syslog remote <address> format octet-counted
- Allows for the transmission of all characters inside a syslog message.
+ Allows for the transmission of multi-line messages, without them being split
+ across separate syslog messages. This only applies for the TCP protocol
+ (this setting is ignored for UDP protocol). Ensure the receiving system is
+ compatible before enabling this.
.. cfgcmd:: set system syslog remote <address> vrf <name>
@@ -164,7 +183,7 @@ Facilities can be adjusted to meet the needs of the user:
+----------+----------+----------------------------------------------------+
| 21 | local5 | local use 5 (local5) |
+----------+----------+----------------------------------------------------+
-| 22 | local6 | use 6 (local6) |
+| 22 | local6 | local use 6 (local6) |
+----------+----------+----------------------------------------------------+
| 23 | local7 | local use 7 (local7) |
+----------+----------+----------------------------------------------------+