Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/operation/boot-options.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
:lastproofread: 2025-11-14

.. _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.

.. warning:: This function can disrupt services.
Run it only when necessary, and verify all input values before proceeding.


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.
VyOS provides several kernel command-line options to modify the normal boot
process.
To add an option, select the desired image in the GRUB menu at load time.
Type **e** to edit the first line, then type **Ctrl+x** to boot.

.. image:: /_static/images/boot-options.png
:width: 80%
Expand All @@ -25,16 +24,17 @@ ready.
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.
You can use a configuration file instead of the default ``/config/config.boot``
file.
If the specified file doesn't exist or isn't readable, the system uses the
default configuration file.
No additional verification is performed, so specify a valid configuration file.

.. code-block:: none

vyos-config=/path/to/file

To load the *factory default* config, use:
To load the *factory default* configuration, use:

.. code-block:: none

Expand All @@ -44,8 +44,8 @@ To load the *factory default* config, use:
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!
These options disable certain steps in the boot process. Understand the
:ref:`boot process <boot-steps>` before using them.

.. glossary::

Expand Down
53 changes: 28 additions & 25 deletions docs/operation/information.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
:lastproofread: 2021-07-07
:lastproofread: 2025-11-19

.. _information:

***********
Information
System Information
***********

VyOS features a rich set of operational level commands to retrieve arbitrary
information about your running system.
information about your running system. For more information on the VyOS command
line interface (CLI), see :ref:`cli`.

########
Hardware
Expand All @@ -18,27 +19,29 @@ Hardware
USB
===

In the past serial interface have been defined as ttySx and ttyUSBx where x was
an instance number of the serial interface. It was discovered that from system
boot to system boot the mapping of USB based serial interfaces will differ,
depending which driver was loaded first by the operating system. This will
become rather painful if you not only have serial interfaces for a console
server connected but in addition also a serial backed :ref:`wwan-interface`.
In the past, serial interfaces were defined as ``ttySx`` and ``ttyUSBx`` where
``x``
was the instance number. However, the mapping of USB-based serial interfaces
can change from one system boot to another, depending on which driver the
operating system loads first. This inconsistency can be problematic when you
use multiple serial interfaces.
For example, both console-server connections and a serial-backed
:ref:`wwan-interface`.

To overcome this issue and the fact that in almost 50% of all cheap USB to
serial converters there is no serial number programmed, the USB to serial
interface is now directly identified by the USB root bridge and bus it connects
to. This somehow mimics the new network interface definitions we see in recent
Linux distributions.
To address this issue, and because of many low-cost USB-to-serial converters
do not have a programmed serial number, VyOS now identifies USB-to-serial
interfaces by the USB root bridge and the bus they connect to.
This approach is similar to the network interface naming conventions used in
recent Linux distributions.

For additional details you can refer to https://vyos.dev/T2490.
For details, see https://vyos.dev/T2490.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This issue was resolved in 2020. Is the above content still relevant?


.. opcmd:: show hardware usb

Retrieve a tree like representation of all connected USB devices.
Retrieve a tree-like representation of all connected USB devices.

.. note:: If a device is unplugged and re-plugged it will receive a new
Port, Dev, If identification.
.. note:: If a device is unplugged and plugged in again, it is assigned a new
``Port``, ``Dev``, and ``If``.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do Dev and If stand for?


.. code-block:: none

Expand Down Expand Up @@ -72,8 +75,8 @@ For additional details you can refer to https://vyos.dev/T2490.
.. opcmd:: show hardware usb serial

Retrieve a list and description of all connected USB serial devices. The
device name displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing
the serial console as console-server device.
device name displayed, (for example ``usb0b2.4p1.0``), can be used
directly when accessing the serial console as console-server device.

.. code-block:: none

Expand Down Expand Up @@ -105,9 +108,9 @@ Version

.. opcmd:: show version

Return the current running VyOS version and build information. This includes
also the name of the release train which is ``crux`` on VyOS 1.2, ``equuleus``
on VyOS 1.3 and ``sagitta`` on VyOS 1.4.
Return the currently running VyOS version and build information. This includes
the name of the release train, which is ``crux`` on VyOS 1.2, ``equuleus``
on VyOS 1.3, ``sagitta`` on VyOS 1.4, and ``circinus`` on VyOS 1.5.

.. code-block:: none

Expand All @@ -134,7 +137,7 @@ Version

.. opcmd:: show version kernel

Return version number of the Linux Kernel used in this release.
Return the version number of the currently running Linux kernel.

.. code-block:: none

Expand All @@ -143,7 +146,7 @@ Version

.. opcmd:: show version frr

Return version number of FRR (Free Range Routing - https://frrouting.org/)
Return the version number of FRR (Free Range Routing - https://frrouting.org/)
used in this release. This is the routing control plane and a successor to GNU
Zebra and Quagga.

Expand Down
Loading