Manage Software Images

Software image management helps you ensure that all devices in your network run on the latest, most secure software versions.


Note

If you are a premiere license user interested in using the Fleet Upgrade feature, refer to the Cisco Crosswork Workflow Manager Solutions 2.0 Fleet Upgrade Guide for instructions on the automated image upgrade workflow.

This section contains the following topics:

Set up software image management (SWIM)

The Software Image Management page, located under Device Management > Software Management, offers a comprehensive overview of image management functionalities. Key features include adding and deploying images, exporting images, deleting image summaries, and viewing job details. Before you upload software images:

  • Ensure your devices are configured correctly with the right credentials.

  • To perform any SWIM related activities such as viewing image information or performing install-related operations, it's essential that you have read and write access permissions for both SWIM related roles and inventory APIs.

  • If you are utilizing FTP, SFTP, or SCP, make sure these protocols are enabled and properly configured.

  • Set your image transfer and distribution preferences. From the main menu, navigate to Device Management > > Software Management Preferences. Under the Basic tab, choose the following preferences.

Basic Settings

Description

Default Setting

Backup running image

Backs up the running image to the software image repository before image distribution.

Disabled

Smart flash delete

Deletes unnecessary files from flash to free up memory space before distribution.

Disabled

Insert boot command

Inserts the boot command into the running image after image distribution.

Disabled

Continue on failure

If distributing images to multiple devices and distribution to a device fails, continues the distribution to other devices.

Enabled

Remove the option to activate software during distribution jobs

Select to remove the option to activate the software during distribution jobs.

Disabled

Copy operation to be initiated by the Crosswork Network Automation Manager server

Select if you want the software images to be copied by the Crosswork server.

Enabled

  • Click the Protocols tab and drag and drop to specify the default protocol Crosswork should use when transferring images in the Image Transfer Protocol Order. Arrange the protocols in order of preference. If the first protocol listed fails, Crosswork will use the next protocol in the list.


Note

Refer to the Cisco Crosswork Network Controller Essentials Supported Devices for more information about support for SWIM on different devices.

Add a software image to the image repository

To add a software image, follow these steps:

Procedure

Step 1

From the main menu, navigate to Device Management > Software Management.

Step 2

Click the Add icon under the Images tab.

Step 3

Select the method for adding software images.

  • From a client machine: Choose the File radio button, browse to select the image, and click Add.

  • From a server: Choose the URL radio button, ensuring the file adheres to the recommended naming convention.

    Example: image family-*-image version.tar, where the image family is in capital case, like NCS540-iosxr-k9-7.0.0.tar.

  • From a managed device: Choose the Device radio button, select the device name.

Step 4

Opt to Run Now or Schedule Later, and click Schedule.

Step 5

Verify that the image is listed on the Software Images page under Device Management > Software Management.

Deploy a new software image to devices

The image distribution process requires transferring a new software image to a designated location on a device. You can deploy images across multiple similar devices within a single deployment, customizing options for each device as needed. Crosswork Network Controller ensures that only devices compatible with the selected image are displayed, facilitating a seamless deployment experience.

When setting up the distribution job, you have the flexibility to choose whether Crosswork Network Controller should deploy the image immediately or schedule it for a later time. You can manage up to five concurrent distribution operations, excluding active operations, and provides real-time feedback and status updates throughout the process. For large-scale deployments, we recommend to stagger device reboots to ensure continuous service during upgrades.

Pre-deployment checklist

  • Memory and disk space: Ensure sufficient memory and clear disk space for distributing the image.

  • Device compatibility: Verify the suitability of the device for the chosen image.

  • Secure protocols: Use the most secure protocols supported by the device for distribution.

  • Geographical considerations: Ensure the device and server are in the same geographical location to optimize efficiency and reduce errors due to slow network speeds.

Procedure

Step 1

From the main menu, select Device Management > Software Management.

Step 2

Select an image: Under the Image ID tab, view the list of available software images in your repository. Select the Image ID that you want to distribute. When you create a distribution job, you can configure the image for each device or do a bulk distribution for a type of devices.

Note

 

If the required device is not listed, verify that the image family associated with the file matches the family of the selected device.

Step 3

Select the device for image distribution.

Step 4

Verify compatibility: In the Verification window, check the details of the software image on the device. Compatible devices will display a SUCCESS message in the Status column. The UI suggests compatible software and storage partitions. You can also choose to deploy the images on a device or on an external server.

Step 5

Configure deployment:Select the various settings according to your preferences. The image deployment options that are available are:

  1. Distribution settings:

    • Smart flash delete: Recover disk space by deleting non-running files.

    • Erase running image: Option to erase the device's current image.

  2. Activation settings:

    • Boot command insertion: Insert the boot command after distribution.

    • Image activation: Choose sequential or parallel deployment for multiple images.

    • Commit: Option to commit the image post-distribution for XR devices.

    • FPD image upgrade: Enable to automatically upgrade Field Programmable Devices during distribution.

  3. Device running mode:

    • Bundle mode: Use a monolithic image to boot. Requires device reload post-activation.

    • Install mode: Activate image in subpackage mode without reloading (ISSU).

    • Currently exists: Activate the image using the device’s current mode.

  4. Advanced settings:

  • Continue on failure: Opt to continue activation or distribution on other devices if one fails.

  • Interface module delay: Select to adjust the delay between the Online Insertion and Removal (OIR) of each interface module.

  • Distribute via default VRF: Enable image distribution through VRF.

Step 6

Scheduling: On the Schedule page, choose to run the job immediately or at a later time, then click Schedule.

Step 7

Monitoring: To view details about the image distribution job, access the Jobs tab under Software Management.

Activate a new software image on devices

When a new image is activated on a device, it becomes the running image on the disk. Deactivated images are not removed when a new image is activated. You must manually delete the image from the device.

To activate an image without distributing a new image to a device—for example, when the device has the image you want to activate—use the following procedure.

Procedure

Step 1

From the main menu, go to Device Management > Software Management.

Step 2

Click the Jobs tab to view details about the image distribution jobs that you have created. This section lists job details such as job type, status, and run time. For more information on a specific job instance, click on the corresponding hyperlink.

Step 3

Select a software image distribution job which has been run successfully and click the Activate button,

Step 4

Select the devices for the image distribution and click Next.

Step 5

In the Activation settings window, choose the settings according to your preference.

Step 6

Click Next and choose Run Now or Schedule Later to activate the software image in the selected devices.

Step 7

Click the Schedule button to submit the changes.

See the table Cisco devices and supported image distribution Protocols for information on Cisco devices and the protocols that they support for image distribution:

Table 1. Cisco devices and supported image distribution protocols
Cisco Devices FTP SCP SFTP HTTPS

Cisco ASR 1000 series routers

Yes

No

Yes

No

Cisco ASR 9000 series routers

No

No

Yes

No

Cisco IOS-XR (except Cisco ASR 9000 series routers)

Yes

Yes

Yes

No

Cisco ASR 900 series routers Yes Yes No No

Delete software image files from the image repository

Software images can only be manually deleted from the image repository. With the right privileges, you can use the following procedure to delete software image files from the image repository.

Procedure

Step 1

Choose Device Management > Software Management.

Step 2

From the Images window, select one or more images that you want to delete.

Step 3

Click the Delete icon to delete the image.