License

Before you start

Goal

• License the Altair SLC Hub.

Prerequisites

• Follow the initial install instructions.
• Altair SLC Hub configuration privileges for the host.
• Access to an Altair licence file, Altair License Server or a token for Altair Managed Licensing

Install the Altair SLC Hub licence

The license may take the form of a file for a server address for on premises licensing or a token or token file for managed licensing.

LinuxWindows

Configuration of the license is in the [etc directory]/config.d/licence.yaml file.

Configuration of the license is in the [etc directory]\config.d\licence.yaml file.

Create a copy of this file with a lexicographically greater name, for example, [etc directory]\config.d\licence_custom.yaml, ensure the ownership and permissions are correct then edit this file.

To make use of Altair licensing, useAltairLicensing needs to be set to true.

Altair Licence Utility

A command line utility (almutil) and GUI program (almutil_gui) are both included in the bin directory under the Altair SLC Hub install location. These tools can be used to view information such as the host ID information and current usage statistics from your licence server. This can also be used to authorise the machine when using managed licensing.

Configuration

The licence can be provided by several different methods.

On PremisesManaged Licence

If using an on-premises Altair units license then set the altairLicencePath property to point at the licence or licensing server. The licence path will take the format of either a file path, for example, /home/user1/licence.dat, or a host address, for example, [email protected]

An example licence_custom.yaml using an on-premises license:

licence:
    useAltairLicensing: true
    altairLicencePath: [email protected]

If making use of Host HyperWorks Units (HHWU), Altair's cloud based licence server solution then you must first authorise the Altair SLC Hub server, this can be carried out using the included licence utilities.

HHWU authorisation can be on a per user basis, or for the whole system. Per user authorisation can be performed from the almutil_gui by logging in or authorising under the Managed Licensing tab, or via the almutil CLI command. System wide authorisation can only be performed using the almutil program, the example below demonstrates this, assuming the almutil application is on your PATH.

Removing -system will make it only authorise for the current user.

almutil -a1auth -system -code <auth code>

The <auth code> can be retrieved from the Altair One™ portal.

If the HHWU token is known then the altairHHwuToken property can be set directly. Otherwise the altairHHwuDirectory property should be set to the directory containing the HHWU configuration file, this will vary as defined in the table below.

OS	HHWU user authorisation location	HHWU system authorisation location
Linux	<user home directory>/.altair_licensing/<hostname>	/usr/local/altair
Windows	C:\Users\<user>\AppData\Local\.altair_licensing\<hostname>	C:\ProgramData\Altair

An example licence_custom.yaml using HHWU:

licence:
    useAltairLicensing: true
    altairHHwuDirectory: /home/bob/.altair_licensing/bobs-pc/

Verification

Verify licence

• run the hubctl verify licence command

Before continuing, it is necessary to verify that the licence has been installed correctly To verify, use the following hubctl command:

hubctl verify licence