Professional Documents
Culture Documents
Software Upgrade Procedure September 23, 2020
Software Upgrade Procedure September 23, 2020
Test
Contents
CONTENTS..........................................................................................................................2
ABOUT THIS SOFTWARE UPGRADE PROCEDURE: CISCO 3850 SWITCHES............................3
HISTORY.....................................................................................................................................3
REVIEW......................................................................................................................................3
DOCUMENT CONVENTIONS..........................................................................................................3
1 INTRODUCTION...............................................................................................................4
1.1 PREFACE............................................................................................................................ 4
1.2 AUDIENCE.......................................................................................................................... 4
1.3 SCOPE............................................................................................................................... 4
1.4 TARGET PROCESS STEPS........................................................................................................4
1.5 ASSUMPTIONS.....................................................................................................................4
1.6 RELATED DOCUMENTS..........................................................................................................5
2 IOS-XE PRE-UPGRADE PROCEDURE..................................................................................6
2.1 VALIDATE USERNAME, CONSOLE / ENABLE ACCESS.....................................................................6
2.2 INSTALL ANALYSIS..................................................................................................................6
2.2.1 Verification of the memory availability......................................................................6
2.2.2 Verify the Configuration Register...............................................................................7
2.2.3 Impact of downtime...................................................................................................7
2.3 IMAGE DEPLOYMENT AND VALIDATION.....................................................................................8
2.3.1 Transfer Software Image and Verify MD5 Hash........................................................8
3 UPGRADE PROCEDURE..................................................................................................10
3.1 AUTOMATIC BOOT LOADER UPGRADE.....................................................................................10
3.2 PRECHECKS.........................................................................................................................10
3.3 VERIFY SWITCH MODE ( BUNDLE OR INSTALL )...................................................................11
3.4 UPGRADE PROCESS IN INSTALL MODE...................................................................................11
3.5 UPGRADE IN BUNDLED MODE...............................................................................................14
4 IOS-XE BACKOUT PROCEDURE.......................................................................................18
4.1 DECISION TO BACK OUT FROM NEW IMAGE..............................................................................18
4.1.1 Backing Out in Install Mode.....................................................................................18
4.1.2 Backing Out in Bundle Mode....................................................................................20
4.1.3 Verification...............................................................................................................21
TRADEMARKS AND DISCLAIMERS.....................................................................................22
DOCUMENT ACCEPTANCE................................................................................................23
Test
About This Software Upgrade Procedure: Cisco
3850 Switches
1 Introduction
1.1 Preface
The purpose of this document is to provide the information about upgrading Cisco 3850 devices
in Test Network. The document is written as a guide to be followed by the migration/Network
team and contains detailed information for the execution of each step.
1.2 Audience
This document is intended for use amongst the Cisco CX team and Test Health Care team who have
direct responsibility for the network infrastructure.
1.3 Scope
This document will cover the detailed step by step information required to upgrade stacked
and/or standalone Cisco Catalyst 3850 switches to IOS-XE version 16.12.4.
Preparation
Install Analysis
Image Deployment and Validation
Upgrade
Pre-install Verification
Install
Post-install Verification
1.5 Assumptions
It is assumed that:
a complete, up-to-date inventory of devices is available
devices to be upgraded are able to be managed remotely over the network using
SSH
engineers working to upgrade the switches have Console access either via Remote
Hands OR via Terminal Server
Test
engineers working on the upgrade are aware of required details like device access
credentials and the network tftp/ftp server to be used for configuration backup and
to copy image to the router.
devices to be upgraded are able to download files from a server on the management
network (either a central file server, or a local replica)
software selected for devices has been appropriately qualified and approved by
customer for deployment
https://www.cisco.com/c/en/us/support/switches/catalyst-3850-series-
switches/series.html#InstallandUpgrade
Test
2 IOS-XE Pre-Upgrade Procedure
1. terminal len 0
2. show flash (confirm enough free flash for image copy)
3. show version (check version of code)
4. show switch (to determine if device is stacked or standalone)
NOTE
The size of the image file is 457.53 MB. Automation should ensure that there is
enough free flash before executing file transfer of the image file.
If there is less than the required free space available, automation should detect and
report this status in the execution log.
All images including the active image should be deleted to make room for the target
image.
If there is still not enough flash available after file deletion, automation should detect
and report this status in the execution log and terminate file transfer or reload
Device image transfer (staging) will occur at least two days prior to the schedule
Maintenance window execution and schedule reload.
Confirm config register is 0x102
Automation should report in the execution logs if it finds the image already resident in
flash
Automation should report in the execution logs if the target is already running on the
device.
Automation should check compatibility between existing OS and Target OS.
Test
2.2.2 Verify the Configuration Register
Use the show version command in order to check this value. The value is displayed in the last
line of the show version output. It should be set to 0x102.
Sometimes, the config-register can’t be changed. Please apply the below config which will
allow to change the config-register value.
Catalyst-3850#configure terminal
Catalyst-3850(config)# no system ignore startup-config switch all
Check the Config-register value from the show version | in register command
Catalyst-3850#show version | in register
Configuration register is 0x102
Consideration should also be given to what (if any) recovery steps may be required in the
event of a device failing to complete an upgrade. This is a particular concern for devices in
remote or unmanned locations, where it may require significant time and resources to
physically replace equipment. In extreme cases it may simply represent too high an
operational risk to upgrade a unit in service.
An assessment should be made for each targeted device, or groups of similar devices, and an
upgrade strategy for these should be agreed with the customer.
Test
2.3 Image Deployment and Validation
1. Copy the IOS image using any one of the four available protocols (ftp, scp, sftp, tftp) to
the flash device (on the master switch only if stacked)
2. Verify the MD5 checksum on the switch (on the master switch if stacked)
3. If the switch is stacked, copy the image from the master switch’s flash device to all
member flash devices and verify the MD5 checksum on all flash devices in the stack
4. If the md5 value is incorrect, re-try copy 3 times. If md5 fails after three attempts,
terminate the stage or reload and report in the execution log.
The MD5 checksum value for the target IOS is provided in the table below:
The steps mentioned in the example below can be used to transfer the image from
Network File server to router’s flash and then to verify the integrity of the copied
image using the MD5 hash verification.
Issue “verify /md5” command to check the MD5 value of the copied image against
that specified for the image on CCO.
The image transfer and the MD5 verification can take several minutes to complete.
Example:-
Standalone Switch
copy ftp://<username>:<pwd>@<cspc
ip>/opt/cisco/ss/adminshell/applications/CSPC/tftproot/tftproot/download/<IMAGE>
OR
copy ftp:// <username>:<pwd>@<cspc ip> /tftproot/download/<IMAGE>
Test
Destination filename [cat3k_caa-universalk9.16.12.04.SPA.bin]?
Accessing ftp://1.0.0.1/IOS/3850/cat3k_caa-
universalk9.16.12.04.SPA.bin...
Loading IOS/3850/cat3k_caa-
universalk9.16.12.04.SPA.bin !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!
[OK - 479750531 bytes]
479750531 bytes copied in 79.811 secs (6011083 bytes/sec)
Stacked Switch
Test
3 Upgrade Procedure
Now that the target IOS-XE image has been copied and verified in device’s flash: , we
are good to proceed with the actual upgrade procedure.
When you deploy the Cisco Catalyst 3850 Series Switch, you have two modes of
operation to choose from: INSTALL and BUNDLE.
There are minor differences between the two modes. INSTALL mode is the default
and recommended mode because it allows for a more complete set of features and
requires fewer resources upon boot. This document provides the steps to upgrade the
IOS-XE image in both the modes
3.2 Prechecks
Before implementing the software upgrade, it’s important to collect a baseline of the device’s
state, allowing us to verify its correct operation once the upgrade has been completed. This
information can be collected using a set of CLI commands and logged to a text file: as soon
as the upgrade is completed, the same set of CLI commands can be run again, and the output
compared with that gathered prior to the upgrade. For Catalyst 3850, these commands might
include the following:
1. terminal len 0 ( this will ensure the command result length is unlimited)
2. show version (shows code version)
Test
3. show ip int brief (shows status on all interfaces)
4. show file system (record the available file systems)
5. show flash (shows the available memory)
6. show run all (shows the running configuration)
7. show switch (to determine if device is stacked or standalone)
CAT3850#show version
<snip>
Switch Ports Model SW Version SW Image Mode
------ ----- ----- ---------- ---------- ----
* 1 56 WS-C3850-48T 16.9.4 CAT3K_CAA-UNIVERSALK9 INSTALL
Configuration register is 0x102
CAT3850#
Test
2. write memory
Use this command to save boot settings.
Switch# write memory
Use the below command to install the IOS image to the flash. This command will
correctly upgrade both stack and standalone 3850 switches.
Or
Reference Output:
C3850-1#$aa-universalk9.16.12.04.SPA.bin force new auto-copy verbose
--- Starting install local lock acquisition on switch 1 ---
Finished install local lock acquisition on switch 1
Test
New files list:
Added cat3k_caa-guestshell.16.12.04.SPA.pkg
Added cat3k_caa-rpbase.16.12.04.SPA.pkg
Added cat3k_caa-rpcore.16.12.04.SPA.pkg
Added cat3k_caa-srdriver.16.12.04.SPA.pkg
Added cat3k_caa-webui.16.12.04.SPA.pkg
Finished list of software package changes
SUCCESS: Software provisioned. New software will load on reboot.
[1]: Finished install successful on switch 1
Checking status of install on [1]
[1]: Finished install in switch 1
SUCCESS: Finished install: Success on [1]
Ensuring that cached content is written to media
... cached content flushed to media
C3850-1#
After the above command is run and executed , make sure to see 5 .pkg files and at
least 1 packages.conf file
C3850-1#dir | in .conf
85189 -rw- 4778 Sep 22 2020 12:08:34 +00:00 packages.conf
85189 -rw- 2097152 Sep 22 2020 12:08:34 +00:00 nvram_config_bkup
85215 -rw- 4778 Sep 22 2020 12:35:40 +00:00 cat3k_caa-
universalk9.16.12.03.SPA.conf
85217 -rw- 4778 Sep 22 2020 12:34:55 +00:00 cat3k_caa-
universalk9.16.12.04.SPA.conf
85210 -rw- 4778 Sep 22 2020 12:35:40 +00:00 cat3k_caa-
universalk9.16.12.03.SPA.conf.00-
C3850-1#
Check “show boot system” and make sure that boot variable is set to packages.conf
Test
STANDALONE-3850#
Reload
Use this command in the privileged EXEC mode to reload the switch.
Switch# reload
boot flash:
If the switch is configured with auto boot, then the stack automatically boots up with
the new image. If not, you can manually boot flash:packages.conf
switch:boot flash:packages.conf
show version
Use this command to verify the version of the new image.
C3850-1#show version
Cisco IOS XE Software, Version 16.12.04
Cisco IOS Software [Gibraltar], Catalyst L3 Switch Software (CAT3K_CAA-
UNIVERSALK9-M), Version 16.12.4, RELEASE SOFTWARE (fc5)
Technical Support: http://www.cisco.com/techsupport
Copyright (c) 1986-2020 by Cisco Systems, Inc.
Compiled Thu 09-Jul-20 18:20 by mcpre
<snip>
C3850-1#
Execute all commands given under section 3.2 . Review and compare for inconsistency
Test
Look at show switch output and ensure that the master has a priority hard-coded. The
image file (cat3k_caa-universalk9.16.12.04.SPA.bin) is only required on the master, if
the switch reboots before the upgrade, the master may change and it will require a
copy from old master to new master. Hence it is always a better practice to copy the
image file to all the slots of the stack.
Since the image file is already copied to the flash, use the following steps for the
upgrade.
Configure the boot variable to boot the router with the newly copied IOS, i.e the boot variable
simply needs to be updated to point to the new image as follows.
2. Configure the following boot command to be at the top of the list of the boot
commands already configured on the switch:
a. On a standalone switch
boot system switch all flash:cat3k_caa-universalk9.16.12.04.SPA.bin
b. On a stacked switch
boot system switch all flash:cat3k_caa-universalk9.16.12.04.SPA.bin
3. Verify the change in boot system to ensure that the device will boot to the target
image after next reload.
a. Save configuration
b. Show boot system
c. Ensure that the boot path shows the target image set for next boot for all
devices standalone or stacked
Example :
Standalone
STANDALONE-3850#show boot
---------------------------
Switch 1
---------------------------
Current Boot Variables:
BOOT variable = flash:cat3k_caa-universalk9.16.12.04.SPA.bin;
Test
iPXE Timeout = 0
STANDALONE-3850#config t
STANDALONE-3850 (config)#no boot system
STANDALONE-3850 (config)#boot system flash:/cat3k_caa-
universalk9.16.12.04.SPA.bin
STANDALONE-3850 (config)# boot system flash:/ cat3k_caa-
universalk9.SPA.03.02.03.SE.150-1.EX3.bin
STANDALONE-3850 (config)#end
STANDALONE-3850#
STANDALONE-3850#wr
Stacked
Stack-3850#config t
Enter configuration commands, one per line. End with CNTL/Z.
Stack-3850 (config)# boot system switch all flash:cat3k_caa-
universalk9.16.12.04.SPA.bin
Stack-3850 (config)#end
Stack-3850# write memory
3850-Stack#sh boot
---------------------------
Switch 1
---------------------------
Current Boot Variables:
BOOT variable = flash:cat3k_caa-universalk9.16.12.04.SPA.bin;
Cat-3850# reload
Test
Proceed with reload? [confirm] y
...
<Switch reloads>
5. Post-install verification
Execute all commands given under section 3.2 . Review and compare for inconsistency.
Test
4 IOS-XE Backout Procedure
Use the following section to restore the original IOS-XE release on the router. This is
expected only if the previous sections did not complete successfully.
Note: When you downgrade to a Cisco IOS XE 3.xE image, your boot loader will not
automatically downgrade. It will remain updated. The new boot loader can support booting
both Cisco IOS XE 3.xE releases as well as Cisco IOS XE Fuji16.x releases.
Test
The following files will be deleted:
[switch 1]:
/flash/cat3k_caa-guestshell.16.12.03.SPA.pkg
/flash/cat3k_caa-rpbase.16.12.03.SPA.pkg
/flash/cat3k_caa-rpcore.16.12.03.SPA.pkg
/flash/cat3k_caa-srdriver.16.12.03.SPA.pkg
/flash/cat3k_caa-universalk9.16.12.03.SPA.conf
/flash/cat3k_caa-universalk9.16.12.03.SPA.conf.00-
/flash/cat3k_caa-universalk9.16.12.04.SPA.conf
/flash/cat3k_caa-webui.16.12.03.SPA.pkg
Do you want to proceed? [y/n]y
[switch 1]:
Deleting file flash:cat3k_caa-guestshell.16.12.03.SPA.pkg ... done.
Deleting file flash:cat3k_caa-rpbase.16.12.03.SPA.pkg ... done.
Deleting file flash:cat3k_caa-rpcore.16.12.03.SPA.pkg ... done.
Deleting file flash:cat3k_caa-srdriver.16.12.03.SPA.pkg ... done.
Deleting file flash:cat3k_caa-universalk9.16.12.03.SPA.conf ... done.
Deleting file flash:cat3k_caa-universalk9.16.12.03.SPA.conf.00- ... done.
Deleting file flash:cat3k_caa-universalk9.16.12.04.SPA.conf ... done.
Deleting file flash:cat3k_caa-webui.16.12.03.SPA.pkg ... done.
SUCCESS: Files deleted.
C3850-1#
Use the request platform software package install command with the new option to
downgrade your stack.
Use the switch all option is needed to downgrade all switches in your stack.
Use the auto-copy option to copy the.bin image from flash: to all other switches in
your stack.
Test
4.1.1.4 Reload the Switch
The last step is to reload the switch using reload command for the changes to take
effect. Please make sure boot variable before reloading.
CAT3850#reload
System configuration has been modified. Save? [yes/no]: yes
The following steps should be followed while downgrading the device in Install Mode
1. Verify boot statements
Issue the “sh run | in boot system” command to identify the boot statement.
CAT3850#sh run | in boot system
boot system flash: cat3k_caa-universalk9.16.12.04.SPA.bin
boot system flash: cat3k_caa-universalk9.SPA.03.06.04.E.152-2.E4.bin
CAT3850#
Issue the no command for existing boot statement in global configuration mode. The
previously available boot statement(s) will remain in same sequence.
CAT3850#conf t
Enter configuration commands, one per line. End with CNTL/Z.
CAT3850(config)#no boot system switch all flash: cat3k_caa-
universalk9.16.12.04.SPA.bin
CAT3850(config)#end
CAT3850#sh run | in boot system
boot system flash :cat3k_caa-universalk9.SPA.03.06.04.E.152-2.E4.bin <<<< Old image
CAT3850#
At this point, save the running configuration and reload the router to boot it with the
previous image.
Test
4.1.3 Verification
Use show version to verify that the old image is activated in the device.
Test
Trademarks and Disclaimers
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT
TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS
MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY
PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET
FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED
HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED
WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THIRD
PARTY SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THIRD PARTY SUPPLIERS
DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OR ARISING FROM
A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR
LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF
CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing
of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of
their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other
company.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and
phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the
document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is
unintentional and coincidental.
Test
Document Acceptance
Name Name
Title Title
Company Company
Signature Signature
Date Date
Name Name
Title Title
Company Company
Signature Signature
Date Date
Name Name
Title Title
Company Company
Signature Signature
Date Date
Test