diff options
Diffstat (limited to 'docs/system')
| -rw-r--r-- | docs/system/index.rst | 1 | ||||
| -rw-r--r-- | docs/system/syslog.rst | 63 | ||||
| -rw-r--r-- | docs/system/systemusers.rst | 22 | ||||
| -rw-r--r-- | docs/system/task-scheduler.rst | 60 |
4 files changed, 130 insertions, 16 deletions
diff --git a/docs/system/index.rst b/docs/system/index.rst index 368b62ff..d2a3d763 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -16,4 +16,5 @@ should be ready for further configuration which is described in this chapter. host-information systemusers syslog + task-scheduler config-management
\ No newline at end of file diff --git a/docs/system/syslog.rst b/docs/system/syslog.rst index dbf7420a..8acbc237 100644 --- a/docs/system/syslog.rst +++ b/docs/system/syslog.rst @@ -112,3 +112,66 @@ logged in, no messages are being displayed. .. code-block:: sh set system syslog user <LOCAL_USERNAME> facility <FACILITY> level <LEVEL> + +Show logs +^^^^^^^^^ + +Display log files on the console + +.. code-block:: sh + + vyos@vyos:~$ show log + Possible completions: + <Enter> Execute the current command + all Show contents of all master log files + authorization Show listing of authorization attempts + cluster Show log for Cluster + conntrack-sync + Show log for Conntrack-sync + dhcp Show log for Dynamic Host Control Protocol (DHCP) + directory Show listing of user-defined log files + dns Show log for Domain Name Service (DNS) + file Show contents of user-defined log file + firewall Show log for Firewall + https Show log for Https + image Show logs from an image + lldp Show log for Lldp + nat Show log for Network Address Translation (NAT) + openvpn Show log for Openvpn + snmp Show log for Simple Network Monitoring Protocol (SNMP) + tail Monitor last lines of messages file + vpn Show log for Virtual Private Network (VPN) + vrrp Show log for Virtual Router Redundancy Protocol (VRRP) + webproxy Show log for Webproxy + +Show contents of a log file in an image +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Log messages from a specified image can be displayed on the console: + +.. code-block:: sh + + $ show log image <image name> + $ show log image <image name> [all | authorization | directory | file <file name> | tail <lines>] + +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/systemusers.rst b/docs/system/systemusers.rst index a8ae570e..ef153377 100644 --- a/docs/system/systemusers.rst +++ b/docs/system/systemusers.rst @@ -3,31 +3,21 @@ System Users ------------ -VyOS supports two levels of users: admin and operator. +The default vyos user account, 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. -The operator level restricts a user to operational commands and prevents -changes to system configuration. This is useful for gathering information -about the state of the system (dhcp leases, vpn connections, routing tables, -etc...) and for manipulating state of the system, such as resetting -connections, clearing counters and bringing up and taking down connection -oriented interfaces. - -The admin level has all of the capabilities of the operator level, plus the -ability to change system configuration. The admin level also enables a user -to use the sudo command, which essentially means the user has root access to -the system. Creating Login User Accounts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Create user account `jsmith`, with `admin` level access and the password -`mypassword` +Create user account `jsmith` and the password `mypassword`. .. code-block:: sh set system login user jsmith full-name "Johan Smith" set system login user jsmith authentication plaintext-password mypassword - set system login user jsmith level admin The command: @@ -63,4 +53,4 @@ The following command will load the public key `dev.pub` for user `jsmith` .. code-block:: sh - loadkey jsmith scp://devuser@dev001.vyos.net/home/devuser/.ssh/dev.pub
\ No newline at end of file + loadkey jsmith scp://devuser@dev001.vyos.net/home/devuser/.ssh/dev.pub diff --git a/docs/system/task-scheduler.rst b/docs/system/task-scheduler.rst new file mode 100644 index 00000000..73057afd --- /dev/null +++ b/docs/system/task-scheduler.rst @@ -0,0 +1,60 @@ +.. _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:: sh + + 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:: sh + + 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:: sh + + set system task-scheduler task TEST crontab-spec "* * * 1 *" + +Example +******* + +.. code-block:: sh + + 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 |