Skip to Content

How to Find a PC's Host ID for Niagara 4 Licensing

Open the Niagara Console for your version and run nre -hostid, or check Workbench's License Manager. You need the Host ID to request any Niagara licence.

Every Niagara 4 licence, whether for Workbench, a Web Supervisor or a demo, is issued for a specific machine identified by its Host ID. When you order a licence or ask your supplier for a demo licence, the first thing they will ask for is the Host ID. This guide shows four ways to find it, explains what it is, and covers the Host ID problems that cause licensing headaches, especially on virtual machines and after hardware changes.

What is a Niagara Host ID?

The Host ID is a unique identifier Niagara calculates for each host it runs on. Tridium issues licences against it, so a licence file only works on the machine whose Host ID it contains. On a Windows PC the Host ID begins with Win- followed by groups of characters, for example Win-XXXX-XXXX-XXXX-XXXX. Controllers have their own Host ID formats.

The Host ID is derived from characteristics of the machine, so it stays the same through normal use, Windows updates and Niagara upgrades, but it can change if the underlying hardware or virtual hardware changes significantly.

Method 1: The Niagara Console (fastest)

  1. Open the Niagara Console for the Niagara version you are licensing. It is in the Start menu under your Niagara installation, or as a shortcut in the Niagara installation folder.

  2. Type:

    nre -hostid

  3. Press Enter. The Niagara Runtime Environment starts and prints the Host ID.

  4. Copy it exactly and send it to your supplier.

This works even when Workbench will not start, for example because there is no licence yet. You can also run nre -version to show the exact Niagara version, vendor and Java build, which is useful to include in the same request.

Method 2: Workbench License Manager

If Workbench opens:

  1. In Workbench, open the License Manager (from the Tools menu, or from the local platform's Platform Administration).
  2. The Host ID of the local machine is shown at the top.
  3. You can select and copy it.

Method 3: Platform Administration

For a remote host, such as a supervisor server you can reach with Workbench:

  1. Open a platform connection to the host.
  2. Open Platform Administration.
  3. The Host ID is displayed with the host's other details (Niagara version, operating system, model).

This is also how you find the Host ID of a JACE or IONA controller.

Method 4: An existing licence file

If the PC already has a Niagara licence (for example a demo licence), the Host ID appears inside the licence file:

  1. Open the Niagara installation's security\licenses folder (for example under C:\Niagara\<version>\security\licenses, or the equivalent licence folder for your Niagara version and brand).
  2. Open the licence file with a text editor such as Notepad++.
  3. Find the Host ID in the file's header.

Do not edit or save the licence file. Any change invalidates its signature and the licence stops working.

Requesting a licence with the Host ID

When you request a licence or demo licence, send:

  • the Host ID exactly as displayed (copy and paste, do not retype)
  • the Niagara version you will run (for example 4.15)
  • the brand of your Niagara installation if it is an OEM build
  • the licence type you need (Workbench, Supervisor, demo, drivers)
  • your company and site details

Your supplier returns a licence file. Install it through the License Manager (or copy it into the licences folder as instructed), then restart Workbench or the station.

Host ID problems and how to avoid them

The Host ID changed after hardware changes

Replacing a motherboard, network hardware or other core components, or reinstalling on new hardware, can produce a new Host ID. The existing licence then no longer matches. Contact your supplier to have the licence reissued for the new Host ID; do this before decommissioning the old machine where possible.

Virtual machines

Supervisors increasingly run on virtual machines. Host IDs on VMs depend on the virtual hardware presented by the hypervisor. Moving a VM to a different host, restoring it from a template, or changing virtual hardware can change its Host ID. To avoid surprises:

  • keep the VM's virtual hardware identifiers stable when migrating
  • check the Host ID with nre -hostid after any VM move, restore or clone
  • never clone a licensed supervisor VM to create a second supervisor; the clone needs its own licence

Multiple Host IDs on one Windows machine

Engineers sometimes see different Host IDs reported by different Niagara versions on the same PC, or by an AX installation versus Niagara 4. If that happens, use the Host ID reported by the version you are licensing, and tell your supplier which version it came from. If a licence will not activate, send the output of nre -hostid and nre -version from that version.

Wrong console version

Always open the Console for the version you are licensing. A console from another installed version may report a different Host ID and cannot manage the other version's daemon.

Planning a supervisor migration or hardware refresh

Moving a Web Supervisor to a new server is one of the most common reasons for a Host ID change. Plan it so the site is never without a licensed supervisor:

  1. Build the new server and install the same Niagara version (or the version you are upgrading to).
  2. Run nre -hostid on the new server and request the licence transfer or a new licence from your supplier, quoting the old and new Host IDs.
  3. Install the new licence when it arrives and confirm the License Manager shows it as valid, with the correct SMA date and features.
  4. Copy the station from the old server with the Station Copier, including histories and alarms if they are stored locally.
  5. Re-establish connections: controllers' Niagara network connections, certificates, database connections and email accounts.
  6. Run both in parallel briefly if possible, then decommission the old server once the new one is confirmed.

Ask your supplier how licence transfers work for your licence type before ordering hardware; some transfers have conditions and may require an active SMA.

Using the Console effectively

The Niagara Console is useful well beyond finding the Host ID:

Command Purpose
nre -hostid Show the Host ID
nre -version Show Niagara version, vendor and Java details
wb Launch Workbench and show its start-up log, useful when Workbench crashes on start
plat installdaemon Install the Niagara Windows service (platform daemon)
plat uninstalldaemon Remove a corrupted or misconfigured daemon before reinstalling

Always open the Console for the specific Niagara version you are working with.

Where to find the Host ID on each type of Niagara host

Host Where to find the Host ID
Windows PC or server (Workbench, supervisor) nre -hostid in the Niagara Console, License Manager, or Platform Administration
Linux supervisor Platform Administration over a platform connection, or the equivalent console command on the server
JACE 8000 Platform Administration over a platform connection; also shown in shell mode during credential resets
JACE 9000 Platform Administration; the SD card must be fitted or the Host ID is incomplete
IONA Niagara 4 controller Platform Administration over a platform connection
Niagara Edge 10 Platform Administration over a platform connection

Whatever the host, copy the Host ID exactly. Licences are matched character for character, and a single mistyped character produces a licence that will not install.

Keep a Host ID register

For any estate with more than a couple of Niagara hosts, keep a simple register: site, host name, model, Host ID, Niagara version, licence features, SMA expiry and where the licence file is stored. It turns licence renewals, upgrades and hardware replacements from detective work into a lookup, and it is invaluable when handing a site to another engineer or integrator.

Demo licences

Tridium distributors can issue demo licences for evaluation and training, tied to the PC's Host ID. Demo licences have limits (such as station size) and typically expire, often annually. They are ideal for working through the free Niagara 4 TCP lab videos before a certification course. Ask our team for a demo licence with your Host ID.

Installing a licence once you receive it

When your supplier sends the licence file:

  1. Open Workbench on the licensed machine.
  2. Open the License Manager and choose to import or install a licence from file (or copy it into the licences folder if instructed).
  3. Check the License Manager shows the licence as valid for this Host ID, with the expected features, Global Capacity and SMA expiry date.
  4. Restart Workbench, or the station on a supervisor, so the licence takes effect.
  5. Keep a copy of the licence file with the site documentation.

Licences can also be retrieved from Tridium's licensing server for a given Host ID, which helps when rebuilding a machine with the same Host ID.

Licences and the Software Maintenance Agreement

A licence also carries the SMA expiry date, which controls which Niagara versions you can install. If you upgrade Niagara on a PC whose SMA has expired, the licence may not allow the new version. Check the SMA date in the License Manager before upgrading, and renew it if needed.

Frequently asked questions

How do I find my Niagara Host ID?

Open the Niagara Console for your version and run nre -hostid, or open the License Manager in Workbench.

What does a Niagara Host ID look like?

On Windows it starts with Win- followed by groups of characters. Controllers use their own formats.

Why has my Host ID changed?

Significant hardware changes, moving or cloning a virtual machine, or reinstalling on new hardware can change the Host ID. The licence must then be reissued.

Can I use one licence on two PCs?

No. A Niagara licence is tied to one Host ID. Each machine needs its own licence.

Where are Niagara licence files stored?

In the Niagara installation's security\licenses folder (the exact location depends on version and brand). Never edit them.

Is the Host ID the same as the computer's MAC address?

No. The Host ID is calculated by Niagara from characteristics of the machine and has its own format, beginning with Win- on Windows.

How long does it take to get a licence?

Demo licences are usually quick. Purchased licences depend on the order and Tridium's processing; plan ahead for commissioning dates.

How do I find the Host ID of a JACE?

Open a platform connection to the JACE in Workbench and look in Platform Administration. On a JACE 9000, make sure the SD card is fitted, otherwise the Host ID is reported incompletely.

Do I need a new licence after upgrading Niagara?

Not usually, if the licence's SMA date covers the new version. If the SMA has expired, the licence may not allow the upgrade until it is renewed.

Can I find the Host ID without Workbench?

Yes. The nre -hostid command in the Niagara Console works even if Workbench will not start.

Can I get a Niagara demo licence for training?

Yes. Ask your Tridium distributor for a demo licence, quoting your PC's Host ID. It is ideal for practising with the free TCP lab videos.

Do I need administrator rights to run nre -hostid?

Normally not; any user who can open the Niagara Console can display the Host ID. Installing licences or services may need administrator rights.

Why does Workbench say my licence is invalid?

The licence was issued for a different Host ID, it has been edited, it does not cover this Niagara version or brand, or its SMA date excludes the installed version.

Need help from a Niagara engineer?

If this guide has not solved the problem, contact the Tyrrell Products technical team on 01942 732819 or [email protected]. Tell us the controller or host type, its Niagara version and what you have already tried, and we will help you get the system running.