System#
System → System is one page with four tabs: Overview, Settings, History and Audit log. The tiles and the header buttons are the same on every tab.
| Tab | What it shows | Page |
|---|---|---|
| Overview | Version, hardware, power, updates and system images | this page |
| Settings | The router's own settings: general, time synchronisation, SSH, router accounts, remote logging, SNMP, kernel parameters and scheduled tasks | Settings |
| History | Every configuration the router has applied, what each change did, restoring an earlier one, and the Git export | History |
| Audit log | Who did what through the web interface and the API, and whether it worked | Audit log |
The tab is not part of the page's address, so a reload returns to Overview.
The router's certificate authorities and certificates have a page of their own, System → Certificates, described in Certificates.
The header#
The subtitle is the host name and the product version, for example edge-1 · Wheelhouse 0.9.1.
When the router has found a newer release, a badge beside the tabs names it (0.9.2 available). Selecting it opens the Overview tab, where the Updates panel says what is new and how to install it.
Download configuration#
Saves the router's configuration in the browser as <host name>-config.boot. Only an
administrator can use it; for every other role the button is disabled. The file is
complete: it carries every secret in the configuration, including private keys and
pre-shared keys.
If the router returns no configuration, the page says "The router returned no configuration to download." rather than saving an empty file.
Save configuration#
Applying changes from the bar at the bottom of the page changes the configuration the router is running. It does not save it: the router starts with the configuration that was last saved, so changes that were applied and not saved are lost at the next restart.
Save configuration makes the running configuration the one the router starts with. It acts at once rather than adding to the pending changes, needs the operator role and a licence, and is recorded in the audit log as "Saved the configuration for the next start". When it has worked, the page says "Configuration saved. The router starts with it from now on."
The tiles#
| Tile | Shows |
|---|---|
| Uptime | How long the router has been running, with its load averages over one, five and fifteen minutes. |
| Memory used | Memory in use, of the total. |
| Disk used | Disk space in use, the filesystem it is on, and a meter. |
| Configuration revisions | How many revisions the configuration history holds. |
Overview — Version#
| Row | Shows |
|---|---|
| Product | The product name and version. |
| Built on | When the running image was built. |
| Architecture | The processor architecture. |
| Boot via | How the running image was started. |
| Host name | The router's host name. |
| Base platform | The version of VyOS the image is built on, with its release train when the version does not already name it. |
Below it: "Built on VyOS, free software under the GNU General Public License, version 2. Credits and source code are on the About page." The About link in the panel's header opens About, which has the full build details and the credits.
Overview — Hardware#
Vendor, Model, CPU, Cores, Clock, Memory, Filesystem, and Disk (used, of the total), as the router reports them.
Overview — Power, Updates and System images#
The third panel on the Overview row is Power. Below the row are Updates, System images and Factory reset. They have their own pages:
- Power — Restart router and Shut down, confirmed by typing the host name. Administrators only; both act at once.
- System images and updates — whether a newer release exists, installing a new agent package in place, and adding, choosing and deleting system images.
- Factory reset — returns the router's Wheelhouse data to how it was installed, confirmed by the host name and the administrator's own password.
None of them goes through the pending changes. Each action is recorded in the audit log.
Integration offers#
If Prometheus is installed from the catalogue, a card appears under the header: "Scrape Wheelhouse itself". It changes nothing on the router. See integration offers and Telemetry.
In Advanced mode#
With Advanced mode turned on (Account → Preferences), the page header also shows the
part of the configuration the page covers, system, and the Updates panel lists the
commands that install a new system image by hand.
See also#
- System — settings — everything configurable about the router itself.
- System — history — the revisions the fourth tile counts.
- System — audit log — who did what, and whether it worked.
- Certificates — the router's certificate authorities and certificates.
- Backup and restore — what Download configuration does not include.
- Overview — the host name, uptime, load, memory and storage at a glance.