Manage Software Images

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

This section contains the following topics:

Software Image Management (SWIM)

A software image management feature is a network operation capability that

  • provides centralized tools for adding, deploying, exporting, and deleting software images,

  • enables configuration of protocol preferences and automation settings for image transfer and deployment, and

  • enforces user role permissions and device credential requirements to ensure secure operations.

Prerequisites before uploading software images

Before you upload software images, ensure your environment supports a secure and successful image transfer:

  • Ensure devices are configured correctly with the correct credentials.

  • Ensure you have read and write access for SWIM-related roles and inventory APIs.

  • Enable and configure FTP, SFTP, or SCP if you use these protocols.

  • Set your image transfer and distribution preferences in the Software Management Preferences window under the Basic tab:

    • Back up the running image to the software image repository before image distribution (default: Disabled).

    • Enable smart flash delete to remove unnecessary files from flash and free up memory space before distribution (default: Disabled).

    • Insert the boot command into the running image after image distribution completes (default: Disabled).

    • Continue distributing software images to other devices even if distribution to one device fails (default: Enabled).

    • Remove the option to activate software during distribution jobs as required (default: Disabled).

    • Perform copy operations through the Crosswork Network Automation Manager server (default: Enabled)

Add a software image to the image repository

Follow these steps to add a software image.

Procedure

Step 1

From the main menu, choose 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, select the image file, 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 and select the device name.

Step 4

Choose Run Now or Schedule Later, and click Schedule.

Step 5

Verify that the image appears 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.

Before you begin

  • 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

Activate a software image so that it becomes the running image on selected devices. This ensures devices operate with the desired software version without distributing a new image if the required image is already present on the device. Deactivated images are not removed when a new image is activated. You must manually delete the image from the device.

Follow these steps to activate a software image on devices:

Procedure

Step 1

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

Step 2

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

Step 3

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

Step 4

Select the devices for the image distribution and click Next.

Step 5

In the Activation settings window, choose your preferred activation settings.

Step 6

Click Next.

Step 7

Choose Run Now or Schedule Later to activate the software image in the selected devices.

Step 8

Click the Schedule to confirm the changes.

The selected devices are scheduled to activate the chosen software image based on your preferred settings. The image becomes the running image on those devices. Deactivated images remain on the device until you delete them manually.

Delete the software image files from the image repository

You may need to periodically remove software image files from the image repository when they are no longer needed, to ensure efficient storage management. Deleting images can only be performed manually and requires the appropriate user privileges.

Follow these steps 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.