# UBL Cloud server setup

## About this Install Guide

| Reading time: | 15 min |
|---------------|--------|
| Last updated: | 22 Jun 2026 |

| Author:       | Ronan Synnott, Arm [View](https://linkedin.com/in/ronansynnott) |
|---------------|------------------------------------------------------------------|
| Official docs:| [View](https://developer.arm.com/documentation/107573)           |

This guide shows you how to install and use the tool with the most common configuration. For advanced options and complete reference information, see the official documentation. Some install guides also include optional next steps to help you explore related workflows or integrations.

## How do I generate an activation code?

Access to the Arm user-based licensing portal with the account that the licenses were assigned to. This is likely to be an assigned license administrator rather than the end-user.

```
https://developer.arm.com/support/licensing/user-based
```

Click on `View Details` of the product of interest, and then navigate to `Cloud Server` > `Generate Activation Code`. This code can be shared with the end-user to [activate](#activate). Once activated, the user information will be visible on the licensing portal dashboard alongside the activation code.

### How do I activate the license?

On the end-user machine, open a command prompt, and navigate to the `bin` directory of any UBL enabled product.

Use the following command with your assigned activation code.

```
armlm activate --code xxxxxxxx-xxxx-xxxx-xxxxxxxx
```

### How do I activate the license via tools IDE?

The license can also be activated in the various Arm tool IDEs. For example, [Arm Development Studio](https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio), via `Help` > `Arm License Manager` > `Manage Arm User-Based Licenses`. Select `Activate with` > `Activation Code`, and enter your product activation code. Click `Activate`.

## How do I confirm license check-out?

To confirm you have checked-out a license, enter the command:

```
armlm inspect
```

## How do I refresh the license?

Your license is cached on your local machine and is valid for 7 days. There will be an automatic attempt to refresh this timer on the first usage of a UBL enabled tool in a day. If it fails to communicate to the server (see [Network requirements for user-based licensing](https://developer.arm.com/documentation/102516/latest/User-based-licensing-overview/Network-requirements-for-user-based-licensing) for the most common reasons) the tools can still be used provided there is still time on the locally cached license.

To manually refresh the cached license, you can deactivate and reactivate your license (assuming above network requirements are fulfilled):

```
armlm deactivate --code xxxxxxxx-xxxx-xxxx-xxxxxxxx
armlm reactivate --code xxxxxxxx-xxxx-xxxx-xxxxxxxx
```

Verify that you have refreshed successfully with:

```
armlm inspect
```