Describes how to manage the software repository, including adding, updating, and removing software images, to ensure your Cisco devices have access to the correct versions for installation and upgrades.
Register a remote server
Registering a remote server with Cisco SD-WAN Manager allows you to add software image locations to the software repository and perform device or controller software upgrades using these images.
-
This task enables centralized management of software images and streamlines the upgrade process for devices and controllers.
In a multitenant Cisco Catalyst SD-WAN deployment, only the provider can register a remote server and perform software upgrades using images on the remote server.
When a Cisco Catalyst SD-WAN device is running on release 17.15.1, if the remote FTP server is configured with a non-standard port, you cannot upgrade the device because the image cannot be downloaded. Reconfigure the FTP server to use standard ports to proceed with the upgrade.
-
Ensure you are using supported protocols and port configurations for successful image downloads and upgrades.
Before you begin
Ensure you have access to Cisco SD-WAN Manager and the necessary credentials to register a remote server.
-
Verify that the remote server is reachable and configured with supported protocols (HTTP, FTP, or SCP).
Follow these steps to register a remote server in Cisco SD-WAN Manager:
Procedure
After completing this task, the remote server is registered in Cisco SD-WAN Manager, and you can add software image locations from the remote server to the software repository for device or controller upgrades.
What to do next
Enable devices to use a remote repository server
Manage a remote server
Configure and manage remote server settings in the Cisco SD-WAN Manager software repository to ensure proper storage and retrieval of software images.
-
Enable viewing, editing, and removal of remote server configurations as needed for software management.
This task is relevant when you need to add, modify, or delete remote server entries used for storing software images in the Cisco SD-WAN Manager software repository.
Perform this task when updating server details, changing credentials, or managing image storage locations for software distribution.
-
Use this procedure during initial setup or when server information changes.
Before you begin
Ensure you have access to the Cisco SD-WAN Manager interface and the necessary permissions to manage remote servers.
-
Verify that no software image entries from the remote server exist in the software repository if you plan to edit or delete the server.
Follow these steps to manage a remote server in the software repository:
Procedure
The remote server is added, updated, or removed in the Cisco SD-WAN Manager software repository, and the server settings are applied as configured.
What to do next
After managing the remote server, verify that the server appears correctly in the software repository and that image uploads or downloads function as expected.
-
Test connectivity and credentials to ensure successful access to the remote server.
Add software images to the repository
Add software images to the Cisco SD-WAN Manager software repository to enable upgrades for edge devices, Cisco Catalyst SD-WAN Controller, or Cisco SD-WAN Manager controllers.
-
Store images on the local Cisco SD-WAN Manager server or reference images on a remote file server.
-
Support upgrade workflows for various deployment scenarios.
This task is required before performing software upgrades on edge devices or controllers managed by Cisco SD-WAN Manager. The repository supports storing images locally or referencing remote servers, and different transfer methods may be used depending on your network environment and file size.
In a multitenant deployment, only the provider can register a remote server and add locations of software images to the repository. Disk space limitations may affect image uploads, especially in cluster environments.
-
Uploading images may fail if disk space on any node in a cluster is low. Ensure /opt/data/ remains below 80% utilization.
-
When downloading from a remote server, use only valid characters for user ID, password, and URL as specified in the notes.
Before you begin
Ensure you have access to the Cisco SD-WAN Manager software repository and the necessary software image files.
-
For remote server storage, register the remote server with Cisco SD-WAN Manager in advance.
Follow these steps to add software images to the repository:
Procedure
After completing this task, the software image is available in the Cisco SD-WAN Manager repository for use in device or controller upgrades. The repository supports local and remote image storage, enabling flexible upgrade workflows.
What to do next
Proceed to initiate a software upgrade using the newly added image as required for your devices or controllers. Monitor disk space usage to avoid upload failures in future operations.
View the software images
Use the Cisco SD-WAN Manager menu to access the Software Repository window, where you can view available software images, their versions, locations, and file details.
From the Cisco SD-WAN Manager menu, choose .
The Software Repository window displays the images avaialable in the repository.
-
The Software Version column lists the version of the software image, and the Controller Version column lists the version of Cisco SD-WAN Control Components that is equivalent to the software version. The Cisco SD-WAN Control Components version is the minimum supported version. The software image can operate with the listed Cisco SD-WAN Control Components version or with a higher version.
-
The Software Location column indicates where the software images are stored, either in the repository on the Cisco SD-WAN Manager server, or in a repository in a remote location.
-
The Available Files column lists the names of the software image files.
-
The Updated On column shows when the software image was added to the repository.
-
The ... option for a desired software version provides the option to delete the software image from the repository.
In Cisco vManage Release 20.6.1 and earlier releases, when two or more software images have the same software version but are uploaded with different filenames, the images are listed in a single row. The Available Files column lists the different filenames. This listing scheme is disadvantageous when deleting software images as the delete operation removes all the software images corresponding to a software version.
From Cisco vManage Release 20.7.1, when two or more software images have the same software version but are uploaded with different filenames, each software image is listed in a separate row. This enables you to choose and delete specific software images.
Add virtual images to the repository
This task enables you to add virtual images to the repository in Cisco SD-WAN Manager for use in your network environment.
-
Facilitates the management and deployment of virtual images through various upload options, including remote server, manager, and remote server-manager.
Use this task when you need to add new or updated virtual images to the Cisco SD-WAN Manager software repository for deployment to network devices.
This process is relevant when onboarding new applications, updating existing images, or preparing images for deployment across devices managed by Cisco SD-WAN Manager.
-
Choose the appropriate upload method based on your network setup and file size requirements.
Before you begin
Ensure you have access to Cisco SD-WAN Manager and the necessary permissions to add virtual images to the repository.
-
If using the remote server option, verify that a remote server is registered with Cisco SD-WAN Manager. For details, see Register Remote Server.
Follow these steps to add virtual images to the repository:
Procedure
After completing this task, the selected virtual images are added to the Cisco SD-WAN Manager repository and are available for deployment to network devices.
What to do next
Verify that the virtual images appear in the repository and are ready for deployment as needed.
-
Refer to related documentation for deploying or managing the uploaded images.
Upload the VNF Images
The VNF images are stored in the SD-WAN Manager software repository. These VNF images are referenced during service chain deployment, and then they are pushed to Cisco NFVIS during service chain attachment.
Procedure
You can have multiple VNF entries such as a firewall from same or from different vendors. Also, you can add different versions of VNF that are based on the release of the same VNF. However, ensure that the VNF name is unique.
Create a Customized VNF Image
You can upload one or more qcow2 images in addition to a root disk image as an input file along with VM-specific properties, bootstrap configuration files (if any), and generate a compressed TAR file. Through custom packaging, you can:
-
Create a custom VM package along with image properties and bootstrap files (if needed) into a TAR archive file.
-
Tokenize custom variables and apply system variables that are passed with the bootstrap configuration files.
Ensure that the following custom packaging requirements are met:
-
Root disk image for a VNF–qcow2
-
Day-0 configuration files–system and tokenized custom variables
-
VM configuration–CPU, memory, disk, NICs
-
HA mode–If a VNF supports HA, specify Day-0 primary and secondary files, NICs for a HA link.
-
Additional Storage–If more storage is required, specify predefined disks (qcow2), storage volumes (NFVIS layer)
Before you begin
Procedure
The Software Repository table displays the customized VNF image, and image is available for choosing when creating a custom service chain.
View VNF Images
Procedure
Delete a software image from the repository
Delete a software image from the vManage software repository to free up storage space and maintain an organized repository.
-
Remove outdated or unnecessary software images from the system.
This task is performed when you need to manage the software images stored in the vManage repository, such as when images are no longer needed or to optimize storage.
Deleting unused images helps prevent clutter and ensures that only relevant software versions are available for deployment.
-
Perform this task when a software image is no longer required for device upgrades or rollbacks.
Before you begin
Ensure you have access to the vManage software repository and the necessary permissions to delete images.
-
Verify that the image you want to delete is not currently being downloaded to a router.
Follow these steps to delete a software image from the repository:
Procedure
-
From the Cisco SD-WAN Manager menu, choose .
-
For the desired software image, click ... and choose Delete.
If a software image is being downloaded to a router, you cannot delete the image until the download process completes. After deletion, the image is removed from the repository and is no longer available for device upgrades or rollbacks.
What to do next
After deleting the image, verify that the repository contains only the required software images for your network operations.
-
Consider performing a repository audit to ensure no critical images were removed unintentionally.
Delete a software image
Delete unnecessary software images from a Cisco Catalyst SD-WAN device to free up storage and keep only relevant versions.
-
Maintain optimal device performance by removing unused software images.
This task is performed when you need to manage device storage or remove outdated software images from your Cisco Catalyst SD-WAN device.
Use this procedure in environments where multiple software versions are present and only certain versions are required.
-
Applicable for administrators managing software upgrades and device maintenance.
Before you begin
Ensure you have access to the Cisco SD-WAN Manager interface and appropriate permissions to delete software images.
-
Verify that the devices are connected and visible in the vManage dashboard.
Follow these steps to delete a software image from a Cisco Catalyst SD-WAN device:
Procedure
The selected software image is removed from the device, freeing up storage and ensuring only required versions remain available.
What to do next
Verify that the deleted software image no longer appears in the device's available software list.
Confirm device functionality after image removal.