Knox E-FOTA Advanced Admin Guide

NOTICE
There is a new version of this guide with a fresh new look!
Remember to update your bookmarks to the Knox consolidated admin guide and let us know your feedback.

Manage devices

On this page

This tutorial describes how to manage devices registered to Knox E-FOTA Advanced.

The Device Management tab contains tools to manage devices with Knox E-FOTA Advanced. View device information, register devices, edit devices, delete devices, and create device groups under this tab.

View devices

You can view the list of devices currently registered to Knox E-FOTA Advanced through the device list.

To view devices:

Log in to the Knox E-FOTA Advanced portal.
Go to Device Management > Devices.

The device list will include the following details:

Device ID—Unique ID associated with the device.
ID Type—Device identification type entered during device registration to Knox E-FOTA Advanced.
Device Model—Device model name.
Carrier Code—Device carrier code specified from multiple Consumer Software Customization (multi-CSC) when a carrier specific SIM card is inserted.
Marketing Name—Marketing name associated with the device.
Status—One of the following states: Active or Deleted.
Last Reported—Time and date of the last reported device management session with the device. (Server time)
Last Seen—Time and date of the last observed session with the device. (Server time)
Operations—Total number of operations performed on the device.
Domain—Domain the device is registered to.
Inventory—Firmware currently installed on the device and other inventory details.
Labels—(If applicable) Labels associated with the device.
Friendly Name—(If applicable) Alias associated with the device.
Actions—Actions you can perform on the device.
- Edit—Edit the device details, domain associated with the device, or labels associated with the device.
- Unregister—Move the devices from the root domain to the service domain.
- Delete—Delete the device from the Knox E-FOTA Advanced service
NOTE—You can't edit or unregister a device associated with a running campaign.

View device firmware details

To view the current firmware installed on a device:

Go to Device Management > Devices.
On the device list, click Inventory Details
Review the firmware details:

Add a device

There are 2 ways to register a device to the Knox E-FOTA Advanced service:

Register a single device.
Bulk register a list of devices (up to 10,000 devices).

For more information, see Register a device.

Create a device group

Device groups allow you to perform actions on multiple devices simultaneously. You can also use them to filter through devices by group name. Note that device groups are specific to a domain. For example, IT admins of a root domain can't access device groups of a subdomain.

To create a device group:

Go to Device Management > Device Groups.
Click New Group.
Under New Device Group, enter the following information:
- Device Group Name—Enter a unique name for the device group.
- Label—(Optional) Select a label to associate with the device group.
- Device Model—Select the device model for the device group.
- Domain—(Optional) Assign the device group to a domain.
- Device ID—(Optional) Enter the device ID to associate with the device group.
Click Save & Close.

After a device group is created, it is listed on the Device Group List. You'll be able to assign devices to the group when registering a device.

Edit a device

Go to Device Management > Devices.
Find the device through the Device Search filters or by scrolling through the device list.
Click Edit.

Delete a device

NOTE—Once a device is connected to the Knox E-FOTA Advanced server, it disables conventional software updates on the settings menu. When you delete a device from the service, you must also uninstall the Knox E-FOTA Advanced client app from the device to re-enable conventional software updates on that device.

Go to Device Management > Devices.
Find the device through the Device Search filters or by scrolling through the device list.
Click Delete.

Set polling interval

By setting the polling interval, IT admins can specify the frequency with which the Knox E-FOTA service checks managed devices for updates.

To set a polling interval:

Go to Device Management > Client Configuration.
Under Polling Interval, enter a time interval between a successful poll and the next poll.
- To disable polling, set this to 0.
- The maximum value is 2160 hours.
Click Set to devices.
In the Set Client Configuration window:
- Select Target Devices—Select All, or specify target devices By Domain, By Device Group, or By Devices.
- Type—Specify whether the update type is a Regular, Critical or Silent update.
- Period—Specify a date range for the device update.
- Allow new devices to be added—(Optional) Select to allow new devices to be added while the campaign is being executed.
- Advanced—Specify a value for Campaign Retry.
- Result Messages—Enter a custom success or fail message that displays when the device update is executed.
Click Execute.

Set factory reset restrictions

Set factory reset restrictions on devices managed through Knox E-FOTA Advanced by creating a profile, and assigning the profile to your target devices.

NOTE—By default, end users are allowed to perform a factory reset.

Step 1: Create a custom setting
Step 2: Execute a custom setting

Create a custom setting

Knox E-FOTA Advanced manages device restrictions through custom settings set under Profiles.

To set factory reset restrictions, create a new custom setting:

Go to Device Management > Profiles.
Click the New icon.
On the New Profile screen, enter the following information:
- Name—Enter a unique profile name to help you identify the profile. (Maximum of 80 alphanumeric characters)
- Description (Optional)—Enter a short description for the profile. (Maximum of 400 alphanumeric characters)
- Base Custom Setting Details—select SET: FactoryResetRestriction.
Click Select. The window will then display the updated information.
Select one of the following Profile Parameters:
- Allow—Gives the user permission to initiate a factory reset on the device. Setting this to allow gives permission to use the setFactoryResetRestrictionAllModels method to communicate with the device side Knox E-FOTA Advanced client.
- Disallow—Prevents the user from initiating a factory reset on the device.
Click Save.

This saves the custom setting under the Profiles list, which can later be executed to target devices.

Execute a custom setting

Once a custom setting is saved under the Profiles list, the custom setting can be pushed to target devices by domain, device group, or device.

To execute a custom setting:

Under Device Management > Profiles, select a target custom setting.
Click Execute to open the Execute Profile window.
Select one of the following Target Devices:
- By Domain—Push the profile to a target subdomain.
- By Device Group—Push the profile to a device group.
- By Device—Push the profile to an individual device by device ID, mobile number, or friendly name.
Select one of the following for the update Type:
- Critical Update—The device user can't refuse the update, but the user can choose to delay the update.
- Silent Update—The update will silently update the device without notifying the device user.
- Regular—The device user will have the option to refuse the update, delay the update, or update the device.
Set the Period—A date range you want the campaign to remain active for. The value must be set to a minimum of 1 hour.
- Optionally select Allow new devices to be added during the active campaign period.
Set the Campaign retry—A value to retry the operation if device updates fail or remain pending.
- Unlimited—Set the action/operation to retry and remain active until all devices successfully download the push update.
- Up to—Set a value limit for the number of times an operation can retry pushing updates (maximum of 99 retries).
(Optional) Set a Result Message for the update:
- Update Failure Message—(Optional) Enter an optional message to the device user (maximum of 256 characters).
- Update Success Message—(Optional) Enter an optional message to the service user (maximum of 256 characters).
Click Save.

NOTE—Devices that are powered OFF during this campaign period will have a pending status until the device is turned ON. If the device remains OFF during the duration of the campaign period, it won't receive the command to update.