diff options
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/boot-options.rst | 56 | ||||
| -rw-r--r-- | docs/system/eventhandler.rst | 48 | ||||
| -rw-r--r-- | docs/system/flowaccounting.rst | 81 | ||||
| -rw-r--r-- | docs/system/host-information.rst | 175 | ||||
| -rw-r--r-- | docs/system/index.rst | 25 | ||||
| -rw-r--r-- | docs/system/login-users.rst | 129 | ||||
| -rw-r--r-- | docs/system/ntp.rst | 19 | ||||
| -rw-r--r-- | docs/system/proxy.rst | 28 | ||||
| -rw-r--r-- | docs/system/serialconsole.rst | 17 | ||||
| -rw-r--r-- | docs/system/syslog.rst | 224 | ||||
| -rw-r--r-- | docs/system/system-dns.rst | 68 | ||||
| -rw-r--r-- | docs/system/task-scheduler.rst | 60 | ||||
| -rw-r--r-- | docs/system/time-zone.rst | 11 |
13 files changed, 0 insertions, 941 deletions
diff --git a/docs/system/boot-options.rst b/docs/system/boot-options.rst deleted file mode 100644 index 1070afa9..00000000 --- a/docs/system/boot-options.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _boot-options: - - -############ -Boot Options -############ - -.. warning:: This function may be highly disruptive. - It may cause major service interruption, so make sure you really - need it and verify your input carefully. - - - -VyOS has several kernel command line options to modify the normal boot -process. -To add an option, select the desired image in GRUB menu at load -time, press **e**, edit the first line, and press **Ctrl-x** to boot when -ready. - -.. image:: /_static/images/boot-options.png - :width: 80% - :align: center - - -Specify custom config file -========================== - -Tells the system to use specified file instead of ``/config/config.boot``. -If specified file does not exist or is not readable, fall back to -default config. No additional verification is performed, so make sure -you specify a valid config file. - -.. code-block:: none - - vyos-config=/path/to/file - -To load the *factory default* config, use: - -.. code-block:: none - - vyos-config=/opt/vyatta/etc/config.boot.default - - -Disable specific boot process steps -=================================== - -These options disable some boot steps. Make sure you understand the -:ref:`boot process <boot-steps>` well before using them! - -.. glossary:: - - no-vyos-migrate - Do not perform config migration. - - no-vyos-firewall - Do not initialize default firewall chains, renders any firewall configuration unusable. diff --git a/docs/system/eventhandler.rst b/docs/system/eventhandler.rst deleted file mode 100644 index 4421e79c..00000000 --- a/docs/system/eventhandler.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. _event-handler: - -Event Handler -------------- - -Event handler allows you to execute scripts when a string that matches a regex appears in a text stream (e.g. log file). - -It uses "feeds" (output of commands, or a named pipes) and "policies" that define what to execute if a regex is matched. - -.. code-block:: none - - system - event-handler - feed <name> - description <feed description> - policy <policy name> - source - preset - syslog # Use the syslog logs for feed - custom - command <command to execute> # E.g. "tail -f /var/log/somelogfile" - named-pipe <path to a names pipe> - policy <policy name> - description <policy description> - event <event name> - description <event description> - pattern <regex> - run <command to run> - -In this small example a script runs every time a login failed and an interface goes down - -.. code-block:: none - - vyos@vyos# show system event-handler - feed Syslog { - policy MyPolicy - source { - preset syslog - } - } - policy MyPolicy { - description "Test policy" - event BadThingsHappened { - pattern "authentication failure" - pattern "interface \.* index \d+ .* DOWN.*" - run /config/scripts/email-to-admin - } - }
\ No newline at end of file diff --git a/docs/system/flowaccounting.rst b/docs/system/flowaccounting.rst deleted file mode 100644 index 9c876001..00000000 --- a/docs/system/flowaccounting.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _flow-accounting: - -NetFlow is a feature that was introduced on Cisco routers around 1996 that -provides the ability to collect IP network traffic as it enters or exits an -interface. By analyzing the data provided by NetFlow, a network administrator -can determine things such as the source and destination of traffic, class of -service, and the causes of congestion. A typical flow monitoring setup (using -NetFlow) consists of three main components: - -* Flow exporter: aggregates packets into flows and exports flow records towards - one or more flow collectors -* Flow collector: responsible for reception, storage and pre-processing of flow - data received from a flow exporter -* Analysis application: analyzes received flow data in the context of intrusion - detection or traffic profiling, for example - -For connectionless protocols as like ICMP and UDP, a flow is considered complete -once no more packets for this flow appear after configurable timeout. - -NetFlow is usually enabled on a per-interface basis to limit load on the router -components involved in NetFlow, or to limit the amount of NetFlow records -exported. - -VyOS supports flow accounting through NetFlow (version 5, 9 and 10) or sFlow. - -Flow Accounting ---------------- - -In order for flow accounting information to be collected and displayed for an -interface, the interface must be configured for flow accounting. The following -example shows how to configure ``eth0`` and ``bond3`` for flow accounting. - -.. code-block:: none - - set system flow-accounting interface eth0 - set system flow-accounting interface bond3 - - -NetFlow is a protocol originating from Cisco Systems. It works on level3. -VyOS supports version 5, 9 and 10 (IPFIX - IP Flow Information Export) - -NetFlow v5 example: - -.. code-block:: none - - set system flow-accounting netflow engine-id 100 - set system flow-accounting netflow version 5 - set system flow-accounting netflow server 192.168.2.10 port 2055 - -Displaying Flow Accounting Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once flow accounting is configured on an interfaces it provides the ability to -display captured network traffic information for all configured interfaces. - -The following op-mode command shows flow accounting for eth0. - -.. code-block:: none - - vyos@vyos:~$ show flow-accounting interface eth0 - flow-accounting for [eth0] - Src Addr Dst Addr Sport Dport Proto Packets Bytes Flows - 0.0.0.0 192.0.2.50 811 811 udp 7733 591576 0 - 0.0.0.0 192.0.2.50 811 811 udp 7669 586558 1 - 192.0.2.200 192.0.2.51 56188 22 tcp 586 36504 1 - 192.0.2.99 192.0.2.51 61636 161 udp 46 6313 4 - 192.0.2.99 192.0.2.51 61638 161 udp 42 5364 9 - 192.0.2.99 192.0.2.51 61640 161 udp 42 5111 3 - 192.0.2.200 192.0.2.51 54702 22 tcp 86 4432 1 - 192.0.2.99 192.0.2.51 62509 161 udp 24 3540 1 - 192.0.2.99 192.0.2.51 0 0 icmp 49 2989 8 - 192.0.2.99 192.0.2.51 54667 161 udp 18 2658 1 - 192.0.2.99 192.0.2.51 54996 161 udp 18 2622 1 - 192.0.2.99 192.0.2.51 63708 161 udp 18 2622 1 - 192.0.2.99 192.0.2.51 62111 161 udp 18 2622 1 - 192.0.2.99 192.0.2.51 61646 161 udp 16 1977 4 - 192.0.2.99 192.0.2.51 56038 161 udp 10 1256 1 - 192.0.2.99 192.0.2.51 55570 161 udp 6 1146 1 - 192.0.2.99 192.0.2.51 54599 161 udp 6 1134 1 - 192.0.2.99 192.0.2.51 56304 161 udp 8 1029 1 - diff --git a/docs/system/host-information.rst b/docs/system/host-information.rst deleted file mode 100644 index 71209412..00000000 --- a/docs/system/host-information.rst +++ /dev/null @@ -1,175 +0,0 @@ -.. _host-information: - -Host Information ----------------- - -This section describes the system's host information and how to configure them, -it covers the following topics: - -* Host name -* Domain -* IP address -* Default gateway -* Aliases - -Host Name -^^^^^^^^^ - -A hostname is the label (name) assigned to a network device (a host) on a -network and is used to distinguish one device from another on specific networks -or over the internet. - -Set a system host name: - -.. code-block:: none - - set system host-name <hostname> - -.. note:: Only letters, numbers and hyphens are allowed. - -Show host name: - -.. code-block:: none - - show system host-name - -Delete host name: - -.. code-block:: none - - delete system host-name <hostname> - -Example: Set system hostname to 'RT01': - -.. code-block:: none - - set system host-name RT01 - commit - show system host-name - host-name RT01 - -Domain Name -^^^^^^^^^^^ - -A domain name is the label (name) assigned to a computer network and is thus -unique. - -Set the system's domain: - -.. code-block:: none - - set system domain-name <domain> - -.. note:: Only letters, numbers, hyphens and periods are allowed. - -Show domain: - -.. code-block:: none - - show system domain-name - -Remove domain name: - -.. code-block:: none - - set system delete domain-name <domain> - -Example: Set system domain to example.com: - -.. code-block:: none - - set system domain-name example.com - commit - show system domain-name - domain-name example.com - -Static host mappings -^^^^^^^^^^^^^^^^^^^^ - -How to assign IPs to interfaces is described in chapter -:ref:`interfaces-addresses`. This section shows how to statically map a system -IP to its host name for local (meaning on this VyOS instance) DNS resolution: - -.. code-block:: none - - set system static-host-mapping host-name <hostname> inet <IP address> - -Show static mapping: - -.. code-block:: none - - show system static-host-mapping - -Example: Create a static mapping between the system's hostname `RT01` and -IP address `10.20.30.41`: - -.. code-block:: none - - set system static-host-mapping host-name RT01 inet 10.20.30.41 - commit - show system static-host-mapping - host-name RT01 { - inet 10.20.30.41 - } - -Aliases -******* - -One or more system aliases (static mappings) can be defined: - -.. code-block:: none - - set system static-host-mapping host-name <hostname> alias <alias> - -Show aliases: - -.. code-block:: none - - show system static-mapping - -Delete alias: - -.. code-block:: none - - delete system static-host-mapping host-name <hostname> alias <alias> - -Example: Set alias `router1` for system with hostname `RT01`: - -.. code-block:: none - - set system static-host-mapping host-name RT01 alias router1 - commit - show system static-host-mapping - host-name RT01 { - alias router1 - inet 10.20.30.41 - } - -Default Gateway/Route -^^^^^^^^^^^^^^^^^^^^^ - -In the past (VyOS 1.1.8) used a gateway-address configured in the system tree -(`set system gateway-address <IP address>`) this is no longer supported and -existing configurations are migrated to the new CLI commands. - -It is replaced by inserting a static route into the routing table using: - -.. code-block:: none - - set protocols static route 0.0.0.0/0 next-hop <gateway ip> - -Delete the default route from the system - -.. code-block:: none - - delete protocols static route 0.0.0.0/0 - -Show default route: - -.. code-block:: none - - vyos@vyos$ show ip route 0.0.0.0 - Routing entry for 0.0.0.0/0 - Known via "static", distance 1, metric 0, best - Last update 3d00h23m ago - * 172.16.34.6, via eth1 diff --git a/docs/system/index.rst b/docs/system/index.rst deleted file mode 100644 index a0d470aa..00000000 --- a/docs/system/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _system: - -System -====== - -After a basic system setup by setting up :ref:`interfaces-addresses`, VyOS -should be ready for further configuration which is described in this chapter. - - -.. toctree:: - :maxdepth: 2 - :hidden: - - eventhandler - flowaccounting - host-information - login-users - ntp - proxy - serialconsole - syslog - system-dns - task-scheduler - time-zone - boot-options diff --git a/docs/system/login-users.rst b/docs/system/login-users.rst deleted file mode 100644 index c34e41a0..00000000 --- a/docs/system/login-users.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. _systemusers: - -Login ------ - -The default VyOS user account (`vyos`), as well as newly created user accounts, -have all capabilities to configure the system. All accounts have sudo capabilities -and therefore can operate as root on the system. Setting the level to admin is -optional, all accounts on the system will have admin privileges. - -Both local administered and remote administered RADIUS (Remote Authentication -Dial-In User Service) accounts are supported. - -Local -^^^^^ - -Create user account `jsmith` and the password `mypassword`. - -.. code-block:: none - - set system login user jsmith full-name "Johan Smith" - set system login user jsmith authentication plaintext-password mypassword - -The command: - -.. code-block:: none - - show system login - -will show the contents of :code:`system login` configuration node: - -.. code-block:: none - - user jsmith { - authentication { - encrypted-password $6$0OQHjuQ8M$AYXVn7jufdfqPrSk4/XXsDBw99JBtNsETkQKDgVLptXogHA2bU9BWlvViOFPBoFxIi.iqjqrvsQdQ./cfiiPT. - plaintext-password "" - } - full-name "Johan Smith" - level admin - } - -SSH with Public Keys -******************** - -The following command will load the public key `dev.pub` for user `jsmith` - -.. code-block:: none - - loadkey jsmith dev.pub - -.. note:: This requires uploading the `dev.pub` public key to the VyOS router - first. As an alternative you can also load the SSH public key directly - from a remote system: - -.. code-block:: none - - loadkey jsmith scp://devuser@dev001.vyos.net/home/devuser/.ssh/dev.pub - -In addition SSH public keys can be fully added using the CLI. Each key can be -given a unique identifier, `calypso` is used oin the example below to id an SSH -key. - -.. code-block:: none - - set system login user jsmith authentication public-keys callisto key 'AAAAB3Hso...Q==' - set system login user jsmith authentication public-keys callisto type 'ssh-rsa' - -RADIUS -^^^^^^ - -VyOS supports using one or more RADIUS servers as backend for user authentication. - -The following command sets up two servers for RADIUS authentication, one with a -discrete timeout of `5` seconds and a discrete port of `1812` and the other using -a default timeout and port. - -.. code-block:: none - - set system login radius-server 192.168.1.2 secret 's3cr3t0815' - set system login radius-server 192.168.1.2 timeout '5' - set system login radius-server 192.168.1.2 port '1812' - set system login radius-server 192.168.1.3 secret 's3cr3t0816' - -This configuration results in: - -.. code-block:: none - - show system login - radius-server 192.168.1.2 { - secret s3cr3t0815 - timeout 5 - port 1812 - } - radius-server 192.168.1.3 { - secret s3cr3t0816 - } - -.. note:: If you wan't to have admin users to authenticate via RADIUS it is - essential to sent the ``Cisco-AV-Pair shell:priv-lvl=15`` attribute. Without - the attribute you will only get regular, non privilegued, system users. - -Source Address -************** - -RADIUS servers could be hardened by only allowing certain IP addresses to connect. -As of this the source address of each RADIUS query can be configured. If this is -not set incoming connections to the RADIUS server will use the nearest interface -address pointing towards the RADIUS server - making it error prone on e.g. OSPF -networks when a link fails. - -.. code-block:: none - - set system login radius-source-address 192.168.1.254 - -Login Banner -^^^^^^^^^^^^ - -You are able to set post-login or pre-login messages with the following lines: - -.. code-block:: none - - set system login banner pre-login "UNAUTHORIZED USE OF THIS SYSTEM IS PROHIBITED\n" - set system login banner post-login "Welcome to VyOS" - -the **\\n** create a newline. - - - diff --git a/docs/system/ntp.rst b/docs/system/ntp.rst deleted file mode 100644 index 95ff0692..00000000 --- a/docs/system/ntp.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _ntp: - -NTP -=== - -there are 3 default NTP server set. You are able to change them. - -.. code-block:: none - - set system ntp server 0.pool.ntp.org - set system ntp server 1.pool.ntp.org - set system ntp server 2.pool.ntp.org - -To set up VyOS as an NTP responder, you must specify the listen address and optionally the permitted clients. - -.. code-block:: none - - set system ntp listen-address 192.168.199.1 - set system ntp allow-clients address 192.168.199.0/24 diff --git a/docs/system/proxy.rst b/docs/system/proxy.rst deleted file mode 100644 index f89794dd..00000000 --- a/docs/system/proxy.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _proxy: - -System Proxy -============ - -Some IT environments require the use of a proxy to connect to the Internet. -The option allowes to set a HTTP proxy and if necessary, supports `basic auth`_. - -The code example below sets a proxy for all HTTP, HTTPS and FTP (anonymous ftp) connections, initiated by vyos. - -.. code-block:: none - - set system proxy url http://10.100.100.1 - set system proxy port 8080 - -That enables the update of a system image if the vyos system operates behind a proxy. - -.. code-block:: none - - vyos@vyos:~$ add system image https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso - Trying to fetch ISO file from https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso - % Total % Received % Xferd Average Speed Time Time Time Current - Dload Upload Total Spent Left Speed - 1 413M 1 4479k 0 0 995k 0 0:07:04 0:00:04 0:07:00 995k - - - -.. _`basic auth`: https://tools.ietf.org/html/rfc7617 diff --git a/docs/system/serialconsole.rst b/docs/system/serialconsole.rst deleted file mode 100644 index 730c9da1..00000000 --- a/docs/system/serialconsole.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _serial-console: - -Serial console -============== - - - -Configuring Console -------------------- - -.. code-block:: none - - vyos@vyos# set system console - Possible completions: - +> device Serial console device name - +> network Network based console logging - powersave Enable screen blank powersaving on VGA console
\ No newline at end of file diff --git a/docs/system/syslog.rst b/docs/system/syslog.rst deleted file mode 100644 index 9f3e1a28..00000000 --- a/docs/system/syslog.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _syslog: - -###### -Syslog -###### - -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 -======= - -Syslog supports logging to multiple targets, those targets could be a plain -file on your VyOS installation itself, a serial console or a remote syslog -server which is reached via :abbr:`IP (Internet Protocol)` UDP/TCP. - -Console -------- - -.. 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 -see tables below. - - -Custom File ------------ - -.. cfgcmd:: set system syslog file <filename> facility <keyword> level <keyword> - -Log syslog messages to file specified via `<filename>`, for en explanation on -:ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords see -tables below. - -.. cfgcmd:: set system syslog file <filename> archive size <size> - -Syslog will write `<size>` kilobytes into the file specified by `<filename>`. -After this limit has been reached, the custom file is "rotated" by logrotate -and a new custom file is created. - -.. cfgcmd:: set system syslog file <filename> archive file <number> - -Syslog uses logrotate to rotate logiles after a number of gives bytes. We keep -as many as `<number>` rotated file before they are deleted on the system. - - -Remote Host ------------ - -Logging to a remote host leaves the local logging configuration intact, it -can be configured in parallel to a custom file or console logging. You can log -to multiple hosts at the same time, using either TCP or UDP. The default is -sending the messages via port 514/UDP. - - -.. cfgcmd:: set system syslog host <address> facility <keyword> level <keyword> - -Log syslog messages to remote host specified by `<address>`. The address can be -specified by either FQDN or IP address. For en explanation on -:ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords see -tables below. - - -.. cfgcmd:: set system syslog host <address> facility <keyword> protocol <udp|tcp> - -Configure protocol used for communication to remote syslog host. This can be -either UDP or TCP. - - -Local User Account ------------------- - -.. cfgcmd:: set system syslog user <username> facility <keyword> level <keyword> - -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 en explanation on -:ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords see -tables below. - -.. _syslog_facilities: - -Facilities -========== - -List of facilities used by syslog. Most facilities names are self explanatory. -Facilities local0 - local7 common usage is f.e. as network logs facilities for -nodes and network equipment. Generally it depends on the situation how to -classify logs and put them to facilities. See facilities more as a tool rather -than a directive to follow. - -Facilities can be adjusted to meet the needs of the user: - -+----------+----------+----------------------------------------------------+ -| Facility | Keyword | Description | -| Code | | | -+==========+==========+====================================================+ -| | all | All facilities | -+----------+----------+----------------------------------------------------+ -| 0 | kern | Kernel messages | -+----------+----------+----------------------------------------------------+ -| 1 | user | User-level messages | -+----------+----------+----------------------------------------------------+ -| 2 | mail | Mail system | -+----------+----------+----------------------------------------------------+ -| 3 | daemon | System daemons | -+----------+----------+----------------------------------------------------+ -| 4 | auth | Security/authentication messages | -+----------+----------+----------------------------------------------------+ -| 5 | syslog | Messages generated internally by syslogd | -+----------+----------+----------------------------------------------------+ -| 6 | lpr | Line printer subsystem | -+----------+----------+----------------------------------------------------+ -| 7 | news | Network news subsystem | -+----------+----------+----------------------------------------------------+ -| 8 | uucp | UUCP subsystem | -+----------+----------+----------------------------------------------------+ -| 9 | cron | Clock daemon | -+----------+----------+----------------------------------------------------+ -| 10 | security | Security/authentication messages | -+----------+----------+----------------------------------------------------+ -| 11 | ftp | FTP daemon | -+----------+----------+----------------------------------------------------+ -| 12 | ntp | NTP subsystem | -+----------+----------+----------------------------------------------------+ -| 13 | logaudit | Log audit | -+----------+----------+----------------------------------------------------+ -| 14 | logalert | Log alert | -+----------+----------+----------------------------------------------------+ -| 15 | clock | clock daemon (note 2) | -+----------+----------+----------------------------------------------------+ -| 16 | local0 | local use 0 (local0) | -+----------+----------+----------------------------------------------------+ -| 17 | local1 | local use 1 (local1) | -+----------+----------+----------------------------------------------------+ -| 18 | local2 | local use 2 (local2) | -+----------+----------+----------------------------------------------------+ -| 19 | local3 | local use 3 (local3) | -+----------+----------+----------------------------------------------------+ -| 20 | local4 | local use 4 (local4) | -+----------+----------+----------------------------------------------------+ -| 21 | local5 | local use 5 (local5) | -+----------+----------+----------------------------------------------------+ -| 22 | local6 | use 6 (local6) | -+----------+----------+----------------------------------------------------+ -| 23 | local7 | local use 7 (local7) | -+----------+----------+----------------------------------------------------+ - -.. _syslog_severity_level: - -Severity Level -============== - -+-------+---------------+---------+-------------------------------------------+ -| Value | Severity | Keyword | Description | -+=======+===============+=========+===========================================+ -| | | all | Log everything | -+-------+---------------+---------+-------------------------------------------+ -| 0 | Emergency | emerg | System is unusable - a panic condition | -+-------+---------------+---------+-------------------------------------------+ -| 1 | Alert | alert | Action must be taken immediately - A | -| | | | condition that should be corrected | -| | | | immediately, such as a corrupted system | -| | | | database. | -+-------+---------------+---------+-------------------------------------------+ -| 2 | Critical | crit | Critical conditions - e.g. hard drive | -| | | | errors. | -+-------+---------------+---------+-------------------------------------------+ -| 3 | Error | err | Error conditions | -+-------+---------------+---------+-------------------------------------------+ -| 4 | Warning | warning | Warning conditions | -+-------+---------------+---------+-------------------------------------------+ -| 5 | Notice | notice | Normal but significant conditions - | -| | | | conditions that are not error conditions, | -| | | | but that may require special handling. | -+-------+---------------+---------+-------------------------------------------+ -| 6 | Informational | info | Informational messages | -+-------+---------------+---------+-------------------------------------------+ -| 7 | Debug | debug | Debug-level messages - Messages that | -| | | | contain information normally of use only | -| | | | when debugging a program. | -+-------+---------------+---------+-------------------------------------------+ - - -Display Logs -============ - -.. opcmd:: show log [all | authorization | cluster | conntrack-sync | ...] - -Display log files of given category on the console. Use tab completion to get -a list of available categories. Thos categories could be: all, authorization, -cluster, conntrack-sync, dhcp, directory, dns, file, firewall, https, image -lldp, nat, openvpn, snmp, tail, vpn, vrrp - -If no option is specified, this defaults to `all`. - -.. opcmd:: show log image <name> [all | authorization | directory | file <file name> | tail <lines>] - -Log messages from a specified image can be displayed on the console. Details of -allowed parameters: - -.. list-table:: - :widths: 25 75 - :header-rows: 0 - - * - all - - Display contents of all master log files of the specified image - * - authorization - - Display all authorization attempts of the specified image - * - directory - - Display list of all user-defined log files of the specified image - * - file <file name> - - Display contents of a specified user-defined log file of the specified image - * - tail - - Display last lines of the system log of the specified image - * - <lines> - - Number of lines to be displayed, default 10 - -When no options/parameters are used, the contents of the main syslog file are -displayed. diff --git a/docs/system/system-dns.rst b/docs/system/system-dns.rst deleted file mode 100644 index 70848f6d..00000000 --- a/docs/system/system-dns.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. _system-dns: - -########## -System DNS -########## - - -This section describes configuring DNS on the system, namely: - - * DNS name servers - * Domain search order - - -DNS name servers -================ - -.. cfgcmd:: set system name-server <address> - - Use this command to specify a DNS server for the system to be used - for DNS lookups. More than one DNS server can be added, configuring - one at a time. Both IPv4 and IPv6 addresses are supported. - - - -Example -------- - -In this example, some *OpenNIC* servers are used, two IPv4 addresses -and two IPv6 addresses: - - -.. code-block:: none - - set system name-server 176.9.37.132 - set system name-server 195.10.195.195 - set system name-server 2a01:4f8:161:3441::1 - set system name-server 2a00:f826:8:2::195 - - -Domain search order -=================== - -In order for the system to use and complete unqualified host names, a -list can be defined which will be used for domain searches. - - -.. cfgcmd:: set system domain-search domain <domain> - - Use this command to define domains, one at a time, so that the system - uses them to complete unqualified host names. Maximum: 6 entries. - - -.. note:: Domain names can include letters, numbers, hyphens and periods - with a maximum length of 253 characters. - - -Example -------- - -The system is configured to attempt domain completion in the following -order: vyos.io (first), vyos.net (second) and vyos.network (last): - - -.. code-block:: none - - set system domain-search domain vyos.io - set system domain-search domain vyos.net - set system domain-search domain vyos.network diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst deleted file mode 100644 index 7fe49988..00000000 --- a/docs/system/task-scheduler.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. _task-scheduler: - - -Task scheduler --------------- - -| Task scheduler — allows scheduled task execution. Note that scripts excecuted this way are executed as root user - this may be dangerous. -| Together with :ref:`commandscripting` this can be used for automating configuration. - -.. code-block:: none - - system - task-scheduler - task <name> - cron-spec <UNIX cron time spec> - executable - arguments <arguments string> - path <path to executable> - interval - <int32>[mhd] - -Interval -******** - -You are able to set the time as an time interval. - -.. code-block:: none - - set system task-scheduler task <name> interval <value><suffix> - -Sets the task to execute every N minutes, hours, or days. Suffixes: - - * m — minutes - * h — hours - * d — days - -If suffix is omitted, minutes are implied. - -Or set the execution time in common cron time. - -.. code-block:: none - - set system task-scheduler task TEST crontab-spec "* * * 1 *" - -Example -******* - -.. code-block:: none - - system - task-scheduler - task mytask - interval 2h - executable - path /config/scripts/mytask - arguments "arg1 arg2 arg3" - task anothertask - cron-spec "* * * 1 *" - executable - path /config/scripts/anothertask
\ No newline at end of file diff --git a/docs/system/time-zone.rst b/docs/system/time-zone.rst deleted file mode 100644 index 9e1690e8..00000000 --- a/docs/system/time-zone.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _timezone: - -Time Zone -========= - -To set the system time zone type: - -.. code-block:: none - - [edit] - vyos@vyos# set system time-zone [time-zone]
\ No newline at end of file |