Introduction
Audience
This document is for network administrators who wish to automate the upgrade of a Catalyst 9000 series switch at a branch or campus using the Cisco DNA Center software image management (SWIM) solution.
About The Solution
Cisco DNA Center stores unique software images by type and version for devices in your network. It allows viewing, importing, and deleting software images, as well as pushing them to devices. Software upgrades can also be scheduled.
About This Guide
This guide demonstrates the value of the Cisco DNA Center software image management (SWIM) solution using a specific combination of equipment, OS version, and configuration. The procedure can be applied to any Catalyst 9000 series switch, but this guide focuses on the Catalyst 9300 switch.
Reader tip: For information on Cisco DNA Center supported devices, refer to the compatibility matrix: https://www.cisco.com/c/en/us/support/cloud-systems-management/dna-center/products-device-support-tables-list.html
Use Cases
Standardize software images for your network devices with software image management (SWIM).
Implementation Flow
Diagram Description: A circular diagram illustrating the four key stages of software image management: STEP 1 DEFINE, STEP 2 DESIGN, STEP 3 DEPLOY, and STEP 4 OPERATE.
Document Structure
This document contains four major sections:
- The Define section provides a high-level overview of how Cisco DNA Center's software image management (SWIM) can reduce device installation and upgrade times.
- The Design section discusses the prerequisites for setting up SWIM with Cisco DNA Center.
- The Deploy section details how to standardize an image as a 'golden image' and use the update workflow to distribute and activate it on a network device.
- The Operate section briefly discusses known caveats of SWIM in Cisco DNA Center.
Define
Solution Overview
Cisco DNA Center assists with non-fabric wired deployments through network discovery, network inventory, return merchandise authorization, and software image management (SWIM).
Reader tip: This guide focuses on SWIM. For day-zero onboarding and RMA, refer to the 'Network Device Onboarding for Cisco DNA Center Deployment Guide'.
Campus Topology
Diagram Description: A network topology illustrating software image standardization. It shows Cisco DNA Center and its Image Repository in the Data Center, distributing images via SCP/HTTPS to campus network layers (Core, Distribution, Access). Cisco.com (CCO) is the source, with DHCP/AD/DNS also indicated. A 'Golden Image' is highlighted within the repository.
Cisco DNA Center is designed for intent-based networking (IBN), streamlining processes into Day 0 and Day N for enterprise networks (routers, switches, wireless) with a near zero-touch deployment experience.
Benefits of SWIM
Zero-touch device connectivity and Software Image Management (SWIM) reduce installation and upgrade times from hours to minutes, enabling easy onboarding of new remote offices with off-the-shelf Cisco devices. SWIM manages software upgrades and ensures consistent image versions across the network.
Design
Ensure Cisco DNA Center is installed on your network before proceeding.
Reader tip: Refer to the Cisco DNA Center Installation resources page for installation details.
Prerequisites for Image Upgrade
- Minimum Software Releases: Devices must meet the Minimum Supported Software Version requirements listed in the Cisco supported devices spreadsheet. https://www.cisco.com/c/en/us/support/cloud-systems-management/dna-center/products-device-support-tables-list.html
- Device Credentials: Devices must have CLI/SNMP or HTTPS/SCP credentials and be in a managed state for Cisco DNA Center to discover and upgrade them (for Day N scenarios).
- CCO Credentials: While not mandatory for SWIM, CCO credentials are highly recommended for features like ROMMON upgrades and viewing suggested/latest image lists. They are also needed to download KGV files for Integrity Verification.
- Integrity Verification: This application monitors software images for unexpected changes. During import, the system compares the image's checksum with the value in the Known Good Values (KVG) file to ensure integrity.
Process 1: Connect to Cisco and Access Software Images
Cisco DNA Center requires connection to Cisco Connection Online (CCO) to display and select Cisco-recommended software images for managed devices.
Tech tip: During Cisco DNA Center installation, you'll set up initial credentials. If needed, follow these steps to re-enter or change them.
Procedure 1: Verify Cisco Credentials
- Log in to Cisco DNA Center.
- Click the gear icon ⚙️, then select System Settings.
- Select Settings and then Cisco Credentials from the left-hand menu.
- Under Cisco Credentials, select CCO.
- Enter your Cisco Connection Online (CCO) username and password.
- Select 'Use Cisco.com user ID' and click Apply.
Tech tip: The entered credentials must have SUPER-ADMIN-ROLE or NETWORK-ADMIN-ROLE privileges.
Deploy
This section details how to standardize an image by marking it as a 'golden image' and use the update workflow to distribute and activate it on network devices (e.g., Catalyst 9300 Series Switch).
Process 2: Upgrade Workflow
This process involves importing and uploading the latest software images for a network device into the Cisco DNA Center software image repository.
Tech tip: Major code updates (e.g., 16.9.1 to 16.11.1) may have additional delays due to ROMMON code upgrades.
Table 1: Software Images for Catalyst 9300 Series Switches
Platform | Software Version | Software Image Name |
---|---|---|
Cisco Catalyst 9300 Switch | IOS XE Release 16.9.1 (Current) | Install Mode (16.9.1) |
Cisco Catalyst 9300 Switch | IOS XE Release 16.9.3 (Upgrade image) | Install Mode (16.9.3) |
Required Procedures
- Standardize the image by marking it as a Golden Image.
- Distribute and activate the software image for the switch.
Procedure 1: Standardize the Image by Marking a Golden Image
Images can be imported automatically via Cisco Connection Online (CCO) or manually uploaded. Cisco DNA Center performs:
- Image Compliance Check (Pre/Post)
- Automatic download of Software Maintenance Updates (SMU)
- Prompt to provision Image updates
For this guide, manual upload will be used. Cisco DNA Center displays suggested and latest images for discovered device families.
Tech tip: CCO credentials are required for Cisco DNA Center to automatically fetch and display suggested image lists. Refer to Process 1 (Option 1).
Option 1 – (AUTO) Recommended Software Image
It is highly recommended to mark a software image as golden from the list provided by Cisco-recommended images.
- Log in to Cisco DNA Center.
- Navigate to Design > Image Repository.
- Expand to view the full list of available Cisco-recommended images.
- Mark the Cisco-recommended image as golden (using the star icon ⭐).
Tech tip: After marking an image as golden, Cisco DNA Center automatically downloads it from cisco.com.
Tech tip: Select non-LDPE software images. Avoid Licensed Data Payload Encryption (LDPE) versions, as they have export control limitations affecting IPSEC capabilities (e.g., cat9k_iosxeldpe.X.X.X.SPA.bin vs. non-LDPE cat9k_iosxe.X.X.X.SPA.bin).
Option 2 – (Manually) Upload Software Image
If the desired software image is not available, you can upload it manually.
- Log in to Cisco DNA Center.
- Go to Design > Image Repository.
- Click +Import.
- In the Import Image/Add-On dialog, choose a file location and click Import.
- Under Image Repository, click Show Tasks to verify the import status.
- Under Image Repository, click Imported Images to view pending images for device family assignment.
- Click Assign next to the image name to be assigned.
- In the slide-out panel, check the box next to the desired Device Series and click Assign.
- Go to the assigned Device Family, click the expand icon, and verify the imported image is available to mark as golden.
- Mark the manually uploaded image as golden (using the star icon ⭐).
- (Optional) Click the pencil icon to select the appropriate role and mark a Golden Image for a specific device role (e.g., ACCESS).
- Verify the image is marked as golden and the ACCESS tag is selected.
Procedure 2: Provision and Activate the Software Image
Once the image is in the repository, it can be distributed and activated on network devices. It is recommended to schedule activation for a specific date and time to align with network change windows.
Before pushing an image, Cisco DNA Center performs a compliance check against golden images. Devices not compliant are marked 'Need Update'. If no golden image is designated, the device image cannot be updated.
Cisco DNA Center also conducts pre-checks (CPU health, disk space, route summary) and post-checks to ensure network state remains unchanged after the image push.
Steps for distributing software images to Catalyst 9300 switches or other network devices:
- From the Cisco DNA Center dashboard, navigate to Provision > Devices.
- Select the Inventory focus and then Software Images.
- Locate the target switch (e.g., AD1-9300.cisco.local) in the list.
- Click 'Needs Update'.
Tech tip: If an incorrect Golden Image is displayed after refreshing or rechecking, the non-golden image must be deleted from the repository for the 'Need Update' option to become available.
Image Update Readiness Check: Verify the correct Golden Image is displayed.
Tech tip: Ensure all check statuses are green (success) or yellow (warning). Red indicates failure and prevents upgrade. Correct issues or click 'Recheck' to re-run the assessment.
Under the Actions drop-down menu, select Software Image > Update Image.
Update Image Workflow (3 Steps):
- Distribute: Select 'Now' or 'Later' (recommended for production) and click Next.
- Activate: Check 'Schedule Activation after Distribution is completed' and click Next.
- Confirm: Review the summary and click Confirm.
A notification will appear stating the image update has initiated. Check Update Status for results.
Tech tip: Scheduled tasks can be viewed to track future distribution and activation.
Verify that the 'Software Image' column shows 'In Progress' for the 'Need Update' status.
Monitor the Update Status:
Tech tip: The device may reboot and become unreachable for 15-30 minutes during the process.
- Distribution in Progress: Update Status changes to 'Distribution In Progress'.
- Activation in Progress: Update Status changes to 'Activation In Progress'.
- Activation Success: Update Status changes to 'Activation Success'.
The switch's software image (e.g., AD1-9300.cisco.local) is now updated to the golden image (e.g., 16.9.3).
Operate
Known Caveats
- Images must be marked as Golden for device families at global or site levels for upgrades in Cisco DNA Center.
- A golden image is equivalent to the certified software image used by Enterprise IT to standardize devices within a family in a customer network.
- Golden images can be defined per device family and per device role. Typically, one golden image per device family is used, with the 'ALL' tag applied to the device role.
- Configuring a time zone via the
clock time zone
IOS XE CLI command might cause a warning in the Image Upgrade Readiness Check panel, indicating a time difference between the device and Cisco DNA Center. This warning can be cleared by removing theclock time zone
command, resyncing the device in inventory, and re-running the readiness assessment. This action will display the device time in UTC.
Appendix A: Hardware and Software Used for Validation
Table 2: Hardware and Software
Functional Area | Product | Software Version |
---|---|---|
Controller (PnP Server) | Cisco DNA Center | 1.3.1.2 |
Device to Onboard (PnP Agent) | Catalyst 9300 Switch Series | 16.09.03 |
Appendix B: Glossary
- Cisco DNA: Cisco Digital Network Architecture
- Cisco PnP: Cisco Plug and Play
- SWIM: Software Image Management
- SSL: Secure Sockets Layer
- VLAN: Virtual Local Area Network
Feedback
For comments and suggestions about this guide and related materials, join the discussion on Cisco Community.
Americas Headquarters: Cisco Systems, Inc., San Jose, CA
Asia Pacific Headquarters: Cisco Systems (USA) Pte. Ltd., Singapore
Europe Headquarters: Cisco Systems International BV Amsterdam, The Netherlands
Cisco has over 200 global offices. Addresses and contact information are available at https://www.cisco.com/go/offices.
Cisco and the Cisco logo are trademarks of Cisco and/or its affiliates. For a list of Cisco trademarks, visit https://www.cisco.com/go/trademarks. Third-party trademarks are the property of their respective owners. The term 'partner' does not imply a partnership relationship.