Manual Chapter : Installation for systems running BIG-IP software on TMOS
back-action Installation Guide: Optics Packages for Optical Transceiver Modules

Updated Date: 05/29/2026

Installation for systems running BIG-IP software on TMOS

You can use tmsh to verify the version of the f5optics package on your system running BIG-IP software and update it to a newer version, if needed.

  1. Connect to the system using the serial console or by opening an SSH session to the management IP address.

  2. Log in to the command line interface (CLI) of the system using an account with root access.

  3. Verify the package version.

    tmsh show net f5optics

    This is an example of the output that you might see when you run this command on a BIG-IP system:

    Name        : f5optics                     Relocations: (not relocatable)
Version     : 1.0.0                             Vendor: (none)
Release     : 60.0                          Build Date: Wed 13 May 2020 12:29:48 AM PDT
Group       : System Environment/Libraries   Source RPM: f5optics-1.0.0-60.0.src.rpm
Summary     : F5 optics configuration
Description :
f5 Optics Configuration

    This is an example of the output that you might see when you run this command on a VIPRION system:

    === slot 2 addr 192.0.2.11 color green ===
Name        : f5optics                     Relocations: (not relocatable)
Version     : 1.0.0                             Vendor: (none)
Release     : 60.0                          Build Date: Wed 13 May 2020 12:29:48 AM PDT
Group       : System Environment/Libraries   Source RPM: f5optics-1.0.0-60.0.src.rpm
Summary     : F5 optics configuration
Description :
f5 Optics Configuration

If the version of f5optics on your system is not the latest available from F5, you download the latest version of the package from the F5 Downloads site at my.f5.com/manage/s/downloads.

Before you install the optics-mgr-package, you must download the f5optics package.

  1. On your management workstation, log in to MyF5 Downloads.

    For information about downloading software from MyF5 Downloads page, refer to K000090258: Download F5 products from MyF5.

  2. Read the End User License Agreement and Program Terms and select the check box.

    You must accept the license agreement and program terms before you can proceed.

  3. Click Next.

  4. Under Select a product family, select F5OS for Group.

  5. Under Tell us more about your product, for Product Line, select Components.

  6. For Product Version, select optics-mgr.

  7. Under Select a product container, select the software that you want to download.

  8. Under Select a download file, select the file.

  9. For Download locations, select a download location.

  10. Click Download.

  11. Download the corresponding checksum file and README file.

    The corresponding checksum file has the same name, except that .md5 is the file extension. After the download completes, verify the integrity of the file by checking the MD5 checksum. For information about verifying MD5 checksum on the downloaded file, refer to K8337: Verifying the MD5 checksum for the downloaded F5 software file.

After you download the latest version of the f5optics package, you import the IMG file to your system and then install the package.

Before you can install a new version of thef5optics package, you must use SCP to move the f5optics IM file to the /shared/f5optics/images directory on your BIG-IP or VIPRION system.

You can use tmsh to install updates to F5-branded transceiver modules using the f5optics package.

Important: When you run an optics package installation process, traffic on the system being updated is disrupted. During the installation process, you are prompted to confirm that you are aware of this action before the installation can proceed.

  1. Connect to the system using the serial console or by opening an SSH session to the management IP address.

  2. Log in to the command line interface (CLI) of the system using an account with admin access.

  3. Open the TMOS Shell (tmsh).

    tmsh

  4. Change to the network module.

    net

    The system prompt updates with the module name: user@bigip01(Active)(/Common)(tmos.net)#

  5. Install the f5optics package.

    install f5optics [ recovery ] [ slot [ <*slot-number*> | all ] ]

    The slot option applies only to chassis-based systems. The recovery option enables you to recover from a corrupted f5optics installation by installing the latest version of the f5optics package that is currently available on the system.

  6. When you are prompted to confirm the installation, enter y.

    A summary similar to this example displays:

    Before installation: f5optics-1.0.0-56.0.i686
f5optics-1.0.0-56.0.x86_64 already installed.
Installing f5optics-1.0.0-60.0.i686.rpm f5optics-1.0.0-60.0.x86_64.rpm
After installation: f5optics-1.0.0-60.0.i686
f5optics-1.0.0-60.0.x86_64 is installed.
Restarting bcm56xxd