Getting Started with EAST

The Esper API Support Tool (EAST) allows users to programmatically interact with their devices through a desktop application. This guide covers how to get started with the tool, common use cases, and troubleshooting solutions. 

Why Use EAST? 

You may run into situations where you’d like to send a command to your devices, or display data for side-by-side comparisons. In that case, you can use EAST to interact with your devices. 

EAST can perform a variety of functions including: 

• Powering off a device 
• View device information in one fragment
• Perform commands on multiple devices at once 
• Perform tasks more conveniently than in the console

Requirements: 

• An Esper API key

In this article: 

• Downloading the Tool 
• Common Use Cases
  • Generating Reports
  • Firing Commands
    • Powering off a Device or Group
    • Removing Non-whitelisted Access Points
    • Starting a Bulk Factory Reset
    • Adding Device Tags and Aliases
• Troubleshooting

Downloading the Tool

To get started, download the package for your application or fork and clone the GitHub repository.

Step 3: Once downloaded, enter the following information: 

• Tenant Name: This can be any name 
• Tenant Host Name: Your tenant host name found in the URL you use to access the Console (ex. The ‘xxxxx’ in https://xxxxx.esper.cloud). 
• Enterprise ID: This information is the top corner of the API Key Management screen in the Console. 
• API Key: The API Key generated by API Key Management. 

Once you’ve entered this information, click Add.

Step 4: After entering your tenant information, you’re now ready to use EAST. 

Common Use Cases 

Generating Reports 

Generate reports at scale with EAST. Whether you’re trying to get information about a single group of devices or multiple groups of devices, EAST allows you to generate data for all the devices on your tenant. 

To get started, select the groups or devices you’d like to analyze and then generate a report from the Select Action dropdown. 

Generate the following reports: 

• Generate All Reports 
• Generate Device Reports
• Generate Device & Network Report 
• Generate App Report

To save reports, go to File > Save All Reports. Reports will be saved with the .xlsx file extension.

Firing Commands 

A variety of commands may be initiated using EAST. We’ve provided a sample of how these commands can be applied to groups of devices. 

Powering Off a Device or Group

Requirements: Only for Knox-enabled devices and select Lenovo devices. 

Select the device or group. From the menu, select Run and then Execute Command.

A popup to enter the JSON command will appear. 

Use the following JSON: 

  "dpcParams": [
        {
          "key": "powerOff",
          "value": "true"
        }
      ]

Then, select UPDATE_DEVICE_CONFIG from the drop-down menu. 

A prompt will appear. 

Press OK. 

The selected devices should power off. 

Removing Non-Whitelisted Access Points 

Do your end users have a habit of adding new Wi-Fi access points to your devices? You can remove these non-whitelisted access points in bulk with EAST. 

First, select the group you’d like to remove the access points for. Then, choose Action -> Remove Non-Whitelisted Wifi Access Points from the Select Action drop-down. 

The access point will no longer appear on the devices. 

Starting a Bulk Factory Reset 

Factory resetting many devices is now possible with EAST. To Factory Reset multiple devices, select the groups or devices you’d like to reset, select the top navigation bar’s Run > Bulk Factory Reset. 

Then enter the Device Identifier information. You can download a template or upload a CSV. 

Adding Device Tags and Aliases

Add device tags to easily identify devices within a group or in the Console. 

Step 1: To add device tags, select the group or devices you’d like to tag. Then, find the Tags column in the Device Information row. Add a list of tags in one of the following formats: 

• [“Tag 1”, “Tag 2”, “Tag 3”]
• 1, 2, 3, “4,5”,”testers”

Step 2: In the Select Action dropdown, select Action-> Modify Device Alias & Tags 

Step 3: Press Run. You’ll receive a confirmation once the action is fired.

Note: Device Aliases can also be modified with this method. Use the Alias column to input your device as a String ("between quotations").

Troubleshooting