sidebar: font-family: Serif background-color: #EEEEEE sidebar-title: font-family: Helvetica
Download PDF

1. Managing Software Images

RBMS manages a list of software images that are currently installed on the switches in the network or eligible for being installed. The image lifecycle encompasses the following states:

  • NEW, a new image that has been uploaded to RBMS but is not yet eligible for deployment. Typcially the integrity of a new image needs to be verified before it becomes eligible for deployment.

  • CANDIDATE, a candidate image is eligible for deployment. It is a candidate to become the new release image if it passes all tests in the network.

  • RELEASE, the release image gets installed by default.

  • SUPERSEDED, a superseded image is a former release image which has been replaced by a newer release.

  • REVOKED, a revoked image must not be installed on switches in the network.

Superseded and revoked images are kept in the resource inventory for the sake of documentation and to track on how many switches superseded or revoked images are installed.

The rtb-image tool provides an option to register new image in RBMS. The new image can be installed on a switch via Zero-Touch Provisioning (ZTP).

1.1. Viewing all registered images

To view all registered images

  • Click the Images tab. The Images page appears, showing the list of registered images.

images view

The Images page displays the following fields:

Field Description


Name of the software image


Indicates the image state such as New, Candidate, Release, Suspended, Revoked. For more information, see the Image Lifecycle Management section.


Type of the software image such as LXC or ONL


Specifies the supported hardware name


Version of the software image


The image is deployed on the specified element roles.


Name of the registered element

1.1.1. Viewing image details

To view the details of an image

  1. Click the Images tab. The list of registered images appear.

  2. In the Images group box, click the name of the image that you want to view. The image details page appears.

images image detail

This page displays the following fields:

Field Description

Image ID

Image UUID (read-only)


The organization that issued the image

Image Type

The image type (read-only)

Image Name

The unique image name

Image Version

Image version (read-only)


Optional image category


Optional description of the image

Platform Chipset

The chipset this image is build for (read-only)

Element Roles

This image can be deployed on the selected element roles

Supported Platforms

The list of platforms on which the image can be installed

1.1.2. Updating image metadata

To update the metadata of an image

  1. Click the Images tab. The list of registered images appear.

  2. In the Images group box, click the name of the image whose metadata you want to update. The image details page appears.

  3. On the left navigation pane, click Metadata.

images image metadata
  1. Update image metadata such as image ID, type, name, and version.

  2. Click Save settings.

1.2. Image Lifecycle Management

The image lifecycle defines five different image states. A new image is an image that has not yet been approved to be eligible for a deployment. The release image is deployed by default. A candidate image is intended to become the new default image, once the candidate has passed all necessary tests. The existing default image is superseded by the new default image. A revoked image must not be used any longer because it contains severe errors.

  1. Click the Images tab. The list of registered images appear.

  2. Click the name of the image that you want to view.

  3. Click State in the left navigation pane.

  4. From the following list of states, select the state that you want to apply.

images image lifecycle
  • New: Newly registered image

  • Candidate: Candidate for the next release image

  • Release: The image to be installed by default

  • Superseded: A former release image that has been superseded by a newer image version

  • Revoked: The image must not be used anymore.

  1. Click Save state.

©Copyright 2024 RtBrick, Inc. All rights reserved. The information contained herein is subject to change without notice. The trademarks, logos and service marks ("Marks") displayed in this documentation are the property of RtBrick in the United States and other countries. Use of the Marks are subject to RtBrick’s Term of Use Policy, available at Use of marks belonging to other parties is for informational purposes only.