Information About the Software Upgrade Workflow

Using this workflow, you can download and upgrade software images on the supported Cisco SD-Routing devices with an option to schedule the upgrade process at your convenience. The workflow also shows the status of the software upgrade. This workflow provides you to perform the software Download and Upgrade.

Benefits of Software Upgrade Workflow

  • The software upgrade workflow helps you prevent various device software upgrade failures by displaying device upgrade status. For example, if the upgrade process fails at any particular stage, the workflow flags it as failed.

  • With this workflow, you can choose to download, install, and activate the new software image in discrete steps or in a single step. You can schedule the workflow during the specified date and time.

Prerequisites for Using the Software Upgrade Workflow

Ensure that the Cisco SD-Routing devices are running the required software versions for using the software upgrade workflow feature.

Access the Software Upgrade Workflow

Before You Begin

To check if there is an in-progress software upgrade workflow:

From the Cisco SD-WAN Manager toolbar, click the Task-list icon. Cisco SD-WAN Manager displays a list of all running tasks along with the total number of successes and failures.

  1. In the Cisco SD-WAN Manager menu, click Workflows > Workflow Library.


    Note

    In the Cisco SD-WAN Manager, the Workflow Library is titled Launch Workflows.

  2. Start a new software upgrade workflow: Library > Software Upgrade.

  3. Follow the on-screen instructions to start a new software upgrade workflow.


    Note

    Click Exit to exit from an in-progress software upgrade workflow. You can resume the in-progress workflow at your convenience.


Note

In a multi-node cluster setup, if the control connection switches to a different node during a SD-Routing device upgrade from Cisco SD-WAN Manager, the upgrade may be impacted due to NetConf session timeout. The SD-Routing device then establishes control connection to a different node. You need to re-trigger the upgrade activity.

Verify the Status of the Software Upgrade Workflow

To check the software upgrade workflow status:

  1. From the Cisco SD-WAN Manager toolbar, click the Task-list icon.

    Cisco SD-WAN Manager displays a list of all running tasks along with the total number of successes and failures.

  2. Click the + icon to view the details of a task.

    Cisco SD-WAN Manager opens a pane displaying the status of the task and details of the SD-Routing device on which the task was performed.

Schedule Software Upgrade Workflow for SD-Routing Devices

The scheduler in the software upgrade workflow enables you to schedule workflows at your convenience and avoid any downtime due to the software upgrade process. A scheduler enables you to schedule the upgrade workflow either Now or Later. If you choose to schedule an upgrade for a later time, you can enter the Start Date, Start time, and Select Timezone.

Scheduling Software Upgrade Workflow

Use the following steps to schedule a software upgrade workflow:

Before you begin

Procedure

Step 1

From the Cisco SD-WAN Manager menu, click Workflows > Workflow Library

OR

Click Workflows > Popular Workflows > Software Upgrade..

Step 2

Start a new software upgrade workflow: Workflow Library > Software Upgrade.

OR

Alternatively, resume an in-progress software upgrade workflow: In-progress > Software Upgrade.

Step 3

In the Scheduler section, choose Later.

Note

 

Use the Now option to perform the software upgrade for the selected devices immediately.

Step 4

Choose the Start Date, Start Time, and Select Timezone.

Note

 

Start date and time should always be greater than the Cisco SD-WAN Manager server date and time.

Step 5

Click Next.

The software upgrade workflow is scheduled.

Cancel the Scheduled Software Upgrade Workflow for SD-Routing

To cancel a scheduled software upgrade workflow,

  1. From the Cisco SD-WAN Manager menu, click Maintenance > Software Upgrade.

  2. Choose the SD-Routing device that is scheduled for a software upgrade from the list of devices.

  3. Click Cancel Software Upgrade.

Delete a Downloaded Software Images on the SD-Routing Devices

To delete downloaded software images on the SD-Routing devices:

  1. From the Cisco SD-WAN Manager menu, choose Maintenance > Software Upgrade.

  2. Click WAN Edge.

  3. Click Delete Downloaded Images

  4. In the Delete Downloaded Images dialogue box, choose the appropriate image or images to delete.

  5. Click Delete.

Feature Information for Schedule Software Upgrade on SD-Routing Devices

The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to https://cfnng.cisco.com/. An account on Cisco.com is not required.

Table 1. Feature Information for Schedule Software Upgrade on SD-Routing Devices

Feature Name

Releases

Feature Information

Schedule Software Upgrade on SD-Routing Devices

Cisco IOS XE Release 17.13.1a

With this feature, you can schedule software image upgrade on Cisco SD-Routing devices. This allows you to avoid any downtime due to the software upgrade process.

Manage Software Maintenance Upgrade images

Use Cisco SD-WAN Manager to add, upgrade, activate, deactivate, or remove an SMU image.


Note

Activate or deactivate an SMU image may cause the device to reboot, based on the specific SMU image.

  • A non-reload SMU type does not trigger a device reboot.

  • A reload SMU type triggers a device reboot.

Add, view, and activate an SMU Image

Add, view, and activate Software Maintenance Update (SMU) images for Cisco IOS XE Catalyst SD-WAN devices.

SMU images are managed to ensure devices are updated with the latest security and defect fixes. The Cisco SD-WAN Manager software repository and upgrade process handle SMUs.

Before you begin

Ensure the following:

  • Ensure administrator privileges are granted before accessing the Cisco SD-WAN Manager.

  • Review the software repository documentation for supported image types.

Follow these steps to add, view, and activate an SMU image:

Procedure

Step 1

Add an SMU image using the Cisco SD-WAN Manager software repository.

For detailed steps, see Add Software Images to Repository procedure in the ​Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide.

Step 2

View available SMU images using the Cisco SD-WAN Manager software repository.

For detailed steps, see View Software Images procedure in the ​Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide.

Consider the following points when viewing SMU images:

  • The Available SMU Versions column displays the number of SMU images available for the current base image version (Cisco IOS XE image version).

  • To see the defects associated with an SMU image, select an entry in the Available SMU Versions column. View the defect ID, the corresponding SMU version, and the SMU types (such as non-reload or reload) in the Available SMU Versions dialog box.

  • To delete an SMU version, click the delete icon next to an SMU version in the Available SMU Versions dialog box.

Step 3

Upgrade an SMU image using the Cisco SD-WAN Manager software upgrade window.

For detailed steps, see Upgrade the Software Image on a Device procedure in the ​Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide.

Consider the following points about the SMU image that you choose to upgrade:

  • In the devices table, the Available SMUs column shows the SMU images available for the current base image version.

  • To view a list of all available SMU versions and upgrade images for a device, click a desired entry under the Available SMUs column. View the SMU versions, SMU types, and the state of an SMU version in the Available SMUs dialog box.

    The SMU version is in the format base_image_version.cdet_id.

  • In the Upgrade dialog box, optionally check Activate and Reboot to activate an SMU image and perform a reboot of the Cisco IOS XE Catalyst SD-WAN device automatically.

    After you check the Activate and Reboot check box, Cisco SD-WAN Manager installs and activates the SMU image on a device and triggers a reload based on the SMU type.

    For more information about activating a software image, refer to the Cisco SD-WAN Manager Activate a Software Image procedure in the ​Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide.

After a successful upgrade of an SMU image, the Cisco device sends a corresponding success message.

Deactivate or remove an SMU image

Deactivate an Software Maintenance Upgrade (SMU) image and remove the image from a device, ensuring it is no longer active or available for use.

Before you begin

Consider the following:

  • Ensure administrator privileges are granted before proceeding on the Cisco SD-WAN device.

  • Verify that the SMU image intended to removal is not required for any critical processes.

  • Review related procedures in the Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide as needed.

Follow the step listed below to deactivate and remove an SMU image from a device:

Procedure

Deactivate an Software Maintenance Upgrade (SMU) image and remove the image from a device using the Delete a Software Image procedure listed in the ​Cisco Catalyst SD-WAN Monitor and Maintain Configuration Guide.

The specified SMU image is deactivated and removed from the device.