Bulk Manage Devices

You can add multiple devices to inventory and register them at the same time using a .csv file that you upload to the server.

Add the Devices

To bulk add devices:

  1. Create a correctly formatted .csv file that includes the required information for each device. You can download a sample .csv file below.
  2. Go to Control Center > Inventory.
  3. Click Bulk Manage.
  4. Select your .csv file and upload it.

Uploads take some time to process, depending on the number of devices you are adding. You can see completed jobs in your Audit Log.

Format Your CSV File

For a bulk upload to work, the file must be correctly formatted.
You can download a sample .csv file.
If there is an error related to a particular line in your file, you will be notified of the line number and device ID affected.

CSV File Requirements

On upload, some pre-checks will be performed:

  • The file size must not exceed 10Mb.
  • Each device_id (first column) may only appear once in the file.
  • Each device_id must be new, that is, cannot already be registered in EyeSaaS, as editing through bulk upload is not currently supported.

Formatting:

  • The first line of the  file must be the column headers and must read: "device_id,customer_id,optional_id". You can use semicolons in place of commas, but do not mix the two.
  • All lines must end with a linebreak.
  • For data fields:
    • Device ID and Customer ID are both required.
    • Optional ID is, unsurprisingly, optional.
    • The supported characters are _A-Za-z0-9 (which means no spaces).
    • Each field may contain 4-32 characters.

A Note on Privacy

As always, ensure that the Customer ID and Optional ID do not contain any customer-identifying information, such as phone numbers, addresses, or similar. For more information, see Customer Privacy.

Use the Audit Log

The Audit Log Displays All Control Center and API Activity

As a user with admin-level access, you can use the Audit Log in Control Center to see any action performed using Control Center and Steel API, and which user performed the action.
The audit log lists all actions and can be sorted on any column.

Search the Audit Log for Devices, Users, or Actions

All the information visible in the Audit Log is searchable. This means you can search for:

  • Any of the standard column values (timestamp, username, IP, action)
  • Any value displayed in the "Details" column, including:
    • The Device ID, Customer ID, and Optional ID (if applicable) of registered or updated devices.
    • The Device ID of unregistered or deleted devices.
    • The name, username, and email address of added or updated users.
    • The username of deleted users.
    • All details for added or updated firmware policies.
    • The policy id of stopped firmware policies.

Edit Users

You can edit users from Control Center (or using any system integrated with EyeSaaS through Steel API).

Edit a User From Control Center

  1. Go to Control Center > Users.
  2. Select the user entry and click Edit.
  3. You can modify the following fields for a user:
    • First name
    • Last name
    • Email address
    • Password -- the password fields will appear empty when editing a user. Leave them empty to leave the password unchanged.
  4. Click Save.

You cannot modify the username or the access level of a user. To get a new access level or username, you must create a new user, see Add and Delete Users.

Add and Delete Users

You can add users through Control Center or through company systems that integrate with Steel API. All your users will show up in Control Center > Users regardless of how or where they were added.

Add Users Using Control Center

To add a user through Control Center:

  1. Go to Control Center > Users.
  2. Click Add User.
  3. Fill in all fields.
    • Only use the Admin level for users who need access to Control Center.
    • Usernames must be unique and minimum four characters long.
    • The password must not contain the username.
  4. Click Save.

Delete a User

To delete a user:

  1. Find and select them in the list.
  2. Click the Delete button that appears.

How User Management Works

User management is part of Control Center. To access Control Center, users must have an access level of Admin. Every EyeSaaS server instance is delivered with two Admin users who are then responsible for further user creation and management for their organization.

There are two access levels available:

  • Admin access level grants access to both Customer Center and Control Center.
  • User is limited to Customer Center access.

You can add users through Control Center or through integrations with your organization's internal systems that use the EyeSaaS Steel API.

For instructions on how to add and delete users, see

Register and Unregister Devices

You must register devices to fully manage them, but any device configured with the server ACS URL will show up in your inventory. For more detail on how this works, see How Device Management Works.

Register Devices Using Control Center

  1. You have two main options for registration:
    • Device has not yet contacted the server: click the Register Device button.
    • Device is already online and has contacted the server: locate it in inventory by searching for the device ID (serial number), select the device and click the Register button next to the device entry.
  2. Fill in the registration fields:
    • Device ID corresponds to the serial number of the device. If the device has already contacted the server itself, this field will be populated.
    • Customer ID must be linked to an entry in your customer database, but not contain any identifiable information.
    • Optional ID may be used to tie the device to a specific project or other group of devices, but may also not contain any identifiable information.

Note that no ID fields may contain spaces or special characters. Hyphens and underscores are allowed.
The device will be added to inventory, and the Last Contact column will remain empty until the device comes online.

Unregister a Device

Select a device from the Inventory list and click the Unregister button next to the entry to remove:

  • The Customer ID.
  • The Optional ID (if present).

 

How Device Management Works

This is an overview of how device management works in EyeSaaS. For instructions on adding and managing devices, see Register and Delete Devices.

Devices Contact Your Server Using the ACS URL

You must ensure that the ACS URL of your EyeSaaS server instance is present on all devices that you want the server to manage. The device will then contact your server as soon as it comes online.
In many cases, your vendor or reseller will have pre-configured the devices with the ACS URL for you. If this is not the case, there are three main options for adding the URL to a device:
  • The device's own web interface
  • The device's command line interface
  • DHCP Option 43

For instructions, see the documentation for your device and/or DHCP server. The ACS URL must be complete and include the desired protocol--http or https depending on what the device supports.
EyeSaaS does not check for username and password. If the device does not support leaving credentials blank, you can populate these fields with dummy data.
When the device contacts the server, it will show up in your Control Center inventory and in Customer Center.

You Must Register Devices to Manage Them

In order for you to fully manage a device associated with a customer, you must register each device with both a device ID (serial number) and a customer ID on your server.
You can register devices through the Control Center interface, or using systems integrated with the server using Steel API. All devices will show up in inventory regardless of how they were added to the server.
You can register devices before or after they first contact the server.

You Cannot Use Personal Identifiers for Device Management

Registering the device involves tying it to a customer ID (CID). There is also a field called Optional ID that may be used for project identification or similar.
It is important that none of these identifiers contain any kind of personal information.
Use customer IDs that are:

  • Unique to each customer, preferably numeric or alphanumeric.
  • Non-identifiable to anyone without access to your customer database.

Do NOT use potentially identifiable and/or non-unique identifiers such as:

  • Email addresses
  • Usernames
  • Phone numbers or parts of phone numbers

Using identifiable customer IDs or optional IDs is a breach of customer privacy and EyeSaaS terms and conditions.

Monitor Firmware Policy Status

These are instructions for tracking the firmware policy status. For an overview of the firmware management process, see How Firmware Management Works.

Scheduled, Active, or Stopped

In Control Center > Firmware, policies are listed by their current status:

  • Scheduled policies have a start date in the future.
  • Active policies are currently running and being triggered by devices as specified within the policy.
  • Stopped policies are past their scheduled end date, have been manually stopped, or stopped because they reached a specified maximum number of successful or failed upgrades.

Upgrade Number Counts

For each policy that is Active or Stopped, you can see the number of upgrades that have been triggered and completed, and how many have failed.

Completed Number of devices that have been successfully upgraded.
Triggered Number of times that the policy has been triggered. As this depends on the setting for retries, this number may well exceed the number of applicable devices.
Failed Number of devices that failed to upgrade. Note that any failed upgrades for a device that then succeeds on a retry, will not be counted.

Counting Examples

The counts are affected by the number of retries allowed and attempted for each device before considering the upgrade a failure.
For example, if you have set Maximum Retries to 5, and one device fails five times:

  • Triggered will increase by 5.
  • Failed will increase by 5.
  • Completed will not increase.

If, in the same scenario, the fifth retry is successful:

  • Triggered will increase by 5.
  • Failed will not increase.
  • Completed will increase by 1.

Troubleshoot Firmware Policies

Policy Trigger Conditions

Firmware policies will only be triggered when:

  • All conditions explicitly set in the policy are met.
  • A device reports the exact firmware version defined in the From Version field to the server.
  • Both the From Version and the To Version are available in the list of Versions.
  • The To Version has a URL defining the location of the firmware. Example: http://www.example.com/directoryExample/firmwareExample.bin
  • The device is able to reach the firmware server (See Set Up a Firmware Server).

Policy is not Triggered

If a policy is not triggered, verify that all fields are correctly filled in and conditions are correctly specified.

Policy is Triggered, but Fails

If a policy is triggered, but fails, verify the following for the To Version:

  • the URL of the firmware is correct and the package is available on the server.
  • the firmware file is accessible to the device/the device can reach the file on the server.
  • the firmware file is correct and usable. Try downloading the file from the firmware server and manually upgrading the device using its web interface.

Device Upgrades are Inconsistent or Loop

If device upgrades are triggered, but behave unpredictably, you may have created conflicting policies.

  • Example 1:
    • Policy 1: From firmware A to firmware B
    • Policy 2: From firmware A to firmware C
    • Result: Unpredictable. Some will be upgraded to firmware B, some to firmware C
  • Example 2:
    • Policy 1: From firmware A to firmware B
    • Policy 2: From firmware B to firmware A
    • Result: Endless firmware upgrade and reboot loop.

Use Middle Firmware for Indirect Upgrades

Sometimes you may need to upgrade devices by several versions, where a direct upgrade from current to desired version is not possible.
Using middle firmware means applying one or more firmware versions between the current version and the desired version during an upgrade sequence.

Add multiple policies using middle firmware

If you cannot go from firmware A to C without first installing B, then B is the middle firmware, and you must add two policies:

  • One to upgrade from firmware A to B.
  • A second policy to upgrade from firmware B to C.

For instructions on setting up policies, see Apply a New Firmware Version to Multiple Devices.

Inform users ahead of time

Note that the device will usually reboot after the new firmware is received. Depending on the event triggers you specify in your policy, this upgrade sequence will therefore cause a minimum of two reboots.
We strongly recommend informing users if you have to apply a middle-firmware policy. This is because:

  • The user may see the downtime caused by this as considerable
  • Users must avoid rebooting the device themselves during the upgrade sequence as this may harm the operation as well as the device.