Optics and Hardware Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

PDF

Optics and Hardware Configuration Guide for Cisco 8000 Series Routers, Cisco IOS XR Releases

CMIS transceiver firmware management

Updated: June 16, 2026

Want to summarize with AI?

Log in

Describes CMIS transceiver firmware management for supported optical transceivers.

A CMIS transceiver firmware management is a feature that

  • identifies applicable firmware by using vendor-provided metadata and transceiver identification information,

  • compares installed firmware with the firmware version available in the matching metadata entry, and

  • supports firmware download, run, commit, and abort operations when the transceiver advertises the required CDB capabilities.

Table 1. Feature History Table

Feature Name

Release Information

Feature Description

CMIS transceiver firmware management

Release 26.3.1

Introduced in this release on: Fixed Systems(8200 [ASIC: P100, P200], 8700 [ASIC: P100,P200]); Modular Systems (8800 [LC ASIC:P100, P200]

You can keep supported CMIS optical transceiver firmware up to date by identifying applicable firmware, comparing versions, and downloading, running, committing, or aborting updates. Hitless restart is used when supported by the transceiver.

Firmware management scope

CMIS transceiver firmware management applies to CMIS-capable optical transceivers that support the CDB capabilities required for the intended firmware operation. Cisco IOS XR uses transceiver-advertised CDB capability fields to determine the available command behavior and limits.

This feature provides the following functions:

  • Identify available firmware from vendor-provided metadata.

  • Compare installed transceiver firmware with available package firmware.

  • Display firmware status and CDB capabilities.

  • Download, run, commit, or abort supported firmware operations.

Performance monitoring, Bit Error Rate Testing (BERT), and general CMIS diagnostic functions are outside the scope of this feature.

Firmware metadata selection

Firmware metadata identifies the transceiver hardware that a firmware binary supports. Vendors provide metadata and firmware binaries as tarballs or as uncompressed files in a directory structure. The metadata and binary files must be copied to the predefined Route Processor (RP) path. Cisco IOS XR reads local metadata during boot or reload.

The router requires the following metadata attributes to select a firmware binary:

  • Vendor name

  • Part number

  • Hardware revision

Metadata can include optional attributes that further limit the transceivers to which a firmware entry applies:

  • Organizationally Unique Identifier (OUI)

  • Serial number

  • Date code

  • Common Language Equipment Identifier (CLEI) code

Note

Optional metadata attributes refine the selection. They do not replace the required vendor name, part number, and hardware revision match.

CDB capability requirements

A transceiver advertises CDB support through CMIS capability fields. Firmware management uses the default CDB instance and foreground operation mode. The advertised capabilities define the available firmware command support and operational limits.

The router evaluates the following CDB capability categories for firmware management:

Table 2. CDB capability categories

Capability category

Firmware management use

CDB instances and operating modes

Identify available command instances and supported CDB operating modes.

Transfer limits

Identify supported read and write lengths, payload pages, and firmware transfer mechanisms.

Command trigger and busy time

Identify the command trigger method and the advertised maximum command busy-time values.

Firmware command support

Identify support for functions such as abort, image copy, readback, and hitless restart.

Firmware operation results

Firmware management supports individual firmware operations and a combined update operation. The available result depends on the transceiver-advertised CDB firmware capabilities.

  • Download transfers a firmware image to the transceiver.

  • Run activates an inactive or running firmware image.

  • Commit commits the image that the transceiver last ran through CDB.

  • Abort stops an in-progress firmware operation when abort support is advertised.

  • Hitless restart attempts to preserve traffic and management state during a firmware run operation when hitless restart support is advertised.

An update operation includes download, run, and commit. By default, the update operation runs the inactive image with a traffic-affecting reset and then commits that image.

Firmware status interpretation

A transceiver with a matching metadata entry can report Need-Upgd when the package firmware version is newer than the installed firmware version. It can report Current when the installed firmware matches the selected package version.

Configure CMIS transceiver firmware management

Configure CMIS transceiver firmware management to identify and use vendor firmware packages for supported optical transceivers.

  • The router selects firmware by matching the transceiver vendor name, part number, and hardware revision.

  • Optional metadata filters, such as OUI, serial number, date code, and CLEI code, limit the transceivers that match a firmware package.

Firmware metadata and binary files are provided by the transceiver vendor as a tarball or uncompressed files in a directory structure. Copy these files to the predefined Route Processor (RP) path on the router. Cisco IOS XR reads the local metadata during system boot or reload.

Firmware operations use the default CDB instance and foreground mode. The transceiver advertises available CDB capabilities, transfer limits, command behavior, busy-time values, and supported firmware operations.

  • Performance monitoring, Bit Error Rate Testing (BERT), and general CMIS diagnostic functions are not part of firmware management.

  • A firmware update downloads, runs, and commits an image. By default, the operation runs the inactive image with a traffic-affecting reset before committing.

Before you begin

Before starting, ensure these prerequisites are met for CMIS transceiver firmware management:

  • Obtain applicable firmware metadata and binary files from the transceiver vendor.

  • Verify that each transceiver supports CMIS CDB firmware management.

  • Confirm that the target transceivers are inserted and initialized.

  • Schedule a maintenance window if a router reload or a traffic-affecting operation is required.

  • Ensure no firmware operation is already running on any target port.

Follow these steps to configure CMIS transceiver firmware management.

Procedure

  1. Copy the vendor firmware metadata and all referenced firmware binary files to the predefined RP path on the router.

    Preserve the directory structure provided by the vendor. The metadata identifies the vendor, part number, hardware revision, firmware version, and binary path.

    • Ensure that each binary referenced by the metadata is present in the RP path.

    • Use OUI, serial number, date code, or CLEI code filters if you need to restrict firmware selection to specific transceivers.

    The firmware metadata and binaries are available in the router's local file system.

  2. Reload the router to allow Cisco IOS XR to read the new firmware metadata files.

    The firmware management service reads metadata during boot or reload to build a database of supported transceivers, firmware versions, and binary paths.

    The router loads the firmware metadata after it completes the reload.

  3. Display the loaded firmware metadata.

    Example:

    show tcvr firmware metadata vendor Cisco

    The router displays available firmware metadata entries and the status of their referenced binary files.

  4. Verify that each target transceiver's metadata entry has the required vendor, part number, hardware revision, firmware version, and binary file.

    Check that the Binary Exists field is True for the image to be used. Vendor, part number, and hardware revision are needed for a firmware match.

    The router can select an appropriate firmware package for each matching transceiver.

  5. Display the firmware status for each target port.

    Example:

    show tcvr firmware optics 0/0/0/5

    The current firmware version and upgrade status are shown for the port.

  6. Display the advertised CDB capabilities for each target port.

    Example:

    show controller optics 0/0/0/5 cdb capability

    The CDB capabilities required to plan a supported firmware operation are listed.

  7. Display detailed firmware information if you need information on image-bank, operational state, or update results.

    Example:

    show tcvr firmware optics 0/0/0/5 detailed

    Detailed firmware and operation information is displayed for the selected port.

You have configured CMIS transceiver firmware management. Cisco IOS XR can select appropriate vendor firmware packages for matching transceivers and report firmware status and CDB capabilities for supported ports.

What to do next

Before upgrading firmware, verify the selected package, transceiver status, and supported CDB operations.

  • Use tcvr firmware optics <rack/slot/instance/port> update to perform download, run, and commit in one operation.

  • Use separate download, run, and commit operations if you need to control each firmware stage individually.

  • Use abort only if an operation is in progress and the transceiver supports abort commands.