Step 7 — Create and assign a campaign

To apply a firmware update to devices, you must create a campaign and specify which firmware version is pushed to your devices, and configure policies that control firmware download and installation.

1. Sign in to your Knox E-FOTA On-Premises server.

2. Go to Campaigns and then click Create Campaign.

Fill in the following campaign information.

Basic info

Enter a unique name for the campaign and a description of what the campaign is for.

Target firmware

Each row of the Target firmware table represents a target device group and the firmware version policy applied to those devices.

1. Select the model and sales code combination that specifies your target devices. Under FIRMWARE VERSION, select one of the following options:

   • Latest firmware — Automatically push the latest firmware version to your target devices.
   • Lock current firmware — Keep the current firmware version.
   • Select from firmware list — Select a specific firmware version to push to your target devices. Only the firmware versions that are compatible with your selected combination of model and sales code are available.

2. Click ADD ANOTHER ROW to target another set of devices and assign them to a firmware version policy.

Policy

You can define policies that govern firmware download and installation.

Network and speed

• Download network — Select which networks devices can use to download firmware.
  • Wi-Fi only — Only download firmware over Wi-Fi.
  • Any (Wi-Fi or Mobile) — Allow firmware downloads over Wi-Fi and mobile networks. This option also allows downloads over VPNs and private networks. To allow firmware downloads while roaming, select Allow download while roaming.
• Max bandwidth — Allocate a maximum bandwidth per device for firmware downloads in MBit/s, where 0 MBit/s represents unlimited bandwidth.

Device condition

You can specify conditions required for firmware installation.

• Specify how much battery charge a device must have before it can begin installing the update.
• Only install firmware if the device is connected to a charging dock.

Postpone installation

Enable this option to allow devices users to postpone firmware installation. You can set the maximum number of times they’re allowed to postpone the installation before any pending firmware begin to install.

Schedule

You can define a schedule for firmware download and installation.

• Campaign period — Set the date range when devices in the campaign can start to download and install the update.
• Repeat on selected days — Set the days of the week you want firmware updates to occur.
• Installation hours — Set a time window that determines when during the day devices can begin installing firmware. This timeframe is based on the device’s timezone. If you want firmware updates to install at any time of the day, set the firmware installation period to identical values:
  • From — 00
  • To — 00

    Devices will start installation during this period, but there’s no guarantee that installation will end within this period.

• Download hours — Set a time window that determines when during the day devices can start downloading firmware. You can allow downloads to occur at one of the following periods:
  • Same as installation hours — Set the firmware download period to be the same as the firmware installation period.
  • Anytime — Allow firmware downloads at any time.
  • Specific hours — Set a firmware download period that’s different from the firmware installation period.
• Gradual campaign rollout — Configure a gradual campaign rollout that deploys in randomized daily batches instead of all devices at once. You can control the rollout rate as a percentage of total devices. This feature allows you to monitor device updates progressively, so you can discover and troubleshoot firmware issues before they spread to all devices.
  • Changes to either the rollout rate, target firmware version, or campaign status during gradual rollout will reset the rollout start date of all assigned devices.
  • Rolling out a campaign to devices newly assigned during the gradual rollout doesn’t reset the rollout start date of devices that were already assigned the campaign, preventing any delay in pushing firmware updates.

Activate your campaign

Once you’ve finished entering your campaign information, click CREATE. You new campaign appears on the Campaigns list.

To assign the campaign to your devices:

1. Go to the Devices page.
2. Select the devices you want to assign.
3. Click ACTIONS > Assign Campaign.
4. Select a running campaign to assign the devices to.
5. Click ASSIGN.

Tutorial progress

Congratulations, you’ve completed the tutorial! You’re now set up to use Knox E-FOTA On-Premises.

Previous