Document Revision History
The following table shows the changes made to this document:
Date |
Change Summary |
---|---|
March 2020 |
First version of the document. |
September 2020 |
Updated Upgrading Ethernet PHY (Fiber) section with firmware version 3.1.96. |
August 2021 |
Updated Resolved Caveats section with ROMMON Release 17.3(3r) information. |
April 2022 |
Updated Resolved Caveats section with ROMMON Release 17.7(3r) information. |
March 2023 |
Updated Resolved Caveats section with ROMMON Release 17.11.01 information. The 17.11.01.pkg release is bundling the earlier released firmware only. |
October 2023 |
Updated Resolved Caveats section with ROMMON Release 17.7(3r) information. Updated ROMMON Images section with IOS-XE versions and the recommended ROMMON versions. |
December 2023 |
Updated Resolved Caveats section with ROMMON Release 17.12(1r) and 17.12(2r) information. Updated ROMMON Images section with latest IOS-XE versions and the recommended ROMMON versions. |
Note |
The hardware programmables are released independently and is not tied to IOS-XE release trains. |
Audience
This publication is for performing upgrades in the field on the ROMMON or FPGA upgrades of the following Cisco Catalyst 9800 Series Wireless Controllers.
-
Cisco Catalyst 9800-80 Wireless Controller
-
Cisco Catalyst 9800-40 Wireless Controller
-
Cisco Catalyst 9800-L Wireless Controller
Conventions
Text Type |
Indication |
---|---|
User input |
Text the user should enter exactly as shown or keys a user should press appear in this font. |
Document titles |
Document titles appear in this font. |
System output |
Terminal sessions and information that the system displays appear in this font. |
CLI commands |
CLI command keywords appear in this font . Variables in a CLI command appear in this font . |
[ ] |
Elements in square brackets are optional. |
{x | y | z} |
Required alternative keywords are grouped in braces and separated by vertical bars. |
[x | y | z] |
Optional alternative keywords are grouped in brackets and separated by vertical bars. |
String |
A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. |
< > |
Nonprinting characters such as passwords are in angle brackets. |
[ ] |
Default responses to system prompts are in square brackets. |
! # |
An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. |
Note |
Means reader take note. Notes contain helpful suggestions or references to material not covered in the document. |
Tip |
Means the following information will help you solve a problem. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver. |
Caution |
Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data. |
Warning |
IMPORTANT SAFETY INSTRUCTIONS This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. SAVE THESE INSTRUCTIONS |
Related Documentation
See the following documentation for more information about the Cisco Catalyst 9800 Series Wireless Controllers:
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation.
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's New in Cisco Product Documentation RSS feed. RSS feeds are a free service.
Upgrading Field Programmable Hardware Devices Overview
This document describes how to perform upgrades in the field on the hardware programmable firmware of the following Cisco Catalyst 9800 Series Wireless Controllers.
-
Cisco Catalyst 9800-80 Wireless Controller
-
Cisco Catalyst 9800-40 Wireless Controller
-
Cisco Catalyst 9800-L Wireless Controller
If the controller contains an old version of the hardware programmable firmware, then that hardware programmable firmware may need to be upgraded. To do this upgrade, a hardware programmable package is released to the customers.
Generally, an upgrade is only necessary in cases where a system message indicates one of the field programmable devices needs an upgrade or a Cisco technical support representative suggests an upgrade.
Note |
During hw-programmables upgrade, the controller may reboot several times and it is not advisable to power cycle the device during this period as it may lead to device failure. Remember that a typical upgrade process would take about 30 minutes to complete the cycle. |
Important |
|
ROMMON Images
A ROMMON image is a software package used by ROM Monitor (ROMMON) software on a controller. The software package is separate from the consolidated package normally used to boot the controller. An independent ROMMON image (software package) may occasionally be released and the controller can be upgraded with the new ROMMON software.
IOS-XE Version |
ROMMON Version |
---|---|
Cisco IOS XE Gibraltar 16.10.x, 16.11.x, 16.12.x |
|
Cisco IOS XE Amsterdam 17.1.x, 17.2.x, 17.3.x |
|
Cisco IOS XE Bengaluru 17.4.x, 17.5.x, 17.6.x |
|
Cisco IOS XE Cupertino 17.7.x, 17.8.x, 17.9.x |
|
Cisco IOS XE Dublin 17.10.x, 17.11.x, 17.12.x |
|
Cisco IOS XE 17.13.x |
IOS-XE Version |
ROMMON Version |
---|---|
Cisco IOS XE Gibraltar 16.10.x, 16.11.x, 16.12.x |
|
Cisco IOS XE Amsterdam 17.1.x, 17.2.x, 17.3.x |
|
Cisco IOS XE Bengaluru 17.4.x, 17.5.x, 17.6.x |
|
Cisco IOS XE Cupertino 17.7.x, 17.8.x, 17.9.x |
|
Cisco IOS XE Dublin 17.10.x, 17.11.x, 17.12.x |
|
Cisco IOS XE 17.13.x |
IOS-XE Version |
ROMMON Version |
---|---|
Cisco IOS XE Gibraltar 16.10.x, 16.11.x, 16.12.x |
|
Cisco IOS XE Amsterdam 17.1.x, 17.2.x, 17.3.x |
|
Cisco IOS XE Bengaluru 17.4.x, 17.5.x, 17.6.x |
|
Cisco IOS XE Cupertino 17.7.x, 17.8.x, 17.9.x |
|
Cisco IOS XE Dublin 17.10.x, 17.11.x, 17.12.x |
|
Cisco IOS XE 17.13.x |
Ethernet PHY Images
This firmware (software upgrade) is for Ethernet PHY and MAC images of the Cisco Catalyst 9800-L Wireless Controllers.
IOS-XE Version |
Hardware Programmables |
---|---|
Cisco IOS XE Gibraltar 16.10.x, 16.11.x, 16.12.x |
|
Cisco IOS XE Amsterdam 17.1.x, 17.2.x, 17.3.x |
|
Cisco IOS XE Bengaluru 17.4.x, 17.5.x, 17.6.x |
|
Cisco IOS XE Cupertino 17.7.x, 17.8.x, 17.9.x |
|
Cisco IOS XE Dublin 17.10.x, 17.11.x, 17.12.x |
|
Cisco IOS XE 17.13.x |
Note |
The FPGAs in Cisco Catalyst 9800-80 and 9800-40 Wireless Controllers does not need an upgrade when the controller's version numbers are as follows.
|
Upgrading Field Programmables for Cisco Catalyst 9800-L Wireless Controller
This section explains field programmable installation procedure for Cisco Catalyst 9800-L Wireless Controller.
Upgrading ROMMON for Cisco Catalyst 9800-L Wireless Controllers
Note |
During ROMMON upgrade, the controller may reboot several times and it is not advisable to power cycle the device during this period as it may lead to device failure. Remember that a typical upgrade process would take about 30 minutes to complete the cycle. |
Before you begin
Note |
To upgrade the ROMMON from 16.12(1r) or a previous version to higher versions, first upgrade ROMMON to 16.12(3r) and then to the required version. Downgrading to older ROMMON versions from release 16.12(3r) is not supported. 16.12(3r) is a mandatory requirement to upgrade to Cisco IOS-XE 17.9.x and later releases.
|
Verify the current ROMMON version using the following commands:
-
Standalone Setup
Device# show rom-monitor chassis active r0 ========================================================== System Bootstrap, Version 16.12(1r), RELEASE SOFTWARE Copyright (c) 1994-2019 by cisco Systems, Inc.
-
High-Availability Setup
Run the following commands on the active controller.
Verify the current ROMMON version for Active controller:
Device# show rom-monitor chassis active r0 ========================================================== System Bootstrap, Version 16.12(1r), RELEASE SOFTWARE Copyright (c) 1994-2019 by Cisco Systems, Inc.
Verify the current ROMMON version for Standby controller:
Device# show rom-monitor chassis standby r0 ========================================================== System Bootstrap, Version 16.12(1r), RELEASE SOFTWARE Copyright (c) 1994-2019 by cisco Systems, Inc.
If the ROMMON version is earlier than 16.12(3r) for the standalone, active, or standby controller, use the procedure given below to upgrade the ROMMON:
Note |
To upgrade ROMMON of the controller in an HA topology, see Upgrading ROMMON in a High-Availability Topology section. |
Procedure
Step 1 |
Download the software image. See the ROMMON Images section for the recommended ROMMON Version and its corresponding software download link. |
||
Step 2 |
Copy the ROMMON image to bootflash, using TFTP, SCP, FTP, or HTTP .
After the system confirms that the copy operation is successful (sample output given below), proceed to the next step.
|
||
Step 3 |
Initiate the upgrade using the command given below and follow the instructions from the tool.
|
||
Step 4 |
Reboot the controller by entering this command:
|
||
Step 5 |
Verify the update on the active controller by entering this command:
|
||
Step 6 |
Verify the update on the standby controller by entering this command:
|
Upgrading Ethernet PHY (Fiber)
Before you begin
This Ethernet PHY upgrade procedure applies only to Fiber SKU (C9800-L-F-K9) model of the Cisco Catalyst 9800-L Wireless Controller.
Use the following command identify the models.
Device# show inventory
NAME: "Chassis 2", DESCR: "Cisco C9800-L-F-K9 Chassis"
PID: C9800-L-F-K9 , VID: 01 , SN: FCW2328H00A
Verify the current Ethernet PHY version on the standalone, active, or standby controllers using the following show commands:
-
Standalone Setup
Device# show platform hardware chassis active qfp datapath pmd ifdev | i FW ========================================================== FFW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 3.1.121 FW Version : 3.1.121
-
High-Availability Setup
Run the following commands only on the active controller.
Verify the current Ethernet PHY version for Active controller.
Device# show platform hardware chassis active qfp datapath pmd ifdev | i FW ========================================================== FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 3.1.121 FW Version : 3.1.121
Verify the current Ethernet PHY version for Standby controller.
Device# show platform hardware chassis standby qfp datapath pmd ifdev | i FW ========================================================== FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 37230 FW Version : 3.1.121 FW Version : 3.1.121
If any of the Ethernet PHY firmware (FW or MDIO) versions are earlier than the firmware version given in the show command output for the standalone, active, or standby controller, use the procedure given below to upgrade the Ethernet PHY firmware:
Note |
To upgrade the Ethernet PHY of the controller in a High Availability topology, see Upgrading Ethernet PHY in a High-Availability Topology. |
Procedure
Step 1 |
Download the software image. See the Ethernet PHY Images section for the recommended Hardware Programmable package and its corresponding software download link. |
Step 2 |
Copy the Ethernet PHY image to bootflash: using TFTP or USB.
After the system confirms that the copy operation is successful (sample output given below), proceed to the next step.
|
Step 3 |
Initiate the upgrade using the command given below and follow the instructions from the tool.
|
Step 4 |
Reboot the controller by entering this command:
|
Step 5 |
After the upgrade is complete, device power cycles automatically, and IOS prompt is displayed. |
Step 6 |
Verify the update on the controller by entering this command:
|
Upgrading Ethernet PHY (Copper)
This procedure upgrades the Ethernet PHY version of your controller.
Before you begin
This Ethernet PHY upgrade procedure applies only to Copper SKU (C9800-L-C-K9) model of the Cisco Catalyst 9800-L Wireless Controller.
Use the show inventory command identify the model.
Device# show inventory
NAME: "Chassis 2", DESCR: "Cisco C9800-L-C-K9 Chassis"
PID: C9800-L-C-K9 , VID: 01 , SN: FCW2328H00A
Verify the current Ethernet PHY version on the standalone, active, or standby controllers using the following show commands:
-
Standalone Setup
Device# show platform hardware chassis active qfp datapath pmd ifdev | i FW ========================================================== FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 3.1.76 FW Version : 3.1.76
-
High-Availability Setup
Run the following command on the active controller.
Verify the current Ethernet PHY version for Active controller.
Device# show platform hardware chassis active qfp datapath pmd ifdev | i FW ========================================================== FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 3.1.76 FW Version : 3.1.76
Verify the current Ethernet PHY version for Standby controller.
Device# show platform hardware chassis standby qfp datapath pmd ifdev | i FW ========================================================== FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000757 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 0x80000756 FW MDIO : 9.1.2 ID: 43503 vers: 1376 FW Version : 3.1.76 FW Version : 3.1.76
If any of the Ethernet PHY firmware (FW or MDIO) versions is earlier than the firmware version given in the show command output for the standalone, active, or standby controller, use the procedure given below to upgrade the Ethernet PHY firmware:
Note |
To upgrade the Ethernet PHY of the controller in a High Availability topology, see Upgrading Ethernet PHY in a High-Availability Topology. |
Procedure
Step 1 |
Download the software image. See the Ethernet PHY Images section for the recommended Hardware Programmable package and its corresponding software download link. |
Step 2 |
Copy the Ethernet PHY image to bootflash: using TFTP or USB.
After the system confirms that the copy operation is successful (sample output given below), proceed to the next step.
|
Step 3 |
Initiate the upgrade using the command given below and follow the instructions from the tool.
|
Step 4 |
Reboot the controller by entering this command:
|
Step 5 |
After the upgrade is complete, device power cycles automatically, and IOS prompt is displayed. |
Step 6 |
Use the following show commands to verify the update on a standalone controller.
|
Step 7 |
Use the following show commands to verify the update on a HA setup. |
Upgrading Field Programmable for Cisco Catalyst 9800-80 Wireless Controller
This section explains field programmable installation procedure for the Cisco Catalyst 9800-80 Wireless Controller.
Before you begin
Note |
To upgrade the ROMMON from 16.12(5r) or a previous version to higher versions, first upgrade ROMMON to 17.3(3r) and then to the required version. To downgrade ROMMON from a higher version to 16.12(5R) or to an older version, first downgrade ROMMON to 17.3(3r) and then to 16.12(5r). 17.3(3r) is a mandatory requirement to upgrade to Cisco IOS-XE 17.9.x and later releases.
|
Verify the current ROMMON version using the following commands:
-
Standalone Setup
Device# show rom-monitor chassis active r0 ========================================================== System Bootstrap, Version 16.10(6r), RELEASE SOFTWARE Copyright (c) 1994-2019 by Cisco Systems, Inc.
-
High-Availability Setup
Run the following command on the active controller.
Verify the current ROMMON version for Active controller:
Device# show rom-monitor chassis active r0 System Bootstrap, Version 16.10(6r), RELEASE SOFTWARE Copyright (c) 1994-2019 by Cisco Systems, Inc.
Verify the current ROMMON version for Standby controller:
Device# show rom-monitor chassis standby r0 ========================================================== System Bootstrap, Version 16.10(6r), RELEASE SOFTWARE Copyright (c) 1994-2019 by cisco Systems, Inc.
If you ROMMON version is earlier than 16.12(5r) for the standalone, active, or standby controller, use the procedure given below:
Note |
To upgrade ROMMON of the controller in an HA topology, see Upgrading ROMMON in a High-Availability Topology section. |
Procedure
Step 1 |
Download the software image. See the ROMMON Images section for the recommended ROMMON version and its corresponding software download link. |
Step 2 |
Copy the ROMMON image to bootflash, using TFTP or USB.
After the system confirms that the copy operation is successful (sample output given below), proceed to the next step.
|
Step 3 |
Initiate the upgrade using the command given below and follow the instructions from the tool.
|
Step 4 |
Reboot the controller by entering this command:
|
Step 5 |
Verify the update on both active and standby controllers by entering this command:
|
Upgrading Field Programmable for Cisco Catalyst 9800-40 Wireless Controllers
This section explains field programmable installation procedure for the Cisco Catalyst 9800-40 Wireless Controller.
Before you begin
Note |
To upgrade the ROMMON from 16.10(2r) or a previous version to higher versions, first upgrade ROMMON to 17.7(3r) and then to the required version. Downgrading to older ROMMON versions from release 17.7(3r) is not supported. 17.7(3r) is a mandatory requirement to upgrade to Cisco IOS-XE 17.9.x and later releases.
|
Verify the current ROMMON version using the following commands:
-
Standalone Setup
Device# show rom-monitor chassis active r0 =========================================================== System Bootstrap, Version 17.7(3r), RELEASE SOFTWARE Copyright (c) 1994-2022 by cisco Systems, Inc.
-
High-Availability Setup
Run the following commands on the active controller.
Verify the current ROMMON version for Active controller:
Device# show rom-monitor chassis active r0 ========================================================== System Bootstrap, Version 17.7(3r), RELEASE SOFTWARE Copyright (c) 1994-2022 by cisco Systems, Inc.
Verify the current ROMMON version for Standby controller:
Device# show rom-monitor chassis standby r0 ========================================================== System Bootstrap, Version 17.7(3r), RELEASE SOFTWARE Copyright (c) 1994-2022 by cisco Systems, Inc.
If the ROMMON version is earlier than 17.7(3r) for the standalone, active, or standby controller, use the procedure given below:
Note |
To upgrade ROMMON of the controller in an HA topology, see Upgrading ROMMON in a High-Availability Topology section. |
Procedure
Step 1 |
Download the software image. See the ROMMON Images section for the recommended ROMMON Version and its corresponding software download link. |
Step 2 |
Copy the ROMMON image to bootflash, using TFTP or USB.
After the system confirms that the copy operation is successful (sample output given below), proceed to the next step.
|
Step 3 |
Initiate the upgrade using the command given below and follow the instructions from the tool.
|
Step 4 |
Reboot the controller by entering this command:
|
Step 5 |
Verify the update on both active and standby controllers by entering this command:
|
Upgrading ROMMON in a High-Availability Topology
This procedure helps to upgrade ROMMON of the controller in an High Availability (HA) topology. This procecure is applicable to all the versions of the Cisco Catalyst 9800 Series Wireless Controllers.
Follow the steps given for upgrading your controller until the upgrade step (Step 3) and then continue with this procedure.
Procedure
Step 1 |
Run the upgrade command on the active device.
The ROMMON gets upgraded and requires a reboot. |
Step 2 |
Run the following command on the current active to complete the upgrade.
After running this command, wait for the controller to join the HA pair and proceed to the next step. |
Step 3 |
Run the upgrade command on the standby device.
The ROMMON gets upgraded and requires a reboot. |
Step 4 |
Run the following command on the standby device to complete the upgrade.
After running this command, wait for the controller to join the HA pair. |
Step 5 |
Use the following show commands to verify the updates on the HA setup.
This verifies the ROMMON version on the active device.
This verifies the ROMMON version on the standby device. |
Upgrading Ethernet PHY in a High-Availability Topology
This procedure helps to upgrade PHY of the controller in an High Availability (HA) topology. This procedure is applicable to all the versions of the Cisco Catalyst 9800 Series Wireless Controllers.
Note |
This procedure results in zero downtime. |
Procedure
Step 1 |
Check PHY versions in both the active and standby units of HA.
|
||
Step 2 |
Transfer the Ethernet PHY image to the bootflash of the active controller.
|
||
Step 3 |
Execute the upgrade command in the active device.
|
||
Step 4 |
Initiate a switchover
After running this command, wait till the rebooting unit is UP and HA is synced. |
||
Step 5 |
Use the following show command to verify the the redundancy states.
|
||
Step 6 |
Use the following show commands to verify the updates in the HA setup.
This verifies the PHY version in the active device.
This verifies the PHY version in the standby device. |
Resolved Caveats
Cisco Catalyst 9800-L Wireless Controller
Note |
The most recent release includes fixes from all preceding releases. |
Caveat ID |
Description |
---|---|
9800-L: CRC error is observed on bay-0 ports bundled in port-channel. |
Caveat ID |
Description |
---|---|
9800-L-C: WLC RX counters stop on TenGigabitEthernet uplink ports. |
Caveat ID |
Description |
---|---|
9800-L: MAC congested @Low PPS, drops/TX_XOFF in Bay 0-Tune settings and pause frames in mgig ports. |
|
9800-L-F: The show hw-module subslot 0/1 transceiver 0 idprom brief command failed to display output. |
|
9800L-F: Bay-1 Onegig and TenGigabitEthernet0/1/0 are not coming up when Bay-1 firmware is upgraded to 3.1.96 |
Caveat ID |
Description |
---|---|
9800-L: Fan always runs at maximum speed and is very loud. |
|
9800-L: Default config register disables breaking into ROMMON; preventing password recovery. |
Cisco Catalyst 9800-80 Wireless Controller
Note |
The most recent release includes fixes from all preceding releases. |
Caveat ID |
Description |
---|---|
Interfaces are going down after upgrading ROMMON to 17.4.1r. |
|
Insyde flash tool should ignore product name while upgrading bios. |
|
Revert bios's name from "Purley-R" to "Purley". |
|
ConfigRegister set to 0X0 does not land on ROMMON prompt. |
|
KGV test failure PCR0. |
Caveat ID |
Description |
---|---|
This release addresses only internal bug fixes. |
Caveat ID |
Description |
---|---|
Support booting of higher size images. |
Cisco Catalyst 9800-40 Wireless Controller
Note |
The most recent release includes fixes from all preceding releases. |
Caveat ID |
Description |
---|---|
KGV test failure PCR0. |
Caveat ID |
Description |
---|---|
Support booting of higher size images. |
|
Data ports are failing during boot. ROMMON: DS31408 fails to lock to APLL 2. |
|
Cisco Catalyst 9800-80/40 controller interfaces are going down after upgrading ROMMON to 17.4.1r. |