The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This document describes upgrade methods for Catalyst 9000 (Cat9K) switches.
There are no specific requirements for this document.
The information in this document is based on these software and hardware versions.
Note: Consult the appropriate configuration guide for the commands that are used in order to enable these features on other Cisco platforms.
The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. If your network is live, ensure that you understand the potential impact of any command.
This document covers new and old upgrade procedures for Catalyst 9K type switches that use either BUNDLE or INSTALL modes..
Bundle mode is a fancy way to say that switch runs the traditional way of Cisco IOSĀ®. You boot a .bin file that contains everything you need to run the Cisco IOS. As per traditional Cisco IOS, you have a boot statement that points to the .bin file you want to load and that gets loaded at the time of boot.
Switch#show boot BOOT variable = bootflash:cat9k_iosxe.16.11.01.SPA.bin; Configuration Register is 0x102 MANUAL_BOOT variable = no BAUD variable = 9600 ENABLE_BREAK variable does not exist BOOTMODE variable does not exist IPXE_TIMEOUT variable does not exist CONFIG_FILE variable =
You must set this boot statement with the boot system command. The next time you reload, the switch boots into 16.12.01 rather than 16.11.01.
Switch#configure terminal Enter configuration commands, one per line. End with CNTL/Z. Switch(config)#no boot system Switch(config)#boot system bootflash:cat9k_iosxe.16.12.01.SPA.bin <--- Switch(config)#end Switch#wr Switch# Switch#show run | include boot system boot system bootflash:cat9k_iosxe.16.12.01.SPA.bin Switch# Switch#show boot BOOT variable = bootflash:cat9k_iosxe.16.12.01.SPA.bin; <--- Configuration Register is 0x102 MANUAL_BOOT variable = no BAUD variable = 9600 ENABLE_BREAK variable does not exist BOOTMODE variable does not exist IPXE_TIMEOUT variable does not exist CONFIG_FILE variable =
Install mode is the newer and recommended mode to run. This breaks the .bin file up into smaller .pkg files that must be loaded into memory independently of each other, and allows you to boot faster and utilize memory better. The .bin file that you download from software.cisco.com has all the .pkg files you need inside.
Note: Think of the .bin file as a .zip file. It is able be extracted to obtain the .pkg files. There is also a configuration file that is used to indicate what .pkg files are needed. This is the process that is used when you boot in install mode.
Note: This is done automatically and you never have to edit this file directly. However, you can check what package files the .conf file is pointed to before you do a reload to ensure it is pointed to the right ones.
Switch#more packages.conf #! /usr/binos/bin/packages_conf.sh <...snip...> # This is for CAT9k boot rp 0 0 rp_boot cat9k-rpboot.16.11.01.SPA.pkg iso rp 0 0 rp_base cat9k-rpbase.16.11.01.SPA.pkg iso rp 0 0 rp_daemons cat9k-rpbase.16.11.01.SPA.pkg iso rp 0 0 rp_iosd cat9k-rpbase.16.11.01.SPA.pkg iso rp 0 0 rp_security cat9k-rpbase.16.11.01.SPA.pkg iso rp 0 0 rp_wlc cat9k-wlc.16.11.01.SPA.pkg iso rp 0 0 rp_webui cat9k-webui.16.11.01.SPA.pkg iso rp 0 0 srdriver cat9k-srdriver.16.11.01.SPA.pkg iso rp 0 0 guestshell cat9k-guestshell.16.11.01.SPA.pkg boot rp 1 0 rp_boot cat9k-rpboot.16.11.01.SPA.pkg iso rp 1 0 rp_base cat9k-rpbase.16.11.01.SPA.pkg iso rp 1 0 rp_daemons cat9k-rpbase.16.11.01.SPA.pkg iso rp 1 0 rp_iosd cat9k-rpbase.16.11.01.SPA.pkg iso rp 1 0 rp_security cat9k-rpbase.16.11.01.SPA.pkg iso rp 1 0 rp_wlc cat9k-wlc.16.11.01.SPA.pkg iso rp 1 0 rp_webui cat9k-webui.16.11.01.SPA.pkg iso rp 1 0 srdriver cat9k-srdriver.16.11.01.SPA.pkg iso rp 1 0 guestshell cat9k-guestshell.16.11.01.SPA.pkg <...snip...> # # -start- superpackage .pkginfo # # pkginfo: Name: rp_super # pkginfo: BuildTime: 2019-03-28_09.46 # pkginfo: ReleaseDate: Thu-28-Mar-19-01:19 # pkginfo: .BuildArch: x86_64 # pkginfo: BootArchitecture: i686 # pkginfo: .BootArch: i686 # pkginfo: RouteProcessor: cat9k # pkginfo: Platform: CAT9K # pkginfo: User: mcpre # pkginfo: PackageName: universalk9 # pkginfo: Build: 16.11.01 # pkginfo: .SupportedBoards: cat9k # pkginfo: .InstallModel: # pkginfo: .PackageRole: rp_super # pkginfo: .RestartRole: rp_super # pkginfo: .UnifiedPlatformList: passport,nyquist,starfleet # pkginfo: CardTypes: # pkginfo: .CardTypes: # pkginfo: .BuildPath: /scratch/mcpre/release/BLD-V16_11_01_FC3/binos/linkfarm/stage-cat9k/hard/rp_super_universalk9.x86_64 # pkginfo: .Version: 16.11.1.0.312.1553791584..Gibraltar # pkginfo: .InstallVersion: 1.0.0 # pkginfo: .InstallCapCommitSupport: yes # # -end- superpackage .pkginfo #
When you perform an upgrade in install mode, the process is always the same. However, the commands can be different per platform:
Most of the time you are able do steps 2-4 with a single command. This also allows us to rollback to a previous version.
If your active supervisor runs in install mode, your best bet is to use auto upgrade. This allows the Active sup to upgrade the Standby sup regardless of what image is loaded onto the standby (bundle/install/etc). However, you have to boot the standby into some valid image in order for the process to start. Auto upgrade does not recover a sup from rommon.
software auto-upgrade enable
install autoupgrade
Note: Auto upgrade works in a Stackwise Virtual setup as long as the active chassis is in Install mode.
This next section talks about use of the "install"
commands. All 9ks support these commands. However, this is the only option for 9600, 9400, and 9200.
As discussed, the upgrade is a 4 part process. However, the commands for steps 2-4 are a little cryptic so here is what each command does:
Restrictions
Your boot statement must always be packages.conf in install mode. If you try to change the boot statement to another .conf file while you are in the middle of an upgrade, it could cause the upgrade to fail. If you have already run the ADD
command, you need to activate the package you added or clean it out to start over. Do not change your boot statement to an inactive package.
Summary
If you want to move to install, you need to first change your boot statement to packages.conf if it is not already then add the .bin file. This means you have to copy the new .bin file onto bootflash either from TFTP or USB. If you have issues with the copy of the file onto the switch because there is not enough space, see the Cleanup section of this doc to clear out files that are not needed.
configure terminal no boot system boot system bootflash:packages.conf end write install add file bootflash:<new .bin file> activate commit
Install Add
Switch#show install summary [ R0 R1 ] Installed Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG C 16.11.1.0.312 -------------------------------------------------------------------------------- Auto abort timer: inactive --------------------------------------------------------------------------------
install add file bootflash:cat9k_iosxe.16.12.01.SPA.bin
Switch#dir | include .pkg
359097 -rw- 11359240 Sep 13 2019 16:10:08 +00:00 cat9k-cc_srdriver.16.11.01.SPA.pkg
359098 -rw- 84354052 Sep 13 2019 16:10:08 +00:00 cat9k-espbase.16.11.01.SPA.pkg
359099 -rw- 1676292 Sep 13 2019 16:10:08 +00:00 cat9k-guestshell.16.11.01.SPA.pkg
359100 -rw- 466576384 Sep 13 2019 16:10:08 +00:00 cat9k-rpbase.16.11.01.SPA.pkg
359106 -rw- 38552418 Sep 13 2019 16:10:30 +00:00 cat9k-rpboot.16.11.01.SPA.pkg
359101 -rw- 29877252 Sep 13 2019 16:10:08 +00:00 cat9k-sipbase.16.11.01.SPA.pkg
359102 -rw- 57259008 Sep 13 2019 16:10:08 +00:00 cat9k-sipspa.16.11.01.SPA.pkg
359103 -rw- 19936260 Sep 13 2019 16:10:08 +00:00 cat9k-srdriver.16.11.01.SPA.pkg
359104 -rw- 12321792 Sep 13 2019 16:10:08 +00:00 cat9k-webui.16.11.01.SPA.pkg
359105 -rw- 9216 Sep 13 2019 16:10:08 +00:00 cat9k-wlc.16.11.01.SPA.pkg
456963 -rw- 14222344 Sep 13 2019 17:05:35 +00:00 cat9k-cc_srdriver.16.12.01.SPA.pkg
456964 -rw- 88892420 Sep 13 2019 17:05:35 +00:00 cat9k-espbase.16.12.01.SPA.pkg
473282 -rw- 1684484 Sep 13 2019 17:05:35 +00:00 cat9k-guestshell.16.12.01.SPA.pkg
473283 -rw- 535475200 Sep 13 2019 17:05:35 +00:00 cat9k-rpbase.16.12.01.SPA.pkg
473289 -rw- 43111714 Sep 13 2019 17:06:00 +00:00 cat9k-rpboot.16.12.01.SPA.pkg
473284 -rw- 31425540 Sep 13 2019 17:05:35 +00:00 cat9k-sipbase.16.12.01.SPA.pkg
473285 -rw- 60183552 Sep 13 2019 17:05:35 +00:00 cat9k-sipspa.16.12.01.SPA.pkg
473286 -rw- 22676484 Sep 13 2019 17:05:35 +00:00 cat9k-srdriver.16.12.01.SPA.pkg
473287 -rw- 12854272 Sep 13 2019 17:05:35 +00:00 cat9k-webui.16.12.01.SPA.pkg
473288 -rw- 9216 Sep 13 2019 17:05:35 +00:00 cat9k-wlc.16.12.01.SPA.pkg
Switch#show install summary [ R0 R1 ] Installed Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG I 16.12.1.0.544 <-- Installed but still Inactive (I) IMG C 16.11.1.0.312 -------------------------------------------------------------------------------- Auto abort timer: inactive -------------------------------------------------------------------------------- Switch#show install inactive [ R0 R1 ] Inactive Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG I 16.12.1.0.544 <-- Installed but still Inactive (I)
Install Activate
install activate
This operation may require a reload of the system. Do you want to proceed? [y/n]
Switch#show install sum [ R0 R1 ] Installed Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG U 16.12.1.0.544 -------------------------------------------------------------------------------- Auto abort timer: active on install_activate, time before rollback - 01:52:08 <--- when this hits zero, the device reloads back to original version. -------------------------------------------------------------------------------- Switch#show install uncommitted [ R0 R1 ] Uncommitted Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG U 16.12.1.0.544
Install Commit
install commit
Switch#show install summary [ R0 R1 ] Installed Package(s) Information: State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG C 16.12.1.0.544 <--- Now Active and Committed -------------------------------------------------------------------------------- Auto abort timer: inactive --------------------------------------------------------------------------------
Install Abort
activate
command and before you commit, if you decide there is something wrong with the new version, you can abort the upgrade. This causes the device to reload again back to the previous version.install abort
Prompt Level
prompt-level
to none
, the switch reloads as soon as it is ready to do so.install add file bootflash:cat9k_iosxe.16.12.01.SPA.bin activate commit prompt-level none
Auto Upgrade Timer
install auto-abort-timer stop
Switch#install activate auto-abort-timer ? <30-1200> Number of minutes the abort-timer is set for
This section describes the classic method of software upgrade with the use of a boot statement that point to the .bin file (versus a .pkg file).
Warning: If you want to upgrade a switch to bundle mode, ensure you have copied the .bin to EVERY switch in the stack!
configure terminal no boot system boot system bootflash:<new filename> end write reload
This section talks about use of the request platform commands and is supported on the 9500 and 9300.
install commands
instead of these).Expand
request platform software package expand switch all file flash:cat9k_iosxe.16.09.02.SPA.bin
expand
command then change your boot statement to packages.conf and reload to get to install mode.Install
request platform software package install switch all file flash:test auto-copy new
Clean
request platform software package clean
configure terminal no boot system boot sys bootflash:packages.conf end write install add file bootflash:<new .bin file> activate commit
Roll Back Install Mode
Switch#show install rollback ID Label Description ----------------------------------------------- 2 No Label No Description 1 No Label No Description Switch#show install rollback id 1 Rollback id - 1 (Created on Fri Sep 13 13:14:40 2019) Label: No Label Description: No Description Reload required: NO State (St): I - Inactive, U - Activated & Uncommitted, C - Activated & Committed, D - Deactivated & Uncommitted -------------------------------------------------------------------------------- Type St Filename/Version -------------------------------------------------------------------------------- IMG C 16.11.1.0.312
Switch#install label 1 ? description Add a description to specified install point label-name Add a label name to specified install point Switch#install label 1 label-name 16_11_01 install_add_label: START Fri Sep 13 16:43:48 UTC 2019 --- Starting install_add_label --- Performing install_add_label on Active/Standby [R0] install_add_label package(s) on R0 [R0] Finished install_add_label on R0 [R1] install_add_label package(s) on R1 [R1] Finished install_add_label on R1 Checking status of install_add_label on [R0 R1] install_add_label: Passed on [R0 R1] Finished install_add_label SUCCESS: install_add_label Fri Sep 13 16:43:57 UTC 2019 Switch#show install rollback ID Label Description ----------------------------------------------- 2 No Label No Description 1 16_11_01 No Description
rollback
command:install rollback to id 1
Not supported at the time of this writing. Scheduled for support on 17.2.1.
The previous upgrade nethods talk about the upgrade of a single sup or the upgrade of both sups at the same time. However, with dual sups you can do an ISSU (In Service Software Upgrade) which allows one sup to be upgraded at a time so that there is little to no outage.
Note: For more information on 9300 xFSU see this document Understand Extended Fast Software Upgrade on Catalyst 9300 Series Switches
Caution: Once you run the command noted here, the process starts and reloads sup automatically. Do not run the command until you are ready for sups to start to reboot. Unlike the normal upgrade process, it does not ask for a confirmation from you before the reload happens.
install add file bootflash:cat9k_iosxe.16.11.01.SPA.bin activate issu commit
install add file flash:cat9k_iosxe.16.10.01.SPA.bin activate reloadfast commit
Once you are done with an upgrade, you have the option to clean up all the files you do not need by removal of all inactive files. It looks at the current loaded .pkg files and removes everything else. You can review all the files it plans to delete before it deletes them.
install remove inactive
Note: This removes all .bin files so if you want to cleanup before you do an upgrade, ensure you do it before you copy on the new .bin file.
If you get a V-mismatch, this means the software that runs on the switch is different than the active. If you are in install mode, you have the option to resolve this with auto-upgrade. If you are in bundle mode, this is a little tricky to resolve.
Switch#show switch Switch/Stack Mac Address : f8b7.e206.4900 - Local Mac Address Mac persistency wait time: Indefinite H/W Current Switch# Role Mac Address Priority Version State ------------------------------------------------------------------------------------- 1 Member 701f.5300.fa00 15 V01 V-Mismatch <---Indicates a version mismatch *2 Active f8b7.e206.4900 14 V01 Ready
Caution: Ensure you have console access to the switch before you try this, to ensure you are able to recover the switch.
Steps for option #2.
V-Mismatch
state.Switch#dir ? /all List all files /recursive List files recursively all-filesystems List files on all filesystems cns: Directory or file name crashinfo-1: Directory or file name crashinfo-2: Directory or file name crashinfo: Directory or file name flash-1: Directory or file name <----Flash for switch #1 flash-2: Directory or file name <----Flash for switch #2 flash: Directory or file name
switch: boot flash:cat9k_iosxe.16.12.01.SPA.bin <-- Image you copied that Active is running
If you get stuck in rommon with no valid image, you have the option to copy the file via USB onto the switch or via TFTP.
boot usbflash0:cat9k_iosxe.16.12.01.SPA.bin
tftp-server flash:cat9k_iosxe.16.12.01.SPA.bin
DEFAULT_GATEWAY=172.27.74.1
IP_ADDRESS=172.27.74.111
IP_SUBNET_MASK=255.255.255.0
TFTP_SERVER=172.19.64.31
ping 172.19.64.31
boot tftp://172.19.64.31/cat9k_iosxe.16.12.01.SPA.bin
Note: More info on rommon recovery is found at the this link: recover_from_corrupt_or_missing_file_image_or_in_rommon_mode .
In-Service Software Upgrade (ISSU) on Catalyst 3850, Catalyst 9000 series switches
Cisco bug ID CSCvr29736 - Doc bug: 9600 cannot do reloadfast
Cisco bug ID CSCvr29864 - Enhancement: 9300 add reloadfast to install command
Cisco bug ID CSCvr29886 - Enhancement: Be able to change boot statement of switch in v-mismatch
Cisco bug ID CSCvr30159 - Enhancement: Add check for manual boot when you run install add command
Cisco bug ID CSCvr30189 - Enhancement: Add an option to undo an "install add" without the need to delete the .bin files
Revision | Publish Date | Comments |
---|---|---|
4.0 |
21-Jun-2023 |
Warning added "If you want to upgrade a switch to bundle mode, ensure you have copied the .bin to EVERY switch in the stack!" |
3.0 |
16-Jun-2023 |
Added link to 'Understand Extended Fast Software Upgrade on Catalyst 9300 Series Switches' in ISSU section |
2.0 |
20-Jul-2022 |
Initial Release |
1.0 |
05-Nov-2020 |
Initial Release |