diff options
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/config-management.rst | 6 | ||||
| -rw-r--r-- | docs/system/eventhandler.rst | 4 | ||||
| -rw-r--r-- | docs/system/flowaccounting.rst | 6 | ||||
| -rw-r--r-- | docs/system/host-information.rst | 36 | ||||
| -rw-r--r-- | docs/system/login-users.rst | 20 | ||||
| -rw-r--r-- | docs/system/ntp.rst | 4 | ||||
| -rw-r--r-- | docs/system/proxy.rst | 4 | ||||
| -rw-r--r-- | docs/system/serialconsole.rst | 2 | ||||
| -rw-r--r-- | docs/system/syslog.rst | 16 | ||||
| -rw-r--r-- | docs/system/task-scheduler.rst | 8 | ||||
| -rw-r--r-- | docs/system/time-zone.rst | 2 |
11 files changed, 54 insertions, 54 deletions
diff --git a/docs/system/config-management.rst b/docs/system/config-management.rst index c30cc0ce..9c4cc491 100644 --- a/docs/system/config-management.rst +++ b/docs/system/config-management.rst @@ -6,7 +6,7 @@ Config Management The following changes the number of commit revisions. In the default settings, 20 revisions are stored locally. -.. code-block:: sh +.. code-block:: console set system config-management commit-revisions 50 @@ -14,7 +14,7 @@ The following changes the number of commit revisions. In the default settings, 2 | If you want to save all config changes to a remote destination. Set the commit-archive location. Every time a commit is successfully the config.boot file will be copied to the defined destinations. -.. code-block:: sh +.. code-block:: console set system config-management commit-archive location 'tftp://10.0.0.2' @@ -22,7 +22,7 @@ The following changes the number of commit revisions. In the default settings, 2 A commit look now like this: -.. code-block:: sh +.. code-block:: console vyos@vyos-R1# commit Archiving config... diff --git a/docs/system/eventhandler.rst b/docs/system/eventhandler.rst index 6204abcc..31f05f2c 100644 --- a/docs/system/eventhandler.rst +++ b/docs/system/eventhandler.rst @@ -7,7 +7,7 @@ Event handler allows you to execute scripts when a string that matches a regex a It uses "feeds" (output of commands, or a named pipes) and "policies" that define what to execute if a regex is matched. -.. code-block:: sh +.. code-block:: console system event-handler @@ -29,7 +29,7 @@ It uses "feeds" (output of commands, or a named pipes) and "policies" that defin In this small example a script runs every time a login failed and an interface goes down -.. code-block:: sh +.. code-block:: console vyos@vyos# show system event-handler feed Syslog { diff --git a/docs/system/flowaccounting.rst b/docs/system/flowaccounting.rst index 0c796f92..6caa0d3e 100644 --- a/docs/system/flowaccounting.rst +++ b/docs/system/flowaccounting.rst @@ -30,7 +30,7 @@ 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:: sh +.. code-block:: console set system flow-accounting interface eth0 set system flow-accounting interface bond3 @@ -41,7 +41,7 @@ VyOS supports version 5, 9 and 10 (IPFIX - IP Flow Information Export) NetFlow v5 example: -.. code-block:: sh +.. code-block:: console set system flow-accounting netflow engine-id 100 set system flow-accounting netflow version 5 @@ -55,7 +55,7 @@ display captured network traffic information for all configured interfaces. The following op-mode command shows flow accounting for eth0. -.. code-block:: sh +.. code-block:: console vyos@vyos:~$ show flow-accounting interface eth0 flow-accounting for [eth0] diff --git a/docs/system/host-information.rst b/docs/system/host-information.rst index 788f7bcc..b5b16ed0 100644 --- a/docs/system/host-information.rst +++ b/docs/system/host-information.rst @@ -21,7 +21,7 @@ or over the internet. Set a system host name: -.. code-block:: sh +.. code-block:: console set system host-name <hostname> @@ -29,19 +29,19 @@ Set a system host name: Show host name: -.. code-block:: sh +.. code-block:: console show system host-name Delete host name: -.. code-block:: sh +.. code-block:: console delete system host-name <hostname> Example: Set system hostname to 'RT01': -.. code-block:: sh +.. code-block:: console set system host-name RT01 commit @@ -56,7 +56,7 @@ unique. Set the system's domain: -.. code-block:: sh +.. code-block:: console set system domain-name <domain> @@ -64,19 +64,19 @@ Set the system's domain: Show domain: -.. code-block:: sh +.. code-block:: console show system domain-name Remove domain name: -.. code-block:: sh +.. code-block:: console set system delete domain-name <domain> Example: Set system domain to example.com: -.. code-block:: sh +.. code-block:: console set system domain-name example.com commit @@ -90,20 +90,20 @@ 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:: sh +.. code-block:: console set system static-host-mapping host-name <hostname> inet <IP address> Show static mapping: -.. code-block:: sh +.. code-block:: console 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:: sh +.. code-block:: console set system static-host-mapping host-name RT01 inet 10.20.30.41 commit @@ -117,25 +117,25 @@ Aliases One or more system aliases (static mappings) can be defined: -.. code-block:: sh +.. code-block:: console set system static-host-mapping host-name <hostname> alias <alias> Show aliases: -.. code-block:: sh +.. code-block:: console show system static-mapping Delete alias: -.. code-block:: sh +.. code-block:: console delete system static-host-mapping host-name <hostname> alias <alias> Example: Set alias `router1` for system with hostname `RT01`: -.. code-block:: sh +.. code-block:: console set system static-host-mapping host-name RT01 alias router1 commit @@ -154,19 +154,19 @@ existing configurations are migrated to the new CLI commands. It is replaced by inserting a static route into the routing table using: -.. code-block:: sh +.. code-block:: console set protocols static route 0.0.0.0/0 next-hop <gateway ip> Delete the default route from the system -.. code-block:: sh +.. code-block:: console delete protocols static route 0.0.0.0/0 Show default route: -.. code-block:: sh +.. code-block:: console vyos@vyos$ show ip route 0.0.0.0 Routing entry for 0.0.0.0/0 diff --git a/docs/system/login-users.rst b/docs/system/login-users.rst index 559188ed..9b7668da 100644 --- a/docs/system/login-users.rst +++ b/docs/system/login-users.rst @@ -16,20 +16,20 @@ Local Create user account `jsmith` and the password `mypassword`. -.. code-block:: sh +.. code-block:: console set system login user jsmith full-name "Johan Smith" set system login user jsmith authentication plaintext-password mypassword The command: -.. code-block:: sh +.. code-block:: console show system login will show the contents of :code:`system login` configuration node: -.. code-block:: sh +.. code-block:: console user jsmith { authentication { @@ -45,7 +45,7 @@ SSH with Public Keys The following command will load the public key `dev.pub` for user `jsmith` -.. code-block:: sh +.. code-block:: console loadkey jsmith dev.pub @@ -53,7 +53,7 @@ The following command will load the public key `dev.pub` for user `jsmith` first. As an alternative you can also load the SSH public key directly from a remote system: -.. code-block:: sh +.. code-block:: console loadkey jsmith scp://devuser@dev001.vyos.net/home/devuser/.ssh/dev.pub @@ -61,7 +61,7 @@ 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:: sh +.. code-block:: console set system login user jsmith authentication public-keys callisto key 'AAAABo..Q==' set system login user jsmith authentication public-keys callisto type 'ssh-rsa' @@ -75,7 +75,7 @@ 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:: sh +.. code-block:: console set system login radius server 192.168.1.2 secret 's3cr3t0815' set system login radius server 192.168.1.2 timeout '5' @@ -84,7 +84,7 @@ a default timeout and port. This configuration results in: -.. code-block:: sh +.. code-block:: console show system login radius { @@ -111,7 +111,7 @@ 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:: sh +.. code-block:: console set system login radius source-address 192.168.1.254 @@ -120,7 +120,7 @@ Login Banner You are able to set post-login or pre-login messages with the following lines: -.. code-block:: sh +.. code-block:: console set system login banner pre-login "UNAUTHORIZED USE OF THIS SYSTEM IS PROHIBITED\n" set system login banner post-login "Welcome to VyOS" diff --git a/docs/system/ntp.rst b/docs/system/ntp.rst index ed2a0ecb..d9598a6f 100644 --- a/docs/system/ntp.rst +++ b/docs/system/ntp.rst @@ -5,7 +5,7 @@ NTP there are 3 default NTP server set. You are able to change them. -.. code-block:: sh +.. code-block:: console set system ntp server 0.pool.ntp.org set system ntp server 1.pool.ntp.org @@ -13,7 +13,7 @@ there are 3 default NTP server set. You are able to change them. To set up VyOS as an NTP responder, you must specify the listen address and optionally the permitted clients. -.. code-block:: sh +.. code-block:: console 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 index 4ff5717b..59bf6d52 100644 --- a/docs/system/proxy.rst +++ b/docs/system/proxy.rst @@ -8,14 +8,14 @@ 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:: sh +.. code-block:: console 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:: sh +.. code-block:: console 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 diff --git a/docs/system/serialconsole.rst b/docs/system/serialconsole.rst index 0e2a0a75..dbb90b7a 100644 --- a/docs/system/serialconsole.rst +++ b/docs/system/serialconsole.rst @@ -8,7 +8,7 @@ Serial console Configuring Console ------------------- -.. code-block:: sh +.. code-block:: console vyos@vyos# set system console Possible completions: diff --git a/docs/system/syslog.rst b/docs/system/syslog.rst index 8acbc237..29a9aec5 100644 --- a/docs/system/syslog.rst +++ b/docs/system/syslog.rst @@ -16,14 +16,14 @@ Logging to serial console The below would log all messages to :code:`/dev/console`. -.. code-block:: sh +.. code-block:: console set system syslog console facility all level all Use the **[tab]** function to display all facilities and levels which can be configured. -.. code-block:: sh +.. code-block:: console vyos@vyos# set system syslog console facility <TAB> Possible completions: @@ -70,7 +70,7 @@ 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. -.. code-block:: sh +.. code-block:: console set system syslog file <FILENAME> facility <FACILITY> level <LEVEL> set system syslog file <FILENAME> archive file <NUMBER OF FILES> @@ -88,7 +88,7 @@ using either TCP or UDP. The default is sending the messages via UDP. **UDP** -.. code-block:: sh +.. code-block:: console set system syslog host 10.1.1.1 facility all level all <optional> @@ -97,7 +97,7 @@ using either TCP or UDP. The default is sending the messages via UDP. **TCP** -.. code-block:: sh +.. code-block:: console set system syslog host 10.1.1.2 facility all level all set system syslog host 10.1.1.2 facility all protocol tcp @@ -109,7 +109,7 @@ 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 +.. code-block:: console set system syslog user <LOCAL_USERNAME> facility <FACILITY> level <LEVEL> @@ -118,7 +118,7 @@ Show logs Display log files on the console -.. code-block:: sh +.. code-block:: console vyos@vyos:~$ show log Possible completions: @@ -149,7 +149,7 @@ Show contents of a log file in an image Log messages from a specified image can be displayed on the console: -.. code-block:: sh +.. code-block:: console $ show log image <image name> $ show log image <image name> [all | authorization | directory | file <file name> | tail <lines>] diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst index 73057afd..20a8640c 100644 --- a/docs/system/task-scheduler.rst +++ b/docs/system/task-scheduler.rst @@ -7,7 +7,7 @@ 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:: sh +.. code-block:: console system task-scheduler @@ -24,7 +24,7 @@ Interval You are able to set the time as an time interval. -.. code-block:: sh +.. code-block:: console set system task-scheduler task <name> interval <value><suffix> @@ -38,14 +38,14 @@ If suffix is omitted, minutes are implied. Or set the execution time in common cron time. -.. code-block:: sh +.. code-block:: console set system task-scheduler task TEST crontab-spec "* * * 1 *" Example ******* -.. code-block:: sh +.. code-block:: console system task-scheduler diff --git a/docs/system/time-zone.rst b/docs/system/time-zone.rst index 9cb7f4a0..182829db 100644 --- a/docs/system/time-zone.rst +++ b/docs/system/time-zone.rst @@ -5,7 +5,7 @@ Time Zone To set the system time zone type: -.. code-block:: sh +.. code-block:: console [edit] vyos@vyos# set system time-zone [time-zone]
\ No newline at end of file |