Litmus Edge Manager User UI
...
Product Features
Software Update

Add New Software Update Tasks

15min

Software update tasks are used to upgrade your edge device software.

Before You Begin

Ensure the following:

  • There is an update file available for the update tasks. See Edge Software Update to learn more.
  • The Edge devices that will be upgraded are online.
  • An Edge device is currently not already undergoing an existing software task (update). You cannot create a new software task for an Edge device that is already undergoing an existing software task.

Running Task Properties

  • Up to 10 running tasks can run in parallel. Additional ones will be queued until a running task completes.
  • The progress bar will automatically fill up from 0 to 100% without a need to refresh the page. It will automatically by itself refresh every 5 seconds.
  • A Software Update Task will usually take a few minutes to complete.
  • A Software Update Task will automatically timeout after 1 hour.
  • A Software Update Task that disconnects before it finishes could still upgrade and reboot a Litmus Edge instance. This will happen if the Litmus Edge successfully receives the .upd file before the disconnect.
  • Once the task completes, it will be transferred from the Current (#) tab to the History (#) tab. If the task was successful, the update status will be set to COMPLETED. If instead the task failed, the update status will be set to ERROR.

The workflow and user interface for adding a software task differs slightly based on your version of Litmus Edge Manager. Refer to the correct workflow when reviewing the steps.

Litmus Edge Manager Version 2.15.0 and Later

Add New Task

You can add a software update task from the Software pane by clicking a new or the Add new task icon.

Add new task icon
Add new task icon


Step 1: Select Software

You can select the software that will be applied to recipient Edge Devices.

Software Update Task UI Step 1: Select Software
Software Update Task UI Step 1: Select Software


To select software, select at least one software package to add and click Next.

Step 2: Select Target Device(s)

After selecting software that will be applied to Edge Devices, select the devices that will receive the software. There is no limit on the number of edge devices that can be updated.

Software Update Task UI Step 3: Select Target Device(s)
Software Update Task UI Step 3: Select Target Device(s)


To target devices to apply, select one or more edge devices from the edge device list and click Next.

Step 3a: Schedule Software Task

You have several options to schedule the software task.

Software Update Task UI Step 3: Schedule Software Job
Software Update Task UI Step 3: Schedule Software Job


To schedule the software task, select one of the following options and click Next.

  • Run now: Download and install the update immediately.
  • Download only: Download the upgrade file to devices (only for Edge Devices on Litmus Edge version 3.5.0 and later).
  • Run on a schedule: Download immediately (only for Edge Devices on Litmus Edge version 3.5.0 and later) and install the update at a specified time.

Step 3b: Configure Software Task Schedule

If you select Run on schedule, select the date and time to run the software task.

You have the option to select the checkbox for Allow delayed upgrade if the download takes long.

  • If you don't select this option and the downloading of the file is not completed by the scheduled upgrade time, the upgrade will not occur.
  • If you select this option and the the downloading of the file is not completed by the scheduled upgrade time, the upgrade will still occur on a delayed schedule.
Run on a schedule options
Run on a schedule options


Step 4: Review Software Task Details

Review and confirm the details of the software task. Then, click Finish to create the task.

Software Update Task UI Step 4: Review
Software Update Task UI Step 4: Review


The software task appears in the list of Software Update Tasks. Click the Task ID to view more information on the task.

List of Software Update Tasks
List of Software Update Tasks

Software Update Task Details
Software Update Task Details


If you need to cancel tasks, see Cancel Software Update Tasks.

Litmus Edge Manager 2.14.0 and Earlier

Add New Job

You can add a software update job from the Software pane by clicking a new or the Add new Job icon.

Add new job icon
Add new job icon


Step 1: Select Software

You can select the software that will be applied to recipient Edge Devices.

Software Update Job UI Step 1: Select Software
Software Update Job UI Step 1: Select Software


To select software:

  1. From the Software tab, select at least one software package to add.
  2. Click Next.

Step 2: Select Target Device(s)

After selecting software that will be applied to Edge Devices, select the devices that will receive the software. There is no limit on the number of edge devices that can be updated.

Software Update Job UI Step 2: Select Target Device(s)
Software Update Job UI Step 2: Select Target Device(s)


To target devices to apply:

  1. From the Targets tab, select one or more edge devices from the edge device list.
  2. Click Next.

Step 3: Run Deploy

Before deploying software to a list of Edge Devices, you can review job details before it gets executed.

Software Update Job UI Step 3: Run Deploy
Software Update Job UI Step 3: Run Deploy


To deploy jobs to edge devices:

  1. From the Targets tab, you have the option to select the Start job immediately check box.
  2. Click Save.

The software job appears in the Software Update Jobs pane Current (#) tab.