RBFS Manual Installation

You can install RtBrick Host manually on an OCP-compliant bare-metal switch. The Open Network Install Environment (ONIE) is an open-source utility that provides an installation environment for OCP-compliant bare-metal switches. ONIE is used to install different network operating systems (NOS) on a device.

ONIE provides several methods for locating a Network Operating System (NOS) installer image. Detailed information about these methods can be found in the ONIE User Guide. The Host image can be installed using any of these methods.

  • When installing Host, any existing configurations on the switch will be deleted.

  • The current RBFS configurations can be retrieved via a REST call from the RESTCONF endpoint. If you have saved the RBFS configuration using this method, you can load it onto the switch through a RESTCONF endpoint. For more information, refer to the following sections of the RtBrick documentation.

  • The URL 'server.example.com' used in this document is a fictitious URL used for demonstration purposes only and needs to be replaced with the URL for the webserver which hosts the RBFS image in your deployment.

RBFS Software Upgrade

If RBFS is already installed on your device and you want to upgrade the software, see the section RBFS-Based Installations. You can perform software upgrade tasks using CLI commands. While the ONIE-based installation methods can technically be used for software upgrades, it is recommended to use the RBFS-based installation methods for their ease of use.

Prerequisites for Manual Installation

ONIE-Based Installation Methods

RBFS supports multiple installation methods using ONIE, allowing both automated and manual deployments.

Zero Touch Provisioning (ZTP)

Automated installation method that allows a device to retrieve installation instructions and install RBFS without any manual intervention. For information on the automated installation process, see section RBFS Automated Installation (Zero Touch Provisioning).

Manual Installation Methods

You can install RBFS using either a USB drive containing the RBFS installer image or by specifying an HTTP URL to a remotely hosted installer image. The USB method is used when network-based installation is unavailable, while the URL method allows ONIE to download and install the image directly from a remote server.

Installing RBFS Using a USB Thumb Drive

This section describes how to install image using a USB thumb drive.

Prerequisites

  • Format the USB drive with the FAT32 file system format because we need to place the RBFS image on the root directory of the USB drive.

  • Ensure that you have downloaded the RBFS Host image as described in the RBFS Image Download section.

Installation Procedure
You can also find instructions for installing via a USB thumb drive in the ONIE User Guide.

To install via USB, insert the USB drive to your computer and assume the USB drive appears as /dev/sda1 and is mounted at /media/rtbuser/4356-00B1 on Linux. This may vary depending on your system and operating system.

$ df -h
Filesystem      Size  Used Avail Use% Mounted on
/dev/sda1        29G   16K   29G   1% /media/rtbuser/4356-00B1

It is crucial to rename the RBFS Host image to onie-installer, as ONIE only recognizes images with this name at the root of the USB drive.

To install via USB, simply copy the installer image (in this example, the image name is bookworm-installer-multiservice-edge-q2c-s9600-72xc-25.3.1) to the root directory of the USB thumb drive, as shown below:

$ cp bookworm-installer-multiservice-edge-q2c-s9600-72xc-25.3.1 /media/rtbuser/4356-00B1/onie-installer

$ ls -al /media/rtbuser/4356-00B1/
total 1256820
drwxr-xr-x  2 rtbuser rtbuser      16384 Jan  1  1970 .
drwxr-x---+ 3 root     root           4096 Jan  9 11:49 ..
-rw-r--r--  1 rtbuser rtbuser 1286955159 Jan  9 11:49 onie-installer

  • Remove the USB drive from your computer and insert it into one of the USB ports on the front or rear panel of your ONIE-enabled device.

  • Insert the cable into the console port and connect to the console port of the device.

  • Power on the device and reboot it. ONIE will automatically detect the onie-installer file located at the root of the USB drive and execute it.

root@bl1-pod1:~# reboot

  • Wait for the device to show the "login:" prompt after installing the image. You can then log in and check the image version.

ufi13 login:
ufi13 login: supervisor
Password:

+--------------------------------------------------------------------+
|                                                                    |
    RtBrick Host system ufi13.q2c.u19.r5.nbg.rtbrick.net:
        Date:       Wed Jan  7 05:51:30 AM UTC 2026
        Uptime:     up 0 minutes

    Image metadata:
        UUID:       bc4c74eb-db7c-4183-af87-1d31ae2abee3
        Version:    25.4.0-g4internal.20260106120631+BDO2078.C1fcf7e8e
        Role:       accessleaf
        Platform:   q2c
        Model:      s9600-72xc
        Format:     host-installer
        Build date: 2026-01-06 12:06:31 UTC
        Based on:   Debian GNU/Linux 12 (bookworm)
|                                                                    |
+--------------------------------------------------------------------+
The system by default selects Image Partition A for installation. If Partition A is already in use, it automatically selects Partition B. It ensures an unused partition is always chosen for installation.
Configuring the Management Interface IP Address

If DHCP is not available, you need to manually configure the IP address, subnet mask, and default gateway for the device’s management port while still logged in from its console port.

  1. Identify the management port. Check the device documentation to determine which network interface is designated as the management interface (labeled "ma1").

  2. Modify the ma1 interface network parameters by adding IP address, Netmask, and gateway using your preferred editor. The example below shows how to modify these parameters using the Vim editor.

supervisor@host:/etc/network/interfaces.d $ vim ma1
auto ma1
iface ma1 inet static        <----- modify ma1 inet assignment as static
      address 192.0.2.187    <----- ma1 management interface ip address
      netmask 255.255.255.0  <----- subnet mask
      gateway 192.0.2.10     <----- configure gateway

  1. Restart the networking service by disabling and enabling the ma1 interface, as shown in the example below. By default, the default route will point to the gateway IP address.

sudo ifdown ma1
sudo ifup ma1

Installation Using the URL of the Installer Image

In this installation mode, the system boots into ONIE and retrieves the installer image from the remote server over the network. ONIE requires the installer image to be hosted on an HTTP-accessible server that is reachable during the boot through a dedicated Out-of-Band management connection.

Prerequisites

  • Ensure that you have downloaded the RBFS Host image as described in the RBFS Image Download section.

  • Ensure that you have configured an HTTP server to host the downloaded images, making them accessible for ONIE during installation.

Installation Procedure
You can also find instructions for installing the Host image over the network in the ONIE User Guide.

To install the RtBrick Host image over the network, perform the following steps:

On a fresh box, host prompt is not available, so skip to ONIE prompt section.

host prompt section:

Manually select ONIE boot mode

  1. Connect to the console port

  1. Reboot the device

root@bl1-pod1:~# reboot

  1. Select "ONIE: Install OS" from the next selection menu displayed.

 +----------------------------------------------------------------------------+
 |*ONIE: Install OS   <---- Select this one                                   |
 | ONIE: Rescue                                                               |
 | ONIE: Uninstall OS                                                         |
 | ONIE: Update ONIE                                                          |
 | ONIE: Embed ONIE                                                           |
 | RTB: Image-A Kernel                                                        |
 | RTB: Image-B Kernel                                                        |
 |                                                                            |
 |                                                                            |
 |                                                                            |
 |                                                                            |
 |                                                                            |
 +----------------------------------------------------------------------------+


      Use the ^ and v keys to select which entry is highlighted.
      Press enter to boot the selected OS, `e' to edit the commands
      before booting or `c' for a command-line.

  1. Wait for the ONIE:/ # prompt.

NOTICE: ONIE started in NOS install mode.  Install mode persists
NOTICE: until a NOS installer runs successfully.

** Installer Mode Enabled **
ONIE:/ #
ONIE:/ #
ONIE:/ #

  1. Provide the URL of the Host installer image location.

The following is an example URL:

onie-nos-install http://server.example.com/rtbrick.net/_/images/latest/rtbrick-host-installer/bookworm-installer-multiservice-edge-q2a-s9510-28dc-25.3.1

  1. Wait until the device displays the "login:" prompt after the image upgrade completes. You can then log into the device and verify the image version.

ufi13 login:
ufi13 login: supervisor
Password:

+--------------------------------------------------------------------+
|                                                                    |
    RtBrick Host system ufi13.q2c.u19.r5.nbg.rtbrick.net:
        Date:       Wed Jan  7 05:51:30 AM UTC 2026
        Uptime:     up 0 minutes

    Image metadata:
        UUID:       bc4c74eb-db7c-4183-af87-1d31ae2abee3
        Version:    25.4.0-g4internal.20260106120631+BDO2078.C1fcf7e8e
        Role:       accessleaf
        Platform:   q2c
        Model:      s9600-72xc
        Format:     host-installer
        Build date: 2026-01-06 12:06:31 UTC
        Based on:   Debian GNU/Linux 12 (bookworm)
|                                                                    |
+--------------------------------------------------------------------+

RBFS-Based Installations

You can perform the subsequent installation tasks (after the initial RBFS installation) such as software upgrades and recovery operations. The commands, available on the RtBrick host system and RBFS CLI, can be used for downloading, installing on the alternate partition, deleting images, and maintaining multiple software versions and so on with minimal impact on the running software. These CLIs include:

  • RtBrick Host System Commands

  • RBFS CLI Commands

RtBrick Host System Commands for Installation Operations

You can manage the RBFS image on the host system. The following commands allow you to perform various actions such as rebooting an image and install another version of the software in the other partition of the image. This operation is supported only if RBFS is already present on the system.

rtb-reboot

This command allows you to reboot the host installer with either RTB image A or image B. This is a temporary reboot of the selected image (it restarts the system using the specific image).

Syntax:

rtb-reboot -p (A | B)
rtb-reboot --no-reboot (A | B)
rtb-reboot (A | B) (install | update | rescue | uninstall)

The command options and description are provided in the following table:

Attribute Description

-p

Sets the selected boot target permanently. It indicates every time the system reboots in the future, it will use this boot target unless you change it again.

--no-reboot

Prevents the system from rebooting immediately after setting the boot target. It is useful if you want to change the boot option but delay the reboot.

A

Boots the system using RTB Image-A Kernel (one of the two software image partitions).

B

Boots the system using RTB Image-B Kernel (the alternate image partition).

install

Boots into ONIE in Install mode to load a new operating system once.

update

Boots ONIE in 'Update' mode to update the ONIE software itself.

rescue

Boots ONIE in 'Rescue' mode for recovery and troubleshooting.

uninstall

Boots ONIE in uninstall mode, which removes the installed operating system.

rtb-reboot A

If the host installer is running image B, use the command to rtb-reboot A to reboot the device and directly boots image A. This is a temporary reboot of the selected image (restarts the system using the specific image).

This does not require any further boot selection input. The following example shows the output of the rtb-reboot A command:

supervisor@host:~ $ sudo rtb-reboot A
Using GRUB partition: /dev/sda2
Setting one-time boot to: RTB: Image-A Kernel
System will reboot into A in 10 seconds.
Press Enter to reboot immediately or Ctrl+C to cancel.
Broadcast message from root@host on pts/0 (Fri 2025-09-12 12:41:48 UTC):
The system will reboot now!
         Stopping session-26.scope- Session 26 of User supervisor...
[  OK  ] Removed slice system-modpr…lice - Slice /system/modprobe.

rtb-reboot B

If the host installer is running image A, use the command to rtb-reboot B to reboot the device and directly boots image B. This is a temporary reboot of the selected image (restarts the system using the specific image).

This does not require any further boot selection input. The following example shows the output of the rtb-reboot B command:

supervisor@host:~ $ sudo rtb-reboot B
Using GRUB partition: /dev/sda2
Setting one-time boot to: RTB: Image-B Kernel
System will reboot into B in 10 seconds.
Press Enter to reboot immediately or Ctrl+C to cancel.
Broadcast message from root@host on pts/0 (Fri 2025-09-12 12:51:03 UTC):
The system will reboot now!
         Stopping session-2.scopeession 2 of User supervisor...
[  OK  ] Removed slice system-modpr…lice - Slice /system/modprobe.

rtb-install

Image partition enables the installation of two different software versions, one on Image A and another on Image B. If you installed the software on Image A, you can install a different version on Image B.

The rtb-install command allows you to install another version of the software on Image B (if you have already installed RBFS on Image A) using a specified file path or URL as the source location.

For example, if RTB image A is already in use, you can target RTB image B for installation using a URL as the source.

The following output is used to figure out which image partition is currently running, either Image A or Image B. This output shows image B that indicates currently running image partition is Image B.

supervisor@host:/ $ ls -la /imag*
-rw------- 1 root root 2 Sep 19 05:59 /image-B

When you execute the rtb-install command, it downloads the image from the given URL, installs it automatically, and provides an acknowledgment message once the installation is complete. Afterward, the system prompts for a reboot for the new installation to take effect.

Syntax:

rtb-install -i (A | B) (-f <filename> | -u <url>)

The command options and description are provided in the following table:

Attribute Description

-i

Specifies the installation target image partition.

A

Installs using RTB Image-A Kernel (one of the two software image partitions).

B

Installs using RTB Image-B Kernel (the alternate image partition).

-f

Specify the file name. Installs the image from the specified file name.

-u

Specify the URL. Installs the image by downloading it from the specified URL location.

The following example shows the output of the rtb-install command:

supervisor@host:/ $  sudo rtb-install -i A -u http://server.example.com/_/images/latest/rtbrick-host-installer/bookworm-installer-multiservice-edge-q2a-s9510-28dc-Downloading file from http://server.example.com/_/images/latest/rtbrick-host-installer/bookworm-installer-multiservice-edge-q2a-s9510-28dc-25.3.1-candidate.1...
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 1421M  100 1421M    0     0  7360k      0  0:03:17  0:03:17 --:--:-- 9467k
Starting the downloaded file with IMAGE=A...
Verifying archive integrity...  100%   SHA256 checksums are OK. All good.
Uncompressing bookworm-installer-multiservice-edge-q2a-s9510-28dc-25.3.1-candidate.1  100%

installer started from within RTB-System
skipping partitioning...
creating ext4 filesystem on partition RTB-IMAGE-A
mke2fs 1.47.0 (5-Feb-2023)
/dev/sda6 contains a ext4 file system labelled 'RTB-IMAGE-A'
    last mounted on / on Fri Sep 12 13:22:37 2025
Discarding device blocks: done
Creating filesystem with 4194304 4k blocks and 1048576 inodes
Filesystem UUID: 65b409b3-4c51-41ba-9ff5-51ce6dfbf16e
Superblock backups stored on blocks:
    32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208,
    4096000

Allocating group tables: done
Writing inode tables: done
Creating journal (32768 blocks): done
Writing superblocks and filesystem accounting information: done

tune2fs 1.47.0 (5-Feb-2023)
installation to Image-A partition
[ 3345.852798] EXT4-fs (sda6): mounted filesystem with ordered data mode. Quota mode: none.
extracting image to /mnt/tmp.72RKIWi8Bj...
...finished
DEBUG: A
A: setting 65b409b3-4c51-41ba-9ff5-51ce6dfbf16e in /mnt/tmp.72RKIWi8Bj/etc/fstab
mount: (hint) your fstab has been modified, but systemd still uses
       the old version; use 'systemctl daemon-reload' to reload.
found ma1 interface, creating udev rule
installing grub bootloader...
unmounting partitions...
[ 3412.562356] EXT4-fs (sda6): unmounting filesystem.
finished installation!
please reboot the system

The installation is now complete. You can proceed with a reboot to apply the changes. The following example shows the output of the reboot command:

supervisor@host:/ $ sudo reboot
Broadcast message from root@host on pts/0 (Fri 2025-09-12 14:40:37 UTC):
The system will reboot now!

supervisor@host:/ $ [  OK  ] Stopped   OK  ] Removed slice system-modpr…lice - Slice /system/modprobe.
[  OK  ] Stopped target graphical.target - Graphical Interface.
[  OK  ] Stopped target rpcbind.target - RPC Port Mapper.

After the reboot, then the login prompt will be shown as below,

[  OK  ] Reached target graphical.target - Graphical Interface.
         Starting systemd-update-ut… Record Runlevel Change in UTMP...
[  OK  ] Finished systemd-update-ut… - Record Runlevel Change in UTMP.
Debian GNU/Linux 12 host ttyS0
host login: [   37.241798] device ma1 entered promiscuous mode
[   37.398983] device ma1 left promiscuous mode

host login:

You can log in and check the image version.

ufi13 login:
ufi13 login: supervisor
Password:

+--------------------------------------------------------------------+
|                                                                    |
    RtBrick Host system ufi13.q2c.u19.r5.nbg.rtbrick.net:
        Date:       Wed Jan  7 05:51:30 AM UTC 2026
        Uptime:     up 0 minutes

    Image metadata:
        UUID:       bc4c74eb-db7c-4183-af87-1d31ae2abee3
        Version:    25.4.0-g4internal.20260106120631+BDO2078.C1fcf7e8e
        Role:       accessleaf
        Platform:   q2c
        Model:      s9600-72xc
        Format:     host-installer
        Build date: 2026-01-06 12:06:31 UTC
        Based on:   Debian GNU/Linux 12 (bookworm)
|                                                                    |
+--------------------------------------------------------------------+

RBFS Commands for Installation Operations

Once RBFS is installed and operational, RBFS CLI commands are available for subseuent installation operations. You can perform operations such as image downloading, installing, activating, and deleting while the router is operational. You can use these commands to perform these operations through both in-band and out-of-band (OOB) interfaces. It allows you to perform software installation and upgrade tasks through the management plane without requiring a dedicated OOB connection.

Software can be downloaded and installed without any downtime. Only a brief downtime occurs during the activation.

The following sections provide information about the commands:

Download Software Image

The following command downloads the software image from the specified HTTPS URL and saves it to the configuration partition using the provided filename.

The URL corresponds to the local directory where the software image was downloaded. The file name is derived from the downloaded image in the directory. For information about the URL and file name of the downloaded image, refer to the section Location of the Downloaded Image.

Syntax:

request software download <url> <file-name>

Option Description

<url>

Specify HTTPS URL location.

<file-name>

Specify the file name.

The following example shows the executed show command and its corresponding output that includes the generated job UUID.

supervisor@rtbrick.net: cfg> request software download https://server.example.com/_/images/latest/rtbrick-host-installer/bookworm-installer-multiservice-edge-q2c-s9600-72xc-25.4
.1.1 rbfs-q2c-img
Task successful with job_uuid: 4aeab4e4-5cb9-49c9-af5e-1281e7446242

Delete Software Image

This command deletes the specified software image file from the partition:

Syntax:

request software delete <file-name>

Option Description

<file-name>

Specify the file name. NOTE: Autocompletion is supported for specifying software image file names.

The following example shows the executed show command and its corresponding output.

supervisor@rtbrick.net: cfg> request software delete rbfs-q2c-img
Task successful

Install Software Image

This command starts the installation of the software image into the specified partition.

You must always specify a partition and if a mounted (active) partition is selected, then it throws an error.

Syntax:

request software install (A | B) <file-name>

Option Description

A | B

Specify the target image partition.

<file-name>

Specify the file name. NOTE: Autocompletion is supported for specifying software image file names.

The following example shows the executed show command and its corresponding output that includes the generated job UUID.

supervisor@rtbrick.net: cfg> request software install partition-b rbfs-q2c-img
Task successful with job_uuid: 5d596d33-3b26-4cfb-9948-ec2b0ae07800

Set Active Partition Flag

You can set a reboot flag for a specific software partition (for example, Partition A or Partition B) as the active partition for the all future reboots. The device will boot from that partition every time it restarts, until changed again.

Syntax:

request software activate (A | B) <option>

Option Description

A | B

Specify the desired partition.

temporary

A temporary reboot activates the specified partition only for the next boot. After the device restarts again, it automatically reverts to the original active partition.

reboot

Reboots the specified partition.

The following example shows the executed show command and its corresponding output.

supervisor@rtbrick.net: cfg> request software activate partition-b reboot
Task successful

RBFS APIs for Installation Tasks

RBFS provides the following API endpoints to perform reboot operations. You can use these API endpoints after the initial RBFS installation on your device.

* POST /api/v1/ctrld/system/_reboot : Reboot the switch.

* POST /api/v1/ctrld/system/_reinstall : Reboot the switch in onie install mode.

* POST /api/v1/ctrld/system/_rescue :Reboot the switch in onie rescue mode.

* POST /api/v1/ctrld/system/_uninstall :Reboot the switch in onie uninstall mode.

* POST /api/v1/ctrld/system/_update :Reboot the switch in onie update mode.

For more information about RBFS APIs for installation and software management tasks, see RBFS CTRLD APIs.

Operational Commands

software partition

Using these show commands, you can view the image partition related information in the system.

Syntax:

show software partition

This command displays all software partitions on the system along with the installed software images. If no software is installed in a partition, the command lists any software image files that have been downloaded to that partition.

The active partition (the one currently running) is clearly shown in the output. The partition marked with the 'reboot' tag shows which partition will become active after the next reboot.

Example Command:

show software partition

Example: The output shows software image details for partitions A and B, including image IDs, versions, and platform information. Partition B is currently set as both the active and permanent boot image. Temporary boot option is not set.

supervisor@rtbrick.net: op> show software partition
System Image Information:
  Image A Details:
    Image ID            : 64ad2c9a-e72a-41f6-be80-de8e9325cc3b
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
  Image B Details:
    Image ID            : ebbacee2-9cf2-4ec4-bd81-05ed23b40250
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
  Boot Options:
    Active Image        : B
    Permanent Boot      : B
    Temporary Boot      : Not Set
  Installer Files: Not available

Example: The output shows that partition B is the active and permanent boot image and partition A is set as the temporary boot image. The system will boot from partition A on the next reboot but will revert to partition B for future boots.

supervisor@rtbrick.net: op> show software partition
System Image Information:
  Image A Details:
    Image ID            : 64ad2c9a-e72a-41f6-be80-de8e9325cc3b
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
  Image B Details:
    Image ID            : ebbacee2-9cf2-4ec4-bd81-05ed23b40250
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
  Boot Options:
    Active Image        : B
    Permanent Boot      : B
    Temporary Boot      : A
  Installer Files: Not available

Example: The output shows two software images installed (Image A and Image B). Image B is currently active, while Image A remains the permanent boot image.

supervisor@rtbrick.net: op> request software activate partition-a
Task successful
supervisor@rtbrick.net: op> show software partition
System Image Information:
  Image A Details:
    Image ID            : 64ad2c9a-e72a-41f6-be80-de8e9325cc3b
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251028034032+Bdevelopment.Cd73d28d2
  Image B Details:
    Image ID            : ebbacee2-9cf2-4ec4-bd81-05ed23b40250
    Image Type          : host-installer
    Platform Chipset    : q2a
    Model               : s9510-28dc
    Element Role        : multiservice-edge
    Image Version       : 2504.0.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
    RTB Image Version   : 25.4.0-g6daily.20251030035506+Bdevelopment.Cd73d28d2
  Boot Options:
    Active Image        : B
    Permanent Boot      : A
    Temporary Boot      : Not Set
  Installer Files: Not available

Job Data

Using the job data show commands, you can track the real-time activity related to the software download or installation.

Syntax:

show software job <job_uuid> data

This command is used to view the real-time activity and log output of a software job. For example, tracking the progress of a software image download or installation.

A job UUID is generated and displayed when an image download or installation is initiated. The following example shows a 'job-uuid' is printed on the screen. 
Task successful with job_uuid: 4aeab4e4-5cb9-49c9-af5e-1281e7446242

Example command:

show software job 2f3d3570-69d2-4307-9c97-305155f8016b data

Example: The output shows the specific software job that shows the system initiated a download. The download is progressing at a rate of around 110 MB/s.

supervisor@rtbrick.net: op> show software job 2f3d3570-69d2-4307-9c97-305155f8016b data
--2025-10-14 04:56:38--  https://server.example.com/_/images/latest/rtbrick-host-installer/bookworm-installer-spine-q2c-s9600-32x-25.4.0-g6daily.20251013163757+Bdevelopment.C3dae1a64
Resolving server.example.com (server.example.com)... 10.200.137.175
Connecting to server.example.com (server.example.com)|10.200.137.175|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 1450171722 (1.3G) [text/plain]
Saving to: ‘/var/config/installer/image-1-dev’

     0K ........ ........ ........ ........  2% 96.8M 14s
 32768K ........ ........ ........ ........  4%  112M 13s
 65536K ........ ........ ........ ........  6%  112M 12s
 98304K ........ ........ ........ ........  9%  112M 12s
131072K ........ ........ ........ ........ 11%  111M 11s
163840K ........ ........ ........ ........ 13%  112M 11s
196608K ........ ........ ........ ........ 16%  112M 11s
229376K ........ ........ ........ ........ 18%  112M 10s
262144K ........ ........ ........ ........ 20%  111M 10s
294912K ........ ........ ........ ........ 23%  113M 10s
327680K ........ ........ ........ ........ 25%  112M 9s
360448K ........ ........ ........ ........ 27%  112M 9s
393216K ........ ........ ........ ........ 30%  112M 9s
425984K ........ ........ ........ ........ 32%  112M 8s
458752K ........ ........ ........ ........ 34%  105M 8s
491520K ........ ........ ........ ........ 37%  112M 8s
<...>
2025-10-14 04:56:50 (111 MB/s) - ‘/var/config/installer/image-1-dev’ saved [1450171722/1450171722]

Job Status

This show command is used to view the final state or result of the software job after execution.

Syntax:

show software job <job_uuid> status

The following example shows the executed show command. The corresponding output shows the software job status that has completed and its state is marked as done with an exit code of 0.

supervisor@rtbrick.net: op> show software job 2f3d3570-69d2-4307-9c97-305155f8016b status
State      : done
Exit Code  : 0