Skip to content
English
  • There are no suggestions because the search field is empty.

Administration: Requesting and Applying System Licenses for Individual Xona Devices

 

Table of Contents

Affected Environments

  • Platform: Hardware (1U Server, DIN Rail), Virtual Image (VMware/Hyper-V) | [x] AWS AMI | [x] Azure VM

  • Component: CSG, XCM

Overview

Your Xona Critical System Gateway (CSG) and Xona Connection Manager (XCM) appliances require a valid license to operate properly. Whether you are deploying a new appliance, renewing an expiring license, or upgrading your deployment to support more simultaneous connections, you must request a newly generated license file from the Xona Support team. This article outlines how to find the unique identifier for your appliance and apply the new license once it is issued.

For general information about Xona licensing, please see the Xona Licensing FAQ KB article.

If your Xona deployment has an XCM, then you can apply one license bundle for your XCM and all of your CSGs. Please refer to following KB article:

Administration: Requesting and Applying System Licenses for Multiple Xona Devices via XCM

Step 1: Locating Your System ID

There are a variety of ways to obtain the System ID:

  • Option 1A: Using the WebUI over HTTPS - Best for when network access is available.
  • Option 1B: Using the Setup Console - Best for when network access is not available.

Option 1A: Using the WebUI over HTTPS (Requires Network)

Xona licenses are cryptographically tied to the specific hardware or virtual instance of your appliance. To generate your license, our team needs your appliance's unique System UUID.

  1. Log in to the CSG or XCM Web UI with a user assigned Admin permissions, or with the default local admin user.

  2. If this this is the first time logging in, then you will be prompted to set the default local admin user's password before continuing. The default password complexity setting requires a 12-character password containing upper/lower case letters, numbers, and symbols. It's recommended to use a random password generator to create a very long password, to securely vault the password, and to only use this default local admin user for maintenance purposes.
  3. If this is the first time logging in to Xona, then you will be prompted to accept the End User License Agreement (EULA) before continuing.

  4. From the left-hand navigation menu, select Settings.

  5. In the secondary left-hand menu, ensure General is selected.

  6. Select the LICENSE tab at the top of the settings pane.

  7. Scroll down to locate the System UUID (a long alphanumeric string, e.g., eb732aa9-xxxx-xxxx-xxxx...).

  8. Highlight and copy this entire string.

Option 1B: Using the Setup Console

The Setup Console is is a Text User Interface (TUI) shown when accessing the Xona device over the following methods:

  • The video output for a physical or virtual Xona device.
  • The serial output for a cloud Xona device.
  • The SSH service, if enabled, for a Xona device.

The initial splash screen of the Setup Console will display the 

Step 2: Requesting a New License

Once you have your System UUID copied to your clipboard, you will need to contact the Xona Customer Success team.

  1. Draft a new email to support@xonasystems.com.

  2. In the body of the email, paste the System ID you copied in the previous step.

  3. Ensure you include the following details so our team can accurately generate your license:

    • Company Name: Your organization's name.

    • Appliance Type: Specify whether this UUID is for a CSG or an XCM.

    • Reason for Request: Let us know if this is a net-new deployment, a standard renewal, or a request to increase your connection limits.

Step 3: Uploading the Applied License

After the Xona Support team processes your request, they will securely email you a new license file.

  1. Download the provided license file to your local machine.

  2. Navigate back to the Settings > General > LICENSE tab in your Xona appliance Web UI.

  3. At the bottom of the page, click the Choose File button.

  4. Select the new license file from your local machine.

  5. Click the pink Upload License button.

  6. The page will refresh. Review the License Information section to verify that the Expires date, Max Connections, and Max Simultaneous Sessions fields reflect your new license parameters.