Skip to main content
UXI Agent For Android

Installation & onboarding guidelines for the UXI agent for Android.

Updated over a week ago

Prerequisites

Before you get started with UXI agent make sure that:

  • The Android device has OS version 8 or above.

  • Only devices with a camera are supported for manual onboarding. Devices without a camera can only be onboarded from the MDM using managed configurations.

  • Ensure connectivity with the UXI cloud. The device will need to be able to report results to the UXI cloud over the network it is connected to. The required URLs are described here.

Getting Started

The UXI agent is available on Google Play. When you are ready to set up the UXI agent, the first step is to obtain a Provisioning Token or QR Code from your UXI dashboard. This Provisioning Token or QR Code is used by the agent to identify which UXI dashboard the device belongs to.

Provisioning Token for existing dashboards

To get a provisioning token (QR Code) for an existing dashboard:

  • Go to Settings → select Sensors and Agents under Locations > click Add.

  • A popup will appear. In the popup, select Agent.

Enter the following information:

  • Groups: Select the group you want the agent to appear in for the visual representation of the dashboard.

  • Legacy Group: Select the group you want the agent to appear in for the test configuration of the dashboard.

Note: Please use the same group selection for both options above unless your dashboard is using the Groups and Sensors Hierarchy Alpha feature.

If you do not select a group, the provisioning token / QR code will place the agent at the top level on your UXI dashboard. You will then need to assign the agent to groups and set the test configuration, similar to a hardware sensor, after the agent reports to the dashboard.

From this screen, you can scan the QR code or copy the provisioning token to your clipboard to be used in your MDM.

Provisioning Token for new dashboards

To get a provisioning token (QR Code) for a new dashboard, you can follow the steps in the onboarding wizard.

  • If you have never logged in to UXI before, you can create a new account here.

  • If you have logged in to UXI, you can create a new account from the Switch Account menu.

  • Click on Setup my first sensor.

  • On the first step of the onboarding wizard, select the sensor type as Agent.

  • On the next page, the provisioning token QR code will be displayed.

From this screen, you can scan the QR code or copy the provisioning token to your clipboard to be used in your MDM.

Install, configure and start the agent

The Aruba UXI Agent is available on Google Play Store.

It is recommended to install the agent from Google Play through your MDM and use Managed Configurations to apply the provisioning token. However, it can also be installed from Google Play locally on the device.

If your MDM is not integrated with Google Play, you can Download the agent from the HPE Aruba Networking Support Portal (ASP). Please be aware of the limitations as described in the help article.

Note: During the provisioning process, the agent will attempt to derive a unique device identifier for the UXI dashboard. To derive this unique identifier, the agent uses a combination of the device serial number and the device MAC address (if available). If you are provisioning a device for a second time, it's possible to see duplicate device entries in your dashboard, especially if you changed what is being sent in the managed configuration or switched from a QR code to the provisioning token. You can remove the old device entry from your dashboard.

MDM Installation and Configuration (Recommended)

The agent supports Managed Configurations to install and configure the agent on devices quickly and easily. Each MDM has a slightly different workflow, but the following steps need to be done through your MDM:

  • Add the "Aruba UXI Agent" to your MDM from Google Play.

  • Ensure the required permissions are set for the application. For example, in VMware Workspace One, this is configured in your device profile.

  • Install the agent to a select group of devices.

  • When installing the agent, send the configuration as follows:

    • Enter your provisioning token provided by Aruba HPE Networking in the Aruba UXI Provisioning Token field.

    • Enter the variable for the device name in the Aruba UXI Device Name field.

    • Enter the variable for the device serial in the Aruba UXI Device Serial field.

    • Enter the variable for the device MAC address in the Aruba UXI Mac Address field.

By using these variables, the device will utilize the device-specific properties from the MDM. For example, in VMware Workspace One, the parameters will look like this: {DeviceFriendlyName}, {DeviceSerialNumber}, {DeviceWLANMac}.

The agent must be started once. After that, it will automatically start when the device reboots. The agent can be started manually (which is the easiest way) or started through the MDM.

Local Installation and Configuration

If you are not installing the agent through your MDM, you can install locally on the device from Google Play or ASP.

  • Install the "Aruba UXI Agent” from Google Play.

  • Start the agent on the device, grant requested permissions and scan a QR code obtained from the UXI dashboard.

  • The QR code will assign the agents to your respective UXI dashboard.

This method will only work for devices with a camera.

Android Doze Mode and Battery Optimization

Although the agent has been optimized to minimize its impact on battery life, Android 10 and above have become more aggressive in optimizing background apps to preserve battery life.

To ensure the agent collects data in the background and prevents Android from ending the process, you must set the UXI agent application's Battery Optimization settings to “Do Not Optimize.”

You can do this manually on the device by following these steps:

  • SettingsBatteryBackground usage limitsNever auto sleeping apps

  • Add the Aruba UXI Agent app

Please note that the steps may vary slightly depending on the phone manufacturer.

Post Installation Steps

Once the agent is started, it will appear on your UXI dashboard and begin reporting test results within 10 to 15 minutes. The UXI agent runs in the background on the device and performs low-impact synthetic tests to measure the end-user experience from the perspective of the handheld device.

  • The agent will only test networks that are defined in the "Wireless" list on the UXI cloud. You don't need to assign a network to the agent; when the agent connects to a network in the list, it will start testing the network.

  • The SSID name is the only mandatory field required to define a network for the agent to test it.

  • You do not need to assign a network to the agent. Whenever the device connects to a network defined in the "Wireless"list, the agent will automatically begin testing the network and report the results to the UXI cloud dashboard.

Example Scenario:

Previously, the agent automatically tested the user's home network and reported the results. Moving forward, this automatic testing will cease unless the user's home network—at the very least its SSID—is defined in the "Wireless" network list on the UXI dashboard.

The agent can only test the network it is connected to. You cannot change the network settings as you would for a hardware sensor.

Synthetic Tests

The test cycle runs every 5 minutes and performs the following tests:

  • AP scan.

  • Gateway reachability.

  • DNS check (a check to see if the agent can resolve cdn.capenetworks.io).

  • HTTP GET.

  • PING.

You can assign the agents to groups and then assign test to groups and networks.

If the agent doesn't support an assigned test, the agent will skip it.

Helpful Links:

Did this answer your question?